texinfo-doc-nonfree 4.13a-1 / usr / share / doc / texinfo / html / ref.html

This file is indexed.

/usr/share/doc/texinfo/html/ref.html is in texinfo-doc-nonfree 4.13a-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
<html lang="en">
<head>
<title>ref - GNU Texinfo 4.13</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Texinfo 4.13">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Cross-References.html#Cross-References" title="Cross References">
<link rel="prev" href="Top-Node-Naming.html#Top-Node-Naming" title="Top Node Naming">
<link rel="next" href="pxref.html#pxref" title="pxref">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual is for GNU Texinfo (version 4.13, 18 September 2008),
a documentation system that can produce both online information and a
printed manual from a single source.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
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.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being ``A GNU Manual'', and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     ``GNU Free Documentation License.''

     (a) The FSF's Back-Cover Text is: ``You are free to copy and modify
     this GNU Manual.  Buying copies from GNU Press supports the FSF in
     developing GNU and promoting software freedom.''
  -->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="ref"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="pxref.html#pxref">pxref</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Top-Node-Naming.html#Top-Node-Naming">Top Node Naming</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Cross-References.html#Cross-References">Cross References</a>
<hr>
</div>

<h3 class="section">8.6 <code>@ref</code></h3>

<p><a name="index-Cross-references-using-_0040code_007b_0040_0040ref_007d-375"></a><a name="index-References-using-_0040code_007b_0040_0040ref_007d-376"></a><a name="index-ref-377"></a>
<code>@ref</code> is nearly the same as <code>@xref</code> except that it does
not generate a `See' in the printed output, just the reference itself. 
This makes it useful as the last part of a sentence.

<p class="noindent">For example,

  <p><a name="index-Hurricanes-378"></a>
<pre class="example">     For more information, @pxref{This}, and @ref{That}.
</pre>
  <p class="noindent">produces in Info:

<pre class="example">     For more information, *note This::, and *note That::.
</pre>
  <p class="noindent">and in printed output:

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

  <p>The <code>@ref</code> command sometimes tempts 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 will be
using both the printed and the Info format.  For example:

  <p><a name="index-Sea-surges-379"></a>
<pre class="example">     Sea surges are described in @ref{Hurricanes}.
</pre>
  <p class="noindent">looks ok in the printed output:

  <blockquote>
Sea surges are described in Section 6.7 [Hurricanes], page 72. 
</blockquote>

<p class="noindent">but is awkward to read in Info, &ldquo;note&rdquo; being a verb:

<pre class="example">     Sea surges are described in *note Hurricanes::.
</pre>
  <p>You should write a period or comma immediately after an <code>@ref</code>
command with two or more arguments.  If there is no such following
punctuation, <samp><span class="command">makeinfo</span></samp> will generate a (grammatically
incorrect) period in the Info output; otherwise, the cross-reference
would fail completely, due to the current syntax of Info format.

  <p>In general, it is best to use <code>@ref</code> only when you need some
word other than &ldquo;see&rdquo; to precede the reference.  When &ldquo;see&rdquo; (or
&ldquo;See&rdquo;) is ok, <code>@xref</code> and <code>@pxref</code> are preferable.

  </body></html>

APT Browse - Built by Thomas Orozco.