Next: , Previous: , Up: Top   [Contents][Index]


Appendix A @-Command List

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

More specifics on the general syntax of different @-commands are given in the section below.


@whitespace

An @ followed by a space, tab, or newline produces a normal, stretchable, interword space. See Multiple Spaces.

@!

Produce an exclamation point that ends a sentence (usually after an end-of-sentence capital letter). See Ending a Sentence.

@"
@'

Generate an umlaut or acute accent, respectively, over the next character, as in ö and ó. See Inserting Accents.

@*

Force a line break. See Line Breaks.

@,{c}

Generate a cedilla accent under c, as in ç. See Inserting Accents.

@-

Insert a discretionary hyphenation point. See @- @hyphenation.

@.

Produce a period that ends a sentence (usually after an end-of-sentence capital letter). See Ending a Sentence.

@/

Produces no output, but allows a line break. See Line Breaks.

@:

Tell TeX to refrain from inserting extra whitespace after an immediately preceding period, question mark, exclamation mark, or colon, as TeX normally would. See Not Ending a Sentence.

@=

Generate a macron (bar) accent over the next character, as in ō. See Inserting Accents.

@?

Produce a question mark that ends a sentence (usually after an end-of-sentence capital letter). See Ending a Sentence.

@@
@atchar{}

Insert an at sign, ‘@’. See Inserting an Atsign.

@\
@backslashchar{}

Insert a backslash, ‘\’; @backslashchar{} works anywhere, while @\ works only inside @math. See Inserting a Backslash, and Inserting Math.

@^
@`

Generate a circumflex (hat) or grave accent, respectively, over the next character, as in ô and è. See Inserting Accents.

@{
@lbracechar{}

Insert a left brace, ‘{’. See Inserting Braces.

@}
@rbracechar{}

Insert a right brace, ‘}’. See Inserting Braces.

@~

Generate a tilde accent over the next character, as in Ñ. See Inserting Accents.

@AA{}
@aa{}

Generate the uppercase and lowercase Scandinavian A-ring letters, respectively: Å, å. See Inserting Accents.

@abbr{abbreviation}

Indicate a general abbreviation, such as ‘Comput.’. See @abbr.

@acronym{acronym}

Indicate an acronym in all capital letters, such as ‘NASA’. See @acronym.

@AE{}
@ae{}

Generate the uppercase and lowercase AE ligatures, respectively: Æ, æ. See Inserting Accents.

@afivepaper

Change page dimensions for the A5 paper size. See A4 Paper.

@afourlatex
@afourpaper
@afourwide

Change page dimensions for the A4 paper size. See A4 Paper.

@alias new=existing

Make the command ‘@new’ a synonym for the existing command ‘@existing’. See @alias.

@allowcodebreaks true-false

Control breaking at ‘-’ and ‘_’ in TeX. See @allowcodebreaks.

@anchor{name}

Define name as the current location for use as a cross reference target. See @anchor.

@appendix title

Begin an appendix. The title appears in the table of contents. In Info, the title is underlined with asterisks. See @unnumbered @appendix.

@appendixsec title
@appendixsection title

Begin an appendix section within an appendix. The section title appears in the table of contents. In Info, the title is underlined with equal signs. @appendixsection is a longer spelling of the @appendixsec command. See @unnumberedsec @appendixsec @heading.

@appendixsubsec title

Begin an appendix subsection. The title appears in the table of contents. In Info, the title is underlined with hyphens. See @unnumberedsubsec @appendixsubsec @subheading.

@appendixsubsubsec title

Begin an appendix subsubsection. The title appears in the table of contents. In Info, the title is underlined with periods. See @subsubsection.

@arrow{}

Generate a right arrow glyph: ‘’. Used by default for @click. See Click Sequences.

@asis

Used following @table, @ftable, and @vtable to print the table’s first column without highlighting (“as is”). See @asis.

@author author

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

@b{text}

Set text in a bold font. No effect in Info. See Fonts.

@bullet{}

Generate a large round dot, • (‘*’ in Info). Often used with @table. See @bullet.

@bye

Stop formatting a file. The formatters do not see anything in the input file following @bye. See Ending a File.

@c comment

Begin a comment in Texinfo. The rest of the line does not appear in any output. A synonym for @comment. DEL also starts a comment. See Comments.

@caption

Define the full caption for an @float. See @caption @shortcaption.

@cartouche

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

@center line-of-text

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

@centerchap line-of-text

Like @chapter, but centers the chapter title. See @chapter.

@chapheading title

Print an unnumbered chapter-like heading, but omit from the table of contents. In Info, the title is underlined with asterisks. See @majorheading @chapheading.

@chapter title

Begin a numbered chapter. The chapter title appears in the table of contents. In Info, the title is underlined with asterisks. See @chapter.

@cindex entry

Add entry to the index of concepts. See Defining the Entries of an Index.

@cite{reference}

Highlight the name of a book or other reference that has no companion Info file. See @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. See @set @clear @value.

@click{}

Represent a single “click” in a GUI. Used within @clicksequence. See Click Sequences.

@clicksequence{action @click{} action}

Represent a sequence of clicks in a GUI. See Click Sequences.

@clickstyle @cmd

Execute @cmd for each @click; the default is @arrow. The usual following empty braces on @cmd are omitted. See Click Sequences.

@code{sample-code}

Indicate an expression, a syntactically complete token of a program, or a program name. Unquoted in Info output. See @code.

@codequotebacktick on-off
@codequoteundirected on-off

Control output of ` and ' in code examples. See Inserting Quote Characters.

