| [ << ] | [ < ] | [ 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.
| A.1 @-Command Syntax | General syntax for varieties of @-commands. | |
| A.2 @-Command Contexts | Guidelines for which commands can be used where. |
@whitespaceAn
@followed by a space, tab, or newline produces a normal, stretchable, interword space. See section Multiple Spaces.@!Produce an exclamation point that ends a sentence (usually after an end-of-sentence capital letter). See section Ending a Sentence.
@"@'Generate an umlaut or acute accent, respectively, over the next character, as in ö and ó. See section Inserting Accents.
@*Force a line break. See section
@*and@/: Generate and Allow Line Breaks.@,{c}Generate a cedilla accent under c, as in ç. See section Inserting Accents.
@-Insert a discretionary hyphenation point. See section
@-and@hyphenation: Helping TeX Hyphenate.@.Produce a period that ends a sentence (usually after an end-of-sentence capital letter). See section Ending a Sentence.
@/Produces no output, but allows a line break. See section
@*and@/: Generate and Allow 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 section Not Ending a Sentence.
@=Generate a macron (bar) accent over the next character, as in ō. See section Inserting Accents.
@?Produce a question mark that ends a sentence (usually after an end-of-sentence capital letter). See section Ending a Sentence.
@@@atchar{}Insert an at sign, ‘@’. See section Inserting ‘@’ with
@@and@atchar{}.@\@backslashchar{}Insert a backslash, ‘\’;
@backslashchar{}works anywhere, while@\works only inside@math. See section Inserting ‘\’ with@backslashchar{}, and@math: Inserting Mathematical Expressions.@^@`Generate a circumflex (hat) or grave accent, respectively, over the next character, as in ô and è. See section Inserting Accents.
@{@lbracechar{}Insert a left brace, ‘{’. See section Inserting ‘{ ‘}’ with
@{ @}and@l rbracechar{}.@}@rbracechar{}Insert a right brace, ‘}’. See section Inserting ‘{ ‘}’ with
@{ @}and@l rbracechar{}.@~Generate a tilde accent over the next character, as in Ñ. See section Inserting Accents.
@AA{}@aa{}Generate the uppercase and lowercase Scandinavian A-ring letters, respectively: Å, å. See section Inserting Accents.
@abbr{abbreviation}Indicate a general abbreviation, such as ‘Comput.’. See section
@abbr{abbreviation[, meaning]}.@acronym{acronym}Indicate an acronym in all capital letters, such as ‘NASA’. See section
@acronym{acronym[, meaning]}.@AE{}@ae{}Generate the uppercase and lowercase AE ligatures, respectively: Æ, æ. See section Inserting Accents.
@afivepaperChange page dimensions for the A5 paper size. See section Printing on A4 Paper.
@afourlatex@afourpaper@afourwideChange page dimensions for the A4 paper size. See section Printing on A4 Paper.
@alias new=existingMake the command ‘@new’ a synonym for the existing command ‘@existing’. See section ‘@alias new=existing’.
@allowcodebreaks true-falseControl breaking at ‘-’ and ‘_’ in TeX. See section
@allowcodebreaks: Control Line Breaks in@code.@anchor{name}Define name as the current location for use as a cross reference target. See section
@anchor: Defining Arbitrary Cross Reference Targets.@appendix titleBegin an appendix. The title appears in the table of contents. In Info, the title is underlined with asterisks. See section
@unnumbered,@appendix: Chapters with Other Labeling.@appendixsec title@appendixsection titleBegin an appendix section within an appendix. The section title appears in the table of contents. In Info, the title is underlined with equal signs.
@appendixsectionis a longer spelling of the@appendixseccommand. See section@unnumberedsec,@appendixsec,@heading.@appendixsubsec titleBegin an appendix subsection. The title appears in the table of contents. In Info, the title is underlined with hyphens. See section The
@subsection-like Commands.@appendixsubsubsec titleBegin an appendix subsubsection. The title appears in the table of contents. In Info, the title is underlined with periods. See section
@subsectionand Other Subsub Commands.@arrow{}Generate a right arrow glyph: ‘→’. Used by default for
@click. See section Click Sequences.@asisUsed following
@table,@ftable, and@vtableto print the table’s first column without highlighting (“as is”). See @asis.@author authorTypeset author flushleft and underline it. See section
@title,@subtitle, and@author.@b{text}Set text in a bold font. No effect in Info. See section Fonts for Printing.
@bullet{}Generate a large round dot, • (‘*’ in Info). Often used with
@table. See section@bullet(•).@byeStop formatting a file. The formatters do not see anything in the input file following
@bye. See section Ending a Texinfo File.@c commentBegin 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 section Comments.@captionDefine the full caption for an
@float. See section@caption&@shortcaption.@cartoucheHighlight an example or quotation by drawing a box with rounded corners around it. Pair with
@end cartouche. No effect in Info. See section@cartouche: Rounded Rectangles.@center line-of-textCenter the line of text following the command. See section
@titlefont,@center, and@sp.@centerchap line-of-textLike
@chapter, but centers the chapter title. See section@chapter: Chapter Structuring.@chapheading titlePrint an unnumbered chapter-like heading, but omit from the table of contents. In Info, the title is underlined with asterisks. See section
@majorheading,@chapheading: Chapter-level Headings.@chapter titleBegin a numbered chapter. The chapter title appears in the table of contents. In Info, the title is underlined with asterisks. See section
@chapter: Chapter Structuring.@cindex entryAdd entry to the index of concepts. See section Defining the Entries of an Index.
@cite{reference}Highlight the name of a book or other reference that has no companion Info file. See section
@cite{reference}.@clear flagUnset flag, preventing the Texinfo formatting commands from formatting text between subsequent pairs of
@ifset flagand@end ifsetcommands, and preventing@value{flag}from expanding to the value to which flag is set. See section Flags:@set,@clear, conditionals, and@value.@click{}Represent a single “click” in a GUI. Used within
@clicksequence. See section Click Sequences.@clicksequence{action @click{} action}Represent a sequence of clicks in a GUI. See section Click Sequences.
@clickstyle @cmdExecute @cmd for each
@click; the default is@arrow. The usual following empty braces on @cmd are omitted. See section Click Sequences.@code{sample-code}Indicate an expression, a syntactically complete token of a program, or a program name. Unquoted in Info output. See section
@code{sample-code}.@codequotebacktick on-off@codequoteundirected on-offControl output of
`and'in code examples. See section Inserting Quote Characters.@comma{}Insert a comma ‘,’ character; only needed when a literal comma would be taken as an argument separator. See section Inserting ‘,’ with
@comma{}.@command{command-name}Indicate a command name, such as
ls. See section@command{command-name}.@comment commentBegin a comment in Texinfo. The rest of the line does not appear in any output. A synonym for
@c. See section Comments.@contentsPrint a complete table of contents. Has no effect in Info, which uses menus instead. See section Generating a Table of Contents.
@copyingSpecify copyright holders and copying conditions for the document Pair with
@end cartouche. See section@copying: Declare Copying Permissions.@copyright{}Generate the copyright symbol ©. See section
@copyright{}(©).@defcodeindex index-nameDefine a new index and its indexing command. Print entries in an
@codefont. See section Defining New Indices.@defcv category class name@defcvx category class nameFormat 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…@deffnx category name arguments…Format a description for a function, interactive command, or similar entity that may take arguments.
@deffntakes 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-nameDefine a new index and its indexing command. Print entries in a roman font. See section Defining New Indices.
@definfoenclose newcmd, before, afterMust be used within
@ifinfo; create a new command@newcmdfor Info that marks text by enclosing it in strings that precede and follow the text. See section@definfoenclose: Customized Highlighting.@defivar class instance-variable-name@defivarx class instance-variable-nameFormat a description for an instance variable in object-oriented programming. The command is equivalent to ‘@defcv {Instance Variable} …’. See section Definition Commands.
@defmac macroname arguments…@defmacx macroname arguments…Format a description for a macro; equivalent to ‘@deffn Macro …’. See section 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 section Definition Commands.
@defop category class name arguments…@defopx category class name arguments…Format a description for an operation in object-oriented programming.
@defoptakes 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 section Definition Commands, and Object-Oriented Programming.@defopt option-name@defoptx option-nameFormat a description for a user option; equivalent to ‘@defvr {User Option} …’. See section 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 section 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 section Definition Commands, and Data Types.
@deftypecv category class data-type name@deftypecvx category class data-type nameFormat a description for a typed class variable in object-oriented programming. See section Definition Commands, and Object-Oriented Programming.
@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.
@deftypefntakes as arguments the category of entity being described, the type, the name of the entity, and its arguments, if any. See section Definition Commands.@deftypefnnewline on-offSpecifies whether return types for
@deftypefnand similar are printed on lines by themselves; default is off. See section 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 section Definition Commands.
@deftypeivar class data-type variable-name@deftypeivarx class data-type variable-nameFormat a description for a typed instance variable in object-oriented programming. See section Definition Commands, and Object-Oriented Programming.
@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 section 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 section Definition Commands, and Object-Oriented Programming.
@deftypevar data-type variable-name@deftypevarx data-type variable-nameFormat a description for a variable in a typed language. The command is equivalent to ‘@deftypevr Variable …’. See section Definition Commands.
@deftypevr category data-type name@deftypevrx category data-type nameFormat 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 section Definition Commands.
@defun function-name arguments…@defunx function-name arguments…Format a description for a function; equivalent to ‘@deffn Function …’. See section Definition Commands.
@defvar variable-name@defvarx variable-nameFormat a description for a variable; equivalent to ‘@defvr Variable …’. See section Definition Commands.
@defvr category name@defvrx category nameFormat a description for any kind of variable.
@defvrtakes as arguments the category of the entity and the name of the entity. See section Definition Commands.@detailmenuMark the (optional) detailed node listing in a master menu. See section Parts of a Master Menu.
@dfn{term}Indicate the introductory or defining use of a term. See section
@dfn{term}.@DH{}@dh{}Generate the uppercase and lowercase Icelandic letter eth, respectively: Ð, ð. See section Inserting Accents.
@dircategory dirpartSpecify a part of the Info directory menu where this file’s entry should go. See section Installing Info Directory Files.
@direntryBegin the Info directory menu entry for this file. Pair with
@end direntry. See section Installing Info Directory Files.@displayBegin a kind of example. Like
@example(indent text, do not fill), but do not select a new font. Pair with@end display. See section@display: Examples Using the Text Font.@dmn{dimension}Format a unit of measure, as in 12pt. Causes TeX to insert a thin space before dimension. No effect in Info. See section
@dmn{dimension}: Format a Dimension.@docbookEnter Docbook completely. Pair with
@end docbook. See section Raw Formatter Commands.@documentdescriptionSet the document description text, included in the HTML output. Pair with
@end documentdescription. See section@documentdescription: Summary Text.@documentencoding encDeclare the input encoding to be enc. See section
@documentencoding enc: Set Input Encoding.@documentlanguage CCDeclare the document language as the two-character ISO-639 abbreviation CC. See section
@documentlanguage ll[_cc]: Set the Document Language.@dotaccent{c}Generate a dot accent over the character c, as in ȯ. See section Inserting Accents.
@dotless{i-or-j}Generate dotless i (‘i’) and dotless j (‘j’). See section Inserting Accents.
@dots{}Generate an ellipsis, ‘…’. See section
@dots(…) and@enddots(...).@email{address[, displayed-text]}Indicate an electronic mail address. See section
@email{email-address[, displayed-text]}.@emph{text}Emphasize text, by using italics where possible, and enclosing in asterisks in Info. See section Emphasizing Text.
@end environmentEnds environment, as in ‘@end example’. See section @-commands.
@enddots{}Generate an end-of-sentence ellipsis, like this: ... See section
@dots(…) and@enddots(...).@enumerate [number-or-letter]Begin a numbered list, using
@itemfor each entry. Optionally, start list with number-or-letter. Pair with@end enumerate. See section@enumerate: Making a Numbered or Lettered List.@env{environment-variable}Indicate an environment variable name, such as
PATH. See section@env{environment-variable}.@equiv{}Indicate to the reader the exact equivalence of two forms with a glyph: ‘≡’. See section
@equiv{}(≡): Indicating Equivalence.@error{}Indicate to the reader with a glyph that the following text is an error message: ‘error-->’. See section
@error{}(error-->): Indicating an Error Message.@errormsg{msg}Report msg as an error to standard error, and exit unsuccessfully. Texinfo commands within msg are expanded to plain text. See section Conditionally Visible Text, and External Macro Processors: Line Directives.
@euro{}Generate the Euro currency sign. See section
@euro(€): Euro Currency Symbol.@evenfooting [left] @| [center] @| [right]@evenheading [left] @| [center] @| [right]Specify page footings resp. headings for even-numbered (left-hand) pages. See section 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 section How to Make Your Own Headings.
@exampleBegin an example. Indent text, do not fill, and select fixed-width font. Pair with
@end example. See section@example: Example Text.@exampleindent indentIndent example-like environments by indent number of spaces (perhaps 0). See section
@exampleindent: Environment Indenting.@exclamdown{}Generate an upside-down exclamation point. See section Inserting Accents.
@exdent line-of-textRemove 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
@expansion{}(→): Indicating an Expansion.@file{filename}Highlight the name of a file, buffer, node, directory, etc. See section
@file{file-name}.@finaloutPrevent TeX from printing large black warning rectangles beside over-wide lines. See section Overfull “hboxes”.
@findex entryAdd entry to the index of functions. See section Defining the Entries of an Index.
@firstparagraphindent wordControl indentation of the first paragraph after section headers according to word, one of ‘none’ or ‘insert’. See section
@firstparagraphindent: Indenting After Headings.@floatEnvironment to define floating material. Pair with
@end float. See section Floats.@flushleft@flushrightDo 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 section@flushleftand@flushright.@fonttextsize 10-11Change the size of the main body font in the TeX output. See section Fonts for Printing.
@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 styleSpecify an Info file’s footnote style, either ‘end’ for the end node style or ‘separate’ for the separate node style. See section Footnotes.
@formatBegin a kind of example. Like
@display, but do not indent. Pair with@end format. See section@example: Example Text.@frenchspacing on-offControl spacing after punctuation. See section
@frenchspacingval: Control Sentence Spacing.@ftable formatting-commandBegin a two-column table, using
@itemfor 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@ftableand@vtable.@geq{}Generate a greater-than-or-equal sign, ‘≥’. See section
@geq(≥) and@leq(≤): Inserting Relations.@groupDisallow page breaks within following text. Pair with
@end group. Ignored in Info. See section@group: Prevent Page Breaks.@guillemetleft{}@guillemetright{}@guillemotleft{}@guillemotright{}@guilsinglleft{}@guilsinglright{}Double and single angle quotation marks: « » ‹ ›.
@guillemotleftand@guillemotrightare synonyms for@guillemetleftand@guillemetright. See section 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
#linedirective. See section Inserting ‘#’ with@hashchar{}, and External Macro Processors: Line Directives.@heading titlePrint an unnumbered section-like heading, but omit from the table of contents. In Info, the title is underlined with equal signs. See section
@unnumberedsec,@appendixsec,@heading.@headings on-off-single-doubleTurn page headings on or off, and/or specify single-sided or double-sided page headings for printing. See section The
@headingsCommand.@headitemBegin a heading row in a multitable. See section Multitable Rows.
@headitemfont{text}Set text in the font used for multitable heading rows; mostly useful in multitable templates. See section Multitable Rows.
@htmlEnter HTML completely. Pair with
@end html. See section Raw Formatter Commands.@hyphenation{hy-phen-a-ted words}Explicitly define hyphenation points. See section
@-and@hyphenation: Helping TeX Hyphenate.@i{text}Set text in an italic font. No effect in Info. See section Fonts for Printing.
@ifclear txivarIf the Texinfo variable txivar is not set, format the following text. Pair with
@end ifclear. See section Flags:@set,@clear, conditionals, and@value.@ifcommanddefined txicmd@ifcommandnotdefined txicmdIf the Texinfo code ‘@txicmd’ is (not) defined, format the follow text. Pair with the corresponding
@end ifcommand.... See section Testing for Texinfo Commands:@ifcommanddefined,@ifcommandnotdefined.@ifdocbook@ifhtml@ifinfoBegin text that will appear only in the given output format.
@ifinfooutput appears in both Info and (for historical compatibility) plain text output. Pair with@end ifdocbookresp.@end ifhtmlresp.@end ifinfo. See section Conditionally Visible Text.@ifnotdocbook@ifnothtml@ifnotplaintext@ifnottex@ifnotxmlBegin text to be ignored in one output format but not the others.
@ifnothtmltext is omitted from HTML output, etc. Pair with the corresponding@end ifnotformat. See section Conditionally Visible Text.@ifnotinfoBegin text to appear in output other than Info and (for historical compatibility) plain text. Pair with
@end ifnotinfo. See section Conditionally Visible Text.@ifplaintextBegin text that will appear only in the plain text output. Pair with
@end ifplaintext. See section Conditionally Visible Text.@ifset txivarIf the Texinfo variable txivar is set, format the following text. Pair with
@end ifset. See section Flags:@set,@clear, conditionals, and@value.@iftexBegin text to appear only in the TeX output. Pair with
@end iftex. See section Conditionally Visible Text.@ifxmlBegin text that will appear only in the XML output. Pair with
@end ifxml. See section Conditionally Visible Text.@ignoreBegin text that will not appear in any output. Pair with
@end ignore. See section 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 section Inserting Images.
@include filenameRead the contents of Texinfo source file filename. See section Include Files.
@indentInsert paragraph indentation. See section
@indent: Forcing Indentation.@indentedblockIndent a block of arbitary text on the left. Pair with
@end indentedblock. See section@indentedblock: Indented text blocks.@indicateurl{indicateurl}Indicate text that is a uniform resource locator for the World Wide Web. See section
@indicateurl{uniform-resource-locator}.@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: Cross References to Info-only Material.@inlinefmt{fmt, text}Insert text only if the output format is fmt. See section Inline Conditionals:
@inline,@inlineifelse,@inlineraw.@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-fileUse 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\inputis used instead of an@because TeX does not recognize@until after it has read the definitions file. See section Texinfo File Header.@insertcopyingInsert the text previously defined with the
@copyingenvironment. See section@insertcopying: Include Permissions Text.@itemIndicate the beginning of a marked paragraph for
@itemizeand@enumerate; indicate the beginning of the text of a first column entry for@table,@ftable, and@vtable. See section Lists and Tables.@itemize mark-generating-character-or-commandBegin 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 section@itemize: Making an Itemized List.@itemxLike
@itembut do not generate extra vertical space above the item text. Thus, when several items have the same description, use@itemfor the first and@itemxfor the others. See section@itemx: Second and Subsequent Items.@kbd{keyboard-characters}Indicate characters of input to be typed by users. See section
@kbd{keyboard-characters}.@kbdinputstyle styleSpecify when
@kbdshould use a font distinct from@codeaccording to style:code,distinct,example. See section@kbd{keyboard-characters}.@key{key-name}Indicate the name of a key on a keyboard. See section
@key{key-name}.@kindex entryAdd entry to the index of keys. See section Defining the Entries of an Index.
@L{}@l{}Generate the uppercase and lowercase Polish suppressed-L letters, respectively: Ł, ł.
@LaTeX{}Generate the LaTeX logo. See section
@TeX{} (TeX) and@LaTeX{} (LaTeX).@leq{}Generate a less-than-or-equal sign, ‘≤’. See section
@geq(≥) and@leq(≤): Inserting Relations.@lispBegin an example of Lisp code. Indent text, do not fill, and select fixed-width font. Pair with
@end lisp. See section@lisp: Marking a Lisp Example.@listoffloatsProduce a table-of-contents-like listing of
@floats. See section@listoffloats: Tables of Contents for Floats.@lowersectionsChange subsequent chapters to sections, sections to subsections, and so on. See section
@raisesectionsand@lowersections.@macro macroname {params}Define a new Texinfo command
@macroname{params}. Pair with@end macro. See section Defining Macros.@majorheading titlePrint an unnumbered chapter-like heading, but omit from the table of contents. This generates more vertical whitespace before the heading than the
@chapheadingcommand. See section@majorheading,@chapheading: Chapter-level Headings.@math{mathematical-expression}Format a mathematical expression. See section
@math: Inserting Mathematical Expressions.@menuMark the beginning of a menu of nodes. 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.@multitable column-width-specBegin a multi-column table. Begin each row with
@itemor@headitem, and separate columns with@tab. Pair with@end multitable. See section Multitable Column Widths.@need nStart 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, upBegin a new node. See section The
@nodeCommand.@noindentPrevent text from being indented as if it were a new paragraph. See section
@noindent: Omitting Indentation.@novalidateSuppress validation of node references and omit creation of auxiliary files with TeX. Use before
@setfilename. See section 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 section How to Make Your Own Headings.
@OE{}@oe{}Generate the uppercase and lowercase OE ligatures, respectively: Œ, œ. See section Inserting Accents.
@ogonek{c}Generate an ogonek diacritic under the next character, as in ą. See section Inserting Accents.
@option{option-name}Indicate a command-line option, such as ‘-l’ or ‘--help’. See section
@option{option-name}.@ordf{}@ordm{}Generate the feminine and masculine Spanish ordinals, respectively: ª, º. See section Inserting Accents.
@pageStart a new page in a printed manual. No effect in Info. See section
@page: Start a New Page.@pagesizes [width][, height]Change page dimensions. See pagesizes.
@paragraphindent indentIndent paragraphs by indent number of spaces (perhaps 0); preserve source file indentation if indent is
asis. See section@paragraphindent: Controlling Paragraph Indentation.@part titleBegin a group of chapters or appendixes; included in the tables of contents and produces a page of its own in printed output. See section
@part: Groups of Chapters.@pindex entryAdd entry to the index of programs. See section Defining the Entries of an Index.
@point{}Indicate the position of point in a buffer to the reader with a glyph: ‘∗’. See section
@point{}(∗): Indicating Point in a Buffer.@pounds{}Generate the pounds sterling currency sign. See section
@pounds(£): Pounds Sterling.@print{}Indicate printed output to the reader with a glyph: ‘-|’. See section
@print{}(-|): Indicating Generated Output.@printindex index-nameGenerate the alphabetized index for index-name (using two columns in a printed manual). See section Printing Indices and 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 section
@pxref.@questiondown{}Generate an upside-down question mark. See section Inserting Accents.
@quotationNarrow 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 section@quotation: Block Quotations.@quotedblleft{}@quotedblright{}@quoteleft{}@quoteright{}@quotedblbase{}@quotesinglbase{}Produce various quotation marks: “ ” ‘ ’ „ ‚. See section Inserting Quotation Marks.
@r{text}Set text in the regular roman font. No effect in Info. See section Fonts for Printing.
@raggedrightFill text; left justify every line while leaving the right end ragged. Leave font as is. Pair with
@end raggedright. No effect in Info. See section@raggedright: Ragged Right Text.@raisesectionsChange subsequent sections to chapters, subsections to sections, and so on. See section Raise/lower Sections:
@raisesectionsand@lowersections.@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 section
@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 section
@registeredsymbol{}(®).@result{}Indicate the result of an expression to the reader with a special glyph: ‘⇒’. See section
@result{}(⇒): Result of an Expression.@ringaccent{c}Generate a ring accent over the next character, as in o*. See section Inserting Accents.
@samp{text}Indicate a literal example of a sequence of characters, in general. Quoted in Info output. See section
@samp{text}.@sansserif{text}Set text in a sans serif font if possible. No effect in Info. See section Fonts for Printing.
@sc{text}Set text in a small caps font in printed output, and uppercase in Info. See section
@sc{text}: The Small Caps Font.@section titleBegin a section within a chapter. The section title appears in the table of contents. In Info, the title is underlined with equal signs. Within
@chapterand@appendix, the section title is numbered; within@unnumbered, the section is unnumbered. See section@section: Sections Below Chapters.@set txivar [string]Define the Texinfo variable txivar, optionally to the value string. See section Flags:
@set,@clear, conditionals, and@value.@setchapternewpage on-off-oddSpecify whether chapters start on new pages, and if so, whether on odd-numbered (right-hand) new pages. See section
@setchapternewpage: Blank Pages Before Chapters.@setcontentsaftertitlepagePut the table of contents after the ‘@end titlepage’ even if the
@contentscommand is at the end. See section Generating a Table of Contents.@setfilename info-file-nameProvide 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 section
@setfilename: Set the Output File Name.@setshortcontentsaftertitlepagePlace the short table of contents after the ‘@end titlepage’ command even if the
@shortcontentscommand is at the end. See section Generating a Table of Contents.@settitle titleSpecify the title for page headers in a printed manual, and the default document title for HTML ‘<head>’. See section
@settitle: Set the Document Title.@shortcaptionDefine the short caption for an
@float. See section@caption&@shortcaption.@shortcontentsPrint a short table of contents, with chapter-level entries only. Not relevant to Info, which uses menus rather than tables of contents. See section Generating a Table of Contents.
@shorttitlepage titleGenerate a minimal title page. See section
@titlepage.@slanted{text}Set text in a slanted font if possible. No effect in Info. See section Fonts for Printing.
@smallbookCause 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
@smallbook: Printing “Small” Books. Also, see@small…Block Commands.@smalldisplayBegin a kind of example. Like
@display, but use a smaller font size where possible. Pair with@end smalldisplay. See section@small…Block Commands.@smallexampleBegin an example. Like
@example, but use a smaller font size where possible. Pair with@end smallexample. See section@small…Block Commands.@smallformatBegin a kind of example. Like
@format, but use a smaller font size where possible. Pair with@end smallformat. See section@small…Block Commands.@smallindentedblockLike
@indentedblock, but use a smaller font size where possible. Pair with@end smallindentedblock. See section@small…Block Commands.@smalllispBegin an example of Lisp code. Same as
@smallexample. Pair with@end smalllisp. See section@small…Block Commands.@smallquotationLike
@quotation, but use a smaller font size where possible. Pair with@end smallquotation. See section@small…Block Commands.@sp nSkip n blank lines. See section
@spn: Insert Blank Lines.@ss{}Generate the German sharp-S es-zet letter, ß. See section Inserting Accents.
@strong {text}Emphasize text more strongly than
@emph, by using boldface where possible; enclosed in asterisks in Info. See Emphasizing Text.@subheading titlePrint 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 section The
@subsection-like Commands.@subsection titleBegin 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 section@subsection: Subsections Below Sections.@subsubheading titlePrint 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 section
@subsectionand Other Subsub Commands.@subsubsection titleBegin 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 section@subsectionand Other Subsub Commands.@subtitle titleIn 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.@summarycontentsPrint a short table of contents. Synonym for
@shortcontents. See section Generating a Table of Contents.@syncodeindex from-index to-indexMerge 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 section Combining Indices.@synindex from-index to-indexMerge 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}Set text in a fixed-width, typewriter-like font. No effect in Info. See section Fonts for Printing.
@tabSeparate columns in a row of a multitable. See section Multitable Rows.
@table formatting-commandBegin a two-column table (description list), using
@itemfor 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@ftableand@vtable, and@itemx: Second and Subsequent Items.@TeX{}Generate the TeX logo. See section
@TeX{} (TeX) and@LaTeX{} (LaTeX).@texEnter TeX completely. Pair with
@end tex. See section Raw Formatter Commands.@textdegree{}Generate the degree symbol. See section
@textdegree(°): Degrees Symbol.@thischapter@thischaptername@thischapternum@thisfile@thispage@thistitleOnly 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 section How to Make Your Own Headings.
@TH{}@th{}Generate the uppercase and lowercase Icelandic letter thorn, respectively: Þ, þ. See section Inserting Accents.
@tie{}Generate a normal interword space at which a line break is not allowed. See section
@tie{}: Inserting an Unbreakable Space.@tieaccent{cc}Generate a tie-after accent over the next two characters cc, as in ‘oo[’. See section Inserting Accents.
@tindex entryAdd entry to the index of data types. See section Defining the Entries of an Index.
@title titleIn 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. See section
@titlefont,@center, and@sp.@titlepageBegin the title page. Write the command on a line of its own, paired with
@end titlepage. Nothing between@titlepageand@end titlepageappears in Info. See section@titlepage.@today{}Insert the current date, in ‘1 Jan 1900’ style. See section How to Make Your Own Headings.
@top titleMark the topmost
@nodein the file, which must be defined on the line immediately preceding the@topcommand. The title is formatted as a chapter-level heading. The entire top node, including the@nodeand@toplines, are normally enclosed with@ifnottex ... @end ifnottex. In TeX andtexinfo-format-buffer, the@topcommand is merely a synonym for@unnumbered. See sectionmakeinfoPointer 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 section Inserting Accents.
@unmacro macronameUndefine the macro
@macronameif it has been defined. See section Defining Macros.@unnumbered titleBegin 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 section
@unnumbered,@appendix: Chapters with Other Labeling.@unnumberedsec titleBegin 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 titleBegin an unnumbered subsection. The title appears in the table of contents. In Info, the title is underlined with hyphens. See section The
@subsection-like Commands.@unnumberedsubsubsec titleBegin an unnumbered subsubsection. The title appears in the table of contents. In Info, the title is underlined with periods. See section
@subsectionand Other Subsub Commands.@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 section
@url,@uref{url[, text][, replacement]}.@urefbreakstyle styleSpecify how
@uref/@urlshould break at special characters:after,before,none. See section@url,@uref{url[, text][, replacement]}.@v{c}Generate check accent over the character c, as in o<. See section Inserting Accents.
@value{txivar}Insert the value, if any, of the Texinfo variable txivar, previously defined by
@set. See section Flags:@set,@clear, conditionals, and@value.@var{metasyntactic-variable}Highlight a metasyntactic variable, which is something that stands for another piece of text. See section
@var{metasyntactic-variable}.@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 section
@verb{chartextchar}.@verbatimOutput the text of the environment exactly as is (in the fixed-width font). Pair with
@end verbatim. See section@verbatim: Literal Text.@verbatiminclude filenameOutput the contents of filename exactly as is (in the fixed-width font). See section
@verbatimincludefile: Include a File Verbatim.@vindex entryAdd entry to the index of variables. See section Defining the Entries of an Index.
@vskip amountIn 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’.)
@vskipmay be used only in contexts ignored for Info. See section Copyright Page.@vtable formatting-commandBegin a two-column table, using
@itemfor 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@ftableand@vtable.@w{text}Disallow line breaks within text. See section
@w{text}: Prevent Line Breaks.@xmlEnter XML completely. Pair with
@end xml. See section 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 section
@xref.@xrefautomaticsectiontitle on-offBy default, use the section title instead of the node name in cross references. See section
@xrefwith Three Arguments.
| [ << ] | [ < ] | [ Up ] | [ > ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This document was generated on October 2, 2013 using texi2html 5.0.
