@-Command List

Here is an alphabetical list of the @-commands in Texinfo. Square brackets, [ ], indicate optional arguments; an ellipsis, `...', indicates repeated text.

@*

Force a line break. Do not end a paragraph that uses @* with an @refill command. See section @*: Generate Line Breaks.

@.

Stands for a period that really does end a sentence (usually after an end-of-sentence capital letter). See section Spacing After Colons and Periods.

@:

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. See section Spacing After Colons and Periods.

@@

Stands for `@'. See section Inserting `@', Braces, and Periods.

@{

Stands for a left-hand brace, `{'.
See section Inserting `@', Braces, and Periods.

@}

Stands for a right-hand brace, `}'.
See section Inserting `@', Braces, and Periods.

@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. See section @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. See section @unnumberedsec, @appendixsec, @heading.

@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. See section The @subsection-like Commands.

@appendixsubsubsec title

Begin an appendix subsubsection within a subappendix. The title appears in the table of contents of a printed manual. In Info, the title is underlined with periods. See section The `subsub' Commands.

@asis

Used following @table, @ftable, and @vtable to print the table's first column without highlighting ("as is"). See section Making a Two-column Table.

@author author

Typeset author flushleft and underline it. See section @title, @subtitle, and @author.

@b{text}

Print text in bold font. No effect in Info. See section Fonts for Printing, Not Info.

@bullet{}

Generate a large round dot, or the closest possible thing to one. See section @bullet{}.

@bye

Stop formatting a file. The formatters do not see the contents of a file following an @bye command. See section Ending a Texinfo 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. See section Comments.

@cartouche

Highlight an example or quotation by drawing a box with rounded corners around it. Pair with @end cartouche. No effect in Info. See section Drawing Cartouches Around Examples.)

@center line-of-text

Center the line of text following the command. See section @titlefont, @center, and @sp.

@lowersections

Change subsequent chapters to sections, sections to subsections, and so on. See section @raisesections and @lowersections.

@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. See section @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. See section @chapter.

@cindex entry

Add entry to the index of concepts. See section Making Index Entries.

@cite{reference}

Highlight the name of a book or other reference that lacks a companion Info file. See section @cite{reference}.

@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. See section @set, @clear, and @value.

@code{sample-code}

Highlight text that is an expression, a syntactically complete token of a program, or a program name. See section @code{sample-code}.

@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. See section Comments.

@contents

Print a complete table of contents. Has no effect in Info, which uses menus instead. See section Generating a Table of Contents.

@copyright{}

Generate a copyright symbol. See section @copyright{}.

@defcodeindex index-name

Define a new index and its indexing command. Print entries in an @code font. See section Defining New Indices.

@defcv 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. See section Definition Commands.

@deffn 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. See section Definition Commands.

@defindex index-name

Define a new index and its indexing command. Print entries in a roman font. See section Defining New Indices.

@definfoenclose new-command, before, after,

Create new @-command for Info that marks text by enclosing it in strings that precede and follow the text. Write definition inside of @ifinfo ... @end ifinfo. See section Customized Highlighting.

@defivar 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} ...'. See section Definition Commands.

@defmac macro-name arguments...

Format a description for a macro. The command is equivalent to `@deffn Macro ...'. See section Definition Commands.

@defmethod 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. See section Definition Commands.

@defop 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. See section Definition Commands.

@defopt option-name

Format a description for a user option. The command is equivalent to `@defvr {User Option} ...'. See section Definition Commands.

@defspec special-form-name arguments...

Format a description for a special form. The command is equivalent to `@deffn {Special Form} ...'. See section Definition Commands.

@deftp 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. See section Definition Commands.

@deftypefn 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. See section Definition Commands.

@deftypefun data-type function-name arguments...

Format a description for a function in a typed language. The command is equivalent to `@deftypefn Function ...'. See section Definition Commands.

@deftypevr 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. See section Definition Commands.

@deftypevar data-type variable-name

Format a description for a variable in a typed language. The command is equivalent to `@deftypevr Variable ...'. See section Definition Commands.

@defun function-name arguments...

Format a description for functions. The command is equivalent to `@deffn Function ...'. See section Definition Commands.

@defvar variable-name

Format a description for variables. The command is equivalent to `@defvr Variable ...'. See section Definition Commands.

@defvr 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. See section Definition Commands.

@dfn{term}

Highlight the introductory or defining use of a term. See section @dfn{term}.

@display

Begin a kind of example. Indent text, do not fill, do not select a new font. Pair with @end display. See section @display.

@dmn{dimension}

Format a dimension. Cause TeX to insert a narrow space before dimension. No effect in Info. Use for writing a number followed by an abbreviation of a dimension name, such as `12pt', written as `12@dmn{pt}', with no space between the number and the @dmn command. See section @dmn{dimension}: Format a Dimension.

@dots{}

Insert an ellipsis: `...'. See section @dots{}.

@emph{text}

Highlight text; text is displayed in italics in printed output, and surrounded by asterisks in Info. See section Emphasizing Text.

@enumerate [number-or-letter]

Begin a numbered list, using @item for each entry. Optionally, start list with number-or-letter. Pair with @end enumerate. See section Making a Numbered or Lettered List.

@equiv{}

Indicate to the reader the exact equivalence of two forms with a glyph: `=='. See section ==: Indicating Equivalence.

