diff options
51 files changed, 4226 insertions, 1409 deletions
diff --git a/chapter06/autoconf.xml b/chapter06/autoconf.xml index 7e6cc0151..dd7c5e233 100644 --- a/chapter06/autoconf.xml +++ b/chapter06/autoconf.xml @@ -47,58 +47,91 @@ M4, Make, Perl, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-autoconf"><title>Contents of Autoconf</title> +<sect2 id="contents-autoconf" role="content"><title>Contents of Autoconf</title> -<para><emphasis>Installed programs</emphasis>: autoconf, autoheader, autom4te, -autoreconf, autoscan, autoupdate and ifnames</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>autoconf, autoheader, autom4te, +autoreconf, autoscan, autoupdate and ifnames</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="autoconf"><command>autoconf</command></term> +<listitem> <indexterm zone="ch-system-autoconf autoconf"><primary sortas="b-autoconf">autoconf</primary></indexterm> -<para id="autoconf"><command>autoconf</command> is a tool for producing shell scripts +<para>is a tool for producing shell scripts that automatically configure software source code packages to adapt to many kinds of Unix-like systems. The configuration scripts it produces are independent -- running them does not require the autoconf program.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="autoheader"><command>autoheader</command> </term> +<listitem> <indexterm zone="ch-system-autoconf autoheader"><primary sortas="b-autoheader">autoheader</primary></indexterm> -<para id="autoheader"><command>autoheader</command> is a tool for creating template files +<para>is a tool for creating template files of C #define statements for configure to use.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="autom4te"><command>autom4te</command></term> +<listitem> <indexterm zone="ch-system-autoconf autom4te"><primary sortas="b-autom4te">autom4te</primary></indexterm> -<para id="autom4te"><command>autom4te</command> is a wrapper for the M4 macro -processor.</para> +<para>is a wrapper for the M4 macro processor.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="autoreconf"><command>autoreconf</command></term> +<listitem> <indexterm zone="ch-system-autoconf autoreconf"><primary sortas="b-autoreconf">autoreconf</primary></indexterm> -<para id="autoreconf"><command>autoreconf</command> comes in handy when there are a lot +<para>comes in handy when there are a lot of autoconf-generated configure scripts around. The program runs autoconf and autoheader repeatedly (where appropriate) to remake the autoconf configure scripts and configuration header templates in a given directory tree.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="autoscan"><command>autoscan</command> </term> +<listitem> <indexterm zone="ch-system-autoconf autoscan"><primary sortas="b-autoscan">autoscan</primary></indexterm> -<para id="autoscan"><command>autoscan</command> can help to create a +<para>can help to create a <filename>configure.in</filename> file for a software package. It examines the source files in a directory tree, searching them for common portability problems and creates a <filename>configure.scan</filename> file that serves as as a preliminary <filename>configure.in</filename> for the package.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="autoupdate"><command>autoupdate</command></term> +<listitem> <indexterm zone="ch-system-autoconf autoupdate"><primary sortas="b-autoupdate">autoupdate</primary></indexterm> -<para id="autoupdate"><command>autoupdate</command> modifies a -<filename>configure.in</filename> file that still calls autoconf macros -by their old names to use the current macro names.</para> - +<para>modifies a <filename>configure.in</filename> file that still calls autoconf +macros by their old names to use the current macro names.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="ifnames"><command>ifnames</command> </term> +<listitem> <indexterm zone="ch-system-autoconf ifnames"><primary sortas="b-ifnames">ifnames</primary></indexterm> -<para id="ifnames"><command>ifnames</command> can be helpful when writing a +<para>can be helpful when writing a <filename>configure.in</filename> for a software package. It prints the identifiers that the package uses in C preprocessor conditionals. If a package has already been set up to have some portability, this program can help to determine what <command>configure</command> needs to check. It can fill in some gaps in a <filename>configure.in</filename> file generated by autoscan.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/automake.xml b/chapter06/automake.xml index 606e3f742..fce2c31a3 100644 --- a/chapter06/automake.xml +++ b/chapter06/automake.xml @@ -47,81 +47,148 @@ Diffutils, Grep, M4, Make, Perl, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-automake"><title>Contents of Automake</title> +<sect2 id="contents-automake" role="content"><title>Contents of Automake</title> -<para><emphasis>Installed programs</emphasis>: acinstall, aclocal, -aclocal-1.8, automake, automake-1.8, compile, config.guess, config.sub, -depcomp, elisp-comp, install-sh, mdate-sh, missing, mkinstalldirs, py-compile, -symlink-tree, ylwrap</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>acinstall, aclocal, aclocal-1.8, automake, automake-1.8, +compile, config.guess, config.sub, depcomp, elisp-comp, install-sh, mdate-sh, +missing, mkinstalldirs, py-compile, symlink-tree, ylwrap</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="acinstall"><command>acinstall</command></term> +<listitem> <indexterm zone="ch-system-automake acinstall"><primary sortas="b-acinstall">acinstall</primary></indexterm> -<para id="acinstall"><command>acinstall</command> is a script that installs -aclocal-style M4 files.</para> +<para>is a script that installs aclocal-style M4 files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="aclocal"><command>aclocal</command></term> +<listitem> <indexterm zone="ch-system-automake aclocal"><primary sortas="b-aclocal">aclocal</primary></indexterm> -<para id="aclocal"><command>aclocal</command> generates <filename>aclocal.m4</filename> +<para>generates <filename>aclocal.m4</filename> files based on the contents of <filename>configure.in</filename> files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="automake"><command>automake</command></term> +<listitem> <indexterm zone="ch-system-automake automake"><primary sortas="b-automake">automake</primary></indexterm> -<para id="automake"><command>automake</command> is a tool for automatically generating +<para>is a tool for automatically generating <filename>Makefile.in</filename>'s from files called <filename>Makefile.am</filename>. To create all the <filename>Makefile.in</filename> files for a package, run this program in the top-level directory. By scanning the <filename>configure.in</filename>s it automatically finds each appropriate <filename>Makefile.am</filename> and generate the corresponding <filename>Makefile.in</filename>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="compile"><command>compile</command></term> +<listitem> <indexterm zone="ch-system-automake compile"><primary sortas="b-compile">compile</primary></indexterm> -<para id="compile"><command>compile</command> is a wrapper for compilers.</para> +<para>is a wrapper for compilers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="config.guess"><command>config.guess</command> </term> +<listitem> <indexterm zone="ch-system-automake config.guess"><primary sortas="b-config.guess">config.guess</primary></indexterm> -<para id="config.guess"><command>config.guess</command> is a script that attempts to guess +<para>is a script that attempts to guess the canonical triplet for the given build, host, or target architecture.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="config.su"><command>config.sub</command></term> +<listitem> <indexterm zone="ch-system-automake config.su"><primary sortas="b-config.su">config.su</primary></indexterm> -<para id="config.su"><command>config.sub</command> is a configuration validation -subroutine script.</para> +<para>is a configuration validation subroutine script.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="depcomp"><command>depcomp</command></term> +<listitem> <indexterm zone="ch-system-automake depcomp"><primary sortas="b-depcomp">depcomp</primary></indexterm> -<para id="depcomp"><command>depcomp</command> is a script for compiling a program -so that not only the desired output is generated, but also dependency -information.</para> - +<para>is a script for compiling a program so that not only the desired output is +generated, but also dependency information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="elisp-comp"><command>elisp-comp</command></term> +<listitem> <indexterm zone="ch-system-automake elisp-comp"><primary sortas="b-elisp-comp">elisp-comp</primary></indexterm> -<para id="elisp-comp"><command>elisp-comp</command> byte-compiles Emacs Lisp code.</para> +<para>byte-compiles Emacs Lisp code.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="install-sh"><command>install-sh</command></term> +<listitem> <indexterm zone="ch-system-automake install-sh"><primary sortas="b-install-sh">install-sh</primary></indexterm> -<para id="install-sh"><command>install-sh</command> is a script that installs a program, -a script, or a datafile.</para> +<para>is a script that installs a program, a script, or a datafile.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mdate-sh"><command>mdate-sh</command></term> +<listitem> <indexterm zone="ch-system-automake mdate-sh"><primary sortas="b-mdate-sh">mdate-sh</primary></indexterm> -<para id="mdate-sh"><command>mdate-sh</command> is a script that prints the modification -time of a file or directory.</para> +<para>is a script that prints the modification time of a file or directory.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="missing"><command>missing</command></term> +<listitem> <indexterm zone="ch-system-automake missing"><primary sortas="b-missing">missing</primary></indexterm> -<para id="missing"><command>missing</command> is a script acting as a common stub for +<para>is a script acting as a common stub for missing GNU programs during an installation.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkinstalldirs"><command>mkinstalldirs</command></term> +<listitem> <indexterm zone="ch-system-automake mkinstalldirs"><primary sortas="b-mkinstalldirs">mkinstalldirs</primary></indexterm> -<para id="mkinstalldirs"><command>mkinstalldirs</command> is a script that creates a directory -tree.</para> +<para>is a script that creates a directory tree.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="py-compile"><command>py-compile</command></term> +<listitem> <indexterm zone="ch-system-automake py-compile"><primary sortas="b-py-compile">py-compile</primary></indexterm> -<para id="py-compile"><command>py-compile</command> compiles a Python program.</para> +<para>compiles a Python program.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="symlink-tree"><command>symlink-tree</command></term> +<listitem> <indexterm zone="ch-system-automake symlink-tree"><primary sortas="b-symlink-tree">symlink-tree</primary></indexterm> -<para id="symlink-tree"><command>symlink-tree</command> is a script to create a symlink tree of -a directory tree.</para> +<para>is a script to create a symlink tree of a directory tree.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ylwrap"><command>ylwrap</command></term> +<listitem> <indexterm zone="ch-system-automake ylwrap"><primary sortas="b-ylwrap">ylwrap</primary></indexterm> -<para id="ylwrap"><command>ylwrap</command> is a wrapper for lex and yacc.</para> +<para>is a wrapper for lex and yacc.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/bash.xml b/chapter06/bash.xml index 7050853ff..8d2745902 100644 --- a/chapter06/bash.xml +++ b/chapter06/bash.xml @@ -63,32 +63,45 @@ available.</para> </sect2> -<sect2 id="contents-bash"><title>Contents of Bash</title> - -<para><emphasis>Installed programs</emphasis>: bash, sh (link to bash) and -bashbug</para> - -</sect2> +<sect2 id="contents-bash" role="content"><title>Contents of Bash</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>bash, sh (link to bash) and bashbug</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="bash"><command>bash</command></term> +<listitem> <indexterm zone="ch-system-bash bash"><primary sortas="b-bash">bash</primary></indexterm> -<para id="bash"><command>bash</command> is a widely-used command interpreter. It +<para>is a widely-used command interpreter. It performs many kinds of expansions and substitutions on a given command line before executing it, thus making this interpreter a powerful tool.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bashbug"><command>bashbug</command></term> +<listitem> <indexterm zone="ch-system-bash bashbug"><primary sortas="b-bashbug">bashbug</primary></indexterm> -<para id="bashbug"><command>bashbug</command> is a shell script to help the user +<para>is a shell script to help the user compose and mail bug reports concerning bash in a standard format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sh"><command>sh</command></term> +<listitem> <indexterm zone="ch-system-bash sh"><primary sortas="b-sh">sh</primary></indexterm> -<para id="sh"><command>sh</command> is a symlink to the bash program. When invoked +<para>is a symlink to the bash program. When invoked as sh, bash tries to mimic the startup behavior of historical versions of sh as closely as possible, while conforming to the POSIX standard as well.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/binutils.xml b/chapter06/binutils.xml index d0eb862a6..cee1136c7 100644 --- a/chapter06/binutils.xml +++ b/chapter06/binutils.xml @@ -95,96 +95,173 @@ some packages:</para> </sect2> -<sect2 id="contents-binutils"><title>Contents of Binutils</title> - -<para><emphasis>Installed programs</emphasis>: addr2line, ar, as, c++filt, -gprof, ld, nm, objcopy, objdump, ranlib, readelf, size, strings and -strip</para> - -<para><emphasis>Installed libraries</emphasis>: libiberty.a, libbfd.[a,so] and -libopcodes.[a,so]</para> - -</sect2> +<sect2 id="contents-binutils" role="content"><title>Contents of Binutils</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>addr2line, ar, as, c++filt, gprof, ld, nm, objcopy, objdump, +ranlib, readelf, size, strings and strip</seg> +<seg>libiberty.a, libbfd.[a,so] and libopcodes.[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="addr2line"><command>addr2line</command></term> +<listitem> <indexterm zone="ch-system-binutils addr2line"><primary sortas="b-addr2line">addr2line</primary></indexterm> -<para id="addr2line"><command>addr2line</command> translates program addresses to file +<para>translates program addresses to file names and line numbers. Given an address and the name of an executable, it uses the debugging information in the executable to figure out which source file and line number are associated with the address.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ar"><command>ar</command></term> +<listitem> <indexterm zone="ch-system-binutils ar"><primary sortas="b-ar">ar</primary></indexterm> -<para id="ar"><command>ar</command> creates, modifies, and extracts from archives. An archive +<para>creates, modifies, and extracts from archives. An archive is a single file holding a collection of other files in a structure that makes it possible to retrieve the original individual files (called members of the archive).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="as"><command>as</command></term> +<listitem> <indexterm zone="ch-system-binutils as"><primary sortas="b-as">as</primary></indexterm> -<para id="as"><command>as</command> is an assembler. It assembles the output of -gcc into object files.</para> +<para>is an assembler. It assembles the output of gcc into object files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="c-filt"><command>c++filt</command></term> +<listitem> <indexterm zone="ch-system-binutils c-filt"><primary sortas="b-c++filt">c++filt</primary></indexterm> -<para id="c-filt"><command>c++filt</command> is used by the linker to de-mangle C++ and +<para>is used by the linker to de-mangle C++ and Java symbols, to keep overloaded functions from clashing.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gprof"><command>gprof</command></term> +<listitem> <indexterm zone="ch-system-binutils gprof"><primary sortas="b-gprof">gprof</primary></indexterm> -<para id="gprof"><command>gprof</command> displays call graph profile data.</para> +<para>displays call graph profile data.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ld"><command>ld</command></term> +<listitem> <indexterm zone="ch-system-binutils ld"><primary sortas="b-ld">ld</primary></indexterm> -<para id="ld"><command>ld</command> is a linker. It combines a number of object -and archive files into a single file, relocating their data and tying up symbol -references.</para> - +<para>is a linker. It combines a number of object and archive files into a single file, +relocating their data and tying up symbol references.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nm"><command>nm</command></term> +<listitem> <indexterm zone="ch-system-binutils nm"><primary sortas="b-nm">nm</primary></indexterm> -<para id="nm"><command>nm</command> lists the symbols occurring in a given object file.</para> +<para>lists the symbols occurring in a given object file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="objcopy"><command>objcopy</command></term> +<listitem> <indexterm zone="ch-system-binutils objcopy"><primary sortas="b-objcopy">objcopy</primary></indexterm> -<para id="objcopy"><command>objcopy</command> is used to translate one type of object -file into another.</para> +<para>is used to translate one type of object file into another.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="objdump"><command>objdump</command></term> +<listitem> <indexterm zone="ch-system-binutils objdump"><primary sortas="b-objdump">objdump</primary></indexterm> -<para id="objdump"><command>objdump</command> displays information about the given -object file, with options controlling what particular information to display. -The information shown is mostly only useful to programmers who are working on -the compilation tools.</para> - +<para>displays information about the given object file, with options controlling what +particular information to display. The information shown is mostly only useful to +programmers who are working on the compilation tools.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="ranlib"><command>ranlib</command></term> +<listitem> <indexterm zone="ch-system-binutils ranlib"><primary sortas="b-ranlib">ranlib</primary></indexterm> -<para id="ranlib"><command>ranlib</command> generates an index of the contents of an +<para>generates an index of the contents of an archive, and stores it in the archive. The index lists all the symbols defined by archive members that are relocatable object files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="readelf"><command>readelf</command></term> +<listitem> <indexterm zone="ch-system-binutils readelf"><primary sortas="b-readelf">readelf</primary></indexterm> -<para id="readelf"><command>readelf</command> displays information about elf type binaries.</para> +<para>displays information about elf type binaries.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="size"><command>size</command></term> +<listitem> <indexterm zone="ch-system-binutils size"><primary sortas="b-size">size</primary></indexterm> -<para id="size"><command>size</command> lists the section sizes -- and the grand -total -- for the given object files.</para> +<para>lists the section sizes -- and the grand total -- for the given object files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="strings"><command>strings</command></term> +<listitem> <indexterm zone="ch-system-binutils strings"><primary sortas="b-strings">strings</primary></indexterm> -<para id="strings"><command>strings</command> outputs, for each given file, the sequences +<para>outputs, for each given file, the sequences of printable characters that are of at least the specified length (defaulting to 4). For object files it prints, by default, only the strings from the initializing and loading sections. For other types of files it scans the whole file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="strip"><command>strip</command></term> +<listitem> <indexterm zone="ch-system-binutils strip"><primary sortas="b-strip">strip</primary></indexterm> -<para id="strip"><command>strip</command> discards symbols from object files.</para> +<para>discards symbols from object files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libiberty"><command>libiberty</command></term> +<listitem> <indexterm zone="ch-system-binutils libiberty"><primary sortas="c-libiberty">libiberty</primary></indexterm> -<para id="libiberty"><command>libiberty</command> contains routines used by various GNU +<para>contains routines used by various GNU programs, including getopt, obstack, strerror, strtol and strtoul.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libbfd"><command>libbfd</command></term> +<listitem> <indexterm zone="ch-system-binutils libbfd"><primary sortas="c-libbfd">libbfd</primary></indexterm> -<para id="libbfd"><command>libbfd</command> is the Binary File Descriptor library.</para> +<para>is the Binary File Descriptor library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libopcodes"><command>libopcodes</command></term> +<listitem> <indexterm zone="ch-system-binutils libopcodes"><primary sortas="c-libopcodes">libopcodes</primary></indexterm> -<para id="libopcodes"><command>libopcodes</command> is a library for dealing with opcodes. +<para>is a library for dealing with opcodes. It is used for building utilities like objdump. Opcodes are the <quote>readable text</quote> versions of instructions for the processor.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/bison.xml b/chapter06/bison.xml index 562fcacf6..1d062e0b1 100644 --- a/chapter06/bison.xml +++ b/chapter06/bison.xml @@ -46,33 +46,46 @@ GCC, Gettext, Glibc, Grep, M4, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-bison"><title>Contents of Bison</title> - -<para><emphasis>Installed programs</emphasis>: bison and yacc</para> - -<para><emphasis>Installed library</emphasis>: liby.a</para> - -</sect2> +<sect2 id="contents-bison" role="content"><title>Contents of Bison</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed library</segtitle> +<seglistitem><seg>bison and yacc</seg><seg>liby.a</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="bison"><command>bison</command></term> +<listitem> <indexterm zone="ch-system-bison bison"><primary sortas="b-bison">bison</primary></indexterm> -<para id="bison"><command>bison</command> generates, from a series of rules, a program +<para>generates, from a series of rules, a program for analyzing the structure of text files. Bison is a replacement for yacc (Yet Another Compiler Compiler).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="yacc"><command>yacc</command></term> +<listitem> <indexterm zone="ch-system-bison yacc"><primary sortas="b-yacc">yacc</primary></indexterm> -<para id="yacc"><command>yacc</command> is a wrapper for bison, meant for programs +<para>is a wrapper for bison, meant for programs that still call yacc instead of bison. It calls bison with the -y option.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="liby.a"><command>liby.a</command></term> +<listitem> <indexterm zone="ch-system-bison liby.a"><primary sortas="c-liby.a">liby.a</primary></indexterm> -<para id="liby.a"><command>liby.a</command> is the Yacc library containing +<para>is the Yacc library containing implementations of Yacc-compatible yyerror and main functions. This library is normally not very useful, but POSIX requires it.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/bzip2.xml b/chapter06/bzip2.xml index 742f63bff..eb8270053 100644 --- a/chapter06/bzip2.xml +++ b/chapter06/bzip2.xml @@ -67,57 +67,104 @@ ln -s bzip2 /bin/bzcat</userinput></screen> </sect2> -<sect2 id="contents-bzip2"><title>Contents of Bzip2</title> +<sect2 id="contents-bzip2" role="content"><title>Contents of Bzip2</title> -<para><emphasis>Installed programs</emphasis>: bunzip2 (link to bzip2), bzcat -(link to bzip2), bzcmp, bzdiff, bzegrep, bzfgrep, bzgrep, bzip2, bzip2recover, -bzless and bzmore</para> - -<para><emphasis>Installed libraries</emphasis>: libbz2.a, libbz2.so (link to -libbz2.so.1.0), libbz2.so.1.0 (link to libbz2.so.&bzip2-version;) and -libbz2.so.&bzip2-version;</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp, bzdiff, +bzegrep, bzfgrep, bzgrep, bzip2, bzip2recover, bzless and bzmore</seg> +<seg>libbz2.a, libbz2.so (link to libbz2.so.1.0), libbz2.so.1.0 (link to +libbz2.so.&bzip2-version;) and libbz2.so.&bzip2-version;</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="bunzip2"><command>bunzip2</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bunzip2"><primary sortas="b-bunzip2">bunzip2</primary></indexterm> -<para id="bunzip2"><command>bunzip2</command> decompresses bzipped files.</para> +<para>decompresses bzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzcat"><command>bzcat</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzcat"><primary sortas="b-bzcat">bzcat</primary></indexterm> -<para id="bzcat"><command>bzcat</command> decompresses to standard output.</para> +<para>decompresses to standard output.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzcmp"><command>bzcmp</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzcmp"><primary sortas="b-bzcmp">bzcmp</primary></indexterm> -<para id="bzcmp"><command>bzcmp</command> runs cmp on bzipped files.</para> +<para>runs cmp on bzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzdiff"><command>bzdiff</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzdiff"><primary sortas="b-bzdiff">bzdiff</primary></indexterm> -<para id="bzdiff"><command>bzdiff</command> runs diff on bzipped files.</para> +<para>runs diff on bzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzgrep"><command>bzgrep</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzgrep"><primary sortas="b-bzgrep">bzgrep</primary></indexterm> -<para id="bzgrep"><command>bzgrep</command> and friends run grep on bzipped files.</para> +<para>and friends run grep on bzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzip2"><command>bzip2</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzip2"><primary sortas="b-bzip2">bzip2</primary></indexterm> -<para id="bzip2"><command>bzip2</command> compresses files using the Burrows-Wheeler +<para>compresses files using the Burrows-Wheeler block sorting text compression algorithm with Huffman coding. The compression rate is generally considerably better than that achieved by more conventional compressors using LZ77/LZ78, like <command>gzip</command>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzip2recover"><command>bzip2recover</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzip2recover"><primary sortas="b-bzip2recover">bzip2recover</primary></indexterm> -<para id="bzip2recover"><command>bzip2recover</command> tries to recover data from damaged -bzip2 files.</para> +<para>tries to recover data from damaged bzip2 files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzless"><command>bzless</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzless"><primary sortas="b-bzless">bzless</primary></indexterm> -<para id="bzless"><command>bzless</command> runs less on bzipped files.</para> +<para>runs less on bzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="bzmore"><command>bzmore</command></term> +<listitem> <indexterm zone="ch-system-bzip2 bzmore"><primary sortas="b-bzmore">bzmore</primary></indexterm> -<para id="bzmore"><command>bzmore</command> runs more on bzipped files.</para> +<para>runs more on bzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libbz2"><command>libbz2*</command></term> +<listitem> <indexterm zone="ch-system-bzip2 libbz2"><primary sortas="c-libbz2*">libbz2*</primary></indexterm> -<para id="libbz2"><command>libbz2*</command> is the library implementing lossless, +<para>is the library implementing lossless, block-sorting data compression, using the Burrows-Wheeler algorithm.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/coreutils.xml b/chapter06/coreutils.xml index 2259585c6..80e6be012 100644 --- a/chapter06/coreutils.xml +++ b/chapter06/coreutils.xml @@ -94,9 +94,11 @@ mv /usr/bin/chroot /usr/sbin</userinput></screen> </sect2> -<sect2 id="contents-coreutils"><title>Contents of Coreutils</title> +<sect2 id="contents-coreutils" role="content"><title>Contents of Coreutils</title> -<para><emphasis>Installed programs</emphasis>: basename, cat, chgrp, chmod, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>basename, cat, chgrp, chmod, chown, chroot, cksum, comm, cp, csplit, cut, date, dd, df, dir, dircolors, dirname, du, echo, env, expand, expr, factor, false, fmt, fold, groups, head, hostid, hostname, id, install, join, link, ln, logname, ls, md5sum, @@ -104,336 +106,746 @@ mkdir, mkfifo, mknod, mv, nice, nl, nohup, od, paste, pathchk, pinky, pr, printenv, printf, ptx, pwd, readlink, rm, rmdir, seq, sha1sum, shred, sleep, sort, split, stat, stty, su, sum, sync, tac, tail, tee, test, touch, tr, true, tsort, tty, uname, unexpand, uniq, unlink, uptime, users, vdir, wc, who, -whoami and yes</para> - -</sect2> - +whoami and yes</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="basename"><command>basename</command></term> +<listitem> <indexterm zone="ch-system-coreutils basename"><primary sortas="b-basename">basename</primary></indexterm> -<para id="basename"><command>basename</command> strips any path and a given suffix from -the given file name.</para> +<para>strips any path and a given suffix from the given file name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="cat"><command>cat</command></term> +<listitem> <indexterm zone="ch-system-coreutils cat"><primary sortas="b-cat">cat</primary></indexterm> -<para id="cat"><command>cat</command> concatenates files to standard output.</para> +<para>concatenates files to standard output.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chgrp"><command>chgrp</command></term> +<listitem> <indexterm zone="ch-system-coreutils chgrp"><primary sortas="b-chgrp">chgrp</primary></indexterm> -<para id="chgrp"><command>chgrp</command> changes the group ownership of each given -file to the given group. The group can be either given a a name or a numeric -ID.</para> - +<para>changes the group ownership of each given file to the given group. The +group can be either given a a name or a numeric ID.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="chmod"><command>chmod</command></term> +<listitem> <indexterm zone="ch-system-coreutils chmod"><primary sortas="b-chmod">chmod</primary></indexterm> -<para id="chmod"><command>chmod</command> changes the permissions of each given file +<para>changes the permissions of each given file to the given mode. The mode can be either a symbolic representation of the changes to make, or an octal number representing the new permissions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chown"><command>chown</command></term> +<listitem> <indexterm zone="ch-system-coreutils chown"><primary sortas="b-chown">chown</primary></indexterm> -<para id="chown"><command>chown</command> changes the user and/or group ownership of +<para>changes the user and/or group ownership of each given file to the given user:group pair.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chroot"><command>chroot</command></term> +<listitem> <indexterm zone="ch-system-coreutils chroot"><primary sortas="b-chroot">chroot</primary></indexterm> -<para id="chroot"><command>chroot</command> runs a given command with the specified -directory as the <filename>/</filename> directory. The given command can be an -interactive shell. On most systems only <emphasis>root</emphasis> can do -this.</para> - +<para>runs a given command with the specified directory as the +<filename>/</filename> directory. The given command can be an interactive shell. +On most systems only <emphasis>root</emphasis> can do this.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="cksum"><command>cksum</command></term> +<listitem> <indexterm zone="ch-system-coreutils cksum"><primary sortas="b-cksum">cksum</primary></indexterm> -<para id="cksum"><command>cksum</command> prints the CRC (Cyclic Redundancy Check) checksum and the byte +<para>prints the CRC (Cyclic Redundancy Check) checksum and the byte counts of each specified file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="comm"><command>comm</command></term> +<listitem> <indexterm zone="ch-system-coreutils comm"><primary sortas="b-comm">comm</primary></indexterm> -<para id="comm"><command>comm</command> compares two sorted files, outputting in +<para>compares two sorted files, outputting in three columns the lines that are unique, and the lines that are common.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="cp"><command>cp</command></term> +<listitem> <indexterm zone="ch-system-coreutils cp"><primary sortas="b-cp">cp</primary></indexterm> -<para id="cp"><command>cp</command> copies files.</para> +<para>copies files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="csplit"><command>csplit</command></term> +<listitem> <indexterm zone="ch-system-coreutils csplit"><primary sortas="b-csplit">csplit</primary></indexterm> -<para id="csplit"><command>csplit</command> splits a given file into several new files, +<para>splits a given file into several new files, separating them according to given patterns or line numbers, and outputting the byte count of each new file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="cut"><command>cut</command></term> +<listitem> <indexterm zone="ch-system-coreutils cut"><primary sortas="b-cut">cut</primary></indexterm> -<para id="cut"><command>cut</command> prints parts of lines, selecting the parts +<para>prints parts of lines, selecting the parts according to given fields or positions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="date"><command>date</command></term> +<listitem> <indexterm zone="ch-system-coreutils date"><primary sortas="b-date">date</primary></indexterm> -<para id="date"><command>date</command> displays the current time in the given -format, or sets the system date.</para> +<para>displays the current time in the given format, or sets the system date.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dd"><command>dd</command> </term> +<listitem> <indexterm zone="ch-system-coreutils dd"><primary sortas="b-dd">dd</primary></indexterm> -<para id="dd"><command>dd</command> copies a file using the given block size and +<para>copies a file using the given block size and count, while optionally performing conversions on it.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="df"><command>df</command></term> +<listitem> <indexterm zone="ch-system-coreutils df"><primary sortas="b-df">df</primary></indexterm> -<para id="df"><command>df</command> reports the amount of disk space available +<para>reports the amount of disk space available (and used) on all mounted file systems, or only on the file systems holding the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dir"><command>dir</command></term> +<listitem> <indexterm zone="ch-system-coreutils dir"><primary sortas="b-dir">dir</primary></indexterm> -<para id="dir"><command>dir</command> is the same as ls.</para> +<para>is the same as ls.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dircolors"><command>dircolors</command></term> +<listitem> <indexterm zone="ch-system-coreutils dircolors"><primary sortas="b-dircolors">dircolors</primary></indexterm> -<para id="dircolors"><command>dircolors</command> outputs commands to set the LS_COLOR +<para>outputs commands to set the LS_COLOR environment variable, to change the color scheme used by ls.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dirname"><command>dirname</command></term> +<listitem> <indexterm zone="ch-system-coreutils dirname"><primary sortas="b-dirname">dirname</primary></indexterm> -<para id="dirname"><command>dirname</command> strips the non-directory suffix from -a given file name.</para> +<para>strips the non-directory suffix from a given file name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="du"><command>du</command></term> +<listitem> <indexterm zone="ch-system-coreutils du"><primary sortas="b-du">du</primary></indexterm> -<para id="du"><command>du</command> reports the amount of disk space used by the +<para>reports the amount of disk space used by the current directory, or by each of the given directories including all their subdirectories, or by each of the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="echo"><command>echo</command></term> +<listitem> <indexterm zone="ch-system-coreutils echo"><primary sortas="b-echo">echo</primary></indexterm> -<para id="echo"><command>echo</command> displays the given strings.</para> +<para>displays the given strings.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="env"><command>env</command></term> +<listitem> <indexterm zone="ch-system-coreutils env"><primary sortas="b-env">env</primary></indexterm> -<para id="env"><command>env</command> runs a command in a modified environment.</para> +<para>runs a command in a modified environment.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="expand"><command>expand</command></term> +<listitem> <indexterm zone="ch-system-coreutils expand"><primary sortas="b-expand">expand</primary></indexterm> -<para id="expand"><command>expand</command> converts tabs to spaces.</para> +<para>converts tabs to spaces.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="expr"><command>expr</command></term> +<listitem> <indexterm zone="ch-system-coreutils expr"><primary sortas="b-expr">expr</primary></indexterm> -<para id="expr"><command>expr</command> evaluates expressions.</para> +<para>evaluates expressions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="factor"><command>factor</command></term> +<listitem> <indexterm zone="ch-system-coreutils factor"><primary sortas="b-factor">factor</primary></indexterm> -<para id="factor"><command>factor</command> prints the prime factors of all specified -integer numbers.</para> +<para>prints the prime factors of all specified integer numbers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="false"><command>false</command></term> +<listitem> <indexterm zone="ch-system-coreutils false"><primary sortas="b-false">false</primary></indexterm> -<para id="false"><command>false</command> does nothing, unsuccessfully. It always +<para>does nothing, unsuccessfully. It always exits with a status code indicating failure.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mt"><command>fmt</command></term> +<listitem> <indexterm zone="ch-system-coreutils mt"><primary sortas="b-mt">mt</primary></indexterm> -<para id="mt"><command>fmt</command> reformats the paragraphs in the given files.</para> +<para>reformats the paragraphs in the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fold"><command>fold</command></term> +<listitem> <indexterm zone="ch-system-coreutils fold"><primary sortas="b-fold">fold</primary></indexterm> -<para id="fold"><command>fold</command> wraps the lines in the given files.</para> +<para>wraps the lines in the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groups-coreutils"><command>groups</command></term> +<listitem> <indexterm zone="ch-system-coreutils groups-coreutils"><primary sortas="b-groups-coreutils">groups</primary></indexterm> -<para id="groups-coreutils"><command>groups</command> reports a user's group memberships.</para> +<para>reports a user's group memberships.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="head"><command>head</command></term> +<listitem> <indexterm zone="ch-system-coreutils head"><primary sortas="b-head">head</primary></indexterm> -<para id="head"><command>head</command> prints the first ten lines (or the given -number of lines) of each given file.</para> +<para>prints the first ten lines (or the given number of lines) of each given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hostid"><command>hostid</command></term> +<listitem> <indexterm zone="ch-system-coreutils hostid"><primary sortas="b-hostid">hostid</primary></indexterm> -<para id="hostid"><command>hostid</command> reports the numeric identifier -(in hexadecimal) of the host.</para> +<para>reports the numeric identifier (in hexadecimal) of the host.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hostname-coreutils"><command>hostname</command></term> +<listitem> <indexterm zone="ch-system-coreutils hostname-coreutils"><primary sortas="b-hostname-coreutils">hostname</primary></indexterm> -<para id="hostname-coreutils"><command>hostname</command> reports or sets the name of the -host.</para> +<para>reports or sets the name of the host.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="id"><command>id</command></term> +<listitem> <indexterm zone="ch-system-coreutils id"><primary sortas="b-id">id</primary></indexterm> -<para id="id"><command>id</command> reports the effective user ID, group ID, and +<para>reports the effective user ID, group ID, and group memberships of the current user, or of a given user.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="install"><command>install</command> </term> +<listitem> <indexterm zone="ch-system-coreutils install"><primary sortas="b-install">install</primary></indexterm> -<para id="install"><command>install</command> copies files while setting their +<para>copies files while setting their permission modes and, if possible, their owner and group.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="join"><command>join</command></term> +<listitem> <indexterm zone="ch-system-coreutils join"><primary sortas="b-join">join</primary></indexterm> -<para id="join"><command>join</command> joins from two files the lines that have -identical join fields.</para> +<para>joins from two files the lines that have identical join fields.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="link"><command>link</command></term> +<listitem> <indexterm zone="ch-system-coreutils link"><primary sortas="b-link">link</primary></indexterm> -<para id="link"><command>link</command> creates a hard link with the given name -to the given file.</para> +<para>creates a hard link with the given name to the given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ln"><command>ln</command></term> +<listitem> <indexterm zone="ch-system-coreutils ln"><primary sortas="b-ln">ln</primary></indexterm> -<para id="ln"><command>ln</command> makes hard links or soft links between files.</para> +<para>makes hard links or soft links between files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="logname"><command>logname</command></term> +<listitem> <indexterm zone="ch-system-coreutils logname"><primary sortas="b-logname">logname</primary></indexterm> -<para id="logname"><command>logname</command> reports the current user's login name.</para> +<para>reports the current user's login name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ls"><command>ls</command></term> +<listitem> <indexterm zone="ch-system-coreutils ls"><primary sortas="b-ls">ls</primary></indexterm> -<para id="ls"><command>ls</command> lists the contents of each given directory. +<para>lists the contents of each given directory. By default it orders the files and subdirectories alphabetically.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="md5sum"><command>md5sum</command></term> +<listitem> <indexterm zone="ch-system-coreutils md5sum"><primary sortas="b-md5sum">md5sum</primary></indexterm> -<para id="md5sum"><command>md5sum</command> reports or checks MD5 (Message Digest 5) checksums.</para> +<para>reports or checks MD5 (Message Digest 5) checksums.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkdir"><command>mkdir</command></term> +<listitem> <indexterm zone="ch-system-coreutils mkdir"><primary sortas="b-mkdir">mkdir</primary></indexterm> -<para id="mkdir"><command>mkdir</command> creates directories with the given names.</para> +<para>creates directories with the given names.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkfifo"><command>mkfifo</command></term> +<listitem> <indexterm zone="ch-system-coreutils mkfifo"><primary sortas="b-mkfifo">mkfifo</primary></indexterm> -<para id="mkfifo"><command>mkfifo</command> creates FIFOs (First-In, First-Out, a "named pipe" in UNIX parlance) with the given names.</para> - +<para>creates FIFOs (First-In, First-Out, a "named pipe" in UNIX parlance) with +the given names.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="mknod"><command>mknod</command></term> +<listitem> <indexterm zone="ch-system-coreutils mknod"><primary sortas="b-mknod">mknod</primary></indexterm> -<para id="mknod"><command>mknod</command> creates device nodes with the given names. +<para>creates device nodes with the given names. A device node is a character special file, or a block special file, or a FIFO.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mv"><command>mv</command></term> +<listitem> <indexterm zone="ch-system-coreutils mv"><primary sortas="b-mv">mv</primary></indexterm> -<para id="mv"><command>mv</command> moves or renames files or directories.</para> +<para>moves or renames files or directories.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="nice"><command>nice</command></term> +<listitem> <indexterm zone="ch-system-coreutils nice"><primary sortas="b-nice">nice</primary></indexterm> -<para id="nice"><command>nice</command> runs a program with modified scheduling priority.</para> +<para>runs a program with modified scheduling priority.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="nl"><command>nl</command></term> +<listitem> <indexterm zone="ch-system-coreutils nl"><primary sortas="b-nl">nl</primary></indexterm> -<para id="nl"><command>nl</command> numbers the lines from the given files.</para> +<para>numbers the lines from the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="nohup"><command>nohup</command></term> +<listitem> <indexterm zone="ch-system-coreutils nohup"><primary sortas="b-nohup">nohup</primary></indexterm> -<para id="nohup"><command>nohup</command> runs a command immune to hangups, with +<para>runs a command immune to hangups, with output redirected to a log file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="od"><command>od</command></term> +<listitem> <indexterm zone="ch-system-coreutils od"><primary sortas="b-od">od</primary></indexterm> -<para id="od"><command>od</command> dumps files in octal and other formats.</para> +<para>dumps files in octal and other formats.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="paste"><command>paste</command></term> +<listitem> <indexterm zone="ch-system-coreutils paste"><primary sortas="b-paste">paste</primary></indexterm> -<para id="paste"><command>paste</command> merges the given files, joining +<para>merges the given files, joining sequentially corresponding lines side by side, separated by tab characters..</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pathchk"><command>pathchk</command></term> +<listitem> <indexterm zone="ch-system-coreutils pathchk"><primary sortas="b-pathchk">pathchk</primary></indexterm> -<para id="pathchk"><command>pathchk</command> checks whether file names are valid -or portable.</para> +<para>checks whether file names are valid or portable.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pinky"><command>pinky</command></term> +<listitem> <indexterm zone="ch-system-coreutils pinky"><primary sortas="b-pinky">pinky</primary></indexterm> -<para id="pinky"><command>pinky</command> is a lightweight finger. It reports -some information about the given users.</para> +<para>is a lightweight finger. It reports some information about the given users.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pr"><command>pr</command></term> +<listitem> <indexterm zone="ch-system-coreutils pr"><primary sortas="b-pr">pr</primary></indexterm> -<para id="pr"><command>pr</command> paginates and columnates files for printing.</para> +<para>paginates and columnates files for printing.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="printenv"><command>printenv</command></term> +<listitem> <indexterm zone="ch-system-coreutils printenv"><primary sortas="b-printenv">printenv</primary></indexterm> -<para id="printenv"><command>printenv</command> prints the environment.</para> +<para>prints the environment.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="printf"><command>printf</command></term> +<listitem> <indexterm zone="ch-system-coreutils printf"><primary sortas="b-printf">printf</primary></indexterm> -<para id="printf"><command>printf</command> prints the given arguments according to the +<para>prints the given arguments according to the given format -- much like the C printf function.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ptx"><command>ptx</command></term> +<listitem> <indexterm zone="ch-system-coreutils ptx"><primary sortas="b-ptx">ptx</primary></indexterm> -<para id="ptx"><command>ptx</command> produces from the contents of the given files +<para>produces from the contents of the given files a permuted index, with each keyword in its context.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pwd"><command>pwd</command></term> +<listitem> <indexterm zone="ch-system-coreutils pwd"><primary sortas="b-pwd">pwd</primary></indexterm> -<para id="pwd"><command>pwd</command> reports the name of the current directory.</para> +<para>reports the name of the current directory.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="readlink"><command>readlink</command></term> +<listitem> <indexterm zone="ch-system-coreutils readlink"><primary sortas="b-readlink">readlink</primary></indexterm> -<para id="readlink"><command>readlink</command> reports the value of the given symbolic -link.</para> +<para>reports the value of the given symbolic link.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rm"><command>rm</command></term> +<listitem> <indexterm zone="ch-system-coreutils rm"><primary sortas="b-rm">rm</primary></indexterm> -<para id="rm"><command>rm</command> removes files or directories.</para> +<para>removes files or directories.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rmdir"><command>rmdir</command></term> +<listitem> <indexterm zone="ch-system-coreutils rmdir"><primary sortas="b-rmdir">rmdir</primary></indexterm> -<para id="rmdir"><command>rmdir</command> removes directories, if they are empty.</para> +<para>removes directories, if they are empty.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="seq"><command>seq</command></term> +<listitem> <indexterm zone="ch-system-coreutils seq"><primary sortas="b-seq">seq</primary></indexterm> -<para id="seq"><command>seq</command> prints a sequence of numbers, within a given +<para>prints a sequence of numbers, within a given range and with a given increment.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sha1sum"><command>sha1sum</command></term> +<listitem> <indexterm zone="ch-system-coreutils sha1sum"><primary sortas="b-sha1sum">sha1sum</primary></indexterm> -<para id="sha1sum"><command>sha1sum</command> prints or checks 160-bit SHA1 -checksums.</para> +<para>prints or checks 160-bit SHA1 checksums.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="shred"><command>shred</command></term> +<listitem> <indexterm zone="ch-system-coreutils shred"><primary sortas="b-shred">shred</primary></indexterm> -<para id="shred"><command>shred</command> overwrites the given files repeatedly with +<para>overwrites the given files repeatedly with strange patterns, to make it real hard to recover the data.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sleep"><command>sleep</command></term> +<listitem> <indexterm zone="ch-system-coreutils sleep"><primary sortas="b-sleep">sleep</primary></indexterm> -<para id="sleep"><command>sleep</command> pauses for the given amount of time.</para> +<para>pauses for the given amount of time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sort"><command>sort</command></term> +<listitem> <indexterm zone="ch-system-coreutils sort"><primary sortas="b-sort">sort</primary></indexterm> -<para id="sort"><command>sort</command> sorts the lines from the given files.</para> +<para>sorts the lines from the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="split"><command>split</command></term> +<listitem> <indexterm zone="ch-system-coreutils split"><primary sortas="b-split">split</primary></indexterm> -<para id="split"><command>split</command> splits the given file into pieces, by size -or by numbspliter of lines.</para> +<para>splits the given file into pieces, by size or by numbspliter of lines.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="stty"><command>stty</command></term> +<listitem> <indexterm zone="ch-system-coreutils stty"><primary sortas="b-stty">stty</primary></indexterm> -<para id="stty"><command>stty</command> sets or reports terminal line settings.</para> +<para>sets or reports terminal line settings.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="su"><command>su</command></term> +<listitem> <indexterm zone="ch-system-coreutils su"><primary sortas="b-su">su</primary></indexterm> -<para id="su"><command>su</command> runs a shell with substitute user and group IDs.</para> +<para>runs a shell with substitute user and group IDs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sum"><command>sum</command></term> +<listitem> <indexterm zone="ch-system-coreutils sum"><primary sortas="b-sum">sum</primary></indexterm> -<para id="sum"><command>sum</command> prints checksum and block counts for each -given file.</para> +<para>prints checksum and block counts for each given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sync"><command>sync</command></term> +<listitem> <indexterm zone="ch-system-coreutils sync"><primary sortas="b-sync">sync</primary></indexterm> -<para id="sync"><command>sync</command> flushes file system buffers. It forces +<para>flushes file system buffers. It forces changed blocks to disk and updates the super block.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tac"><command>tac</command></term> +<listitem> <indexterm zone="ch-system-coreutils tac"><primary sortas="b-tac">tac</primary></indexterm> -<para id="tac"><command>tac</command> concatenates the given files in reverse.</para> +<para>concatenates the given files in reverse.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tail"><command>tail</command></term> +<listitem> <indexterm zone="ch-system-coreutils tail"><primary sortas="b-tail">tail</primary></indexterm> -<para id="tail"><command>tail</command> prints the last ten lines (or the given -number of lines) of each given file.</para> +<para>prints the last ten lines (or the given number of lines) of each given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tee"><command>tee</command></term> +<listitem> <indexterm zone="ch-system-coreutils tee"><primary sortas="b-tee">tee</primary></indexterm> -<para id="tee"><command>tee</command> reads from standard input while writing both +<para>reads from standard input while writing both to standard output and to the given files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="test"><command>test</command></term> +<listitem> <indexterm zone="ch-system-coreutils test"><primary sortas="b-test">test</primary></indexterm> -<para id="test"><command>test</command> compares values and checks file types.</para> +<para>compares values and checks file types.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="touch"><command>touch</command></term> +<listitem> <indexterm zone="ch-system-coreutils touch"><primary sortas="b-touch">touch</primary></indexterm> -<para id="touch"><command>touch</command> changes file timestamps, setting the access +<para>changes file timestamps, setting the access and modification times of the given files to the current time. Files that do not exist are created with zero length.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tr"><command>tr</command></term> +<listitem> <indexterm zone="ch-system-coreutils tr"><primary sortas="b-tr">tr</primary></indexterm> -<para id="tr"><command>tr</command> translates, squeezes, and deletes the given +<para>translates, squeezes, and deletes the given characters from standard input.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="true"><command>true</command></term> +<listitem> <indexterm zone="ch-system-coreutils true"><primary sortas="b-true">true</primary></indexterm> -<para id="true"><command>true</command> does nothing, successfully. It always exits +<para>does nothing, successfully. It always exits with a status code indicating success.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tsort"><command>tsort</command></term> +<listitem> <indexterm zone="ch-system-coreutils tsort"><primary sortas="b-tsort">tsort</primary></indexterm> -<para id="tsort"><command>tsort</command> performs a topological sort. It writes a +<para>performs a topological sort. It writes a totally ordered list according to the partial ordering in a given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tty"><command>tty</command></term> +<listitem> <indexterm zone="ch-system-coreutils tty"><primary sortas="b-tty">tty</primary></indexterm> -<para id="tty"><command>tty</command> reports the file name of the terminal -connected to standard input.</para> +<para>reports the file name of the terminal connected to standard input.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="uname"><command>uname</command></term> +<listitem> <indexterm zone="ch-system-coreutils uname"><primary sortas="b-uname">uname</primary></indexterm> -<para id="uname"><command>uname</command> reports system information.</para> +<para>reports system information.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="unexpand"><command>unexpand</command></term> +<listitem> <indexterm zone="ch-system-coreutils unexpand"><primary sortas="b-unexpand">unexpand</primary></indexterm> -<para id="unexpand"><command>unexpand</command> converts spaces to tabs.</para> +<para>converts spaces to tabs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="uniq"><command>uniq</command></term> +<listitem> <indexterm zone="ch-system-coreutils uniq"><primary sortas="b-uniq">uniq</primary></indexterm> -<para id="uniq"><command>uniq</command> discards all but one of successive -identical lines.</para> +<para>discards all but one of successive identical lines.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="unlink"><command>unlink</command></term> +<listitem> <indexterm zone="ch-system-coreutils unlink"><primary sortas="b-unlink">unlink</primary></indexterm> -<para id="unlink"><command>unlink</command> removes the given file.</para> +<para>removes the given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="uptime-coreutils"><command>uptime</command></term> +<listitem> <indexterm zone="ch-system-coreutils uptime-coreutils"><primary sortas="b-uptime-coreutils">uptime</primary></indexterm> -<para id="uptime-coreutils"><command>uptime</command> reports how long the system has been +<para>reports how long the system has been running, how many users are logged on, and the system load averages.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="users"><command>users</command></term> +<listitem> <indexterm zone="ch-system-coreutils users"><primary sortas="b-users">users</primary></indexterm> -<para id="users"><command>users</command> reports the names of the users currently -logged on.</para> +<para>reports the names of the users currently logged on.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vdir"><command>vdir</command></term> +<listitem> <indexterm zone="ch-system-coreutils vdir"><primary sortas="b-vdir">vdir</primary></indexterm> -<para id="vdir"><command>vdir</command> is the same as ls -l.</para> +<para>is the same as ls -l.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="wc"><command>wc</command></term> +<listitem> <indexterm zone="ch-system-coreutils wc"><primary sortas="b-wc">wc</primary></indexterm> -<para id="wc"><command>wc</command> reports the number of lines, words, and bytes +<para>reports the number of lines, words, and bytes for each given file, and a total line when more than one file is given.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="who"><command>who</command></term> +<listitem> <indexterm zone="ch-system-coreutils who"><primary sortas="b-who">who</primary></indexterm> -<para id="who"><command>who</command> reports who is logged on.</para> +<para>reports who is logged on.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="whoami"><command>whoami</command></term> +<listitem> <indexterm zone="ch-system-coreutils whoami"><primary sortas="b-whoami">whoami</primary></indexterm> -<para id="whoami"><command>whoami</command> reports the user name associated with the -current effective user ID.</para> +<para>reports the user name associated with the current effective user ID.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="yes"><command>yes</command></term> +<listitem> <indexterm zone="ch-system-coreutils yes"><primary sortas="b-yes">yes</primary></indexterm> -<para id="yes"><command>yes</command> outputs 'y' or a given string repeatedly, -until killed.</para> +<para>outputs 'y' or a given string repeatedly, until killed.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/diffutils.xml b/chapter06/diffutils.xml index 01a7d031c..f65781a6c 100644 --- a/chapter06/diffutils.xml +++ b/chapter06/diffutils.xml @@ -44,32 +44,48 @@ Gettext, Glibc, Grep, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-diffutils"><title>Contents of Diffutils</title> - -<para><emphasis>Installed programs</emphasis>: cmp, diff, diff3 and sdiff</para> - -</sect2> +<sect2 id="contents-diffutils" role="content"><title>Contents of Diffutils</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>cmp, diff, diff3 and sdiff</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="cmp"><command>cmp</command></term> +<listitem> <indexterm zone="ch-system-diffutils cmp"><primary sortas="b-cmp">cmp</primary></indexterm> -<para id="cmp"><command>cmp</command> compares two files and reports whether or -in which bytes they differ.</para> +<para>compares two files and reports whether or in which bytes they differ.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="diff"><command>diff</command></term> +<listitem> <indexterm zone="ch-system-diffutils diff"><primary sortas="b-diff">diff</primary></indexterm> -<para id="diff"><command>diff</command> compares two files or directories and reports -which lines in the files differ.</para> +<para>compares two files or directories and reports which lines in the files differ.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="diff3"><command>diff3</command></term> +<listitem> <indexterm zone="ch-system-diffutils diff3"><primary sortas="b-diff3">diff3</primary></indexterm> -<para id="diff3"><command>diff3</command> compares three files line by line.</para> +<para>compares three files line by line.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sdiff"><command>sdiff</command></term> +<listitem> <indexterm zone="ch-system-diffutils sdiff"><primary sortas="b-sdiff">sdiff</primary></indexterm> -<para id="sdiff"><command>sdiff</command> merges two files and interactively outputs -the results.</para> +<para>merges two files and interactively outputs the results.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/e2fsprogs.xml b/chapter06/e2fsprogs.xml index f9195efcf..ba4201881 100644 --- a/chapter06/e2fsprogs.xml +++ b/chapter06/e2fsprogs.xml @@ -70,125 +70,239 @@ the shared libraries which some programs in this package use.</para></listitem> -<sect2 id="contents-e2fsprogs"><title>Contents of E2fsprogs</title> +<sect2 id="contents-e2fsprogs" role="content"><title>Contents of E2fsprogs</title> -<para><emphasis>Installed programs</emphasis>: badblocks, blkid, chattr, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs, e2fsck, e2image, e2label, findfs, fsck, fsck.ext2, fsck.ext3, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, -mklost+found, resize2fs, tune2fs and uuidgen.</para> - -<para><emphasis>Installed libraries</emphasis>: libblkid.[a,so], -libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], libss.[a,so] and -libuuid.[a,so]</para> - -</sect2> - +mklost+found, resize2fs, tune2fs and uuidgen.</seg> +<seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so], libext2fs.[a,so], libss.[a,so] and +libuuid.[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="badblocks"><command>badblocks</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs badblocks"><primary sortas="b-badblocks">badblocks</primary></indexterm> -<para id="badblocks"><command>badblocks</command> searches a device (usually a disk -partition) for bad blocks.</para> +<para>searches a device (usually a disk partition) for bad blocks.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="blkid"><command>blkid</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm> -<para id="blkid"><command>blkid</command> is a command line utility to locate and -print block device attributes.</para> +<para>is a command line utility to locate and print block device attributes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chattr"><command>chattr</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs chattr"><primary sortas="b-chattr">chattr</primary></indexterm> -<para id="chattr"><command>chattr</command> changes the attributes of files on a -second extended (ext2) file system, and also ext3 file systems, the journaling version of ext2 file systems.</para> - +<para>changes the attributes of files on a second extended (ext2) file system, and +also ext3 file systems, the journaling version of ext2 file systems.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="compile_et"><command>compile_et</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm> -<para id="compile_et"><command>compile_et</command> is an error table compiler. It +<para>is an error table compiler. It converts a table of error-code names and messages into a C source file suitable for use with the com_err library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="debugfs"><command>debugfs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm> -<para id="debugfs"><command>debugfs</command> is a file system debugger. It can be +<para>is a file system debugger. It can be used to examine and change the state of an ext2 file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dumpe2fs"><command>dumpe2fs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm> -<para id="dumpe2fs"><command>dumpe2fs</command> prints the super block and blocks group +<para>prints the super block and blocks group information for the file system present on a given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="e2fsck"><command>e2fsck</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm> -<para id="e2fsck"><command>e2fsck</command> is used to check, and optionally repair, +<para>is used to check, and optionally repair, second extended (ext2) file systems, and also ext3 file systems.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="e2image"><command>e2image</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm> -<para id="e2image"><command>e2image</command> is used to save critical ext2 file system -data to a file.</para> +<para>is used to save critical ext2 file system data to a file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="e2label"><command>e2label</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm> -<para id="e2label"><command>e2label</command> will display or change the file system +<para>will display or change the file system label on the ext2 file system present on a given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="findfs"><command>findfs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm> -<para id="findfs"><command>findfs</command> finds a file system by label or UUID (Universally Unique Identifier).</para> +<para>finds a file system by label or UUID (Universally Unique Identifier).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fsck"><command>fsck</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm> -<para id="fsck"><command>fsck</command> is used to check, and optionally repair, -file systems. By default it checks the file systems listed in -<filename>/etc/fstab</filename></para> - +<para>is used to check, and optionally repair, file systems. By default it checks the +file systems listed in <filename>/etc/fstab</filename></para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="logsave"><command>logsave</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm> -<para id="logsave"><command>logsave</command> saves the output of a command in a log file.</para> +<para>saves the output of a command in a log file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lsattr"><command>lsattr</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm> -<para id="lsattr"><command>lsattr</command> lists the attributes of files on a second -extended file system.</para> +<para>lists the attributes of files on a second extended file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mk_cmds"><command>mk_cmds</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm> -<para id="mk_cmds"><command>mk_cmds</command> converts a table of command names +<para>converts a table of command names and help messages into a C source file suitable for use with the <filename>libss</filename> subsystem library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mke2fs"><command>mke2fs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm> -<para id="mke2fs"><command>mke2fs</command> is used to create a second extended -file system on the given device.</para> +<para>is used to create a second extended file system on the given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mklost-found"><command>mklost+found</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm> -<para id="mklost-found"><command>mklost+found</command> is used to create a +<para>is used to create a <filename>lost+found</filename> directory on a second extended file system. It pre-allocates disk blocks to this directory to lighten the task of e2fsck.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="resize2fs"><command>resize2fs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm> -<para id="resize2fs"><command>resize2fs</command> can be used to enlarge or shrink an -ext2 file system.</para> +<para>can be used to enlarge or shrink an ext2 file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tune2fs"><command>tune2fs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm> -<para id="tune2fs"><command>tune2fs</command> is used adjust tunable file system +<para>is used adjust tunable file system parameters on a second extended file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="uuidgen"><command>uuidgen</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm> -<para id="uuidgen"><command>uuidgen</command> creates new -UUID. Each new UUID can reasonably be considered unique +<para>creates new UUID. Each new UUID can reasonably be considered unique among all UUIDs created, on the local system and on other systems, in the past and in the future.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libblkid"><command>libblkid</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm> -<para id="libblkid"><command>libblkid</command> contains routines for device -identification and token extraction.</para> +<para>contains routines for device identification and token extraction.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libcom_err"><command>libcom_err</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm> -<para id="libcom_err"><command>libcom_err</command> is the common error display routine.</para> +<para>is the common error display routine.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libe2p"><command>libe2p</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm> -<para id="libe2p"><command>libe2p</command> is used by dumpe2fs, chattr, and lsattr.</para> +<para>is used by dumpe2fs, chattr, and lsattr.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libext2fs"><command>libext2fs</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm> -<para id="libext2fs"><command>libext2fs</command> contains routines to enable user-level +<para>contains routines to enable user-level programs to manipulate an ext2 file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libss"><command>libss</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm> -<para id="libss"><command>libss</command> is used by debugfs.</para> +<para>is used by debugfs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libuuid"><command>libuuid</command></term> +<listitem> <indexterm zone="ch-system-e2fsprogs libuuid"><primary sortas="c-libuuid">libuuid</primary></indexterm> -<para id="libuuid"><command>libuuid</command> contains routines for generating unique +<para>contains routines for generating unique identifiers for objects that may be accessible beyond the local system.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/file.xml b/chapter06/file.xml index 88c5ef383..a5043f518 100644 --- a/chapter06/file.xml +++ b/chapter06/file.xml @@ -43,28 +43,35 @@ GCC, Glibc, Grep, Make, Sed, Zlib</seg></seglistitem> </sect2> -<sect2 id="contents-file"><title>Contents of File</title> - -<para><emphasis>Installed program</emphasis>: file</para> - -<para><emphasis>Installed library</emphasis>: libmagic.[a,so]</para> - -</sect2> +<sect2 id="contents-file" role="content"><title>Contents of File</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed library</segtitle> +<seglistitem><seg>file</seg><seg>libmagic.[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="file"><command>file</command></term> +<listitem> <indexterm zone="ch-system-file file"><primary sortas="b-file">file</primary></indexterm> -<para id="file"><command>file</command> tries to classify each given file. It does +<para>tries to classify each given file. It does this by performing several tests: file system tests, magic number tests, and language tests. The first test that succeeds determines the result.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libmagic"><command>libmagic</command></term> +<listitem> <indexterm zone="ch-system-file libmagic"><primary sortas="c-libmagic">libmagic</primary></indexterm> -<para id="libmagic"><command>libmagic</command> contains routines for magic number -recognition, used by the file program.</para> +<para>contains routines for magic number recognition, used by the file program.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/findutils.xml b/chapter06/findutils.xml index f0e7030e4..4847c2fc8 100644 --- a/chapter06/findutils.xml +++ b/chapter06/findutils.xml @@ -53,48 +53,77 @@ database to be in /var/lib/locate, which is FHS-compliant.</para> </sect2> -<sect2 id="contents-findutils"><title>Contents of Findutils</title> - -<para><emphasis>Installed programs</emphasis>: bigram, code, find, frcode, -locate, updatedb and xargs</para> - -</sect2> +<sect2 id="contents-findutils" role="content"><title>Contents of Findutils</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>bigram, code, find, frcode, locate, updatedb and xargs</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="bigram"><command>bigram</command></term> +<listitem> <indexterm zone="ch-system-findutils bigram"><primary sortas="b-bigram">bigram</primary></indexterm> -<para id="bigram"><command>bigram</command> was formerly used to produce locate -databases.</para> +<para>was formerly used to produce locate databases.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="code"><command>code</command></term> +<listitem> <indexterm zone="ch-system-findutils code"><primary sortas="b-code">code</primary></indexterm> -<para id="code"><command>code</command> was formerly used to produce locate +<para>was formerly used to produce locate databases. It is the ancestor of frcode.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="find"><command>find</command></term> +<listitem> <indexterm zone="ch-system-findutils find"><primary sortas="b-find">find</primary></indexterm> -<para id="find"><command>find</command> searches given directory trees for files -matching the specified criteria.</para> +<para>searches given directory trees for files matching the specified criteria.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="frcode"><command>frcode</command></term> +<listitem> <indexterm zone="ch-system-findutils frcode"><primary sortas="b-frcode">frcode</primary></indexterm> -<para id="frcode"><command>frcode</command> is called by updatedb to compress the -list of file names. It uses front-compression, reducing the database size by a -factor of 4 to 5.</para> - +<para>is called by updatedb to compress the list of file names. It uses +front-compression, reducing the database size by a factor of 4 to 5.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="locate"><command>locate</command></term> +<listitem> <indexterm zone="ch-system-findutils locate"><primary sortas="b-locate">locate</primary></indexterm> -<para id="locate"><command>locate</command> searches through a database of file names, +<para>searches through a database of file names, and reports the names that contain a given string or match a given pattern.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="updatedb"><command>updatedb</command></term> +<listitem> <indexterm zone="ch-system-findutils updatedb"><primary sortas="b-updatedb">updatedb</primary></indexterm> -<para id="updatedb"><command>updatedb</command> updates the locate database. It scans +<para>updates the locate database. It scans the entire file system (including other file systems that are currently mounted, unless told not to) and puts every file name it finds in the database.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="xargs"><command>xargs</command></term> +<listitem> <indexterm zone="ch-system-findutils xargs"><primary sortas="b-xargs">xargs</primary></indexterm> -<para id="xargs"><command>xargs</command> can be used to apply a given command to -a list of files.</para> +<para>can be used to apply a given command to a list of files.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/flex.xml b/chapter06/flex.xml index 855238aa6..c4bc1e664 100644 --- a/chapter06/flex.xml +++ b/chapter06/flex.xml @@ -78,34 +78,46 @@ chmod 755 /usr/bin/lex</userinput></screen> </sect2> -<sect2 id="contents-flex"><title>Contents of Flex</title> - -<para><emphasis>Installed programs</emphasis>: flex, flex++ (link to flex) -and lex</para> - -<para><emphasis>Installed library</emphasis>: libfl.a</para> - -</sect2> +<sect2 id="contents-flex" role="content"><title>Contents of Flex</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed library</segtitle> +<seglistitem><seg>flex, flex++ (link to flex) and lex</seg> +<seg>libfl.a</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="flex"><command>flex</command></term> +<listitem> <indexterm zone="ch-system-flex flex"><primary sortas="b-flex">flex</primary></indexterm> -<para id="flex"><command>flex</command> is a tool for generating programs that +<para>is a tool for generating programs that recognize patterns in text. Pattern recognition is useful in many applications. From a set of rules on what to look for, flex makes a program that looks for those patterns. The reason to use flex is that it is much easier to specify the rules for a pattern-finding program than to write the program.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="flex-"><command>flex++</command></term> +<listitem> <indexterm zone="ch-system-flex flex-"><primary sortas="b-flex++">flex++</primary></indexterm> -<para id="flex-"><command>flex++</command> invokes a version of flex that is used -exclusively for C++ scanners.</para> +<para>invokes a version of flex that is used exclusively for C++ scanners.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libfl.a"><command>libfl.a</command></term> +<listitem> <indexterm zone="ch-system-flex libfl.a"><primary sortas="c-libfl.a">libfl.a</primary></indexterm> -<para id="libfl.a"><command>libfl.a</command> is the flex library.</para> +<para>is the flex library.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/gawk.xml b/chapter06/gawk.xml index 99420f0b8..022948dc0 100644 --- a/chapter06/gawk.xml +++ b/chapter06/gawk.xml @@ -46,36 +46,58 @@ Diffutils, GCC, Gettext, Glibc, Grep, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-gawk"><title>Contents of Gawk</title> +<sect2 id="contents-gawk" role="content"><title>Contents of Gawk</title> -<para><emphasis>Installed programs</emphasis>: awk (link to gawk), gawk, -gawk-&gawk-version;, grcat, igawk, pgawk, pgawk-&gawk-version; and pwcat</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>awk (link to gawk), gawk, gawk-&gawk-version;, grcat, igawk, +pgawk, pgawk-&gawk-version; and pwcat</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="gawk"><command>gawk</command></term> +<listitem> <indexterm zone="ch-system-gawk gawk"><primary sortas="b-gawk">gawk</primary></indexterm> -<para id="gawk"><command>gawk</command> is a program for manipulating text files. +<para>is a program for manipulating text files. It is the GNU implementation of awk.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grcat"><command>grcat</command></term> +<listitem> <indexterm zone="ch-system-gawk grcat"><primary sortas="b-grcat">grcat</primary></indexterm> -<para id="grcat"><command>grcat</command> dumps the group database -<filename>/etc/group</filename>.</para> +<para>dumps the group database <filename>/etc/group</filename>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="igawk"><command>igawk</command></term> +<listitem> <indexterm zone="ch-system-gawk igawk"><primary sortas="b-igawk">igawk</primary></indexterm> -<para id="igawk"><command>igawk</command> gives gawk the ability to -include files.</para> +<para>gives gawk the ability to include files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pgawk"><command>pgawk</command></term> +<listitem> <indexterm zone="ch-system-gawk pgawk"><primary sortas="b-pgawk">pgawk</primary></indexterm> -<para id="pgawk"><command>pgawk</command> is the profiling version of gawk.</para> +<para>is the profiling version of gawk.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pwcat"><command>pwcat</command></term> +<listitem> <indexterm zone="ch-system-gawk pwcat"><primary sortas="b-pwcat">pwcat</primary></indexterm> -<para id="pwcat"><command>pwcat</command> dumps the password database -<filename>/etc/passwd</filename>.</para> +<para>dumps the password database <filename>/etc/passwd</filename>.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/gcc.xml b/chapter06/gcc.xml index 79dcc7974..c6ed50188 100644 --- a/chapter06/gcc.xml +++ b/chapter06/gcc.xml @@ -106,52 +106,86 @@ are wrong, then most likely you erroneously applied the GCC Specs patch from </sect2> -<sect2 id="contents-gcc"><title>Contents of GCC</title> - -<para><emphasis>Installed programs</emphasis>: c++, cc (link to gcc), -cc1, cc1plus, collect2, cpp, g++, gcc, gccbug, and gcov</para> - -<para><emphasis>Installed libraries</emphasis>: libgcc.a, libgcc_eh.a, -libgcc_s.so, libstdc++.[a,so] and libsupc++.a</para> - -</sect2> +<sect2 id="contents-gcc" role="content"><title>Contents of GCC</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>c++, cc (link to gcc), +cc1, cc1plus, collect2, cpp, g++, gcc, gccbug, and gcov</seg> +<seg>libgcc.a, libgcc_eh.a, libgcc_s.so, libstdc++.[a,so] and libsupc++.a</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="cpp"><command>cpp</command></term> +<listitem> <indexterm zone="ch-system-gcc cpp"><primary sortas="b-cpp">cpp</primary></indexterm> -<para id="cpp"><command>cpp</command> is the C preprocessor. It is used by the -compiler to have the #include and #define and such statements expanded in -the source files.</para> - +<para>is the C preprocessor. It is used by the compiler to have the #include and +#define and such statements expanded in the source files.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="g"><command>g++</command></term> +<listitem> <indexterm zone="ch-system-gcc g"><primary sortas="b-g++">g++</primary></indexterm> -<para id="g"><command>g++</command> is the C++ compiler.</para> +<para>is the C++ compiler.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gcc"><command>gcc</command></term> +<listitem> <indexterm zone="ch-system-gcc gcc"><primary sortas="b-gcc">gcc</primary></indexterm> -<para id="gcc"><command>gcc</command> is the C compiler. It is used to translate +<para>is the C compiler. It is used to translate the source code of a program into assembly code.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gccbug"><command>gccbug</command></term> +<listitem> <indexterm zone="ch-system-gcc gccbug"><primary sortas="b-gccbug">gccbug</primary></indexterm> -<para id="gccbug"><command>gccbug</command> is a shell script used to help create -good bug reports.</para> +<para>is a shell script used to help create good bug reports.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gcov"><command>gcov</command></term> +<listitem> <indexterm zone="ch-system-gcc gcov"><primary sortas="b-gcov">gcov</primary></indexterm> -<para id="gcov"><command>gcov</command> is a coverage testing tool. It is used to +<para>is a coverage testing tool. It is used to analyze programs to find out where optimizations will have the most effect.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libgcc"><command>libgcc*</command></term> +<listitem> <indexterm zone="ch-system-gcc libgcc"><primary sortas="c-libgcc*">libgcc*</primary></indexterm> -<para id="libgcc"><command>libgcc*</command> contains run-time support for gcc.</para> +<para>contains run-time support for gcc.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libstdc"><command>libstdc++</command></term> +<listitem> <indexterm zone="ch-system-gcc libstdc"><primary sortas="c-libstdc++">libstdc++</primary></indexterm> -<para id="libstdc"><command>libstdc++</command> is the standard C++ library. It contains -many frequently-used functions.</para> +<para>is the standard C++ library. It contains many frequently-used functions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libsupc"><command>libsupc++</command></term> +<listitem> <indexterm zone="ch-system-gcc libsupc"><primary sortas="c-libsupc++">libsupc++</primary></indexterm> -<para id="libsupc"><command>libsupc++</command> provides supporting routines -for the c++ programming language.</para> +<para>provides supporting routines for the c++ programming language.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/gettext.xml b/chapter06/gettext.xml index 09f139014..feb85a5f0 100644 --- a/chapter06/gettext.xml +++ b/chapter06/gettext.xml @@ -49,137 +49,253 @@ Diffutils, Gawk, GCC, Glibc, Grep, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-gettext"><title>Contents of Gettext</title> +<sect2 id="contents-gettext" role="content"><title>Contents of Gettext</title> -<para><emphasis>Installed programs</emphasis>: autopoint, config.charset, -config.rpath, envsubst, gettext, gettextize, hostname, msgattrib, msgcat, -msgcmp, msgcomm, msgconv, msgen, msgexec, msgfilter, msgfmt, msggrep, msginit, -msgmerge, msgunfmt, msguniq, ngettext, project-id, team-address, trigger, -urlget, user-email and xgettext</para> - -<para><emphasis>Installed libraries</emphasis>: libasprintf[a,so], -libgettextlib[a,so], libgettextpo[a,so] and libgettextsrc[a,so]</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>autopoint, config.charset, config.rpath, envsubst, gettext, +gettextize, hostname, msgattrib, msgcat, msgcmp, msgcomm, msgconv, msgen, +msgexec, msgfilter, msgfmt, msggrep, msginit, msgmerge, msgunfmt, msguniq, +ngettext, project-id, team-address, trigger, urlget, user-email and xgettext</seg> +<seg>libasprintf[a,so], libgettextlib[a,so], libgettextpo[a,so] and libgettextsrc[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="autopoint"><command>autopoint</command></term> +<listitem> <indexterm zone="ch-system-gettext autopoint"><primary sortas="b-autopoint">autopoint</primary></indexterm> -<para id="autopoint"><command>autopoint</command> copies standard gettext infrastructure -files into a source package.</para> +<para>copies standard gettext infrastructure files into a source package.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="config.charset"><command>config.charset</command></term> +<listitem> <indexterm zone="ch-system-gettext config.charset"><primary sortas="b-config.charset">config.charset</primary></indexterm> -<para id="config.charset"><command>config.charset</command> outputs a system-dependent table of -character encoding aliases.</para> +<para>outputs a system-dependent table of character encoding aliases.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="config.rpath"><command>config.rpath</command></term> +<listitem> <indexterm zone="ch-system-gettext config.rpath"><primary sortas="b-config.rpath">config.rpath</primary></indexterm> -<para id="config.rpath"><command>config.rpath</command> outputs a system-dependent set of -variables, describing how to set the runtime search path of shared libraries in an -executable.</para> - +<para>outputs a system-dependent set of variables, describing how to set the +runtime search path of shared libraries in an executable.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="envsubst"><command>envsubst</command></term> +<listitem> <indexterm zone="ch-system-gettext envsubst"><primary sortas="b-envsubst">envsubst</primary></indexterm> -<para id="envsubst"><command>envsubst</command> substitutes environment variables in shell -format strings.</para> +<para>substitutes environment variables in shell format strings.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gettext"><command>gettext</command></term> +<listitem> <indexterm zone="ch-system-gettext gettext"><primary sortas="b-gettext">gettext</primary></indexterm> -<para id="gettext"><command>gettext</command> translates a natural language message into +<para>translates a natural language message into the user's language, by looking up the translation in a message catalog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gettextize"><command>gettextize</command></term> +<listitem> <indexterm zone="ch-system-gettext gettextize"><primary sortas="b-gettextize">gettextize</primary></indexterm> -<para id="gettextize"><command>gettextize</command> copies all standard Gettext files into +<para>copies all standard Gettext files into the given top-level directory of a package, to begin inter-nationalizing it.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hostname-gettext"><command>hostname</command></term> +<listitem> <indexterm zone="ch-system-gettext hostname-gettext"><primary sortas="b-hostname-gettext">hostname</primary></indexterm> -<para id="hostname-gettext"><command>hostname</command> displays a network hostname in various -forms.</para> +<para>displays a network hostname in various forms.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgattrib"><command>msgattrib</command></term> +<listitem> <indexterm zone="ch-system-gettext msgattrib"><primary sortas="b-msgattrib">msgattrib</primary></indexterm> -<para id="msgattrib"><command>msgattrib</command> filters the messages of a translation +<para>filters the messages of a translation catalog according to their attributes and manipulates the attributes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgcat"><command>msgcat</command></term> +<listitem> <indexterm zone="ch-system-gettext msgcat"><primary sortas="b-msgcat">msgcat</primary></indexterm> -<para id="msgcat"><command>msgcat</command> concatenates and merges the given -<filename>.po</filename> files.</para> +<para>concatenates and merges the given <filename>.po</filename> files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgcmp"><command>msgcmp</command></term> +<listitem> <indexterm zone="ch-system-gettext msgcmp"><primary sortas="b-msgcmp">msgcmp</primary></indexterm> -<para id="msgcmp"><command>msgcmp</command> compares two <filename>.po</filename> +<para>compares two <filename>.po</filename> files to check that both contain the same set of msgid strings.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgcomm"><command>msgcomm</command></term> +<listitem> <indexterm zone="ch-system-gettext msgcomm"><primary sortas="b-msgcomm">msgcomm</primary></indexterm> -<para id="msgcomm"><command>msgcomm</command> finds the messages that are common to +<para>finds the messages that are common to to the given <filename>.po</filename> files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgconv"><command>msgconv</command></term> +<listitem> <indexterm zone="ch-system-gettext msgconv"><primary sortas="b-msgconv">msgconv</primary></indexterm> -<para id="msgconv"><command>msgconv</command> converts a translation catalog to a -different character encoding.</para> +<para>converts a translation catalog to a different character encoding.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgen"><command>msgen</command></term> +<listitem> <indexterm zone="ch-system-gettext msgen"><primary sortas="b-msgen">msgen</primary></indexterm> -<para id="msgen"><command>msgen</command> creates an English translation catalog.</para> +<para>creates an English translation catalog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgexec"><command>msgexec</command></term> +<listitem> <indexterm zone="ch-system-gettext msgexec"><primary sortas="b-msgexec">msgexec</primary></indexterm> -<para id="msgexec"><command>msgexec</command> applies a command to all translations of a -translation catalog.</para> +<para>applies a command to all translations of a translation catalog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgfilter"><command>msgfilter</command></term> +<listitem> <indexterm zone="ch-system-gettext msgfilter"><primary sortas="b-msgfilter">msgfilter</primary></indexterm> -<para id="msgfilter"><command>msgfilter</command> applies a filter to all translations of a -translation catalog.</para> +<para>applies a filter to all translations of a translation catalog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgfmt"><command>msgfmt</command></term> +<listitem> <indexterm zone="ch-system-gettext msgfmt"><primary sortas="b-msgfmt">msgfmt</primary></indexterm> -<para id="msgfmt"><command>msgfmt</command> generates a binary message catalog from -from a translation catalog.</para> +<para>generates a binary message catalog from from a translation catalog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msggrep"><command>msggrep</command></term> +<listitem> <indexterm zone="ch-system-gettext msggrep"><primary sortas="b-msggrep">msggrep</primary></indexterm> -<para id="msggrep"><command>msggrep</command> extracts all messages of a translation +<para>extracts all messages of a translation catalog that match a given pattern or belong to some given source files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msginit"><command>msginit</command></term> +<listitem> <indexterm zone="ch-system-gettext msginit"><primary sortas="b-msginit">msginit</primary></indexterm> -<para id="msginit"><command>msginit</command> creates a new <filename>.po</filename> -file, initializing the meta information with values from the user's -environment.</para> - +<para>creates a new <filename>.po</filename> file, initializing the meta +information with values from the user's environment.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="msgmerge"><command>msgmerge</command></term> +<listitem> <indexterm zone="ch-system-gettext msgmerge"><primary sortas="b-msgmerge">msgmerge</primary></indexterm> -<para id="msgmerge"><command>msgmerge</command> combines two raw translations into a -single file.</para> +<para>combines two raw translations into a single file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msgunfmt"><command>msgunfmt</command></term> +<listitem> <indexterm zone="ch-system-gettext msgunfmt"><primary sortas="b-msgunfmt">msgunfmt</primary></indexterm> -<para id="msgunfmt"><command>msgunfmt</command> decompiles a binary message catalog -into raw translation text.</para> +<para>decompiles a binary message catalog into raw translation text.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="msguniq"><command>msguniq</command></term> +<listitem> <indexterm zone="ch-system-gettext msguniq"><primary sortas="b-msguniq">msguniq</primary></indexterm> -<para id="msguniq"><command>msguniq</command> unifies duplicate translations in a -translation catalog.</para> +<para>unifies duplicate translations in a translation catalog.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ngettext"><command>ngettext</command></term> +<listitem> <indexterm zone="ch-system-gettext ngettext"><primary sortas="b-ngettext">ngettext</primary></indexterm> -<para id="ngettext"><command>ngettext</command> displays native language translations of a +<para>displays native language translations of a textual message whose grammatical form depends on a number.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="xgettext"><command>xgettext</command></term> +<listitem> <indexterm zone="ch-system-gettext xgettext"><primary sortas="b-xgettext">xgettext</primary></indexterm> -<para id="xgettext"><command>xgettext</command> extracts the translatable message lines +<para>extracts the translatable message lines from the given source files, to make the first translation template.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libasprintf"><command>libasprintf</command></term> +<listitem> <indexterm zone="ch-system-gettext libasprintf"><primary sortas="c-libasprintf">libasprintf</primary></indexterm> -<para id="libasprintf"><command>libasprintf</command> defines the autosprintf class, which +<para>defines the autosprintf class, which makes C formatted output routines usable in C++ programs, for use with the <string> strings and the <iostream> streams.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libgettextlib"><command>libgettextlib</command></term> +<listitem> <indexterm zone="ch-system-gettext libgettextlib"><primary sortas="c-libgettextlib">libgettextlib</primary></indexterm> -<para id="libgettextlib"><command>libgettextlib</command> is a private library containing -common routines used by the various gettext programs. They're not meant for -general use.</para> - +<para>is a private library containing common routines used by the various gettext +programs. They're not meant for general use.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="libgettextpo"><command>libgettextpo</command></term> +<listitem> <indexterm zone="ch-system-gettext libgettextpo"><primary sortas="c-libgettextpo">libgettextpo</primary></indexterm> -<para id="libgettextpo"><command>libgettextpo</command> is used to write specialized -programs that process PO files. This library is used when the standard -applications shipped with gettext won't suffice (such as msgcomm, msgcmp, -msgattrib and msgen).</para> - +<para>is used to write specialized programs that process PO files. This library is +used when the standard applications shipped with gettext won't suffice (such as +msgcomm, msgcmp, msgattrib and msgen).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="libgettextsrc"><command>libgettextsrc</command></term> +<listitem> <indexterm zone="ch-system-gettext libgettextsrc"><primary sortas="c-libgettextsrc">libgettextsrc</primary></indexterm> -<para id="libgettextsrc"><command>libgettextsrc</command> is a private library containing -common routines used by the various gettext programs. They're not meant for -general use.</para> +<para>is a private library containing common routines used by the various gettext +programs. They're not meant for general use.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/glibc.xml b/chapter06/glibc.xml index cc59f02c0..f3b7d108f 100644 --- a/chapter06/glibc.xml +++ b/chapter06/glibc.xml @@ -239,202 +239,420 @@ following:</para> </sect2> -<sect2 id="contents-glibc"><title>Contents of Glibc</title> +<sect2 id="contents-glibc" role="content"><title>Contents of Glibc</title> -<para><emphasis>Installed programs</emphasis>: catchsegv, gencat, getconf, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>catchsegv, gencat, getconf, getent, glibcbug, iconv, iconvconfig, ldconfig, ldd, lddlibc4, locale, localedef, mtrace, nscd, nscd_nischeck, pcprofiledump, pt_chown, rpcgen, -rpcinfo, sln, sprof, tzselect, xtrace, zdump and zic</para> - -<para><emphasis>Installed libraries</emphasis>: ld.so, libBrokenLocale.[a,so], +rpcinfo, sln, sprof, tzselect, xtrace, zdump and zic</seg> +<seg>ld.so, libBrokenLocale.[a,so], libSegFault.so, libanl.[a,so], libbsd-compat.a, libc.[a,so], libc_nonshared.a, libcrypt.[a,so], libdl.[a,so], libg.a, libieee.a, libm.[a,so], libmcheck.a, libmemusage.so, libnsl.a, libnss_compat.so, libnss_dns.so, libnss_files.so, libnss_hesiod.so, libnss_nis.so, libnss_nisplus.so, libpcprofile.so, libpthread.[a,so], libresolv.[a,so], librpcsvc.a, librt.[a,so], libthread_db.so -and libutil.[a,so]</para> - -</sect2> - +and libutil.[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="catchsegv"><command>catchsegv</command></term> +<listitem> <indexterm zone="ch-system-glibc catchsegv"><primary sortas="b-catchsegv">catchsegv</primary></indexterm> -<para id="catchsegv"><command>catchsegv</command> can be used to create a stack trace +<para>can be used to create a stack trace when a program terminates with a segmentation fault.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gencat"><command>gencat</command></term> +<listitem> <indexterm zone="ch-system-glibc gencat"><primary sortas="b-gencat">gencat</primary></indexterm> -<para id="gencat"><command>gencat</command> generates message catalogues.</para> +<para>generates message catalogues.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="getconf"><command>getconf</command></term> +<listitem> <indexterm zone="ch-system-glibc getconf"><primary sortas="b-getconf">getconf</primary></indexterm> -<para id="getconf"><command>getconf</command> displays the system configuration values -for file system specific variables.</para> +<para>displays the system configuration values for file system specific variables.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="getent"><command>getent</command></term> +<listitem> <indexterm zone="ch-system-glibc getent"><primary sortas="b-getent">getent</primary></indexterm> -<para id="getent"><command>getent</command> gets entries from an administrative -database.</para> +<para>gets entries from an administrative database.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="glibcbug"><command>glibcbug</command></term> +<listitem> <indexterm zone="ch-system-glibc glibcbug"><primary sortas="b-glibcbug">glibcbug</primary></indexterm> -<para id="glibcbug"><command>glibcbug</command> creates a bug report and mails it to the -bug email address.</para> +<para>creates a bug report and mails it to the bug email address.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="iconv"><command>iconv</command></term> +<listitem> <indexterm zone="ch-system-glibc iconv"><primary sortas="b-iconv">iconv</primary></indexterm> -<para id="iconv"><command>iconv</command> performs character set conversion.</para> +<para>performs character set conversion.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="iconvconfig"><command>iconvconfig</command></term> +<listitem> <indexterm zone="ch-system-glibc iconvconfig"><primary sortas="b-iconvconfig">iconvconfig</primary></indexterm> -<para id="iconvconfig"><command>iconvconfig</command> creates fastloading iconv module -configuration file.</para> +<para>creates fastloading iconv module configuration file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ldconfig"><command>ldconfig</command></term> +<listitem> <indexterm zone="ch-system-glibc ldconfig"><primary sortas="b-ldconfig">ldconfig</primary></indexterm> -<para id="ldconfig"><command>ldconfig</command> configures the dynamic linker runtime -bindings.</para> +<para>configures the dynamic linker runtime bindings.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ldd"><command>ldd</command></term> +<listitem> <indexterm zone="ch-system-glibc ldd"><primary sortas="b-ldd">ldd</primary></indexterm> -<para id="ldd"><command>ldd</command> reports which shared libraries are required +<para>reports which shared libraries are required by each given program or shared library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lddlibc4"><command>lddlibc4</command></term> +<listitem> <indexterm zone="ch-system-glibc lddlibc4"><primary sortas="b-lddlibc4">lddlibc4</primary></indexterm> -<para id="lddlibc4"><command>lddlibc4</command> assists ldd with object files.</para> +<para>assists ldd with object files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="locale"><command>locale</command></term> +<listitem> <indexterm zone="ch-system-glibc locale"><primary sortas="b-locale">locale</primary></indexterm> -<para id="locale"><command>locale</command> is a Perl program that tells the compiler +<para>is a Perl program that tells the compiler to enable or disable the use of POSIX locales for built-in operations.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="localedef"><command>localedef</command></term> +<listitem> <indexterm zone="ch-system-glibc localedef"><primary sortas="b-localedef">localedef</primary></indexterm> -<para id="localedef"><command>localedef</command> compiles locale specifications.</para> +<para>compiles locale specifications.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mtrace"><command>mtrace</command></term> +<listitem> <indexterm zone="ch-system-glibc mtrace"><primary sortas="b-mtrace">mtrace</primary></indexterm> -<para id="mtrace"><command>mtrace</command>...</para> +<para>...</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="nscd"><command>nscd</command></term> +<listitem> <indexterm zone="ch-system-glibc nscd"><primary sortas="b-nscd">nscd</primary></indexterm> -<para id="nscd"><command>nscd</command> is a name service cache daemon providing a +<para>is a name service cache daemon providing a cache for the most common name service requests.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="nscd_nischeck"><command>nscd_nischeck</command></term> +<listitem> <indexterm zone="ch-system-glibc nscd_nischeck"><primary sortas="b-nscd_nischeck">nscd_nischeck</primary></indexterm> -<para id="nscd_nischeck"><command>nscd_nischeck</command> checks whether or not secure mode -is necessary for NIS+ lookup.</para> +<para>checks whether or not secure mode is necessary for NIS+ lookup.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pcprofiledump"><command>pcprofiledump</command></term> +<listitem> <indexterm zone="ch-system-glibc pcprofiledump"><primary sortas="b-pcprofiledump">pcprofiledump</primary></indexterm> -<para id="pcprofiledump"><command>pcprofiledump</command> dumps information generated by -PC profiling.</para> +<para>dumps information generated by PC profiling.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pt_chown"><command>pt_chown</command></term> +<listitem> <indexterm zone="ch-system-glibc pt_chown"><primary sortas="b-pt_chown">pt_chown</primary></indexterm> -<para id="pt_chown"><command>pt_chown</command> is a helper program for grantpt to set +<para>is a helper program for grantpt to set the owner, group and access permissions of a slave pseudo terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rpcgen"><command>rpcgen</command></term> +<listitem> <indexterm zone="ch-system-glibc rpcgen"><primary sortas="b-rpcgen">rpcgen</primary></indexterm> -<para id="rpcgen"><command>rpcgen</command> generates C code to implement the -RPC protocol.</para> +<para>generates C code to implement the RPC protocol.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rpcinfo"><command>rpcinfo</command></term> +<listitem> <indexterm zone="ch-system-glibc rpcinfo"><primary sortas="b-rpcinfo">rpcinfo</primary></indexterm> -<para id="rpcinfo"><command>rpcinfo</command> makes an RPC call to an RPC server.</para> +<para>makes an RPC call to an RPC server.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sln"><command>sln</command></term> +<listitem> <indexterm zone="ch-system-glibc sln"><primary sortas="b-sln">sln</primary></indexterm> -<para id="sln"><command>sln</command> is used to make symbolic links. The program +<para>is used to make symbolic links. The program is statically linked, so it is useful for making symbolic links to dynamic libraries if the dynamic linking system for some reason is nonfunctional.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sprof"><command>sprof</command></term> +<listitem> <indexterm zone="ch-system-glibc sprof"><primary sortas="b-sprof">sprof</primary></indexterm> -<para id="sprof"><command>sprof</command> reads and displays shared object profiling -data.</para> +<para>reads and displays shared object profiling data.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tzselect"><command>tzselect</command></term> +<listitem> <indexterm zone="ch-system-glibc tzselect"><primary sortas="b-tzselect">tzselect</primary></indexterm> -<para id="tzselect"><command>tzselect</command> asks the user about the location of the +<para>asks the user about the location of the system and reports the corresponding time zone description.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="xtrace"><command>xtrace</command></term> +<listitem> <indexterm zone="ch-system-glibc xtrace"><primary sortas="b-xtrace">xtrace</primary></indexterm> -<para id="xtrace"><command>xtrace</command> traces the execution of a program by +<para>traces the execution of a program by printing the currently executed function.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zdump"><command>zdump</command></term> +<listitem> <indexterm zone="ch-system-glibc zdump"><primary sortas="b-zdump">zdump</primary></indexterm> -<para id="zdump"><command>zdump</command> is the time zone dumper.</para> +<para>is the time zone dumper.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zic"><command>zic</command></term> +<listitem> <indexterm zone="ch-system-glibc zic"><primary sortas="b-zic">zic</primary></indexterm> -<para id="zic"><command>zic</command> is the time zone compiler.</para> +<para>is the time zone compiler.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ld.so"><command>ld.so</command></term> +<listitem> <indexterm zone="ch-system-glibc ld.so"><primary sortas="c-ld.so">ld.so</primary></indexterm> -<para id="ld.so"><command>ld.so</command> is the helper program for shared library -executables.</para> +<para>is the helper program for shared library executables.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libBrokenLocale"><command>libBrokenLocale</command></term> +<listitem> <indexterm zone="ch-system-glibc libBrokenLocale"><primary sortas="c-libBrokenLocale">libBrokenLocale</primary></indexterm> -<para id="libBrokenLocale"><command>libBrokenLocale</command> is used by programs, such as -Mozilla, to solve broken locales.</para> +<para>is used by programs, such as Mozilla, to solve broken locales.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libSegFault"><command>libSegFault</command></term> +<listitem> <indexterm zone="ch-system-glibc libSegFault"><primary sortas="c-libSegFault">libSegFault</primary></indexterm> -<para id="libSegFault"><command>libSegFault</command> is a segmentation fault signal -handler. It tries to catch segfaults.</para> +<para>is a segmentation fault signal handler. It tries to catch segfaults.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libanl"><command>libanl</command></term> +<listitem> <indexterm zone="ch-system-glibc libanl"><primary sortas="c-libanl">libanl</primary></indexterm> -<para id="libanl"><command>libanl</command> is an asynchronous name lookup -library.</para> +<para>is an asynchronous name lookup library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libbsd-compat"><command>libbsd-compat</command></term> +<listitem> <indexterm zone="ch-system-glibc libbsd-compat"><primary sortas="c-libbsd-compat">libbsd-compat</primary></indexterm> -<para id="libbsd-compat"><command>libbsd-compat</command> provides the portability needed +<para>provides the portability needed in order to run certain BSD programs under Linux.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libc"><command>libc</command></term> +<listitem> <indexterm zone="ch-system-glibc libc"><primary sortas="c-libc">libc</primary></indexterm> -<para id="libc"><command>libc</command> is the main C library -- a collection of -commonly used functions.</para> +<para>is the main C library -- a collection of commonly used functions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libcrypt"><command>libcrypt</command></term> +<listitem> <indexterm zone="ch-system-glibc libcrypt"><primary sortas="c-libcrypt">libcrypt</primary></indexterm> -<para id="libcrypt"><command>libcrypt</command> is the cryptography library.</para> +<para>is the cryptography library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libdl"><command>libdl</command></term> +<listitem> <indexterm zone="ch-system-glibc libdl"><primary sortas="c-libdl">libdl</primary></indexterm> -<para id="libdl"><command>libdl</command> is the dynamic linking interface library.</para> +<para>is the dynamic linking interface library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libg"><command>libg</command></term> +<listitem> <indexterm zone="ch-system-glibc libg"><primary sortas="c-libg">libg</primary></indexterm> -<para id="libg"><command>libg</command> is a runtime library for g++.</para> +<para>is a runtime library for g++.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libieee"><command>libieee</command></term> +<listitem> <indexterm zone="ch-system-glibc libieee"><primary sortas="c-libieee">libieee</primary></indexterm> -<para id="libieee"><command>libieee</command> is the IEEE floating point library.</para> +<para>is the IEEE floating point library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libm"><command>libm</command></term> +<listitem> <indexterm zone="ch-system-glibc libm"><primary sortas="c-libm">libm</primary></indexterm> -<para id="libm"><command>libm</command> is the mathematical library.</para> +<para>is the mathematical library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libmcheck"><command>libmcheck</command></term> +<listitem> <indexterm zone="ch-system-glibc libmcheck"><primary sortas="c-libmcheck">libmcheck</primary></indexterm> -<para id="libmcheck"><command>libmcheck</command> contains code run at boot.</para> +<para>contains code run at boot.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libmemusage"><command>libmemusage</command></term> +<listitem> <indexterm zone="ch-system-glibc libmemusage"><primary sortas="c-libmemusage">libmemusage</primary></indexterm> -<para id="libmemusage"><command>libmemusage</command> is used by memusage to help collect +<para>is used by memusage to help collect information about the memory usage of a program.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libnsl"><command>libnsl</command></term> +<listitem> <indexterm zone="ch-system-glibc libnsl"><primary sortas="c-libnsl">libnsl</primary></indexterm> -<para id="libnsl"><command>libnsl</command> is the network services library.</para> +<para>is the network services library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libnss"><command>libnss*</command></term> +<listitem> <indexterm zone="ch-system-glibc libnss"><primary sortas="c-libnss*">libnss*</primary></indexterm> -<para id="libnss"><command>libnss*</command> are the Name Service Switch libraries, +<para>are the Name Service Switch libraries, containing functions for resolving host names, user names, group names, aliases, services, protocols,and the like.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libpcprofile"><command>libpcprofile</command></term> +<listitem> <indexterm zone="ch-system-glibc libpcprofile"><primary sortas="c-libpcprofile">libpcprofile</primary></indexterm> -<para id="libpcprofile"><command>libpcprofile</command> contains profiling functions used +<para>contains profiling functions used to track the amount of CPU time spent in which source code lines.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libpthread"><command>libpthread</command></term> +<listitem> <indexterm zone="ch-system-glibc libpthread"><primary sortas="c-libpthread">libpthread</primary></indexterm> -<para id="libpthread"><command>libpthread</command> is the POSIX threads library.</para> +<para>is the POSIX threads library.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libresolv"><command>libresolv</command></term> +<listitem> <indexterm zone="ch-system-glibc libresolv"><primary sortas="c-libresolv">libresolv</primary></indexterm> -<para id="libresolv"><command>libresolv</command> contains functions for creating, +<para>contains functions for creating, sending, and interpreting packets to the Internet domain name servers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="librpcsvc"><command>librpcsvc</command></term> +<listitem> <indexterm zone="ch-system-glibc librpcsvc"><primary sortas="c-librpcsvc">librpcsvc</primary></indexterm> -<para id="librpcsvc"><command>librpcsvc</command>contains functions providing -miscellaneous RPC services.</para> +<para>contains functions providing miscellaneous RPC services.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="librt"><command>librt</command></term> +<listitem> <indexterm zone="ch-system-glibc librt"><primary sortas="c-librt">librt</primary></indexterm> -<para id="librt"><command>librt</command> contains functions providing most of the +<para>contains functions providing most of the interfaces specified by the POSIX.1b Realtime Extension.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libthread_db"><command>libthread_db</command></term> +<listitem> <indexterm zone="ch-system-glibc libthread_db"><primary sortas="c-libthread_db">libthread_db</primary></indexterm> -<para id="libthread_db"><command>libthread_db</command> contains functions useful for +<para>contains functions useful for building debuggers for multi-threaded programs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libutil"><command>libutil</command></term> +<listitem> <indexterm zone="ch-system-glibc libutil"><primary sortas="c-libutil">libutil</primary></indexterm> -<para id="libutil"><command>libutil</command> contains code for "standard" functions -used in many different Unix utilities.</para> +<para>contains code for "standard" functions used in many different Unix utilities.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/grep.xml b/chapter06/grep.xml index 344fb0700..1726965b7 100644 --- a/chapter06/grep.xml +++ b/chapter06/grep.xml @@ -46,30 +46,40 @@ Diffutils, GCC, Gettext, Glibc, Make, Sed, Texinfo</seg></seglistitem> </sect2> -<sect2 id="contents-grep"><title>Contents of Grep</title> - -<para><emphasis>Installed programs</emphasis>: egrep (link to grep), fgrep -(link to grep) and grep</para> - -</sect2> +<sect2 id="contents-grep" role="content"><title>Contents of Grep</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>egrep (link to grep), fgrep (link to grep) and grep</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="egrep"><command>egrep</command></term> +<listitem> <indexterm zone="ch-system-grep egrep"><primary sortas="b-egrep">egrep</primary></indexterm> -<para id="egrep"><command>egrep</command> prints lines matching an extended regular -expression.</para> +<para>prints lines matching an extended regular expression.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fgrep"><command>fgrep</command></term> +<listitem> <indexterm zone="ch-system-grep fgrep"><primary sortas="b-fgrep">fgrep</primary></indexterm> -<para id="fgrep"><command>fgrep</command> prints lines matching a list of fixed -strings.</para> +<para>prints lines matching a list of fixed strings.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grep"><command>grep</command></term> +<listitem> <indexterm zone="ch-system-grep grep"><primary sortas="b-grep">grep</primary></indexterm> -<para id="grep"><command>grep</command> prints lines matching a basic regular -expression.</para> +<para>prints lines matching a basic regular expression.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/groff.xml b/chapter06/groff.xml index 5ad0f34b0..f580255ba 100644 --- a/chapter06/groff.xml +++ b/chapter06/groff.xml @@ -55,155 +55,302 @@ ln -s tbl /usr/bin/gtbl</userinput></screen> </sect2> -<sect2 id="contents-groff"><title>Contents of Groff</title> +<sect2 id="contents-groff" role="content"><title>Contents of Groff</title> -<para><emphasis>Installed programs</emphasis>: addftinfo, afmtodit, eqn, -eqn2graph, geqn (link to eqn), grn, grodvi, groff, groffer, grog, grolbp, -grolj4, grops, grotty, gtbl (link to tbl), hpftodit, indxbib, lkbib, -lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml, -pre-grohtml, refer, soelim, tbl, tfmtodit, troff and zsoelim (link to -soelim)</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn, +grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit, +indxbib, lkbib, lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml, +pre-grohtml, refer, soelim, tbl, tfmtodit, troff and zsoelim (link to soelim)</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="addftinfo"><command>addftinfo</command></term> +<listitem> <indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> -<para id="addftinfo"><command>addftinfo</command> reads a troff font file and adds some +<para>reads a troff font file and adds some additional font-metric information that is used by the groff system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="afmtodit"><command>afmtodit</command></term> +<listitem> <indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> -<para id="afmtodit"><command>afmtodit</command> creates a font file for use with -groff and grops.</para> +<para>creates a font file for use with groff and grops.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="eqn"><command>eqn</command></term> +<listitem> <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> -<para id="eqn"><command>eqn</command> compiles descriptions of equations embedded +<para>compiles descriptions of equations embedded within troff input files into commands that are understood by troff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="eqn2graph"><command>eqn2graph</command></term> +<listitem> <indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> -<para id="eqn2graph"><command>eqn2graph</command> converts an EQN equation into a cropped -image.</para> +<para>converts an EQN equation into a cropped image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grn"><command>grn</command></term> +<listitem> <indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> -<para id="grn"><command>grn</command> is a groff preprocessor for gremlin files.</para> +<para>is a groff preprocessor for gremlin files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grodvi"><command>grodvi</command></term> +<listitem> <indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> -<para id="grodvi"><command>grodvi</command> is a driver for groff that produces TeX dvi format.</para> +<para>is a driver for groff that produces TeX dvi format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groff"><command>groff</command></term> +<listitem> <indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> -<para id="groff"><command>groff</command> is a front-end to the groff document +<para>is a front-end to the groff document formatting system. Normally it runs the troff program and a post-processor appropriate for the selected device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groffer"><command>groffer</command></term> +<listitem> <indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> -<para id="groffer"><command>groffer</command> displays groff files and man pages on X -and tty terminals.</para> +<para>displays groff files and man pages on X and tty terminals.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grog"><command>grog</command></term> +<listitem> <indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> -<para id="grog"><command>grog</command> reads files and guesses which of the groff +<para>reads files and guesses which of the groff options -e, -man, -me, -mm, -ms, -p, -s, and -t are required for printing files, and reports the groff command including those options.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grolbp"><command>grolbp</command></term> +<listitem> <indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> -<para id="grolbp"><command>grolbp</command> is a groff driver for Canon CAPSL printers +<para>is a groff driver for Canon CAPSL printers (LBP-4 and LBP-8 series laser printers).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grolj4"><command>grolj4</command></term> +<listitem> <indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> -<para id="grolj4"><command>grolj4</command> is a driver for groff that produces output +<para>is a driver for groff that produces output in PCL5 format suitable for an HP Laserjet 4 printer.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grops"><command>grops</command></term> +<listitem> <indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> -<para id="grops"><command>grops</command> translates the output of GNU troff to -Postscript.</para> +<para>translates the output of GNU troff to Postscript.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grotty"><command>grotty</command></term> +<listitem> <indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> -<para id="grotty"><command>grotty</command> translates the output of GNU troff into +<para>translates the output of GNU troff into a form suitable for typewriter-like devices.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gtbl"><command>gtbl</command></term> +<listitem> <indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> -<para id="gtbl"><command>gtbl</command> is the GNU implementation of tbl.</para> +<para>is the GNU implementation of tbl.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hpftodit"><command>hpftodit</command></term> +<listitem> <indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> -<para id="hpftodit"><command>hpftodit</command> creates a font file for use with +<para>creates a font file for use with groff -Tlj4 from an HP-tagged font metric file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="indxbib"><command>indxbib</command></term> +<listitem> <indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> -<para id="indxbib"><command>indxbib</command> makes an inverted index for the -bibliographic databases a specified file for use with refer, lookbib, -and lkbib.</para> - +<para>makes an inverted index for the bibliographic databases a specified file for +use with refer, lookbib, and lkbib.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="lkbib"><command>lkbib</command></term> +<listitem> <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> -<para id="lkbib"><command>lkbib</command> searches bibliographic databases for +<para>searches bibliographic databases for references that contain specified keys and reports any references found.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lookbib"><command>lookbib</command></term> +<listitem> <indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> -<para id="lookbib"><command>lookbib</command> prints a prompt on the standard error +<para>prints a prompt on the standard error (unless the standard input is not a terminal), reads from the standard input a line containing a set of keywords, searches the bibliographic databases in a specified file for references containing those keywords, prints any references found on the standard output and repeats this process until the end of input.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mmroff"><command>mmroff</command></term> +<listitem> <indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> -<para id="mmroff"><command>mmroff</command> is a simple preprocessor for groff.</para> +<para>is a simple preprocessor for groff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="neqn"><command>neqn</command></term> +<listitem> <indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> -<para id="neqn"><command>neqn</command> formats equations for ASCII (American Standard Code for Information Interchange) output.</para> - +<para>formats equations for ASCII (American Standard Code for Information +Interchange) output.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nroff"><command>nroff</command></term> +<listitem> <indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> -<para id="nroff"><command>nroff</command> is a script that emulates the nroff command -using groff.</para> +<para>is a script that emulates the nroff command using groff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pfbtops"><command>pfbtops</command></term> +<listitem> <indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> -<para id="pfbtops"><command>pfbtops</command> translates a Postscript font in .pfb -format to ASCII.</para> +<para>translates a Postscript font in .pfb format to ASCII.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pic"><command>pic</command></term> +<listitem> <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> -<para id="pic"><command>pic</command> compiles descriptions of pictures embedded +<para>compiles descriptions of pictures embedded within troff or TeX input files into commands understood by TeX or troff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pic2graph"><command>pic2graph</command></term> +<listitem> <indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> -<para id="pic2graph"><command>pic2graph</command> converts a PIC diagram into a cropped -image.</para> +<para>converts a PIC diagram into a cropped image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pre-grohtml"><command>pre-grohtml </command></term> +<listitem> <indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> -<para id="pre-grohtml"><command>pre-grohtml </command> translates the output of GNU troff -to html.</para> +<para>translates the output of GNU troff to html.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="post-grohtml"><command>post-grohtml</command></term> +<listitem> <indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> -<para id="post-grohtml"><command>post-grohtml</command> translates the output of GNU troff -to html.</para> +<para>translates the output of GNU troff to html.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="refer"><command>refer</command></term> +<listitem> <indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> -<para id="refer"><command>refer</command> copies the contents of a file to the +<para>copies the contents of a file to the standard output, except that lines between .[ and .] are interpreted as citations, and lines between .R1 and .R2 are interpreted as commands about how citations are to be processed.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="soelim"><command>soelim</command></term> +<listitem> <indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm> -<para id="soelim"><command>soelim</command> reads files and replaces lines of the form +<para>reads files and replaces lines of the form <emphasis>.so file</emphasis> by the contents of the mentioned <emphasis>file</emphasis>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tbl"><command>tbl</command></term> +<listitem> <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> -<para id="tbl"><command>tbl</command> compiles descriptions of tables embedded +<para>compiles descriptions of tables embedded within troff input files into commands that are understood by troff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tfmtodit"><command>tfmtodit</command></term> +<listitem> <indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> -<para id="tfmtodit"><command>tfmtodit</command> creates a font file for use with -groff -Tdvi.</para> +<para>creates a font file for use with groff -Tdvi.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="troff"><command>troff</command></term> +<listitem> <indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> -<para id="troff"><command>troff</command> is highly compatible with Unix troff. -Usually it should be invoked using the groff command, which will also run -preprocessors and post-processors in the appropriate order and with the -appropriate options.</para> - +<para>is highly compatible with Unix troff. Usually it should be invoked using the +groff command, which will also run preprocessors and post-processors in the +appropriate order and with the appropriate options.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="zsoelim"><command>zsoelim</command></term> +<listitem> <indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> -<para id="zsoelim"><command>zsoelim</command> is the GNU implementation of soelim.</para> +<para>is the GNU implementation of soelim.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/grub.xml b/chapter06/grub.xml index 1195d3292..1c15a15cb 100644 --- a/chapter06/grub.xml +++ b/chapter06/grub.xml @@ -70,32 +70,57 @@ and/or <filename>reiserfs_stage1_5</filename> files.</para> </sect2> -<sect2 id="contents-grub"><title>Contents of Grub</title> +<sect2 id="contents-grub" role="content"><title>Contents of Grub</title> -<para><emphasis>Installed programs</emphasis>: grub, grub-install, -grub-md5-crypt, grub-terminfo and mbchk</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>grub, grub-install, +grub-md5-crypt, grub-terminfo and mbchk</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="grub"><command>grub</command></term> +<listitem> <indexterm zone="ch-system-grub grub"><primary sortas="b-grub">grub</primary></indexterm> -<para id="grub"><command>grub</command> is the GRand Unified Bootloader's command -shell.</para> +<para>is the GRand Unified Bootloader's command shell.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grub-install"><command>grub-install</command></term> +<listitem> <indexterm zone="ch-system-grub grub-install"><primary sortas="b-grub-install">grub-install</primary></indexterm> -<para id="grub-install"><command>grub-install</command> installs GRUB on the given device.</para> +<para>installs GRUB on the given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grub-md5-crypt"><command>grub-md5-crypt</command></term> +<listitem> <indexterm zone="ch-system-grub grub-md5-crypt"><primary sortas="b-grub-md5-crypt">grub-md5-crypt</primary></indexterm> -<para id="grub-md5-crypt"><command>grub-md5-crypt</command> encrypts a password in MD5 -format.</para> +<para>encrypts a password in MD5 format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grub-terminfo"><command>grub-terminfo</command></term> +<listitem> <indexterm zone="ch-system-grub grub-terminfo"><primary sortas="b-grub-terminfo">grub-terminfo</primary></indexterm> -<para id="grub-terminfo"><command>grub-terminfo</command> generates a terminfo command from a +<para>generates a terminfo command from a terminfo name. It can be used if you have an uncommon terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mbchk"><command>mbchk</command></term> +<listitem> <indexterm zone="ch-system-grub mbchk"><primary sortas="b-mbchk">mbchk</primary></indexterm> -<para id="mbchk"><command>mbchk</command> checks the format of a multi-boot kernel.</para> +<para>checks the format of a multi-boot kernel.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> diff --git a/chapter06/gzip.xml b/chapter06/gzip.xml index 419005823..65791d2b7 100644 --- a/chapter06/gzip.xml +++ b/chapter06/gzip.xml @@ -59,63 +59,124 @@ ln -s gunzip /bin/uncompress</userinput></screen> </sect2> -<sect2 id="contents-gzip"><title>Contents of Gzip</title> +<sect2 id="contents-gzip" role="content"><title>Contents of Gzip</title> -<para><emphasis>Installed programs</emphasis>: gunzip (link to gzip), gzexe, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>gunzip (link to gzip), gzexe, gzip, uncompress (link to gunzip), zcat (link to gzip), zcmp, zdiff, -zegrep, zfgrep, zforce, zgrep, zless, zmore and znew</para> - -</sect2> +zegrep, zfgrep, zforce, zgrep, zless, zmore and znew</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="gunzip"><command>gunzip</command></term> +<listitem> <indexterm zone="ch-system-gzip gunzip"><primary sortas="b-gunzip">gunzip</primary></indexterm> -<para id="gunzip"><command>gunzip</command> decompresses gzipped files.</para> +<para>decompresses gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gzexe"><command>gzexe</command></term> +<listitem> <indexterm zone="ch-system-gzip gzexe"><primary sortas="b-gzexe">gzexe</primary></indexterm> -<para id="gzexe"><command>gzexe</command> is used to create self-uncompressing -executable files.</para> +<para>is used to create self-uncompressing executable files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gzip"><command>gzip</command></term> +<listitem> <indexterm zone="ch-system-gzip gzip"><primary sortas="b-gzip">gzip</primary></indexterm> -<para id="gzip"><command>gzip</command> compresses the given files, using -Lempel-Ziv (LZ77) coding.</para> +<para>compresses the given files, using Lempel-Ziv (LZ77) coding.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zcat"><command>zcat</command></term> +<listitem> <indexterm zone="ch-system-gzip zcat"><primary sortas="b-zcat">zcat</primary></indexterm> -<para id="zcat"><command>zcat</command> uncompresses the given gzipped files to -standard output.</para> +<para>uncompresses the given gzipped files to standard output.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zcmp"><command>zcmp</command></term> +<listitem> <indexterm zone="ch-system-gzip zcmp"><primary sortas="b-zcmp">zcmp</primary></indexterm> -<para id="zcmp"><command>zcmp</command> runs cmp on gzipped files.</para> +<para>runs cmp on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zdiff"><command>zdiff</command></term> +<listitem> <indexterm zone="ch-system-gzip zdiff"><primary sortas="b-zdiff">zdiff</primary></indexterm> -<para id="zdiff"><command>zdiff</command> runs diff on gzipped files.</para> +<para>runs diff on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zegrep"><command>zegrep</command></term> +<listitem> <indexterm zone="ch-system-gzip zegrep"><primary sortas="b-zegrep">zegrep</primary></indexterm> -<para id="zegrep"><command>zegrep</command> runs egrep on gzipped files.</para> +<para>runs egrep on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zfgrep"><command>zfgrep</command></term> +<listitem> <indexterm zone="ch-system-gzip zfgrep"><primary sortas="b-zfgrep">zfgrep</primary></indexterm> -<para id="zfgrep"><command>zfgrep</command> runs fgrep on gzipped files.</para> +<para>runs fgrep on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zforce"><command>zforce</command></term> +<listitem> <indexterm zone="ch-system-gzip zforce"><primary sortas="b-zforce">zforce</primary></indexterm> -<para id="zforce"><command>zforce</command> forces a .gz extension on all given files +<para>forces a .gz extension on all given files that are gzipped files, so that gzip will not compress them again. This can be useful when file names were truncated during a file transfer.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zgrep"><command>zgrep</command></term> +<listitem> <indexterm zone="ch-system-gzip zgrep"><primary sortas="b-zgrep">zgrep</primary></indexterm> -<para id="zgrep"><command>zgrep</command> runs grep on gzipped files.</para> +<para>runs grep on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zless"><command>zless</command></term> +<listitem> <indexterm zone="ch-system-gzip zless"><primary sortas="b-zless">zless</primary></indexterm> -<para id="zless"><command>zless</command> runs less on gzipped files.</para> +<para>runs less on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="zmore"><command>zmore</command></term> +<listitem> <indexterm zone="ch-system-gzip zmore"><primary sortas="b-zmore">zmore</primary></indexterm> -<para id="zmore"><command>zmore</command> runs more on gzipped files.</para> +<para>runs more on gzipped files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="znew"><command>znew</command></term> +<listitem> <indexterm zone="ch-system-gzip znew"><primary sortas="b-znew">znew</primary></indexterm> -<para id="znew"><command>znew</command> re-compresses files from compress format -to gzip format -- .Z to .gz.</para> +<para>re-compresses files from compress format to gzip format -- .Z to .gz.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/iana-etc.xml b/chapter06/iana-etc.xml index b1b3b1420..a911b7adf 100644 --- a/chapter06/iana-etc.xml +++ b/chapter06/iana-etc.xml @@ -36,9 +36,12 @@ </sect2> -<sect2 id="contents-iana-etc"><title>Contents of Iana-Etc</title> +<sect2 id="contents-iana-etc" role="content"><title>Contents of Iana-Etc</title> -<para><emphasis>Installed files</emphasis>: protocols, services</para> +<segmentedlist> +<segtitle>Installed files</segtitle> +<seglistitem><seg>protocols, services</seg></seglistitem> +</segmentedlist> <indexterm zone="ch-system-iana-etc"><primary sortas="e-/etc/protocols">/etc/protocols</primary></indexterm> diff --git a/chapter06/inetutils.xml b/chapter06/inetutils.xml index 954ce8f6d..12aeebdf5 100644 --- a/chapter06/inetutils.xml +++ b/chapter06/inetutils.xml @@ -87,42 +87,80 @@ place:</para> </sect2> -<sect2 id="contents-inetutils"><title>Contents of Inetutils</title> +<sect2 id="contents-inetutils" role="content"><title>Contents of Inetutils</title> -<para><emphasis>Installed programs</emphasis>: ftp, ping, rcp, rlogin, rsh, -talk, telnet and tftp</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>ftp, ping, rcp, rlogin, rsh, talk, telnet and tftp</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="ftp"><command>ftp</command></term> +<listitem> <indexterm zone="ch-system-inetutils ftp"><primary sortas="b-ftp">ftp</primary></indexterm> -<para id="ftp"><command>ftp</command> is the ARPANET file transfer program.</para> +<para>is the ARPANET file transfer program.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ping"><command>ping</command></term> +<listitem> <indexterm zone="ch-system-inetutils ping"><primary sortas="b-ping">ping</primary></indexterm> -<para id="ping"><command>ping</command> sends echo-request packets and reports how -long the replies take.</para> +<para>sends echo-request packets and reports how long the replies take.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rcp"><command>rcp</command></term> +<listitem> <indexterm zone="ch-system-inetutils rcp"><primary sortas="b-rcp">rcp</primary></indexterm> -<para id="rcp"><command>rcp</command> does remote file copy.</para> +<para>does remote file copy.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rlogin"><command>rlogin</command></term> +<listitem> <indexterm zone="ch-system-inetutils rlogin"><primary sortas="b-rlogin">rlogin</primary></indexterm> -<para id="rlogin"><command>rlogin</command> does remote login.</para> +<para>does remote login.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rsh"><command>rsh</command></term> +<listitem> <indexterm zone="ch-system-inetutils rsh"><primary sortas="b-rsh">rsh</primary></indexterm> -<para id="rsh"><command>rsh</command> runs a remote shell.</para> +<para>runs a remote shell.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="talk"><command>talk</command></term> +<listitem> <indexterm zone="ch-system-inetutils talk"><primary sortas="b-talk">talk</primary></indexterm> -<para id="talk"><command>talk</command> is used to chat up another user.</para> +<para>is used to chat up another user.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="telnet"><command>telnet</command></term> +<listitem> <indexterm zone="ch-system-inetutils telnet"><primary sortas="b-telnet">telnet</primary></indexterm> -<para id="telnet"><command>telnet</command> is an interface to the TELNET protocol.</para> +<para>is an interface to the TELNET protocol.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tftp"><command>tftp</command></term> +<listitem> <indexterm zone="ch-system-inetutils tftp"><primary sortas="b-tftp">tftp</primary></indexterm> -<para id="tftp"><command>tftp</command> is a trivial file transfer program.</para> +<para>is a trivial file transfer program.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/kbd.xml b/chapter06/kbd.xml index 574cb181e..e89b203d9 100644 --- a/chapter06/kbd.xml +++ b/chapter06/kbd.xml @@ -45,106 +45,220 @@ Diffutils, Flex, GCC, Gettext, Glibc, Grep, Gzip, M4, Make, Sed</seg></seglistit <!-- The "Configuring your keyboard" section has been moved to Chapter 7 and renamed to "Configuring Linux console" --> -<sect2 id="contents-kbd"><title>Contents of Kbd</title> +<sect2 id="contents-kbd" role="content"><title>Contents of Kbd</title> -<para><emphasis>Installed programs</emphasis>: chvt, deallocvt, dumpkeys, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, getunimap, kbd_mode, kbdrate, loadkeys, loadunimap, mapscrn, openvt, psfaddtable (link to psfxtable), psfgettable (link to psfxtable), psfstriptable (link to psfxtable), psfxtable, resizecons, setfont, setkeycodes, setleds, setlogcons, setmetamode, setvesablank, -showconsolefont, showkey, unicode_start and unicode_stop</para> - -</sect2> - +showconsolefont, showkey, unicode_start and unicode_stop</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="chvt"><command>chvt</command></term> +<listitem> <indexterm zone="ch-system-kbd chvt"><primary sortas="b-chvt">chvt</primary></indexterm> -<para id="chvt"><command>chvt</command> changes the foreground virtual terminal.</para> +<para>changes the foreground virtual terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="deallocvt"><command>deallocvt</command></term> +<listitem> <indexterm zone="ch-system-kbd deallocvt"><primary sortas="b-deallocvt">deallocvt</primary></indexterm> -<para id="deallocvt"><command>deallocvt</command> deallocates unused virtual terminals.</para> +<para>deallocates unused virtual terminals.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dumpkeys"><command>dumpkeys</command></term> +<listitem> <indexterm zone="ch-system-kbd dumpkeys"><primary sortas="b-dumpkeys">dumpkeys</primary></indexterm> -<para id="dumpkeys"><command>dumpkeys</command> dumps the keyboard translation tables.</para> +<para>dumps the keyboard translation tables.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fgconsole"><command>fgconsole</command></term> +<listitem> <indexterm zone="ch-system-kbd fgconsole"><primary sortas="b-fgconsole">fgconsole</primary></indexterm> -<para id="fgconsole"><command>fgconsole</command> prints the number of the active virtual terminal.</para> +<para>prints the number of the active virtual terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="getkeycodes"><command>getkeycodes</command></term> +<listitem> <indexterm zone="ch-system-kbd getkeycodes"><primary sortas="b-getkeycodes">getkeycodes</primary></indexterm> -<para id="getkeycodes"><command>getkeycodes</command> prints the kernel scancode-to-keycode -mapping table.</para> +<para>prints the kernel scancode-to-keycode mapping table.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="getunimap"><command>getunimap</command></term> +<listitem> <indexterm zone="ch-system-kbd getunimap"><primary sortas="b-getunimap">getunimap</primary></indexterm> -<para id="getunimap"><command>getunimap</command> prints the currently used unimap.</para> +<para>prints the currently used unimap.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="kbd_mode"><command>kbd_mode</command></term> +<listitem> <indexterm zone="ch-system-kbd kbd_mode"><primary sortas="b-kbd_mode">kbd_mode</primary></indexterm> -<para id="kbd_mode"><command>kbd_mode</command> reports or sets the keyboard mode.</para> +<para>reports or sets the keyboard mode.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="kbdrate"><command>kbdrate</command></term> +<listitem> <indexterm zone="ch-system-kbd kbdrate"><primary sortas="b-kbdrate">kbdrate</primary></indexterm> -<para id="kbdrate"><command>kbdrate</command> sets the keyboard repeat and delay rates.</para> +<para>sets the keyboard repeat and delay rates.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="loadkeys"><command>loadkeys</command></term> +<listitem> <indexterm zone="ch-system-kbd loadkeys"><primary sortas="b-loadkeys">loadkeys</primary></indexterm> -<para id="loadkeys"><command>loadkeys</command> loads the keyboard translation tables.</para> +<para>loads the keyboard translation tables.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="loadunimap"><command>loadunimap</command></term> +<listitem> <indexterm zone="ch-system-kbd loadunimap"><primary sortas="b-loadunimap">loadunimap</primary></indexterm> -<para id="loadunimap"><command>loadunimap</command> loads the kernel unicode-to-font mapping table.</para> +<para>loads the kernel unicode-to-font mapping table.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mapscrn"><command>mapscrn</command></term> +<listitem> <indexterm zone="ch-system-kbd mapscrn"><primary sortas="b-mapscrn">mapscrn</primary></indexterm> -<para id="mapscrn"><command>mapscrn</command> is an obsolete program that used to load +<para>is an obsolete program that used to load a user-defined output character mapping table into the console driver. This is now done by setfont.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="openvt"><command>openvt</command></term> +<listitem> <indexterm zone="ch-system-kbd openvt"><primary sortas="b-openvt">openvt</primary></indexterm> -<para id="openvt"><command>openvt</command> starts a program on a new virtual terminal (VT).</para> +<para>starts a program on a new virtual terminal (VT).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="psf"><command>psf*</command></term> +<listitem> <indexterm zone="ch-system-kbd psf"><primary sortas="b-psf*">psf*</primary></indexterm> -<para id="psf"><command>psf*</command> are a set of tools for handling Unicode -character tables for console fonts.</para> +<para>are a set of tools for handling Unicode character tables for console fonts.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="resizecons"><command>resizecons</command></term> +<listitem> <indexterm zone="ch-system-kbd resizecons"><primary sortas="b-resizecons">resizecons</primary></indexterm> -<para id="resizecons"><command>resizecons</command> changes the kernel idea of the console size.</para> +<para>changes the kernel idea of the console size.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setfont"><command>setfont</command></term> +<listitem> <indexterm zone="ch-system-kbd setfont"><primary sortas="b-setfont">setfont</primary></indexterm> -<para id="setfont"><command>setfont</command> lets you change the EGA/VGA fonts on the console.</para> +<para>lets you change the EGA/VGA fonts on the console.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setkeycodes"><command>setkeycodes</command></term> +<listitem> <indexterm zone="ch-system-kbd setkeycodes"><primary sortas="b-setkeycodes">setkeycodes</primary></indexterm> -<para id="setkeycodes"><command>setkeycodes</command> loads kernel scancode-to-keycode +<para>loads kernel scancode-to-keycode mapping table entries, useful if you have some unusual keys on your keyboard.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setleds"><command>setleds</command></term> +<listitem> <indexterm zone="ch-system-kbd setleds"><primary sortas="b-setleds">setleds</primary></indexterm> -<para id="setleds"><command>setleds</command> sets the keyboard flags and LEDs. Many +<para>sets the keyboard flags and LEDs. Many people find it useful to have "Num Lock" on by default, setleds +num achieves this.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setlogcons"><command>setlogcons</command></term> +<listitem> <indexterm zone="ch-system-kbd setlogcons"><primary sortas="b-setlogcons">setlogcons</primary></indexterm> -<para id="setlogcons"><command>setlogcons</command> sends kernel messages to the console.</para> +<para>sends kernel messages to the console.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setmetamode"><command>setmetamode</command></term> +<listitem> <indexterm zone="ch-system-kbd setmetamode"><primary sortas="b-setmetamode">setmetamode</primary></indexterm> -<para id="setmetamode"><command>setmetamode</command> defines the keyboard meta-key handling.</para> +<para>defines the keyboard meta-key handling.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setvesablank"><command>setvesablank</command></term> +<listitem> <indexterm zone="ch-system-kbd setvesablank"><primary sortas="b-setvesablank">setvesablank</primary></indexterm> -<para id="setvesablank"><command>setvesablank</command> lets you fiddle with the built-in +<para>lets you fiddle with the built-in hardware screensaver (no toasters, just a blank screen).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="showconsolefont"><command>showconsolefont</command></term> +<listitem> <indexterm zone="ch-system-kbd showconsolefont"><primary sortas="b-showconsolefont">showconsolefont</primary></indexterm> -<para id="showconsolefont"><command>showconsolefont</command> shows the current EGA/VGA console -screen font.</para> +<para>shows the current EGA/VGA console screen font.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="showkey"><command>showkey</command></term> +<listitem> <indexterm zone="ch-system-kbd showkey"><primary sortas="b-showkey">showkey</primary></indexterm> -<para id="showkey"><command>showkey</command> reports the scancodes and keycodes and +<para>reports the scancodes and keycodes and ASCII codes of the keys pressed on the keyboard.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="unicode_start"><command>unicode_start</command></term> +<listitem> <indexterm zone="ch-system-kbd unicode_start"><primary sortas="b-unicode_start">unicode_start</primary></indexterm> -<para id="unicode_start"><command>unicode_start</command> puts the keyboard and console in -UNICODE mode. Never use it on LFS, because applications are not -configured to support UNICODE.</para> - +<para>puts the keyboard and console in UNICODE mode. Never use it on LFS, +because applications are not configured to support UNICODE.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="unicode_stop"><command>unicode_stop</command></term> +<listitem> <indexterm zone="ch-system-kbd unicode_stop"><primary sortas="b-unicode_stop">unicode_stop</primary></indexterm> -<para id="unicode_stop"><command>unicode_stop</command> reverts keyboard and console from -UNICODE mode.</para> +<para>reverts keyboard and console from UNICODE mode.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/less.xml b/chapter06/less.xml index f855c9e85..1aa67392d 100644 --- a/chapter06/less.xml +++ b/chapter06/less.xml @@ -50,31 +50,41 @@ configuration files.</para></listitem> </sect2> +<sect2 id="contents-less" role="content"><title>Contents of Less</title> -<sect2 id="contents-less"><title>Contents of Less</title> - -<para><emphasis>Installed programs</emphasis>: less, lessecho and lesskey</para> - -</sect2> - +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>less, lessecho and lesskey</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="less"><command>less</command></term> +<listitem> <indexterm zone="ch-system-less less"><primary sortas="b-less">less</primary></indexterm> -<para id="less"><command>less</command> is a file viewer or pager. It displays the -contents of the given file, letting you scroll around, find strings, and jump -to marks.</para> - +<para>is a file viewer or pager. It displays the contents of the given file, letting you +scroll around, find strings, and jump to marks.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="lessecho"><command>lessecho</command></term> +<listitem> <indexterm zone="ch-system-less lessecho"><primary sortas="b-lessecho">lessecho</primary></indexterm> -<para id="lessecho"><command>lessecho</command> is needed to expand meta-characters, -such as * and ?, in filenames on Unix systems.</para> +<para>is needed to expand meta-characters, such as * and ?, in filenames on Unix systems.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lesskey"><command>lesskey</command></term> +<listitem> <indexterm zone="ch-system-less lesskey"><primary sortas="b-lesskey">lesskey</primary></indexterm> -<para id="lesskey"><command>lesskey</command> is used to specify the key bindings -for less.</para> +<para>is used to specify the key bindings for less.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/libtool.xml b/chapter06/libtool.xml index 5c212f9e2..ea5fe64c4 100644 --- a/chapter06/libtool.xml +++ b/chapter06/libtool.xml @@ -48,31 +48,41 @@ GCC, Glibc, Grep, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-libtool"><title>Contents of Libtool</title> - -<para><emphasis>Installed programs</emphasis>: libtool and libtoolize</para> - -<para><emphasis>Installed libraries</emphasis>: libltdl.[a,so].</para> - -</sect2> +<sect2 id="contents-libtool" role="content"><title>Contents of Libtool</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>libtool and libtoolize</seg><seg>libltdl.[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="libtool"><command>libtool</command></term> +<listitem> <indexterm zone="ch-system-libtool libtool"><primary sortas="b-libtool">libtool</primary></indexterm> -<para id="libtool"><command>libtool</command> provides generalized library-building -support services.</para> +<para>provides generalized library-building support services.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libtoolize"><command>libtoolize</command></term> +<listitem> <indexterm zone="ch-system-libtool libtoolize"><primary sortas="b-libtoolize">libtoolize</primary></indexterm> -<para id="libtoolize"><command>libtoolize</command> provides a standard way to add -libtool support to a package.</para> +<para>provides a standard way to add libtool support to a package.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libltdl"><command>libltdl</command></term> +<listitem> <indexterm zone="ch-system-libtool libltdl"><primary sortas="c-libltdl">libltdl</primary></indexterm> -<para id="libltdl"><command>libltdl</command> hides the various difficulties of -dlopening libraries.</para> +<para>hides the various difficulties of dlopening libraries.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/m4.xml b/chapter06/m4.xml index 72e2b2d56..a6e7a95f1 100644 --- a/chapter06/m4.xml +++ b/chapter06/m4.xml @@ -46,22 +46,29 @@ Gettext, Glibc, Grep, Make, Perl, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-m4"><title>Contents of M4</title> +<sect2 id="contents-m4" role="content"><title>Contents of M4</title> -<para><emphasis>Installed program</emphasis>: m4</para> - -</sect2> +<segmentedlist> +<segtitle>Installed program</segtitle> +<seglistitem><seg>m4</seg></seglistitem> +</segmentedlist> -<sect2><title>Short description</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="m4"><command>m4</command></term> +<listitem> <indexterm zone="ch-system-m4 m4"><primary sortas="b-m4">m4</primary></indexterm> -<para id="m4"><command>m4</command> copies the given files +<para>copies the given files while expanding the macros that they contain. These macros are either built-in or user-defined and can take any number of arguments. Besides just doing macro expansion, m4 has built-in functions for including named files, running Unix commands, doing integer arithmetic, manipulating text in various ways, recursion, and so on. The m4 program can be used either as a front-end to a compiler or as a macro processor in its own right.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> diff --git a/chapter06/make.xml b/chapter06/make.xml index 82ce7671b..537aa74e0 100644 --- a/chapter06/make.xml +++ b/chapter06/make.xml @@ -46,21 +46,25 @@ GCC, Gettext, Glibc, Grep, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-make"><title>Contents of Make</title> - -<para><emphasis>Installed program</emphasis>: make</para> - -</sect2> +<sect2 id="contents-make" role="content"><title>Contents of Make</title> +<segmentedlist> +<segtitle>Installed program</segtitle> +<seglistitem><seg>make</seg></seglistitem> +</segmentedlist> -<sect2><title>Short description</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="make"><command>make</command></term> +<listitem> <indexterm zone="ch-system-make make"><primary sortas="b-make">make</primary></indexterm> -<para id="make"><command>make</command> automatically determines which pieces of a -large package need to be recompiled, and then issues the relevant commands.</para> +<para>automatically determines which pieces of a large package need to be +recompiled, and then issues the relevant commands.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/man-pages.xml b/chapter06/man-pages.xml index ae5d0dca5..532f5a962 100644 --- a/chapter06/man-pages.xml +++ b/chapter06/man-pages.xml @@ -34,22 +34,25 @@ </sect2> -<sect2 id="contents-manpages"><title>Contents of Man-pages</title> - -<para><emphasis>Installed files</emphasis>: various manual pages</para> - -</sect2> +<sect2 id="contents-manpages" role="content"><title>Contents of Man-pages</title> +<segmentedlist> +<segtitle>Installed files</segtitle> +<seglistitem><seg>various manual pages</seg></seglistitem> +</segmentedlist> -<sect2><title>Short description</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="manual-pages"><emphasis>manual pages</emphasis></term> +<listitem> <indexterm zone="ch-system-man-pages manual-pages"><primary sortas="e-manual-pages">manual pages</primary></indexterm> -<para id="manual-pages">Examples of provided <emphasis>manual pages</emphasis> are the pages -describing all the C and C++ functions, important device files, and important -configuration files.</para> +<para>Examples of provided manual pages are the pages describing all the C and +C++ functions, important device files, and important configuration files.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/man.xml b/chapter06/man.xml index a1de7a956..6a95b0702 100644 --- a/chapter06/man.xml +++ b/chapter06/man.xml @@ -108,42 +108,69 @@ formatting and compression issues for man pages.</para> </sect2> -<sect2 id="contents-man"><title>Contents of Man</title> - -<para><emphasis>Installed programs</emphasis>: apropos, makewhatis, man, -man2dvi, man2html and whatis</para> - -</sect2> +<sect2 id="contents-man" role="content"><title>Contents of Man</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>apropos, makewhatis, man, +man2dvi, man2html and whatis</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="apropos"><command>apropos</command></term> +<listitem> <indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm> -<para id="apropos"><command>apropos</command> searches the whatis database and displays +<para>searches the whatis database and displays the short descriptions of system commands that contain a given string.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="makewhatis"><command>makewhatis</command></term> +<listitem> <indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm> -<para id="makewhatis"><command>makewhatis</command> builds the whatis database. It reads +<para>builds the whatis database. It reads all the manual pages in the manpath and for each page writes the name and a short description in the whatis database.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="man"><command>man</command></term> +<listitem> <indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm> -<para id="man"><command>man</command> formats and displays the requested on-line -manual page.</para> +<para>formats and displays the requested on-line manual page.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="man2dvi"><command>man2dvi</command></term> +<listitem> <indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm> -<para id="man2dvi"><command>man2dvi</command> converts a manual page into dvi format.</para> +<para>converts a manual page into dvi format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="man2html"><command>man2html</command></term> +<listitem> <indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm> -<para id="man2html"><command>man2html</command> converts a manual page into html.</para> +<para>converts a manual page into html.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="whatis"><command>whatis</command></term> +<listitem> <indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm> -<para id="whatis"><command>whatis</command> searches the whatis database and displays -the short descriptions of system commands that contain the given keyword as a -separate word.</para> +<para>searches the whatis database and displays the short descriptions of system +commands that contain the given keyword as a separate word.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/mktemp.xml b/chapter06/mktemp.xml index 0640f1afb..689ae992a 100644 --- a/chapter06/mktemp.xml +++ b/chapter06/mktemp.xml @@ -56,24 +56,33 @@ library.</para></listitem> </sect2> -<sect2 id="contents-mktemp"><title>Contents of Mktemp</title> +<sect2 id="contents-mktemp" role="content"><title>Contents of Mktemp</title> -<para><emphasis>Installed programs</emphasis>: mktemp, tempfile</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>mktemp, tempfile</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="mktemp"><command>mktemp</command></term> +<listitem> <indexterm zone="ch-system-mktemp mktemp"><primary sortas="b-mktemp">mktemp</primary></indexterm> -<para id="mktemp"><command>mktemp</command> creates temporary files in a secure manner. -It is used in scripts.</para> +<para>creates temporary files in a secure manner. It is used in scripts.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tempfile"><command>tempfile</command></term> +<listitem> <indexterm zone="ch-system-mktemp tempfile"><primary sortas="b-tempfile">tempfile</primary></indexterm> -<para id="tempfile"><command>tempfile</command> creates temporary files in a less secure -manner than <command>mktemp</command>. It is installed for -backwards-compatibility.</para> +<para>creates temporary files in a less secure manner than +<command>mktemp</command>. It is installed for backwards-compatibility.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - </sect1> diff --git a/chapter06/module-init-tools.xml b/chapter06/module-init-tools.xml index 150d93dfb..cb3191236 100644 --- a/chapter06/module-init-tools.xml +++ b/chapter06/module-init-tools.xml @@ -47,59 +47,111 @@ Coreutils, Diffutils, Flex, GCC, Glibc, Grep, M4, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-module-init-tools"><title>Contents of Module-Init-Tools</title> +<sect2 id="contents-module-init-tools" role="content"><title>Contents of Module-Init-Tools</title> -<para><emphasis>Installed programs</emphasis>: depmod, genksyms, insmod, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>depmod, genksyms, insmod, insmod_ksymoops_clean, kallsyms (link to insmod), kernelversion, ksyms (link to insmod), lsmod (link to insmod), modinfo, modprobe (link to insmod) -and rmmod (link to insmod)</para> - -</sect2> - +and rmmod (link to insmod)</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="depmod"><command>depmod</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools depmod"><primary sortas="b-depmod">depmod</primary></indexterm> -<para id="depmod"><command>depmod</command> creates a dependency file, based on the +<para>creates a dependency file, based on the symbols it finds in the existing set of modules. This dependency file is used by modprobe to automatically load the required modules.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="genksyms"><command>genksyms</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools genksyms"><primary sortas="b-genksyms">genksyms</primary></indexterm> -<para id="genksyms"><command>genksyms</command> generates symbol version information.</para> +<para>generates symbol version information.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="insmod"><command>insmod</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools insmod"><primary sortas="b-insmod">insmod</primary></indexterm> -<para id="insmod"><command>insmod</command> installs a loadable module in the running kernel.</para> +<para>installs a loadable module in the running kernel.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="insmod_ksymoops_clean"><command>insmod_ksymoops_clean</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools insmod_ksymoops_clean"><primary sortas="b-insmod_ksymoops_clean">insmod_ksymoops_clean</primary></indexterm> -<para id="insmod_ksymoops_clean"><command>insmod_ksymoops_clean</command> deletes saved ksyms and -modules not accessed for two days.</para> +<para>deletes saved ksyms and modules not accessed for two days.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="kallsyms"><command>kallsyms</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools kallsyms"><primary sortas="b-kallsyms">kallsyms</primary></indexterm> -<para id="kallsyms"><command>kallsyms</command> extracts all kernel symbols for debugging.</para> +<para>extracts all kernel symbols for debugging.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="kernelversion"><command>kernelversion</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools kernelversion"><primary sortas="b-kernelversion">kernelversion</primary></indexterm> -<para id="kernelversion"><command>kernelversion</command> reports the major version of the -running kernel.</para> +<para>reports the major version of the running kernel.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ksyms"><command>ksyms</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools ksyms"><primary sortas="b-ksyms">ksyms</primary></indexterm> -<para id="ksyms"><command>ksyms</command> displays exported kernel symbols.</para> +<para>displays exported kernel symbols.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lsmod"><command>lsmod</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools lsmod"><primary sortas="b-lsmod">lsmod</primary></indexterm> -<para id="lsmod"><command>lsmod</command> shows which modules are loaded.</para> +<para>shows which modules are loaded.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="modinfo"><command>modinfo</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools modinfo"><primary sortas="b-modinfo">modinfo</primary></indexterm> -<para id="modinfo"><command>modinfo</command> examines an object file associated with +<para>examines an object file associated with a kernel module and displays any information that it can glean.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="modprobe"><command>modprobe</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools modprobe"><primary sortas="b-modprobe">modprobe</primary></indexterm> -<para id="modprobe"><command>modprobe</command> uses a dependency file, created by +<para>uses a dependency file, created by depmod, to automatically load the relevant modules.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rmmod"><command>rmmod</command></term> +<listitem> <indexterm zone="ch-system-module-init-tools rmmod"><primary sortas="b-rmmod">rmmod</primary></indexterm> -<para id="rmmod"><command>rmmod</command> unloads modules from the running kernel.</para> +<para>unloads modules from the running kernel.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/ncurses.xml b/chapter06/ncurses.xml index 686ea1a0c..733796464 100644 --- a/chapter06/ncurses.xml +++ b/chapter06/ncurses.xml @@ -62,77 +62,141 @@ ln -sf libncurses.so /usr/lib/libcurses.so</userinput></screen> </sect2> -<sect2 id="contents-ncurses"><title>Contents of Ncurses</title> +<sect2 id="contents-ncurses" role="content"><title>Contents of Ncurses</title> -<para><emphasis>Installed programs</emphasis>: captoinfo (link to tic), clear, -infocmp, infotocap (link to tic), reset (link to tset), tack, tic, toe, tput -and tset</para> - -<para><emphasis>Installed libraries</emphasis>: libcurses.[a,so] (link to -libncurses.[a,so]), libform.[a,so], libmenu.[a,so], libncurses++.a, -libncurses.[a,so], libpanel.[a,so]</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>captoinfo (link to tic), clear, infocmp, infotocap (link to tic), +reset (link to tset), tack, tic, toe, tput and tset</seg> +<seg>libcurses.[a,so] (link to libncurses.[a,so]), libform.[a,so], libmenu.[a,so], +libncurses++.a, libncurses.[a,so], libpanel.[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="captoinfo"><command>captoinfo</command></term> +<listitem> <indexterm zone="ch-system-ncurses captoinfo"><primary sortas="b-captoinfo">captoinfo</primary></indexterm> -<para id="captoinfo"><command>captoinfo</command> converts a termcap description into a -terminfo description.</para> +<para>converts a termcap description into a terminfo description.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="clear"><command>clear</command></term> +<listitem> <indexterm zone="ch-system-ncurses clear"><primary sortas="b-clear">clear</primary></indexterm> -<para id="clear"><command>clear</command> clears the screen, if this is possible.</para> +<para>clears the screen, if this is possible.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="infocmp"><command>infocmp</command></term> +<listitem> <indexterm zone="ch-system-ncurses infocmp"><primary sortas="b-infocmp">infocmp</primary></indexterm> -<para id="infocmp"><command>infocmp</command> compares or prints out terminfo -descriptions.</para> +<para>compares or prints out terminfo descriptions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="infotocap"><command>infotocap</command></term> +<listitem> <indexterm zone="ch-system-ncurses infotocap"><primary sortas="b-infotocap">infotocap</primary></indexterm> -<para id="infotocap"><command>infotocap</command> converts a terminfo description into -a termcap description.</para> +<para>converts a terminfo description into a termcap description.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="reset"><command>reset</command></term> +<listitem> <indexterm zone="ch-system-ncurses reset"><primary sortas="b-reset">reset</primary></indexterm> -<para id="reset"><command>reset</command> reinitializes a terminal to its default -values.</para> +<para>reinitializes a terminal to its default values.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tack"><command>tack</command></term> +<listitem> <indexterm zone="ch-system-ncurses tack"><primary sortas="b-tack">tack</primary></indexterm> -<para id="tack"><command>tack</command> is the terminfo action checker. It is mainly +<para>is the terminfo action checker. It is mainly used to test the correctness of an entry in the terminfo database.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tic"><command>tic</command></term> +<listitem> <indexterm zone="ch-system-ncurses tic"><primary sortas="b-tic">tic</primary></indexterm> -<para id="tic"><command>tic</command> is the terminfo entry-description compiler. +<para>is the terminfo entry-description compiler. It translates a terminfo file from source format into the binary format needed for the ncurses library routines. A terminfo file contains information on the capabilities of a certain terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="toe"><command>toe</command></term> +<listitem> <indexterm zone="ch-system-ncurses toe"><primary sortas="b-toe">toe</primary></indexterm> -<para id="toe"><command>toe</command> lists all available terminal types, for each +<para>lists all available terminal types, for each giving its primary name and its description.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tput"><command>tput</command></term> +<listitem> <indexterm zone="ch-system-ncurses tput"><primary sortas="b-tput">tput</primary></indexterm> -<para id="tput"><command>tput</command> makes the values of terminal-dependent +<para>makes the values of terminal-dependent capabilities available to the shell. It can also be used to reset or initialize a terminal, or report its long name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tset"><command>tset</command></term> +<listitem> <indexterm zone="ch-system-ncurses tset"><primary sortas="b-tset">tset</primary></indexterm> -<para id="tset"><command>tset</command> can be used to initialize terminals.</para> +<para>can be used to initialize terminals.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libncurses"><command>libncurses*</command></term> +<listitem> <indexterm zone="ch-system-ncurses libncurses"><primary sortas="c-libncurses*">libncurses*</primary></indexterm> -<para id="libncurses"><command>libncurses*</command> contains functions to display text in +<para>contains functions to display text in many complicated ways on a terminal screen. A good example of the use of these functions is the menu displayed during the kernel's make menuconfig.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libform"><command>libform*</command></term> +<listitem> <indexterm zone="ch-system-ncurses libform"><primary sortas="c-libform*">libform*</primary></indexterm> -<para id="libform"><command>libform*</command> contains functions to implement forms.</para> +<para>contains functions to implement forms.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libmenu"><command>libmenu*</command></term> +<listitem> <indexterm zone="ch-system-ncurses libmenu"><primary sortas="c-libmenu*">libmenu*</primary></indexterm> -<para id="libmenu"><command>libmenu*</command> contains functions to implement menus.</para> +<para>contains functions to implement menus.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libpanel"><command>libpanel*</command></term> +<listitem> <indexterm zone="ch-system-ncurses libpanel"><primary sortas="c-libpanel*">libpanel*</primary></indexterm> -<para id="libpanel"><command>libpanel*</command> contains functions to implement panels.</para> +<para>contains functions to implement panels.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/net-tools.xml b/chapter06/net-tools.xml index 6a55a1dcc..d45fd004b 100644 --- a/chapter06/net-tools.xml +++ b/chapter06/net-tools.xml @@ -65,71 +65,125 @@ make config</userinput> instead):</para> </sect2> -<sect2 id="contents-net"><title>Contents of Net-tools</title> - -<para><emphasis>Installed programs</emphasis>: arp, dnsdomainname (link to -hostname), domainname (link to hostname), hostname, ifconfig, nameif, netstat, -nisdomainname (link to hostname), plipconfig, rarp, route, slattach and -ypdomainname (link to hostname)</para> - -</sect2> +<sect2 id="contents-net" role="content"><title>Contents of Net-tools</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>arp, dnsdomainname (link to hostname), domainname (link to +hostname), hostname, ifconfig, nameif, netstat, nisdomainname (link to hostname), +plipconfig, rarp, route, slattach and ypdomainname (link to hostname)</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="arp"><command>arp</command></term> +<listitem> <indexterm zone="ch-system-net-tools arp"><primary sortas="b-arp">arp</primary></indexterm> -<para id="arp"><command>arp</command> is used to manipulate the kernel's ARP cache, +<para>is used to manipulate the kernel's ARP cache, usually to add or delete an entry, or to dump the entire cache.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dnsdomainname"><command>dnsdomainname</command></term> +<listitem> <indexterm zone="ch-system-net-tools dnsdomainname"><primary sortas="b-dnsdomainname">dnsdomainname</primary></indexterm> -<para id="dnsdomainname"><command>dnsdomainname</command> reports the system's DNS (Domain Name Server) domain -name.</para> +<para>reports the system's DNS (Domain Name Server) domain name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="domainname"><command>domainname</command></term> +<listitem> <indexterm zone="ch-system-net-tools domainname"><primary sortas="b-domainname">domainname</primary></indexterm> -<para id="domainname"><command>domainname</command> reports or sets the system's NIS/YP -domain name.</para> +<para>reports or sets the system's NIS/YP domain name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hostname"><command>hostname</command></term> +<listitem> <indexterm zone="ch-system-net-tools hostname"><primary sortas="b-hostname">hostname</primary></indexterm> -<para id="hostname"><command>hostname</command> reports or sets the name of the current -host system.</para> +<para>reports or sets the name of the current host system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ifconfig"><command>ifconfig</command></term> +<listitem> <indexterm zone="ch-system-net-tools ifconfig"><primary sortas="b-ifconfig">ifconfig</primary></indexterm> -<para id="ifconfig"><command>ifconfig</command> is the main utility for configuring -network interfaces.</para> +<para>is the main utility for configuring network interfaces.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="nameif"><command>nameif</command></term> +<listitem> <indexterm zone="ch-system-net-tools nameif"><primary sortas="b-nameif">nameif</primary></indexterm> -<para id="nameif"><command>nameif</command> names network interfaces based on MAC -addresses.</para> +<para>names network interfaces based on MAC addresses.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="netstat"><command>netstat</command></term> +<listitem> <indexterm zone="ch-system-net-tools netstat"><primary sortas="b-netstat">netstat</primary></indexterm> -<para id="netstat"><command>netstat</command> is used to report network connections, -routing tables, and interface statistics..</para> - +<para>is used to report network connections, routing tables, and interface +statistics..</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nisdomainname"><command>nisdomainname</command></term> +<listitem> <indexterm zone="ch-system-net-tools nisdomainname"><primary sortas="b-nisdomainname">nisdomainname</primary></indexterm> -<para id="nisdomainname"><command>nisdomainname</command> does the same as domainname.</para> +<para>does the same as domainname.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="plipconfig"><command>plipconfig</command></term> +<listitem> <indexterm zone="ch-system-net-tools plipconfig"><primary sortas="b-plipconfig">plipconfig</primary></indexterm> -<para id="plipconfig"><command>plipconfig</command> is used to fine tune the PLIP device -parameters, to improve its performance.</para> +<para>is used to fine tune the PLIP device parameters, to improve its performance.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rarp"><command>rarp</command></term> +<listitem> <indexterm zone="ch-system-net-tools rarp"><primary sortas="b-rarp">rarp</primary></indexterm> -<para id="rarp"><command>rarp</command> is used to manipulate the kernel's RARP -table.</para> +<para>is used to manipulate the kernel's RARP table.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="route"><command>route</command></term> +<listitem> <indexterm zone="ch-system-net-tools route"><primary sortas="b-route">route</primary></indexterm> -<para id="route"><command>route</command> is used to manipulate the IP routing -table.</para> +<para>is used to manipulate the IP routing table.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="slattach"><command>slattach</command></term> +<listitem> <indexterm zone="ch-system-net-tools slattach"><primary sortas="b-slattach">slattach</primary></indexterm> -<para id="slattach"><command>slattach</command> attaches a network interface to a serial -line. This allows you to use normal terminal lines for point-to-point links to -other computers.</para> - +<para>attaches a network interface to a serial line. This allows you to use normal +terminal lines for point-to-point links to other computers.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="ypdomainname"><command>ypdomainname</command></term> +<listitem> <indexterm zone="ch-system-net-tools ypdomainname"><primary sortas="b-ypdomainname">ypdomainname</primary></indexterm> -<para id="ypdomainname"><command>ypdomainname</command> does the same as domainname.</para> +<para>does the same as domainname.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/patch.xml b/chapter06/patch.xml index 052af9315..ad6708b25 100644 --- a/chapter06/patch.xml +++ b/chapter06/patch.xml @@ -45,24 +45,28 @@ machines you can leave it out):</para> </sect2> -<sect2 id="contents-patch"><title>Contents of Patch</title> - -<para><emphasis>Installed program</emphasis>: patch</para> - -</sect2> +<sect2 id="contents-patch" role="content"><title>Contents of Patch</title> +<segmentedlist> +<segtitle>Installed program</segtitle> +<seglistitem><seg>patch</seg></seglistitem> +</segmentedlist> -<sect2><title>Short description</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="patch"><command>patch</command></term> +<listitem> <indexterm zone="ch-system-patch patch"><primary sortas="b-patch">patch</primary></indexterm> -<para id="patch"><command>patch</command> modifies files according to a patch file. +<para>modifies files according to a patch file. A patch file normally is a difference listing created with the diff program. By applying these differences to the original files, patch creates the patched versions. Using patches instead of entirely new tarballs to keep your sources up-to-date can save you a lot of download time.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/perl.xml b/chapter06/perl.xml index b0ab6cbbb..2008d4959 100644 --- a/chapter06/perl.xml +++ b/chapter06/perl.xml @@ -64,122 +64,245 @@ resolve the name <emphasis>localhost</emphasis>:</para> </sect2> -<sect2 id="contents-perl"><title>Contents of Perl</title> +<sect2 id="contents-perl" role="content"><title>Contents of Perl</title> -<para><emphasis>Installed programs</emphasis>: a2p, c2ph, dprofpp, enc2xs, +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>a2p, c2ph, dprofpp, enc2xs, find2perl, h2ph, h2xs, libnetcfg, perl, perl&perl-version; (link to perl), perlbug, perlcc, perldoc, perlivp, piconv, pl2pm, pod2html, pod2latex, pod2man, pod2text, pod2usage, podchecker, podselect, psed (link to s2p), pstruct (link -to c2ph), s2p, splain and xsubpp</para> - -<para><emphasis>Installed libraries</emphasis>: (too many to name)</para> - -</sect2> +to c2ph), s2p, splain and xsubpp</seg> +<seg>(too many to name)</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="a2p"><command>a2p</command></term> +<listitem> <indexterm zone="ch-system-perl a2p"><primary sortas="b-a2p">a2p</primary></indexterm> -<para id="a2p"><command>a2p</command> translates awk to perl.</para> +<para>translates awk to perl.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="c2ph"><command>c2ph</command></term> +<listitem> <indexterm zone="ch-system-perl c2ph"><primary sortas="b-c2ph">c2ph</primary></indexterm> -<para id="c2ph"><command>c2ph</command> dumps C structures as generated from -"cc -g -S" stabs.</para> +<para>dumps C structures as generated from "cc -g -S" stabs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dprofpp"><command>dprofpp</command></term> +<listitem> <indexterm zone="ch-system-perl dprofpp"><primary sortas="b-dprofpp">dprofpp</primary></indexterm> -<para id="dprofpp"><command>dprofpp</command> displays perl profile data.</para> +<para>displays perl profile data.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="en2cxs"><command>en2cxs</command></term> +<listitem> <indexterm zone="ch-system-perl en2cxs"><primary sortas="b-en2cxs">en2cxs</primary></indexterm> -<para id="en2cxs"><command>en2cxs</command> builds a Perl extension for the Encode module, +<para>builds a Perl extension for the Encode module, from either Unicode Character Mappings or Tcl Encoding Files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="find2perl"><command>find2perl</command></term> +<listitem> <indexterm zone="ch-system-perl find2perl"><primary sortas="b-find2perl">find2perl</primary></indexterm> -<para id="find2perl"><command>find2perl</command> translates find commands to perl.</para> +<para>translates find commands to perl.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="h2ph"><command>h2ph</command></term> +<listitem> <indexterm zone="ch-system-perl h2ph"><primary sortas="b-h2ph">h2ph</primary></indexterm> -<para id="h2ph"><command>h2ph</command> converts .h C header files to .ph Perl header files.</para> +<para>converts .h C header files to .ph Perl header files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="h2xs"><command>h2xs</command></term> +<listitem> <indexterm zone="ch-system-perl h2xs"><primary sortas="b-h2xs">h2xs</primary></indexterm> -<para id="h2xs"><command>h2xs</command> converts .h C header files to Perl extensions.</para> +<para>converts .h C header files to Perl extensions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libnetcfg"><command>libnetcfg</command></term> +<listitem> <indexterm zone="ch-system-perl libnetcfg"><primary sortas="b-libnetcfg">libnetcfg</primary></indexterm> -<para id="libnetcfg"><command>libnetcfg</command> can be used to configure the libnet.</para> +<para>can be used to configure the libnet.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="perl"><command>perl</command></term> +<listitem> <indexterm zone="ch-system-perl perl"><primary sortas="b-perl">perl</primary></indexterm> -<para id="perl"><command>perl</command> combines some of the best features of C, sed, +<para>combines some of the best features of C, sed, awk and sh into a single swiss-army language.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="perlbug"><command>perlbug</command></term> +<listitem> <indexterm zone="ch-system-perl perlbug"><primary sortas="b-perlbug">perlbug</primary></indexterm> -<para id="perlbug"><command>perlbug</command> is used to generate bug reports about +<para>is used to generate bug reports about Perl or the modules that come with it, and mail them.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="perlcc"><command>perlcc</command></term> +<listitem> <indexterm zone="ch-system-perl perlcc"><primary sortas="b-perlcc">perlcc</primary></indexterm> -<para id="perlcc"><command>perlcc</command> generates executables from Perl programs.</para> +<para>generates executables from Perl programs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="perldoc"><command>perldoc</command></term> +<listitem> <indexterm zone="ch-system-perl perldoc"><primary sortas="b-perldoc">perldoc</primary></indexterm> -<para id="perldoc"><command>perldoc</command> displays a piece of documentation in pod +<para>displays a piece of documentation in pod format that is embedded in the perl installation tree or in a perl script.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="perlivp"><command>perlivp</command></term> +<listitem> <indexterm zone="ch-system-perl perlivp"><primary sortas="b-perlivp">perlivp</primary></indexterm> -<para id="perlivp"><command>perlivp</command> is the Perl Installation Verification -Procedure. It can be used to verify that Perl and its libraries have been -installed correctly.</para> - +<para>is the Perl Installation Verification Procedure. It can be used to verify that +Perl and its libraries have been installed correctly.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="piconv"><command>piconv</command></term> +<listitem> <indexterm zone="ch-system-perl piconv"><primary sortas="b-piconv">piconv</primary></indexterm> -<para id="piconv"><command>piconv</command> is a Perl version of the character encoding +<para>is a Perl version of the character encoding converter <command>iconv</command>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pl2pm"><command>pl2pm</command></term> +<listitem> <indexterm zone="ch-system-perl pl2pm"><primary sortas="b-pl2pm">pl2pm</primary></indexterm> -<para id="pl2pm"><command>pl2pm</command> is a rough tool for converting Perl4 .pl -files to Perl5 .pm modules.</para> +<para>is a rough tool for converting Perl4 .pl files to Perl5 .pm modules.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pod2html"><command>pod2html</command></term> +<listitem> <indexterm zone="ch-system-perl pod2html"><primary sortas="b-pod2html">pod2html</primary></indexterm> -<para id="pod2html"><command>pod2html</command> converts files from pod format to HTML -format.</para> +<para>converts files from pod format to HTML format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pod2latex"><command>pod2latex</command></term> +<listitem> <indexterm zone="ch-system-perl pod2latex"><primary sortas="b-pod2latex">pod2latex</primary></indexterm> -<para id="pod2latex"><command>pod2latex</command> converts files from pod format to LaTeX -format.</para> +<para>converts files from pod format to LaTeX format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pod2man"><command>pod2man</command></term> +<listitem> <indexterm zone="ch-system-perl pod2man"><primary sortas="b-pod2man">pod2man</primary></indexterm> -<para id="pod2man"><command>pod2man</command> converts pod data to formatted *roff -input.</para> +<para>converts pod data to formatted *roff input.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pod2text"><command>pod2text</command></term> +<listitem> <indexterm zone="ch-system-perl pod2text"><primary sortas="b-pod2text">pod2text</primary></indexterm> -<para id="pod2text"><command>pod2text</command> converts pod data to formatted ASCII -text.</para> +<para>converts pod data to formatted ASCII text.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pod2usage"><command>pod2usage</command></term> +<listitem> <indexterm zone="ch-system-perl pod2usage"><primary sortas="b-pod2usage">pod2usage</primary></indexterm> -<para id="pod2usage"><command>pod2usage</command> prints usage messages from embedded -pod docs in files.</para> +<para>prints usage messages from embedded pod docs in files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="podchecker"><command>podchecker</command></term> +<listitem> <indexterm zone="ch-system-perl podchecker"><primary sortas="b-podchecker">podchecker</primary></indexterm> -<para id="podchecker"><command>podchecker</command> checks the syntax of pod format -documentation files.</para> +<para>checks the syntax of pod format documentation files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="podselect"><command>podselect</command></term> +<listitem> <indexterm zone="ch-system-perl podselect"><primary sortas="b-podselect">podselect</primary></indexterm> -<para id="podselect"><command>podselect</command> displays selected sections of pod -documentation.</para> +<para>displays selected sections of pod documentation.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="psed"><command>psed</command></term> +<listitem> <indexterm zone="ch-system-perl psed"><primary sortas="b-psed">psed</primary></indexterm> -<para id="psed"><command>psed</command> is a Perl version of the stream editor -<userinput>sed</userinput>.</para> +<para>is a Perl version of the stream editor <userinput>sed</userinput>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pstruct"><command>pstruct</command></term> +<listitem> <indexterm zone="ch-system-perl pstruct"><primary sortas="b-pstruct">pstruct</primary></indexterm> -<para id="pstruct"><command>pstruct</command> dumps C structures as generated from -"cc -g -S" stabs.</para> +<para>dumps C structures as generated from "cc -g -S" stabs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="s2p"><command>s2p</command></term> +<listitem> <indexterm zone="ch-system-perl s2p"><primary sortas="b-s2p">s2p</primary></indexterm> -<para id="s2p"><command>s2p</command> translates sed to perl.</para> +<para>translates sed to perl.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="splain"><command>splain</command></term> +<listitem> <indexterm zone="ch-system-perl splain"><primary sortas="b-splain">splain</primary></indexterm> -<para id="splain"><command>splain</command> is used to force verbose warning +<para>is used to force verbose warning diagnostics in perl.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="xsubpp"><command>xsubpp</command></term> +<listitem> <indexterm zone="ch-system-perl xsubpp"><primary sortas="b-xsubpp">xsubpp</primary></indexterm> -<para id="xsubpp"><command>xsubpp</command> converts Perl XS code into C code.</para> +<para>converts Perl XS code into C code.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/procps.xml b/chapter06/procps.xml index be44ace51..9444b9eef 100644 --- a/chapter06/procps.xml +++ b/chapter06/procps.xml @@ -43,83 +43,152 @@ Make, Ncurses</seg></seglistitem> </sect2> -<sect2 id="contents-procps"><title>Contents of Procps</title> - -<para><emphasis>Installed programs</emphasis>: free, kill, pgrep, pkill, -pmap, ps, skill, snice, sysctl, tload, top, uptime, vmstat, w and watch</para> - -<para><emphasis>Installed library</emphasis>: libproc.so</para> - -</sect2> +<sect2 id="contents-procps" role="content"><title>Contents of Procps</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<segtitle>Installed library</segtitle> +<seglistitem><seg>free, kill, pgrep, pkill, +pmap, ps, skill, snice, sysctl, tload, top, uptime, vmstat, w and watch</seg> +<seg>libproc.so</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="free"><command>free</command></term> +<listitem> <indexterm zone="ch-system-procps free"><primary sortas="b-free">free</primary></indexterm> -<para id="free"><command>free</command> reports the amount of free and used memory +<para>reports the amount of free and used memory in the system, both physical and swap memory.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="kill"><command>kill</command></term> +<listitem> <indexterm zone="ch-system-procps kill"><primary sortas="b-kill">kill</primary></indexterm> -<para id="kill"><command>kill</command> is used to send signals to processes.</para> +<para>is used to send signals to processes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pgrep"><command>pgrep</command></term> +<listitem> <indexterm zone="ch-system-procps pgrep"><primary sortas="b-pgrep">pgrep</primary></indexterm> -<para id="pgrep"><command>pgrep</command> looks up processes based on their name -and other attributes.</para> +<para>looks up processes based on their name and other attributes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pkill"><command>pkill</command></term> +<listitem> <indexterm zone="ch-system-procps pkill"><primary sortas="b-pkill">pkill</primary></indexterm> -<para id="pkill"><command>pkill</command> signals processes based on their name -and other attributes.</para> +<para>signals processes based on their name and other attributes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pmap"><command>pmap</command></term> +<listitem> <indexterm zone="ch-system-procps pmap"><primary sortas="b-pmap">pmap</primary></indexterm> -<para id="pmap"><command>pmap</command> reports the memory map of the given -process.</para> +<para>reports the memory map of the given process.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ps"><command>ps</command></term> +<listitem> <indexterm zone="ch-system-procps ps"><primary sortas="b-ps">ps</primary></indexterm> -<para id="ps"><command>ps</command> gives a snapshot of the current processes.</para> +<para>gives a snapshot of the current processes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="skill"><command>skill</command></term> +<listitem> <indexterm zone="ch-system-procps skill"><primary sortas="b-skill">skill</primary></indexterm> -<para id="skill"><command>skill</command> sends signals to processes matching the -given criteria.</para> +<para>sends signals to processes matching the given criteria.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="snice"><command>snice</command></term> +<listitem> <indexterm zone="ch-system-procps snice"><primary sortas="b-snice">snice</primary></indexterm> -<para id="snice"><command>snice</command> changes the scheduling priority of processes -matching the given criteria.</para> +<para>changes the scheduling priority of processes matching the given criteria.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sysctl"><command>sysctl</command></term> +<listitem> <indexterm zone="ch-system-procps sysctl"><primary sortas="b-sysctl">sysctl</primary></indexterm> -<para id="sysctl"><command>sysctl</command> modifies kernel parameters at run time.</para> +<para>modifies kernel parameters at run time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tload"><command>tload</command></term> +<listitem> <indexterm zone="ch-system-procps tload"><primary sortas="b-tload">tload</primary></indexterm> -<para id="tload"><command>tload</command> prints a graph of the current system load -average.</para> +<para>prints a graph of the current system load average.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="top"><command>top</command></term> +<listitem> <indexterm zone="ch-system-procps top"><primary sortas="b-top">top</primary></indexterm> -<para id="top"><command>top</command> displays the top CPU processes. It provides +<para>displays the top CPU processes. It provides an ongoing look at processor activity in real time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="uptime"><command>uptime</command></term> +<listitem> <indexterm zone="ch-system-procps uptime"><primary sortas="b-uptime">uptime</primary></indexterm> -<para id="uptime"><command>uptime</command> reports how long the system has been +<para>reports how long the system has been running, how many users are logged on, and the system load averages.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vmstat"><command>vmstat</command></term> +<listitem> <indexterm zone="ch-system-procps vmstat"><primary sortas="b-vmstat">vmstat</primary></indexterm> -<para id="vmstat"><command>vmstat</command> reports virtual memory statistics, giving -information about processes, memory, paging, block IO, traps, and CPU -activity.</para> - +<para>reports virtual memory statistics, giving information about processes, +memory, paging, block IO, traps, and CPU activity.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="w"><command>w</command></term> +<listitem> <indexterm zone="ch-system-procps w"><primary sortas="b-w">w</primary></indexterm> -<para id="w"><command>w</command> shows which users are currently logged on, -where and since when.</para> +<para>shows which users are currently logged on, where and since when.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="watch"><command>watch</command></term> +<listitem> <indexterm zone="ch-system-procps watch"><primary sortas="b-watch">watch</primary></indexterm> -<para id="watch"><command>watch</command> runs a given command repeatedly, -displaying the first screen-full of its output. This allows you to watch the -output change over time.</para> - +<para>runs a given command repeatedly, displaying the first screen-full of its +output. This allows you to watch the output change over time.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="libproc"><command>libproc</command></term> +<listitem> <indexterm zone="ch-system-procps libproc"><primary sortas="c-libproc">libproc</primary></indexterm> -<para id="libproc"><command>libproc</command> contains the functions used by most -programs in this package.</para> +<para>contains the functions used by most programs in this package.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/psmisc.xml b/chapter06/psmisc.xml index dff3897cd..99fce8c68 100644 --- a/chapter06/psmisc.xml +++ b/chapter06/psmisc.xml @@ -72,33 +72,49 @@ creating the following symlink:</para> </sect2> -<sect2 id="contents-psmisc"><title>Contents of Psmisc</title> - -<para><emphasis>Installed programs</emphasis>: fuser, killall, pstree and -pstree.x11 (link to pstree)</para> - -</sect2> +<sect2 id="contents-psmisc" role="content"><title>Contents of Psmisc</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>fuser, killall, pstree and pstree.x11 (link to pstree)</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="fuser"><command>fuser</command></term> +<listitem> <indexterm zone="ch-system-psmisc fuser"><primary sortas="b-fuser">fuser</primary></indexterm> -<para id="fuser"><command>fuser</command> reports the PIDs of processes that use -the given files or file systems.</para> +<para>reports the PIDs of processes that use the given files or file systems.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="killall"><command>killall</command></term> +<listitem> <indexterm zone="ch-system-psmisc killall"><primary sortas="b-killall">killall</primary></indexterm> -<para id="killall"><command>killall</command> kills processes by name. It sends a signal +<para>kills processes by name. It sends a signal to all processes running any of the given commands.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pstree"><command>pstree</command></term> +<listitem> <indexterm zone="ch-system-psmisc pstree"><primary sortas="b-pstree">pstree</primary></indexterm> -<para id="pstree"><command>pstree</command> displays running processes as a tree.</para> +<para>displays running processes as a tree.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pstree.x11"><command>pstree.x11</command></term> +<listitem> <indexterm zone="ch-system-psmisc pstree.x11"><primary sortas="b-pstree.x11">pstree.x11</primary></indexterm> -<para id="pstree.x11"><command>pstree.x11</command> same as pstree except that it waits for -confirmation before exiting.</para> +<para>same as pstree except that it waits for confirmation before exiting.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/readline.xml b/chapter06/readline.xml index f69af4fe0..5884b1d05 100644 --- a/chapter06/readline.xml +++ b/chapter06/readline.xml @@ -63,8 +63,11 @@ ln -sf ../../lib/libreadline.so.4 /usr/lib/libreadline.so</userinput></screen> </sect2> -<sect2 id="contents-readline"><title>Contents of Readline</title> -<para><emphasis>Installed libraries</emphasis>: Not checked.</para> +<sect2 id="contents-readline" role="content"><title>Contents of Readline</title> +<segmentedlist> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>Not checked</seg></seglistitem> +</segmentedlist> </sect2> diff --git a/chapter06/sed.xml b/chapter06/sed.xml index a37aea312..9bb01facc 100644 --- a/chapter06/sed.xml +++ b/chapter06/sed.xml @@ -46,18 +46,23 @@ Diffutils, GCC, Gettext, Glibc, Grep, Make, Texinfo</seg></seglistitem> </sect2> -<sect2 id="contents-sed"><title>Contents of Sed</title> - -<para><emphasis>Installed program</emphasis>: sed</para> - -</sect2> +<sect2 id="contents-sed" role="content"><title>Contents of Sed</title> +<segmentedlist> +<segtitle>Installed program</segtitle> +<seglistitem><seg>sed</seg></seglistitem> +</segmentedlist> -<sect2><title>Short description</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="sed"><command>sed</command></term> +<listitem> <indexterm zone="ch-system-sed sed"><primary sortas="b-sed">sed</primary></indexterm> -<para id="sed"><command>sed</command> is used to filter and transform text files -in a single pass.</para> +<para>is used to filter and transform text files in a single pass.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> diff --git a/chapter06/shadow.xml b/chapter06/shadow.xml index d8ba3bb25..04f988a99 100644 --- a/chapter06/shadow.xml +++ b/chapter06/shadow.xml @@ -140,152 +140,297 @@ any group passwords with the <command>gpasswd</command> command.</para> </sect2> -<sect2 id="contents-shadow"><title>Contents of Shadow</title> +<sect2 id="contents-shadow" role="content"><title>Contents of Shadow</title> -<para><emphasis>Installed programs</emphasis>: chage, chfn, chpasswd, chsh, -dpasswd, expiry, faillog, gpasswd, groupadd, groupdel, groupmod, groups, grpck, -grpconv, grpunconv, lastlog, login, logoutd, mkpasswd, newgrp, newusers, -passwd, pwck, pwconv, pwunconv, sg (link to newgrp), useradd, userdel, usermod, -vigr (link to vipw) and vipw</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>chage, chfn, chpasswd, chsh, dpasswd, expiry, faillog, +gpasswd, groupadd, groupdel, groupmod, groups, grpck, grpconv, grpunconv, +lastlog, login, logoutd, mkpasswd, newgrp, newusers, passwd, pwck, pwconv, +pwunconv, sg (link to newgrp), useradd, userdel, usermod, vigr (link to vipw) and +vipw</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="chage"><command>chage</command></term> +<listitem> <indexterm zone="ch-system-shadow chage"><primary sortas="b-chage">chage</primary></indexterm> -<para id="chage"><command>chage</command> is used to change the maximum number of +<para>is used to change the maximum number of days between obligatory password changes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chfn"><command>chfn</command></term> +<listitem> <indexterm zone="ch-system-shadow chfn"><primary sortas="b-chfn">chfn</primary></indexterm> -<para id="chfn"><command>chfn</command> is used to change a user's full name and -some other info.</para> +<para>is used to change a user's full name and some other info.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chpasswd"><command>chpasswd</command></term> +<listitem> <indexterm zone="ch-system-shadow chpasswd"><primary sortas="b-chpasswd">chpasswd</primary></indexterm> -<para id="chpasswd"><command>chpasswd</command> is used to update the passwords of a +<para>is used to update the passwords of a whole series of user accounts in one go.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chsh"><command>chsh</command></term> +<listitem> <indexterm zone="ch-system-shadow chsh"><primary sortas="b-chsh">chsh</primary></indexterm> -<para id="chsh"><command>chsh</command> is used to change a user's default - login shell.</para> +<para>is used to change a user's default login shell.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dpasswd"><command>dpasswd</command></term> +<listitem> <indexterm zone="ch-system-shadow dpasswd"><primary sortas="b-dpasswd">dpasswd</primary></indexterm> -<para id="dpasswd"><command>dpasswd</command> is used to change dial-up passwords for -user login shells.</para> +<para>is used to change dial-up passwords for user login shells.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="expiry"><command>expiry</command></term> +<listitem> <indexterm zone="ch-system-shadow expiry"><primary sortas="b-expiry">expiry</primary></indexterm> -<para id="expiry"><command>expiry</command> checks and enforces the current password -expiration policy.</para> +<para>checks and enforces the current password expiration policy.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="faillog"><command>faillog</command></term> +<listitem> <indexterm zone="ch-system-shadow faillog"><primary sortas="b-faillog">faillog</primary></indexterm> -<para id="faillog"><command>faillog</command> is used to examine the log of login -failures, to set a maximum number of failures before an account is blocked, -or to reset the failure count.</para> - +<para>is used to examine the log of login failures, to set a maximum number of +failures before an account is blocked, or to reset the failure count.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="gpasswd"><command>gpasswd</command></term> +<listitem> <indexterm zone="ch-system-shadow gpasswd"><primary sortas="b-gpasswd">gpasswd</primary></indexterm> -<para id="gpasswd"><command>gpasswd</command> is used to add and delete members and -administrators to groups.</para> +<para>is used to add and delete members and administrators to groups.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groupadd"><command>groupadd</command></term> +<listitem> <indexterm zone="ch-system-shadow groupadd"><primary sortas="b-groupadd">groupadd</primary></indexterm> -<para id="groupadd"><command>groupadd</command> creates a group with the given -name.</para> +<para>creates a group with the given name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groupdel"><command>groupdel</command></term> +<listitem> <indexterm zone="ch-system-shadow groupdel"><primary sortas="b-groupdel">groupdel</primary></indexterm> -<para id="groupdel"><command>groupdel</command> deletes the group with the given -name.</para> +<para>deletes the group with the given name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groupmod"><command>groupmod</command></term> +<listitem> <indexterm zone="ch-system-shadow groupmod"><primary sortas="b-groupmod">groupmod</primary></indexterm> -<para id="groupmod"><command>groupmod</command> is used to modify the given group's -name or GID.</para> +<para>is used to modify the given group's name or GID.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groups"><command>groups</command></term> +<listitem> <indexterm zone="ch-system-shadow groups"><primary sortas="b-groups">groups</primary></indexterm> -<para id="groups"><command>groups</command> reports the groups of which the given -users are members.</para> +<para>reports the groups of which the given users are members.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grpck"><command>grpck</command></term> +<listitem> <indexterm zone="ch-system-shadow grpck"><primary sortas="b-grpck">grpck</primary></indexterm> -<para id="grpck"><command>grpck</command> verifies the integrity of the group files, -<filename>/etc/group</filename> and <filename>/etc/gshadow</filename>.</para> - +<para>verifies the integrity of the group files, <filename>/etc/group</filename> +and <filename>/etc/gshadow</filename>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="grpconv"><command>grpconv</command></term> +<listitem> <indexterm zone="ch-system-shadow grpconv"><primary sortas="b-grpconv">grpconv</primary></indexterm> -<para id="grpconv"><command>grpconv</command> creates or updates the shadow group file -from the normal group file.</para> +<para>creates or updates the shadow group file from the normal group file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grpunconv"><command>grpunconv</command></term> +<listitem> <indexterm zone="ch-system-shadow grpunconv"><primary sortas="b-grpunconv">grpunconv</primary></indexterm> -<para id="grpunconv"><command>grpunconv</command> updates <filename>/etc/group</filename> +<para>updates <filename>/etc/group</filename> from <filename>/etc/gshadow</filename> and then deletes the latter.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lastlog"><command>lastlog</command></term> +<listitem> <indexterm zone="ch-system-shadow lastlog"><primary sortas="b-lastlog">lastlog</primary></indexterm> -<para id="lastlog"><command>lastlog</command> reports the most recent login of all -users, or of a given user.</para> +<para>reports the most recent login of all users, or of a given user.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="login"><command>login</command></term> +<listitem> <indexterm zone="ch-system-shadow login"><primary sortas="b-login">login</primary></indexterm> -<para id="login"><command>login</command> is used by the system to let users sign on.</para> +<para>is used by the system to let users sign on.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="logoutd"><command>logoutd</command></term> +<listitem> <indexterm zone="ch-system-shadow logoutd"><primary sortas="b-logoutd">logoutd</primary></indexterm> -<para id="logoutd"><command>logoutd</command> is a daemon used to enforce restrictions -on log-on time and ports.</para> +<para>is a daemon used to enforce restrictions on log-on time and ports.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkpasswd"><command>mkpasswd</command></term> +<listitem> <indexterm zone="ch-system-shadow mkpasswd"><primary sortas="b-mkpasswd">mkpasswd</primary></indexterm> -<para id="mkpasswd"><command>mkpasswd</command> encrypts the given password using the -also given perturbation.</para> +<para>encrypts the given password using the also given perturbation.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="newgrp"><command>newgrp</command></term> +<listitem> <indexterm zone="ch-system-shadow newgrp"><primary sortas="b-newgrp">newgrp</primary></indexterm> -<para id="newgrp"><command>newgrp</command> is used to change the current GID during -a login session.</para> +<para>is used to change the current GID during a login session.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="newusers"><command>newusers</command></term> +<listitem> <indexterm zone="ch-system-shadow newusers"><primary sortas="b-newusers">newusers</primary></indexterm> -<para id="newusers"><command>newusers</command> is used to create or update a whole -series of user accounts in one go.</para> +<para>is used to create or update a whole series of user accounts in one go.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="passwd"><command>passwd</command></term> +<listitem> <indexterm zone="ch-system-shadow passwd"><primary sortas="b-passwd">passwd</primary></indexterm> -<para id="passwd"><command>passwd</command> is used to change the password for a user -or group account.</para> +<para>is used to change the password for a user or group account.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pwck"><command>pwck</command></term> +<listitem> <indexterm zone="ch-system-shadow pwck"><primary sortas="b-pwck">pwck</primary></indexterm> -<para id="pwck"><command>pwck</command> verifies the integrity of the password files, +<para>verifies the integrity of the password files, <filename>/etc/passwd</filename> and <filename>/etc/shadow</filename>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pwconv"><command>pwconv</command></term> +<listitem> <indexterm zone="ch-system-shadow pwconv"><primary sortas="b-pwconv">pwconv</primary></indexterm> -<para id="pwconv"><command>pwconv</command> creates or updates the shadow password file +<para>creates or updates the shadow password file from the normal password file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pwunconv"><command>pwunconv</command></term> +<listitem> <indexterm zone="ch-system-shadow pwunconv"><primary sortas="b-pwunconv">pwunconv</primary></indexterm> -<para id="pwunconv"><command>pwunconv</command> updates <filename>/etc/passwd</filename> +<para>updates <filename>/etc/passwd</filename> from <filename>/etc/shadow</filename> and then deletes the latter.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sg"><command>sg</command></term> +<listitem> <indexterm zone="ch-system-shadow sg"><primary sortas="b-sg">sg</primary></indexterm> -<para id="sg"><command>sg</command> executes a given command while the user's GID +<para>executes a given command while the user's GID is set to that of the given group.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="useradd"><command>useradd</command></term> +<listitem> <indexterm zone="ch-system-shadow useradd"><primary sortas="b-useradd">useradd</primary></indexterm> -<para id="useradd"><command>useradd</command> creates a new user with the given name, +<para>creates a new user with the given name, or updates the default new-user information.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="userdel"><command>userdel</command></term> +<listitem> <indexterm zone="ch-system-shadow userdel"><primary sortas="b-userdel">userdel</primary></indexterm> -<para id="userdel"><command>userdel</command> deletes the given user account.</para> +<para>deletes the given user account.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="usermod"><command>usermod</command></term> +<listitem> <indexterm zone="ch-system-shadow usermod"><primary sortas="b-usermod">usermod</primary></indexterm> -<para id="usermod"><command>usermod</command> is used to modify the given user's -login name, UID (User Identification), shell, initial group, home directory, and the like.</para> - +<para>is used to modify the given user's login name, UID (User Identification), +shell, initial group, home directory, and the like.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="vigr"><command>vigr</command></term> +<listitem> <indexterm zone="ch-system-shadow vigr"><primary sortas="b-vigr">vigr</primary></indexterm> -<para id="vigr"><command>vigr</command> can be used to edit the -<filename>/etc/group</filename> or <filename>/etc/gshadow</filename> -files.</para> - +<para>can be used to edit the <filename>/etc/group</filename> or +<filename>/etc/gshadow</filename> files.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="vipw"><command>vipw</command></term> +<listitem> <indexterm zone="ch-system-shadow vipw"><primary sortas="b-vipw">vipw</primary></indexterm> -<para id="vipw"><command>vipw</command> can be used to edit the -<filename>/etc/passwd</filename> or <filename>/etc/shadow</filename> -files.</para> - +<para>can be used to edit the <filename>/etc/passwd</filename> or +<filename>/etc/shadow</filename> files.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="libmisc"><command>libmisc</command></term> +<listitem> <indexterm zone="ch-system-shadow libmisc"><primary sortas="c-libmisc">libmisc</primary></indexterm> -<para id="libmisc"><command>libmisc</command>...</para> +<para>...</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="libshadow"><command>libshadow</command></term> +<listitem> <indexterm zone="ch-system-shadow libshadow"><primary sortas="c-libshadow">libshadow</primary></indexterm> -<para id="libshadow"><command>libshadow</command> contains functions used by most -programs in this package.</para> +<para>contains functions used by most programs in this package.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/sysklogd.xml b/chapter06/sysklogd.xml index 7ef354519..c1a10c5bf 100644 --- a/chapter06/sysklogd.xml +++ b/chapter06/sysklogd.xml @@ -77,27 +77,35 @@ user.* -/var/log/user.log </sect2> -<sect2 id="contents-sysklogd"><title>Contents of Sysklogd</title> - -<para><emphasis>Installed programs</emphasis>: klogd and syslogd</para> - -</sect2> +<sect2 id="contents-sysklogd" role="content"><title>Contents of Sysklogd</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>klogd and syslogd</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="klogd"><command>klogd</command></term> +<listitem> <indexterm zone="ch-system-sysklogd klogd"><primary sortas="b-klogd">klogd</primary></indexterm> -<para id="klogd"><command>klogd</command> is a system daemon for intercepting and -logging kernel messages.</para> +<para>is a system daemon for intercepting and logging kernel messages.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="syslogd"><command>syslogd</command></term> +<listitem> <indexterm zone="ch-system-sysklogd syslogd"><primary sortas="b-syslogd">syslogd</primary></indexterm> -<para id="syslogd"><command>syslogd</command> logs the messages that system programs +<para>logs the messages that system programs offer for logging. Every logged message contains at least a date stamp and a hostname, and normally the program's name too, but that depends on how trusting the logging daemon is told to be.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/sysvinit.xml b/chapter06/sysvinit.xml index 8c3cb6c8e..31095948d 100644 --- a/chapter06/sysvinit.xml +++ b/chapter06/sysvinit.xml @@ -103,83 +103,152 @@ speakers.</para> </sect2> -<sect2 id="contents-sysvinit"><title>Contents of Sysvinit</title> - -<para><emphasis>Installed programs</emphasis>: halt, init, killall5, last, -lastb (link to last), mesg, pidof (link to killall5), poweroff (link to halt), -reboot (link to halt), runlevel, shutdown, sulogin, telinit (link to init), -utmpdump and wall</para> - -</sect2> +<sect2 id="contents-sysvinit" role="content"><title>Contents of Sysvinit</title> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>halt, init, killall5, last, lastb (link to last), mesg, pidof (link to +killall5), poweroff (link to halt), reboot (link to halt), runlevel, shutdown, sulogin, telinit +(link to init), utmpdump and wall</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="halt"><command>halt</command></term> +<listitem> <indexterm zone="ch-system-sysvinit halt"><primary sortas="b-halt">halt</primary></indexterm> -<para id="halt"><command>halt</command> normally invokes shutdown with the -h flag, +<para>normally invokes shutdown with the -h flag, except when already in run-level 0, then it tells the kernel to halt the system. But first it notes in the file <filename>/var/log/wtmp</filename> that the system is being brought down.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="init"><command>init</command></term> +<listitem> <indexterm zone="ch-system-sysvinit init"><primary sortas="b-init">init</primary></indexterm> -<para id="init"><command>init</command> is the mother of all processes. It reads its +<para>is the mother of all processes. It reads its commands from <filename>/etc/inittab</filename>, which normally tell it which scripts to run for which run-level, and how many gettys to spawn.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="killall5"><command>killall5</command></term> +<listitem> <indexterm zone="ch-system-sysvinit killall5"><primary sortas="b-killall5">killall5</primary></indexterm> -<para id="killall5"><command>killall5</command> sends a signal to all processes, except -the processes in its own session -- so it won't kill the shell running the -script that called it.</para> - +<para>sends a signal to all processes, except the processes in its own session -- +so it won't kill the shell running the script that called it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="last"><command>last</command></term> +<listitem> <indexterm zone="ch-system-sysvinit last"><primary sortas="b-last">last</primary></indexterm> -<para id="last"><command>last</command> shows which users last logged in (and out), +<para>shows which users last logged in (and out), searching back through the file <filename>/var/log/wtmp</filename>. It can also show system boots and shutdowns, and run-level changes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lastb"><command>lastb</command></term> +<listitem> <indexterm zone="ch-system-sysvinit lastb"><primary sortas="b-lastb">lastb</primary></indexterm> -<para id="lastb"><command>lastb</command> shows the failed login attempts, as logged -in <filename>/var/log/btmp</filename>.</para> - +<para>shows the failed login attempts, as logged in +<filename>/var/log/btmp</filename>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="mesg"><command>mesg</command></term> +<listitem> <indexterm zone="ch-system-sysvinit mesg"><primary sortas="b-mesg">mesg</primary></indexterm> -<para id="mesg"><command>mesg</command> controls whether other users can send +<para>controls whether other users can send messages to the current user's terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pidof"><command>pidof</command></term> +<listitem> <indexterm zone="ch-system-sysvinit pidof"><primary sortas="b-pidof">pidof</primary></indexterm> -<para id="pidof"><command>pidof</command> reports the PIDs of the given programs.</para> +<para>reports the PIDs of the given programs.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="poweroff"><command>poweroff</command></term> +<listitem> <indexterm zone="ch-system-sysvinit poweroff"><primary sortas="b-poweroff">poweroff</primary></indexterm> -<para id="poweroff"><command>poweroff</command> tells the kernel to halt the system and +<para>tells the kernel to halt the system and switch off the computer. But see halt.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="reboot"><command>reboot</command></term> +<listitem> <indexterm zone="ch-system-sysvinit reboot"><primary sortas="b-reboot">reboot</primary></indexterm> -<para id="reboot"><command>reboot</command> tells the kernel to reboot the system. -But see halt.</para> +<para>tells the kernel to reboot the system. But see halt.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="runlevel"><command>runlevel</command></term> +<listitem> <indexterm zone="ch-system-sysvinit runlevel"><primary sortas="b-runlevel">runlevel</primary></indexterm> -<para id="runlevel"><command>runlevel</command> reports the previous and the current -run-level, as noted in the last run-level record in -<filename>/var/run/utmp</filename>.</para> - +<para>reports the previous and the current run-level, as noted in the last run-level +record in <filename>/var/run/utmp</filename>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="shutdown"><command>shutdown</command></term> +<listitem> <indexterm zone="ch-system-sysvinit shutdown"><primary sortas="b-shutdown">shutdown</primary></indexterm> -<para id="shutdown"><command>shutdown</command> brings the system down in a secure way, +<para>brings the system down in a secure way, signaling all processes and notifying all logged-in users.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sulogin"><command>sulogin</command></term> +<listitem> <indexterm zone="ch-system-sysvinit sulogin"><primary sortas="b-sulogin">sulogin</primary></indexterm> -<para id="sulogin"><command>sulogin</command> allows the superuser to log in. It is +<para>allows the superuser to log in. It is normally invoked by init when the system goes into single user mode.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="telinit"><command>telinit</command></term> +<listitem> <indexterm zone="ch-system-sysvinit telinit"><primary sortas="b-telinit">telinit</primary></indexterm> -<para id="telinit"><command>telinit</command> tells init which run-level to enter.</para> +<para>tells init which run-level to enter.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="utmpdump"><command>utmpdump</command></term> +<listitem> <indexterm zone="ch-system-sysvinit utmpdump"><primary sortas="b-utmpdump">utmpdump</primary></indexterm> -<para id="utmpdump"><command>utmpdump</command> displays the content of the given login -file in a friendlier format.</para> +<para>displays the content of the given login file in a friendlier format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="wall"><command>wall</command></term> +<listitem> <indexterm zone="ch-system-sysvinit wall"><primary sortas="b-wall">wall</primary></indexterm> -<para id="wall"><command>wall</command> writes a message to all logged-in users.</para> +<para>writes a message to all logged-in users.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/tar.xml b/chapter06/tar.xml index f8a8a856e..1d457bf1f 100644 --- a/chapter06/tar.xml +++ b/chapter06/tar.xml @@ -46,24 +46,33 @@ Diffutils, GCC, Gettext, Glibc, Grep, Make, Sed</seg></seglistitem> </sect2> -<sect2 id="contents-tar"><title>Contents of Tar</title> +<sect2 id="contents-tar" role="content"><title>Contents of Tar</title> -<para><emphasis>Installed programs</emphasis>: rmt and tar</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>rmt and tar</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="rmt"><command>rmt</command></term> +<listitem> <indexterm zone="ch-system-tar rmt"><primary sortas="b-rmt">rmt</primary></indexterm> -<para id="rmt"><command>rmt</command> is used to remotely manipulate a magnetic +<para>is used to remotely manipulate a magnetic tape drive, through an interprocess communication connection.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tar"><command>tar</command></term> +<listitem> <indexterm zone="ch-system-tar tar"><primary sortas="b-tar">tar</primary></indexterm> -<para id="tar"><command>tar</command> is used to create and extract files from -archives, also known as tarballs.</para> +<para>is used to create and extract files from archives, also known as tarballs.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/texinfo.xml b/chapter06/texinfo.xml index ea985184e..524423ad0 100644 --- a/chapter06/texinfo.xml +++ b/chapter06/texinfo.xml @@ -73,41 +73,70 @@ done</userinput></screen> </sect2> -<sect2 id="contents-texinfo"><title>Contents of Texinfo</title> +<sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title> -<para><emphasis>Installed programs</emphasis>: info, infokey, install-info, -makeinfo, texi2dvi and texindex</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>info, infokey, install-info, +makeinfo, texi2dvi and texindex</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="info"><command>info</command></term> +<listitem> <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm> -<para id="info"><command>info</command> is used to read Info documents. Info +<para>is used to read Info documents. Info documents are a bit like man pages, but often go much deeper than just explaining all the flags. Compare for example man tar and info tar.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="infokey"><command>infokey</command></term> +<listitem> <indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm> -<para id="infokey"><command>infokey</command> compiles a source file containing Info +<para>compiles a source file containing Info customizations into a binary format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="install-info"><command>install-info</command></term> +<listitem> <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm> -<para id="install-info"><command>install-info</command> is used to install Info files. It -updates entries in the Info index file.</para> +<para>is used to install Info files. It updates entries in the Info index file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="makeinfo"><command>makeinfo</command></term> +<listitem> <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm> -<para id="makeinfo"><command>makeinfo</command> translates the given Texinfo source +<para>translates the given Texinfo source documents into various other formats: Info files, plain text, or HTML.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="texi2dvi"><command>texi2dvi</command></term> +<listitem> <indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm> -<para id="texi2dvi"><command>texi2dvi</command> is used to format the given Texinfo +<para>is used to format the given Texinfo document into a device-independent file that can be printed.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="texindex"><command>texindex</command></term> +<listitem> <indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm> -<para id="texindex"><command>texindex</command> is used to sort Texinfo index files.</para> +<para>is used to sort Texinfo index files.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/udev.xml b/chapter06/udev.xml index 13ea69a28..2c3453bf8 100644 --- a/chapter06/udev.xml +++ b/chapter06/udev.xml @@ -46,7 +46,7 @@ udev binary itself, we correct it's hotplug configuration:</para> </sect2> -<sect2 id="contents-udev"><title>Contents of Udev</title> +<sect2 id="contents-udev" role="content"><title>Contents of Udev</title> <para>Who knows?</para> </sect2> diff --git a/chapter06/util-linux.xml b/chapter06/util-linux.xml index 01c553d31..a1b81dc92 100644 --- a/chapter06/util-linux.xml +++ b/chapter06/util-linux.xml @@ -78,248 +78,530 @@ installed again.</para></listitem> </sect2> -<sect2 id="contents-utillinux"><title>Contents of Util-linux</title> - -<para><emphasis>Installed programs</emphasis>: agetty, arch, blockdev, cal, -cfdisk, chkdupexe, col, colcrt, colrm, column, ctrlaltdel, cytune, ddate, -dmesg, elvtune, fdformat, fdisk, fsck.cramfs, fsck.minix, getopt, hexdump, -hwclock, ipcrm, ipcs, isosize, line, logger, look, losetup, mcookie, mkfs, -mkfs.bfs, mkfs.cramfs, mkfs.minix, mkswap, more, mount, namei, pg, pivot_root, -ramsize (link to rdev), raw, rdev, readprofile, rename, renice, rev, rootflags -(link to rdev), script, setfdprm, setsid, setterm, sfdisk, swapoff (link to -swapon), swapon, tunelp, ul, umount, vidmode (link to rdev), whereis and -write</para> +<sect2 id="contents-utillinux" role="content"><title>Contents of Util-linux</title> -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>agetty, arch, blockdev, cal, cfdisk, chkdupexe, col, colcrt, +colrm, column, ctrlaltdel, cytune, ddate, dmesg, elvtune, fdformat, fdisk, +fsck.cramfs, fsck.minix, getopt, hexdump, hwclock, ipcrm, ipcs, isosize, line, +logger, look, losetup, mcookie, mkfs, mkfs.bfs, mkfs.cramfs, mkfs.minix, mkswap, +more, mount, namei, pg, pivot_root, ramsize (link to rdev), raw, rdev, readprofile, +rename, renice, rev, rootflags (link to rdev), script, setfdprm, setsid, setterm, +sfdisk, swapoff (link to swapon), swapon, tunelp, ul, umount, vidmode (link to rdev), +whereis and write</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="agetty"><command>agetty</command></term> +<listitem> <indexterm zone="ch-system-util-linux agetty"><primary sortas="b-agetty">agetty</primary></indexterm> -<para id="agetty"><command>agetty</command> opens a tty port, prompts for a login name, +<para>opens a tty port, prompts for a login name, and then invokes the login program.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="arch"><command>arch</command></term> +<listitem> <indexterm zone="ch-system-util-linux arch"><primary sortas="b-arch">arch</primary></indexterm> -<para id="arch"><command>arch</command> reports the machine's architecture.</para> +<para>reports the machine's architecture.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="blockdev"><command>blockdev</command></term> +<listitem> <indexterm zone="ch-system-util-linux blockdev"><primary sortas="b-blockdev">blockdev</primary></indexterm> -<para id="blockdev"><command>blockdev</command> allows you to call block device ioctls -from the command line.</para> +<para>allows you to call block device ioctls from the command line.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="cal"><command>cal</command></term> +<listitem> <indexterm zone="ch-system-util-linux cal"><primary sortas="b-cal">cal</primary></indexterm> -<para id="cal"><command>cal</command> displays a simple calendar.</para> +<para>displays a simple calendar.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="cfdisk"><command>cfdisk</command></term> +<listitem> <indexterm zone="ch-system-util-linux cfdisk"><primary sortas="b-cfdisk">cfdisk</primary></indexterm> -<para id="cfdisk"><command>cfdisk</command> is used to manipulate the partition table -of the given device.</para> +<para>is used to manipulate the partition table of the given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="chkdupexe"><command>chkdupexe</command></term> +<listitem> <indexterm zone="ch-system-util-linux chkdupexe"><primary sortas="b-chkdupexe">chkdupexe</primary></indexterm> -<para id="chkdupexe"><command>chkdupexe</command> finds duplicate executables.</para> +<para>finds duplicate executables.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="col"><command>col</command></term> +<listitem> <indexterm zone="ch-system-util-linux col"><primary sortas="b-col">col</primary></indexterm> -<para id="col"><command>col</command> filters out reverse line feeds.</para> +<para>filters out reverse line feeds.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="colcrt"><command>colcrt</command></term> +<listitem> <indexterm zone="ch-system-util-linux colcrt"><primary sortas="b-colcrt">colcrt</primary></indexterm> -<para id="colcrt"><command>colcrt</command> is used to filter nroff output for terminals +<para>is used to filter nroff output for terminals that lack some capabilities such as overstriking and half-lines.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="colrm"><command>colrm</command></term> +<listitem> <indexterm zone="ch-system-util-linux colrm"><primary sortas="b-colrm">colrm</primary></indexterm> -<para id="colrm"><command>colrm</command> filters out the given columns.</para> +<para>filters out the given columns.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="column"><command>column</command></term> +<listitem> <indexterm zone="ch-system-util-linux column"><primary sortas="b-column">column</primary></indexterm> -<para id="column"><command>column</command> formats a given file into multiple -columns.</para> +<para>formats a given file into multiple columns.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ctrlaltdel"><command>ctrlaltdel</command></term> +<listitem> <indexterm zone="ch-system-util-linux ctrlaltdel"><primary sortas="b-ctrlaltdel">ctrlaltdel</primary></indexterm> -<para id="ctrlaltdel"><command>ctrlaltdel</command> sets the function of the Ctrl+Alt+Del - key combination to a hard or a soft reset.</para> - +<para>sets the function of the Ctrl+Alt+Del key combination to a hard or a +soft reset.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="cytune"><command>cytune</command></term> +<listitem> <indexterm zone="ch-system-util-linux cytune"><primary sortas="b-cytune">cytune</primary></indexterm> -<para id="cytune"><command>cytune</command> was used to tune the parameters of the +<para>was used to tune the parameters of the serial line drivers for Cyclades cards.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ddate"><command>ddate</command></term> +<listitem> <indexterm zone="ch-system-util-linux ddate"><primary sortas="b-ddate">ddate</primary></indexterm> -<para id="ddate"><command>ddate</command> gives the Discordian date, or converts the +<para>gives the Discordian date, or converts the given Gregorian date to a Discordian one.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="dmesg"><command>dmesg</command></term> +<listitem> <indexterm zone="ch-system-util-linux dmesg"><primary sortas="b-dmesg">dmesg</primary></indexterm> -<para id="dmesg"><command>dmesg</command> dumps the kernel boot messages.</para> +<para>dumps the kernel boot messages.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="elvtune"><command>elvtune</command></term> +<listitem> <indexterm zone="ch-system-util-linux elvtune"><primary sortas="b-elvtune">elvtune</primary></indexterm> -<para id="elvtune"><command>elvtune</command> can be used to tune the performance +<para>can be used to tune the performance and interactivity of a block device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fdformat"><command>fdformat</command></term> +<listitem> <indexterm zone="ch-system-util-linux fdformat"><primary sortas="b-fdformat">fdformat</primary></indexterm> -<para id="fdformat"><command>fdformat</command> low-level formats a floppy disk.</para> +<para>low-level formats a floppy disk.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fdisk"><command>fdisk</command></term> +<listitem> <indexterm zone="ch-system-util-linux fdisk"><primary sortas="b-fdisk">fdisk</primary></indexterm> -<para id="fdisk"><command>fdisk</command> could be used to manipulate the partition -table of the given device.</para> +<para>could be used to manipulate the partition table of the given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fsck.cramfs"><command>fsck.cramfs</command></term> +<listitem> <indexterm zone="ch-system-util-linux fsck.cramfs"><primary sortas="b-fsck.cramfs">fsck.cramfs</primary></indexterm> -<para id="fsck.cramfs"><command>fsck.cramfs</command> performs a consistency check on the +<para>performs a consistency check on the Cramfs file system on the given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="fsck.minix"><command>fsck.minix</command></term> +<listitem> <indexterm zone="ch-system-util-linux fsck.minix"><primary sortas="b-fsck.minix">fsck.minix</primary></indexterm> -<para id="fsck.minix"><command>fsck.minix</command> performs a consistency check on the +<para>performs a consistency check on the Minix file system on the given device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="getopt"><command>getopt</command></term> +<listitem> <indexterm zone="ch-system-util-linux getopt"><primary sortas="b-getopt">getopt</primary></indexterm> -<para id="getopt"><command>getopt</command> parses options in the given command line.</para> +<para>parses options in the given command line.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hexdump"><command>hexdump</command></term> +<listitem> <indexterm zone="ch-system-util-linux hexdump"><primary sortas="b-hexdump">hexdump</primary></indexterm> -<para id="hexdump"><command>hexdump</command> dumps the given file in hexadecimal, or -in another given format.</para> +<para>dumps the given file in hexadecimal, or in another given format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hwclock"><command>hwclock</command></term> +<listitem> <indexterm zone="ch-system-util-linux hwclock"><primary sortas="b-hwclock">hwclock</primary></indexterm> -<para id="hwclock"><command>hwclock</command> is used to read or set the system's -hardware clock, also called the RTC (Real-Time Clock) or BIOS (Basic Input-Output System) clock.</para> - +<para>is used to read or set the system's hardware clock, also called the RTC +(Real-Time Clock) or BIOS (Basic Input-Output System) clock.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="ipcrm"><command>ipcrm</command></term> +<listitem> <indexterm zone="ch-system-util-linux ipcrm"><primary sortas="b-ipcrm">ipcrm</primary></indexterm> -<para id="ipcrm"><command>ipcrm</command> removes the given IPC resource.</para> +<para>removes the given IPC resource.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ipcs"><command>ipcs</command></term> +<listitem> <indexterm zone="ch-system-util-linux ipcs"><primary sortas="b-ipcs">ipcs</primary></indexterm> -<para id="ipcs"><command>ipcs</command> provides IPC status information.</para> +<para>provides IPC status information.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="isosize"><command>isosize</command></term> +<listitem> <indexterm zone="ch-system-util-linux isosize"><primary sortas="b-isosize">isosize</primary></indexterm> -<para id="isosize"><command>isosize</command> reports the size of an iso9660 -file system.</para> +<para>reports the size of an iso9660 file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="line"><command>line</command></term> +<listitem> <indexterm zone="ch-system-util-linux line"><primary sortas="b-line">line</primary></indexterm> -<para id="line"><command>line</command> copies a single line.</para> +<para>copies a single line.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="logger"><command>logger</command></term> +<listitem> <indexterm zone="ch-system-util-linux logger"><primary sortas="b-logger">logger</primary></indexterm> -<para id="logger"><command>logger</command> enters the given message into the system -log.</para> +<para>enters the given message into the system log.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="look"><command>look</command></term> +<listitem> <indexterm zone="ch-system-util-linux look"><primary sortas="b-look">look</primary></indexterm> -<para id="look"><command>look</command> displays lines that begin with the given -string.</para> +<para>displays lines that begin with the given string.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="losetup"><command>losetup</command></term> +<listitem> <indexterm zone="ch-system-util-linux losetup"><primary sortas="b-losetup">losetup</primary></indexterm> -<para id="losetup"><command>losetup</command> is used to set up and control loop devices.</para> +<para>is used to set up and control loop devices.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mcookie"><command>mcookie</command></term> +<listitem> <indexterm zone="ch-system-util-linux mcookie"><primary sortas="b-mcookie">mcookie</primary></indexterm> -<para id="mcookie"><command>mcookie</command> generates magic cookies, 128-bit random -hexadecimal numbers, for xauth.</para> - +<para>generates magic cookies, 128-bit random hexadecimal numbers, +for xauth.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="mkfs"><command>mkfs</command></term> +<listitem> <indexterm zone="ch-system-util-linux mkfs"><primary sortas="b-mkfs">mkfs</primary></indexterm> -<para id="mkfs"><command>mkfs</command> is used to build a file system on a device +<para>is used to build a file system on a device (usually a hard disk partition).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkfs.bfs"><command>mkfs.bfs</command></term> +<listitem> <indexterm zone="ch-system-util-linux mkfs.bfs"><primary sortas="b-mkfs.bfs">mkfs.bfs</primary></indexterm> -<para id="mkfs.bfs"><command>mkfs.bfs</command> creates an SCO (Santa Cruz Operations) bfs file system.</para> +<para>creates an SCO (Santa Cruz Operations) bfs file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkfs.cramfs"><command>mkfs.cramfs</command></term> +<listitem> <indexterm zone="ch-system-util-linux mkfs.cramfs"><primary sortas="b-mkfs.cramfs">mkfs.cramfs</primary></indexterm> -<para id="mkfs.cramfs"><command>mkfs.cramfs</command> creates a cramfs file system.</para> +<para>creates a cramfs file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkfs.minix"><command>mkfs.minix</command></term> +<listitem> <indexterm zone="ch-system-util-linux mkfs.minix"><primary sortas="b-mkfs.minix">mkfs.minix</primary></indexterm> -<para id="mkfs.minix"><command>mkfs.minix</command> creates a Minix file system.</para> +<para>creates a Minix file system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mkswap"><command>mkswap</command></term> +<listitem> <indexterm zone="ch-system-util-linux mkswap"><primary sortas="b-mkswap">mkswap</primary></indexterm> -<para id="mkswap"><command>mkswap</command> initializes the given device or file to be -used as a swap area.</para> +<para>initializes the given device or file to be used as a swap area.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="more"><command>more</command></term> +<listitem> <indexterm zone="ch-system-util-linux more"><primary sortas="b-more">more</primary></indexterm> -<para id="more"><command>more</command> is a filter for paging through text one +<para>is a filter for paging through text one screen full at a time. But less is much better.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mount"><command>mount</command></term> +<listitem> <indexterm zone="ch-system-util-linux mount"><primary sortas="b-mount">mount</primary></indexterm> -<para id="mount"><command>mount</command> attaches the file system on the given device -to a specified directory (thus hiding the contents of that directory) in the file-system tree.</para> - +<para>attaches the file system on the given device to a specified directory (thus +hiding the contents of that directory) in the file-system tree.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="namei"><command>namei</command></term> +<listitem> <indexterm zone="ch-system-util-linux namei"><primary sortas="b-namei">namei</primary></indexterm> -<para id="namei"><command>namei</command> shows the symbolic links in the given -pathnames.</para> +<para>shows the symbolic links in the given pathnames.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pg"><command>pg</command></term> +<listitem> <indexterm zone="ch-system-util-linux pg"><primary sortas="b-pg">pg</primary></indexterm> -<para id="pg"><command>pg</command> displays a text file one screen full at a -time.</para> +<para>displays a text file one screen full at a time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pivot_root"><command>pivot_root</command></term> +<listitem> <indexterm zone="ch-system-util-linux pivot_root"><primary sortas="b-pivot_root">pivot_root</primary></indexterm> -<para id="pivot_root"><command>pivot_root</command> makes the given file system the new +<para>makes the given file system the new root file system of the current process.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ramsize"><command>ramsize</command></term> +<listitem> <indexterm zone="ch-system-util-linux ramsize"><primary sortas="b-ramsize">ramsize</primary></indexterm> -<para id="ramsize"><command>ramsize</command> is used to set the size of the -RAM disk in a bootable image.</para> +<para>is used to set the size of the RAM disk in a bootable image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rdev"><command>rdev</command></term> +<listitem> <indexterm zone="ch-system-util-linux rdev"><primary sortas="b-rdev">rdev</primary></indexterm> -<para id="rdev"><command>rdev</command> is used to query and set the root +<para>is used to query and set the root device and other things in a bootable image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="readprofile"><command>readprofile</command></term> +<listitem> <indexterm zone="ch-system-util-linux readprofile"><primary sortas="b-readprofile">readprofile</primary></indexterm> -<para id="readprofile"><command>readprofile</command> reads kernel profiling information.</para> +<para>reads kernel profiling information.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rename"><command>rename</command></term> +<listitem> <indexterm zone="ch-system-util-linux rename"><primary sortas="b-rename">rename</primary></indexterm> -<para id="rename"><command>rename</command> renames the given files, replacing a given -string with another.</para> +<para>renames the given files, replacing a given string with another.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="renice"><command>renice</command></term> +<listitem> <indexterm zone="ch-system-util-linux renice"><primary sortas="b-renice">renice</primary></indexterm> -<para id="renice"><command>renice</command> is used to alter the priority of running -processes.</para> +<para>is used to alter the priority of running processes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rev"><command>rev</command></term> +<listitem> <indexterm zone="ch-system-util-linux rev"><primary sortas="b-rev">rev</primary></indexterm> -<para id="rev"><command>rev</command> reverses the lines of a given file.</para> +<para>reverses the lines of a given file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rootflags"><command>rootflags</command></term> +<listitem> <indexterm zone="ch-system-util-linux rootflags"><primary sortas="b-rootflags">rootflags</primary></indexterm> -<para id="rootflags"><command>rootflags</command> is used to set the rootflags -in a bootable image.</para> +<para>is used to set the rootflags in a bootable image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="script"><command>script</command></term> +<listitem> <indexterm zone="ch-system-util-linux script"><primary sortas="b-script">script</primary></indexterm> -<para id="script"><command>script</command> makes a typescript of a terminal -session, of everything printed to the terminal.</para> - +<para>makes a typescript of a terminal session, of everything printed to +the terminal.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="setfdprm"><command>setfdprm</command></term> +<listitem> <indexterm zone="ch-system-util-linux setfdprm"><primary sortas="b-setfdprm">setfdprm</primary></indexterm> -<para id="setfdprm"><command>setfdprm</command> sets user-provided floppy disk -parameters.</para> +<para>sets user-provided floppy disk parameters.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setsid"><command>setsid</command></term> +<listitem> <indexterm zone="ch-system-util-linux setsid"><primary sortas="b-setsid">setsid</primary></indexterm> -<para id="setsid"><command>setsid</command> runs the given program in a new session.</para> +<para>runs the given program in a new session.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setterm"><command>setterm</command></term> +<listitem> <indexterm zone="ch-system-util-linux setterm"><primary sortas="b-setterm">setterm</primary></indexterm> -<para id="setterm"><command>setterm</command> is used to set terminal attributes.</para> +<para>is used to set terminal attributes.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sfdisk"><command>sfdisk</command></term> +<listitem> <indexterm zone="ch-system-util-linux sfdisk"><primary sortas="b-sfdisk">sfdisk</primary></indexterm> -<para id="sfdisk"><command>sfdisk</command> is a disk partition table manipulator.</para> +<para>is a disk partition table manipulator.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="swapdev"><command>swapdev</command></term> +<listitem> <indexterm zone="ch-system-util-linux swapdev"><primary sortas="b-swapdev">swapdev</primary></indexterm> -<para id="swapdev"><command>swapdev</command> is used to set the swap device -in a bootable image.</para> +<para>is used to set the swap device in a bootable image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="swapoff"><command>swapoff</command></term> +<listitem> <indexterm zone="ch-system-util-linux swapoff"><primary sortas="b-swapoff">swapoff</primary></indexterm> -<para id="swapoff"><command>swapoff</command> disables devices and files for paging -and swapping.</para> +<para>disables devices and files for paging and swapping.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="swapon"><command>swapon</command></term> +<listitem> <indexterm zone="ch-system-util-linux swapon"><primary sortas="b-swapon">swapon</primary></indexterm> -<para id="swapon"><command>swapon</command> enables devices and files for paging -and swapping.</para> +<para>enables devices and files for paging and swapping.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tunelp"><command>tunelp</command></term> +<listitem> <indexterm zone="ch-system-util-linux tunelp"><primary sortas="b-tunelp">tunelp</primary></indexterm> -<para id="tunelp"><command>tunelp</command> is used to tune the parameters of the -line printer.</para> +<para>is used to tune the parameters of the line printer.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ul"><command>ul</command></term> +<listitem> <indexterm zone="ch-system-util-linux ul"><primary sortas="b-ul">ul</primary></indexterm> -<para id="ul"><command>ul</command> is a filter for translating underscores into +<para>is a filter for translating underscores into escape sequences indicating underlining for the terminal in use.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="umount"><command>umount</command></term> +<listitem> <indexterm zone="ch-system-util-linux umount"><primary sortas="b-umount">umount</primary></indexterm> -<para id="umount"><command>umount</command> disconnects a file system from the -system's file tree.</para> +<para>disconnects a file system from the system's file tree.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vidmode"><command>vidmode</command></term> +<listitem> <indexterm zone="ch-system-util-linux vidmode"><primary sortas="b-vidmode">vidmode</primary></indexterm> -<para id="vidmode"><command>vidmode</command> could be used to set the video mode -in a bootable image.</para> +<para>could be used to set the video mode in a bootable image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="whereis"><command>whereis</command></term> +<listitem> <indexterm zone="ch-system-util-linux whereis"><primary sortas="b-whereis">whereis</primary></indexterm> -<para id="whereis"><command>whereis</command> reports the location of binary, the +<para>reports the location of binary, the source, and the manual page for the given command.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="write"><command>write</command></term> +<listitem> <indexterm zone="ch-system-util-linux write"><primary sortas="b-write">write</primary></indexterm> -<para id="write"><command>write</command> sends a message to the given user, +<para>sends a message to the given user, <emphasis>if</emphasis> that user has not disabled such messages.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/vim.xml b/chapter06/vim.xml index 4a74b90b8..a47d9d456 100644 --- a/chapter06/vim.xml +++ b/chapter06/vim.xml @@ -118,94 +118,185 @@ the following command:</para> </sect2> -<sect2 id="contents-vim"><title>Contents of Vim</title> +<sect2 id="contents-vim" role="content"><title>Contents of Vim</title> -<para><emphasis>Installed programs</emphasis>: efm_filter.pl, efm_perl.pl, ex -(link to vim), less.sh, mve.awk, pltags.pl, ref, rview (link to vim), rvim -(link to vim), shtags.pl, tcltags, vi (link to vim), view (link to vim), vim, -vim132, vim2html.pl, vimdiff (link to vim), vimm, vimspell.sh, vimtutor -and xxd</para> - -</sect2> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk, +pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl, tcltags, vi (link to vim), +view (link to vim), vim, vim132, vim2html.pl, vimdiff (link to vim), vimm, vimspell.sh, +vimtutor and xxd</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="efm_filter.pl"><command>efm_filter.pl</command></term> +<listitem> <indexterm zone="ch-system-vim efm_filter.pl"><primary sortas="b-efm_filter.pl">efm_filter.pl</primary></indexterm> -<para id="efm_filter.pl"><command>efm_filter.pl</command> is a filter for creating an error -file that can be read by vim.</para> +<para>is a filter for creating an error file that can be read by vim.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="efm_perl.pl"><command>efm_perl.pl</command></term> +<listitem> <indexterm zone="ch-system-vim efm_perl.pl"><primary sortas="b-efm_perl.pl">efm_perl.pl</primary></indexterm> -<para id="efm_perl.pl"><command>efm_perl.pl</command> reformats the error messages of the +<para>reformats the error messages of the Perl interpreter for use with the <quote>quickfix</quote> mode of vim.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ex"><command>ex</command></term> +<listitem> <indexterm zone="ch-system-vim ex"><primary sortas="b-ex">ex</primary></indexterm> -<para id="ex"><command>ex</command> starts vim in ex mode.</para> +<para>starts vim in ex mode.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="less.sh"><command>less.sh</command></term> +<listitem> <indexterm zone="ch-system-vim less.sh"><primary sortas="b-less.sh">less.sh</primary></indexterm> -<para id="less.sh"><command>less.sh</command> is a script that starts vim with less.vim.</para> +<para>is a script that starts vim with less.vim.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mve.awk"><command>mve.awk</command></term> +<listitem> <indexterm zone="ch-system-vim mve.awk"><primary sortas="b-mve.awk">mve.awk</primary></indexterm> -<para id="mve.awk"><command>mve.awk</command> processes vim errors.</para> +<para>processes vim errors.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pltags.pl"><command>pltags.pl</command></term> +<listitem> <indexterm zone="ch-system-vim pltags.pl"><primary sortas="b-pltags.pl">pltags.pl</primary></indexterm> -<para id="pltags.pl"><command>pltags.pl</command> creates a tags file for perl code, -for use by vim.</para> +<para>creates a tags file for perl code, for use by vim.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ref"><command>ref</command></term> +<listitem> <indexterm zone="ch-system-vim ref"><primary sortas="b-ref">ref</primary></indexterm> -<para id="ref"><command>ref</command> checks the spelling of arguments.</para> +<para>checks the spelling of arguments.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rview"><command>rview</command></term> +<listitem> <indexterm zone="ch-system-vim rview"><primary sortas="b-rview">rview</primary></indexterm> -<para id="rview"><command>rview</command> is a restricted version of view: no shell +<para>is a restricted version of view: no shell commands can be started and view can't be suspended.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rvim"><command>rvim</command></term> +<listitem> <indexterm zone="ch-system-vim rvim"><primary sortas="b-rvim">rvim</primary></indexterm> -<para id="rvim"><command>rvim</command> is a restricted version of vim: no shell +<para>is a restricted version of vim: no shell commands can be started and vim can't be suspended.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="shtags.pl"><command>shtags.pl</command></term> +<listitem> <indexterm zone="ch-system-vim shtags.pl"><primary sortas="b-shtags.pl">shtags.pl</primary></indexterm> -<para id="shtags.pl"><command>shtags.pl</command> generates a tag file for perl scripts.</para> +<para>generates a tag file for perl scripts.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tcltags"><command>tcltags</command></term> +<listitem> <indexterm zone="ch-system-vim tcltags"><primary sortas="b-tcltags">tcltags</primary></indexterm> -<para id="tcltags"><command>tcltags</command> generates a tag file for TCL code.</para> +<para>generates a tag file for TCL code.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="view"><command>view</command></term> +<listitem> <indexterm zone="ch-system-vim view"><primary sortas="b-view">view</primary></indexterm> -<para id="view"><command>view</command> starts vim in read-only mode.</para> +<para>starts vim in read-only mode.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vim"><command>vim</command></term> +<listitem> <indexterm zone="ch-system-vim vim"><primary sortas="b-vim">vim</primary></indexterm> -<para id="vim"><command>vim</command> is the editor.</para> +<para>is the editor.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vim132"><command>vim132</command></term> +<listitem> <indexterm zone="ch-system-vim vim132"><primary sortas="b-vim132">vim132</primary></indexterm> -<para id="vim132"><command>vim132</command> starts vim with the terminal in -132-column mode.</para> +<para>starts vim with the terminal in 132-column mode.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vim2html.pl"><command>vim2html.pl</command></term> +<listitem> <indexterm zone="ch-system-vim vim2html.pl"><primary sortas="b-vim2html.pl">vim2html.pl</primary></indexterm> -<para id="vim2html.pl"><command>vim2html.pl</command> converts vim documentation to -HTML.</para> +<para>converts vim documentation to HTML.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vimdiff"><command>vimdiff</command></term> +<listitem> <indexterm zone="ch-system-vim vimdiff"><primary sortas="b-vimdiff">vimdiff</primary></indexterm> -<para id="vimdiff"><command>vimdiff</command> edits two or three versions of a file with -vim and show differences.</para> +<para>edits two or three versions of a file with vim and show differences.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vimm"><command>vimm</command></term> +<listitem> <indexterm zone="ch-system-vim vimm"><primary sortas="b-vimm">vimm</primary></indexterm> -<para id="vimm"><command>vimm</command> enables the DEC locator input model on a -remote terminal.</para> +<para>enables the DEC locator input model on a remote terminal.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="vimspell.sh"><command>vimspell.sh</command></term> +<listitem> <indexterm zone="ch-system-vim vimspell.sh"><primary sortas="b-vimspell.sh">vimspell.sh</primary></indexterm> -<para id="vimspell.sh"><command>vimspell.sh</command> is a script which spells a file and generates the syntax -statements necessary to highlight in vim. -This script requires the old Unix <command>spell</command> command, -which is provided neither in LFS nor in BLFS.</para> - +<para>is a script which spells a file and generates the syntax statements necessary +to highlight in vim. This script requires the old Unix <command>spell</command> +command, which is provided neither in LFS nor in BLFS.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="vimtutor"><command>vimtutor</command></term> +<listitem> <indexterm zone="ch-system-vim vimtutor"><primary sortas="b-vimtutor">vimtutor</primary></indexterm> -<para id="vimtutor"><command>vimtutor</command> teaches you the basic keys and commands -of vim.</para> +<para>teaches you the basic keys and commands of vim.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="xxd"><command>xxd</command></term> +<listitem> <indexterm zone="ch-system-vim xxd"><primary sortas="b-xxd">xxd</primary></indexterm> -<para id="xxd"><command>xxd</command> makes a hex dump of the given file. It can +<para>makes a hex dump of the given file. It can also do the reverse, so it can be used for binary patching.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter06/zlib.xml b/chapter06/zlib.xml index f7c585a33..08cdfbf79 100644 --- a/chapter06/zlib.xml +++ b/chapter06/zlib.xml @@ -88,21 +88,25 @@ because we just moved the file it points to:</para> </sect2> -<sect2 id="contents-zlib"><title>Contents of Zlib</title> - -<para><emphasis>Installed libraries</emphasis>: libz[a,so]</para> - -</sect2> +<sect2 id="contents-zlib" role="content"><title>Contents of Zlib</title> +<segmentedlist> +<segtitle>Installed libraries</segtitle> +<seglistitem><seg>libz[a,so]</seg></seglistitem> +</segmentedlist> -<sect2><title>Short description</title> +<variablelist><title>Short description</title> +<varlistentry> +<term id="libz"><command>libz*</command></term> +<listitem> <indexterm zone="ch-system-zlib libz"><primary sortas="c-libz*">libz*</primary></indexterm> -<para id="libz"><command>libz*</command> contains compression and un-compression +<para>contains compression and un-compression functions used by some programs.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter07/bootscripts.xml b/chapter07/bootscripts.xml index 86c74e051..6982e698d 100644 --- a/chapter07/bootscripts.xml +++ b/chapter07/bootscripts.xml @@ -34,98 +34,176 @@ </sect2> -<sect2 id="contents-bootscripts"><title>Contents of LFS-bootscripts</title> - -<para><emphasis>Installed scripts</emphasis>: checkfs, cleanfs, -console, -functions, halt, ifdown, ifup, -localnet, mountfs, mountkernfs, network, rc, -reboot, sendsignals, setclock, static, swap, sysklogd and template</para> - -</sect2> +<sect2 id="contents-bootscripts" role="content"><title>Contents of LFS-bootscripts</title> +<segmentedlist> +<segtitle>Installed scripts</segtitle> +<seglistitem><seg>checkfs, cleanfs, console, functions, halt, ifdown, ifup, +localnet, mountfs, mountkernfs, network, rc, reboot, sendsignals, setclock, static, +swap, sysklogd and template</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="checkfs-bootscripts"><command>checkfs</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts checkfs-bootscripts"><primary sortas="d-checkfs">checkfs</primary></indexterm> -<para id="checkfs-bootscripts">The <command>checkfs</command> script checks the file systems just -before they are mounted (with the exception of journal and network based -file systems).</para> - +<para>checks the file systems just before they are mounted (with the exception of journal +and network based file systems).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="cleanfs-bootscripts"><command>cleanfs</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts cleanfs-bootscripts"><primary sortas="d-cleanfs">cleanfs</primary></indexterm> -<para id="cleanfs-bootscripts">The <command>cleanfs</command> script removes files that shouldn't be +<para>removes files that shouldn't be preserved between reboots, such as those in <filename>/var/run/</filename> and <filename>/var/lock/</filename>. It re-creates <filename>/var/run/utmp</filename> and removes the possibly present <filename>/etc/nologin</filename>, <filename>/fastboot</filename> and <filename>/forcefsck</filename> files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="console-bootscripts"><command>console</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts console-bootscripts"><primary sortas="d-console">console</primary></indexterm> -<para id="console-bootscripts">The <command>console</command> script -loads the keymap table you -specified as proper for your keyboard layout. +<para>loads the keymap table you specified as proper for your keyboard layout. It also sets the screen font.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="functions-bootscripts"><command>functions</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts functions-bootscripts"><primary sortas="d-functions">functions</primary></indexterm> -<para id="functions-bootscripts">The <command>functions</command> script contains functions shared among +<para>contains functions shared among different scripts, such as error and status checking.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="halt-bootscripts"><command>halt</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts halt-bootscripts"><primary sortas="d-halt">halt</primary></indexterm> -<para id="halt-bootscripts">The <command>halt</command> script halts the system.</para> +<para>halts the system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="ifdown-bootscripts"><command>ifdown</command> and <command>ifup</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts ifdown-bootscripts"><primary sortas="d-ifdown">ifdown</primary></indexterm> -<para id="ifdown-bootscripts">The <command>ifdown</command> and <command>ifup</command> scripts assist -the network script with network devices.</para> +<para>assist the network script with network devices.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="localnet-bootscripts"><command>localnet</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts localnet-bootscripts"><primary sortas="d-localnet">localnet</primary></indexterm> -<para id="localnet-bootscripts">The <command>localnet</command> script sets up the system's hostname and -local loopback device.</para> +<para>sets up the system's hostname and local loopback device.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mountfs-bootscripts"><command>mountfs</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts mountfs-bootscripts"><primary sortas="d-mountfs">mountfs</primary></indexterm> -<para id="mountfs-bootscripts">The <command>mountfs</command> script mounts all file systems that +<para>mounts all file systems that aren't marked <emphasis>noauto</emphasis> or aren't network based.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="mountkernfs-bootscripts"><command>mountkernfs</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts mountkernfs-bootscripts"><primary sortas="d-mountkernfs">mountkernfs</primary></indexterm> -<para id="mountkernfs-bootscripts">The <command>mountkernfs</command> script is used to mount -kernel-provided file systems, such as /proc.</para> +<para>is used to mount kernel-provided file systems, such as /proc.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="network-bootscripts"><command>network</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts network-bootscripts"><primary sortas="d-network">network</primary></indexterm> -<para id="network-bootscripts">The <command>network</command> script sets up network interfaces, such +<para>sets up network interfaces, such as network cards, and sets up the default gateway where applicable.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="rc-bootscripts"><command>rc</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts rc-bootscripts"><primary sortas="d-rc">rc</primary></indexterm> -<para id="rc-bootscripts">The <command>rc</command> script is the master run-level control script. +<para>is the master run-level control script. It is responsible for running all the other scripts one-by-one, in a sequence determined by the name of the symbolic links being processed.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="reboot-bootscripts"><command>reboot</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts reboot-bootscripts"><primary sortas="d-reboot">reboot</primary></indexterm> -<para id="reboot-bootscripts">The <command>reboot</command> script reboots the system.</para> +<para>reboots the system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sendsignals-bootscripts"><command>sendsignals</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts sendsignals-bootscripts"><primary sortas="d-sendsignals">sendsignals</primary></indexterm> -<para id="sendsignals-bootscripts">The <command>sendsignals</command> script makes sure every process is -terminated before the system reboots or halts.</para> +<para>makes sure every process is terminated before the system reboots or halts.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="setclock-bootscripts"><command>setclock</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts setclock-bootscripts"><primary sortas="d-setclock">setclock</primary></indexterm> -<para id="setclock-bootscripts">The <command>setclock</command> script resets the kernel clock to +<para>resets the kernel clock to localtime in case the hardware clock isn't set to GMT time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="static-bootscripts"><command>static</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts static-bootscripts"><primary sortas="d-static">static</primary></indexterm> -<para id="static-bootscripts">The <command>static</command> script provides the functionality needed +<para>provides the functionality needed to assign a static IP address to a network interface.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="swap-bootscripts"><command>swap</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts swap-bootscripts"><primary sortas="d-swap">swap</primary></indexterm> -<para id="swap-bootscripts">The <command>swap</command> script enables and disables swap files and -partitions.</para> +<para>enables and disables swap files and partitions.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="sysklogd-bootscripts"><command>sysklogd</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts sysklogd-bootscripts"><primary sortas="d-sysklogd">sysklogd</primary></indexterm> -<para id="sysklogd-bootscripts">The <command>sysklogd</command> script starts and stops the system and -kernel log daemons.</para> +<para>starts and stops the system and kernel log daemons.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="template-bootscripts"><command>template</command></term> +<listitem> <indexterm zone="ch-scripts-bootscripts template-bootscripts"><primary sortas="d-template">template</primary></indexterm> -<para id="template-bootscripts">The <command>template</command> script is a template you can use to +<para>is a template you can use to create your own bootscripts for your other daemons.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/chapter08/kernel.xml b/chapter08/kernel.xml index cdcd55612..749c11770 100644 --- a/chapter08/kernel.xml +++ b/chapter08/kernel.xml @@ -131,37 +131,51 @@ owned by user <emphasis>root</emphasis>.</para> </sect2> -<sect2 id="contents-kernel"><title>Contents of Linux</title> +<sect2 id="contents-kernel" role="content"><title>Contents of Linux</title> -<para><emphasis>Installed files</emphasis>: the kernel, the kernel headers, -and the System.map</para> - -</sect2> +<segmentedlist> +<segtitle>Installed files</segtitle> +<seglistitem><seg>the kernel, the kernel headers, +and the System.map</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="kernel">The <emphasis>kernel</emphasis></term> +<listitem> <indexterm zone="ch-bootable-kernel kernel"><primary sortas="b-kernel">kernel</primary></indexterm> -<para id="kernel">The <emphasis>kernel</emphasis> is the engine of your GNU/Linux system. +<para>is the engine of your GNU/Linux system. When switching on your box, the kernel is the first part of your operating system that gets loaded. It detects and initializes all the components of your computer's hardware, then makes these components available as a tree of files to the software, and turns a single CPU into a multi-tasking machine capable of running scores of programs seemingly at the same time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="kernel-headers">The <emphasis>kernel headers</emphasis></term> +<listitem> <indexterm zone="ch-bootable-kernel kernel-headers"><primary sortas="e-kernel-headers">kernel headers</primary></indexterm> -<para id="kernel-headers">The <emphasis>kernel headers</emphasis> define the interface to the +<para>define the interface to the services that the kernel provides. The headers in your system's <filename>include</filename> directory should <emphasis>always</emphasis> be the ones against which Glibc was compiled and should therefore <emphasis>not</emphasis> be replaced when upgrading the kernel.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="System.map"><filename>System.map</filename></term> +<listitem> <indexterm zone="ch-bootable-kernel System.map"><primary sortas="e-/boot/System.map">/boot/System.map</primary></indexterm> -<para id="System.map">The <filename>System.map</filename> file is a list of addresses and -symbols. It maps the entry points and addresses of all the functions and data -structures in the kernel.</para> +<para>is a list of addresses and symbols. It maps the entry points and addresses +of all the functions and data structures in the kernel.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> diff --git a/general.ent b/general.ent index b899fb8e4..64cdb5b02 100644 --- a/general.ent +++ b/general.ent @@ -13,8 +13,8 @@ <!ENTITY http-down "http://downloads.linuxfromscratch.org/"> <!ENTITY freshmeat "http://freshmeat.net/projects/"> -<!ENTITY buildtime "Approximate build time: "> -<!ENTITY diskspace "Required disk space: "> +<!ENTITY buildtime "Approximate build time"> +<!ENTITY diskspace "Required disk space"> <!ENTITY autoconf-version "2.59"> <!ENTITY automake-version "1.8.5"> |