@comma{}

Insert a comma ‘,’ character; only needed when a literal comma would be taken as an argument separator. See Inserting a Comma.

@command{command-name}

Indicate a command name, such as ls. See @command.

@comment comment

Begin a comment in Texinfo. The rest of the line does not appear in any output. A synonym for @c. See Comments.

@contents

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

@copying

Specify copyright holders and copying conditions for the document Pair with @end cartouche. See @copying.

@copyright{}

Generate the copyright symbol ©. See @copyright.

@defcodeindex index-name

Define a new index and its indexing command. Print entries in an @code font. See 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. See Definition Commands.

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

@defindex index-name

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

@definfoenclose newcmd, before, after

Must be used within @ifinfo; create a new command @newcmd for Info that marks text by enclosing it in strings that precede and follow the text. See @definfoenclose.

@defivar class instance-variable-name
@defivarx class instance-variable-name

Format a description for an instance variable in object-oriented programming. The command is equivalent to ‘@defcv {Instance Variable} …’. See Definition Commands.

@defmac macroname arguments
@defmacx macroname arguments

Format a description for a macro; equivalent to ‘@deffn Macro …’. See Definition Commands.

@defmethod class method-name arguments
@defmethodx class method-name arguments

Format a description for a method in object-oriented programming; equivalent to ‘@defop Method …’. See Definition Commands.

@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 name of the category of operation, the name of the operation’s class, the name of the operation, and its arguments, if any. See Definition Commands, and Abstract Objects.

@defopt option-name
@defoptx option-name

Format a description for a user option; equivalent to ‘@defvr {User Option} …’. See Definition Commands.

@defspec special-form-name arguments
@defspecx special-form-name arguments

Format a description for a special form; equivalent to ‘@deffn {Special Form} …’. See Definition Commands.

@deftp category name-of-type attributes
@deftpx category name-of-type attributes

Format a description for a data type; its arguments are the category, the name of the type (e.g., ‘int’) , and then the names of attributes of objects of that type. See Definition Commands, and Data Types.

@deftypecv category class data-type name
@deftypecvx category class data-type name

Format a description for a typed class variable in object-oriented programming. See Definition Commands, and Abstract Objects.

@deftypefn category data-type name arguments
@deftypefnx category 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 category of entity being described, the type, the name of the entity, and its arguments, if any. See Definition Commands.

@deftypefnnewline on-off

Specifies whether return types for @deftypefn and similar are printed on lines by themselves; default is off. See Functions in Typed Languages.

@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 …’. See Definition Commands.

@deftypeivar class data-type variable-name
@deftypeivarx class data-type variable-name

Format a description for a typed instance variable in object-oriented programming. See Definition Commands, and 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. See Definition Commands.

@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. See Definition Commands, and 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 …’. See Definition Commands.