@error{}

Indicate to the reader with a glyph that the following text is an error message: `error-->'. See section error-->: Indicating an Error Message.

@evenfooting [left] @| [center] @| [right]

Specify page footings for even-numbered (left-hand) pages. Not relevant to Info. See section How to Make Your Own Headings.

@evenheading [left] @| [center] @| [right]

Specify page headings for even-numbered (left-hand) pages. Not relevant to Info. See section How to Make Your Own Headings.

@everyfooting [left] @| [center] @| [right]

Specify page footings for every page. Not relevant to Info. See section How to Make Your Own Headings.

@everyheading [left] @| [center] @| [right]

Specify page headings for every page. Not relevant to Info. See section How to Make Your Own Headings.

@example

Begin an example. Indent text, do not fill, and select fixed-width font. Pair with @end example. See section @example.

@exdent line-of-text

Remove any indentation a line might have. See section @exdent: Undoing a Line's Indentation.

@expansion{}

Indicate the result of a macro expansion to the reader with a special glyph: `==>'. See section ==>: Indicating an Expansion.

@file{filename}

Highlight the name of a file, buffer, node, or directory. See section @file{file-name}.

@finalout

Prevent TeX from printing large black warning rectangles beside over-wide lines. See section Overfull "hboxes".

@findex entry

Add entry to the index of functions. See section Making Index Entries.

@flushleft

Left justify every line but leave the right end ragged. Leave font as is. Pair with @end flushleft. See section @flushleft and @flushright.

@flushright

Right justify every line but leave the left end ragged. Leave font as is. Pair with @end flushright. See section @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. See section Footnotes.

@footnotestyle style

Specify an Info file's footnote style, either `end' for the end node style or `separate' for the separate node style. See section Footnotes.

@format

Begin a kind of example. Like @example or @display, but do not narrow the margins and do not select the fixed-width font. Pair with @end format. See section @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. See section @ftable and @vtable.

@group

Hold text together that must appear on one printed page. Pair with @end group. Not relevant to Info. See section @group: Prevent Page Breaks.

@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. See section @unnumberedsec, @appendixsec, @heading.

@headings on-off-single-double

Turn page headings on or off, or specify single-sided or double-sided page headings for printing. @headings on is synonymous with @headings double. See section The @headings Command.

@i{text}

Print text in italic font. No effect in Info. See section Fonts for Printing, Not Info.

@ifclear flag

If flag is cleared, the Texinfo formatting commands format text between @ifclear flag and the following @end ifclear command. See section @set, @clear, and @value.

@ifinfo

Begin a stretch of text that will be ignored by TeX when it typesets the printed manual. The text appears only in the Info file. Pair with @end ifinfo. See section Conditionally Visible Text.

@ifset flag

If flag is set, the Texinfo formatting commands format text between @ifset flag and the following @end ifset command. See section @set, @clear, and @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. See section 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. See section Comments.

@include filename

Incorporate the contents of the file filename into the Info file or printed document. See section 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. See section @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 properly recognize @ until after it has read the definitions file. See section 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. See section Making 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. See section Making an Itemized List.

@itemx

Like @item but do not generate extra vertical space above the item text. See section @itemx.

@kbd{keyboard-characters}

Indicate text that consists of characters of input to be typed by users. See section @kbd{keyboard-characters}.

@key{key-name}

Highlight key-name, a conventional name for a key on a keyboard. See section @key{key-name}.

@kindex entry

Add entry to the index of keys. See section Making Index Entries.

@global@letnew-command=existing-command

Equate a new highlighting command with an existing one. Only for TeX. Write definition inside of @iftex ... @end iftex. See section Customized Highlighting.

@lisp

Begin an example of Lisp code. Indent text, do not fill, and select fixed-width font. Pair with @end lisp. See section @lisp.

@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. See section @majorheading, @chapheading.

@math{mathematical-expression}

Format a mathematical expression. See section @math: Inserting Mathematical Expressions.

@menu

Mark the beginning of a menu of nodes in Info. No effect in a printed manual. Pair with @end menu. See section Menus.

@minus{}

Generate a minus sign. See section @minus{}: Inserting a Minus Sign.

@need n

Start a new page in a printed manual if fewer than n mils (thousandths of an inch) remain on the current page. See section @need mils: Prevent Page Breaks.

@node name, next, previous, up

Define the beginning of a new node in Info, and serve as a locator for references for TeX. See section The @node Command.

@noindent

Prevent text from being indented as if it were a new paragraph. See section @noindent.

@oddfooting [left] @| [center] @| [right]

Specify page footings for odd-numbered (right-hand) pages. Not relevant to Info. See section How to Make Your Own Headings.

@oddheading [left] @| [center] @| [right]

Specify page headings for odd-numbered (right-hand) pages. Not relevant to Info. See section How to Make Your Own Headings.

@page

Start a new page in a printed manual. No effect in Info. See section @page: Start a New Page.

@paragraphindent indent

Indent paragraphs by indent number of spaces; delete indentation if the value of indent is 0; and do not change indentation if indent is asis. See section Paragraph Indenting.

@pindex entry

Add entry to the index of programs. See section Making Index Entries.

@point{}

Indicate the position of point in a buffer to the reader with a glyph: `-!-'. See section Indicating Point in a Buffer.

