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

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

<span id="ref"></span><span id="index-ref"></span>
<span id="index-Cross_002dreferences-using-_0040ref"></span>
<span id="index-References-using-_0040ref"></span>

<p><code>@ref</code> is nearly the same as <code>@xref</code> except that it does
not generate a &lsquo;See&rsquo; in the printed output, just the reference itself.
This makes it useful as the last part of a sentence.
</p>
<p>For example,
</p>
<span id="index-Hurricanes"></span>
<div class="example">
<pre class="example">For more information, @pxref{This}, and @ref{That}.
</pre></div>

<p>produces in Info:
</p>
<div class="example">
<pre class="example">For more information, *note This::, and *note That::.
</pre></div>

<p>and in printed output:
</p>
<blockquote>
<p>For more information, see Section 1.1 [This], page 1,
and Section 1.2 [That], page 2.
</p></blockquote>

<p>The <code>@ref</code> command can tempt writers to express themselves in a
manner that is suitable for a printed manual but looks awkward in the
Info format.  Bear in mind that your audience could be using both the
printed and the Info format.  For example:
</p>
<span id="index-Sea-surges"></span>
<div class="example">
<pre class="example">Sea surges are described in @ref{Hurricanes}.
</pre></div>

<p>looks ok in the printed output:
</p>
<blockquote>
<p>Sea surges are described in Section 6.7 [Hurricanes], page 72.
</p></blockquote>

<p>but is awkward to read in Info, &ldquo;note&rdquo; being a verb:
</p>
<div class="example">
<pre class="example">Sea surges are described in *note Hurricanes::.
</pre></div>





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