@deftypevr category data-type name
@deftypevrx category 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 category of entity being described, the type, and the name of the entity. See Definition Commands.

@defun function-name arguments
@defunx function-name arguments

Format a description for a function; equivalent to ‘@deffn Function …’. See Definition Commands.

@defvar variable-name
@defvarx variable-name

Format a description for a variable; equivalent to ‘@defvr Variable …’. See Definition Commands.

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

@detailmenu

Mark the (optional) detailed node listing in a master menu. See Master Menu Parts.

@dfn{term}

Indicate the introductory or defining use of a term. See @dfn.

@DH{}
@dh{}

Generate the uppercase and lowercase Icelandic letter eth, respectively: Ð, ð. See Inserting Accents.

@dircategory dirpart

Specify a part of the Info directory menu where this file’s entry should go. See Installing Dir Entries.

@direntry

Begin the Info directory menu entry for this file. Pair with @end direntry. See 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. See @display.

@dmn{dimension}

Format a unit of measure, as in 12pt. Causes TeX to insert a thin space before dimension. No effect in Info. See @dmn.

@docbook

Enter Docbook completely. Pair with @end docbook. See Raw Formatter Commands.

@documentdescription

Set the document description text, included in the HTML output. Pair with @end documentdescription. See @documentdescription.

@documentencoding enc

Declare the input encoding to be enc. See @documentencoding.

@documentlanguage CC

Declare the document language as the two-character ISO-639 abbreviation CC. See @documentlanguage.

@dotaccent{c}

Generate a dot accent over the character c, as in ȯ. See Inserting Accents.

@dotless{i-or-j}

Generate dotless i (‘i’) and dotless j (‘j’). See Inserting Accents.

@dots{}

Generate an ellipsis, ‘’. See @dots.

@email{address[, displayed-text]}

Indicate an electronic mail address. See @email.

@emph{text}

Emphasize text, by using italics where possible, and enclosing in asterisks in Info. See Emphasizing Text.

@end environment

Ends environment, as in ‘@end example’. See @-commands.

@enddots{}

Generate an end-of-sentence ellipsis, like this: ... See @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. See @enumerate.

@env{environment-variable}

Indicate an environment variable name, such as PATH. See @env.

@equiv{}

Indicate to the reader the exact equivalence of two forms with a glyph: ‘’. See @equiv.

@error{}

Indicate to the reader with a glyph that the following text is an error message: ‘error→’. See @error.

@errormsg{msg}

Report msg as an error to standard error, and exit unsuccessfully. Texinfo commands within msg are expanded to plain text. See Conditionals, and External Macro Processors.

@euro{}

Generate the Euro currency sign. See @euro.

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

Specify page footings resp. headings for even-numbered (left-hand) pages. See 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. See 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 @example.

@exampleindent indent

Indent example-like environments by indent number of spaces (perhaps 0). See @exampleindent.

@exclamdown{}

Generate an upside-down exclamation point. See Inserting Accents.

@exdent line-of-text

Remove any indentation a line might have. See @exdent.

@expansion{}

Indicate the result of a macro expansion to the reader with a special glyph: ‘’. See @expansion.

@file{filename}

Highlight the name of a file, buffer, node, directory, etc. See @file.

@finalout

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

@findex entry

Add entry to the index of functions. See Defining the Entries of an Index.

@firstparagraphindent word

Control indentation of the first paragraph after section headers according to word, one of ‘none’ or ‘insert’. See @firstparagraphindent.

@float

Environment to define floating material. Pair with @end float. See Floats.

@flushleft
@flushright

Do not fill text; left (right) justify every line while leaving the right (left) end ragged. Leave font as is. Pair with @end flushleft (@end flushright). See @flushleft @flushright.

@fonttextsize 10-11

Change the size of the main body font in the TeX output. See Fonts.

@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 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 Footnotes.

@format

Begin a kind of example. Like @display, but do not indent. Pair with @end format. See @example.

@frenchspacing on-off

Control spacing after punctuation. See @frenchspacing.

@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 @ftable @vtable.

@geq{}

Generate a greater-than-or-equal sign, ‘≥’. See @geq @leq.

@group

