texinfo: One Argument

@xref

Two Arguments

Reference Syntax

Back to Software Index

8.4.2 '@xref' with One Argument
-------------------------------

The simplest form of '@xref' takes one argument, the name of another
node in the same Texinfo file.  The Info formatters produce output that
the Info readers can use to jump to the reference; TeX produces output
that specifies the page and section number for you; the HTML output is a
normal hyperlink.

For example,

     @xref{Tropical Storms}.

produces

     Note: Tropical Storms.

in Info and

     See Section 3.1 [Tropical Storms], page 24.

in a printed manual.  (Note that in the preceding example the closing
brace to '@xref''s argument is followed by a period.)

  You can write a clause after the cross reference, like this:

     @xref{Tropical Storms}, for more info.

which produces

     Note: Tropical Storms, for more info.

in Info and

     See Section 3.1 [Tropical Storms], page 24, for more info.

in a printed manual.  Note that in the preceding example the closing
brace to '@xref' is followed by a comma, then the additional text.  It's
a common mistake to follow an '@xref' command with a space, but this is
never correct.