mingw/info/gdb/Formatting-Documentation.html

   1 <html lang="en">
   2 <head>
   3 <title>Debugging with GDB</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="Debugging with GDB">
   6 <meta name="generator" content="makeinfo 4.3">
   7 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home">
   8 </head>
   9 <body>
  10 <div class="node">
  11 <p>
  12 Node:<a name="Formatting%20Documentation">Formatting Documentation</a>,
  13 Next:<a rel="next" accesskey="n" href="Command-Line-Editing.html#Command%20Line%20Editing">Command Line Editing</a>,
  14 Previous:<a rel="previous" accesskey="p" href="GDB-Bugs.html#GDB%20Bugs">GDB Bugs</a>,
  15 Up:<a rel="up" accesskey="u" href="index.html#Top">Top</a>
  16 <hr><br>
  17 </div>
  18
  19 <h2 class="appendix">Formatting Documentation</h2>
  20
  21    <p>The GDB 4 release includes an already-formatted reference card, ready
  22 for printing with PostScript or Ghostscript, in the <code>gdb</code>
  23 subdirectory of the main source directory<a rel="footnote" href="#fn-1"><sup>1</sup></a>.  If you can use PostScript or Ghostscript with your printer,
  24 you can print the reference card immediately with <code>refcard.ps</code>.
  25
  26    <p>The release also includes the source for the reference card.  You
  27 can format it, using TeX, by typing:
  28
  29 <pre class="example">     make refcard.dvi
  30      </pre>
  31
  32    <p>The GDB reference card is designed to print in <dfn>landscape</dfn>
  33 mode on US "letter" size paper;
  34 that is, on a sheet 11 inches wide by 8.5 inches
  35 high.  You will need to specify this form of printing as an option to
  36 your <small>DVI</small> output program.
  37
  38    <p>All the documentation for GDB comes as part of the machine-readable
  39 distribution.  The documentation is written in Texinfo format, which is
  40 a documentation system that uses a single source file to produce both
  41 on-line information and a printed manual.  You can use one of the Info
  42 formatting commands to create the on-line version of the documentation
  43 and TeX (or <code>texi2roff</code>) to typeset the printed version.
  44
  45    GDB includes an already formatted copy of the on-line Info
  46 version of this manual in the <code>gdb</code> subdirectory.  The main Info
  47 file is <code>gdb-5.2.1/gdb/gdb.info</code>, and it refers to
  48 subordinate files matching <code>gdb.info*</code> in the same directory.  If
  49 necessary, you can print out these files, or read them with any editor;
  50 but they are easier to read using the <code>info</code> subsystem in <small>GNU</small>
  51 Emacs or the standalone <code>info</code> program, available as part of the
  52 <small>GNU</small> Texinfo distribution.
  53
  54    <p>If you want to format these Info files yourself, you need one of the
  55 Info formatting programs, such as <code>texinfo-format-buffer</code> or
  56 <code>makeinfo</code>.
  57
  58    <p>If you have <code>makeinfo</code> installed, and are in the top level
  59 GDB source directory (<code>gdb-5.2.1</code>, in the case of
  60 version 5.2.1), you can make the Info file by typing:
  61
  62 <pre class="example">     cd gdb
  63      make gdb.info
  64      </pre>
  65
  66    <p>If you want to typeset and print copies of this manual, you need TeX,
  67 a program to print its <small>DVI</small> output files, and <code>texinfo.tex</code>, the
  68 Texinfo definitions file.
  69
  70    <p>TeX is a typesetting program; it does not print files directly, but
  71 produces output files called <small>DVI</small> files.  To print a typeset
  72 document, you need a program to print <small>DVI</small> files.  If your system
  73 has TeX installed, chances are it has such a program.  The precise
  74 command to use depends on your system; <kbd>lpr -d</kbd> is common; another
  75 (for PostScript devices) is <kbd>dvips</kbd>.  The <small>DVI</small> print command may
  76 require a file name without any extension or a <code>.dvi</code> extension.
  77
  78    <p>TeX also requires a macro definitions file called
  79 <code>texinfo.tex</code>.  This file tells TeX how to typeset a document
  80 written in Texinfo format.  On its own, TeX cannot either read or
  81 typeset a Texinfo file.  <code>texinfo.tex</code> is distributed with GDB
  82 and is located in the <code>gdb-</code><var>version-number</var><code>/texinfo</code>
  83 directory.
  84
  85    <p>If you have TeX and a <small>DVI</small> printer program installed, you can
  86 typeset and print this manual.  First switch to the the <code>gdb</code>
  87 subdirectory of the main source directory (for example, to
  88 <code>gdb-5.2.1/gdb</code>) and type:
  89
  90 <pre class="example">     make gdb.dvi
  91      </pre>
  92
  93    <p>Then give <code>gdb.dvi</code> to your <small>DVI</small> printing program.
  94
  95    <div class="footnote">
  96 <hr>
  97 <h4>Footnotes</h4>
  98 <ol type="1">
  99 <li><a name="fn-1"></a>
 100 <p>In
 101 <code>gdb-5.2.1/gdb/refcard.ps</code> of the version 5.2.1
 102 release.</p>
 103
 104    </ol><hr></div>
 105
 106    </body></html>
 107