Next: @-Command Contexts, Previous: @-Command Syntax, Up: @-Command Details [Contents][Index]
Here is an alphabetical list of the @-commands in Texinfo. Square brackets, [ ], indicate optional arguments; an ellipsis, ‘…’, indicates repeated text.
@whitespace
An @
followed by a space, tab, or newline produces a normal,
stretchable, interword space. 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.
@&
@ampchar{}
Generate an ampersand. See Inserting ‘&’ with @&
and @ampchar{}
.
@*
Force a line break. See @*
and @/
: Generate and Allow Line Breaks.
@,{c}
Generate a cedilla accent under c, as in ç. See Inserting Accents.
@-
Insert a discretionary hyphenation point. See @-
and @hyphenation
: Helping TeX Hyphenate.
@.
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 @*
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 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 ‘@’ with @@
and @atchar{}
.
@\
@backslashchar{}
Insert a backslash, ‘\’; @backslashchar{}
works
anywhere, while @\
works only inside @math
.
See Inserting ‘\’ with @backslashchar{}
, and @math
and @displaymath
: Formatting Mathematics.
@^
@`
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 ‘{ ‘}’ with @{ @}
and @l rbracechar{}
.
@}
@rbracechar{}
Insert a right brace, ‘}’. See Inserting ‘{ ‘}’ with @{ @}
and @l rbracechar{}
.
@~
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
{abbreviation[, meaning]}.
@acronym{acronym}
Indicate an acronym in all capital letters, such as ‘NASA’.
See @acronym
{acronym[, meaning]}.
@AE{}
@ae{}
Generate the uppercase and lowercase AE ligatures, respectively: Æ, æ. See Inserting Accents.
@afivepaper
Change page dimensions for the A5 paper size. See Printing on A4 Paper.
@afourlatex
@afourpaper
@afourwide
Change page dimensions for the A4 paper size. See Printing on A4 Paper.
@alias new=existing
Make the command ‘@new’ a synonym for the existing command ‘@existing’. See ‘@alias new=existing’.
@allowcodebreaks true-false
Control breaking at ‘-’ and ‘_’ in TeX.
See @allowcodebreaks
: Control Line Breaks in @code
.
@anchor{name}
Define name as the current location for use as a cross-reference
target. See @anchor
: Defining Arbitrary Cross-reference Targets.
@appendix title
Begin an appendix. The title appears in the table of contents. In
Info, the title is underlined with asterisks.
See @unnumbered
, @appendix
: Chapters with Other Labeling.
@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 The @subsection
-like Commands.
@appendixsubsubsec title
Begin an appendix subsubsection. The title appears in the table of
contents. In Info, the title is underlined with periods.
See @subsection
and Other Subsub Commands.
@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
, and @author
.
@b{text}
Set text in a bold font. No effect in Info. See Fonts for Printing.
@bullet{}
Generate a large round dot, • (‘*’ in Info). Often used
with @table
. See @bullet
(•).
@bsixpaper
Change page dimensions for the B6 paper size. See Printing on A4 Paper.
@bye
Stop formatting a file. The formatters do not see anything in the
input file following @bye
. See Ending a Texinfo 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 a @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
: Rounded Rectangles.
@center line-of-text
Center the line of text following the command.
See @titlefont
, @center
, and @sp
.
@centerchap line-of-text
Like @chapter
, but centers the chapter title. See @chapter
: Chapter Structuring.
@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-level Headings.
@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
: Chapter Structuring.
@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
{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 Flags: @set
, @clear
, conditionals, and @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
{sample-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 ‘,’ with @comma{}
.
@command{command-name}
Indicate a command name, such as ls
. See @command
{command-name}.
@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 copying
. See @copying
: Declare Copying Permissions.
@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
: Customized Highlighting.
@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
Object-Oriented Programming.
@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 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. @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 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 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 Object-Oriented Programming.
@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 Parts of a Master Menu.
@dfn{term}
Indicate the introductory or defining use of a term. See @dfn
{term}.
@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 Info Directory Files.
@direntry
Begin the Info directory menu entry for this file. Pair with
@end direntry
. See Installing Info Directory Files.
@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
: Examples Using the Text Font.
@displaymath
Format a block of math in “display” format. See @math
and @displaymath
: Formatting Mathematics.
@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
{dimension}: Format a Dimension.
@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
: Summary Text.
@documentencoding enc
Declare the input encoding to be enc.
See @documentencoding enc
: Set Input Encoding.
@documentlanguage CC
Declare the document language as the two-character ISO-639 abbreviation
CC. See @documentlanguage ll[_cc]
: Set the Document Language.
@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
(…) and @enddots
(...).
@email{address[, displayed-text]}
Indicate an electronic mail address. See @email
{email-address[, displayed-text]}.
@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
(…) and @enddots
(...).
@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
: Making a Numbered or Lettered List.
@env{environment-variable}
Indicate an environment variable name, such as PATH
.
See @env
{environment-variable}.
@equiv{}
Indicate to the reader the exact equivalence of two forms with a
glyph: ‘≡’. See @equiv{}
(≡): Indicating Equivalence.
@error{}
Indicate to the reader with a glyph that the following text is
an error message: ‘error→’. See @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 Conditionally Visible Text, and External Macro Processors: Line Directives.
@euro{}
Generate the Euro currency sign. See @euro
(€): Euro Currency Symbol.
@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
: Example Text.
@exampleindent indent
Indent example-like environments by indent number of spaces
(perhaps 0). See @exampleindent
: Environment Indenting.
@exclamdown{}
Generate an upside-down exclamation point. See Inserting Accents.
@exdent line-of-text
Remove any indentation a line might have. See @exdent
: Undoing a Line’s Indentation.
@expansion{}
Indicate the result of a macro expansion to the reader with a special
glyph: ‘→’. See @expansion{}
(→): Indicating an Expansion.
@file{filename}
Highlight the name of a file, buffer, node, directory, etc.
See @file
{file-name}.
@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
: Indenting After Headings.
@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
and @flushright
.
@fonttextsize 10-11
Change the size of the main body font in the TeX output. See 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 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
: Example Text.
@frenchspacing on-off
Control spacing after punctuation. See @frenchspacing
val: Control Sentence Spacing.
@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
and @vtable
.
@geq{}
Generate a greater-than-or-equal sign, ‘≥’. See @geq
(≥) and @leq
(≤): Inserting Relations.
@group
Disallow page breaks within following text. Pair with @end
group
. Ignored in Info. See @group
: Prevent Page Breaks.
@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 ‘#’ with @hashchar{}
, and
External Macro Processors: Line Directives.
@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 The @headings
Command.
@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 @-
and @hyphenation
: Helping TeX Hyphenate.
@i{text}
Set text in an italic font. No effect in Info. See Fonts for Printing.
@ifclear txivar
If the Texinfo variable txivar is not set, format the following
text. Pair with @end ifclear
. See Flags: @set
, @clear
, conditionals, and @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: @ifcommanddefined
, @ifcommandnotdefined
.
@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 Conditionally Visible Text.
@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 Conditionally Visible Text.
@ifnotinfo
Begin text to appear in output other than Info and (for historical
compatibility) plain text. Pair with @end ifnotinfo
.
See Conditionally Visible Text.
@ifplaintext
Begin text that will appear only in the plain text output.
Pair with @end ifplaintext
. See Conditionally Visible Text.
@ifset txivar
If the Texinfo variable txivar is set, format the following
text. Pair with @end ifset
. See Flags: @set
, @clear
, conditionals, and @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 Conditionally Visible Text.
@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 Inserting Images.
@include filename
Read the contents of Texinfo source file filename. See Include Files.
@indent
Insert paragraph indentation. See @indent
: Forcing Indentation.
@indentedblock
Indent a block of arbitrary text on the left. Pair with @end
indentedblock
. See @indentedblock
: Indented text blocks.
@indicateurl{indicateurl}
Indicate text that is a uniform resource locator for the World Wide
Web. See @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 @inforef
: Cross-references to Info-only Material.
@inlinefmt{fmt, text}
Insert text only if the output format is fmt.
See 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-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
: Include Permissions Text.
@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
: Making an Itemized List.
@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
: Second and Subsequent Items.
@kbd{keyboard-characters}
Indicate characters of input to be typed by users. See @kbd
{keyboard-characters}.
@kbdinputstyle style
Specify when @kbd
should use a font distinct from
@code
according to style: code
, distinct
,
example
. See @kbd
{keyboard-characters}.
@key{key-name}
Indicate the name of a key on a keyboard. See @key
{key-name}.
@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
{} (TeX) and @LaTeX
{} (LaTeX).
@leq{}
Generate a less-than-or-equal sign, ‘≤’. See @geq
(≥) and @leq
(≤): Inserting Relations.
@lisp
Begin an example of Lisp code. Indent text, do not fill, and select
fixed-width font. Pair with @end lisp
. See @lisp
: Marking a Lisp Example.
@listoffloats
Produce a table-of-contents-like listing of @float
s.
See @listoffloats
: Tables of Contents for Floats.
@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
: Chapter-level Headings.
@math{mathematical-expression}
Format a mathematical expression. See @math
and @displaymath
: Formatting Mathematics.
@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
(-): Inserting a Minus Sign.
@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 mils
: Prevent Page Breaks.
@node name, next, previous, up
Begin a new node. See Writing a @node
Line.
@noindent
Prevent text from being indented as if it were a new paragraph.
See @noindent
: Omitting Indentation.
@novalidate
Suppress validation of node references and omit creation of auxiliary files with TeX. Use before any sectioning or cross-reference commands. 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
{option-name}.
@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
: Start a New 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
: Controlling Paragraph Indentation.
@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
: Groups of Chapters.
@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{}
(∗): Indicating Point in a Buffer.
@pounds{}
Generate the pounds sterling currency sign.
See @pounds
(£): Pounds Sterling.
@print{}
Indicate printed output to the reader with a glyph: ‘-|’.
See @print{}
(-|): Indicating Generated Output.
@printindex index-name
Generate the alphabetized index for index-name (using two columns in a printed manual). See 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 @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
: Block Quotations.
@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 for Printing.
@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
: Ragged Right Text.
@raisesections
Change subsequent sections to chapters, subsections to sections, and so
on. See Raise/lower Sections: @raisesections
and @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 @ref
.
@registeredsymbol{}
Generate the legal symbol ®.
See @registeredsymbol{}
(®).
@result{}
Indicate the result of an expression to the reader with a special
glyph: ‘⇒’. See @result{}
(⇒): Result of an Expression.
@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
{text}.
@sansserif{text}
Set text in a sans serif font if possible. No effect in Info. See Fonts for Printing.
@sc{text}
Set text in a small caps font in printed output, and uppercase
in Info. See @sc
{text}: The Small Caps Font.
@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
: Sections Below Chapters.
@set txivar [string]
Define the Texinfo variable txivar, optionally to the value
string. See Flags: @set
, @clear
, conditionals, 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 @setchapternewpage
: Blank Pages Before Chapters.
@setfilename info-file-name
Provide a name to be used for the output files. This command is ignored
for TeX formatting. See @setfilename
: Set the Output File Name.
@settitle title
Specify the title for page headers in a printed manual, and the
default document title for HTML ‘<head>’.
See @settitle
: Set the Document Title.
@shortcaption
Define the short caption for a @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 for Printing.
@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
: Printing “Small” Books. Also, see @small…
Block Commands.
@smalldisplay
Begin a kind of example. Like @display
, but use a smaller
font size where possible. Pair with @end smalldisplay
.
See @small…
Block Commands.
@smallexample
Begin an example. Like @example
, but use a smaller font size
where possible. Pair with @end smallexample
.
See @small…
Block Commands.
@smallformat
Begin a kind of example. Like @format
, but use a smaller font
size where possible. Pair with @end smallformat
.
See @small…
Block Commands.
@smallindentedblock
Like @indentedblock
, but use a smaller font size where
possible. Pair with @end smallindentedblock
.
See @small…
Block Commands.
@smalllisp
Begin an example of Lisp code. Same as @smallexample
. Pair
with @end smalllisp
. See @small…
Block Commands.
@smallquotation
Like @quotation
, but use a smaller font size where possible.
Pair with @end smallquotation
. See @small…
Block Commands.
@sortas {key}
Used in the arguments to index commands to give a string by which the index entry should be sorted. See Defining the Entries of an Index.
@sp n
Skip n blank lines. See @sp
n: Insert Blank Lines.
@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.
@sub {text}
Set text as a subscript. See @sub
and @sup
: Inserting Subscripts and Superscripts.
@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 The @subsection
-like Commands.
@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
: Subsections Below Sections.
@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 @subsection
and Other Subsub Commands.
@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 @subsection
and Other 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 @title
, @subtitle
, and @author
.
@summarycontents
Print a short table of contents. Synonym for @shortcontents
.
See Generating a Table of Contents.
@sup {text}
Set text as a superscript. See @sub
and @sup
: Inserting Subscripts and Superscripts.
@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 for Printing.
@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
and @vtable
, and @itemx
: Second and Subsequent Items.
@TeX{}
Generate the TeX logo. See @TeX
{} (TeX) and @LaTeX
{} (LaTeX).
@tex
Enter TeX completely. Pair with @end tex
. See Raw Formatter Commands.
@textdegree{}
Generate the degree symbol. See @textdegree
(°): Degrees Symbol.
@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 file name, 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{}
: Inserting an Unbreakable Space.
@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
, and @author
.
@titlefont{text}
In a printed manual, print text in a larger than normal font.
See @titlefont
, @center
, and @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. In TeX and
texinfo-format-buffer
, the @top
command is merely a
synonym for @unnumbered
.
@U{hex}
Output a representation of Unicode character U+hex.
See Inserting Unicode: @U
.
@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
: Chapters with Other Labeling.
@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 The @subsection
-like Commands.
@unnumberedsubsubsec title
Begin an unnumbered subsubsection. The title appears in the table of
contents. In Info, the title is underlined with periods.
See @subsection
and 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 @url
, @uref{url[, text][, replacement]}
.
@urefbreakstyle style
Specify how @uref
/@url
should break at special
characters: after
, before
, none
.
See @url
, @uref{url[, text][, replacement]}
.
@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 Flags: @set
, @clear
, conditionals, and @value
.
@var{metasyntactic-variable}
Highlight a metasyntactic variable, which is something that stands for
another piece of text. See @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 @verb
{chartextchar}.
@verbatim
Output the text of the environment exactly as is (in the fixed-width
font). Pair with @end verbatim
. See @verbatim
: Literal Text.
@verbatiminclude filename
Output the contents of filename exactly as is (in the
fixed-width font). See @verbatiminclude
file: Include a File Verbatim.
@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 Page.
@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
and @vtable
.
@w{text}
Disallow line breaks within text. See @w
{text}: Prevent Line Breaks.
@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, including in node headers in HTML. See @xref
with Three Arguments.
Next: @-Command Contexts, Previous: @-Command Syntax, Up: @-Command Details [Contents][Index]