NAME-OF-MANUAL

’: Indicate text that is quoted. The text is filled, indented, and printed in a roman font by default. ‘

'
     Illustrate code, commands, and the like. The text is printed in a
     fixed-width font, and indented but not filled.
`

'
     Illustrate Lisp code. The text is printed in a fixed-width font,
     and indented but not filled.
`

'
     Illustrate code, commands, and the like.  Similar to `

',
     except that in TeX this command typesets text in a smaller font
     for the smaller `     format.
`

'
     Illustrate Lisp code.  Similar to `

', except that in TeX this
     command typesets text in a smaller font for the smaller
     ``

'
     Display illustrative text.  The text is indented but not filled,
     and no font is specified (so, by default, the font is roman).
`

'
     Print illustrative text.  The text is not indented and not filled
     and no font is specified (so, by default, the font is roman).
   The `' command is used within the above constructs to undo
the indentation of a line.
   The `

' and `

' commands are used to line up the
left or right margins of unfilled text.
   The `' command may be used after one of the above
constructs to prevent the following text from being indented as a new
paragraph.
   You can use the `

' command within one of the above
constructs to highlight the example or quotation by drawing a box with
rounded corners around it.  (The `

' command affects only the
printed manual; it has no effect in the Info file; see *Note Drawing
Cartouches Around Examples: cartouche.)
File: texi.info,  Node: quotation,  Next: example,  Prev: Block Enclosing Commands,  Up: Quotations and Examples
`

': ============
   The text of a quotation is processed normally except that:
   * the margins are closer to the center of the page, so the whole of
     the quotation is indented;
   * the first lines of paragraphs are indented no more than other
     lines;
   * in the printed output, interparagraph spacing is reduced.
     This is an example of text written between an `

' command:      and an `

'command.  An `

' command is most:      often used to indicate text that is excerpted from another (real
     or hypothetical) printed work.
   Write an `

' command as text on a line by itself.  This: line will disappear from the output.  Mark the end of the quotation
with a line beginning with and containing only `

'. The
`

'line will likewise disappear from the output.  Thus,
the following,

     This is
     a foo.

produces
     This is a foo.
File: texi.info,  Node: example,  Next: noindent,  Prev: quotation,  Up: Quotations and Examples
`

'
==========
   The `

' command is used to indicate an example that is not
part of the running text, such as computer input or output.
     This is an example of text written between an
     `

' command
     and an `

'command.
     The text is indented but not filled.
     
     In the printed manual, the text is typeset in a
     fixed-width font, and extra spaces and blank lines are
     significant.  In the Info file, an analogous result is
     obtained by indenting each line with five spaces.
   Write an `

' command at the beginning of a line by itself.
This line will disappear from the output.  Mark the end of the example
with an `

'command, also written at the beginning of a line
by itself.  The `

'will disappear from the output.
   For example,

     mv foo bar

produces
     mv foo bar
   Since the lines containing `

' and `

'will
disappear, you should put a blank line before the `

' and
another blank line after the `

'. (Remember that blank
lines between the beginning `

' and the ending `

