- Timestamp:
- 02/05/2006 11:42:02 AM (19 years ago)
- Children:
- 9442d266
- Parents:
- 3a0a57c
- Location:
- chapter06
- Files:
-
- 7 edited
Legend:
- Unmodified
- Added
- Removed
-
chapter06/groff.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-groff" role="wrap"> 7 <title>Groff-&groff-version;</title> 8 <?dbhtml filename="groff.html"?> 9 10 <indexterm zone="ch-system-groff"><primary sortas="a-Groff">Groff</primary></indexterm> 11 12 <sect2 role="package"><title/> 13 <para>The Groff package contains programs for processing and formatting text.</para> 14 15 <segmentedlist> 16 <segtitle>&buildtime;</segtitle> 17 <segtitle>&diskspace;</segtitle> 18 <seglistitem><seg>0.5 SBU</seg><seg>38.7 MB</seg></seglistitem> 19 </segmentedlist> 20 21 <segmentedlist> 22 <segtitle>&dependencies;</segtitle> 23 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, 24 Gawk, GCC, Glibc, Grep, Make, and Sed</seg></seglistitem> 25 </segmentedlist> 26 </sect2> 27 28 <sect2 role="installation"> 29 <title>Installation of Groff</title> 30 31 <para>Apply the patch that adds the <quote>ascii8</quote> and 32 <quote>nippon</quote> devices to Groff:</para> 9 <?dbhtml filename="groff.html"?> 10 11 <title>Groff-&groff-version;</title> 12 13 <indexterm zone="ch-system-groff"> 14 <primary sortas="a-Groff">Groff</primary> 15 </indexterm> 16 17 <sect2 role="package"> 18 <title/> 19 20 <para>The Groff package contains programs for processing and formatting 21 text.</para> 22 23 <segmentedlist> 24 <segtitle>&buildtime;</segtitle> 25 <segtitle>&diskspace;</segtitle> 26 27 <seglistitem> 28 <seg>0.5 SBU</seg> 29 <seg>38.7 MB</seg> 30 </seglistitem> 31 </segmentedlist> 32 33 <segmentedlist> 34 <segtitle>&dependencies;</segtitle> 35 36 <seglistitem> 37 <seg>Bash, Binutils, Coreutils, Diffutils, Gawk, GCC, Glibc, Grep, 38 Make, and Sed</seg> 39 </seglistitem> 40 </segmentedlist> 41 42 </sect2> 43 44 <sect2 role="installation"> 45 <title>Installation of Groff</title> 46 47 <para>Apply the patch that adds the <quote>ascii8</quote> and 48 <quote>nippon</quote> devices to Groff:</para> 33 49 34 50 <screen><userinput>zcat ../&groff-debian-patch; | patch -Np1</userinput></screen> 35 51 36 <note><para>These devices are used by Man-DB when formatting non-English manual 37 pages that are not in the ISO-8859-1 encoding. Currently, there is no working 38 patch for Groff-1.19.x that adds this functionality. 39 <!-- Details: http://bugs.debian.org/196762 --> 40 </para></note> 41 42 <para>Many screen fonts don't have Unicode single quotes and dashes in them. 43 Tell Groff to use the ASCII equivalents instead:</para> 52 <note> 53 <para>These devices are used by Man-DB when formatting non-English manual 54 pages that are not in the ISO-8859-1 encoding. Currently, there is no 55 working patch for Groff-1.19.x that adds this functionality.</para> 56 <!-- Details: http://bugs.debian.org/196762 --> 57 </note> 58 59 <para>Many screen fonts don't have Unicode single quotes and dashes in them. 60 Tell Groff to use the ASCII equivalents instead:</para> 44 61 45 62 <screen><userinput>sed -i -e 's/2010/002D/' -e 's/2212/002D/' \ 46 -e 's/2018/0060/' -e 's/2019/0027/' font/devutf8/R.proto 47 </userinput></screen> 48 49 <para>Groff expects the environment variable <envar>PAGE</envar> 50 to contain the default paper size. For users in the United States, 51 <parameter>PAGE=letter</parameter> is appropriate. Elsewhere, 52 <parameter>PAGE=A4</parameter> may be more suitable. 53 While the default paper size is configured during compilation, it can be 54 overridden later by echoing either <quote>A4</quote> or <quote>letter</quote> 55 to the <filename>/etc/papersize</filename> file.</para> 56 57 <para>Prepare Groff for compilation:</para> 63 -e 's/2018/0060/' -e 's/2019/0027/' font/devutf8/R.proto</userinput></screen> 64 65 <para>Groff expects the environment variable <envar>PAGE</envar> to 66 contain the default paper size. For users in the United States, 67 <parameter>PAGE=letter</parameter> is appropriate. Elsewhere, 68 <parameter>PAGE=A4</parameter> may be more suitable. While the default 69 paper size is configured during compilation, it can be overridden later 70 by echoing either <quote>A4</quote> or <quote>letter</quote> to the 71 <filename>/etc/papersize</filename> file.</para> 72 73 <para>Prepare Groff for compilation:</para> 58 74 59 75 <screen><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr --enable-multibyte</userinput></screen> 60 76 61 <para>Compile the package:</para>77 <para>Compile the package:</para> 62 78 63 79 <screen><userinput>make</userinput></screen> 64 80 65 <para>This package does not come with a test suite.</para>66 67 <para>Install the package:</para>81 <para>This package does not come with a test suite.</para> 82 83 <para>Install the package:</para> 68 84 69 85 <screen><userinput>make install</userinput></screen> 70 86 71 <para>Some documentation programs, such as <command>xman</command>,72 will not work properly without the following symlinks:</para>87 <para>Some documentation programs, such as <command>xman</command>, 88 will not work properly without the following symlinks:</para> 73 89 74 90 <screen><userinput>ln -sv soelim /usr/bin/zsoelim … … 76 92 ln -sv tbl /usr/bin/gtbl</userinput></screen> 77 93 78 </sect2> 79 80 81 <sect2 id="contents-groff" role="content"><title>Contents of Groff</title> 82 83 <segmentedlist> 84 <segtitle>Installed programs</segtitle> 85 <seglistitem><seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn, 86 grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit, 87 indxbib, lkbib, lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml, 88 pre-grohtml, refer, soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg></seglistitem> 89 </segmentedlist> 90 91 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 92 <?dbfo list-presentation="list"?> 93 <?dbhtml list-presentation="table"?> 94 95 <varlistentry id="addftinfo"> 96 <term><command>addftinfo</command></term> 97 <listitem> 98 <para>Reads a troff font file and adds some 99 additional font-metric information that is used by the <command>groff</command> system</para> 100 <indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> 101 </listitem> 102 </varlistentry> 103 104 <varlistentry id="afmtodit"> 105 <term><command>afmtodit</command></term> 106 <listitem> 107 <para>Creates a font file for use with <command>groff</command> and <command>grops</command></para> 108 <indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> 109 </listitem> 110 </varlistentry> 111 112 <varlistentry id="eqn"> 113 <term><command>eqn</command></term> 114 <listitem> 115 <para>Compiles descriptions of equations embedded 116 within troff input files into commands that are understood by <command>troff</command></para> 117 <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> 118 </listitem> 119 </varlistentry> 120 121 <varlistentry id="eqn2graph"> 122 <term><command>eqn2graph</command></term> 123 <listitem> 124 <para>Converts a troff EQN (equation) into a cropped image</para> 125 <indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> 126 </listitem> 127 </varlistentry> 128 129 <varlistentry id="geqn"> 130 <term><command>geqn</command></term> 131 <listitem> 132 <para>A link to <command>eqn</command></para> 133 <indexterm zone="ch-system-groff geqn"><primary sortas="b-geqn">geqn</primary></indexterm> 134 </listitem> 135 </varlistentry> 136 137 <varlistentry id="grn"> 138 <term><command>grn</command></term> 139 <listitem> 140 <para>A <command>groff</command> preprocessor for gremlin files</para> 141 <indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> 142 </listitem> 143 </varlistentry> 144 145 <varlistentry id="grodvi"> 146 <term><command>grodvi</command></term> 147 <listitem> 148 <para>A driver for <command>groff</command> that produces TeX dvi format</para> 149 <indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> 150 </listitem> 151 </varlistentry> 152 153 <varlistentry id="groff"> 154 <term><command>groff</command></term> 155 <listitem> 156 <para>A front-end to the groff document 157 formatting system; normally, it runs the <command>troff</command> program and a post-processor 158 appropriate for the selected device</para> 159 <indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> 160 </listitem> 161 </varlistentry> 162 163 <varlistentry id="groffer"> 164 <term><command>groffer</command></term> 165 <listitem> 166 <para>Displays groff files and man pages on X and tty terminals</para> 167 <indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> 168 </listitem> 169 </varlistentry> 170 171 <varlistentry id="grog"> 172 <term><command>grog</command></term> 173 <listitem> 174 <para>Reads files and guesses which of the <command>groff</command> 175 options <parameter>-e</parameter>, <parameter>-man</parameter>, 176 <parameter>-me</parameter>, <parameter>-mm</parameter>, 177 <parameter>-ms</parameter>, <parameter>-p</parameter>, <parameter>-s</parameter>, 178 and <parameter>-t</parameter> are required for printing 179 files, and reports the <command>groff</command> command including those options</para> 180 <indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> 181 </listitem> 182 </varlistentry> 183 184 <varlistentry id="grolbp"> 185 <term><command>grolbp</command></term> 186 <listitem> 187 <para>Is a <command>groff</command> driver for Canon CAPSL printers 188 (LBP-4 and LBP-8 series laser printers)</para> 189 <indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> 190 </listitem> 191 </varlistentry> 192 193 <varlistentry id="grolj4"> 194 <term><command>grolj4</command></term> 195 <listitem> 196 <para>Is a driver for <command>groff</command> that produces output 197 in PCL5 format suitable for an HP LaserJet 4 printer</para> 198 <indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> 199 </listitem> 200 </varlistentry> 201 202 <varlistentry id="grops"> 203 <term><command>grops</command></term> 204 <listitem> 205 <para>Translates the output of GNU <command>troff</command> to PostScript</para> 206 <indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> 207 </listitem> 208 </varlistentry> 209 210 <varlistentry id="grotty"> 211 <term><command>grotty</command></term> 212 <listitem> 213 <para>Translates the output of GNU <command>troff</command> into 214 a form suitable for typewriter-like devices</para> 215 <indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> 216 </listitem> 217 </varlistentry> 218 219 <varlistentry id="gtbl"> 220 <term><command>gtbl</command></term> 221 <listitem> 222 <para>A link to <command>tbl</command></para> 223 <indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> 224 </listitem> 225 </varlistentry> 226 227 <varlistentry id="hpftodit"> 228 <term><command>hpftodit</command></term> 229 <listitem> 230 <para>Creates a font file for use with 231 <command>groff -Tlj4</command> from an HP-tagged font metric file</para> 232 <indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> 233 </listitem> 234 </varlistentry> 235 236 <varlistentry id="indxbib"> 237 <term><command>indxbib</command></term> 238 <listitem> 239 <para>Creates an inverted index for the bibliographic databases with a specified file for 240 use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command></para> 241 <indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> 242 </listitem> 243 </varlistentry> 244 245 <varlistentry id="lkbib"> 246 <term><command>lkbib</command></term> 247 <listitem> 248 <para>Searches bibliographic databases for references that contain 249 specified keys and reports any references found</para> 250 <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> 251 </listitem> 252 </varlistentry> 253 254 <varlistentry id="lookbib"> 255 <term><command>lookbib</command></term> 256 <listitem> 257 <para>Prints a prompt on the standard error (unless the standard input 258 is not a terminal), reads a line containing a 259 set of keywords from the standard input, searches the bibliographic databases in a specified 260 file for references containing those keywords, prints any references 261 found on the standard output, and repeats this process until the end 262 of input</para> 263 <indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> 264 </listitem> 265 </varlistentry> 266 267 <varlistentry id="mmroff"> 268 <term><command>mmroff</command></term> 269 <listitem> 270 <para>A simple preprocessor for <command>groff</command></para> 271 <indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> 272 </listitem> 273 </varlistentry> 274 275 <varlistentry id="neqn"> 276 <term><command>neqn</command></term> 277 <listitem> 278 <para>Formats equations for American Standard Code for Information 279 Interchange (ASCII) output</para> 280 <indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> 281 </listitem> 282 </varlistentry> 283 284 <varlistentry id="nroff"> 285 <term><command>nroff</command></term> 286 <listitem> 287 <para>A script that emulates the <command>nroff</command> command using <command>groff</command></para> 288 <indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> 289 </listitem> 290 </varlistentry> 291 292 <varlistentry id="pfbtops"> 293 <term><command>pfbtops</command></term> 294 <listitem> 295 <para>Translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII</para> 296 <indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> 297 </listitem> 298 </varlistentry> 299 300 <varlistentry id="pic"> 301 <term><command>pic</command></term> 302 <listitem> 303 <para>Compiles descriptions of pictures embedded 304 within troff or TeX input files into commands understood by TeX or <command>troff</command></para> 305 <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> 306 </listitem> 307 </varlistentry> 308 309 <varlistentry id="pic2graph"> 310 <term><command>pic2graph</command></term> 311 <listitem> 312 <para>Converts a PIC diagram into a cropped image</para> 313 <indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> 314 </listitem> 315 </varlistentry> 316 317 <varlistentry id="post-grohtml"> 318 <term><command>post-grohtml</command></term> 319 <listitem> 320 <para>Translates the output of GNU <command>troff</command> to HTML</para> 321 <indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> 322 </listitem> 323 </varlistentry> 324 325 <varlistentry id="pre-grohtml"> 326 <term><command>pre-grohtml </command></term> 327 <listitem> 328 <para>Translates the output of GNU <command>troff</command> to HTML</para> 329 <indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> 330 </listitem> 331 </varlistentry> 332 333 <varlistentry id="refer"> 334 <term><command>refer</command></term> 335 <listitem> 336 <para>Copies the contents of a file to the standard output, except 337 that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis> 338 are interpreted as citations, and lines between 339 <emphasis>.R1</emphasis> and <emphasis>.R2</emphasis> are interpreted 340 as commands for how citations are to be processed</para> 341 <indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> 342 </listitem> 343 </varlistentry> 344 345 <varlistentry id="soelim"> 346 <term><command>soelim</command></term> 347 <listitem> 348 <para>Reads files and replaces lines of the form 349 <emphasis>.so file</emphasis> by the contents of the mentioned 350 <emphasis>file</emphasis></para> 351 <indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm> 352 </listitem> 353 </varlistentry> 354 355 <varlistentry id="tbl"> 356 <term><command>tbl</command></term> 357 <listitem> 358 <para>Compiles descriptions of tables embedded 359 within troff input files into commands that are understood by <command>troff</command></para> 360 <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> 361 </listitem> 362 </varlistentry> 363 364 <varlistentry id="tfmtodit"> 365 <term><command>tfmtodit</command></term> 366 <listitem> 367 <para>Creates a font file for use with <command>groff -Tdvi</command></para> 368 <indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> 369 </listitem> 370 </varlistentry> 371 372 <varlistentry id="troff"> 373 <term><command>troff</command></term> 374 <listitem> 375 <para>Is highly compatible with Unix <command>troff</command>; it 376 should usually be invoked using the 377 <command>groff</command> command, which will also run preprocessors and post-processors in the 378 appropriate order and with the appropriate options</para> 379 <indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> 380 </listitem> 381 </varlistentry> 382 383 <varlistentry id="zsoelim"> 384 <term><command>zsoelim</command></term> 385 <listitem> 386 <para>A link to <command>soelim</command></para> 387 <indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> 388 </listitem> 389 </varlistentry> 390 </variablelist> 391 392 </sect2> 94 </sect2> 95 96 <sect2 id="contents-groff" role="content"> 97 <title>Contents of Groff</title> 98 99 <segmentedlist> 100 <segtitle>Installed programs</segtitle> 101 102 <seglistitem> 103 <seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn, 104 grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl 105 (link to tbl), hpftodit, indxbib, lkbib, lookbib, mmroff, neqn, 106 nroff, pfbtops, pic, pic2graph, post-grohtml, pre-grohtml, refer, 107 soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg> 108 </seglistitem> 109 </segmentedlist> 110 111 <variablelist> 112 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 113 <?dbfo list-presentation="list"?> 114 <?dbhtml list-presentation="table"?> 115 116 <varlistentry id="addftinfo"> 117 <term><command>addftinfo</command></term> 118 <listitem> 119 <para>Reads a troff font file and adds some additional font-metric 120 information that is used by the <command>groff</command> system</para> 121 <indexterm zone="ch-system-groff addftinfo"> 122 <primary sortas="b-addftinfo">addftinfo</primary> 123 </indexterm> 124 </listitem> 125 </varlistentry> 126 127 <varlistentry id="afmtodit"> 128 <term><command>afmtodit</command></term> 129 <listitem> 130 <para>Creates a font file for use with <command>groff</command> and 131 <command>grops</command></para> 132 <indexterm zone="ch-system-groff afmtodit"> 133 <primary sortas="b-afmtodit">afmtodit</primary> 134 </indexterm> 135 </listitem> 136 </varlistentry> 137 138 <varlistentry id="eqn"> 139 <term><command>eqn</command></term> 140 <listitem> 141 <para>Compiles descriptions of equations embedded within troff 142 input files into commands that are understood by 143 <command>troff</command></para> 144 <indexterm zone="ch-system-groff eqn"> 145 <primary sortas="b-eqn">eqn</primary> 146 </indexterm> 147 </listitem> 148 </varlistentry> 149 150 <varlistentry id="eqn2graph"> 151 <term><command>eqn2graph</command></term> 152 <listitem> 153 <para>Converts a troff EQN (equation) into a cropped image</para> 154 <indexterm zone="ch-system-groff eqn2graph"> 155 <primary sortas="b-eqn2graph">eqn2graph</primary> 156 </indexterm> 157 </listitem> 158 </varlistentry> 159 160 <varlistentry id="geqn"> 161 <term><command>geqn</command></term> 162 <listitem> 163 <para>A link to <command>eqn</command></para> 164 <indexterm zone="ch-system-groff geqn"> 165 <primary sortas="b-geqn">geqn</primary> 166 </indexterm> 167 </listitem> 168 </varlistentry> 169 170 <varlistentry id="grn"> 171 <term><command>grn</command></term> 172 <listitem> 173 <para>A <command>groff</command> preprocessor for gremlin files</para> 174 <indexterm zone="ch-system-groff grn"> 175 <primary sortas="b-grn">grn</primary> 176 </indexterm> 177 </listitem> 178 </varlistentry> 179 180 <varlistentry id="grodvi"> 181 <term><command>grodvi</command></term> 182 <listitem> 183 <para>A driver for <command>groff</command> that produces TeX dvi 184 format</para> 185 <indexterm zone="ch-system-groff grodvi"> 186 <primary sortas="b-grodvi">grodvi</primary> 187 </indexterm> 188 </listitem> 189 </varlistentry> 190 191 <varlistentry id="groff"> 192 <term><command>groff</command></term> 193 <listitem> 194 <para>A front-end to the groff document formatting system; normally, it 195 runs the <command>troff</command> program and a post-processor 196 appropriate for the selected device</para> 197 <indexterm zone="ch-system-groff groff"> 198 <primary sortas="b-groff">groff</primary> 199 </indexterm> 200 </listitem> 201 </varlistentry> 202 203 <varlistentry id="groffer"> 204 <term><command>groffer</command></term> 205 <listitem> 206 <para>Displays groff files and man pages on X and tty terminals</para> 207 <indexterm zone="ch-system-groff groffer"> 208 <primary sortas="b-groffer">groffer</primary> 209 </indexterm> 210 </listitem> 211 </varlistentry> 212 213 <varlistentry id="grog"> 214 <term><command>grog</command></term> 215 <listitem> 216 <para>Reads files and guesses which of the <command>groff</command> 217 options <option>-e</option>, <option>-man</option>, <option>-me</option>, 218 <option>-mm</option>, <option>-ms</option>, <option>-p</option>, 219 <option>-s</option>, and <option>-t</option> are required for printing 220 files, and reports the <command>groff</command> command including those 221 options</para> 222 <indexterm zone="ch-system-groff grog"> 223 <primary sortas="b-grog">grog</primary> 224 </indexterm> 225 </listitem> 226 </varlistentry> 227 228 <varlistentry id="grolbp"> 229 <term><command>grolbp</command></term> 230 <listitem> 231 <para>Is a <command>groff</command> driver for Canon CAPSL printers 232 (LBP-4 and LBP-8 series laser printers)</para> 233 <indexterm zone="ch-system-groff grolbp"> 234 <primary sortas="b-grolbp">grolbp</primary> 235 </indexterm> 236 </listitem> 237 </varlistentry> 238 239 <varlistentry id="grolj4"> 240 <term><command>grolj4</command></term> 241 <listitem> 242 <para>Is a driver for <command>groff</command> that produces output 243 in PCL5 format suitable for an HP LaserJet 4 printer</para> 244 <indexterm zone="ch-system-groff grolj4"> 245 <primary sortas="b-grolj4">grolj4</primary> 246 </indexterm> 247 </listitem> 248 </varlistentry> 249 250 <varlistentry id="grops"> 251 <term><command>grops</command></term> 252 <listitem> 253 <para>Translates the output of GNU <command>troff</command> to 254 PostScript</para> 255 <indexterm zone="ch-system-groff grops"> 256 <primary sortas="b-grops">grops</primary> 257 </indexterm> 258 </listitem> 259 </varlistentry> 260 261 <varlistentry id="grotty"> 262 <term><command>grotty</command></term> 263 <listitem> 264 <para>Translates the output of GNU <command>troff</command> into 265 a form suitable for typewriter-like devices</para> 266 <indexterm zone="ch-system-groff grotty"> 267 <primary sortas="b-grotty">grotty</primary> 268 </indexterm> 269 </listitem> 270 </varlistentry> 271 272 <varlistentry id="gtbl"> 273 <term><command>gtbl</command></term> 274 <listitem> 275 <para>A link to <command>tbl</command></para> 276 <indexterm zone="ch-system-groff gtbl"> 277 <primary sortas="b-gtbl">gtbl</primary> 278 </indexterm> 279 </listitem> 280 </varlistentry> 281 282 <varlistentry id="hpftodit"> 283 <term><command>hpftodit</command></term> 284 <listitem> 285 <para>Creates a font file for use with <command>groff -Tlj4</command> 286 from an HP-tagged font metric file</para> 287 <indexterm zone="ch-system-groff hpftodit"> 288 <primary sortas="b-hpftodit">hpftodit</primary> 289 </indexterm> 290 </listitem> 291 </varlistentry> 292 293 <varlistentry id="indxbib"> 294 <term><command>indxbib</command></term> 295 <listitem> 296 <para>Creates an inverted index for the bibliographic databases with a 297 specified file for use with <command>refer</command>, 298 <command>lookbib</command>, and <command>lkbib</command></para> 299 <indexterm zone="ch-system-groff indxbib"> 300 <primary sortas="b-indxbib">indxbib</primary> 301 </indexterm> 302 </listitem> 303 </varlistentry> 304 305 <varlistentry id="lkbib"> 306 <term><command>lkbib</command></term> 307 <listitem> 308 <para>Searches bibliographic databases for references that contain 309 specified keys and reports any references found</para> 310 <indexterm zone="ch-system-groff lkbib"> 311 <primary sortas="b-lkbib">lkbib</primary> 312 </indexterm> 313 </listitem> 314 </varlistentry> 315 316 <varlistentry id="lookbib"> 317 <term><command>lookbib</command></term> 318 <listitem> 319 <para>Prints a prompt on the standard error (unless the standard input 320 is not a terminal), reads a line containing a set of keywords from the 321 standard input, searches the bibliographic databases in a specified file 322 for references containing those keywords, prints any references found 323 on the standard output, and repeats this process until the end of 324 input</para> 325 <indexterm zone="ch-system-groff lookbib"> 326 <primary sortas="b-lookbib">lookbib</primary> 327 </indexterm> 328 </listitem> 329 </varlistentry> 330 331 <varlistentry id="mmroff"> 332 <term><command>mmroff</command></term> 333 <listitem> 334 <para>A simple preprocessor for <command>groff</command></para> 335 <indexterm zone="ch-system-groff mmroff"> 336 <primary sortas="b-mmroff">mmroff</primary> 337 </indexterm> 338 </listitem> 339 </varlistentry> 340 341 <varlistentry id="neqn"> 342 <term><command>neqn</command></term> 343 <listitem> 344 <para>Formats equations for American Standard Code for Information 345 Interchange (ASCII) output</para> 346 <indexterm zone="ch-system-groff neqn"> 347 <primary sortas="b-neqn">neqn</primary> 348 </indexterm> 349 </listitem> 350 </varlistentry> 351 352 <varlistentry id="nroff"> 353 <term><command>nroff</command></term> 354 <listitem> 355 <para>A script that emulates the <command>nroff</command> command 356 using <command>groff</command></para> 357 <indexterm zone="ch-system-groff nroff"> 358 <primary sortas="b-nroff">nroff</primary> 359 </indexterm> 360 </listitem> 361 </varlistentry> 362 363 <varlistentry id="pfbtops"> 364 <term><command>pfbtops</command></term> 365 <listitem> 366 <para>Translates a PostScript font in <filename 367 class="extension">.pfb</filename> format to ASCII</para> 368 <indexterm zone="ch-system-groff pfbtops"> 369 <primary sortas="b-pfbtops">pfbtops</primary> 370 </indexterm> 371 </listitem> 372 </varlistentry> 373 374 <varlistentry id="pic"> 375 <term><command>pic</command></term> 376 <listitem> 377 <para>Compiles descriptions of pictures embedded within troff or 378 TeX input files into commands understood by TeX or 379 <command>troff</command></para> 380 <indexterm zone="ch-system-groff pic"> 381 <primary sortas="b-pic">pic</primary> 382 </indexterm> 383 </listitem> 384 </varlistentry> 385 386 <varlistentry id="pic2graph"> 387 <term><command>pic2graph</command></term> 388 <listitem> 389 <para>Converts a PIC diagram into a cropped image</para> 390 <indexterm zone="ch-system-groff pic2graph"> 391 <primary sortas="b-pic2graph">pic2graph</primary> 392 </indexterm> 393 </listitem> 394 </varlistentry> 395 396 <varlistentry id="post-grohtml"> 397 <term><command>post-grohtml</command></term> 398 <listitem> 399 <para>Translates the output of GNU <command>troff</command> to 400 HTML</para> 401 <indexterm zone="ch-system-groff post-grohtml"> 402 <primary sortas="b-post-grohtml">post-grohtml</primary> 403 </indexterm> 404 </listitem> 405 </varlistentry> 406 407 <varlistentry id="pre-grohtml"> 408 <term><command>pre-grohtml </command></term> 409 <listitem> 410 <para>Translates the output of GNU <command>troff</command> to 411 HTML</para> 412 <indexterm zone="ch-system-groff pre-grohtml"> 413 <primary sortas="b-pre-grohtml">pre-grohtml</primary> 414 </indexterm> 415 </listitem> 416 </varlistentry> 417 418 <varlistentry id="refer"> 419 <term><command>refer</command></term> 420 <listitem> 421 <para>Copies the contents of a file to the standard output, except 422 that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis> 423 are interpreted as citations, and lines between <emphasis>.R1</emphasis> 424 and <emphasis>.R2</emphasis> are interpreted as commands for how 425 citations are to be processed</para> 426 <indexterm zone="ch-system-groff refer"> 427 <primary sortas="b-refer">refer</primary> 428 </indexterm> 429 </listitem> 430 </varlistentry> 431 432 <varlistentry id="soelim"> 433 <term><command>soelim</command></term> 434 <listitem> 435 <para>Reads files and replaces lines of the form <emphasis>.so 436 file</emphasis> by the contents of the mentioned 437 <emphasis>file</emphasis></para> 438 <indexterm zone="ch-system-groff soelim"> 439 <primary sortas="b-soelim">soelim</primary> 440 </indexterm> 441 </listitem> 442 </varlistentry> 443 444 <varlistentry id="tbl"> 445 <term><command>tbl</command></term> 446 <listitem> 447 <para>Compiles descriptions of tables embedded within troff input 448 files into commands that are understood by 449 <command>troff</command></para> 450 <indexterm zone="ch-system-groff tbl"> 451 <primary sortas="b-tbl">tbl</primary> 452 </indexterm> 453 </listitem> 454 </varlistentry> 455 456 <varlistentry id="tfmtodit"> 457 <term><command>tfmtodit</command></term> 458 <listitem> 459 <para>Creates a font file for use with <command>groff 460 -Tdvi</command></para> 461 <indexterm zone="ch-system-groff tfmtodit"> 462 <primary sortas="b-tfmtodit">tfmtodit</primary> 463 </indexterm> 464 </listitem> 465 </varlistentry> 466 467 <varlistentry id="troff"> 468 <term><command>troff</command></term> 469 <listitem> 470 <para>Is highly compatible with Unix <command>troff</command>; it 471 should usually be invoked using the <command>groff</command> command, 472 which will also run preprocessors and post-processors in the 473 appropriate order and with the appropriate options</para> 474 <indexterm zone="ch-system-groff troff"> 475 <primary sortas="b-troff">troff</primary> 476 </indexterm> 477 </listitem> 478 </varlistentry> 479 480 <varlistentry id="zsoelim"> 481 <term><command>zsoelim</command></term> 482 <listitem> 483 <para>A link to <command>soelim</command></para> 484 <indexterm zone="ch-system-groff zsoelim"> 485 <primary sortas="b-zsoelim">zsoelim</primary> 486 </indexterm> 487 </listitem> 488 </varlistentry> 489 490 </variablelist> 491 492 </sect2> 393 493 394 494 </sect1> 395 -
chapter06/grub.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-grub" role="wrap"> 7 <title>GRUB-&grub-version;</title> 8 <?dbhtml filename="grub.html"?> 9 <?dbhtml filename="grub.html"?> 9 10 10 <indexterm zone="ch-system-grub"><primary sortas="a-Grub">GRUB</primary></indexterm>11 <title>GRUB-&grub-version;</title> 11 12 12 <sect2 role="package"><title/> 13 <para>The GRUB package contains the GRand Unified Bootloader.</para> 13 <indexterm zone="ch-system-grub"> 14 <primary sortas="a-Grub">GRUB</primary> 15 </indexterm> 14 16 15 <segmentedlist> 16 <segtitle>&buildtime;</segtitle> 17 <segtitle>&diskspace;</segtitle> 18 <seglistitem><seg>0.2 SBU</seg><seg>10.0 MB</seg></seglistitem> 19 </segmentedlist> 17 <sect2 role="package"> 18 <title/> 20 19 21 <segmentedlist> 22 <segtitle>&dependencies;</segtitle> 23 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, 24 GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem> 25 </segmentedlist> 26 </sect2> 20 <para>The GRUB package contains the GRand Unified Bootloader.</para> 27 21 28 <sect2 role="installation"> 29 <title>Installation of GRUB</title> 22 <segmentedlist> 23 <segtitle>&buildtime;</segtitle> 24 <segtitle>&diskspace;</segtitle> 30 25 31 <para>This package is known to have issues when its default 32 optimization flags (including the <parameter>-march</parameter> and 33 <parameter>-mcpu</parameter> options) are changed. If any environment 34 variables that override default optimizations have been defined, such 35 as <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar>, 36 unset them when building GRUB.</para> 26 <seglistitem> 27 <seg>0.2 SBU</seg> 28 <seg>10.0 MB</seg> 29 </seglistitem> 30 </segmentedlist> 37 31 38 <para>Prepare GRUB for compilation:</para> 32 <segmentedlist> 33 <segtitle>&dependencies;</segtitle> 34 35 <seglistitem> 36 <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, 37 Ncurses, and Sed</seg> 38 </seglistitem> 39 </segmentedlist> 40 41 </sect2> 42 43 <sect2 role="installation"> 44 <title>Installation of GRUB</title> 45 46 <para>This package is known to have issues when its default 47 optimization flags (including the <parameter>-march</parameter> and 48 <parameter>-mcpu</parameter> options) are changed. If any environment 49 variables that override default optimizations have been defined, such 50 as <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar>, 51 unset them when building GRUB.</para> 52 53 <para>Prepare GRUB for compilation:</para> 39 54 40 55 <screen><userinput>./configure --prefix=/usr</userinput></screen> 41 56 42 <para>Compile the package:</para>57 <para>Compile the package:</para> 43 58 44 59 <screen><userinput>make</userinput></screen> 45 60 46 <para>To test the results, issue:47 <userinput>make check</userinput>.</para>61 <para>To test the results, issue: 62 <userinput>make check</userinput>.</para> 48 63 49 <para>Install the package:</para>64 <para>Install the package:</para> 50 65 51 66 <screen><userinput>make install … … 53 68 cp -v /usr/lib/grub/i386-pc/stage{1,2} /boot/grub</userinput></screen> 54 69 55 <para>Replace <filename class="directory">i386-pc</filename> with whatever56 directory is appropriate for the hardware in use.</para>70 <para>Replace <filename class="directory">i386-pc</filename> with whatever 71 directory is appropriate for the hardware in use.</para> 57 72 58 <para>The <filename class="directory">i386-pc</filename> directory59 contains a number of <filename>*stage1_5</filename> files, different60 ones for different file systems. Review the files available and copy61 the appropriate ones to the <filename62 class="directory">/boot/grub</filename> directory. Most users will63 copy the <filename>e2fs_stage1_5</filename> and/or64 <filename>reiserfs_stage1_5</filename> files.</para>73 <para>The <filename class="directory">i386-pc</filename> directory 74 contains a number of <filename>*stage1_5</filename> files, different 75 ones for different file systems. Review the files available and copy 76 the appropriate ones to the <filename 77 class="directory">/boot/grub</filename> directory. Most users will 78 copy the <filename>e2fs_stage1_5</filename> and/or 79 <filename>reiserfs_stage1_5</filename> files.</para> 65 80 66 </sect2>81 </sect2> 67 82 83 <sect2 id="contents-gRUB" role="content"> 84 <title>Contents of GRUB</title> 68 85 69 <sect2 id="contents-gRUB" role="content"><title>Contents of GRUB</title> 86 <segmentedlist> 87 <segtitle>Installed programs</segtitle> 70 88 71 <segmentedlist> 72 <segtitle>Installed programs</segtitle> 73 <seglistitem><seg>grub, grub-install, 74 grub-md5-crypt, grub-terminfo, and mbchk</seg></seglistitem> 75 </segmentedlist> 89 <seglistitem> 90 <seg>grub, grub-install, grub-md5-crypt, grub-terminfo, and mbchk</seg> 91 </seglistitem> 92 </segmentedlist> 76 93 77 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 78 <?dbfo list-presentation="list"?> 79 <?dbhtml list-presentation="table"?> 94 <variablelist> 95 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 96 <?dbfo list-presentation="list"?> 97 <?dbhtml list-presentation="table"?> 80 98 81 <varlistentry id="grub"> 82 <term><command>grub</command></term> 83 <listitem> 84 <para>The Grand Unified Bootloader's command shell</para> 85 <indexterm zone="ch-system-grub grub"><primary sortas="b-grub">grub</primary></indexterm> 86 </listitem> 87 </varlistentry> 99 <varlistentry id="grub"> 100 <term><command>grub</command></term> 101 <listitem> 102 <para>The Grand Unified Bootloader's command shell</para> 103 <indexterm zone="ch-system-grub grub"> 104 <primary sortas="b-grub">grub</primary> 105 </indexterm> 106 </listitem> 107 </varlistentry> 88 108 89 <varlistentry id="grub-install"> 90 <term><command>grub-install</command></term> 91 <listitem> 92 <para>Installs GRUB on the given device</para> 93 <indexterm zone="ch-system-grub grub-install"><primary sortas="b-grub-install">grub-install</primary></indexterm> 94 </listitem> 95 </varlistentry> 109 <varlistentry id="grub-install"> 110 <term><command>grub-install</command></term> 111 <listitem> 112 <para>Installs GRUB on the given device</para> 113 <indexterm zone="ch-system-grub grub-install"> 114 <primary sortas="b-grub-install">grub-install</primary> 115 </indexterm> 116 </listitem> 117 </varlistentry> 96 118 97 <varlistentry id="grub-md5-crypt"> 98 <term><command>grub-md5-crypt</command></term> 99 <listitem> 100 <para>Encrypts a password in MD5 format</para> 101 <indexterm zone="ch-system-grub grub-md5-crypt"><primary sortas="b-grub-md5-crypt">grub-md5-crypt</primary></indexterm> 102 </listitem> 103 </varlistentry> 119 <varlistentry id="grub-md5-crypt"> 120 <term><command>grub-md5-crypt</command></term> 121 <listitem> 122 <para>Encrypts a password in MD5 format</para> 123 <indexterm zone="ch-system-grub grub-md5-crypt"> 124 <primary sortas="b-grub-md5-crypt">grub-md5-crypt</primary> 125 </indexterm> 126 </listitem> 127 </varlistentry> 104 128 105 <varlistentry id="grub-terminfo"> 106 <term><command>grub-terminfo</command></term> 107 <listitem> 108 <para>Generates a terminfo command from a terminfo name; it can be 109 employed if an unknown terminal is being used</para> 110 <indexterm zone="ch-system-grub grub-terminfo"><primary sortas="b-grub-terminfo">grub-terminfo</primary></indexterm> 111 </listitem> 112 </varlistentry> 129 <varlistentry id="grub-terminfo"> 130 <term><command>grub-terminfo</command></term> 131 <listitem> 132 <para>Generates a terminfo command from a terminfo name; it can be 133 employed if an unknown terminal is being used</para> 134 <indexterm zone="ch-system-grub grub-terminfo"> 135 <primary sortas="b-grub-terminfo">grub-terminfo</primary> 136 </indexterm> 137 </listitem> 138 </varlistentry> 113 139 114 <varlistentry id="mbchk"> 115 <term><command>mbchk</command></term> 116 <listitem> 117 <para>Checks the format of a multi-boot kernel</para> 118 <indexterm zone="ch-system-grub mbchk"><primary sortas="b-mbchk">mbchk</primary></indexterm> 119 </listitem> 120 </varlistentry> 121 </variablelist> 140 <varlistentry id="mbchk"> 141 <term><command>mbchk</command></term> 142 <listitem> 143 <para>Checks the format of a multi-boot kernel</para> 144 <indexterm zone="ch-system-grub mbchk"> 145 <primary sortas="b-mbchk">mbchk</primary> 146 </indexterm> 147 </listitem> 148 </varlistentry> 122 149 123 </sect2> 150 </variablelist> 151 152 </sect2> 124 153 125 154 </sect1> 126 -
chapter06/gzip.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-gzip" role="wrap"> 7 <title>Gzip-&gzip-version;</title> 8 <?dbhtml filename="gzip.html"?> 9 10 <indexterm zone="ch-system-gzip"><primary sortas="a-Gzip">Gzip</primary></indexterm> 11 12 <sect2 role="package"><title/> 13 <para>The Gzip package contains programs for compressing and decompressing 14 files.</para> 15 16 <segmentedlist> 17 <segtitle>&buildtime;</segtitle> 18 <segtitle>&diskspace;</segtitle> 19 <seglistitem><seg>0.1 SBU</seg><seg>2.2 MB</seg></seglistitem> 20 </segmentedlist> 21 22 <segmentedlist> 23 <segtitle>&dependencies;</segtitle> 24 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, 25 GCC, Glibc, Grep, Make, Patch, and Sed</seg></seglistitem> 26 </segmentedlist> 27 </sect2> 28 29 <sect2 role="installation"> 30 <title>Installation of Gzip</title> 31 32 <para>Gzip has 2 known security vulnerabilities. The following patch 33 addresses both of them:</para> 9 <?dbhtml filename="gzip.html"?> 10 11 <title>Gzip-&gzip-version;</title> 12 13 <indexterm zone="ch-system-gzip"> 14 <primary sortas="a-Gzip">Gzip</primary> 15 </indexterm> 16 17 <sect2 role="package"> 18 <title/> 19 20 <para>The Gzip package contains programs for compressing and decompressing 21 files.</para> 22 23 <segmentedlist> 24 <segtitle>&buildtime;</segtitle> 25 <segtitle>&diskspace;</segtitle> 26 27 <seglistitem> 28 <seg>0.1 SBU</seg> 29 <seg>2.2 MB</seg> 30 </seglistitem> 31 </segmentedlist> 32 33 <segmentedlist> 34 <segtitle>&dependencies;</segtitle> 35 36 <seglistitem> 37 <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, 38 Patch, and Sed</seg> 39 </seglistitem> 40 </segmentedlist> 41 42 </sect2> 43 44 <sect2 role="installation"> 45 <title>Installation of Gzip</title> 46 47 <para>Gzip has 2 known security vulnerabilities. The following patch 48 addresses both of them:</para> 34 49 35 50 <screen><userinput>patch -Np1 -i ../&gzip-security_fix-patch;</userinput></screen> 36 51 37 <para>Prepare Gzip for compilation:</para>52 <para>Prepare Gzip for compilation:</para> 38 53 39 54 <screen><userinput>./configure --prefix=/usr</userinput></screen> 40 55 41 <para>The <command>gzexe</command> script has the location of the42 <command>gzip</command> binary hard-wired into it. Because the43 location of the binary is changed later, the following command ensures44 that the new location gets placed into the script:</para>56 <para>The <command>gzexe</command> script has the location of the 57 <command>gzip</command> binary hard-wired into it. Because the 58 location of the binary is changed later, the following command ensures 59 that the new location gets placed into the script:</para> 45 60 46 61 <screen><userinput>sed -i 's@"BINDIR"@/bin@g' gzexe.in</userinput></screen> 47 62 48 <para>Compile the package:</para>63 <para>Compile the package:</para> 49 64 50 65 <screen><userinput>make</userinput></screen> 51 66 52 <para>This package does not come with a test suite.</para>53 54 <para>Install the package:</para>67 <para>This package does not come with a test suite.</para> 68 69 <para>Install the package:</para> 55 70 56 71 <screen><userinput>make install</userinput></screen> 57 72 58 <para>Move the <command>gzip</command> program to the <filename59 class="directory">/bin</filename> directory and create some commonly used60 symlinks to it:</para>73 <para>Move the <command>gzip</command> program to the <filename 74 class="directory">/bin</filename> directory and create some commonly used 75 symlinks to it:</para> 61 76 62 77 <screen><userinput>mv -v /usr/bin/gzip /bin … … 67 82 ln -sv gunzip /bin/uncompress</userinput></screen> 68 83 69 </sect2> 70 71 72 <sect2 id="contents-gzip" role="content"><title>Contents of Gzip</title> 73 74 <segmentedlist> 75 <segtitle>Installed programs</segtitle> 76 <seglistitem><seg>compress (link to gzip), gunzip (link to gzip), gzexe, 77 gzip, uncompress (link to gunzip), zcat (link to gzip), zcmp, zdiff, 78 zegrep, zfgrep, zforce, zgrep, zless, zmore, and znew</seg></seglistitem> 79 </segmentedlist> 80 81 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 82 <?dbfo list-presentation="list"?> 83 <?dbhtml list-presentation="table"?> 84 85 <varlistentry id="compress"> 86 <term><command>compress</command></term> 87 <listitem> 88 <para>Compresses and decompresses files</para> 89 <indexterm zone="ch-system-gzip compress"><primary sortas="b-compress">compress</primary></indexterm> 90 </listitem> 91 </varlistentry> 92 93 <varlistentry id="gunzip"> 94 <term><command>gunzip</command></term> 95 <listitem> 96 <para>Decompresses gzipped files</para> 97 <indexterm zone="ch-system-gzip gunzip"><primary sortas="b-gunzip">gunzip</primary></indexterm> 98 </listitem> 99 </varlistentry> 100 101 <varlistentry id="gzexe"> 102 <term><command>gzexe</command></term> 103 <listitem> 104 <para>Creates self-decompressing executable files</para> 105 <indexterm zone="ch-system-gzip gzexe"><primary sortas="b-gzexe">gzexe</primary></indexterm> 106 </listitem> 107 </varlistentry> 108 109 <varlistentry id="gzip"> 110 <term><command>gzip</command></term> 111 <listitem> 112 <para>Compresses the given files using Lempel-Ziv (LZ77) coding</para> 113 <indexterm zone="ch-system-gzip gzip"><primary sortas="b-gzip">gzip</primary></indexterm> 114 </listitem> 115 </varlistentry> 116 117 <varlistentry id="uncompress"> 118 <term><command>uncompress</command></term> 119 <listitem> 120 <para>Decompresses compressed files</para> 121 <indexterm zone="ch-system-gzip uncompress"><primary sortas="b-uncompress">uncompress</primary></indexterm> 122 </listitem> 123 </varlistentry> 124 125 <varlistentry id="zcat"> 126 <term><command>zcat</command></term> 127 <listitem> 128 <para>Decompresses the given gzipped files to standard output</para> 129 <indexterm zone="ch-system-gzip zcat"><primary sortas="b-zcat">zcat</primary></indexterm> 130 </listitem> 131 </varlistentry> 132 133 <varlistentry id="zcmp"> 134 <term><command>zcmp</command></term> 135 <listitem> 136 <para>Runs <command>cmp</command> on gzipped files</para> 137 <indexterm zone="ch-system-gzip zcmp"><primary sortas="b-zcmp">zcmp</primary></indexterm> 138 </listitem> 139 </varlistentry> 140 141 <varlistentry id="zdiff"> 142 <term><command>zdiff</command></term> 143 <listitem> 144 <para>Runs <command>diff</command> on gzipped files</para> 145 <indexterm zone="ch-system-gzip zdiff"><primary sortas="b-zdiff">zdiff</primary></indexterm> 146 </listitem> 147 </varlistentry> 148 149 <varlistentry id="zegrep"> 150 <term><command>zegrep</command></term> 151 <listitem> 152 <para>Runs <command>egrep</command> on gzipped files</para> 153 <indexterm zone="ch-system-gzip zegrep"><primary sortas="b-zegrep">zegrep</primary></indexterm> 154 </listitem> 155 </varlistentry> 156 157 <varlistentry id="zfgrep"> 158 <term><command>zfgrep</command></term> 159 <listitem> 160 <para>Runs <command>fgrep</command> on gzipped files</para> 161 <indexterm zone="ch-system-gzip zfgrep"><primary sortas="b-zfgrep">zfgrep</primary></indexterm> 162 </listitem> 163 </varlistentry> 164 165 <varlistentry id="zforce"> 166 <term><command>zforce</command></term> 167 <listitem> 168 <para>Forces a <filename class="extension">.gz</filename> extension on all given files 169 that are gzipped files, so that <command>gzip</command> will not compress them again; this can be 170 useful when file names were truncated during a file transfer</para> 171 <indexterm zone="ch-system-gzip zforce"><primary sortas="b-zforce">zforce</primary></indexterm> 172 </listitem> 173 </varlistentry> 174 175 <varlistentry id="zgrep"> 176 <term><command>zgrep</command></term> 177 <listitem> 178 <para>Runs <command>grep</command> on gzipped files</para> 179 <indexterm zone="ch-system-gzip zgrep"><primary sortas="b-zgrep">zgrep</primary></indexterm> 180 </listitem> 181 </varlistentry> 182 183 <varlistentry id="zless"> 184 <term><command>zless</command></term> 185 <listitem> 186 <para>Runs <command>less</command> on gzipped files</para> 187 <indexterm zone="ch-system-gzip zless"><primary sortas="b-zless">zless</primary></indexterm> 188 </listitem> 189 </varlistentry> 190 191 <varlistentry id="zmore"> 192 <term><command>zmore</command></term> 193 <listitem> 194 <para>Runs <command>more</command> on gzipped files</para> 195 <indexterm zone="ch-system-gzip zmore"><primary sortas="b-zmore">zmore</primary></indexterm> 196 </listitem> 197 </varlistentry> 198 199 <varlistentry id="znew"> 200 <term><command>znew</command></term> 201 <listitem> 202 <para>Re-compresses files from <command>compress</command> format to 203 <command>gzip</command> format—<filename class="extension">.Z</filename> 204 to <filename class="extension">.gz</filename></para> 205 <indexterm zone="ch-system-gzip znew"><primary sortas="b-znew">znew</primary></indexterm> 206 </listitem> 207 </varlistentry> 208 </variablelist> 209 210 </sect2> 84 </sect2> 85 86 <sect2 id="contents-gzip" role="content"> 87 <title>Contents of Gzip</title> 88 89 <segmentedlist> 90 <segtitle>Installed programs</segtitle> 91 92 <seglistitem> 93 <seg>compress (link to gzip), gunzip (link to gzip), gzexe, gzip, 94 uncompress (link to gunzip), zcat (link to gzip), zcmp, zdiff, 95 zegrep, zfgrep, zforce, zgrep, zless, zmore, and znew</seg> 96 </seglistitem> 97 </segmentedlist> 98 99 <variablelist> 100 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 101 <?dbfo list-presentation="list"?> 102 <?dbhtml list-presentation="table"?> 103 104 <varlistentry id="compress"> 105 <term><command>compress</command></term> 106 <listitem> 107 <para>Compresses and decompresses files</para> 108 <indexterm zone="ch-system-gzip compress"> 109 <primary sortas="b-compress">compress</primary> 110 </indexterm> 111 </listitem> 112 </varlistentry> 113 114 <varlistentry id="gunzip"> 115 <term><command>gunzip</command></term> 116 <listitem> 117 <para>Decompresses gzipped files</para> 118 <indexterm zone="ch-system-gzip gunzip"> 119 <primary sortas="b-gunzip">gunzip</primary> 120 </indexterm> 121 </listitem> 122 </varlistentry> 123 124 <varlistentry id="gzexe"> 125 <term><command>gzexe</command></term> 126 <listitem> 127 <para>Creates self-decompressing executable files</para> 128 <indexterm zone="ch-system-gzip gzexe"> 129 <primary sortas="b-gzexe">gzexe</primary> 130 </indexterm> 131 </listitem> 132 </varlistentry> 133 134 <varlistentry id="gzip"> 135 <term><command>gzip</command></term> 136 <listitem> 137 <para>Compresses the given files using Lempel-Ziv (LZ77) coding</para> 138 <indexterm zone="ch-system-gzip gzip"> 139 <primary sortas="b-gzip">gzip</primary> 140 </indexterm> 141 </listitem> 142 </varlistentry> 143 144 <varlistentry id="uncompress"> 145 <term><command>uncompress</command></term> 146 <listitem> 147 <para>Decompresses compressed files</para> 148 <indexterm zone="ch-system-gzip uncompress"> 149 <primary sortas="b-uncompress">uncompress</primary> 150 </indexterm> 151 </listitem> 152 </varlistentry> 153 154 <varlistentry id="zcat"> 155 <term><command>zcat</command></term> 156 <listitem> 157 <para>Decompresses the given gzipped files to standard output</para> 158 <indexterm zone="ch-system-gzip zcat"> 159 <primary sortas="b-zcat">zcat</primary> 160 </indexterm> 161 </listitem> 162 </varlistentry> 163 164 <varlistentry id="zcmp"> 165 <term><command>zcmp</command></term> 166 <listitem> 167 <para>Runs <command>cmp</command> on gzipped files</para> 168 <indexterm zone="ch-system-gzip zcmp"> 169 <primary sortas="b-zcmp">zcmp</primary> 170 </indexterm> 171 </listitem> 172 </varlistentry> 173 174 <varlistentry id="zdiff"> 175 <term><command>zdiff</command></term> 176 <listitem> 177 <para>Runs <command>diff</command> on gzipped files</para> 178 <indexterm zone="ch-system-gzip zdiff"> 179 <primary sortas="b-zdiff">zdiff</primary> 180 </indexterm> 181 </listitem> 182 </varlistentry> 183 184 <varlistentry id="zegrep"> 185 <term><command>zegrep</command></term> 186 <listitem> 187 <para>Runs <command>egrep</command> on gzipped files</para> 188 <indexterm zone="ch-system-gzip zegrep"> 189 <primary sortas="b-zegrep">zegrep</primary> 190 </indexterm> 191 </listitem> 192 </varlistentry> 193 194 <varlistentry id="zfgrep"> 195 <term><command>zfgrep</command></term> 196 <listitem> 197 <para>Runs <command>fgrep</command> on gzipped files</para> 198 <indexterm zone="ch-system-gzip zfgrep"> 199 <primary sortas="b-zfgrep">zfgrep</primary> 200 </indexterm> 201 </listitem> 202 </varlistentry> 203 204 <varlistentry id="zforce"> 205 <term><command>zforce</command></term> 206 <listitem> 207 <para>Forces a <filename class="extension">.gz</filename> extension on 208 all given files that are gzipped files, so that <command>gzip</command> 209 will not compress them again; this can be useful when file names were 210 truncated during a file transfer</para> 211 <indexterm zone="ch-system-gzip zforce"> 212 <primary sortas="b-zforce">zforce</primary> 213 </indexterm> 214 </listitem> 215 </varlistentry> 216 217 <varlistentry id="zgrep"> 218 <term><command>zgrep</command></term> 219 <listitem> 220 <para>Runs <command>grep</command> on gzipped files</para> 221 <indexterm zone="ch-system-gzip zgrep"> 222 <primary sortas="b-zgrep">zgrep</primary> 223 </indexterm> 224 </listitem> 225 </varlistentry> 226 227 <varlistentry id="zless"> 228 <term><command>zless</command></term> 229 <listitem> 230 <para>Runs <command>less</command> on gzipped files</para> 231 <indexterm zone="ch-system-gzip zless"> 232 <primary sortas="b-zless">zless</primary> 233 </indexterm> 234 </listitem> 235 </varlistentry> 236 237 <varlistentry id="zmore"> 238 <term><command>zmore</command></term> 239 <listitem> 240 <para>Runs <command>more</command> on gzipped files</para> 241 <indexterm zone="ch-system-gzip zmore"> 242 <primary sortas="b-zmore">zmore</primary> 243 </indexterm> 244 </listitem> 245 </varlistentry> 246 247 <varlistentry id="znew"> 248 <term><command>znew</command></term> 249 <listitem> 250 <para>Re-compresses files from <command>compress</command> format to 251 <command>gzip</command> format—<filename 252 class="extension">.Z</filename> to <filename 253 class="extension">.gz</filename></para> 254 <indexterm zone="ch-system-gzip znew"> 255 <primary sortas="b-znew">znew</primary> 256 </indexterm> 257 </listitem> 258 </varlistentry> 259 260 </variablelist> 261 262 </sect2> 211 263 212 264 </sect1> 213 -
chapter06/hotplug.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 6 <sect1 id="ch-system-hotplug" xreflabel="Hotplug" role="wrap"> 7 <title>Hotplug-&hotplug-version;</title> 8 <?dbhtml filename="hotplug.html"?> 9 10 <indexterm zone="ch-system-hotplug"><primary sortas="a-Hotplug">Hotplug</primary></indexterm> 11 12 <sect2 role="package"><title/> 13 <para>The Hotplug package contains scripts that react upon hotplug events 14 generated by the kernel. Such events correspond to every change in the kernel 15 state visible in the <systemitem class="filesystem">sysfs</systemitem> 16 filesystem, e.g., the addition and removal of hardware. This package also 17 detects existing hardware during boot and inserts the relevant modules into the 18 running kernel.</para> 19 20 <segmentedlist> 21 <segtitle>&buildtime;</segtitle> 22 <segtitle>&diskspace;</segtitle> 23 <seglistitem><seg>0.01 SBU</seg><seg>460 KB</seg></seglistitem> 24 </segmentedlist> 25 26 <segmentedlist> 27 <segtitle>&dependencies;</segtitle> 28 <seglistitem><seg>Bash, Coreutils, Findutils, Gawk, and Make</seg></seglistitem> 29 </segmentedlist> 30 </sect2> 31 32 <sect2 role="installation"> 33 <title>Installation of Hotplug</title> 34 35 <para>This package does not come with a test suite.</para> 36 37 <para>Install the Hotplug package:</para> 7 8 <sect1 id="ch-system-hotplug" role="wrap"> 9 <?dbhtml filename="hotplug.html"?> 10 11 <title>Hotplug-&hotplug-version;</title> 12 13 <indexterm zone="ch-system-hotplug"> 14 <primary sortas="a-Hotplug">Hotplug</primary> 15 </indexterm> 16 17 <sect2 role="package"> 18 <title/> 19 20 <para>The Hotplug package contains scripts that react upon hotplug events 21 generated by the kernel. Such events correspond to every change in the kernel 22 state visible in the <systemitem class="filesystem">sysfs</systemitem> 23 filesystem, e.g., the addition and removal of hardware. This package also 24 detects existing hardware during boot and inserts the relevant modules into the 25 running kernel.</para> 26 27 <segmentedlist> 28 <segtitle>&buildtime;</segtitle> 29 <segtitle>&diskspace;</segtitle> 30 31 <seglistitem> 32 <seg>0.01 SBU</seg> 33 <seg>460 KB</seg> 34 </seglistitem> 35 </segmentedlist> 36 37 <segmentedlist> 38 <segtitle>&dependencies;</segtitle> 39 40 <seglistitem> 41 <seg>Bash, Coreutils, Findutils, Gawk, and Make</seg> 42 </seglistitem> 43 </segmentedlist> 44 45 </sect2> 46 47 <sect2 role="installation"> 48 <title>Installation of Hotplug</title> 49 50 <para>This package does not come with a test suite.</para> 51 52 <para>Install the Hotplug package:</para> 38 53 39 54 <screen><userinput>make install</userinput></screen> 40 55 41 <para>Copy a file that the <quote>install</quote> target omits.</para>56 <para>Copy a file that the <quote>install</quote> target omits.</para> 42 57 43 58 <screen><userinput>cp -v etc/hotplug/pnp.distmap /etc/hotplug</userinput></screen> 44 59 45 <para>Remove the init script that Hotplug installs since we are going to be46 using the script included in the LFS-Bootscripts package:</para>60 <para>Remove the init script that Hotplug installs since we are going to be 61 using the script included in the LFS-Bootscripts package:</para> 47 62 48 63 <screen><userinput>rm -rfv /etc/init.d</userinput></screen> 49 64 50 <para>Network device hotplugging is not yet supported by the LFS-Bootscripts51 package. For that reason, remove the network hotplug agent:</para>65 <para>Network device hotplugging is not yet supported by the LFS-Bootscripts 66 package. For that reason, remove the network hotplug agent:</para> 52 67 53 68 <screen><userinput>rm -fv /etc/hotplug/net.agent</userinput></screen> 54 69 55 <para>Create a directory for storing firmware that can be loaded by56 <command>hotplug</command>:</para>70 <para>Create a directory for storing firmware that can be loaded by 71 <command>hotplug</command>:</para> 57 72 58 73 <screen><userinput>mkdir -v /lib/firmware</userinput></screen> 59 74 60 </sect2> 61 62 63 <sect2 id="contents-hotplug" role="content"><title>Contents of Hotplug</title> 64 65 <segmentedlist> 66 <segtitle>Installed program</segtitle> 67 <segtitle>Installed scripts</segtitle> 68 <segtitle>Installed files</segtitle> 69 <seglistitem><seg>hotplug</seg> 70 <seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg> 71 <seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, /etc/hotplug/{pci,usb}, 72 /etc/hotplug/usb.usermap, /etc/hotplug.d, and /var/log/hotplug/events</seg></seglistitem> 73 </segmentedlist> 74 75 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 76 <?dbfo list-presentation="list"?> 77 <?dbhtml list-presentation="table"?> 78 79 <varlistentry id="hotplug"> 80 <term><command>hotplug</command></term> 81 <listitem> 82 <para>This script is called by default by the Linux kernel when something 83 changes in its internal state (e.g., a new device is added or an existing device 84 is removed)</para> 85 <indexterm zone="ch-system-hotplug hotplug"><primary 86 sortas="b-hotplug">hotplug</primary></indexterm> 87 </listitem> 88 </varlistentry> 89 90 <varlistentry id="hotplug-rc"> 91 <term><command>/etc/hotplug/*.rc</command></term> 92 <listitem> 93 <para>These scripts are used for cold plugging, i.e., detecting and acting upon 94 hardware already present during system startup. They are called by the 95 <filename>hotplug</filename> initscript included in the LFS-Bootscripts package. 96 The <command>*.rc</command> scripts try to recover hotplug events that were lost 97 during system boot because, for example, the root filesystem was not mounted by 98 the kernel</para> 99 <indexterm zone="ch-system-hotplug hotplug-rc"><primary 100 sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary></indexterm> 101 </listitem> 102 </varlistentry> 103 104 <varlistentry id="hotplug-agent"> 105 <term><command>/etc/hotplug/*.agent</command></term> 106 <listitem> 107 <para>These scripts are called by <command>hotplug</command> 108 in response to different types of hotplug events generated by the kernel. 109 Their action is to insert corresponding kernel modules and call any 110 user-provided scripts</para> 111 <indexterm zone="ch-system-hotplug hotplug-agent"><primary 112 sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary></indexterm> 113 </listitem> 114 </varlistentry> 115 116 <varlistentry id="hotplug-blacklist"> 117 <term><filename>/etc/hotplug/blacklist</filename></term> 118 <listitem> 119 <para>This file contains the list of modules that should never be inserted into 120 the kernel by the Hotplug scripts</para> 121 <indexterm zone="ch-system-hotplug hotplug-blacklist"><primary 122 sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary></indexterm> 123 </listitem> 124 </varlistentry> 125 126 <varlistentry id="hotplug-functions"> 127 <term><filename>/etc/hotplug/hotplug.functions</filename></term> 128 <listitem> 129 <para>This file contains common functions used by other scripts in the Hotplug 130 package</para> 131 <indexterm zone="ch-system-hotplug hotplug-functions"><primary 132 sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary></indexterm> 133 </listitem> 134 </varlistentry> 135 136 <varlistentry id="hotplug-subdirs"> 137 <term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term> 138 <listitem> 139 <para>These directories contain user-written handlers for hotplug events</para> 140 <indexterm zone="ch-system-hotplug hotplug-subdirs"><primary 141 sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary></indexterm> 142 </listitem> 143 </varlistentry> 144 145 <varlistentry id="hotplug-usb.usermap"> 146 <term><filename>/etc/hotplug/usb.usermap</filename></term> 147 <listitem> 148 <para>This file contains rules that determine which user-defined handlers to 149 call for each USB device, based on its vendor ID and other attributes</para> 150 <indexterm zone="ch-system-hotplug hotplug-usb.usermap"><primary 151 sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary></indexterm> 152 </listitem> 153 </varlistentry> 154 155 <varlistentry id="hotplug-hotplug.d"> 156 <term><filename class="directory">/etc/hotplug.d</filename></term> 157 <listitem> 158 <para>This directory contains programs (or symlinks to them) that are interested 159 in receiving hotplug events. For example, Udev puts its symlink here during 160 installation</para> 161 <indexterm zone="ch-system-hotplug hotplug-hotplug.d"><primary 162 sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary></indexterm> 163 </listitem> 164 </varlistentry> 165 166 <varlistentry id="hotplug-firmware"> 167 <term><filename class="directory">/lib/firmware</filename></term> 168 <listitem> 169 <para>This directory contains the firmware for devices that need to have their 170 firmware loaded before use</para> 171 <indexterm zone="ch-system-hotplug hotplug-firmware"><primary 172 sortas="e-/lib/firmware">/lib/firmware</primary></indexterm> 173 </listitem> 174 </varlistentry> 175 176 <varlistentry id="hotplug-events"> 177 <term><filename>/var/log/hotplug/events</filename></term> 178 <listitem> 179 <para>This file contains all the events that <command>hotplug</command> has 180 called since bootup</para> 181 <indexterm zone="ch-system-hotplug hotplug-events"><primary 182 sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary></indexterm> 183 </listitem> 184 </varlistentry> 185 186 </variablelist> 187 </sect2> 75 </sect2> 76 77 78 <sect2 id="contents-hotplug" role="content"> 79 <title>Contents of Hotplug</title> 80 81 <segmentedlist> 82 <segtitle>Installed program</segtitle> 83 <segtitle>Installed scripts</segtitle> 84 <segtitle>Installed files</segtitle> 85 86 <seglistitem> 87 <seg>hotplug</seg> 88 <seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg> 89 <seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, 90 /etc/hotplug/{pci,usb}, /etc/hotplug/usb.usermap, /etc/hotplug.d, 91 and /var/log/hotplug/events</seg> 92 </seglistitem> 93 </segmentedlist> 94 95 <variablelist> 96 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 97 <?dbfo list-presentation="list"?> 98 <?dbhtml list-presentation="table"?> 99 100 <varlistentry id="hotplug"> 101 <term><command>hotplug</command></term> 102 <listitem> 103 <para>This script is called by default by the Linux kernel when 104 something changes in its internal state (e.g., a new device is 105 added or an existing device is removed)</para> 106 <indexterm zone="ch-system-hotplug hotplug"> 107 <primary sortas="b-hotplug">hotplug</primary> 108 </indexterm> 109 </listitem> 110 </varlistentry> 111 112 <varlistentry id="hotplug-rc"> 113 <term><command>/etc/hotplug/*.rc</command></term> 114 <listitem> 115 <para>These scripts are used for cold plugging, i.e., detecting and 116 acting upon hardware already present during system startup. They are 117 called by the <filename>hotplug</filename> initscript included in 118 the LFS-Bootscripts package. The <command>*.rc</command> scripts try 119 to recover hotplug events that were lost during system boot because, 120 for example, the root filesystem was not mounted by the kernel</para> 121 <indexterm zone="ch-system-hotplug hotplug-rc"> 122 <primary sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary> 123 </indexterm> 124 </listitem> 125 </varlistentry> 126 127 <varlistentry id="hotplug-agent"> 128 <term><command>/etc/hotplug/*.agent</command></term> 129 <listitem> 130 <para>These scripts are called by <command>hotplug</command> in response 131 to different types of hotplug events generated by the kernel. Their 132 action is to insert corresponding kernel modules and call any 133 user-provided scripts</para> 134 <indexterm zone="ch-system-hotplug hotplug-agent"> 135 <primary sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary> 136 </indexterm> 137 </listitem> 138 </varlistentry> 139 140 <varlistentry id="hotplug-blacklist"> 141 <term><filename>/etc/hotplug/blacklist</filename></term> 142 <listitem> 143 <para>This file contains the list of modules that should never be 144 inserted into the kernel by the Hotplug scripts</para> 145 <indexterm zone="ch-system-hotplug hotplug-blacklist"> 146 <primary sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary> 147 </indexterm> 148 </listitem> 149 </varlistentry> 150 151 <varlistentry id="hotplug-functions"> 152 <term><filename>/etc/hotplug/hotplug.functions</filename></term> 153 <listitem> 154 <para>This file contains common functions used by other scripts in the 155 Hotplug package</para> 156 <indexterm zone="ch-system-hotplug hotplug-functions"> 157 <primary sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary> 158 </indexterm> 159 </listitem> 160 </varlistentry> 161 162 <varlistentry id="hotplug-subdirs"> 163 <term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term> 164 <listitem> 165 <para>These directories contain user-written handlers for hotplug 166 events</para> 167 <indexterm zone="ch-system-hotplug hotplug-subdirs"> 168 <primary sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary> 169 </indexterm> 170 </listitem> 171 </varlistentry> 172 173 <varlistentry id="hotplug-usb.usermap"> 174 <term><filename>/etc/hotplug/usb.usermap</filename></term> 175 <listitem> 176 <para>This file contains rules that determine which user-defined handlers to 177 call for each USB device, based on its vendor ID and other 178 attributes</para> 179 <indexterm zone="ch-system-hotplug hotplug-usb.usermap"> 180 <primary sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary> 181 </indexterm> 182 </listitem> 183 </varlistentry> 184 185 <varlistentry id="hotplug-hotplug.d"> 186 <term><filename class="directory">/etc/hotplug.d</filename></term> 187 <listitem> 188 <para>This directory contains programs (or symlinks to them) that are 189 interested in receiving hotplug events. For example, Udev puts its 190 symlink here during installation</para> 191 <indexterm zone="ch-system-hotplug hotplug-hotplug.d"> 192 <primary sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary> 193 </indexterm> 194 </listitem> 195 </varlistentry> 196 197 <varlistentry id="hotplug-firmware"> 198 <term><filename class="directory">/lib/firmware</filename></term> 199 <listitem> 200 <para>This directory contains the firmware for devices that need to 201 have their firmware loaded before use</para> 202 <indexterm zone="ch-system-hotplug hotplug-firmware"> 203 <primary sortas="e-/lib/firmware">/lib/firmware</primary> 204 </indexterm> 205 </listitem> 206 </varlistentry> 207 208 <varlistentry id="hotplug-events"> 209 <term><filename>/var/log/hotplug/events</filename></term> 210 <listitem> 211 <para>This file contains all the events that <command>hotplug</command> 212 has called since bootup</para> 213 <indexterm zone="ch-system-hotplug hotplug-events"> 214 <primary sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary> 215 </indexterm> 216 </listitem> 217 </varlistentry> 218 219 </variablelist> 220 221 </sect2> 222 188 223 </sect1> -
chapter06/iana-etc.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-iana-etc" role="wrap"> 7 <title>Iana-Etc-&iana-etc-version;</title> 8 <?dbhtml filename="iana-etc.html"?> 9 <?dbhtml filename="iana-etc.html"?> 9 10 10 <indexterm zone="ch-system-iana-etc"><primary sortas="a-Iana-Etc">Iana-Etc</primary></indexterm>11 <title>Iana-Etc-&iana-etc-version;</title> 11 12 12 <sect2 role="package"><title/> 13 <para>The Iana-Etc package provides data for network services and protocols.</para> 13 <indexterm zone="ch-system-iana-etc"> 14 <primary sortas="a-Iana-Etc">Iana-Etc</primary> 15 </indexterm> 14 16 15 <segmentedlist> 16 <segtitle>&buildtime;</segtitle> 17 <segtitle>&diskspace;</segtitle> 18 <seglistitem><seg>0.1 SBU</seg><seg>2.0 MB</seg></seglistitem> 19 </segmentedlist> 17 <sect2 role="package"> 18 <title/> 20 19 21 <segmentedlist> 22 <segtitle>&dependencies;</segtitle> 23 <seglistitem><seg>Coreutils, Gawk, and Make</seg></seglistitem> 24 </segmentedlist> 25 </sect2> 20 <para>The Iana-Etc package provides data for network services and 21 protocols.</para> 26 22 27 <sect2 role="installation"> 28 <title>Installation of Iana-Etc</title> 23 <segmentedlist> 24 <segtitle>&buildtime;</segtitle> 25 <segtitle>&diskspace;</segtitle> 29 26 30 <para>The following command converts the raw data provided by IANA into the 31 correct formats for the <filename>/etc/protocols</filename> and 32 <filename>/etc/services</filename> data files:</para> 27 <seglistitem> 28 <seg>0.1 SBU</seg> 29 <seg>2.0 MB</seg> 30 </seglistitem> 31 </segmentedlist> 32 33 <segmentedlist> 34 <segtitle>&dependencies;</segtitle> 35 36 <seglistitem> 37 <seg>Coreutils, Gawk, and Make</seg> 38 </seglistitem> 39 </segmentedlist> 40 41 </sect2> 42 43 <sect2 role="installation"> 44 <title>Installation of Iana-Etc</title> 45 46 <para>The following command converts the raw data provided by IANA into the 47 correct formats for the <filename>/etc/protocols</filename> and 48 <filename>/etc/services</filename> data files:</para> 33 49 34 50 <screen><userinput>make</userinput></screen> 35 51 36 <para>This package does not come with a test suite.</para>52 <para>This package does not come with a test suite.</para> 37 53 38 <para>Install the package:</para>54 <para>Install the package:</para> 39 55 40 56 <screen><userinput>make install</userinput></screen> 41 57 42 </sect2>58 </sect2> 43 59 60 <sect2 id="contents-iana-etc" role="content"> 61 <title>Contents of Iana-Etc</title> 44 62 45 <sect2 id="contents-iana-etc" role="content"><title>Contents of Iana-Etc</title> 63 <segmentedlist> 64 <segtitle>Installed files</segtitle> 46 65 47 <segmentedlist>48 <segtitle>Installed files</segtitle>49 <seglistitem><seg>/etc/protocols and /etc/services</seg></seglistitem>50 </segmentedlist>66 <seglistitem> 67 <seg>/etc/protocols and /etc/services</seg> 68 </seglistitem> 69 </segmentedlist> 51 70 52 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 53 <?dbfo list-presentation="list"?> 54 <?dbhtml list-presentation="table"?> 71 <variablelist> 72 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 73 <?dbfo list-presentation="list"?> 74 <?dbhtml list-presentation="table"?> 55 75 56 <varlistentry id="protocols"> 57 <term><filename>/etc/protocols</filename></term> 58 <listitem> 59 <para>Describes the various DARPA Internet protocols that are 60 available from the TCP/IP subsystem</para> 61 <indexterm zone="ch-system-iana-etc"><primary sortas="e-/etc/protocols">/etc/protocols</primary></indexterm> 62 </listitem> 63 </varlistentry> 76 <varlistentry id="protocols"> 77 <term><filename>/etc/protocols</filename></term> 78 <listitem> 79 <para>Describes the various DARPA Internet protocols that are 80 available from the TCP/IP subsystem</para> 81 <indexterm zone="ch-system-iana-etc"> 82 <primary sortas="e-/etc/protocols">/etc/protocols</primary> 83 </indexterm> 84 </listitem> 85 </varlistentry> 64 86 65 <varlistentry id="services"> 66 <term><filename>/etc/services</filename></term> 67 <listitem> 68 <para>Provides a mapping between friendly textual names for internet 69 services, and their underlying assigned port numbers and protocol 70 types</para> 71 <indexterm zone="ch-system-iana-etc"><primary sortas="e-/etc/services">/etc/services</primary></indexterm> 72 </listitem> 73 </varlistentry> 74 </variablelist> 87 <varlistentry id="services"> 88 <term><filename>/etc/services</filename></term> 89 <listitem> 90 <para>Provides a mapping between friendly textual names for internet 91 services, and their underlying assigned port numbers and protocol 92 types</para> 93 <indexterm zone="ch-system-iana-etc"> 94 <primary sortas="e-/etc/services">/etc/services</primary> 95 </indexterm> 96 </listitem> 97 </varlistentry> 75 98 76 </sect2> 99 </variablelist> 100 101 </sect2> 77 102 78 103 </sect1> 79 -
chapter06/inetutils.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-inetutils" role="wrap"> 7 <title>Inetutils-&inetutils-version;</title> 8 <?dbhtml filename="inetutils.html"?> 9 10 <indexterm zone="ch-system-inetutils"><primary sortas="a-Inetutils">Inetutils</primary></indexterm> 11 12 <sect2 role="package"><title/> 13 <para>The Inetutils package contains programs for basic networking.</para> 14 15 <segmentedlist> 16 <segtitle>&buildtime;</segtitle> 17 <segtitle>&diskspace;</segtitle> 18 <seglistitem><seg>0.2 SBU</seg><seg>8.7 MB</seg></seglistitem> 19 </segmentedlist> 20 21 <segmentedlist> 22 <segtitle>&dependencies;</segtitle> 23 <seglistitem><seg>Bash, Binutils, Coreutils, 24 Diffutils, GCC, Glibc, Grep, Make, Ncurses, Patch, and Sed</seg></seglistitem> 25 </segmentedlist> 26 </sect2> 27 28 <sect2 role="installation"> 29 <title>Installation of Inetutils</title> 30 31 <para>Apply a patch to Inetutils to enable it to compile with GCC-&gcc-version;:</para> 9 <?dbhtml filename="inetutils.html"?> 10 11 <title>Inetutils-&inetutils-version;</title> 12 13 <indexterm zone="ch-system-inetutils"> 14 <primary sortas="a-Inetutils">Inetutils</primary> 15 </indexterm> 16 17 <sect2 role="package"> 18 <title/> 19 20 <para>The Inetutils package contains programs for basic networking.</para> 21 22 <segmentedlist> 23 <segtitle>&buildtime;</segtitle> 24 <segtitle>&diskspace;</segtitle> 25 26 <seglistitem> 27 <seg>0.2 SBU</seg> 28 <seg>8.7 MB</seg> 29 </seglistitem> 30 </segmentedlist> 31 32 <segmentedlist> 33 <segtitle>&dependencies;</segtitle> 34 35 <seglistitem> 36 <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, 37 Ncurses, Patch, and Sed</seg> 38 </seglistitem> 39 </segmentedlist> 40 41 </sect2> 42 43 <sect2 role="installation"> 44 <title>Installation of Inetutils</title> 45 46 <para>Apply a patch to Inetutils to enable it to compile with 47 GCC-&gcc-version;:</para> 32 48 33 49 <screen><userinput>patch -Np1 -i ../&inetutils-gcc4_fixes-patch;</userinput></screen> 34 50 35 <para>All programs that come with Inetutils will not be installed.36 However, the Inetutils build system will insist on installing all the37 man pages anyway. The following patch will correct this38 situation:</para>51 <para>All programs that come with Inetutils will not be installed. 52 However, the Inetutils build system will insist on installing all the 53 man pages anyway. The following patch will correct this 54 situation:</para> 39 55 40 56 <screen><userinput>patch -Np1 -i ../&inetutils-man_pages-patch;</userinput></screen> … … 47 63 --disable-whois --disable-servers</userinput></screen> 48 64 49 <para>The meaning of the configure options:</para> 50 51 <variablelist> 52 <varlistentry> 53 <term><parameter>--disable-logger</parameter></term> 54 <listitem><para>This option 55 prevents Inetutils from installing the <command>logger</command> program, which is used by 56 scripts to pass messages to the System Log Daemon. Do not install it 57 because Util-linux installs a better version later.</para></listitem> 58 </varlistentry> 59 60 <varlistentry> 61 <term><parameter>--disable-syslogd</parameter></term> 62 <listitem><para>This option 63 prevents Inetutils from installing the System Log Daemon, which is 64 installed with the Sysklogd package.</para></listitem> 65 </varlistentry> 66 67 <varlistentry> 68 <term><parameter>--disable-whois</parameter></term> 69 <listitem><para>This option disables 70 the building of the Inetutils <command>whois</command> client, which is out of date. 71 Instructions for a better <command>whois</command> client are in the BLFS book.</para></listitem> 72 </varlistentry> 73 74 <varlistentry> 75 <term><parameter>--disable-servers</parameter></term> 76 <listitem><para>This disables the installation of the various network 77 servers included as part of the Inetutils package. These servers are 78 deemed not appropriate in a basic LFS system. Some are insecure by 79 nature and are only considered safe on trusted networks. More 80 information can be found at <ulink 81 url="&blfs-root;view/svn/basicnet/inetutils.html"/>. Note that 82 better replacements are available for many of these 83 servers.</para></listitem> 84 </varlistentry> 85 </variablelist> 86 87 <para>Compile the package:</para> 65 <variablelist> 66 <title>The meaning of the configure options:</title> 67 68 <varlistentry> 69 <term><parameter>--disable-logger</parameter></term> 70 <listitem> 71 <para>This option prevents Inetutils from installing the 72 <command>logger</command> program, which is used by scripts to 73 pass messages to the System Log Daemon. Do not install it because 74 Util-linux installs a better version later.</para> 75 </listitem> 76 </varlistentry> 77 78 <varlistentry> 79 <term><parameter>--disable-syslogd</parameter></term> 80 <listitem> 81 <para>This option prevents Inetutils from installing the System Log 82 Daemon, which is installed with the Sysklogd package.</para> 83 </listitem> 84 </varlistentry> 85 86 <varlistentry> 87 <term><parameter>--disable-whois</parameter></term> 88 <listitem> 89 <para>This option disables the building of the Inetutils 90 <command>whois</command> client, which is out of date. Instructions for 91 a better <command>whois</command> client are in the BLFS book.</para> 92 </listitem> 93 </varlistentry> 94 95 <varlistentry> 96 <term><parameter>--disable-servers</parameter></term> 97 <listitem> 98 <para>This disables the installation of the various network servers 99 included as part of the Inetutils package. These servers are deemed not 100 appropriate in a basic LFS system. Some are insecure by nature and are 101 only considered safe on trusted networks. More information can be found 102 at <ulink url="&blfs-root;view/svn/basicnet/inetutils.html"/>. Note that 103 better replacements are available for many of these servers.</para> 104 </listitem> 105 </varlistentry> 106 107 </variablelist> 108 109 <para>Compile the package:</para> 88 110 89 111 <screen><userinput>make</userinput></screen> 90 112 91 <para>This package does not come with a test suite.</para>92 93 <para>Install the package:</para>113 <para>This package does not come with a test suite.</para> 114 115 <para>Install the package:</para> 94 116 95 117 <screen><userinput>make install</userinput></screen> 96 118 97 <para>Move the <command>ping</command> program to its FHS-compliant98 place:</para>119 <para>Move the <command>ping</command> program to its FHS-compliant 120 place:</para> 99 121 100 122 <screen><userinput>mv -v /usr/bin/ping /bin</userinput></screen> 101 123 102 </sect2> 103 104 105 <sect2 id="contents-inetutils" role="content"><title>Contents of Inetutils</title> 106 107 <segmentedlist> 108 <segtitle>Installed programs</segtitle> 109 <seglistitem><seg>ftp, ping, rcp, rlogin, rsh, talk, telnet, and tftp</seg></seglistitem> 110 </segmentedlist> 111 112 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 113 <?dbfo list-presentation="list"?> 114 <?dbhtml list-presentation="table"?> 115 116 <varlistentry id="ftp"> 117 <term><command>ftp</command></term> 118 <listitem> 119 <para>Is the file transfer protocol program</para> 120 <indexterm zone="ch-system-inetutils ftp"><primary sortas="b-ftp">ftp</primary></indexterm> 121 </listitem> 122 </varlistentry> 123 124 <varlistentry id="ping"> 125 <term><command>ping</command></term> 126 <listitem> 127 <para>Sends echo-request packets and reports how long the replies take</para> 128 <indexterm zone="ch-system-inetutils ping"><primary sortas="b-ping">ping</primary></indexterm> 129 </listitem> 130 </varlistentry> 131 132 <varlistentry id="rcp"> 133 <term><command>rcp</command></term> 134 <listitem> 135 <para>Performs remote file copy</para> 136 <indexterm zone="ch-system-inetutils rcp"><primary sortas="b-rcp">rcp</primary></indexterm> 137 </listitem> 138 </varlistentry> 139 140 <varlistentry id="rlogin"> 141 <term><command>rlogin</command></term> 142 <listitem> 143 <para>Performs remote login</para> 144 <indexterm zone="ch-system-inetutils rlogin"><primary sortas="b-rlogin">rlogin</primary></indexterm> 145 </listitem> 146 </varlistentry> 147 148 <varlistentry id="rsh"> 149 <term><command>rsh</command></term> 150 <listitem> 151 <para>Runs a remote shell</para> 152 <indexterm zone="ch-system-inetutils rsh"><primary sortas="b-rsh">rsh</primary></indexterm> 153 </listitem> 154 </varlistentry> 155 156 <varlistentry id="talk"> 157 <term><command>talk</command></term> 158 <listitem> 159 <para>Is used to chat with another user</para> 160 <indexterm zone="ch-system-inetutils talk"><primary sortas="b-talk">talk</primary></indexterm> 161 </listitem> 162 </varlistentry> 163 164 <varlistentry id="telnet"> 165 <term><command>telnet</command></term> 166 <listitem> 167 <para>An interface to the TELNET protocol</para> 168 <indexterm zone="ch-system-inetutils telnet"><primary sortas="b-telnet">telnet</primary></indexterm> 169 </listitem> 170 </varlistentry> 171 172 <varlistentry id="tftp"> 173 <term><command>tftp</command></term> 174 <listitem> 175 <para>A trivial file transfer program</para> 176 <indexterm zone="ch-system-inetutils tftp"><primary sortas="b-tftp">tftp</primary></indexterm> 177 </listitem> 178 </varlistentry> 179 </variablelist> 180 181 </sect2> 124 </sect2> 125 126 <sect2 id="contents-inetutils" role="content"> 127 <title>Contents of Inetutils</title> 128 129 <segmentedlist> 130 <segtitle>Installed programs</segtitle> 131 132 <seglistitem> 133 <seg>ftp, ping, rcp, rlogin, rsh, talk, telnet, and tftp</seg> 134 </seglistitem> 135 </segmentedlist> 136 137 <variablelist> 138 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 139 <?dbfo list-presentation="list"?> 140 <?dbhtml list-presentation="table"?> 141 142 <varlistentry id="ftp"> 143 <term><command>ftp</command></term> 144 <listitem> 145 <para>Is the file transfer protocol program</para> 146 <indexterm zone="ch-system-inetutils ftp"> 147 <primary sortas="b-ftp">ftp</primary> 148 </indexterm> 149 </listitem> 150 </varlistentry> 151 152 <varlistentry id="ping"> 153 <term><command>ping</command></term> 154 <listitem> 155 <para>Sends echo-request packets and reports how long the replies 156 take</para> 157 <indexterm zone="ch-system-inetutils ping"> 158 <primary sortas="b-ping">ping</primary> 159 </indexterm> 160 </listitem> 161 </varlistentry> 162 163 <varlistentry id="rcp"> 164 <term><command>rcp</command></term> 165 <listitem> 166 <para>Performs remote file copy</para> 167 <indexterm zone="ch-system-inetutils rcp"> 168 <primary sortas="b-rcp">rcp</primary> 169 </indexterm> 170 </listitem> 171 </varlistentry> 172 173 <varlistentry id="rlogin"> 174 <term><command>rlogin</command></term> 175 <listitem> 176 <para>Performs remote login</para> 177 <indexterm zone="ch-system-inetutils rlogin"> 178 <primary sortas="b-rlogin">rlogin</primary> 179 </indexterm> 180 </listitem> 181 </varlistentry> 182 183 <varlistentry id="rsh"> 184 <term><command>rsh</command></term> 185 <listitem> 186 <para>Runs a remote shell</para> 187 <indexterm zone="ch-system-inetutils rsh"> 188 <primary sortas="b-rsh">rsh</primary> 189 </indexterm> 190 </listitem> 191 </varlistentry> 192 193 <varlistentry id="talk"> 194 <term><command>talk</command></term> 195 <listitem> 196 <para>Is used to chat with another user</para> 197 <indexterm zone="ch-system-inetutils talk"> 198 <primary sortas="b-talk">talk</primary> 199 </indexterm> 200 </listitem> 201 </varlistentry> 202 203 <varlistentry id="telnet"> 204 <term><command>telnet</command></term> 205 <listitem> 206 <para>An interface to the TELNET protocol</para> 207 <indexterm zone="ch-system-inetutils telnet"> 208 <primary sortas="b-telnet">telnet</primary> 209 </indexterm> 210 </listitem> 211 </varlistentry> 212 213 <varlistentry id="tftp"> 214 <term><command>tftp</command></term> 215 <listitem> 216 <para>A trivial file transfer program</para> 217 <indexterm zone="ch-system-inetutils tftp"> 218 <primary sortas="b-tftp">tftp</primary> 219 </indexterm> 220 </listitem> 221 </varlistentry> 222 223 </variablelist> 224 225 </sect2> 182 226 183 227 </sect1> 184 -
chapter06/introduction.xml
r3a0a57c r9506f85 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="ch-system-introduction"> 7 <title>Introduction</title> 8 <?dbhtml filename="introduction.html"?> 9 <?dbhtml filename="introduction.html"?> 9 10 10 <para>In this chapter, we enter the building site and start 11 constructing the LFS system in earnest. That is, we chroot into the 12 temporary mini Linux system, make a few final preparations, and then 13 begin installing the packages.</para> 11 <title>Introduction</title> 14 12 15 <para>The installation of this software is straightforward. Although 16 in many cases the installation instructions could be made shorter and 17 more generic, we have opted to provide the full instructions for every 18 package to minimize the possibilities for mistakes. The key to 19 learning what makes a Linux system work is to know what each package 20 is used for and why the user (or the system) needs it. For every 21 installed package, a summary of its contents is given, followed by 22 concise descriptions of each program and library the package 23 installed.</para> 13 <para>In this chapter, we enter the building site and start constructing the 14 LFS system in earnest. That is, we chroot into the temporary mini Linux system, 15 make a few final preparations, and then begin installing the packages.</para> 24 16 25 <para>If using the compiler optimizations provided in this chapter, 26 please review the optimization hint at <ulink 27 url="&hints-root;optimization.txt"/>. Compiler optimizations can make 28 a program run slightly faster, but they may also cause compilation 29 difficulties and problems when running the program. If a package 30 refuses to compile when using optimization, try to compile it without 31 optimization and see if that fixes the problem. Even if the package 32 does compile when using optimization, there is the risk it may have 33 been compiled incorrectly because of the complex interactions between 34 the code and build tools. Also note that the <option>-march</option> 35 and <option>-mtune</option> options may cause problems with the 36 toolchain packages (Binutils, GCC and Glibc). The small potential 37 gains achieved in using compiler optimizations are often outweighed by 38 the risks. First-time builders of LFS are encouraged to build without 39 custom optimizations. The subsequent system will still run very fast 40 and be stable at the same time.</para> 17 <para>The installation of this software is straightforward. Although in many 18 cases the installation instructions could be made shorter and more generic, 19 we have opted to provide the full instructions for every package to minimize 20 the possibilities for mistakes. The key to learning what makes a Linux system 21 work is to know what each package is used for and why the user (or the system) 22 needs it. For every installed package, a summary of its contents is given, 23 followed by concise descriptions of each program and library the package 24 installed.</para> 41 25 42 <para>The order that packages are installed in this chapter needs to 43 be strictly followed to ensure that no program accidentally acquires a 44 path referring to <filename class="directory">/tools</filename> 45 hard-wired into it. For the same reason, do not compile packages in 46 parallel. Compiling in parallel may save time (especially on dual-CPU 47 machines), but it could result in a program containing a hard-wired 48 path to <filename class="directory">/tools</filename>, which will 49 cause the program to stop working when that directory is 50 removed.</para> 26 <para>If using the compiler optimizations provided in this chapter, please 27 review the optimization hint at <ulink url="&hints-root;optimization.txt"/>. 28 Compiler optimizations can make a program run slightly faster, but they may 29 also cause compilation difficulties and problems when running the program. 30 If a package refuses to compile when using optimization, try to compile it 31 without optimization and see if that fixes the problem. Even if the package 32 does compile when using optimization, there is the risk it may have been 33 compiled incorrectly because of the complex interactions between the code 34 and build tools. Also note that the <option>-march</option> and 35 <option>-mtune</option> options may cause problems with the toolchain packages 36 (Binutils, GCC and Glibc). The small potential gains achieved in using 37 compiler optimizations are often outweighed by the risks. First-time builders 38 of LFS are encouraged to build without custom optimizations. The subsequent 39 system will still run very fast and be stable at the same time.</para> 51 40 52 <para>Before the installation instructions, each installation page53 provides information about the package, including a concise 54 description of what it contains, approximately how long it will take 55 to build, how much disk space is required during this building 56 process, and any other packages needed to successfully build the 57 package. Following the installation instructions, there is a list of 58 programs and libraries (along with brief descriptions of these) that 59 the package installs.</para>41 <para>The order that packages are installed in this chapter needs to be 42 strictly followed to ensure that no program accidentally acquires a path 43 referring to <filename class="directory">/tools</filename> hard-wired into 44 it. For the same reason, do not compile packages in parallel. Compiling in 45 parallel may save time (especially on dual-CPU machines), but it could result 46 in a program containing a hard-wired path to <filename 47 class="directory">/tools</filename>, which will cause the program to stop 48 working when that directory is removed.</para> 60 49 61 <note><para>At this point, you may wish to keep your finished temporary 62 tools for use in future LFS builds by creating a tarball of the 63 <filename class="directory">/tools</filename> directory and 64 storing it in a safe location.</para></note> 50 <para>Before the installation instructions, each installation page provides 51 information about the package, including a concise description of what it 52 contains, approximately how long it will take to build, how much disk space 53 is required during this building process, and any other packages needed to 54 successfully build the package. Following the installation instructions, 55 there is a list of programs and libraries (along with brief descriptions of 56 these) that the package installs.</para> 57 58 <note> 59 <para>At this point, you may wish to keep your finished temporary 60 tools for use in future LFS builds by creating a tarball of the 61 <filename class="directory">/tools</filename> directory and 62 storing it in a safe location.</para> 63 </note> 65 64 66 65 </sect1> 67
Note:
See TracChangeset
for help on using the changeset viewer.