Disallow page breaks within following text. Pair with @end group. Ignored in Info. See @group.

@guillemetleft{}
@guillemetright{}
@guillemotleft{}
@guillemotright{}
@guilsinglleft{}
@guilsinglright{}

Double and single angle quotation marks: « » ‹ ›. @guillemotleft and @guillemotright are synonyms for @guillemetleft and @guillemetright. See Inserting Quotation Marks.

@H{c}

Generate the long Hungarian umlaut accent over c, as in ő.

@hashchar{}

Insert a hash ‘#’ character; only needed when a literal hash would introduce #line directive. See Inserting a Hashsign, and External Macro Processors.

@heading title

Print an unnumbered section-like heading, but omit from the table of contents. In Info, the title is underlined with equal signs. See @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. See @headings.

@headitem

Begin a heading row in a multitable. See Multitable Rows.

@headitemfont{text}

Set text in the font used for multitable heading rows; mostly useful in multitable templates. See Multitable Rows.

@html

Enter HTML completely. Pair with @end html. See Raw Formatter Commands.

@hyphenation{hy-phen-a-ted words}

Explicitly define hyphenation points. See @- @hyphenation.

@i{text}

Set text in an italic font. No effect in Info. See Fonts.

@ifclear txivar

If the Texinfo variable txivar is not set, format the following text. Pair with @end ifclear. See @set @clear @value.

@ifcommanddefined txicmd
@ifcommandnotdefined txicmd

If the Texinfo code ‘@txicmd’ is (not) defined, format the follow text. Pair with the corresponding @end ifcommand.... See Testing for Texinfo Commands.

@ifdocbook
@ifhtml
@ifinfo

Begin text that will appear only in the given output format. @ifinfo output appears in both Info and (for historical compatibility) plain text output. Pair with @end ifdocbook resp. @end ifhtml resp. @end ifinfo. See Conditionals.

@ifnotdocbook
@ifnothtml
@ifnotplaintext
@ifnottex
@ifnotxml

Begin text to be ignored in one output format but not the others. @ifnothtml text is omitted from HTML output, etc. Pair with the corresponding @end ifnotformat. See Conditionals.

@ifnotinfo

Begin text to appear in output other than Info and (for historical compatibility) plain text. Pair with @end ifnotinfo. See Conditionals.

@ifplaintext

Begin text that will appear only in the plain text output. Pair with @end ifplaintext. See Conditionals.

@ifset txivar

If the Texinfo variable txivar is set, format the following text. Pair with @end ifset. See @set @clear @value.

@iftex

Begin text to appear only in the TeX output. Pair with @end iftex. See Conditionally Visible Text.

@ifxml

Begin text that will appear only in the XML output. Pair with @end ifxml. See Conditionals.

@ignore

Begin text that will not appear in any output. Pair with @end ignore. See 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. See Images.

@include filename

Read the contents of Texinfo source file filename. See Include Files.

@indent

Insert paragraph indentation. See @indent.

@indentedblock

Indent a block of arbitary text on the left. Pair with @end indentedblock. See @indentedblock.

@indicateurl{indicateurl}

Indicate text that is a uniform resource locator for the World Wide Web. See @indicateurl.

@inforef{node-name, [entry-name], info-file-name}

Make a cross reference to an Info file for which there is no printed manual. See @inforef.

@inlinefmt{fmt, text}

Insert text only if the output format is fmt. See Inline Conditionals.

@inlinefmtifelse{fmt, text, else-text}

Insert text if the output format is fmt, else else-text.

@inlineifclear{var, text}
@inlineifset{var, text}

Insert text only if the Texinfo variable var is (not) set.

@inlineraw{fmt, raw-text}

Insert text as in a raw conditional, only if the output format is fmt.

\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 \ in \input is used instead of an @ because TeX does not recognize @ until after it has read the definitions file. See Texinfo File Header.

@insertcopying

Insert the text previously defined with the @copying environment. See @insertcopying.

@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 Lists and Tables.

@itemize mark-generating-character-or-command

Begin an unordered list: indented paragraphs with a mark, such as @bullet, inside the left margin at the beginning of each item. Pair with @end itemize. See @itemize.

@itemx

