Viewing File: /usr/share/doc/texinfo/html/_0040pxref.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>@pxref (GNU Texinfo 6.7)</title>

<meta name="description" content="@pxref (GNU Texinfo 6.7)">
<meta name="keywords" content="@pxref (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="_0040anchor.html" rel="next" title="@anchor">
<link href="_0040ref.html" rel="prev" title="@ref">
<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="g_t_0040pxref"></span><div class="header">
<p>
Next: <a href="_0040anchor.html" accesskey="n" rel="next"><code>@anchor</code></a>, Previous: <a href="_0040ref.html" accesskey="p" rel="prev"><code>@ref</code></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="g_t_0040pxref-1"></span><h3 class="section">6.7 <code>@pxref</code></h3>

<span id="pxref"></span><span id="index-pxref"></span>
<span id="index-Cross_002dreferences-using-_0040pxref"></span>
<span id="index-References-using-_0040pxref"></span>

<p>The parenthetical reference command, <code>@pxref</code>, is nearly the
same as <code>@xref</code>, but it is best used within parentheses.
The command differs from <code>@xref</code> in that TeX typesets the 
reference for the printed manual with a lowercase &lsquo;see&rsquo; rather than an 
uppercase &lsquo;See&rsquo;.
</p>
<p>With one argument, a parenthetical cross-reference looks like this:
</p>
<span id="index-Flooding"></span>
<div class="example">
<pre class="example">&hellip; storms cause flooding (@pxref{Hurricanes}) &hellip;
</pre></div>

<p>which produces
</p>
<div class="example">
<pre class="example">&hellip; storms cause flooding (*note Hurricanes::) &hellip;
</pre></div>

<p>in Info and
</p>
<blockquote>
<p>&hellip; storms cause flooding (see Section 6.7 [Hurricanes], page 72) &hellip;
</p></blockquote>

<p>in a printed manual.
</p>
<p>With two arguments, a parenthetical cross-reference has this template:
</p>
<div class="example">
<pre class="example">&hellip; (@pxref{<var>node-name</var>, <var>cross-reference-name</var>}) &hellip;
</pre></div>

<p>which produces
</p>
<div class="example">
<pre class="example">&hellip; (*note <var>cross-reference-name</var>: <var>node-name</var>.) &hellip;
</pre></div>

<p>in Info and
</p>
<blockquote>
<p>&hellip; (see Section <var>nnn</var> [<var>node-name</var>], page <var>ppp</var>) &hellip;
</p></blockquote>

<p>in a printed manual.
</p>
<p><code>@pxref</code> can be used with up to five arguments, just like
<code>@xref</code> (see <a href="_0040xref.html"><code>@xref</code></a>).
</p>
<p>In past versions of Texinfo, it was not allowed to write punctuation
after a <code>@pxref</code>, so it could be used <em>only</em> before a
right parenthesis.  This is no longer the case.
The effect of &lsquo;<samp>@pxref{<var>node-name</var>}</samp>&rsquo; is similar to that of
&lsquo;<samp>see @ref{<var>node-name</var>}</samp>&rsquo;.  However, in many circumstance the
latter is preferrable, as this makes it clear in the Info output that 
the word &ldquo;see&rdquo; should be present.
</p>




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