Changeset 3f0c882 for chapter06/groff.xml
- Timestamp:
- 12/21/2004 07:38:32 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:
- 3d36131c
- Parents:
- aaa3260
- File:
-
- 1 edited
-
chapter06/groff.xml (modified) (4 diffs)
Legend:
- Unmodified
- Added
- Removed
-
chapter06/groff.xml
raaa3260 r3f0c882 11 11 12 12 <sect2 role="package"><title/> 13 <para>The Groff package contains programs for processing and formatting text.</para>14 13 15 14 <segmentedlist> … … 19 18 </segmentedlist> 20 19 21 <segmentedlist>22 <segtitle>Groff installation depends on</segtitle>23 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,24 Gawk, GCC, Glibc, Grep, Make, Sed</seg></seglistitem>25 </segmentedlist>26 20 </sect2> 27 21 28 22 <sect2 role="installation"> 29 23 <title>Installation of Groff</title> 30 31 <para>Groff expects the environment variable PAGE to contain the default paper32 size. For those in the United States, the command below is appropriate. If you33 live elsewhere, you may want to change <emphasis>PAGE=letter</emphasis> to34 <emphasis>PAGE=A4</emphasis>.</para>35 24 36 25 <para>Prepare Groff for compilation:</para> … … 46 35 <screen><userinput>make install</userinput></screen> 47 36 48 <para>Some documentation programs, such as <command>xman</command>, 49 will not work properly without the following symlinks:</para> 37 <para>Create the following symlinks:</para> 50 38 51 39 <screen><userinput>ln -s soelim /usr/bin/zsoelim … … 58 46 <sect2 id="contents-groff" role="content"><title>Contents of Groff</title> 59 47 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><title>Short descriptions</title> 69 70 <varlistentry id="addftinfo"> 71 <term><command>addftinfo</command></term> 72 <listitem> 73 <indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> 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 </listitem> 77 </varlistentry> 78 79 <varlistentry id="afmtodit"> 80 <term><command>afmtodit</command></term> 81 <listitem> 82 <indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> 83 <para>creates a font file for use with <command>groff</command> and <command>grops</command>.</para> 84 </listitem> 85 </varlistentry> 86 87 <varlistentry id="eqn"> 88 <term><command>eqn</command></term> 89 <listitem> 90 <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> 91 <para>compiles descriptions of equations embedded 92 within troff input files into commands that are understood by <command>troff</command>.</para> 93 </listitem> 94 </varlistentry> 95 96 <varlistentry id="eqn2graph"> 97 <term><command>eqn2graph</command></term> 98 <listitem> 99 <indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> 100 <para>converts an EQN equation into a cropped image.</para> 101 </listitem> 102 </varlistentry> 103 104 <varlistentry id="grn"> 105 <term><command>grn</command></term> 106 <listitem> 107 <indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> 108 <para>is a <command>groff</command> preprocessor for gremlin files.</para> 109 </listitem> 110 </varlistentry> 111 112 <varlistentry id="grodvi"> 113 <term><command>grodvi</command></term> 114 <listitem> 115 <indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> 116 <para>is a driver for <command>groff</command> that produces TeX dvi format.</para> 117 </listitem> 118 </varlistentry> 119 120 <varlistentry id="groff"> 121 <term><command>groff</command></term> 122 <listitem> 123 <indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> 124 <para>is a front-end to the groff document 125 formatting system. Normally it runs the <command>troff</command> program and a post-processor 126 appropriate for the selected device.</para> 127 </listitem> 128 </varlistentry> 129 130 <varlistentry id="groffer"> 131 <term><command>groffer</command></term> 132 <listitem> 133 <indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> 134 <para>displays groff files and man pages on X and tty terminals.</para> 135 </listitem> 136 </varlistentry> 137 138 <varlistentry id="grog"> 139 <term><command>grog</command></term> 140 <listitem> 141 <indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> 142 <para>reads files and guesses which of the <command>groff</command> 143 options <parameter>-e</parameter>, <parameter>-man</parameter>, 144 <parameter>-me</parameter>, <parameter>-mm</parameter>, 145 <parameter>-ms</parameter>, <parameter>-p</parameter>, <parameter>-s</parameter>, 146 and <parameter>-t</parameter> are required for printing 147 files, and reports the <command>groff</command> command including those options.</para> 148 </listitem> 149 </varlistentry> 150 151 <varlistentry id="grolbp"> 152 <term><command>grolbp</command></term> 153 <listitem> 154 <indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> 155 <para>is a <command>groff</command> driver for Canon CAPSL printers 156 (LBP-4 and LBP-8 series laser printers).</para> 157 </listitem> 158 </varlistentry> 159 160 <varlistentry id="grolj4"> 161 <term><command>grolj4</command></term> 162 <listitem> 163 <indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> 164 <para>is a driver for <command>groff</command> that produces output 165 in PCL5 format suitable for an HP Laserjet 4 printer.</para> 166 </listitem> 167 </varlistentry> 168 169 <varlistentry id="grops"> 170 <term><command>grops</command></term> 171 <listitem> 172 <indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> 173 <para>translates the output of GNU <command>troff</command> to PostScript.</para> 174 </listitem> 175 </varlistentry> 176 177 <varlistentry id="grotty"> 178 <term><command>grotty</command></term> 179 <listitem> 180 <indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> 181 <para>translates the output of GNU <command>troff</command> into 182 a form suitable for typewriter-like devices.</para> 183 </listitem> 184 </varlistentry> 185 186 <varlistentry id="gtbl"> 187 <term><command>gtbl</command></term> 188 <listitem> 189 <indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> 190 <para>is the GNU implementation of <command>tbl</command>.</para> 191 </listitem> 192 </varlistentry> 193 194 <varlistentry id="hpftodit"> 195 <term><command>hpftodit</command></term> 196 <listitem> 197 <indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> 198 <para>creates a font file for use with 199 <command>groff -Tlj4</command> from an HP-tagged font metric file.</para> 200 </listitem> 201 </varlistentry> 202 203 <varlistentry id="indxbib"> 204 <term><command>indxbib</command></term> 205 <listitem> 206 <indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> 207 <para>makes an inverted index for the bibliographic databases a specified file for 208 use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command>.</para> 209 </listitem> 210 </varlistentry> 211 212 <varlistentry id="lkbib"> 213 <term><command>lkbib</command></term> 214 <listitem> 215 <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> 216 <para>searches bibliographic databases for 217 references that contain specified keys and reports any references found.</para> 218 </listitem> 219 </varlistentry> 220 221 <varlistentry id="lookbib"> 222 <term><command>lookbib</command></term> 223 <listitem> 224 <indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> 225 <para>prints a prompt on the standard error 226 (unless the standard input is not a terminal), reads from the standard input 227 a line containing a set of keywords, searches the bibliographic databases in 228 a specified file for references containing those keywords, prints any 229 references found on the standard output and repeats this process until the 230 end of input.</para> 231 </listitem> 232 </varlistentry> 233 234 <varlistentry id="mmroff"> 235 <term><command>mmroff</command></term> 236 <listitem> 237 <indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> 238 <para>is a simple preprocessor for <command>groff</command>.</para> 239 </listitem> 240 </varlistentry> 241 242 <varlistentry id="neqn"> 243 <term><command>neqn</command></term> 244 <listitem> 245 <indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> 246 <para>formats equations for ASCII (American Standard Code for Information 247 Interchange) output.</para> 248 </listitem> 249 </varlistentry> 250 251 <varlistentry id="nroff"> 252 <term><command>nroff</command></term> 253 <listitem> 254 <indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> 255 <para>is a script that emulates the <command>nroff</command> command using <command>groff</command>.</para> 256 </listitem> 257 </varlistentry> 258 259 <varlistentry id="pfbtops"> 260 <term><command>pfbtops</command></term> 261 <listitem> 262 <indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> 263 <para>translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII.</para> 264 </listitem> 265 </varlistentry> 266 267 <varlistentry id="pic"> 268 <term><command>pic</command></term> 269 <listitem> 270 <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> 271 <para>compiles descriptions of pictures embedded 272 within troff or TeX input files into commands understood by TeX or <command>troff</command>.</para> 273 </listitem> 274 </varlistentry> 275 276 <varlistentry id="pic2graph"> 277 <term><command>pic2graph</command></term> 278 <listitem> 279 <indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> 280 <para>converts a PIC diagram into a cropped image.</para> 281 </listitem> 282 </varlistentry> 283 284 <varlistentry id="pre-grohtml"> 285 <term><command>pre-grohtml </command></term> 286 <listitem> 287 <indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> 288 <para>translates the output of GNU <command>troff</command> to html.</para> 289 </listitem> 290 </varlistentry> 291 292 <varlistentry id="post-grohtml"> 293 <term><command>post-grohtml</command></term> 294 <listitem> 295 <indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> 296 <para>translates the output of GNU <command>troff</command> to html.</para> 297 </listitem> 298 </varlistentry> 299 300 <varlistentry id="refer"> 301 <term><command>refer</command></term> 302 <listitem> 303 <indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> 304 <para>copies the contents of a file to the 305 standard output, except that lines between .[ and .] are interpreted as 306 citations, and lines between .R1 and .R2 are interpreted as commands about 307 how citations are to be processed.</para> 308 </listitem> 309 </varlistentry> 310 311 <varlistentry id="soelim"> 312 <term><command>soelim</command></term> 313 <listitem> 314 <indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm> 315 <para>reads files and replaces lines of the form 316 <emphasis>.so file</emphasis> by the contents of the mentioned 317 <emphasis>file</emphasis>.</para> 318 </listitem> 319 </varlistentry> 320 321 <varlistentry id="tbl"> 322 <term><command>tbl</command></term> 323 <listitem> 324 <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> 325 <para>compiles descriptions of tables embedded 326 within troff input files into commands that are understood by <command>troff</command>.</para> 327 </listitem> 328 </varlistentry> 329 330 <varlistentry id="tfmtodit"> 331 <term><command>tfmtodit</command></term> 332 <listitem> 333 <indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> 334 <para>creates a font file for use with <command>groff -Tdvi</command>.</para> 335 </listitem> 336 </varlistentry> 337 338 <varlistentry id="troff"> 339 <term><command>troff</command></term> 340 <listitem> 341 <indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> 342 <para>is highly compatible with Unix <command>troff</command>. Usually it should be invoked using the 343 <command>groff</command> command, which will also run preprocessors and post-processors in the 344 appropriate order and with the appropriate options.</para> 345 </listitem> 346 </varlistentry> 347 348 <varlistentry id="zsoelim"> 349 <term><command>zsoelim</command></term> 350 <listitem> 351 <indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> 352 <para>is the GNU implementation of <command>soelim</command>.</para> 353 </listitem> 354 </varlistentry> 355 </variablelist> 48 <para>See testing</para> 356 49 357 50 </sect2>
Note:
See TracChangeset
for help on using the changeset viewer.
