Viewing File: /usr/share/doc/texinfo/html/Cross-Reference-Commands.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Cross Reference Commands (GNU Texinfo 6.7)</title>

<meta name="description" content="Cross Reference Commands (GNU Texinfo 6.7)">
<meta name="keywords" content="Cross Reference Commands (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Cross-References.html" rel="up" title="Cross References">
<link href="Cross-Reference-Parts.html" rel="next" title="Cross Reference Parts">
<link href="References.html" rel="prev" title="References">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="Cross-Reference-Commands"></span><div class="header">
<p>
Next: <a href="Cross-Reference-Parts.html" accesskey="n" rel="next">Cross Reference Parts</a>, Previous: <a href="References.html" accesskey="p" rel="prev">References</a>, Up: <a href="Cross-References.html" accesskey="u" rel="up">Cross References</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Different-Cross_002dreference-Commands"></span><h3 class="section">6.2 Different Cross-reference Commands</h3>
<span id="index-Different-cross_002dreference-commands"></span>

<p>There are three different cross-reference commands:
</p>
<dl compact="compact">
<dt><code>@xref</code></dt>
<dd><p>Used to start a sentence in the printed manual and in HTML with
&lsquo;See&nbsp;&hellip;&rsquo;<!-- /@w --> or an Info cross-reference saying &lsquo;<samp>*Note
<var>name</var>: <var>node</var>.</samp>&rsquo;.
</p>
</dd>
<dt><code>@ref</code></dt>
<dd><p>Used within or, more often, at the end of a sentence; produces just
the reference in the printed manual and in HTML without the preceding
&lsquo;See&rsquo; (same as <code>@xref</code> for Info).
</p>
</dd>
<dt><code>@pxref</code></dt>
<dd><p>Used within parentheses, at the end of a sentence, or otherwise before
punctuation, to make a reference.  Its output starts with a lowercase
&lsquo;see&rsquo; in the printed manual and in HTML, and a lowercase &lsquo;<samp>*note</samp>&rsquo;
in Info.  (&lsquo;<samp>p</samp>&rsquo; is for &lsquo;parenthesis&rsquo;.)
</p></dd>
</dl>

<p>Additionally, there are commands to produce references to documents
outside the Texinfo system.  The <code>@cite</code> command is used
to make references to books and manuals.  <code>@url</code> produces
a <acronym>URL</acronym>, for example a reference to a page on the World
Wide Web.  <code>@inforef</code> is used to make a reference to an Info
file for which there is no printed manual.
</p>




</body>
</html>
Back to Directory File Manager