/usr/share/doc/texinfo/html/Def-Cmd-Continuation-Lines.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 5.2, 26 September 2013),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled "GNU Free Documentation
License".

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Texinfo 5.2: Def Cmd Continuation Lines</title>

<meta name="description" content="GNU Texinfo 5.2: Def Cmd Continuation Lines">
<meta name="keywords" content="GNU Texinfo 5.2: Def Cmd Continuation Lines">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Definition-Commands.html#Definition-Commands" rel="up" title="Definition Commands">
<link href="Optional-Arguments.html#Optional-Arguments" rel="next" title="Optional Arguments">
<link href="Def-Cmd-Template.html#Def-Cmd-Template" rel="previous" title="Def Cmd Template">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Def-Cmd-Continuation-Lines"></a>
<div class="header">
<p>
Next: <a href="Optional-Arguments.html#Optional-Arguments" accesskey="n" rel="next">Optional Arguments</a>, Previous: <a href="Def-Cmd-Template.html#Def-Cmd-Template" accesskey="p" rel="previous">Def Cmd Template</a>, Up: <a href="Definition-Commands.html#Definition-Commands" accesskey="u" rel="up">Definition Commands</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Definition-Command-Continuation-Lines"></a>
<h3 class="section">16.2 Definition Command Continuation Lines</h3>
<a name="index-Continuation-lines-in-definition-commands"></a>
<a name="index-Definition-command-headings_002c-continuing"></a>
<a name="index-_0040-as-continuation-in-definition-commands"></a>

<p>The heading line of a definition command can get very long.
Therefore, Texinfo has a special syntax allowing them to be continued
over multiple lines of the source file: a lone &lsquo;<samp>@</samp>&rsquo; at the end of
each line to be continued.  Here&rsquo;s an example:
</p>
<div class="example">
<pre class="example">@defun fn-name @
  arg1 arg2 arg3
This is the basic continued defun.
@end defun
</pre></div>

<p>produces:
</p>
<dl>
<dt><a name="index-fn_002dname"></a>Function: <strong>fn-name</strong> <em>arg1 arg2 arg3</em></dt>
<dd><p>This is the basic continued defun.
</p></dd></dl>

<p>As you can see, the continued lines are combined, as if they had been
typed on one source line.
</p>
<p>Although this example only shows a one-line continuation,
continuations may extend over any number of lines, in the same way;
put an <code>@</code> at the end of each line to be continued.
</p>
<a name="index-Whitespace_002c-collapsed-around-continuations"></a>
<a name="index-Collapsing-whitespace-around-continuations"></a>
<p>In general, any number of spaces or tabs before the <code>@</code>
continuation character are collapsed into a single space.  There is one
exception: the Texinfo processors will not fully collapse whitespace
around a continuation inside braces.  For example:
</p>
<div class="example">
<pre class="example">@deffn {Category @
  Name} &hellip;
</pre></div>

<p>The output (not shown) has excess space between &lsquo;Category&rsquo;
and &lsquo;Name&rsquo;.  To avoid this, elide the unwanted whitespace in your
input, or put the continuation <code>@</code> outside braces.
</p>
<p><code>@</code> does not function as a continuation character in <em>any</em>
other context.  Ordinarily, &lsquo;<samp>@</samp>&rsquo; followed by a whitespace
character (space, tab, newline) produces a normal interword space
(see <a href="Multiple-Spaces.html#Multiple-Spaces">Multiple Spaces</a>).
</p>




</body>
</html>
texinfo-doc-nonfree 5.2.0-1 / usr / share / doc / texinfo / html / Def-Cmd-Continuation-Lines.html
