Formatting-Documentation.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  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. 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 "Free Software" and "Free Software Needs
  8. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"
  9. and with the Back-Cover Texts as in (a) below.
  10. (a) The FSF's Back-Cover Text is: "You are free to copy and modify
  11. this GNU Manual. Buying copies from GNU Press supports the FSF in
  12. developing GNU and promoting software freedom." -->
  13. <!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
  14. <head>
  15. <title>Debugging with GDB: Formatting Documentation</title>
  16. <meta name="description" content="Debugging with GDB: Formatting Documentation">
  17. <meta name="keywords" content="Debugging with GDB: Formatting Documentation">
  18. <meta name="resource-type" content="document">
  19. <meta name="distribution" content="global">
  20. <meta name="Generator" content="makeinfo">
  21. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  22. <link href="index.html#Top" rel="start" title="Top">
  23. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
  24. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  25. <link href="index.html#Top" rel="up" title="Top">
  26. <link href="Installing-GDB.html#Installing-GDB" rel="next" title="Installing GDB">
  27. <link href="In-Memoriam.html#In-Memoriam" rel="previous" title="In Memoriam">
  28. <style type="text/css">
  29. <!--
  30. a.summary-letter {text-decoration: none}
  31. blockquote.smallquotation {font-size: smaller}
  32. div.display {margin-left: 3.2em}
  33. div.example {margin-left: 3.2em}
  34. div.indentedblock {margin-left: 3.2em}
  35. div.lisp {margin-left: 3.2em}
  36. div.smalldisplay {margin-left: 3.2em}
  37. div.smallexample {margin-left: 3.2em}
  38. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  39. div.smalllisp {margin-left: 3.2em}
  40. kbd {font-style:oblique}
  41. pre.display {font-family: inherit}
  42. pre.format {font-family: inherit}
  43. pre.menu-comment {font-family: serif}
  44. pre.menu-preformatted {font-family: serif}
  45. pre.smalldisplay {font-family: inherit; font-size: smaller}
  46. pre.smallexample {font-size: smaller}
  47. pre.smallformat {font-family: inherit; font-size: smaller}
  48. pre.smalllisp {font-size: smaller}
  49. span.nocodebreak {white-space:nowrap}
  50. span.nolinebreak {white-space:nowrap}
  51. span.roman {font-family:serif; font-weight:normal}
  52. span.sansserif {font-family:sans-serif; font-weight:normal}
  53. ul.no-bullet {list-style: none}
  54. -->
  55. </style>
  56. </head>
  57. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  58. <a name="Formatting-Documentation"></a>
  59. <div class="header">
  60. <p>
  61. Next: <a href="Installing-GDB.html#Installing-GDB" accesskey="n" rel="next">Installing GDB</a>, Previous: <a href="In-Memoriam.html#In-Memoriam" accesskey="p" rel="previous">In Memoriam</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  62. </div>
  63. <hr>
  64. <a name="Formatting-Documentation-1"></a>
  65. <h2 class="appendix">Appendix B Formatting Documentation</h2>
  66. <a name="index-GDB-reference-card"></a>
  67. <a name="index-reference-card"></a>
  68. <p>The <small>GDB</small> 4 release includes an already-formatted reference card, ready
  69. for printing with PostScript or Ghostscript, in the <samp>gdb</samp>
  70. subdirectory of the main source directory<a name="DOCF19" href="#FOOT19"><sup>19</sup></a>. If you can use PostScript or Ghostscript with your printer,
  71. you can print the reference card immediately with <samp>refcard.ps</samp>.
  72. </p>
  73. <p>The release also includes the source for the reference card. You
  74. can format it, using TeX, by typing:
  75. </p>
  76. <div class="smallexample">
  77. <pre class="smallexample">make refcard.dvi
  78. </pre></div>
  79. <p>The <small>GDB</small> reference card is designed to print in <em>landscape</em>
  80. mode on US &ldquo;letter&rdquo; size paper;
  81. that is, on a sheet 11 inches wide by 8.5 inches
  82. high. You will need to specify this form of printing as an option to
  83. your <small>DVI</small> output program.
  84. </p>
  85. <a name="index-documentation"></a>
  86. <p>All the documentation for <small>GDB</small> comes as part of the machine-readable
  87. distribution. The documentation is written in Texinfo format, which is
  88. a documentation system that uses a single source file to produce both
  89. on-line information and a printed manual. You can use one of the Info
  90. formatting commands to create the on-line version of the documentation
  91. and TeX (or <code>texi2roff</code>) to typeset the printed version.
  92. </p>
  93. <p><small>GDB</small> includes an already formatted copy of the on-line Info
  94. version of this manual in the <samp>gdb</samp> subdirectory. The main Info
  95. file is <samp>gdb-10.1.90.20201028-git/gdb/gdb.info</samp>, and it refers to
  96. subordinate files matching &lsquo;<samp>gdb.info*</samp>&rsquo; in the same directory. If
  97. necessary, you can print out these files, or read them with any editor;
  98. but they are easier to read using the <code>info</code> subsystem in <small>GNU</small>
  99. Emacs or the standalone <code>info</code> program, available as part of the
  100. <small>GNU</small> Texinfo distribution.
  101. </p>
  102. <p>If you want to format these Info files yourself, you need one of the
  103. Info formatting programs, such as <code>texinfo-format-buffer</code> or
  104. <code>makeinfo</code>.
  105. </p>
  106. <p>If you have <code>makeinfo</code> installed, and are in the top level
  107. <small>GDB</small> source directory (<samp>gdb-10.1.90.20201028-git</samp>, in the case of
  108. version 10.1.90.20201028-git), you can make the Info file by typing:
  109. </p>
  110. <div class="smallexample">
  111. <pre class="smallexample">cd gdb
  112. make gdb.info
  113. </pre></div>
  114. <p>If you want to typeset and print copies of this manual, you need TeX,
  115. a program to print its <small>DVI</small> output files, and <samp>texinfo.tex</samp>, the
  116. Texinfo definitions file.
  117. </p>
  118. <p>TeX is a typesetting program; it does not print files directly, but
  119. produces output files called <small>DVI</small> files. To print a typeset
  120. document, you need a program to print <small>DVI</small> files. If your system
  121. has TeX installed, chances are it has such a program. The precise
  122. command to use depends on your system; <kbd>lpr -d</kbd> is common; another
  123. (for PostScript devices) is <kbd>dvips</kbd>. The <small>DVI</small> print command may
  124. require a file name without any extension or a &lsquo;<samp>.dvi</samp>&rsquo; extension.
  125. </p>
  126. <p>TeX also requires a macro definitions file called
  127. <samp>texinfo.tex</samp>. This file tells TeX how to typeset a document
  128. written in Texinfo format. On its own, TeX cannot either read or
  129. typeset a Texinfo file. <samp>texinfo.tex</samp> is distributed with GDB
  130. and is located in the <samp>gdb-<var>version-number</var>/texinfo</samp>
  131. directory.
  132. </p>
  133. <p>If you have TeX and a <small>DVI</small> printer program installed, you can
  134. typeset and print this manual. First switch to the <samp>gdb</samp>
  135. subdirectory of the main source directory (for example, to
  136. <samp>gdb-10.1.90.20201028-git/gdb</samp>) and type:
  137. </p>
  138. <div class="smallexample">
  139. <pre class="smallexample">make gdb.dvi
  140. </pre></div>
  141. <p>Then give <samp>gdb.dvi</samp> to your <small>DVI</small> printing program.
  142. </p>
  143. <div class="footnote">
  144. <hr>
  145. <h4 class="footnotes-heading">Footnotes</h4>
  146. <h3><a name="FOOT19" href="#DOCF19">(19)</a></h3>
  147. <p>In
  148. <samp>gdb-10.1.90.20201028-git/gdb/refcard.ps</samp> of the version 10.1.90.20201028-git
  149. release.</p>
  150. </div>
  151. <hr>
  152. <div class="header">
  153. <p>
  154. Next: <a href="Installing-GDB.html#Installing-GDB" accesskey="n" rel="next">Installing GDB</a>, Previous: <a href="In-Memoriam.html#In-Memoriam" accesskey="p" rel="previous">In Memoriam</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
  155. </div>
  156. </body>
  157. </html>