texinfo-doc-nonfree 6.5.0-1 / usr / share / doc / texinfo / html / Referring-to-a-Manual-as-a-Whole.html

This file is indexed.

/usr/share/doc/texinfo/html/Referring-to-a-Manual-as-a-Whole.html is in texinfo-doc-nonfree 6.5.0-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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<!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.5, 25 August 2017),
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 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 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 have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 6.4.90, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Referring to a Manual as a Whole (GNU Texinfo 6.5)</title>

<meta name="description" content="Referring to a Manual as a Whole (GNU Texinfo 6.5)">
<meta name="keywords" content="Referring to a Manual as a Whole (GNU Texinfo 6.5)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Cross-References.html#Cross-References" rel="up" title="Cross References">
<link href="_0040ref.html#g_t_0040ref" rel="next" title="@ref">
<link href="Four-and-Five-Arguments.html#Four-and-Five-Arguments" rel="prev" title="Four and Five Arguments">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
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">
<a name="Referring-to-a-Manual-as-a-Whole"></a>
<div class="header">
<p>
Next: <a href="_0040ref.html#g_t_0040ref" accesskey="n" rel="next"><code>@ref</code></a>, Previous: <a href="_0040xref.html#g_t_0040xref" accesskey="p" rel="prev"><code>@xref</code></a>, Up: <a href="Cross-References.html#Cross-References" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Referring-to-a-Manual-as-a-Whole-1"></a>
<h3 class="section">6.5 Referring to a Manual as a Whole</h3>
<a name="index-Manual_002c-referring-to-as-a-whole"></a>
<a name="index-Referring-to-an-entire-manual"></a>
<a name="Top-Node-Naming"></a>
<p>Ordinarily, you must always name a node in a cross-reference.
However, it&rsquo;s not unusual to want to refer to another manual as a
whole, rather than a particular section within it.  In this case,
giving any section name is an unnecessary distraction.
</p>
<p>So, with cross-references to other manuals (see <a href="Four-and-Five-Arguments.html#Four-and-Five-Arguments">Four and Five Arguments</a>), if the first argument is either &lsquo;<samp>Top</samp>&rsquo; (capitalized
just that way) or omitted entirely, and the third argument is omitted,
the printed output includes no node or section name.  (The Info output
includes &lsquo;<samp>Top</samp>&rsquo; if it was given.)  For example,
</p>
<div class="example">
<pre class="example">@xref{Top,,, make, The GNU Make Manual}.
</pre></div>

<p>produces
</p>
<div class="example">
<pre class="example">*Note (make)Top::.
</pre></div>

<p>and
</p>
<blockquote>
<p>See <cite>The GNU Make Manual</cite>.
</p></blockquote>

<p>Info readers will go to the Top node of the manual whether
or not the &lsquo;Top&rsquo; node is explicitly specified.
</p>
<p>It&rsquo;s also possible (and is historical practice) to refer to a whole
manual by specifying the &lsquo;Top&rsquo; node and an appropriate entry for the
third argument to the <code>@xref</code> command.  Using this idiom, to
make a cross-reference to <cite>The GNU Make Manual</cite>, you would write:
</p>
<div class="example">
<pre class="example">@xref{Top,, Overview, make, The GNU Make Manual}.
</pre></div>

<p>which produces
</p>
<div class="example">
<pre class="example">*Note Overview: (make)Top.
</pre></div>

<p>in Info and
</p>
<blockquote>
<p>See section &ldquo;Overview&rdquo; in <cite>The GNU Make Manual</cite>.
</p></blockquote>

<p>in a printed manual.
</p>
<p>In this example, &lsquo;<samp>Top</samp>&rsquo; is the name of the first node, and
&lsquo;<samp>Overview</samp>&rsquo; is the name of the first section of the manual.  There
is no widely-used convention for naming the first section in a printed
manual, this is just what the Make manual happens to use.  This
arbitrariness of the first name is a principal reason why omitting the
third argument in whole-manual cross-references is preferable.
</p>

<hr>
<div class="header">
<p>
Next: <a href="_0040ref.html#g_t_0040ref" accesskey="n" rel="next"><code>@ref</code></a>, Previous: <a href="_0040xref.html#g_t_0040xref" accesskey="p" rel="prev"><code>@xref</code></a>, Up: <a href="Cross-References.html#Cross-References" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>

APT Browse - Built by Thomas Orozco.