GNU Info
(texinfo)Command List
@-Command List
**************
Here is an alphabetical list of the @-commands in Texinfo. Square
brackets, [ ], indicate optional arguments; an ellipsis, `...',
indicates repeated text.
`@WHITESPACE'
An `@' followed by a space, tab, or newline produces a normal,
stretchable, interword space. Note: Multiple Spaces.
`@!'
Generate an exclamation point that really does end a sentence
(usually after an end-of-sentence capital letter). Note: Ending a
Sentence.
`@"'
`@''
Generate an umlaut or acute accent, respectively, over the next
character, as in o" and o'. Note: Inserting Accents.
`@*'
Force a line break. Do not end a paragraph that uses `@*' with an
`@refill' command. Note: Line Breaks.
`@,{C}'
Generate a cedilla accent under C, as in c,. Note: Inserting
Accents.
`@-'
Insert a discretionary hyphenation point. Note: - and
hyphenation.
`@.'
Produce a period that really does end a sentence (usually after an
end-of-sentence capital letter). Note: Ending a Sentence.
`@:'
Indicate to TeX that an immediately preceding period, question
mark, exclamation mark, or colon does not end a sentence. Prevent
TeX from inserting extra whitespace as it does at the end of a
sentence. The command has no effect on the Info file output.
Note: Not Ending a Sentence.
`@='
Generate a macron (bar) accent over the next character, as in o=.
Note: Inserting Accents.
`@?'
Generate a question mark that really does end a sentence (usually
after an end-of-sentence capital letter). Note: Ending a
Sentence.
`@@'
Stands for an at sign, `@'. Note: Inserting @ and braces.
`@^'
`@`'
Generate a circumflex (hat) or grave accent, respectively, over
the next character, as in o^. Note: Inserting Accents.
`@{'
Stands for a left brace, `{'. *Note Inserting @ and braces:
Braces Atsigns.
`@}'
Stands for a right-hand brace, `}'.
Note: Inserting @ and braces.
`@~'
Generate a tilde accent over the next character, as in N~. Note:
Inserting Accents.
`@AA{}'
`@aa{}'
Generate the uppercase and lowercase Scandinavian A-ring letters,
respectively: AA, aa. Note: Inserting Accents.
`@acronym{ABBREV}'
Tag ABBREV as an acronym, that is, an abbreviation written in all
capital letters, such as `NASA'. Note: `acronym'.
`@AE{}'
`@ae{}'
Generate the uppercase and lowercase AE ligatures, respectively:
AE, ae. Note: Inserting Accents.
`@afivepaper'
Change page dimensions for the A5 paper size. Note: A4 Paper.
`@afourlatex'
`@afourpaper'
`@afourwide'
Change page dimensions for the A4 paper size. Note: A4 Paper.
`@alias NEW=EXISTING'
Make the command `@NEW' an alias for the existing command
`@EXISTING'. Note: alias.
`@anchor{NAME}'
Define NAME as the current location for use as a cross-reference
target. Note: `@anchor'.
`@appendix TITLE'
Begin an appendix. The title appears in the table of contents of
a printed manual. In Info, the title is underlined with
asterisks. *Note The `@unnumbered' and `@appendix' Commands:
unnumbered & appendix.
`@appendixsec TITLE'
`@appendixsection TITLE'
Begin an appendix section within an appendix. The section title
appears in the table of contents of a printed manual. In Info,
the title is underlined with equal signs. `@appendixsection' is a
longer spelling of the `@appendixsec' command. Note: Section
Commands.
`@appendixsubsec TITLE'
Begin an appendix subsection within an appendix. The title appears
in the table of contents of a printed manual. In Info, the title
is underlined with hyphens. *Note Subsection Commands:
unnumberedsubsec appendixsubsec subheading.
`@appendixsubsubsec TITLE'
Begin an appendix subsubsection within an appendix subsection. The
title appears in the table of contents of a printed manual. In
Info, the title is underlined with periods. Note: The `subsub'
Commands.
`@asis'
Used following `@table', `@ftable', and `@vtable' to print the
table's first column without highlighting ("as is"). Note: Making
a Two-column Table.
`@author AUTHOR'
Typeset AUTHOR flushleft and underline it. Note: The `@title' and
`@author' Commands.
`@b{TEXT}'
Print TEXT in bold font. No effect in Info. Note: Fonts.
`@bullet{}'
Generate a large round dot, or the closest possible thing to one.
Note: `@bullet'.
`@bye'
Stop formatting a file. The formatters do not see the contents of
a file following an `@bye' command. Note: Ending a File.
`@c COMMENT'
Begin a comment in Texinfo. The rest of the line does not appear
in either the Info file or the printed manual. A synonym for
`@comment'. Note: Comments.
`@cartouche'
Highlight an example or quotation by drawing a box with rounded
corners around it. Pair with `@end cartouche'. No effect in
Info. Note: Drawing Cartouches Around Examples.)
`@center LINE-OF-TEXT'
Center the line of text following the command. *Note `@center':
titlefont center sp.
`@centerchap LINE-OF-TEXT'
Like `@chapter', but centers the chapter title. *Note `@chapter':
chapter.
`@chapheading TITLE'
Print a chapter-like heading in the text, but not in the table of
contents of a printed manual. In Info, the title is underlined
with asterisks. *Note `@majorheading' and `@chapheading':
majorheading & chapheading.
`@chapter TITLE'
Begin a chapter. The chapter title appears in the table of
contents of a printed manual. In Info, the title is underlined
with asterisks. Note: `@chapter'.
`@cindex ENTRY'
Add ENTRY to the index of concepts. Note: Defining the Entries of
an Index.
`@cite{REFERENCE}'
Highlight the name of a book or other reference that lacks a
companion Info file. Note: `@cite'.
`@clear FLAG'
Unset FLAG, preventing the Texinfo formatting commands from
formatting text between subsequent pairs of `@ifset FLAG' and
`@end ifset' commands, and preventing `@value{FLAG}' from
expanding to the value to which FLAG is set. Note: `@set'
`@clear' `@value'.
`@code{SAMPLE-CODE}'
Highlight text that is an expression, a syntactically complete
token of a program, or a program name. Note: `@code'.
`@command{COMMAND-NAME}'
Indicate a command name, such as `ls'. Note: `@command'.
`@comment COMMENT'
Begin a comment in Texinfo. The rest of the line does not appear
in either the Info file or the printed manual. A synonym for `@c'.
Note: Comments.
`@contents'
Print a complete table of contents. Has no effect in Info, which
uses menus instead. *Note Generating a Table of Contents:
Contents.
`@copyright{}'
Generate a copyright symbol. Note: `@copyright'.
`@defcodeindex INDEX-NAME'
Define a new index and its indexing command. Print entries in an
`@code' font. Note: Defining New Indices.
`@defcv CATEGORY CLASS NAME'
`@defcvx CATEGORY CLASS NAME'
Format a description for a variable associated with a class in
object-oriented programming. Takes three arguments: the category
of thing being defined, the class to which it belongs, and its
name. Note: Definition Commands, and *Note Def Cmds in Detail:
deffnx.
`@deffn CATEGORY NAME ARGUMENTS...'
`@deffnx CATEGORY NAME ARGUMENTS...'
Format a description for a function, interactive command, or
similar entity that may take arguments. `@deffn' takes as
arguments the category of entity being described, the name of this
particular entity, and its arguments, if any. Note: Definition
Commands.
`@defindex INDEX-NAME'
Define a new index and its indexing command. Print entries in a
roman font. Note: Defining New Indices.
`@definfoenclose NEWCMD, BEFORE, AFTER,'
Create new @-command NEWCMD for Info that marks text by enclosing
it in strings that precede and follow the text. Note:
definfoenclose.
`@defivar CLASS INSTANCE-VARIABLE-NAME'
`@defivarx CLASS INSTANCE-VARIABLE-NAME'
This command formats a description for an instance variable in
object-oriented programming. The command is equivalent to `@defcv
{Instance Variable} ...'. Note: Definition Commands, and Note:
Def Cmds in Detail.
`@defmac MACRONAME ARGUMENTS...'
`@defmacx MACRONAME ARGUMENTS...'
Format a description for a macro. The command is equivalent to
`@deffn Macro ...'. Note: Definition Commands, and Note: Def
Cmds in Detail.
`@defmethod CLASS METHOD-NAME ARGUMENTS...'
`@defmethodx CLASS METHOD-NAME ARGUMENTS...'
Format a description for a method in object-oriented programming.
The command is equivalent to `@defop Method ...'. Takes as
arguments the name of the class of the method, the name of the
method, and its arguments, if any. Note: Definition Commands,
and Note: Def Cmds in Detail.
`@defop CATEGORY CLASS NAME ARGUMENTS...'
`@defopx CATEGORY CLASS NAME ARGUMENTS...'
Format a description for an operation in object-oriented
programming. `@defop' takes as arguments the overall name of the
category of operation, the name of the class of the operation, the
name of the operation, and its arguments, if any. Note:
Definition Commands, and Note: Abstract Objects.
`@defopt OPTION-NAME'
`@defoptx OPTION-NAME'
Format a description for a user option. The command is equivalent
to `@defvr {User Option} ...'. Note: Definition Commands, and
Note: Def Cmds in Detail.
`@defspec SPECIAL-FORM-NAME ARGUMENTS...'
`@defspecx SPECIAL-FORM-NAME ARGUMENTS...'
Format a description for a special form. The command is
equivalent to `@deffn {Special Form} ...'. Note: Definition
Commands, and Note: Def Cmds in Detail.
`@deftp CATEGORY NAME-OF-TYPE ATTRIBUTES...'
`@deftpx CATEGORY NAME-OF-TYPE ATTRIBUTES...'
Format a description for a data type. `@deftp' takes as arguments
the category, the name of the type (which is a word like `int' or
`float'), and then the names of attributes of objects of that type.
Note: Definition Commands, and Note: Data Types.
`@deftypefn CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
`@deftypefnx CLASSIFICATION DATA-TYPE NAME ARGUMENTS...'
Format a description for a function or similar entity that may take
arguments and that is typed. `@deftypefn' takes as arguments the
classification of entity being described, the type, the name of the
entity, and its arguments, if any. Note: Definition Commands,
and Note: Def Cmds in Detail.
`@deftypefun DATA-TYPE FUNCTION-NAME ARGUMENTS...'
`@deftypefunx DATA-TYPE FUNCTION-NAME ARGUMENTS...'
Format a description for a function in a typed language. The
command is equivalent to `@deftypefn Function ...'. Note:
Definition Commands, and Note: Def Cmds in Detail.
`@deftypeivar CLASS DATA-TYPE VARIABLE-NAME'
`@deftypeivarx CLASS DATA-TYPE VARIABLE-NAME'
Format a description for a typed instance variable in
object-oriented programming. Note: Definition Commands, and
Note: Abstract Objects.
`@deftypemethod CLASS DATA-TYPE METHOD-NAME ARGUMENTS...'
`@deftypemethodx CLASS DATA-TYPE METHOD-NAME ARGUMENTS...'
Format a description for a typed method in object-oriented
programming. Note: Definition Commands, and Note: Def Cmds in
Detail.
`@deftypeop CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...'
`@deftypeopx CATEGORY CLASS DATA-TYPE NAME ARGUMENTS...'
Format a description for a typed operation in object-oriented
programming. Note: Definition Commands, and Note: Abstract
Objects.
`@deftypevar DATA-TYPE VARIABLE-NAME'
`@deftypevarx DATA-TYPE VARIABLE-NAME'
Format a description for a variable in a typed language. The
command is equivalent to `@deftypevr Variable ...'. Note:
Definition Commands, and Note: Def Cmds in Detail.
`@deftypevr CLASSIFICATION DATA-TYPE NAME'
`@deftypevrx CLASSIFICATION DATA-TYPE NAME'
Format a description for something like a variable in a typed
language--an entity that records a value. Takes as arguments the
classification of entity being described, the type, and the name
of the entity. Note: Definition Commands, and Note: Def Cmds in
Detail.
`@defun FUNCTION-NAME ARGUMENTS...'
`@defunx FUNCTION-NAME ARGUMENTS...'
Format a description for functions. The command is equivalent to
`@deffn Function ...'. Note: Definition Commands, and Note: Def
Cmds in Detail.
`@defvar VARIABLE-NAME'
`@defvarx VARIABLE-NAME'
Format a description for variables. The command is equivalent to
`@defvr Variable ...'. Note: Definition Commands, and Note: Def
Cmds in Detail.
`@defvr CATEGORY NAME'
`@defvrx CATEGORY NAME'
Format a description for any kind of variable. `@defvr' takes as
arguments the category of the entity and the name of the entity.
Note: Definition Commands, and Note: Def Cmds in Detail.
`@detailmenu'
Avoid `makeinfo' confusion stemming from the detailed node listing
in a master menu. Note: Master Menu Parts.
`@dfn{TERM}'
Highlight the introductory or defining use of a term. Note:
`@dfn'.
`@dircategory DIRPART'
Specify a part of the Info directory menu where this file's entry
should go. Note: Installing Dir Entries.
`@direntry'
Begin the Info directory menu entry for this file. Pair with
`@end direntry'. Note: Installing Dir Entries.
`@display'
Begin a kind of example. Like `@example' (indent text, do not
fill), but do not select a new font. Pair with `@end display'.
Note: `@display'.
`@dmn{DIMENSION}'
Format a unit of measure, as in 12pt. Causes TeX to insert a thin
space before DIMENSION. No effect in Info. Note: `@dmn'.
`@documentdescription'
Set the document description text, included in the HTML output.
Pair with `@end documentdescription'. Note:
`@documentdescription'.
`@documentencoding ENC'
Declare the input encoding to be ENC. *Note `@documentencoding':
documentencoding.
`@documentlanguage CC'
Declare the document language as the two-character ISO-639
abbreviation CC. Note: `@documentlanguage'.
`@dotaccent{C}'
Generate a dot accent over the character C, as in o.. Note:
Inserting Accents.
`@dots{}'
Insert an ellipsis: `...'. Note: `@dots'.
`@email{ADDRESS[, DISPLAYED-TEXT]}'
Indicate an electronic mail address. Note: `@email'.
`@emph{TEXT}'
Highlight TEXT; text is displayed in _italics_ in printed output,
and surrounded by asterisks in Info. *Note Emphasizing Text:
Emphasis.
`@end ENVIRONMENT'
Ends ENVIRONMENT, as in `@end example'. *Note @-commands:
Formatting Commands.
`@env{ENVIRONMENT-VARIABLE}'
Indicate an environment variable name, such as `PATH'. Note:
`@env'.
`@enddots{}'
Generate an end-of-sentence of ellipsis, like this .... Note:
`@dots{}'.
`@enumerate [NUMBER-OR-LETTER]'
Begin a numbered list, using `@item' for each entry. Optionally,
start list with NUMBER-OR-LETTER. Pair with `@end enumerate'.
Note: `@enumerate'.
`@equiv{}'
Indicate to the reader the exact equivalence of two forms with a
glyph: `=='. Note: Equivalence.
`@error{}'
Indicate to the reader with a glyph that the following text is an
error message: `error-->'. Note: Error Glyph.
`@evenfooting [LEFT] @| [CENTER] @| [RIGHT]'
`@evenheading [LEFT] @| [CENTER] @| [RIGHT]'
Specify page footings resp. headings for even-numbered (left-hand)
pages. Only allowed inside `@iftex'. Note: How to Make Your Own
Headings.
`@everyfooting [LEFT] @| [CENTER] @| [RIGHT]'
`@everyheading [LEFT] @| [CENTER] @| [RIGHT]'
Specify page footings resp. headings for every page. Not relevant
to Info. Note: How to Make Your Own Headings.
`@example'
Begin an example. Indent text, do not fill, and select
fixed-width font. Pair with `@end example'. *Note `@example':
example.
`@exampleindent INDENT'
Indent example-like environments by INDENT number of spaces
(perhaps 0). Note: Paragraph Indenting.
`@exclamdown{}'
Produce an upside-down exclamation point. Note: Inserting
Accents.
`@exdent LINE-OF-TEXT'
Remove any indentation a line might have. Note: Undoing the
Indentation of a Line.
`@expansion{}'
Indicate the result of a macro expansion to the reader with a
special glyph: `==>'. *Note ==> Indicating an Expansion:
expansion.
`@file{FILENAME}'
Highlight the name of a file, buffer, node, or directory. Note:
`@file'.
`@finalout'
Prevent TeX from printing large black warning rectangles beside
over-wide lines. Note: Overfull hboxes.
`@findex ENTRY'
Add ENTRY to the index of functions. Note: Defining the Entries
of an Index.
`@flushleft'
`@flushright'
Left justify every line but leave the right end ragged. Leave
font as is. Pair with `@end flushleft'. `@flushright' analogous.
Note: `@flushleft' and `@flushright'.
`@footnote{TEXT-OF-FOOTNOTE}'
Enter a footnote. Footnote text is printed at the bottom of the
page by TeX; Info may format in either `End' node or `Separate'
node style. Note: Footnotes.
`@footnotestyle STYLE'
Specify an Info file's footnote style, either `end' for the end
node style or `separate' for the separate node style. Note:
Footnotes.
`@format'
Begin a kind of example. Like `@display', but do not narrow the
margins. Pair with `@end format'. Note: `@example'.
`@ftable FORMATTING-COMMAND'
Begin a two-column table, using `@item' for each entry.
Automatically enter each of the items in the first column into the
index of functions. Pair with `@end ftable'. The same as
`@table', except for indexing. *Note `@ftable' and `@vtable':
ftable vtable.
`@group'
Hold text together that must appear on one printed page. Pair with
`@end group'. Not relevant to Info. Note: `@group'.
`@H{C}'
Generate the long Hungarian umlaut accent over C, as in o''.
`@heading TITLE'
Print an unnumbered section-like heading in the text, but not in
the table of contents of a printed manual. In Info, the title is
underlined with equal signs. *Note Section Commands:
unnumberedsec appendixsec heading.
`@headings ON-OFF-SINGLE-DOUBLE'
Turn page headings on or off, and/or specify single-sided or
double-sided page headings for printing. Note: The `@headings'
Command.
`@html'
Enter HTML completely. Pair with `@end html'. Note: Raw
Formatter Commands.
`@hyphenation{HY-PHEN-A-TED WORDS}'
Explicitly define hyphenation points. Note: `@-' and
`@hyphenation'.
`@i{TEXT}'
Print TEXT in italic font. No effect in Info. Note: Fonts.
`@ifclear FLAG'
If FLAG is cleared, the Texinfo formatting commands format text
between `@ifclear FLAG' and the following `@end ifclear' command.
Note: `@set' `@clear' `@value'.
`@ifhtml'
`@ifinfo'
Begin a stretch of text that will be ignored by TeX when it
typesets the printed manual. The text appears only in the HTML
resp. Info file. Pair with `@end ifhtml' resp. `@end ifinfo'.
Note: Conditionals.
`@ifnothtml'
`@ifnotinfo'
`@ifnottex'
Begin a stretch of text that will be ignored in one output format
but not the others. The text appears only in the format not
specified. Pair with `@end ifnothtml' resp. `@end ifnotinfo' resp.
`@end ifnotinfo'. Note: Conditionals.
`@ifset FLAG'
If FLAG is set, the Texinfo formatting commands format text
between `@ifset FLAG' and the following `@end ifset' command.
Note: `@set' `@clear' `@value'.
`@iftex'
Begin a stretch of text that will not appear in the Info file, but
will be processed only by TeX. Pair with `@end iftex'. Note:
Conditionally Visible Text.
`@ignore'
Begin a stretch of text that will not appear in either the Info
file or the printed output. Pair with `@end ignore'. Note:
Comments and Ignored Text.
`@image{FILENAME, [WIDTH], [HEIGHT], [ALT], [EXT]}'
Include graphics image in external FILENAME scaled to the given
WIDTH and/or HEIGHT, using ALT text and looking for `FILENAME.EXT'
in HTML. Note: Images.
`@include FILENAME'
Incorporate the contents of the file FILENAME into the Info file
or printed document. Note: Include Files.
`@inforef{NODE-NAME, [ENTRY-NAME], INFO-FILE-NAME}'
Make a cross reference to an Info file for which there is no
printed manual. Note: Cross references using `@inforef'.
`\input MACRO-DEFINITIONS-FILE'
Use the specified macro definitions file. This command is used
only in the first line of a Texinfo file to cause TeX to make use
of the `texinfo' macro definitions file. The backslash in `\input'
is used instead of an `@' because TeX does not recognize `@' until
after it has read the definitions file. Note: The Texinfo File
Header.
`@item'
Indicate the beginning of a marked paragraph for `@itemize' and
`@enumerate'; indicate the beginning of the text of a first column
entry for `@table', `@ftable', and `@vtable'. Note: Lists and
Tables.
`@itemize MARK-GENERATING-CHARACTER-OR-COMMAND'
Produce a sequence of indented paragraphs, with a mark inside the
left margin at the beginning of each paragraph. Pair with `@end
itemize'. Note: `@itemize'.
`@itemx'
Like `@item' but do not generate extra vertical space above the
item text. Note: `@itemx'.
`@kbd{KEYBOARD-CHARACTERS}'
Indicate text that is characters of input to be typed by users.
Note: `@kbd'.
`@kbdinputstyle STYLE'
Specify when `@kbd' should use a font distinct from `@code'.
Note: `@kbd'.
`@key{KEY-NAME}'
Indicate a name for a key on a keyboard. Note: `@key'.
`@kindex ENTRY'
Add ENTRY to the index of keys. Note: Defining the Entries of an
Index.
`@L{}'
`@l{}'
Generate the uppercase and lowercase Polish suppressed-L letters,
respectively: /L, /l.
`@lisp'
Begin an example of Lisp code. Indent text, do not fill, and
select fixed-width font. Pair with `@end lisp'. *Note `@lisp':
lisp.
`@lowersections'
Change subsequent chapters to sections, sections to subsections,
and so on. *Note `@raisesections' and `@lowersections':
Raise/lower sections.
`@macro MACRONAME {PARAMS}'
Define a new Texinfo command `@MACRONAME{PARAMS}'. Only supported
by `makeinfo' and `texi2dvi'. Note: Defining Macros.
`@majorheading TITLE'
Print a chapter-like heading in the text, but not in the table of
contents of a printed manual. Generate more vertical whitespace
before the heading than the `@chapheading' command. In Info, the
chapter heading line is underlined with asterisks. Note:
`@majorheading' and `@chapheading'.
`@math{MATHEMATICAL-EXPRESSION}'
Format a mathematical expression. Note: `@math'.
`@menu'
Mark the beginning of a menu of nodes in Info. No effect in a
printed manual. Pair with `@end menu'. Note: Menus.
`@minus{}'
Generate a minus sign, `-'. Note: `@minus'.
`@multitable COLUMN-WIDTH-SPEC'
Begin a multi-column table. Pair with `@end multitable'. Note:
Multitable Column Widths.
`@need N'
Start a new page in a printed manual if fewer than N mils
(thousandths of an inch) remain on the current page. Note:
`@need'.
`@node NAME, NEXT, PREVIOUS, UP'
Define the beginning of a new node in Info, and serve as a locator
for references for TeX. Note: `@node'.
`@noindent'
Prevent text from being indented as if it were a new paragraph.
Note: `@noindent'.
`@novalidate'
Suppress validation of node references, omit creation of auxiliary
files with TeX. Use before `@setfilename'. Note: Pointer
Validation.
`@O{}'
`@o{}'
Generate the uppercase and lowercase O-with-slash letters,
respectively: /O, /o.
`@oddfooting [LEFT] @| [CENTER] @| [RIGHT]'
`@oddheading [LEFT] @| [CENTER] @| [RIGHT]'
Specify page footings resp. headings for odd-numbered (right-hand)
pages. Only allowed inside `@iftex'. Note: How to Make Your Own
Headings.
`@OE{}'
`@oe{}'
Generate the uppercase and lowercase OE ligatures, respectively:
Œ, œ. Note: Inserting Accents.
`@option{OPTION-NAME}'
Indicate a command-line option, such as `-l' or `--help'. Note:
`@option'.
`@page'
Start a new page in a printed manual. No effect in Info. Note:
`@page'.
`@pagesizes [WIDTH][, HEIGHT]'
Change page dimensions. Note: pagesizes.
`@paragraphindent INDENT'
Indent paragraphs by INDENT number of spaces (perhaps 0); preserve
source file indentation if INDENT is `asis'. Note: Paragraph
Indenting.
`@pindex ENTRY'
Add ENTRY to the index of programs. Note: Defining the Entries of
an Index.
`@point{}'
Indicate the position of point in a buffer to the reader with a
glyph: `-!-'. Note: Indicating Point in a Buffer.
`@pounds{}'
Generate the pounds sterling currency sign. *Note `@pounds{}':
pounds.
`@print{}'
Indicate printed output to the reader with a glyph: `-|'. Note:
Print Glyph.
`@printindex INDEX-NAME'
Print an alphabetized two-column index in a printed manual or
generate an alphabetized menu of index entries for Info. Note:
Printing Indices & Menus.
`@pxref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
Make a reference that starts with a lower case `see' in a printed
manual. Use within parentheses only. Do not follow command with a
punctuation mark--the Info formatting commands automatically insert
terminating punctuation as needed. Only the first argument is
mandatory. Note: `@pxref'.
`@questiondown{}'
Generate an upside-down question mark. Note: Inserting Accents.
`@quotation'
Narrow the margins to indicate text that is quoted from another
real or imaginary work. Write command on a line of its own. Pair
with `@end quotation'. Note: `@quotation'.
`@r{TEXT}'
Print TEXT in roman font. No effect in Info. Note: Fonts.
`@raisesections'
Change subsequent sections to chapters, subsections to sections,
and so on. *Note `@raisesections' and `@lowersections':
Raise/lower sections.
`@ref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
Make a reference. In a printed manual, the reference does not
start with a `See'. Follow command with a punctuation mark. Only
the first argument is mandatory. Note: `@ref'.
`@refill'
In Info, refill and indent the paragraph after all the other
processing has been done. No effect on TeX, which always refills.
This command is no longer needed, since all formatters now
automatically refill. Note: Refilling Paragraphs.
`@result{}'
Indicate the result of an expression to the reader with a special
glyph: `=>'. Note: `@result'.
`@ringaccent{C}'
Generate a ring accent over the next character, as in o*. Note:
Inserting Accents.
`@samp{TEXT}'
Highlight TEXT that is a literal example of a sequence of
characters. Used for single characters, for statements, and often
for entire shell commands. Note: `@samp'.
`@sc{TEXT}'
Set TEXT in a printed output in THE SMALL CAPS FONT and set text
in the Info file in uppercase letters. Note: Smallcaps.
`@section TITLE'
Begin a section within a chapter. In a printed manual, the section
title is numbered and appears in the table of contents. In Info,
the title is underlined with equal signs. *Note `@section':
section.
`@set FLAG [STRING]'
Make FLAG active, causing the Texinfo formatting commands to
format text between subsequent pairs of `@ifset FLAG' and `@end
ifset' commands. Optionally, set value of FLAG to STRING. Note:
`@set' `@clear' `@value'.
`@setchapternewpage ON-OFF-ODD'
Specify whether chapters start on new pages, and if so, whether on
odd-numbered (right-hand) new pages. *Note `@setchapternewpage':
setchapternewpage.
`@setcontentsaftertitlepage'
Put the table of contents after the `@end titlepage' even if the
`@contents' command is not there. Note: Contents.
`@setfilename INFO-FILE-NAME'
Provide a name to be used by the Info file. This command is
essential for TeX formatting as well, even though it produces no
output. Note: `@setfilename'.
`@setshortcontentsaftertitlepage'
Place the short table of contents after the `@end titlepage'
command even if the `@shortcontents' command is not there. Note:
Contents.
`@settitle TITLE'
Provide a title for page headers in a printed manual, and the
default document description for HTML `<head>'. Note:
`@settitle'.
`@shortcontents'
Print a short table of contents. Not relevant to Info, which uses
menus rather than tables of contents. A synonym for
`@summarycontents'. *Note Generating a Table of Contents:
Contents.
`@shorttitlepage TITLE'
Generate a minimal title page. Note: `@titlepage'.
`@smallbook'
Cause TeX to produce a printed manual in a 7 by 9.25 inch format
rather than the regular 8.5 by 11 inch format. Note: Printing
Small Books. Also, see Note: small.
`@smalldisplay'
Begin a kind of example. Like `@smallexample' (narrow margins, no
filling), but do not select the fixed-width font. Pair with `@end
smalldisplay'. Note: small.
`@smallexample'
Indent text to indicate an example. Do not fill, select
fixed-width font, narrow the margins. In printed manuals, print
text in a smaller font than with `@example'. Pair with `@end
smallexample'. Note: small.
`@smallformat'
Begin a kind of example. Like `@smalldisplay', but do not narrow
the margins. Pair with `@end smallformat'. Note: small.
`@smalllisp'
Begin an example of Lisp code. Same as `@smallexample'. Pair
with `@end smalllisp'. Note: small.
`@sp N'
Skip N blank lines. Note: `@sp'.
`@ss{}'
Generate the German sharp-S es-zet letter, ss. Note: Inserting
Accents.
`@strong {TEXT}'
Emphasize TEXT by typesetting it in a *bold* font for the printed
manual and by surrounding it with asterisks for Info. Note:
Emphasizing Text.
`@subheading TITLE'
Print an unnumbered subsection-like heading in the text, but not in
the table of contents of a printed manual. In Info, the title is
underlined with hyphens. Note: `@unnumberedsubsec'
`@appendixsubsec' `@subheading'
subheading.
`@subsection TITLE'
Begin a subsection within a section. In a printed manual, the
subsection title is numbered and appears in the table of contents.
In Info, the title is underlined with hyphens. Note:
`@subsection'.
`@subsubheading TITLE'
Print an unnumbered subsubsection-like heading in the text, but
not in the table of contents of a printed manual. In Info, the
title is underlined with periods. *Note The `subsub' Commands:
subsubsection.
`@subsubsection TITLE'
Begin a subsubsection within a subsection. In a printed manual,
the subsubsection title is numbered and appears in the table of
contents. In Info, the title is underlined with periods. Note:
The `subsub' Commands.
`@subtitle TITLE'
In a printed manual, set a subtitle in a normal sized font flush to
the right-hand side of the page. Not relevant to Info, which does
not have title pages. Note: `@title' `@subtitle' and `@author'
Commands.
`@summarycontents'
Print a short table of contents. Not relevant to Info, which uses
menus rather than tables of contents. A synonym for
`@shortcontents'. Note: Generating a Table of Contents.
`@syncodeindex FROM-INDEX INTO-INDEX'
Merge the index named in the first argument into the index named in
the second argument, printing the entries from the first index in
`@code' font. Note: Combining Indices.
`@synindex FROM-INDEX INTO-INDEX'
Merge the index named in the first argument into the index named in
the second argument. Do not change the font of FROM-INDEX
entries. Note: Combining Indices.
`@t{TEXT}'
Print TEXT in a fixed-width, typewriter-like font. No effect in
Info. Note: Fonts.
`@tab'
Separate columns in a multitable. Note: Multitable Rows.
`@table FORMATTING-COMMAND'
Begin a two-column table, using `@item' for each entry. Write
each first column entry on the same line as `@item'. First column
entries are printed in the font resulting from FORMATTING-COMMAND.
Pair with `@end table'. *Note Making a Two-column Table:
Two-column Tables. Also see Note: `@ftable' and `@vtable',
and Note: `@itemx'.
`@TeX{}'
Insert the logo TeX. Note: Inserting TeX and (C).
`@tex'
Enter TeX completely. Pair with `@end tex'. Note: Raw Formatter
Commands.
`@thischapter'
`@thischaptername'
`@thisfile'
`@thispage'
`@thistitle'
Only allowed in a heading or footing. Stands for the number and
name of the current chapter (in the format `Chapter 1: Title'),
the chapter name only, the filename, the current page number, and
the title of the document, respectively. Note: How to Make Your
Own Headings.
`@tieaccent{CC}'
Generate a tie-after accent over the next two characters CC, as in
`oo['. Note: Inserting Accents.
`@tindex ENTRY'
Add ENTRY to the index of data types. Note: Defining the Entries
of an Index.
`@title TITLE'
In a printed manual, set a title flush to the left-hand side of the
page in a larger than normal font and underline it with a black
rule. Not relevant to Info, which does not have title pages.
Note: The `@title' `@subtitle' and `@author' Commands.
`@titlefont{TEXT}'
In a printed manual, print TEXT in a larger than normal font. Not
relevant to Info, which does not have title pages. Note: The
`@titlefont' `@center' and `@sp' Commands.
`@titlepage'
Indicate to Texinfo the beginning of the title page. Write
command on a line of its own. Pair with `@end titlepage'.
Nothing between `@titlepage' and `@end titlepage' appears in Info.
Note: `@titlepage'.
`@today{}'
Insert the current date, in `1 Jan 1900' style. Note: How to Make
Your Own Headings.
`@top TITLE'
In a Texinfo file to be formatted with `makeinfo', identify the
topmost `@node' line in the file, which must be written on the line
immediately preceding the `@top' command. Used for `makeinfo''s
node pointer insertion feature. The title is underlined with
asterisks. Both the `@node' line and the `@top' line normally
should be enclosed by `@ifinfo' and `@end ifinfo'. In TeX and
`texinfo-format-buffer', the `@top' command is merely a synonym
for `@unnumbered'. *Note Creating Pointers with `makeinfo':
makeinfo Pointer Creation.
`@u{C}'
`@ubaraccent{C}'
`@udotaccent{C}'
Generate a breve, underbar, or underdot accent, respectively, over
or under the character C, as in o(, o_, .o. Note: Inserting
Accents.
`@unnumbered TITLE'
In a printed manual, begin a chapter that appears without chapter
numbers of any kind. The title appears in the table of contents
of a printed manual. In Info, the title is underlined with
asterisks. Note: `@unnumbered' and `@appendix'.
`@unnumberedsec TITLE'
In a printed manual, begin a section that appears without section
numbers of any kind. The title appears in the table of contents
of a printed manual. In Info, the title is underlined with equal
signs. Note: Section Commands.
`@unnumberedsubsec TITLE'
In a printed manual, begin an unnumbered subsection within a
chapter. The title appears in the table of contents of a printed
manual. In Info, the title is underlined with hyphens. *Note
`@unnumberedsubsec' `@appendixsubsec' `@subheading':
unnumberedsubsec appendixsubsec subheading.
`@unnumberedsubsubsec TITLE'
In a printed manual, begin an unnumbered subsubsection within a
chapter. The title appears in the table of contents of a printed
manual. In Info, the title is underlined with periods. Note: The
`subsub' Commands.
`@uref{URL[, DISPLAYED-TEXT][, REPLACEMENT}'
Define a cross reference to an external uniform resource locator
for the World Wide Web. Note: `@uref'.
`@url{URL}'
Indicate text that is a uniform resource locator for the World Wide
Web. Note: `@url'.
`@v{C}'
Generate check accent over the character C, as in o<. Note:
Inserting Accents.
`@value{FLAG}'
Replace FLAG with the value to which it is set by `@set FLAG'.
Note: `@set' `@clear' `@value'.
`@var{METASYNTACTIC-VARIABLE}'
Highlight a metasyntactic variable, which is something that stands
for another piece of text. Note: Indicating Metasyntactic
Variables.
`@verb{DELIM LITERAL DELIM}'
Output LITERAL, delimited by the single character DELIM, exactly
as is (in the fixed-width font), including any whitespace or
Texinfo special characters. Note: `verb'.
`@verbatim'
Output the text of the environment exactly as is (in the
fixed-width font). Pair with `@end verbatim'. *Note `verbatim':
verbatim.
`@verbatiminclude FILENAME'
Output the contents of FILENAME exactly as is (in the fixed-width
font). Note: `verbatiminclude'.
`@vindex ENTRY'
Add ENTRY to the index of variables. Note: Defining the Entries
of an Index.
`@vskip AMOUNT'
In a printed manual, insert whitespace so as to push text on the
remainder of the page towards the bottom of the page. Used in
formatting the copyright page with the argument `0pt plus 1filll'.
(Note spelling of `filll'.) `@vskip' may be used only in
contexts ignored for Info. Note: The Copyright Page and Printed
Permissions.
`@vtable FORMATTING-COMMAND'
Begin a two-column table, using `@item' for each entry.
Automatically enter each of the items in the first column into the
index of variables. Pair with `@end vtable'. The same as
`@table', except for indexing. *Note `@ftable' and `@vtable':
ftable vtable.
`@w{TEXT}'
Prevent TEXT from being split across two lines. Do not end a
paragraph that uses `@w' with an `@refill' command. Note: `@w'.
`@xref{NODE-NAME, [ENTRY], [TOPIC-OR-TITLE], [INFO-FILE], [MANUAL]}'
Make a reference that starts with `See' in a printed manual.
Follow command with a punctuation mark. Only the first argument is
mandatory. Note: `@xref'.
automatically generated by info2www version 1.2.2.9