visus
/
toolchain-gcc-arm-embedded
Наблюдаван 1
Харесван 0
Разклонения 0
Код Задачи 0 Заявки за сливане 0 Версии 0 Уики Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Ревизии
1 Клон
Клон: main
Клонове Маркери
${ item.name }
Create branch ${ searchTerm }
от 'main'
${ noResults }
toolchain-gcc-arm-embedded/share/doc/gcc-arm-none-eabi/html/gccint/Man-Page-Generation.html

132 lines
6.1KB
Директен файл Постоянна връзка Blame История 

  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-2020 Free Software Foundation, Inc.

  4. 

  5. Permission is granted to copy, distribute and/or modify this document

  6. under the terms of the GNU Free Documentation License, Version 1.3 or

  7. any later version published by the Free Software Foundation; with the

  8. Invariant Sections being "Funding Free Software", the Front-Cover

  9. Texts being (a) (see below), and with the Back-Cover Texts being (b)

  10. (see below).  A copy of the license is included in the section entitled

  11. "GNU Free Documentation License".

  12. 

  13. (a) The FSF's Front-Cover Text is:

  14. 

  15. A GNU Manual

  16. 

  17. (b) The FSF's Back-Cover Text is:

  18. 

  19. You have freedom to copy and modify this GNU Manual, like GNU

  20.      software.  Copies published by the Free Software Foundation raise

  21.      funds for GNU development. -->

  22. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->

  23. <head>

  24. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  25. <title>Man Page Generation (GNU Compiler Collection (GCC) Internals)</title>

  26. 

  27. <meta name="description" content="Man Page Generation (GNU Compiler Collection (GCC) Internals)">

  28. <meta name="keywords" content="Man Page Generation (GNU Compiler Collection (GCC) Internals)">

  29. <meta name="resource-type" content="document">

  30. <meta name="distribution" content="global">

  31. <meta name="Generator" content="makeinfo">

  32. <link href="index.html#Top" rel="start" title="Top">

  33. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">

  34. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">

  35. <link href="Documentation.html#Documentation" rel="up" title="Documentation">

  36. <link href="Miscellaneous-Docs.html#Miscellaneous-Docs" rel="next" title="Miscellaneous Docs">

  37. <link href="Texinfo-Manuals.html#Texinfo-Manuals" rel="prev" title="Texinfo Manuals">

  38. <style type="text/css">

  39. <!--

  40. a.summary-letter {text-decoration: none}

  41. blockquote.indentedblock {margin-right: 0em}

  42. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}

  43. blockquote.smallquotation {font-size: smaller}

  44. div.display {margin-left: 3.2em}

  45. div.example {margin-left: 3.2em}

  46. div.lisp {margin-left: 3.2em}

  47. div.smalldisplay {margin-left: 3.2em}

  48. div.smallexample {margin-left: 3.2em}

  49. div.smalllisp {margin-left: 3.2em}

  50. kbd {font-style: oblique}

  51. pre.display {font-family: inherit}

  52. pre.format {font-family: inherit}

  53. pre.menu-comment {font-family: serif}

  54. pre.menu-preformatted {font-family: serif}

  55. pre.smalldisplay {font-family: inherit; font-size: smaller}

  56. pre.smallexample {font-size: smaller}

  57. pre.smallformat {font-family: inherit; font-size: smaller}

  58. pre.smalllisp {font-size: smaller}

  59. span.nolinebreak {white-space: nowrap}

  60. span.roman {font-family: initial; font-weight: normal}

  61. span.sansserif {font-family: sans-serif; font-weight: normal}

  62. ul.no-bullet {list-style: none}

  63. -->

  64. </style>

  65. 

  66. 

  67. </head>

  68. 

  69. <body lang="en">

  70. <a name="Man-Page-Generation"></a>

  71. <div class="header">

  72. <p>

  73. Next: <a href="Miscellaneous-Docs.html#Miscellaneous-Docs" accesskey="n" rel="next">Miscellaneous Docs</a>, Previous: <a href="Texinfo-Manuals.html#Texinfo-Manuals" accesskey="p" rel="prev">Texinfo Manuals</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>

  74. </div>

  75. <hr>

  76. <a name="Man-Page-Generation-1"></a>

  77. <h4 class="subsubsection">6.3.7.2 Man Page Generation</h4>

  78. 

  79. <p>Because of user demand, in addition to full Texinfo manuals, man pages

  80. are provided which contain extracts from those manuals.  These man

  81. pages are generated from the Texinfo manuals using

  82. <samp>contrib/texi2pod.pl</samp> and <code>pod2man</code>.  (The man page for

  83. <code>g++</code>, <samp>cp/g++.1</samp>, just contains a &lsquo;<samp>.so</samp>&rsquo; reference

  84. to <samp>gcc.1</samp>, but all the other man pages are generated from

  85. Texinfo manuals.)

  86. </p>

  87. <p>Because many systems may not have the necessary tools installed to

  88. generate the man pages, they are only generated if the

  89. <samp>configure</samp> script detects that recent enough tools are

  90. installed, and the Makefiles allow generating man pages to fail

  91. without aborting the build.  Man pages are also included in release

  92. distributions.  They are generated in the source directory.

  93. </p>

  94. <p>Magic comments in Texinfo files starting &lsquo;<samp>@c man</samp>&rsquo; control what

  95. parts of a Texinfo file go into a man page.  Only a subset of Texinfo

  96. is supported by <samp>texi2pod.pl</samp>, and it may be necessary to add

  97. support for more Texinfo features to this script when generating new

  98. man pages.  To improve the man page output, some special Texinfo

  99. macros are provided in <samp>doc/include/gcc-common.texi</samp> which

  100. <samp>texi2pod.pl</samp> understands:

  101. </p>

  102. <dl compact="compact">

  103. <dt><code>@gcctabopt</code></dt>

  104. <dd><p>Use in the form &lsquo;<samp>@table @gcctabopt</samp>&rsquo; for tables of options,

  105. where for printed output the effect of &lsquo;<samp>@code</samp>&rsquo; is better than

  106. that of &lsquo;<samp>@option</samp>&rsquo; but for man page output a different effect is

  107. wanted.

  108. </p></dd>

  109. <dt><code>@gccoptlist</code></dt>

  110. <dd><p>Use for summary lists of options in manuals.

  111. </p></dd>

  112. <dt><code>@gol</code></dt>

  113. <dd><p>Use at the end of each line inside &lsquo;<samp>@gccoptlist</samp>&rsquo;.  This is

  114. necessary to avoid problems with differences in how the

  115. &lsquo;<samp>@gccoptlist</samp>&rsquo; macro is handled by different Texinfo formatters.

  116. </p></dd>

  117. </dl>

  118. 

  119. <p>FIXME: describe the <samp>texi2pod.pl</samp> input language and magic

  120. comments in more detail.

  121. </p>

  122. <hr>

  123. <div class="header">

  124. <p>

  125. Next: <a href="Miscellaneous-Docs.html#Miscellaneous-Docs" accesskey="n" rel="next">Miscellaneous Docs</a>, Previous: <a href="Texinfo-Manuals.html#Texinfo-Manuals" accesskey="p" rel="prev">Texinfo Manuals</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>

  126. </div>

  127. 

  128. 

  129. 

  130. </body>

  131. </html>