You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
5.6 KiB
HTML
102 lines
5.6 KiB
HTML
<html lang="en">
|
|
<head>
|
|
<title>Texinfo Manuals - GNU Compiler Collection (GCC) Internals</title>
|
|
<meta http-equiv="Content-Type" content="text/html">
|
|
<meta name="description" content="GNU Compiler Collection (GCC) Internals">
|
|
<meta name="generator" content="makeinfo 4.13">
|
|
<link title="Top" rel="start" href="index.html#Top">
|
|
<link rel="up" href="Documentation.html#Documentation" title="Documentation">
|
|
<link rel="next" href="Man-Page-Generation.html#Man-Page-Generation" title="Man Page Generation">
|
|
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
|
|
<!--
|
|
Copyright (C) 1988-2015 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 the
|
|
Invariant Sections being ``Funding Free Software'', the Front-Cover
|
|
Texts being (a) (see below), and with the Back-Cover Texts being (b)
|
|
(see below). A copy of the license is included in the section entitled
|
|
``GNU Free Documentation License''.
|
|
|
|
(a) The FSF's Front-Cover Text is:
|
|
|
|
A GNU Manual
|
|
|
|
(b) The FSF's Back-Cover Text is:
|
|
|
|
You have freedom to copy and modify this GNU Manual, like GNU
|
|
software. Copies published by the Free Software Foundation raise
|
|
funds for GNU development.-->
|
|
<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="Texinfo-Manuals"></a>
|
|
<p>
|
|
Next: <a rel="next" accesskey="n" href="Man-Page-Generation.html#Man-Page-Generation">Man Page Generation</a>,
|
|
Up: <a rel="up" accesskey="u" href="Documentation.html#Documentation">Documentation</a>
|
|
<hr>
|
|
</div>
|
|
|
|
<h5 class="subsubsection">6.3.7.1 Texinfo Manuals</h5>
|
|
|
|
<p>The manuals for GCC as a whole, and the C and C++ front ends, are in
|
|
files <samp><span class="file">doc/*.texi</span></samp>. Other front ends have their own manuals in
|
|
files <samp><var>language</var><span class="file">/*.texi</span></samp>. Common files
|
|
<samp><span class="file">doc/include/*.texi</span></samp> are provided which may be included in
|
|
multiple manuals; the following files are in <samp><span class="file">doc/include</span></samp>:
|
|
|
|
<dl>
|
|
<dt><samp><span class="file">fdl.texi</span></samp><dd>The GNU Free Documentation License.
|
|
<br><dt><samp><span class="file">funding.texi</span></samp><dd>The section “Funding Free Software”.
|
|
<br><dt><samp><span class="file">gcc-common.texi</span></samp><dd>Common definitions for manuals.
|
|
<br><dt><samp><span class="file">gpl_v3.texi</span></samp><dd>The GNU General Public License.
|
|
<br><dt><samp><span class="file">texinfo.tex</span></samp><dd>A copy of <samp><span class="file">texinfo.tex</span></samp> known to work with the GCC manuals.
|
|
</dl>
|
|
|
|
<p>DVI-formatted manuals are generated by ‘<samp><span class="samp">make dvi</span></samp>’, which uses
|
|
<samp><span class="command">texi2dvi</span></samp> (via the Makefile macro <code>$(TEXI2DVI)</code>).
|
|
PDF-formatted manuals are generated by ‘<samp><span class="samp">make pdf</span></samp>’, which uses
|
|
<samp><span class="command">texi2pdf</span></samp> (via the Makefile macro <code>$(TEXI2PDF)</code>). HTML
|
|
formatted manuals are generated by ‘<samp><span class="samp">make html</span></samp>’. Info
|
|
manuals are generated by ‘<samp><span class="samp">make info</span></samp>’ (which is run as part of
|
|
a bootstrap); this generates the manuals in the source directory,
|
|
using <samp><span class="command">makeinfo</span></samp> via the Makefile macro <code>$(MAKEINFO)</code>,
|
|
and they are included in release distributions.
|
|
|
|
<p>Manuals are also provided on the GCC web site, in both HTML and
|
|
PostScript forms. This is done via the script
|
|
<samp><span class="file">maintainer-scripts/update_web_docs_svn</span></samp>. Each manual to be
|
|
provided online must be listed in the definition of <code>MANUALS</code> in
|
|
that file; a file <samp><var>name</var><span class="file">.texi</span></samp> must only appear once in the
|
|
source tree, and the output manual must have the same name as the
|
|
source file. (However, other Texinfo files, included in manuals but
|
|
not themselves the root files of manuals, may have names that appear
|
|
more than once in the source tree.) The manual file
|
|
<samp><var>name</var><span class="file">.texi</span></samp> should only include other files in its own
|
|
directory or in <samp><span class="file">doc/include</span></samp>. HTML manuals will be generated by
|
|
‘<samp><span class="samp">makeinfo --html</span></samp>’, PostScript manuals by <samp><span class="command">texi2dvi</span></samp>
|
|
and <samp><span class="command">dvips</span></samp>, and PDF manuals by <samp><span class="command">texi2pdf</span></samp>.
|
|
All Texinfo files that are parts of manuals must
|
|
be version-controlled, even if they are generated files, for the
|
|
generation of online manuals to work.
|
|
|
|
<p>The installation manual, <samp><span class="file">doc/install.texi</span></samp>, is also provided on
|
|
the GCC web site. The HTML version is generated by the script
|
|
<samp><span class="file">doc/install.texi2html</span></samp>.
|
|
|
|
</body></html>
|
|
|