texinfo: Two Arguments

@xref

Three Arguments

One Argument

Back to Software Index

8.4.3 '@xref' with Two Arguments
--------------------------------

With two arguments, the second is used as the name of the cross
reference, while the first is still the name of the node to which the
cross reference points.

The template is like this:

     @xref{NODE-NAME, CROSS-REFERENCE-NAME}.

For example,

     @xref{Electrical Effects, Lightning}.

produces:

     Note: Lightning.

in Info and

     See Section 5.2 [Electrical Effects], page 57.

in a printed manual.  (Note that in the preceding example the closing
brace is followed by a period; and that the node name is printed, not
the cross reference name.)

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

     @xref{Electrical Effects, Lightning}, for more info.

which produces

     Note: Lightning, for more info.

in Info and

     See Section 5.2 [Electrical Effects], page 57, for more info.

in a printed manual.  (Note that in the preceding example the closing
brace is followed by a comma, and then by the clause, which is followed
by a period.)