/usr/share/doc/texinfo/html/Three-Arguments.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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | <!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>Three Arguments (GNU Texinfo 6.5)</title>
<meta name="description" content="Three Arguments (GNU Texinfo 6.5)">
<meta name="keywords" content="Three Arguments (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="_0040xref.html#g_t_0040xref" rel="up" title="@xref">
<link href="Four-and-Five-Arguments.html#Four-and-Five-Arguments" rel="next" title="Four and Five Arguments">
<link href="Two-Arguments.html#Two-Arguments" rel="prev" title="Two 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="Three-Arguments"></a>
<div class="header">
<p>
Next: <a href="Four-and-Five-Arguments.html#Four-and-Five-Arguments" accesskey="n" rel="next">Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html#Two-Arguments" accesskey="p" rel="prev">Two Arguments</a>, Up: <a href="_0040xref.html#g_t_0040xref" accesskey="u" rel="up"><code>@xref</code></a> [<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="g_t_0040xref-with-Three-Arguments"></a>
<h4 class="subsection">6.4.3 <code>@xref</code> with Three Arguments</h4>
<a name="index-Three_002dargument-form-of-cross_002dreferences"></a>
<p>A third argument replaces the node name in the TeX output. The third
argument should be the name of the section in the printed output, or
else state the topic discussed by that section.
</p>
<p>The template is like this:
</p>
<div class="example">
<pre class="example">@xref{<var>node-name</var>, <var>online-label</var>, <var>printed-label</var>}.
</pre></div>
<p>For example,
</p>
<div class="example">
<pre class="example">@xref{Electrical Effects, Lightning, Thunder and Lightning},
for details.
</pre></div>
<p>produces
</p>
<div class="example">
<pre class="example">*Note Lightning: Electrical Effects, for details.
</pre></div>
<p>in Info and
</p>
<blockquote>
<p>See Section 5.2 [Thunder and Lightning], page 57, for details.
</p></blockquote>
<p>in a printed manual.
</p>
<p>If a third argument is given and the second one is empty, then the
third argument serves for both. (Note how two commas, side by side, mark
the empty second argument.)
</p>
<div class="example">
<pre class="example">@xref{Electrical Effects, , Thunder and Lightning},
for details.
</pre></div>
<p>produces
</p>
<div class="example">
<pre class="example">*Note Thunder and Lightning: Electrical Effects, for details.
</pre></div>
<p>in Info and
</p>
<blockquote>
<p>See Section 5.2 [Thunder and Lightning], page 57, for details.
</p></blockquote>
<p>in a printed manual.
</p>
<p>The third argument to cross-references must observe some of the
restrictions for node names (see <a href="Node-Line-Requirements.html#Node-Line-Requirements">Node Line Requirements</a>). The
most common issue is that colons cannot be used, since that interferes
with the parsing of the Info file.
</p>
<p>As a practical matter, it is often best to write cross-references with
just the first argument if the node name and the section title are the
same (or nearly so), and with the first and third arguments only if the
node name and title are different.
</p>
<a name="index-xrefautomaticsectiontitle"></a>
<p>Texinfo offers a setting to use the section title instead of node
names by default in cross-references (an explicitly specified third
argument still takes precedence):
</p>
<div class="example">
<pre class="example">@xrefautomaticsectiontitle on
</pre></div>
<p>Typically this line would be given near the beginning of the document
and used for the whole manual. But you can turn it off if you want
(<code>@xrefautomaticsectiontitle off</code>), for example, if you’re
including some other sub-document that doesn’t have suitable section
names.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Four-and-Five-Arguments.html#Four-and-Five-Arguments" accesskey="n" rel="next">Four and Five Arguments</a>, Previous: <a href="Two-Arguments.html#Two-Arguments" accesskey="p" rel="prev">Two Arguments</a>, Up: <a href="_0040xref.html#g_t_0040xref" accesskey="u" rel="up"><code>@xref</code></a> [<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>
|