Like @item but do not generate extra vertical space above the item text. Thus, when several items have the same description, use @item for the first and @itemx for the others. See @itemx.

@kbd{keyboard-characters}

Indicate characters of input to be typed by users. See @kbd.

@kbdinputstyle style

Specify when @kbd should use a font distinct from @code according to style: code, distinct, example. See @kbd.

@key{key-name}

Indicate the name of a key on a keyboard. See @key.

@kindex entry

Add entry to the index of keys. See Defining the Entries of an Index.

@L{}
@l{}

Generate the uppercase and lowercase Polish suppressed-L letters, respectively: Ł, ł.

@LaTeX{}

Generate the LaTeX logo. See @TeX @LaTeX.

@leq{}

Generate a less-than-or-equal sign, ‘≤’. See @geq @leq.

@lisp

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

@listoffloats

Produce a table-of-contents-like listing of @floats. See @listoffloats.

@lowersections

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

@macro macroname {params}

Define a new Texinfo command @macroname{params}. Pair with @end macro. See Defining Macros.

@majorheading title

Print an unnumbered chapter-like heading, but omit from the table of contents. This generates more vertical whitespace before the heading than the @chapheading command. See @majorheading @chapheading.

@math{mathematical-expression}

Format a mathematical expression. See Inserting Math.

@menu

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

@minus{}

Generate a minus sign, ‘-’. See @minus.

@multitable column-width-spec

Begin a multi-column table. Begin each row with @item or @headitem, and separate columns with @tab. Pair with @end multitable. See 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. See @need.

@node name, next, previous, up

Begin a new node. See @node.

@noindent

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

@novalidate

Suppress validation of node references and omit creation of auxiliary files with TeX. Use before @setfilename. See Pointer Validation.

@O{}
@o{}

Generate the uppercase and lowercase O-with-slash letters, respectively: Ø, ø.

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

Specify page footings resp. headings for odd-numbered (right-hand) pages. See How to Make Your Own Headings.

@OE{}
@oe{}

Generate the uppercase and lowercase OE ligatures, respectively: Œ, œ. See Inserting Accents.

@ogonek{c}

Generate an ogonek diacritic under the next character, as in ą. See Inserting Accents.

@option{option-name}

Indicate a command-line option, such as -l or --help. See @option.

@ordf{}
@ordm{}

Generate the feminine and masculine Spanish ordinals, respectively: ª, º. See Inserting Accents.

@page

Start a new page in a printed manual. No effect in Info. See @page.

@pagesizes [width][, height]

Change page dimensions. See pagesizes.

@paragraphindent indent

Indent paragraphs by indent number of spaces (perhaps 0); preserve source file indentation if indent is asis. See @paragraphindent.

@part title

Begin a group of chapters or appendixes; included in the tables of contents and produces a page of its own in printed output. See @part.

@pindex entry

Add entry to the index of programs. See Defining the Entries of an Index.

@point{}

Indicate the position of point in a buffer to the reader with a glyph: ‘’. See @point.

@pounds{}

Generate the pounds sterling currency sign. See @pounds.

@print{}

Indicate printed output to the reader with a glyph: ‘-|’. See @print.

@printindex index-name

Generate the alphabetized index for index-name (using two columns in a printed manual). See Printing Indices & Menus.

@pxref{node, [entry], [node-title], [info-file], [manual]}

Make a reference that starts with a lowercase ‘see’ in a printed manual. Use within parentheses only. Only the first argument is mandatory. See @pxref.

@questiondown{}

Generate an upside-down question mark. See Inserting Accents.

@quotation

Narrow the margins to indicate text that is quoted from another work. Takes optional argument specifying prefix text, e.g., an author name. Pair with @end quotation. See @quotation.

@quotedblleft{}
@quotedblright{}
@quoteleft{}
@quoteright{}
@quotedblbase{}
@quotesinglbase{}

Produce various quotation marks: “ ” ‘ ’ „ ‚. See Inserting Quotation Marks.

@r{text}

Set text in the regular roman font. No effect in Info. See Fonts.

@raggedright

Fill text; left justify every line while leaving the right end ragged. Leave font as is. Pair with @end raggedright. No effect in Info. See @raggedright.

