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

<meta name="description" content="@inforef (GNU Texinfo 6.7)">
<meta name="keywords" content="@inforef (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="_0040url.html" rel="next" title="@url">
<link href="_0040anchor.html" rel="prev" title="@anchor">
<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_0040inforef"></span><div class="header">
<p>
Next: <a href="_0040url.html" accesskey="n" rel="next"><code>@url</code></a>, Previous: <a href="_0040anchor.html" accesskey="p" rel="prev"><code>@anchor</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_0040inforef_003a-Cross_002dreferences-to-Info_002donly-Material"></span><h3 class="section">6.9 <code>@inforef</code>: Cross-references to Info-only Material</h3>

<span id="inforef"></span><span id="index-inforef"></span>
<span id="index-Cross_002dreferences-using-_0040inforef"></span>
<span id="index-References-using-_0040inforef"></span>

<p><code>@inforef</code> is used for making cross-references to Info
documents&mdash;even from a printed manual.  This might be because you
want to refer to conditional <code>@ifinfo</code> text
(see <a href="Conditionals.html">Conditionals</a>), or because printed output is not available
(perhaps because there is no Texinfo source), among other
possibilities.
</p>
<p>The command takes either two or three arguments, in the following
order:
</p>
<ol>
<li> The node name.

</li><li> The cross-reference name (optional).

</li><li> The Info file name.
</li></ol>

<p>The template is:
</p>
<div class="example">
<pre class="example">@inforef{<var>node-name</var>, <var>cross-reference-name</var>, <var>info-file-name</var>}
</pre></div>

<p>For example,
</p>
<div class="example">
<pre class="example">@inforef{Advanced, Advanced Info commands, info},
for more information.
</pre></div>

<p>produces (in Info):
</p>
<div class="example">
<pre class="example">*Note Advanced Info commands: (info)Advanced,
for more information.
</pre></div>

<p>and (in the printed output):
</p>
<blockquote>
<p>See Info file <samp>info</samp>, node &lsquo;<samp>Advanced</samp>&rsquo;, for more information.
</p></blockquote>

<p>(This particular example is not realistic, since the Info manual is
written in Texinfo, so all formats are available.  In fact, we don&rsquo;t
know of any extant Info-only manuals.)
</p>
<p>The converse of <code>@inforef</code> is <code>@cite</code>, which is used to
refer to printed works for which no Info form exists.
See <a href="_0040cite.html"><code>@cite</code></a>.
</p>




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