Changeset 81fd230 for chapter06/groff.xml
- Timestamp:
- 02/19/2005 10:16:42 PM (19 years ago)
- Branches:
- 10.0, 10.0-rc1, 10.1, 10.1-rc1, 11.0, 11.0-rc1, 11.0-rc2, 11.0-rc3, 11.1, 11.1-rc1, 11.2, 11.2-rc1, 11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, 6.1, 6.1.1, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.5-systemd, 7.6, 7.6-systemd, 7.7, 7.7-systemd, 7.8, 7.8-systemd, 7.9, 7.9-systemd, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, arm, bdubbs/gcc13, ml-11.0, multilib, renodr/libudev-from-systemd, s6-init, trunk, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/lfs-next, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/mips64el, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc
- Children:
- 3d31fc4
- Parents:
- 2f9131f
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
chapter06/groff.xml
r2f9131f r81fd230 4 4 %general-entities; 5 5 ]> 6 <sect1 id="ch-system-groff" xreflabel="Groff"role="wrap">6 <sect1 id="ch-system-groff" role="wrap"> 7 7 <title>Groff-&groff-version;</title> 8 8 <?dbhtml filename="groff.html"?> … … 11 11 12 12 <sect2 role="package"><title/> 13 <para>The Groff package contains programs for processing and formatting text.</para> 13 14 14 15 <segmentedlist> … … 18 19 </segmentedlist> 19 20 21 <segmentedlist> 22 <segtitle>Groff installation depends on</segtitle> 23 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, 24 Gawk, GCC, Glibc, Grep, Make, and Sed</seg></seglistitem> 25 </segmentedlist> 20 26 </sect2> 21 27 … … 23 29 <title>Installation of Groff</title> 24 30 31 <para>Groff expects the environment variable <envar>PAGE</envar> 32 to contain the default paper size. For users in the United States, 33 <parameter>PAGE=letter</parameter> is appropriate. Elsewhere, 34 <parameter>PAGE=A4</parameter> may be more suitable.</para> 35 25 36 <para>Prepare Groff for compilation:</para> 26 37 … … 31 42 <screen><userinput>make</userinput></screen> 32 43 33 <para> Now install it:</para>44 <para>Install the package:</para> 34 45 35 46 <screen><userinput>make install</userinput></screen> 36 47 37 <para>Create the following symlinks:</para> 48 <para>Some documentation programs, such as <command>xman</command>, 49 will not work properly without the following symlinks:</para> 38 50 39 51 <screen><userinput>ln -s soelim /usr/bin/zsoelim … … 46 58 <sect2 id="contents-groff" role="content"><title>Contents of Groff</title> 47 59 48 <para>See testing</para> 60 <segmentedlist> 61 <segtitle>Installed programs</segtitle> 62 <seglistitem><seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn, 63 grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit, 64 indxbib, lkbib, lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml, 65 pre-grohtml, refer, soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg></seglistitem> 66 </segmentedlist> 67 68 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 69 <?dbfo list-presentation="list"?> 70 71 <varlistentry id="addftinfo"> 72 <term><command>addftinfo</command></term> 73 <listitem> 74 <para>Reads a troff font file and adds some 75 additional font-metric information that is used by the <command>groff</command> system</para> 76 <indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> 77 </listitem> 78 </varlistentry> 79 80 <varlistentry id="afmtodit"> 81 <term><command>afmtodit</command></term> 82 <listitem> 83 <para>Creates a font file for use with <command>groff</command> and <command>grops</command></para> 84 <indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> 85 </listitem> 86 </varlistentry> 87 88 <varlistentry id="eqn"> 89 <term><command>eqn</command></term> 90 <listitem> 91 <para>Compiles descriptions of equations embedded 92 within troff input files into commands that are understood by <command>troff</command></para> 93 <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> 94 </listitem> 95 </varlistentry> 96 97 <varlistentry id="eqn2graph"> 98 <term><command>eqn2graph</command></term> 99 <listitem> 100 <para>Converts a troff EQN (equation) into a cropped image</para> 101 <indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> 102 </listitem> 103 </varlistentry> 104 105 <varlistentry id="geqn"> 106 <term><command>eqn</command></term> 107 <listitem> 108 <para>A link to <command>eqn</command></para> 109 <indexterm zone="ch-system-groff geqn"><primary sortas="b-geqn">geqn</primary></indexterm> 110 </listitem> 111 </varlistentry> 112 113 <varlistentry id="grn"> 114 <term><command>grn</command></term> 115 <listitem> 116 <para>A <command>groff</command> preprocessor for gremlin files</para> 117 <indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> 118 </listitem> 119 </varlistentry> 120 121 <varlistentry id="grodvi"> 122 <term><command>grodvi</command></term> 123 <listitem> 124 <para>A driver for <command>groff</command> that produces TeX dvi format</para> 125 <indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> 126 </listitem> 127 </varlistentry> 128 129 <varlistentry id="groff"> 130 <term><command>groff</command></term> 131 <listitem> 132 <para>A front-end to the groff document 133 formatting system; normally, it runs the <command>troff</command> program and a post-processor 134 appropriate for the selected device</para> 135 <indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> 136 </listitem> 137 </varlistentry> 138 139 <varlistentry id="groffer"> 140 <term><command>groffer</command></term> 141 <listitem> 142 <para>Displays groff files and man pages on X and tty terminals</para> 143 <indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> 144 </listitem> 145 </varlistentry> 146 147 <varlistentry id="grog"> 148 <term><command>grog</command></term> 149 <listitem> 150 <para>Reads files and guesses which of the <command>groff</command> 151 options <parameter>-e</parameter>, <parameter>-man</parameter>, 152 <parameter>-me</parameter>, <parameter>-mm</parameter>, 153 <parameter>-ms</parameter>, <parameter>-p</parameter>, <parameter>-s</parameter>, 154 and <parameter>-t</parameter> are required for printing 155 files, and reports the <command>groff</command> command including those options</para> 156 <indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> 157 </listitem> 158 </varlistentry> 159 160 <varlistentry id="grolbp"> 161 <term><command>grolbp</command></term> 162 <listitem> 163 <para>Is a <command>groff</command> driver for Canon CAPSL printers 164 (LBP-4 and LBP-8 series laser printers)</para> 165 <indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> 166 </listitem> 167 </varlistentry> 168 169 <varlistentry id="grolj4"> 170 <term><command>grolj4</command></term> 171 <listitem> 172 <para>Is a driver for <command>groff</command> that produces output 173 in PCL5 format suitable for an HP Laserjet 4 printer</para> 174 <indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> 175 </listitem> 176 </varlistentry> 177 178 <varlistentry id="grops"> 179 <term><command>grops</command></term> 180 <listitem> 181 <para>Translates the output of GNU <command>troff</command> to PostScript</para> 182 <indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> 183 </listitem> 184 </varlistentry> 185 186 <varlistentry id="grotty"> 187 <term><command>grotty</command></term> 188 <listitem> 189 <para>Translates the output of GNU <command>troff</command> into 190 a form suitable for typewriter-like devices</para> 191 <indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> 192 </listitem> 193 </varlistentry> 194 195 <varlistentry id="gtbl"> 196 <term><command>gtbl</command></term> 197 <listitem> 198 <para>Is the GNU implementation of <command>tbl</command></para> 199 <indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> 200 </listitem> 201 </varlistentry> 202 203 <varlistentry id="hpftodit"> 204 <term><command>hpftodit</command></term> 205 <listitem> 206 <para>Creates a font file for use with 207 <command>groff -Tlj4</command> from an HP-tagged font metric file</para> 208 <indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> 209 </listitem> 210 </varlistentry> 211 212 <varlistentry id="indxbib"> 213 <term><command>indxbib</command></term> 214 <listitem> 215 <para>Creates an inverted index for the bibliographic databases with a specified file for 216 use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command></para> 217 <indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> 218 </listitem> 219 </varlistentry> 220 221 <varlistentry id="lkbib"> 222 <term><command>lkbib</command></term> 223 <listitem> 224 <para>Searches bibliographic databases for references that contain 225 specified keys and reports any references found</para> 226 <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> 227 </listitem> 228 </varlistentry> 229 230 <varlistentry id="lookbib"> 231 <term><command>lookbib</command></term> 232 <listitem> 233 <para>Prints a prompt on the standard error (unless the standard input 234 is not a terminal), reads a line containing a 235 set of keywords from the standard input, searches the bibliographic databases in a specified 236 file for references containing those keywords, prints any references 237 found on the standard output, and repeats this process until the end 238 of input</para> 239 <indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> 240 </listitem> 241 </varlistentry> 242 243 <varlistentry id="mmroff"> 244 <term><command>mmroff</command></term> 245 <listitem> 246 <para>A simple preprocessor for <command>groff</command></para> 247 <indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> 248 </listitem> 249 </varlistentry> 250 251 <varlistentry id="neqn"> 252 <term><command>neqn</command></term> 253 <listitem> 254 <para>Formats equations for American Standard Code for Information 255 Interchange (ASCII) output</para> 256 <indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> 257 </listitem> 258 </varlistentry> 259 260 <varlistentry id="nroff"> 261 <term><command>nroff</command></term> 262 <listitem> 263 <para>A script that emulates the <command>nroff</command> command using <command>groff</command></para> 264 <indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> 265 </listitem> 266 </varlistentry> 267 268 <varlistentry id="pfbtops"> 269 <term><command>pfbtops</command></term> 270 <listitem> 271 <para>Translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII</para> 272 <indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> 273 </listitem> 274 </varlistentry> 275 276 <varlistentry id="pic"> 277 <term><command>pic</command></term> 278 <listitem> 279 <para>Compiles descriptions of pictures embedded 280 within troff or TeX input files into commands understood by TeX or <command>troff</command></para> 281 <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> 282 </listitem> 283 </varlistentry> 284 285 <varlistentry id="pic2graph"> 286 <term><command>pic2graph</command></term> 287 <listitem> 288 <para>Converts a PIC diagram into a cropped image</para> 289 <indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> 290 </listitem> 291 </varlistentry> 292 293 <varlistentry id="post-grohtml"> 294 <term><command>post-grohtml</command></term> 295 <listitem> 296 <para>Translates the output of GNU <command>troff</command> to html</para> 297 <indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> 298 </listitem> 299 </varlistentry> 300 301 <varlistentry id="pre-grohtml"> 302 <term><command>pre-grohtml </command></term> 303 <listitem> 304 <para>Translates the output of GNU <command>troff</command> to html</para> 305 <indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> 306 </listitem> 307 </varlistentry> 308 309 <varlistentry id="refer"> 310 <term><command>refer</command></term> 311 <listitem> 312 <para>Copies the contents of a file to the standard output, except 313 that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis> 314 are interpreted as citations, and lines between 315 <emphasis>.R1</emphasis> and <emphasis>.R2</emphasis> are interpreted 316 as commands for how citations are to be processed</para> 317 <indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> 318 </listitem> 319 </varlistentry> 320 321 <varlistentry id="soelim"> 322 <term><command>soelim</command></term> 323 <listitem> 324 <para>Reads files and replaces lines of the form 325 <emphasis>.so file</emphasis> by the contents of the mentioned 326 <emphasis>file</emphasis></para> 327 <indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm> 328 </listitem> 329 </varlistentry> 330 331 <varlistentry id="tbl"> 332 <term><command>tbl</command></term> 333 <listitem> 334 <para>Compiles descriptions of tables embedded 335 within troff input files into commands that are understood by <command>troff</command></para> 336 <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> 337 </listitem> 338 </varlistentry> 339 340 <varlistentry id="tfmtodit"> 341 <term><command>tfmtodit</command></term> 342 <listitem> 343 <para>Creates a font file for use with <command>groff -Tdvi</command></para> 344 <indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> 345 </listitem> 346 </varlistentry> 347 348 <varlistentry id="troff"> 349 <term><command>troff</command></term> 350 <listitem> 351 <para>Is highly compatible with Unix <command>troff</command>; it 352 should usually be invoked using the 353 <command>groff</command> command, which will also run preprocessors and post-processors in the 354 appropriate order and with the appropriate options</para> 355 <indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> 356 </listitem> 357 </varlistentry> 358 359 <varlistentry id="zsoelim"> 360 <term><command>zsoelim</command></term> 361 <listitem> 362 <para>Is the GNU implementation of <command>soelim</command></para> 363 <indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> 364 </listitem> 365 </varlistentry> 366 </variablelist> 49 367 50 368 </sect2> 51 369 52 370 </sect1> 371
Note:
See TracChangeset
for help on using the changeset viewer.