'will appear in the output.)
     *Caution:* Do not use tabs in the lines of an example (or anywhere
     else in Texinfo, for that matter)!  TeX treats tabs as single
     spaces, and that is not what they look like.  This is a problem
     with TeX.  (If necessary, in Emacs, you can use `M-x untabify' to
     convert tabs in a region to multiple spaces.)
   Examples are often, logically speaking, "in the middle" of a
paragraph, and the text continues after an example should not be
indented.  The `' command prevents a piece of text from being
indented as if it were a new paragraph.  (*Note noindent::.)
   (The `@code' command is used for examples of code that are embedded
within sentences, not set off from preceding and following text.  *Note
`@code': code.)
File: texi.info,  Node: noindent,  Next: Lisp Example,  Prev: example,  Up: Quotations and Examples
`'
===========
   An example or other inclusion can break a paragraph into segments.
Ordinarily, the formatters indent text that follows an example as a new
paragraph.  However, you can prevent this by writing `' at the
beginning of a line by itself preceding the continuation text.
   For example:

     This is an example

     
          This line is not indented.  As you can see, the
     beginning of the line is fully flush left with the line
     that follows after it.  (This whole example is between
     @display and @end display.)
produces
          This is an example
     
     
     This line is not indented.  As you can see, the
     beginning of the line is fully flush left with the line
     that follows after it.  (This whole example is between
     `

' and `

'.)   To adjust the number of blank lines properly in the Info file output,
remember that the line containing `' does not generate a blank
line, and neither does the `

'line.
   In the Texinfo source file for this manual, each line that says
`produces' is preceded by a line containing `'.
   Do not put braces after an `' command; they are not
necessary, since `' is a command used outside of paragraphs
(*note Command Syntax::.).
File: texi.info,  Node: Lisp Example,  Next: smallexample & smalllisp,  Prev: noindent,  Up: Quotations and Examples
`

'
=======
   The `

' command is used for Lisp code.  It is synonymous with
the `

' command.
     This is an example of text written between an
     `

' command and an `

'command.
   Use `

' instead of `

' so as to preserve information
regarding the nature of the example.  This is useful, for example, if
you write a function that evaluates only and all the Lisp code in a
Texinfo file.  Then you can use the Texinfo file as a Lisp library.(1)
   Mark the end of `

' with `

'on a line by itself.
   ---------- Footnotes ----------
   (1)  It would be straightforward to extend Texinfo to work in a
similar fashion for C, FORTRAN, or other languages.
File: texi.info,  Node: smallexample & smalllisp,  Next: display,  Prev: Lisp Example,  Up: Quotations and Examples
`

' and `

'
================================
   In addition to the regular `

' and `

' commands, Texinfo
has two other "example-style" commands.  These are the `

'
and `

' commands.  Both these commands are designed for use
with the `manual in a 7 by 9.25 inch format rather than the regular 8.5 by 11
inch format.
   In TeX, the `

' and `

' commands typeset text
in a smaller font for the smaller `by 11 inch format.  Consequently, many examples containing long lines
fit in a narrower, `Both commands typeset in the normal font size when you format for the
8.5 by 11 inch size; indeed, in this situation, the `

' and
`

' commands are defined to be the `

' and `

'
commands.
   In Info, the `

' and `

' commands are
equivalent to the `

' and `

' commands, and work exactly the
same.
   Mark the end of `

' or `

' with `@end
smallexample' or `

',respectively.
     This is an example of text written between `

' and
     `

'. In Info and in an 8.5 by 11 inch manual,
     this text appears in its normal size; but in a 7 by 9.25 inch manual,
     this text appears in a smaller font.
   The `

' and `

' commands make it easier to
prepare smaller format manuals without forcing you to edit examples by
hand to fit them onto narrower pages.
   As a general rule, a printed document looks better if you write all
the examples in a chapter consistently in `

' or in
`

'.  Only occasionally should you mix the two formats.
   *Note Printing "Small" Books: smallbook, for more information about
the `File: texi.info,  Node: display,  Next: format,  Prev: smallexample & smalllisp,  Up: Quotations and Examples
`

'
==========
   The `

' command begins a kind of example.  It is like the
`

' command except that, in a printed manual, `

' does
not select the fixed-width font.  In fact, it does not specify the font
at all, so that the text appears in the same font it would have
appeared in without the `

' command.
     This is an example of text written between an `

' command
     and an `

'command.  The `

' command
     indents the text, but does not fill it.
File: texi.info,  Node: format,  Next: exdent,  Prev: display,  Up: Quotations and Examples
`

'
=========
   The `

' command is similar to `

' except that, in the
printed manual, `

' does not select the fixed-width font and does
not narrow the margins.
This is an example of text written between an `

' command
and an `

'command.  As you can see
from this example,
the `

' command does not fill the text.
File: texi.info,  Node: exdent,  Next: flushleft & flushright,  Prev: format,  Up: Quotations and Examples
`': Undoing a Line's Indentation
=======================================
   The `' command removes any indentation a line might have.
The command is written at the beginning of a line and applies only to
the text that follows the command that is on the same line.  Do not use
braces around the text.  In a printed manual, the text on an `'
line is printed in the roman font.
   `' is usually used within examples.  Thus,

     This line follows an @example command.
     This line is exdented.
     This line follows the exdented line.
     The @end example comes on the next line.