@raisesections

Change subsequent sections to chapters, subsections to sections, and so on. See Raise/lower sections.

@ref{node, [entry], [node-title], [info-file], [manual]}

Make a plain reference that does not start with any special text. Follow command with a punctuation mark. Only the first argument is mandatory. See @ref.

@refill

This command used to refill and indent the paragraph after all the other processing has been done. It is no longer needed, since all formatters now automatically refill as needed, but you may still see it in the source to some manuals, as it does no harm.

@registeredsymbol{}

Generate the legal symbol ®. See @registeredsymbol.

@result{}

Indicate the result of an expression to the reader with a special glyph: ‘’. See @result.

@ringaccent{c}

Generate a ring accent over the next character, as in o*. See Inserting Accents.

@samp{text}

Indicate a literal example of a sequence of characters, in general. Quoted in Info output. See @samp.

@sansserif{text}

Set text in a sans serif font if possible. No effect in Info. See Fonts.

@sc{text}

Set text in a small caps font in printed output, and uppercase in Info. See Smallcaps.

@section title

Begin a section within a chapter. The section title appears in the table of contents. In Info, the title is underlined with equal signs. Within @chapter and @appendix, the section title is numbered; within @unnumbered, the section is unnumbered. See @section.

@set txivar [string]

Define the Texinfo variable txivar, optionally to the value string. See @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. See @setchapternewpage.

@setcontentsaftertitlepage

Put the table of contents after the ‘@end titlepage’ even if the @contents command is at the end. See Contents.

@setfilename info-file-name

Provide a name to be used for the output files. This command is essential for TeX formatting as well, even though it produces no output of its own. See @setfilename.

@setshortcontentsaftertitlepage

Place the short table of contents after the ‘@end titlepage’ command even if the @shortcontents command is at the end. See Contents.

@settitle title

Specify the title for page headers in a printed manual, and the default document title for HTML ‘<head>’. See @settitle.

@shortcaption

Define the short caption for an @float. See @caption @shortcaption.

@shortcontents

Print a short table of contents, with chapter-level entries only. Not relevant to Info, which uses menus rather than tables of contents. See Generating a Table of Contents.

@shorttitlepage title

Generate a minimal title page. See @titlepage.

@slanted{text}

Set text in a slanted font if possible. No effect in Info. See Fonts.

@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 @smallbook. Also, see @small….

@smalldisplay

Begin a kind of example. Like @display, but use a smaller font size where possible. Pair with @end smalldisplay. See @small….

@smallexample

Begin an example. Like @example, but use a smaller font size where possible. Pair with @end smallexample. See @small….

@smallformat

Begin a kind of example. Like @format, but use a smaller font size where possible. Pair with @end smallformat. See @small….

@smallindentedblock

Like @indentedblock, but use a smaller font size where possible. Pair with @end smallindentedblock. See @small….

@smalllisp

Begin an example of Lisp code. Same as @smallexample. Pair with @end smalllisp. See @small….

@smallquotation

Like @quotation, but use a smaller font size where possible. Pair with @end smallquotation. See @small….

@sp n

Skip n blank lines. See @sp.

@ss{}

Generate the German sharp-S es-zet letter, ß. See Inserting Accents.

@strong {text}

Emphasize text more strongly than @emph, by using boldface where possible; enclosed in asterisks in Info. See Emphasizing Text.

@subheading title

Print an unnumbered subsection-like heading, but omit from the table of contents of a printed manual. In Info, the title is underlined with hyphens. See @unnumberedsubsec @appendixsubsec @subheading.

@subsection title

Begin a subsection within a section. The subsection title appears in the table of contents. In Info, the title is underlined with hyphens. Same context-dependent numbering as @section. See @subsection.

@subsubheading title

Print an unnumbered subsubsection-like heading, but omit from the table of contents of a printed manual. In Info, the title is underlined with periods. See @subsubsection.

@subsubsection title

Begin a subsubsection within a subsection. The subsubsection title appears in the table of contents. In Info, the title is underlined with periods. Same context-dependent numbering as @section. See @subsubsection.

@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 @title @subtitle @author.

@summarycontents

Print a short table of contents. Synonym for @shortcontents. See Generating a Table of Contents.

