Texinfo-Manuals.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1988-2017 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Funding Free Software", the Front-Cover
  8. Texts being (a) (see below), and with the Back-Cover Texts being (b)
  9. (see below). A copy of the license is included in the section entitled
  10. "GNU Free Documentation License".
  11. (a) The FSF's Front-Cover Text is:
  12. A GNU Manual
  13. (b) The FSF's Back-Cover Text is:
  14. You have freedom to copy and modify this GNU Manual, like GNU
  15. software. Copies published by the Free Software Foundation raise
  16. funds for GNU development. -->
  17. <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <title>GNU Compiler Collection (GCC) Internals: Texinfo Manuals</title>
  20. <meta name="description" content="GNU Compiler Collection (GCC) Internals: Texinfo Manuals">
  21. <meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Texinfo Manuals">
  22. <meta name="resource-type" content="document">
  23. <meta name="distribution" content="global">
  24. <meta name="Generator" content="makeinfo">
  25. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="Documentation.html#Documentation" rel="up" title="Documentation">
  30. <link href="Man-Page-Generation.html#Man-Page-Generation" rel="next" title="Man Page Generation">
  31. <link href="Documentation.html#Documentation" rel="prev" title="Documentation">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.smallquotation {font-size: smaller}
  36. div.display {margin-left: 3.2em}
  37. div.example {margin-left: 3.2em}
  38. div.indentedblock {margin-left: 3.2em}
  39. div.lisp {margin-left: 3.2em}
  40. div.smalldisplay {margin-left: 3.2em}
  41. div.smallexample {margin-left: 3.2em}
  42. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  43. div.smalllisp {margin-left: 3.2em}
  44. kbd {font-style:oblique}
  45. pre.display {font-family: inherit}
  46. pre.format {font-family: inherit}
  47. pre.menu-comment {font-family: serif}
  48. pre.menu-preformatted {font-family: serif}
  49. pre.smalldisplay {font-family: inherit; font-size: smaller}
  50. pre.smallexample {font-size: smaller}
  51. pre.smallformat {font-family: inherit; font-size: smaller}
  52. pre.smalllisp {font-size: smaller}
  53. span.nocodebreak {white-space:nowrap}
  54. span.nolinebreak {white-space:nowrap}
  55. span.roman {font-family:serif; font-weight:normal}
  56. span.sansserif {font-family:sans-serif; font-weight:normal}
  57. ul.no-bullet {list-style: none}
  58. -->
  59. </style>
  60. </head>
  61. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  62. <a name="Texinfo-Manuals"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="Man-Page-Generation.html#Man-Page-Generation" accesskey="n" rel="next">Man Page Generation</a>, Up: <a href="Documentation.html#Documentation" accesskey="u" rel="up">Documentation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  66. </div>
  67. <hr>
  68. <a name="Texinfo-Manuals-1"></a>
  69. <h4 class="subsubsection">6.3.7.1 Texinfo Manuals</h4>
  70. <p>The manuals for GCC as a whole, and the C and C++ front ends, are in
  71. files <samp>doc/*.texi</samp>. Other front ends have their own manuals in
  72. files <samp><var>language</var>/*.texi</samp>. Common files
  73. <samp>doc/include/*.texi</samp> are provided which may be included in
  74. multiple manuals; the following files are in <samp>doc/include</samp>:
  75. </p>
  76. <dl compact="compact">
  77. <dt><samp>fdl.texi</samp></dt>
  78. <dd><p>The GNU Free Documentation License.
  79. </p></dd>
  80. <dt><samp>funding.texi</samp></dt>
  81. <dd><p>The section &ldquo;Funding Free Software&rdquo;.
  82. </p></dd>
  83. <dt><samp>gcc-common.texi</samp></dt>
  84. <dd><p>Common definitions for manuals.
  85. </p></dd>
  86. <dt><samp>gpl_v3.texi</samp></dt>
  87. <dd><p>The GNU General Public License.
  88. </p></dd>
  89. <dt><samp>texinfo.tex</samp></dt>
  90. <dd><p>A copy of <samp>texinfo.tex</samp> known to work with the GCC manuals.
  91. </p></dd>
  92. </dl>
  93. <p>DVI-formatted manuals are generated by &lsquo;<samp>make dvi</samp>&rsquo;, which uses
  94. <code>texi2dvi</code> (via the Makefile macro <code>$(TEXI2DVI)</code>).
  95. PDF-formatted manuals are generated by &lsquo;<samp>make pdf</samp>&rsquo;, which uses
  96. <code>texi2pdf</code> (via the Makefile macro <code>$(TEXI2PDF)</code>). HTML
  97. formatted manuals are generated by &lsquo;<samp>make html</samp>&rsquo;. Info
  98. manuals are generated by &lsquo;<samp>make info</samp>&rsquo; (which is run as part of
  99. a bootstrap); this generates the manuals in the source directory,
  100. using <code>makeinfo</code> via the Makefile macro <code>$(MAKEINFO)</code>,
  101. and they are included in release distributions.
  102. </p>
  103. <p>Manuals are also provided on the GCC web site, in both HTML and
  104. PostScript forms. This is done via the script
  105. <samp>maintainer-scripts/update_web_docs_svn</samp>. Each manual to be
  106. provided online must be listed in the definition of <code>MANUALS</code> in
  107. that file; a file <samp><var>name</var>.texi</samp> must only appear once in the
  108. source tree, and the output manual must have the same name as the
  109. source file. (However, other Texinfo files, included in manuals but
  110. not themselves the root files of manuals, may have names that appear
  111. more than once in the source tree.) The manual file
  112. <samp><var>name</var>.texi</samp> should only include other files in its own
  113. directory or in <samp>doc/include</samp>. HTML manuals will be generated by
  114. &lsquo;<samp>makeinfo --html</samp>&rsquo;, PostScript manuals by <code>texi2dvi</code>
  115. and <code>dvips</code>, and PDF manuals by <code>texi2pdf</code>.
  116. All Texinfo files that are parts of manuals must
  117. be version-controlled, even if they are generated files, for the
  118. generation of online manuals to work.
  119. </p>
  120. <p>The installation manual, <samp>doc/install.texi</samp>, is also provided on
  121. the GCC web site. The HTML version is generated by the script
  122. <samp>doc/install.texi2html</samp>.
  123. </p>
  124. <hr>
  125. <div class="header">
  126. <p>
  127. Next: <a href="Man-Page-Generation.html#Man-Page-Generation" accesskey="n" rel="next">Man Page Generation</a>, Up: <a href="Documentation.html#Documentation" accesskey="u" rel="up">Documentation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  128. </div>
  129. </body>
  130. </html>