@print{}

Indicate printed output to the reader with a glyph: `-|'. See section -|: Indicating Printed Output.

@printindex index-name

Print an alphabetized two-column index in a printed manual or generate an alphabetized menu of index entries for Info. See section Index Menus and Printing an Index.

@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, which is why you do not need to insert punctuation. Only the first argument is mandatory. See section @pxref.

@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. See section @quotation.

@r{text}

Print text in roman font. No effect in Info. See section Fonts for Printing, Not Info.

@raisesections

Change subsequent sections to chapters, subsections to sections, and so on. See section @raisesections and @lowersections.

@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. See section @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. See section Refilling Paragraphs.

@result{}

Indicate the result of an expression to the reader with a special glyph: `=>'. See section =>: Indicating Evaluation.

@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. See section @samp{text}.

@sc{text}

Set text in a printed output in THE SMALL CAPS FONT and set text in the Info file in uppercase letters. See section @sc{text}: The Small Caps Font.

@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. See 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. See section @set, @clear, and @value.

@setchapternewpage on-off-odd

Specify whether chapters start on new pages, and if so, whether on odd-numbered (right-hand) new pages. See section @setchapternewpage.

@setfilename info-file-name

Provide a name to be used by the Info file. See section @setfilename.

@settitle title

Provide a title for page headers in a printed manual. See section @settitle.

@shortcontents

Print a short table of contents. Not relevant to Info, which uses menus rather than tables of contents. A synonym for @summarycontents. See section Generating a Table of Contents.

@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. See section Printing "Small" Books. Also, see section @smallexample and @smalllisp.

@smallexample

Indent text to indicate an example. Do not fill, select fixed-width font. In @smallbook format, print text in a smaller font than with @example. Pair with @end smallexample. See section @smallexample and @smalllisp.

@smalllisp

Begin an example of Lisp code. Indent text, do not fill, select fixed-width font. In @smallbook format, print text in a smaller font. Pair with @end smalllisp. See section @smallexample and @smalllisp.

@sp n

Skip n blank lines. See section @sp n: Insert Blank Lines.

@strong text

Emphasize text by typesetting it in a bold font for the printed manual and by surrounding it with asterisks for Info. See section @emph{text} and @strong{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. See section The @subsection-like Commands.

@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. See section The @subsection Command.

@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. See section The `subsub' Commands.

@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. See section 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. See section @title, @subtitle, and @author.

@summarycontents

Print a short table of contents. Not relevant to Info, which uses menus rather than tables of contents. A synonym for @shortcontents. See section 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. See section 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. See section Combining Indices.

@t{text}

Print text in a fixed-width, typewriter-like font. No effect in Info. See section Fonts for Printing, Not Info.

@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. See section Making a Two-column Table. Also see section @ftable and @vtable, and section @itemx.

@TeX{}

Insert the logo TeX. See section Inserting TeX and the Copyright Symbol.

@tex

Enter TeX completely. Pair with @end tex. See section Using Ordinary TeX Commands.

@thischapter

In a heading or footing, stands for the number and name of the current chapter, in the format `Chapter 1: Title'. See section How to Make Your Own Headings.

@thischaptername

In a heading or footing, stands for the name of the current chapter. See section How to Make Your Own Headings.

@thisfile

In a heading or footing, stands for the name of the current @include file. Does not insert anything if not within an @include file. See section How to Make Your Own Headings.

@thispage

In a heading or footing, stands for the current page number. See section How to Make Your Own Headings.

@thistitle

In a heading or footing, stands for the name of the document, as specified by the @settitle command. See section How to Make Your Own Headings.

@tindex entry

Add entry to the index of data types. See section Making Index Entries.

@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. See section @title, @subtitle, and @author.

@titlefont{text}

In a printed manual, print text in a larger than normal font. Not relevant to Info, which does not have title pages. See section @titlefont, @center, and @sp.

@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. See section @titlepage.

@today{}

Insert the current date, in `1 Jan 1900' style. See section 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. See section Creating Pointers with makeinfo.

@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. See section @unnumbered, @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. See section @unnumberedsec, @appendixsec, @heading.

@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. See section The @subsection-like Commands.

@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. See section The `subsub' Commands.

@value{flag}

Replace flag with the value to which it is set by @set flag. See section @set, @clear, and @value.

@var{metasyntactic-variable}

Highlight a metasyntactic variable, which is something that stands for another piece of text. See section @var{metasyntactic-variable}.

@vindex entry

Add entry to the index of variables. See section Making Index Entries.

@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. See section Copyright Page and 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. See section @ftable and @vtable.

@w{text}

Prevent text from being split across two lines. Do not end a paragraph that uses @w with an @refill command. In the Texinfo file, keep text on one line. See section @w{text}: Prevent Line Breaks.

@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. See section @xref.