@syncodeindex from-index to-index

Merge the index named in the first argument into the index named in the second argument, formatting the entries from the first index with @code. See Combining Indices.

@synindex from-index to-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 Combining Indices.

@t{text}

Set text in a fixed-width, typewriter-like font. No effect in Info. See Fonts.

@tab

Separate columns in a row of a multitable. See Multitable Rows.

@table formatting-command

Begin a two-column table (description list), 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 Making a Two-column Table. Also see @ftable @vtable, and @itemx.

@TeX{}

Generate the TeX logo. See @TeX @LaTeX.

@tex

Enter TeX completely. Pair with @end tex. See Raw Formatter Commands.

@textdegree{}

Generate the degree symbol. See @textdegree.

@thischapter
@thischaptername
@thischapternum
@thisfile
@thispage
@thistitle

Only allowed in a heading or footing. Stands for, respectively, the number and name of the current chapter (in the format ‘Chapter 1: Title’), the current chapter name only, the current chapter number only, the filename, the current page number, and the title of the document, respectively. See How to Make Your Own Headings.

@TH{}
@th{}

Generate the uppercase and lowercase Icelandic letter thorn, respectively: Þ, þ. See Inserting Accents.

@tie{}

Generate a normal interword space at which a line break is not allowed. See @tie.

@tieaccent{cc}

Generate a tie-after accent over the next two characters cc, as in ‘oo[’. See Inserting Accents.

@tindex entry

Add entry to the index of data types. See 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. See @title @subtitle @author.

@titlefont{text}

In a printed manual, print text in a larger than normal font. See @titlefont @center @sp.

@titlepage

Begin the title page. Write the command on a line of its own, paired with @end titlepage. Nothing between @titlepage and @end titlepage appears in Info. See @titlepage.

@today{}

Insert the current date, in ‘1 Jan 1900’ style. See How to Make Your Own Headings.

@top title

Mark the topmost @node in the file, which must be defined on the line immediately preceding the @top command. The title is formatted as a chapter-level heading. The entire top node, including the @node and @top lines, are normally enclosed with @ifnottex ... @end ifnottex. In TeX and texinfo-format-buffer, the @top command is merely a synonym for @unnumbered. See 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_, ọ. See Inserting Accents.

@unmacro macroname

Undefine the macro @macroname if it has been defined. See Defining Macros.

@unnumbered title

Begin a chapter that appears without chapter numbers of any kind. The title appears in the table of contents. In Info, the title is underlined with asterisks. See @unnumbered @appendix.

@unnumberedsec title

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

@unnumberedsubsec title

Begin an unnumbered subsection. The title appears in the table of contents. In Info, the title is underlined with hyphens. See @unnumberedsubsec @appendixsubsec @subheading.

@unnumberedsubsubsec title

Begin an unnumbered subsubsection. The title appears in the table of contents. In Info, the title is underlined with periods. See @subsubsection.

@uref{url[, displayed-text][, replacement}
@url{url[, displayed-text][, replacement}

Define a cross reference to an external uniform resource locator, e.g., for the World Wide Web. See @url.

@urefbreakstyle style

Specify how @uref/@url should break at special characters: after, before, none. See @url.

@v{c}

Generate check accent over the character c, as in ǒ. See Inserting Accents.

@value{txivar}

Insert the value, if any, of the Texinfo variable txivar, previously defined by @set. See @set @clear @value.

@var{metasyntactic-variable}

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

@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. See @verb.

@verbatim

Output the text of the environment exactly as is (in the fixed-width font). Pair with @end verbatim. See @verbatim.

@verbatiminclude filename

Output the contents of filename exactly as is (in the fixed-width font). See @verbatiminclude.

@vindex entry

Add entry to the index of variables. See 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. See Copyright.

@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 @ftable @vtable.

@w{text}

Disallow line breaks within text. See @w.

@xml

Enter XML completely. Pair with @end xml. See Raw Formatter Commands.

@xref{node, [entry], [node-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 @xref.

@xrefautomaticsectiontitle on-off

By default, use the section title instead of the node name in cross references. See Three Arguments.


Next: , Previous: , Up: Top   [Contents][Index]