gronod/lfs
1
0
Fork 0
mirror of https://git.linuxfromscratch.org/lfs.git synced 2025-03-05 22:04:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Changing the style of the command descriptions in appendix A.

Browse Source 
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@2879 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
This commit is contained in:
Alex Gronenwoud 2003-09-24 22:29:16 +00:00
parent aa497295b3
commit 978d0bffc4
50 changed files with 1209 additions and 1936 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
appendixa/autoconf-desc.xml
View File

@ -3,49 +3,44 @@
<sect2><title>Descriptions</title>
<para>(Last checked against version &autoconf-contversion;.)</para>
<sect3><title>Program file descriptions</title>
<sect4><title>autoconf</title>
<para>autoconf 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 produced by autoconf are
independent of autoconf when they are run, so their users do not need to
have autoconf.</para></sect4>
<sect4><title>autoheader</title>
<para>The autoheader program can create a template file of C #define
statements for configure to use.</para></sect4>
<para><command>autoconf</command> 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>
<sect4><title>autom4te</title>
<para>autom4te runs GNU M4 on files.</para></sect4>
<para><command>autoheader</command> is a tool for creating template files
of C #define statements for configure to use.</para>
<sect4><title>autoreconf</title>
<para>If there are a lot of autoconf-generated configure scripts, the
autoreconf program can save some work. It runs autoconf and
autoheader (where appropriate) repeatedly to remake the autoconf
configure scripts and configuration header templates in the directory
tree rooted at the current directory.</para></sect4>
<para><command>autom4te</command> is a wrapper for the M4 macro
processor.</para>
<sect4><title>autoscan</title>
<para>The autoscan program can help to create a configure.in file for
a software package. autoscan examines the source files in a directory
tree. If a directory is not specified on the command line, then the
current working directory is used. The source files are searched for
common portability problems and a configure.scan file is created to
serve as the preliminary configure.in for that package.</para></sect4>
<para><command>autoreconf</command> 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>
<sect4><title>autoupdate</title>
<para>The autoupdate program updates a configure.in file that calls
autoconf macros by their old names to use the current
macro names.</para></sect4>
<para><command>autoscan</command> 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>
<sect4><title>ifnames</title>
<para>ifnames can help when writing a configure.in for a software
package. It prints the identifiers that the package already uses in C
preprocessor conditionals. If a package has already been set up to
have some portability, this program can help to determine what configure
needs to check. It may fill in some gaps in a configure.in file generated
by autoscan.</para></sect4>
<para><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><command>ifnames</command> 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 <userinput>configure</userinput> needs to check. It can fill
in some gaps in a <filename>configure.in</filename> file generated by
autoscan.</para>
</sect3>
</sect2>

79
appendixa/automake-desc.xml
View File

@ -6,68 +6,51 @@
<sect3><title>Program file descriptions</title>
<sect4><title>acinstall</title>
<para>acinstall is a script which installs aclocal-style M4 files.</para></sect4>
<para><command>acinstall</command> is a script that installs
aclocal-style M4 files.</para>
<sect4><title>aclocal, aclocal-1.6</title>
<para>automake includes a number of autoconf macros which can be used in
packages, some of which are needed by automake in certain
situations. These macros must be defined in the aclocal.m4-file
or they will not be seen by autoconf.</para>
<para><command>aclocal</command> generates <filename>aclocal.m4</filename>
files based on the contents of <filename>configure.in</filename> files.</para>
<para>The aclocal program will automatically generate aclocal.m4 files
based on the contents of configure.in. This provides a convenient
way to get automake-provided macros without having to search around.
Also, the aclocal mechanism is extensible for use
by other packages.</para></sect4>
<para><command>automake</command> 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>
<sect4><title>automake, automake-1.6</title>
<para>To create all the Makefile.in files for a package, run the
automake program in the top level directory, with no
arguments. automake will automatically find each appropriate
Makefile.am (by scanning configure.in) and generate the corresponding
Makefile.in.</para></sect4>
<para><command>compile</command> is a wrapper for compilers.</para>
<sect4><title>compile</title>
<para>compile is script which acts as a wrapper for compilers.</para></sect4>
<para><command>config.guess</command> is a script that attempts to guess
the canonical triplet for the given build, host, or target architecture.</para>
<sect4><title>config.guess</title>
<para>config.guess is a script which attempts to guess a canonical system
name.</para></sect4>
<para><command>config.sub</command> is a configuration validation
subroutine script.</para>
<sect4><title>config.sub</title>
<para>config.sub is a configuration validation subroutine script.</para></sect4>
<para><command>depcomp</command> is a script for compiling a program
so that not only the desired output is generated but also dependency
information.</para>
<sect4><title>depcomp</title>
<para>depcomp is a script which compiles a program while generating
dependencies as side-effects.</para></sect4>
<para><command>elisp-comp</command> byte-compiles Emacs Lisp code.</para>
<sect4><title>elisp-comp</title>
<para>elisp-comp is a script which byte-compiles .el files.</para></sect4>
<para><command>install-sh</command> is a script that installs a program,
a script, or a datafile.</para>
<sect4><title>install-sh</title>
<para>install-sh is a script which installs a program, script, or a
datafile.</para></sect4>
<para><command>mdate-sh</command> is a script that prints the modification
time of a file or directory.</para>
<sect4><title>mdate-sh</title>
<para>mdate-sh is a script which prints the modification time of a file
or directory.</para></sect4>
<para><command>missing</command> is a script acting as a common stub for
missing GNU programs during an installation.</para>
<sect4><title>missing</title>
<para>missing is a script which acts as a common stub for a few missing
GNU programs during an installation.</para></sect4>
<para><command>mkinstalldirs</command> is a script that creates a directory
tree.</para>
<sect4><title>mkinstalldirs</title>
<para>mkinstalldirs is a script which makes a directory
hierarchy.</para></sect4>
<para><command>py-compile</command> compiles a Python program.</para>
<sect4><title>py-compile</title>
<para>py-compile is a script which compiles a Python program.</para></sect4>
<sect4><title>ylwrap</title>
<para>ylwrap is a script which acts as a wrapper for lex/yacc
invocations.</para></sect4>
<para><command>ylwrap</command> is a wrapper for lex and yacc.</para>
</sect3>
</sect2>

22
appendixa/bash-desc.xml
View File

@ -6,22 +6,16 @@
<sect3><title>Program file descriptions</title>
<sect4><title>bash</title>
<para>bash is the Bourne-Again SHell, which is a widely used command
interpreter on Unix systems. The bash program reads from standard
input (the keyboard). A user types something and the program will evaluate
what he has typed and do something with it, like running a
program.</para></sect4>
<para><command>bash</command> is a widely-used command interpreter. It
performs all kinds of expansions and substitutions on a given command line
before executing it, thus making this interpreter a powerful tool.</para>
<sect4><title>bashbug</title>
<para>bashbug is a shell script to help the user compose and mail bug
reports concerning bash in a standard format.</para></sect4>
<para><command>bashbug</command> is a shell script to help the user
compose and mail bug reports concerning bash in a standard format.</para>
<sect4><title>sh</title>
<para>sh 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></sect4>
<para><command>sh</command> 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>
</sect3>

98
appendixa/binutils-desc.xml
View File

@ -6,86 +6,60 @@
<sect3><title>Program file descriptions</title>
<sect4><title>addr2line</title>
<para>addr2line translates program addresses into file names and line numbers.
Given an address and an executable, it uses the debugging information in
the executable to figure out which file name and line number are associated
with a given address.</para></sect4>
<para><command>addr2line</command> 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>
<sect4><title>ar</title>
<para>The ar program 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></sect4>
<para><command>ar</command> 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>
<sect4><title>as</title>
<para>as is primarily intended to assemble the output of the GNU C compiler,
gcc, for use by the linker ld.</para></sect4>
<para><command>as</command> is an assembler. It assembles the output of
gcc into object files.</para>
<sect4><title>gprof</title>
<para>gprof displays call graph profile data.</para></sect4>
<para><command>gprof</command> displays call graph profile data.</para>
<sect4><title>ld</title>
<para>ld combines a number of object and archive files, relocates their data
and ties up symbol references. Often the last step in building a new compiled
program to run is a call to ld.</para></sect4>
<para><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>
<sect4><title>nm</title>
<para>nm lists the symbols from object files.</para></sect4>
<para><command>nm</command> lists the symbols occurring in a given object file.</para>
<sect4><title>objcopy</title>
<para>objcopy utility copies the contents of an object file to another. objcopy
uses the GNU BFD Library to read and write the object files. It can write
the destination object file in a format different from that of the source
object file.</para></sect4>
<para><command>objcopy</command> is used to translate one type of object
file into another.</para>
<sect4><title>objdump</title>
<para>objdump displays information about one or more object files. The options
control what particular information to display. This information is mostly
useful to programmers who are working on the compilation tools, as opposed to
programmers who just want their program to compile and work.</para></sect4>
<para><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>
<sect4><title>ranlib</title>
<para>ranlib generates an index to the contents of an archive, and stores it in
the archive. The index lists each symbol defined by an archive member
that is a relocatable object file.</para></sect4>
<para><command>ranlib</command> 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>
<sect4><title>readelf</title>
<para>readelf displays information about elf type binaries.</para></sect4>
<para><command>readelf</command> displays information about elf type binaries.</para>
<sect4><title>size</title>
<para>size lists the section sizes --and the total size-- for each of the
object files in its argument list. By default, one line of output is
generated for each object file or each module in an archive.</para></sect4>
<para><command>size</command> lists the section sizes -- and the grand
total -- for the given object files.</para>
<sect4><title>strings</title>
<para>For each file given, strings prints the printable character sequences
that are at least 4 characters long (or the number specified with an
option to the program) and are followed by an unprintable character. By
default, it only prints the strings from the initialized and loaded
sections of object files. For other types of files, it prints the strings
from the whole file.</para>
<para><command>strings</command> outputs for each file given 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>
<para>strings is mainly useful for determining the contents of non-text files.</para></sect4>
<sect4><title>strip</title>
<para>strip discards all or specific symbols from object files. The list of
object files may include archives. At least one object file must be
given. strip modifies the files named in its argument, rather than writing
modified copies under different names.</para></sect4>
<para><command>strip</command> discards symbols from object files.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libbfd</title>
<para>libbfd is the Binary File Descriptor library.</para></sect4>
<para><command>libbfd</command> is the Binary File Descriptor library.</para>
<sect4><title>libopcodes</title>
<para>libopcodes is a native library for dealing with opcodes and is
used in the course of building utilities such as objdump. Opcodes are
actually "readable text" versions of instructions for the
processor.</para></sect4>
<para><command>libopcodes</command> is a library for dealing with opcodes.
It is used for building utilities like objdump. Opcodes are the "readable text"
versions of instructions for the processor.</para>
</sect3>

44
appendixa/bison-desc.xml
View File

@ -6,46 +6,12 @@
<sect3><title>Program file descriptions</title>
<sect4><title>bison</title>
<para>bison is a parser generator, a replacement for yacc. yacc stands for Yet
Another Compiler Compiler. What is bison then? It is a program that
generates a program that analyzes the structure of a text file. Instead of
writing the actual program a user specifies how things should be connected
and with those rules a program is constructed that analyzes the
text file. There are a lot of examples where structure is needed and
one of them is the calculator.</para>
<para><command>bison</command> 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>
<para>Given the string :</para>
<blockquote><literallayout> 1 + 2 * 3</literallayout></blockquote>
<para>A human can easily come to the result 7. Why? Because of the structure.
Our brain knows
how to interpret the string. The computer doesn't know that and bison is a
tool to help it understand by presenting the string in the following way
to the compiler:</para>
<blockquote><literallayout> +
/ \
* 1
/ \
2 3</literallayout></blockquote>
<para>Starting at the bottom of a tree and coming across the numbers 2 and
3 which are joined by the multiplication symbol, the computer
multiplies 2 and 3. The result of that multiplication is remembered and
the next thing that the computer sees is the result of 2*3 and the
number 1 which are joined by the add symbol. Adding 1 to the previous
result makes 7. In calculating, the most complex calculations can be
broken down in this tree format and the computer just starts at the
bottom and works its way up to the top and comes with the correct
answer. Of course, bison isn't only used for calculators
alone.</para></sect4>
<sect4><title>yacc</title>
<para>This bash script calls bison using the -y option. This is for
compatibility purposes for programs which use yacc instead of
bison.</para></sect4>
<para><command>yacc</command> is a wrapper for bison, meant for programs
that still call yacc instead of bison. It calls bison with the -y option.</para>
</sect3>

84
appendixa/bootscripts-desc.xml
View File

@ -6,74 +6,58 @@
<sect3><title>Program file descriptions</title>
<sect4><title>checkfs</title>
<para>The checkfs script checks the file systems just before they are
mounted (with the exception of journal and network based file
systems).</para></sect4>
<para>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>
<sect4><title>cleanfs</title>
<para>The cleanfs script removes files that shouldn't be preserved between
<para>The <command>cleanfs</command> script removes files that shouldn't be preserved between
reboots, such as /var/run/* and /var/lock/*. It re-creates /var/run/utmp and
removes the possibly present /etc/nologin, /fastboot and /forcefsck
files.</para></sect4>
files.</para>
<sect4><title>functions</title>
<para>The functions script contains functions shared among different
scripts such as error checking, status checking, etc.</para></sect4>
<para>The <command>functions</command> script contains functions shared among
different scripts, such as error and status checking.</para>
<sect4><title>halt</title>
<para>The halt script halts the system.</para></sect4>
<para>The <command>halt</command> script halts the system.</para>
<sect4><title>ifdown, ifup</title>
<para>The ifdown and ifup scripts assist the network script with
network devices.</para></sect4>
<para>The <command>ifdown</command> and <command>ifup</command> scripts assist
the network script with network devices.</para>
<sect4><title>loadkeys</title>
<para>The loadkeys script loads the keymap table you specified as proper for
your keyboard layout.</para></sect4>
<para>The <command>loadkeys</command> script loads the keymap table you
specified as proper for your keyboard layout.</para>
<sect4><title>localnet</title>
<para>The localnet script sets up the system's hostname and local loopback
device.</para></sect4>
<para>The <command>localnet</command> script sets up the system's hostname and
local loopback device.</para>
<sect4><title>mountfs</title>
<para>The mountfs script mounts all file systems that aren't marked noauto
or aren't network based.</para></sect4>
<para>The <command>mountfs</command> script mounts all file systems that
aren't marked noauto or aren't network based.</para>
<sect4><title>mountproc</title>
<para>The mountproc script is used to mount the proc filesystem.</para></sect4>
<para>The <command>mountproc</command> script is used to mount the proc
filesystem.</para>
<sect4><title>network</title>
<para>The network script sets up network interfaces, such as network cards,
and sets up the default gateway where applicable.</para></sect4>
<para>The <command>network</command> script sets up network interfaces, such
as network cards, and sets up the default gateway where applicable.</para>
<sect4><title>rc</title>
<para>The rc script is the master runlevel control script. It is
responsible for running all the other scripts one-by-one in a specific
sequence.</para></sect4>
<para>The <command>rc</command> script is the master runlevel control script.
It is responsible for running all the other scripts one-by-one in a specific
sequence.</para>
<sect4><title>reboot</title>
<para>The reboot scripts reboots the system.</para></sect4>
<para>The <command>reboot</command> script reboots the system.</para>
<sect4><title>sendsignals</title>
<para>The sendsignals script makes sure every process is terminated before
the system reboots or halts.</para></sect4>
<para>The <command>sendsignals</command> script makes sure every process is
terminated before the system reboots or halts.</para>
<sect4><title>setclock</title>
<para>The setclock scripts resets the kernel clock to localtime in case
the hardware clock isn't set to GMT time.</para></sect4>
<para>The <command>setclock</command> script resets the kernel clock to
localtime in case the hardware clock isn't set to GMT time.</para>
<sect4><title>swap</title>
<para>The swap scripts enables and disables swap files and
partitions.</para></sect4>
<para>The <command>swap</command> script enables and disables swap files and
partitions.</para>
<sect4><title>sysklogd</title>
<para>The sysklogd script starts and stops the system and kernel log
daemons.</para></sect4>
<para>The <command>sysklogd</command> script starts and stops the system and
kernel log daemons.</para>
<sect4><title>template</title>
<para>The template script is a template you can use to create your own
bootscripts for your other daemons.</para></sect4>
<para>The <command>template</command> script is a template you can use to
create your own bootscripts for your other daemons.</para>
</sect3>

49
appendixa/bzip2-desc.xml
View File

@ -6,51 +6,36 @@
<sect3><title>Program file descriptions</title>
<sect4><title>bunzip2</title>
<para>bunzip2 decompresses files that are compressed with
bzip2.</para></sect4>
<para><command>bunzip2</command> decompresses bzipped files.</para>
<sect4><title>bzcat</title>
<para>bzcat (or bzip2 -dc) decompresses all specified files to the standard
output.</para></sect4>
<para><command>bzcat</command> decompresses to standard output.</para>
<sect4><title>bzcmp, bzdiff</title>
<para>bzcmp and bzdiff are used to invoke the cmp or the diff program on
bzip2 compressed files.</para></sect4>
<para><command>bzcmp</command> runs cmp on bzipped files.</para>
<sect4><title>bzegrep, bzfgrep, bzgrep</title>
<para>bzegrep, bzfgrep, and bzgrep invoke either egrep, fgrep, or grep
(respectively) on bzip2-compressed files.</para></sect4>
<para><command>bzdiff</command> runs diff on bzipped files.</para>
<sect4><title>bzip2</title>
<para>bzip2 compresses files using the Burrows-Wheeler block sorting text
compression algorithm and Huffman coding. Compression is generally
considerably better than that achieved by more conventional LZ77/LZ78-based
compressors (such as the traditional <userinput>gzip</userinput> utility)
and approaches the performance of the PPM family of statistical
compressors.</para></sect4>
<para><command>bzgrep</command> and friends run grep on bzipped files.</para>
<sect4><title>bzip2recover</title>
<para>bzip2recover recovers data from damaged bzip2 files.</para></sect4>
<para><command>bzip2</command> 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 <userinput>gzip</userinput>.</para>
<sect4><title>bzless</title>
<para>bzless is a filter which allows examination of compressed
or plain text files, one screenful at a time on a soft-copy
terminal, like less.</para></sect4>
<para><command>bzip2recover</command> tries to recover data from damaged
bzip2 files.</para>
<sect4><title>bzmore</title>
<para>bzmore is a filter which allows examination of compressed
or plain text files, one screenful at a time on a soft-copy
terminal, like more.</para></sect4>
<para><command>bzless</command> runs less on bzipped files.</para>
<para><command>bzmore</command> runs more on bzipped files.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libbz2</title>
<para>libbz2 is the library for implementing lossless, block-sorting data
compression, using the Burrows-Wheeler algorithm.</para></sect4>
<para><command>libbz2</command> is the library implementing lossless,
block-sorting data compression, using the Burrows-Wheeler algorithm.</para>
</sect3>
</sect2>

382
appendixa/coreutils-desc.xml
View File

@ -2,315 +2,245 @@
<sect2><title>Descriptions</title>
<para>(Last checked against the old Fileutils, Sh-utils and Textutils.)</para>
<sect3><title>Program file descriptions</title>
<sect4><title>basename</title>
<para>basename strips directory and suffixes from filenames.</para></sect4>
<para><command>basename</command> strips any path and a given suffix from
the given file name.</para>
<sect4><title>cat</title>
<para>cat concatenates file(s) or standard input to
standard output.</para></sect4>
<para><command>cat</command> concatenates files to standard output.</para>
<sect4><title>chgrp</title>
<para>chgrp changes the group ownership of each given file to the named group,
which can be either a group name or a numeric group ID.</para></sect4>
<para><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>
<sect4><title>chmod</title>
<para>chmod changes the permissions of each given file according to mode, which
can be either a symbolic representation of changes to make or an octal
number representing the bit pattern for the new permissions.</para></sect4>
<sect4><title>chown</title>
<para>chown changes the user and/or group ownership of each
given file.</para></sect4>
<para><command>chmod</command> 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>
<sect4><title>chroot</title>
<para>chroot runs a command or interactive shell with special
root directory.</para></sect4>
<para><command>chown</command> changes the user and/or group ownership of
each given file to the given user:group pair.</para>
<sect4><title>cksum</title>
<para>cksum prints CRC checksum and byte counts of each specified
file.</para></sect4>
<para><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>
<sect4><title>comm</title>
<para>comm compares two sorted files line by line.</para></sect4>
<para><command>cksum</command> prints the CRC checksum and the byte
counts of each specified file.</para>
<sect4><title>cp</title>
<para>cp copies files from one place to another.</para></sect4>
<para><command>comm</command> compares two sorted files, outputting in
three columns the lines that are unique, and the lines that are common.</para>
<sect4><title>csplit</title>
<para>csplit outputs pieces of a file separated by (a) pattern(s) to files
xx01, xx02, ..., and outputs byte counts of each piece to standard
output.</para></sect4>
<para><command>cp</command> copies files.</para>
<sect4><title>cut</title>
<para>cut prints selected parts of lines from specified files to standard
output.</para></sect4>
<para><command>csplit</command> 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>
<sect4><title>date</title>
<para>date displays the current time in a specified format, or sets
the system date.</para></sect4>
<para><command>cut</command> prints parts of lines, selecting the parts
according to given fields or positions.</para>
<sect4><title>dd</title>
<para>dd copies a file (from the standard input to the standard output, by
default) with a user-selectable blocksize, while optionally performing
conversions on it.</para></sect4>
<para><command>date</command> displays the current time in the given
format, or sets the system date.</para>
<sect4><title>df</title>
<para>df displays the amount of disk space available on the filesystem
containing each file name argument. If no file name is given, the space
available on all currently mounted filesystems is shown.</para></sect4>
<para><command>dd</command> copies a file using the given blocksize and
count, while optionally performing conversions on it.</para>
<sect4><title>dir, ls and vdir</title>
<para>dir and vdir are versions of ls with different default output formats.
These programs list each given file or directory name. Directory contents
are sorted alphabetically. For ls, files are, by default, listed in columns
sorted vertically if the standard output is a terminal; otherwise they
are listed one per line. For dir, files are, by default, listed in columns
sorted vertically. For vdir, files are, by default, listed in
long format.</para></sect4>
<para><command>df</command> reports the amount of disk space available
(and used) on all mounted filesystems, or only on the filesystems holding the
given files.</para>
<sect4><title>dircolors</title>
<para>dircolors outputs commands to set the LS_COLOR environment variable.
The LS_COLOR variable is use to change the default color scheme used by
ls and related utilities.</para></sect4>
<para><command>dir</command> is the same as ls.</para>
<sect4><title>dirname</title>
<para>dirname strips non-directory suffixes from file name.</para></sect4>
<para><command>dircolors</command> outputs commands to set the LS_COLOR
environment variable, to change the color scheme used by ls.</para>
<sect4><title>du</title>
<para>du displays the amount of disk space used by each file or directory
listed on the command-line and by each of their subdirectories.</para></sect4>
<para><command>dirname</command> strips the non-directory suffix from
a given file name.</para>
<sect4><title>echo</title>
<para>echo displays a line of text.</para></sect4>
<para><command>du</command> 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>
<sect4><title>env</title>
<para>env runs a program in a modified environment.</para></sect4>
<para><command>echo</command> displays the given strings.</para>
<sect4><title>expand</title>
<para>expand converts tabs in files to spaces, writing to standard
output.</para></sect4>
<para><command>env</command> runs a command in a modified environment.</para>
<sect4><title>expr</title>
<para>expr evaluates expressions.</para></sect4>
<para><command>expand</command> converts tabs to spaces.</para>
<sect4><title>factor</title>
<para>factor prints the prime factors of all specified
integer numbers.</para></sect4>
<para><command>expr</command> evaluates expressions.</para>
<sect4><title>false</title>
<para>false always exits with a status code indicating failure.</para></sect4>
<para><command>factor</command> prints the prime factors of all specified
integer numbers.</para>
<sect4><title>fmt</title>
<para>fmt reformats each paragraph in the specified file(s), writing to
standard output.</para></sect4>
<para><command>false</command> does nothing, unsuccessfully. It always
exits with a status code indicating failure.</para>
<sect4><title>fold</title>
<para>fold wraps input lines in each specified file (standard input by default),
writing to standard output.</para></sect4>
<para><command>fmt</command> reformats the paragraphs in the given files.</para>
<sect4><title>groups</title>
<para>groups prints a user's group memberships.</para></sect4>
<para><command>fold</command> wraps the lines in the given files.</para>
<sect4><title>head</title>
<para>head prints the first xx (10 by default) lines of each specified file to
standard output.</para></sect4>
<para><command>groups</command> reports a user's group memberships.</para>
<sect4><title>hostid</title>
<para>hostid prints the numeric identifier (in hexadecimal) for the current
host.</para></sect4>
<para><command>head</command> prints the first ten lines (or the given
number of lines) of each given file.</para>
<sect4><title>hostname</title>
<para>hostname reports or sets the name of the current host.</para></sect4>
<para><command>hostid</command> reports the numeric identifier
(in hexadecimal) of the host.</para>
<sect4><title>id</title>
<para>id prints the effective user and group IDs of the current
user or a given user.</para></sect4>
<para><command>hostname</command> reports or sets the name of the
host.</para>
<sect4><title>install</title>
<para>install copies files and sets their permission modes and, if possible,
their owner and group.</para></sect4>
<para><command>id</command> reports the effective user ID, group ID, and
group memberships of the current user, or of a given user.</para>
<sect4><title>join</title>
<para>join joins lines of two files on a common field.</para></sect4>
<para><command>install</command> copies files while setting their
permission modes and, if possible, their owner and group.</para>
<sect4><title>kill</title>
<para>kill terminates the given process.</para></sect4>
<para><command>join</command> joins from two files the lines that have
identical join fields.</para>
<sect4><title>ln</title>
<para>ln makes hard or soft (symbolic) links between files.</para></sect4>
<para><command>kill</command> terminates the given process.</para>
<sect4><title>logname</title>
<para>logname prints the current user's login name.</para></sect4>
<para><command>link</command> creates a hard link with the given name
to the given file.</para>
<sect4><title>md5sum</title>
<para>md5sum prints or checks MD5 checksums.</para></sect4>
<para><command>ln</command> makes hard links or soft links between files.</para>
<sect4><title>mkdir</title>
<para>mkdir creates directories with a given name.</para></sect4>
<para><command>logname</command> reports the current user's login name.</para>
<sect4><title>mkfifo</title>
<para>mkfifo creates a FIFO with each given name.</para></sect4>
<para><command>ls</command> lists the contents of each given directory.
By default it orders the files and subdirectories alphabetically.</para>
<sect4><title>mknod</title>
<para>mknod creates a FIFO, character special file or block special file
with the given file name.</para></sect4>
<para><command>md5sum</command> reports or checks MD5 checksums.</para>
<sect4><title>mv</title>
<para>mv moves files from one directory to another or renames files, depending
on the arguments given to mv.</para></sect4>
<para><command>mkdir</command> creates directories with the given names.</para>
<sect4><title>nice</title>
<para>nice runs a program with modified scheduling priority.</para></sect4>
<para><command>mkfifo</command> creates FIFOs with the given names.</para>
<sect4><title>nl</title>
<para>nl writes each specified file to standard output, with line numbers
added.</para></sect4>
<para><command>mknod</command> creates device nodes with the given names.
A device node is a character special file, or a block special file, or a FIFO.</para>
<sect4><title>nohup</title>
<para>nohup runs a command immune to hangups, with output to a
log file.</para></sect4>
<para><command>mv</command> moves or renames files or directories.</para>
<sect4><title>od</title>
<para>od writes an unambiguous representation, octal bytes by default, of a
specified file to standard output.</para></sect4>
<para><command>nice</command> runs a program with modified scheduling priority.</para>
<sect4><title>paste</title>
<para>paste writes lines consisting of the sequentially corresponding
lines from each specified file, separated by TABs,
to standard output.</para></sect4>
<para><command>nl</command> numbers the lines from the given files.</para>
<sect4><title>pathchk</title>
<para>pathchk checks whether file names are valid or portable.</para></sect4>
<para><command>nohup</command> runs a command immune to hangups, with
output redirected to a log file.</para>
<sect4><title>pinky</title>
<para>pinky is a lightweight finger utility which retrieves information about
a certain user.</para></sect4>
<para><command>od</command> dumps files in octal and other formats.</para>
<sect4><title>pr</title>
<para>pr paginates or columnates files for printing.</para></sect4>
<para><command>paste</command> merges the given files, joining
sequentially corresponding lines side by side, separated by TABs.</para>
<sect4><title>printenv</title>
<para>printenv prints all or part of the environment.</para></sect4>
<para><command>pathchk</command> checks whether file names are valid
or portable.</para>
<sect4><title>printf</title>
<para>printf formats and prints data (the same as the C printf
function).</para></sect4>
<para><command>pinky</command> is a lightweight finger. It reports
some information about the given users.</para>
<sect4><title>ptx</title>
<para>ptx produces a permuted index of file contents.</para></sect4>
<para><command>pr</command> paginates and columnates files for printing.</para>
<sect4><title>pwd</title>
<para>pwd prints the name of the current/working directory.</para></sect4>
<para><command>printenv</command> prints the environment.</para>
<sect4><title>rm</title>
<para>rm removes files or directories.</para></sect4>
<para><command>printf</command> prints the given arguments according to the
given format -- much like the C printf function.</para>
<sect4><title>rmdir</title>
<para>rmdir removes directories, if they are empty.</para></sect4>
<para><command>ptx</command> produces from the contents of the given files
a permuted index, with each keyword in its context.</para>
<sect4><title>seq</title>
<para>seq prints numbers in a certain range with a certain
increment.</para></sect4>
<para><command>pwd</command> reports the name of the current directory.</para>
<sect4><title>sha1sum</title>
<para>sha1sum prints or checks 160-bit SHA1checksums.</para></sect4>
<para><command>readlink</command> reports the value of the given symbolic
link.</para>
<sect4><title>shred</title>
<para>shred deletes a file securely, overwriting it first so that its
contents can't be recovered.</para></sect4>
<para><command>rm</command> removes files or directories.</para>
<sect4><title>sleep</title>
<para>sleep delays for a specified amount of time.</para></sect4>
<para><command>rmdir</command> removes directories, if they are empty.</para>
<sect4><title>sort</title>
<para>sort writes sorted concatenation of files to standard
output.</para></sect4>
<para><command>seq</command> prints a sequence of numbers, within a given
range and with a given increment.</para>
<sect4><title>split</title>
<para>split outputs fixed-size pieces of an input file to
PREFIXaa, PREFIXab, ...</para></sect4>
<para><command>sha1sum</command> prints or checks 160-bit SHA1
checksums.</para>
<sect4><title>stty</title>
<para>stty changes and prints terminal line settings.</para></sect4>
<para><command>shred</command> overwrites the given files repeatedly with
strange patterns, to make it real hard to recover the data.</para>
<sect4><title>su</title>
<para>su runs a shell with substitute user and group IDs.</para></sect4>
<para><command>sleep</command> pauses for the given amount of time.</para>
<sect4><title>sum</title>
<para>sum prints checksum and block counts for each specified
file.</para></sect4>
<para><command>sort</command> sorts the lines from the given files.</para>
<sect4><title>sync</title>
<para>sync forces changed blocks to disk and updates the
super block.</para></sect4>
<para><command>split</command> splits the given file into pieces, by size
or by number of lines.</para>
<sect4><title>tac</title>
<para>tac writes each specified file to standard output, last line
first.</para></sect4>
<para><command>stty</command> sets or reports terminal line settings.</para>
<sect4><title>tail</title>
<para>tail print the last xx (10 by default) lines of each specified file to
standard output.</para></sect4>
<para><command>su</command> runs a shell with substitute user and group IDs.</para>
<sect4><title>tee</title>
<para>tee reads from standard input and writes to standard output and
files.</para></sect4>
<para><command>sum</command> prints checksum and block counts for each
given file.</para>
<sect4><title>test</title>
<para>test checks file types and compares values.</para></sect4>
<para><command>sync</command> flushes filesystem buffers. It forces
changed blocks to disk and updates the super block.</para>
<sect4><title>touch</title>
<para>touch changes the access and modification times of each given file to the
current time. Files that do not exist are created empty.</para></sect4>
<para><command>tac</command> concatenates the given files in reverse.</para>
<sect4><title>tr</title>
<para>tr translates, squeezes, and/or deletes characters from standard
input, writing to standard output.</para></sect4>
<para><command>tail</command> prints the last ten lines (or the given
number of lines) of each given file.</para>
<sect4><title>true</title>
<para>true always exits with a status code indicating success.</para></sect4>
<para><command>tee</command> reads from standard input while writing both
to standard output and to the given files.</para>
<sect4><title>tsort</title>
<para>tsort writes totally ordered lists consistent with the partial ordering
in specified files.</para></sect4>
<para><command>test</command> compares values and checks file types.</para>
<sect4><title>tty</title>
<para>tty prints the file name of the terminal connected to standard
input.</para></sect4>
<para><command>touch</command> 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>
<sect4><title>uname</title>
<para>uname prints system information.</para></sect4>
<para><command>tr</command> translates, squeezes, and deletes the given
characters from standard input.</para>
<sect4><title>unexpand</title>
<para>unexpand converts spaces in each file to tabs, writing to standard
output.</para></sect4>
<para><command>true</command> does nothing, successfully. It always exits
with a status code indicating success.</para>
<sect4><title>uniq</title>
<para>uniq removes duplicate lines from a sorted file.</para></sect4>
<para><command>tsort</command> performs a topological sort. It writes a
totally ordered list according to the partial ordering in a given file.</para>
<sect4><title>uptime</title>
<para>uptime tells how long the system has been running.</para></sect4>
<para><command>tty</command> reports the file name of the terminal
connected to standard input.</para>
<sect4><title>users</title>
<para>users prints the user names of users currently logged in to the
current host.</para></sect4>
<para><command>uname</command> reports system information.</para>
<sect4><title>wc</title>
<para>wc prints line, word and byte counts for each specified file and a
total line, if more than one file is specified.</para></sect4>
<para><command>unexpand</command> converts spaces to tabs.</para>
<sect4><title>who</title>
<para>who shows who is logged on.</para></sect4>
<para><command>uniq</command> discards all but one of successive
identical lines.</para>
<sect4><title>whoami</title>
<para>whoami prints the user name associated with the current
effective user ID.</para></sect4>
<para><command>unlink</command> removes the given file.</para>
<sect4><title>yes</title>
<para>yes outputs 'y' or a given string repeatedly,
until killed.</para></sect4>
<para><command>uptime</command> reports how long the system has been
running, how many users are logged on, and the system load averages.</para>
<para><command>users</command> reports the names of the users currently
logged on.</para>
<para><command>vdir</command> is the same as ls -l.</para>
<para><command>wc</command> reports the number of lines, words, and bytes
for each given file, and a total line when more than one file is given.</para>
<para><command>who</command> reports who is logged on.</para>
<para><command>whoami</command> reports the user name associated with the
current effective user ID.</para>
<para><command>yes</command> outputs 'y' or a given string repeatedly,
until killed.</para>
</sect3>

18
appendixa/diffutils-desc.xml
View File

@ -6,18 +6,16 @@
<sect3><title>Program file descriptions</title>
<sect4><title>cmp and diff</title>
<para>cmp and diff both compare two files and report their differences. Both
programs have extra options which compare files in
different situations.</para></sect4>
<para><command>cmp</command> compares two files and reports whether or
in which bytes they differ.</para>
<sect4><title>diff3</title>
<para>The difference between diff and diff3 is that diff compares 2 files,
diff3 compares 3 files.</para></sect4>
<para><command>diff</command> compares two files or directories and reports
which lines in the files differ.</para>
<sect4><title>sdiff</title>
<para>sdiff merges two files and interactively outputs
the results.</para></sect4>
<para><command>diff3</command> compares three files line by line.</para>
<para><command>sdiff</command> merges two files and interactively outputs
the results.</para>
</sect3>

117
appendixa/e2fsprogs-desc.xml
View File

@ -6,102 +6,75 @@
<sect3><title>Program file descriptions</title>
<sect4><title>badblocks</title>
<para>badblocks is used to search for bad blocks on a device (usually a disk
partition).</para></sect4>
<para><command>badblocks</command> searches a device (usually a disk
partition) for bad blocks.</para>
<sect4><title>chattr</title>
<para>chattr changes the file attributes on a Linux second extended file
system.</para></sect4>
<para><command>chattr</command> changes the attributes of files on a
second extended (ext2) filesystem.</para>
<sect4><title>compile_et</title>
<para>compile_et is used to convert a table, listing error-code names
and associated messages, into a C source file that is suitable for use
with the com_err library.</para></sect4>
<para><command>compile_et</command> 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>
<sect4><title>debugfs</title>
<para>The debugfs program is a file system debugger. It can be used to examine
and change the state of an ext2 file system.</para></sect4>
<para><command>debugfs</command> is a filesystem debugger. It can be
used to examine and change the state of an ext2 filesystem.</para>
<sect4><title>dumpe2fs</title>
<para>dumpe2fs prints the super block and blocks group information for the
filesystem present on a specified device.</para></sect4>
<para><command>dumpe2fs</command> prints the super block and blocks group
information for the filesystem present on a given device.</para>
<sect4><title>e2fsck and fsck.ext2</title>
<para>e2fsck and fsck.ext2 are used to check, and optionally repair, Linux
second extended filesystems.</para></sect4>
<para><command>e2fsck</command> is used to check, and optionally repair,
second extended (ext2) filesystems, and also ext3 filesystems.</para>
<sect4><title>e2image</title>
<para>e2image is used to save critical ext2 filesystem data to
a file.</para></sect4>
<para><command>e2image</command> is used to save critical ext2 filesystem
data to a file.</para>
<sect4><title>e2label</title>
<para>e2label will display or change the filesystem label on the ext2
filesystem located on the specified device.</para></sect4>
<para><command>e2label</command> will display or change the filesystem
label on the ext2 filesystem present on a given device.</para>
<sect4><title>fsck</title>
<para>fsck is used to check, and optionally repair, a Linux file
system.</para></sect4>
<para><command>fsck</command> is used to check, and optionally repair,
filesystems. By default it checks the filesystems listed in
<filename>/etc/fstab</filename></para>
<sect4><title>fsck.ext3</title>
<para>fsck.ext3 is used to check, and optionally repair, a Linux ext3
filesystems.</para></sect4>
<para><command>lsattr</command> lists the attributes of files on a second
extended filesystem.</para>
<sect4><title>lsattr</title>
<para>lsattr lists the file attributes on a second extended
file system.</para></sect4>
<para><command>mk_cmds</command> 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>
<sect4><title>mk_cmds</title>
<para>The mk_cmds utility takes a command table file as input and produces
a C source file as output, which is intended to be used with the subsystem
library, libss.</para></sect4>
<para><command>mke2fs</command> is used to create a second extended
filesystem on the given device.</para>
<sect4><title>mke2fs and mkfs.ext2</title>
<para>mke2fs is used to create a Linux second extended file system on a device
(usually a disk partition). mkfs.ext2 does the same as mke2fs.</para></sect4>
<para><command>mklost+found</command> is used to create a
<filename>lost+found</filename> directory on a second extended filesystem.
It pre-allocates disk blocks to this directory to lighten the task of e2fsck.</para>
<sect4><title>mkfs.ext3</title>
<para>mkfs.ext3 is used to create an ext3 filesystem.</para></sect4>
<para><command>resize2fs</command> can be used to enlarge or shrink an
ext2 filesystem.</para>
<sect4><title>mklost+found</title>
<para>mklost+found is used to create a lost+found directory in the current
working directory on a Linux second extended file system. mklost+found
pre-allocates disk blocks to the directory to make it
usable by e2fsck.</para></sect4>
<para><command>tune2fs</command> is used adjust tunable filesystem
parameters on a second extended filesystem.</para>
<sect4><title>resize2fs</title>
<para>resize2fs is used to resize ext2 file systems.</para></sect4>
<sect4><title>tune2fs</title>
<para>tune2fs adjusts tunable filesystem parameters on a Linux second extended
filesystem.</para></sect4>
<sect4><title>uuidgen</title>
<para>The uuidgen program creates a new universally unique identifier (UUID)
using the libuuid library. The 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></sect4>
<para><command>uuidgen</command> creates new universally unique
identifiers (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>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libcom_err</title>
<para>The common error display routine.</para></sect4>
<para><command>libcom_err</command> is the common error display routine.</para>
<sect4><title>libe2p</title>
<para>libe2p is used by dumpe2fs, chattr, and lsattr.</para></sect4>
<para><command>libe2p</command> is used by dumpe2fs, chattr, and lsattr.</para>
<sect4><title>libext2fs</title>
<para>The ext2fs library is designed to allow user-level programs to
manipulate an ext2 filesystem.</para></sect4>
<para><command>libext2fs</command> contains routines to enable user-level
programs to manipulate an ext2 filesystem.</para>
<sect4><title>libss</title>
<para>libss is used by debugfs.</para></sect4>
<para><command>libss</command> is used by debugfs.</para>
<sect4><title>libuuid</title>
<para>The libuuid library is used to generate unique identifiers for
objects that may be accessible beyond the local system.</para></sect4>
<para><command>libuuid</command> contains routines for generating unique
identifiers for objects that may be accessible beyond the local system.</para>
</sect3>

10
appendixa/ed-desc.xml
View File

@ -6,13 +6,11 @@
<sect3><title>Program file description</title>
<sect4><title>ed</title>
<para>ed is a line-oriented text editor. It is used to create, display,
modify and otherwise manipulate text files.</para></sect4>
<para><command>ed</command> is a line-oriented text editor. It can be used
to create, display, modify and otherwise manipulate text files.</para>
<sect4><title>red</title>
<para>red is a restricted ed: it can only edit files in the current
directory and cannot execute shell commands.</para></sect4>
<para><command>red</command> is a restricted ed -- it can only edit files
in the current directory and cannot execute shell commands.</para>
</sect3>

8
appendixa/file-desc.xml
View File

@ -6,11 +6,9 @@
<sect3><title>Program file descriptions</title>
<sect4><title>file</title>
<para>file tests each specified file in an attempt to classify it. There are
three sets of tests, performed in this order: filesystem tests,
magic number tests and language tests. The first test that succeeds
causes the file type to be printed.</para></sect4>
<para><command>file</command> tries to classify each given file. It does
this by performing several tests: filesystem tests, magic number tests, and
language tests. The first test that succeeds determines the result.</para>
</sect3>

50
appendixa/findutils-desc.xml
View File

@ -6,46 +6,28 @@
<sect3><title>Program file descriptions</title>
<sect4><title>bigram</title>
<para>bigram is used together with code to produce older-style locate
databases. To learn more about these last three programs, read the locatedb.5
manual page.</para></sect4>
<para><command>bigram</command> was formerly used to produce locate
databases.</para>
<sect4><title>code</title>
<para>code is the ancestor of frcode. It was used in older-style locate
databases.</para></sect4>
<para><command>code</command> was formerly used to produce locate
databases. It is is the ancestor of frcode.</para>
<sect4><title>find</title>
<para>The find program searches for files in a directory hierarchy which match
a certain criteria. If no criteria is given, it lists all files in the
current directory and its subdirectories.</para></sect4>
<para><command>find</command> searches given directory trees for files
matching the specified criteria.</para>
<sect4><title>frcode</title>
<para>frcode is called by updatedb to compress the list of file names
using front-compression, which reduces the database size by a factor of
4 to 5.</para></sect4>
<para><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>
<sect4><title>locate</title>
<para>locate scans a database which contains all files and directories on a
filesystem. This program lists the files and directories in this
database matching a certain criteria. If a user is looking for a file this
program will scan the database and tell him exactly where the files he
requested are located. This only makes sense if the locate database is
fairly up-to-date, else it will provide out-of-date information.</para></sect4>
<para><command>locate</command> searches through a database of file names,
and reports the names that contain a given string or match a given pattern.</para>
<sect4><title>updatedb</title>
<para>The updatedb program updates the locate database. It scans the entire
file system (including other file systems that are currently mounted
unless it is told not to do so) and puts every directory and file it finds
into the database that's used by the locate program, which retrieves this
information. It's good practice to update this database once a day to
have it up-to-date whenever it is needed.</para></sect4>
<para><command>updatedb</command> updates the locate database. It scans
the entire filesystem (including other filesystems that are currently mounted,
unless told not to) and puts every file name it finds in the database.</para>
<sect4><title>xargs</title>
<para>The xargs command applies a command to a list of files. If there is
a need to perform the same command on multiple files, a list can be created
that names all those files (one per line) and xargs can perform that
command on those files.</para></sect4>
<para><command>xargs</command> can be used to apply a given command to
a list of files.</para>
</sect3>

25
appendixa/flex-desc.xml
View File

@ -6,29 +6,20 @@
<sect3><title>Program file descriptions</title>
<sect4><title>flex</title>
<para>flex is a tool for generating programs which recognize
patterns in text. Pattern recognition is very useful in many applications.
A user sets up rules about what to look for and flex will make a program
that looks for those patterns. The reason people use flex is that it is
much easier to set up rules for what to look for than to write the actual
program which finds the text.</para></sect4>
<para><command>flex</command> 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 than to write the actual pattern-finding program.</para>
<sect4><title>flex++</title>
<para>flex++ invokes a version of flex which is used exclusively for
C++ scanners.</para></sect4>
<sect4><title>lex</title>
<para>We create a bash script called lex which calls flex using the -l option.
This is for compatibility purposes for programs which use lex instead
of flex.</para></sect4>
<para><command>flex++</command> invokes a version of flex that is used
exclusively for C++ scanners.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libfl</title>
<para>libfl is the flex library.</para></sect4>
<para><command>libfl</command> is the flex library.</para>
</sect3>

27
appendixa/gawk-desc.xml
View File

@ -6,28 +6,21 @@
<sect3><title>Program file descriptions</title>
<sect4><title>awk</title>
<para>awk is a symbolic link to gawk.</para></sect4>
<para><command>gawk</command> is a program for manipulating text files.
It is the GNU implementation of awk.</para>
<sect4><title>gawk, gawk-3.1.1</title>
<para>gawk is the GNU implementation of awk, a pattern scanning and
processing language.</para></sect4>
<para><command>grcat</command> dumps the group database
<filename>/etc/group</filename>.</para>
<sect4><title>grcat</title>
<para>grcat concatenates the group database,
/etc/group.</para></sect4>
<para><command>igawk</command> gives gawk the ability to
include files.</para>
<sect4><title>igawk</title>
<para>igawk is a shell script which gives gawk the ability to
include files.</para></sect4>
<para><command>pgawk</command> is the profiling version of gawk.</para>
<sect4><title>pgawk, pgawk-3.1.1</title>
<para>pgawk is the profiling version of gawk.</para></sect4>
<sect4><title>pwcat</title>
<para>pwcat concatenates the password database,
/etc/passwd.</para></sect4>
<para><command>pwcat</command> dumps the password database
<filename>/etc/passwd</filename>.</para>
</sect3>
</sect2>

66
appendixa/gcc-desc.xml
View File

@ -6,66 +6,38 @@
<sect3><title>Program file descriptions</title>
<sect4><title>cc, cc1, cc1plus, gcc</title>
<para>These are the C compiler. A compiler translates source code in
text format to a format that a computer understands. After a source code
file is compiled into an object file, a linker will create an executable
file from one or more of these compiler generated object files.</para></sect4>
<para><command>c++filt</command> is used by the linker to demangle C++
symbols, to keep overloaded functions from clashing.</para>
<sect4><title>c++, cc1plus, g++</title>
<para>These are the C++ compiler, the equivalent of cc and
gcc etc.</para></sect4>
<para><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>
<sect4><title>c++filt</title>
<para>The C++ language provides function overloading, which means that it is
possible to write many functions with the same name (providing each takes
parameters of different types). All C++ function names are encoded into
a low-level assembly label (this process is known as mangling). The c++filt
program does the inverse mapping: it decodes (demangles) low-level names
into user-level names so that the linker can keep these overloaded functions
from clashing.</para></sect4>
<para><command>g++</command> is the C++ compiler.</para>
<sect4><title>collect2</title>
<para>collect2 assists with the compilation of constructors.</para></sect4>
<para><command>gcc</command> is the C compiler. It is used to translate
the source code of a program into assembly code.</para>
<sect4><title>cpp, cpp0</title>
<para>cpp pre-processes a source file, such as including the contents of
header files into the source file. Simply add a line, such as #include
&lt;filename&gt;, to your source file. The preprocessor will insert the
contents of the included file into the source file.</para></sect4>
<para><command>gccbug</command> is a shell script used to help create
good bug reports.</para>
<sect4><title>gccbug</title>
<para>gccbug is a shell script which is used to simplify the creation of
bug reports.</para></sect4>
<sect4><title>gcov</title>
<para>gcov analyzes programs to help create more efficient, faster running
code through optimization.</para></sect4>
<sect4><title>tradcpp0</title>
<para>No description is currently available.</para></sect4>
<para><command>gcov</command> is a coverage testing tool. It is used to
analyze programs to find out where optimizations will have the most effect.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libgcc, libgcc_eh, libgcc_s</title>
<para>Run-time support files for gcc.</para></sect4>
<para><command>libgcc*</command> contains run-time support for gcc.</para>
<sect4><title>libiberty</title>
<para>libiberty is a collection of subroutines used by various GNU
programs including getopt, obstack, strerror, strtol and strtoul.</para></sect4>
<para><command>libiberty</command> contains routines used by various GNU
programs, including getopt, obstack, strerror, strtol and strtoul.</para>
<sect4><title>libstdc++</title>
<para>libstdc++ is the C++ library. It is used by C++ programs and contains
functions that are frequently used in C++ programs. This way the
programmer doesn't have to write certain functions (such as writing a
string of text to the screen) from scratch every time he creates a
program.</para></sect4>
<para><command>libstdc++</command> is the standard C++ library. It contains
many frequently-used functions.</para>
<sect4><title>libsupc++</title>
<para>libsupc++ provides support for the c++ programming language. Among other
things, libsupc++ contains routines for exception handling.</para></sect4>
<para><command>libsupc++</command> provides supporting routines
for the c++ programming language.</para>
</sect3>

136
appendixa/gettext-desc.xml
View File

@ -6,123 +6,79 @@
<sect3><title>Program file descriptions</title>
<sect4><title>config.charset</title>
<para>The config.charset script outputs a system-dependent table of
character encoding aliases.</para></sect4>
<para><command>config.charset</command> outputs a system-dependent table of
character encoding aliases.</para>
<sect4><title>config.rpath</title>
<para>The config.rpath script outputs a system-dependent set of variables,
describing how to set the run time search path of shared libraries in an
executable.</para></sect4>
<para><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>
<sect4><title>gettext</title>
<para>The gettext package is used for internationalization (also known as
i18n) and for localization (also known as l10n). Programs can be
compiled with Native Language Support (NLS) which enable them to output
messages in the user's native language rather than in the default English
language.</para></sect4>
<para><command>gettext</command> translates a natural language message into
the user's language, by looking up the translation in a message catalog.</para>
<sect4><title>gettextize</title>
<para>The gettextize program copies all standard gettext files into a
directory. It's used to make a package with gettext translations.</para></sect4>
<para><command>gettextize</command> copies all standard Gettext files into
the given top-level directory of a package, to begin internationalizing it.</para>
<sect4><title>hostname</title>
<para>The hostname program displays a network hostname in various
forms.</para></sect4>
<para><command>hostname</command> displays a network hostname in various
forms.</para>
<sect4><title>msgattrib</title>
<para>The msgattrib program filters the messages of a translation catalog
according to their attributes and manipulates the attributes.</para></sect4>
<para><command>msgattrib</command> filters the messages of a translation
catalog according to their attributes and manipulates the attributes.</para>
<sect4><title>msgcat</title>
<para>The msgcat program finds messages which are common in several raw
translations.</para></sect4>
<para><command>msgcat</command> concatenates and merges the given
<filename>.po</filename> files.</para>
<sect4><title>msgcmp</title>
<para>The msgcmp program compares two raw translation files.</para></sect4>
<para><command>msgcmp</command> compares two <filename>.po</filename>
files to check that both contain the same set of msgid strings.</para>
<sect4><title>msgcomm</title>
<para>The msgcomm program searches messages which appear in several .po
files. It's used to compare how things are translated.</para></sect4>
<para><command>msgcomm</command> finds the messages that are common to
to the given <filename>.po</filename> files.</para>
<sect4><title>msgconv</title>
<para>The msgconv program converts a translation catalog to a different
character encoding.</para></sect4>
<para><command>msgconv</command> converts a translation catalog to a
different character encoding.</para>
<sect4><title>msgen</title>
<para>The msgen program creates an English translation catalog.</para></sect4>
<para><command>msgen</command> creates an English translation catalog.</para>
<sect4><title>msgexec</title>
<para>The msgexec program applies a command to all translations of a
translation catalog.</para></sect4>
<para><command>msgexec</command> applies a command to all translations of a
translation catalog.</para>
<sect4><title>msgfilter</title>
<para>The msgfilter program applies a filter to all translations of a
translation catalog.</para></sect4>
<para><command>msgfilter</command> applies a filter to all translations of a
translation catalog.</para>
<sect4><title>msgfmt</title>
<para>The msgfmt program compiles raw translation into machine code. It's
used to create the final program/package translation file.</para></sect4>
<para><command>msgfmt</command> generates a binary message catalog from
from a translation catalog.</para>
<sect4><title>msggrep</title>
<para>The msggrep program extracts all messages of a translation
catalog that match a given pattern or belong to some given source
files.</para></sect4>
<para><command>msggrep</command> extracts all messages of a translation
catalog that match a given pattern or belong to some given source files.</para>
<sect4><title>msginit</title>
<para>The msginit program creates a new PO file, initializing the
meta information with values from the user's environment.</para></sect4>
<para><command>msginit</command> creates a new <filename>.po</filename>
file, initializing the meta information with values from the user's
environment.</para>
<sect4><title>msgmerge</title>
<para>The msgmerge program combines two raw translations into one file.
It's used to update the raw translation with the source extract.</para></sect4>
<para><command>msgmerge</command> combines two raw translations into a
single file.</para>
<sect4><title>msgunfmt</title>
<para>The msgunfmt program decompiles translation files into raw
translation text. It can only be used if the compiled versions are
available.</para></sect4>
<para><command>msgunfmt</command> decompiles a binary message catalog
into raw translation text.</para>
<sect4><title>msguniq</title>
<para>The msguniq program unifies duplicate translations in a translation
catalog.</para></sect4>
<para><command>msguniq</command> unifies duplicate translations in a
translation catalog.</para>
<sect4><title>ngettext</title>
<para>The ngettext program displays native language translations of a
textual message whose grammatical form depends on a number.</para></sect4>
<para><command>ngettext</command> displays native language translations of a
textual message whose grammatical form depends on a number.</para>
<sect4><title>project-id</title>
<para>The project-id script prints a package's identification package
version or package.</para></sect4>
<sect4><title>team-address</title>
<para>The team-address script prints the team's address to stdout and
outputs additional instructions.</para></sect4>
<sect4><title>trigger</title>
<para>The trigger script tests whether the current package is a GNOME or
KDE package.</para></sect4>
<sect4><title>urlget</title>
<para>The urlget program gets the contents of a URL.</para></sect4>
<sect4><title>user-email</title>
<para>The user-email script prints the user's email address, with
confirmation from the user.</para></sect4>
<sect4><title>xgettext</title>
<para>The xgettext program extracts the message lines from the programmers' C
files. It's used to make the first translation template.</para></sect4>
<para><command>xgettext</command> extracts the translatable message lines
from the given source files, to make the first translation template.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libgettextlib</title>
<para>No description is currently available.</para></sect4>
<para><command>libgettextlib</command>...</para>
<sect4><title>libgettextsrc</title>
<para>No description is currently available.</para></sect4>
<para><command>libgettextsrc</command>...</para>
</sect3>
</sect2>

225
appendixa/glibc-desc.xml
View File

@ -6,201 +6,136 @@
<sect3><title>Program file descriptions</title>
<sect4><title>catchsegv</title>
<para>catchsegv can be used to create a stack trace when a program
terminates with a segmentation fault.</para></sect4>
<para><command>catchsegv</command> can be used to create a stack trace
when a program terminates with a segmentation fault.</para>
<sect4><title>gencat</title>
<para>gencat generates message catalogues.</para></sect4>
<para><command>gencat</command> generates message catalogues.</para>
<sect4><title>getconf</title>
<para>getconf displays the system configuration values for filesystem
specific variables.</para></sect4>
<para><command>getconf</command> displays the system configuration values
for filesystem specific variables.</para>
<sect4><title>getent</title>
<para>getent gets entries from an administrative database.</para></sect4>
<para><command>getent</command> gets entries from an administrative
database.</para>
<sect4><title>glibcbug</title>
<para>glibcbug creates a bug report about glibc and and mails it to the
bug email address.</para></sect4>
<para><command>glibcbug</command> creates a bug report and mails it to the
bug email address.</para>
<sect4><title>iconv</title>
<para>iconv performs character set conversion.</para></sect4>
<para><command>iconv</command> performs character set conversion.</para>
<sect4><title>iconvconfig</title>
<para>iconvconfig creates fastloading iconv module
configuration file.</para></sect4>
<para><command>iconvconfig</command> creates fastloading iconv module
configuration file.</para>
<sect4><title>ldconfig</title>
<para>ldconfig configures the dynamic linker run time bindings.</para></sect4>
<para><command>ldconfig</command> configures the dynamic linker runtime
bindings.</para>
<sect4><title>ldd</title>
<para>ldd prints the shared libraries required by each program or shared
library specified on the command line.</para></sect4>
<para><command>ldd</command> reports which shared libraries are required
by each given program or shared library.</para>
<sect4><title>lddlibc4</title>
<para>lddlibc4 assists ldd with object files.</para></sect4>
<para><command>lddlibc4</command> assists ldd with object files.</para>
<sect4><title>locale</title>
<para>locale is a Perl program which tells the compiler to enable
(or disable) the use of POSIX locales for built-in operations.</para></sect4>
<para><command>locale</command> is a Perl program that tells the compiler
to enable or disable the use of POSIX locales for built-in operations.</para>
<sect4><title>localedef</title>
<para>localedef compiles locale specifications.</para></sect4>
<para><command>localedef</command> compiles locale specifications.</para>
<sect4><title>mtrace</title>
<para>(No description available yet.)</para></sect4>
<para><command>mtrace</command>...</para>
<sect4><title>nscd</title>
<para>nscd is a daemon that provides a cache for the most common name
service requests.</para></sect4>
<para><command>nscd</command> is a name service cache daemon providing a
cache for the most common name service requests.</para>
<sect4><title>nscd_nischeck</title>
<para>nscd_nischeck checks whether or not secure mode is necessary for
NIS+ lookup.</para></sect4>
<para><command>nscd_nischeck</command> checks whether or not secure mode
is necessary for NIS+ lookup.</para>
<sect4><title>pcprofiledump</title>
<para>pcprofiledump dumps information generated by
PC profiling.</para></sect4>
<para><command>pcprofiledump</command> dumps information generated by
PC profiling.</para>
<sect4><title>pt_chown</title>
<para>pt_chown sets the owner, group and access permission of the
slave pseudo terminal corresponding to the master pseudo terminal passed
on file descriptor `3'. This is the helper program for the `grantpt'
function. It is not intended to be run directly from the command
line.</para></sect4>
<para><command>pt_chown</command> is a helper program for grantpt to set
the owner, group and access permissions of a slave pseudo terminal.</para>
<sect4><title>rpcgen</title>
<para>rpcgen generates C code to implement the RPC protocol.</para></sect4>
<para><command>rpcgen</command> generates C code to implement the
RPC protocol.</para>
<sect4><title>rpcinfo</title>
<para>rpcinfo makes an RPC call to an RPC server.</para></sect4>
<para><command>rpcinfo</command> makes an RPC call to an RPC server.</para>
<sect4><title>sln</title>
<para>sln symbolically links dest to source. It is statically linked,
needing no dynamic linking at all. Thus sln is useful to make symbolic
links to dynamic libraries if the dynamic linking system for some reason
is nonfunctional.</para></sect4>
<para><command>sln</command> 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>
<sect4><title>sprof</title>
<para>sprof reads and displays shared object profiling data.</para></sect4>
<para><command>sprof</command> reads and displays shared object profiling
data.</para>
<sect4><title>tzselect</title>
<para>tzselect asks the user for information about the current location and
outputs the resulting time zone description to standard output.</para></sect4>
<para><command>tzselect</command> asks the user about the location of the
system and reports the corresponding time zone description.</para>
<sect4><title>xtrace</title>
<para>xtrace traces execution of program by printing the currently executed
function.</para></sect4>
<para><command>xtrace</command> traces the execution of a program by
printing the currently executed function.</para>
<sect4><title>zdump</title>
<para>zdump is the time zone dumper.</para></sect4>
<para><command>zdump</command> is the time zone dumper.</para>
<sect4><title>zic</title>
<para>zic is the time zone compiler.</para></sect4>
<para><command>zic</command> is the time zone compiler.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>ld.so</title>
<para>ld.so is the helper program for shared library
executables.</para></sect4>
<para><command>ld.so</command> is the helper program for shared library
executables.</para>
<sect4><title>libBrokenLocale</title>
<para>Used by software, such as Mozilla, to solve broken locales.</para></sect4>
<para><command>libBrokenLocale</command> is used by programs, such as
Mozilla, to solve broken locales.</para>
<sect4><title>libSegFault</title>
<para>libSegFault is a segmentation fault signal handler. It tries to catch
segfaults.</para></sect4>
<para><command>libSegFault</command> is a segmentation fault signal
handler. It tries to catch segfaults.</para>
<sect4><title>libanl</title>
<para>libanl is an asynchronous name lookup library.</para></sect4>
<para><command>libanl</command> is an asynchronous name lookup
library.</para>
<sect4><title>libbsd-compat</title>
<para>libbsd-compat provides the portability needed in order to run certain
programs in Linux.</para></sect4>
<para><command>libbsd-compat</command> provides the portability needed
in order to run certain BSD programs under Linux.</para>
<sect4><title>libc, libc_nonshared</title>
<para>These files constitute the main C library. The C library is a
collection of commonly used functions in programs.
This way a programmer doesn't need to create his own functions for every
single task. The most common things like writing a string to the screen
are already present and at the disposal of the programmer.</para>
<para><command>libc</command> is the main C library -- a collection of
commonly used functions.</para>
<para>The C library (actually almost every library) comes in two flavors:
a dynamic and a static one. In short, when a program uses a static C
library, the code from the C library is copied into the executable file.
When a program uses a dynamic library, the executable will not
contain the code from the C library, but instead a routine that loads
the functions from the library at the time the program is run. This
means a significant decrease in the file size of a program. The
documentation that comes with the C library describes this in more
detail, as it is too complicated to explain here in one or two
lines.</para></sect4>
<para><command>libcrypt</command> is the cryptography library.</para>
<sect4><title>libcrypt</title>
<para>libcrypt is the cryptography library.</para></sect4>
<para><command>libdl</command> is the dynamic linking interface library.</para>
<sect4><title>libdl</title>
<para>libdl is the dynamic linking interface library.</para></sect4>
<para><command>libg</command> is a runtime library for g++.</para>
<sect4><title>libg</title>
<para>libg is a runtime library for g++.</para></sect4>
<para><command>libieee</command> is the IEEE floating point library.</para>
<sect4><title>libieee</title>
<para>libieee is the IEEE floating point library.</para></sect4>
<para><command>libm</command> is the mathematical library.</para>
<sect4><title>libm</title>
<para>libm is the mathematical library.</para></sect4>
<para><command>libmcheck</command> contains code run at boot.</para>
<sect4><title>libmcheck</title>
<para>libmcheck contains code run at boot.</para></sect4>
<para><command>libmemusage</command> is used by memusage to help collect
information about the memory usage of a program.</para>
<sect4><title>libmemusage</title>
<para>libmemusage is used by memusage to help collect information about the
memory usage of a program.</para></sect4>
<para><command>libnsl</command> is the network services library.</para>
<sect4><title>libnsl</title>
<para>libnsl is the network services library.</para></sect4>
<para><command>libnss*</command> are the Name Service Switch libraries,
containing functions for resolving host names, user names, group names,
aliases, services, protocols,and the like.</para>
<sect4><title>libnss_compat, libnss_dns, libnss_files,
libnss_hesiod, libnss_nis, libnss_nisplus</title>
<para>The basic idea is to put the implementation of the different services
offered to access the databases in separate modules. This has some
advantages:</para>
<itemizedlist>
<listitem><para>contributors can add new services without adding them to
GNU C library,</para></listitem>
<listitem><para>the modules can be updated separately,</para></listitem>
<listitem><para>the C library image is smaller.</para></listitem>
</itemizedlist></sect4>
<para><command>libpcprofile</command> contains profiling functions used
to track the amount of CPU time spent in which source code lines.</para>
<sect4><title>libpcprofile</title>
<para>Code used by the kernel to track CPU time spent in functions, source
code lines, and instructions.</para></sect4>
<para><command>libpthread</command> is the POSIX threads library.</para>
<sect4><title>libpthread</title>
<para>The POSIX threads library.</para></sect4>
<para><command>libresolv</command> contains functions for creating,
sending, and interpreting packets to the Internet domain name servers.</para>
<sect4><title>libresolv</title>
<para>Functions in this library provide for creating, sending, and
interpreting packets to the Internet domain name servers.</para></sect4>
<para><command>librpcsvc</command>contains functions providing
miscellaneous RPC services.</para>
<sect4><title>librpcsvc</title>
<para>Functions in this library provide miscellaneous RPC services.</para></sect4>
<para><command>librt</command> contains functions providing most of the
interfaces specified by the POSIX.1b Realtime Extension.</para>
<sect4><title>librt</title>
<para>Functions in this library provide most of the interfaces specified by
the POSIX.1b Realtime Extension.</para></sect4>
<para><command>libthread_db</command> contains functions useful for
building debuggers for multi-threaded programs.</para>
<sect4><title>libthread_db</title>
<para>Functions is this library are useful for building debuggers for
multi-threaded programs.</para></sect4>
<sect4><title>libutil</title>
<para>Contains code for "standard" functions used in many different Unix
utilities.</para></sect4>
<para><command>libutil</command> contains code for "standard" functions
used in many different Unix utilities.</para>
</sect3>

15
appendixa/grep-desc.xml
View File

@ -6,17 +6,14 @@
<sect3><title>Program file descriptions</title>
<sect4><title>egrep</title>
<para>egrep prints lines from files matching an extended regular expression
pattern.</para></sect4>
<para><command>egrep</command> prints lines matching an extended regular
expression.</para>
<sect4><title>fgrep</title>
<para>fgrep prints lines from files matching a list of fixed strings,
separated by newlines, any of which is to be matched.</para></sect4>
<para><command>fgrep</command> prints lines matching a list of fixed
strings.</para>
<sect4><title>grep</title>
<para>grep prints lines from files matching a basic regular expression
pattern.</para></sect4>
<para><command>grep</command> prints lines matching a basic regular
expression.</para>
</sect3>

153
appendixa/groff-desc.xml
View File

@ -6,123 +6,100 @@
<sect3><title>Program file descriptions</title>
<sect4><title>addftinfo</title>
<para>addftinfo reads a troff font file and adds some additional font-metric
information that is used by the groff system.</para></sect4>
<para><command>addftinfo</command> reads a troff font file and adds some
additional font-metric information that is used by the groff system.</para>
<sect4><title>afmtodit</title>
<para>afmtodit creates a font file for use with groff and grops.</para></sect4>
<para><command>afmtodit</command> creates a font file for use with
groff and grops.</para>
<sect4><title>eqn</title>
<para>eqn compiles descriptions of equations embedded within troff input files
into commands that are understood by troff.</para></sect4>
<para><command>eqn</command> compiles descriptions of equations embedded
within troff input files into commands that are understood by troff.</para>
<sect4><title>geqn</title>
<para>geqn is the GNU implementation of eqn.</para></sect4>
<para><command>grn</command> is a groff preprocessor for gremlin files.</para>
<sect4><title>grn</title>
<para>grn is a groff preprocessor for gremlin files.</para></sect4>
<para><command>grodvi</command> is a driver for groff that produces TeX dvi format.</para>
<sect4><title>grodvi</title>
<para>grodvi is a driver for groff that produces TeX dvi format.</para></sect4>
<para><command>groff</command> 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>
<sect4><title>groff</title>
<para>groff 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></sect4>
<para><command>grog</command> 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>
<sect4><title>grog</title>
<para>grog reads files and guesses which of the groff options -e, -man, -me,
-mm, -ms, -p, -s, and -t are required for printing files, and prints the groff
command including those options on the standard output.</para></sect4>
<para><command>grolbp</command> is a groff driver for Canon CAPSL printers
(LBP-4 and LBP-8 series laser printers).</para>
<sect4><title>grolbp</title>
<para>grolbp is a groff driver for Canon CAPSL printers (LBP-4 and LBP-8
series laser printers).</para></sect4>
<para><command>grolj4</command> is a driver for groff that produces output
in PCL5 format suitable for an HP Laserjet 4 printer.</para>
<sect4><title>grolj4</title>
<para>grolj4 is a driver for groff that produces output in PCL5 format suitable
for an HP Laserjet 4 printer.</para></sect4>
<para><command>grops</command> translates the output of GNU troff to
Postscript.</para>
<sect4><title>grops</title>
<para>grops translates the output of GNU troff to Postscript.</para></sect4>
<para><command>grotty</command> translates the output of GNU troff into
a form suitable for typewriter-like devices.</para>
<sect4><title>grotty</title>
<para>grotty translates the output of GNU troff into a form suitable for
typewriter-like devices.</para></sect4>
<para><command>gtbl</command> is the GNU implementation of tbl.</para>
<sect4><title>gtbl</title>
<para>gtbl is the GNU implementation of tbl.</para></sect4>
<para><command>hpftodit</command> creates a font file for use with
groff -Tlj4 from an HP-tagged font metric file.</para>
<sect4><title>hpftodit</title>
<para>hpftodit creates a font file for use with groff -Tlj4 from an HP
tagged font metric file.</para></sect4>
<para><command>indxbib</command> makes an inverted index for the
bibliographic databases a specified file for use with refer, lookbib,
and lkbib.</para>
<sect4><title>indxbib</title>
<para>indxbib makes an inverted index for the bibliographic databases a
specified file for use with refer, lookbib, and lkbib.</para></sect4>
<para><command>lkbib</command> searches bibliographic databases for
references that contain specified keys and reports any references found.</para>
<sect4><title>lkbib</title>
<para>lkbib searches bibliographic databases for references that contain
specified keys and prints any references found on the
standard output.</para></sect4>
<para><command>lookbib</command> 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>
<sect4><title>lookbib</title>
<para>lookbib 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></sect4>
<para><command>mmroff</command> is a simple preprocessor for groff.</para>
<sect4><title>mmroff</title>
<para>mmroff is a simple preprocessor for groff.</para></sect4>
<para><command>neqn</command> formats equations for ascii output.</para>
<sect4><title>neqn</title>
<para>The neqn script formats equations for ascii output.</para></sect4>
<para><command>nroff</command> is a script that emulates the nroff command
using groff.</para>
<sect4><title>nroff</title>
<para>The nroff script emulates the nroff command using groff.</para></sect4>
<para><command>pfbtops</command> translates a Postscript font in .pfb
format to ASCII.</para>
<sect4><title>pfbtops</title>
<para>pfbtops translates a Postscript font in .pfb format
to ASCII.</para></sect4>
<para><command>pic</command> compiles descriptions of pictures embedded
within troff or TeX input files into commands understood by TeX or troff.</para>
<sect4><title>pic</title>
<para>pic compiles descriptions of pictures embedded within troff or TeX input
files into commands that are understood by TeX or troff.</para></sect4>
<para><command>pre-grohtml </command> translates the output of GNU troff
to html.</para>
<sect4><title>pre-grohtml and post-grohtml</title>
<para>pre- and post-grohtml translate the output of GNU troff
to html.</para></sect4>
<para><command>post-grohtml</command> translates the output of GNU troff
to html.</para>
<sect4><title>refer</title>
<para>refer 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></sect4>
<para><command>refer</command> 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>
<sect4><title>soelim</title>
<para>soelim reads files and replaces lines of the form
<emphasis>.so file</emphasis> by the contents of
<emphasis>file</emphasis>.</para></sect4>
<para><command>soelim</command> reads files and replaces lines of the form
<emphasis>.so file</emphasis> by the contents of the mentioned
<emphasis>file</emphasis>.</para>
<sect4><title>tbl</title>
<para>tbl compiles descriptions of tables embedded within troff input files
into commands that are understood by troff.</para></sect4>
<para><command>tbl</command> compiles descriptions of tables embedded
within troff input files into commands that are understood by troff.</para>
<sect4><title>tfmtodit</title>
<para>tfmtodit creates a font file for use with <userinput>groff
-Tdvi</userinput>.</para></sect4>
<para><command>tfmtodit</command> creates a font file for use with
groff -Tdvi.</para>
<sect4><title>troff</title>
<para>troff 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></sect4>
<para><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>
<sect4><title>zsoelim</title>
<para>zsoelim is the GNU implementation of soelim.</para></sect4>
<para><command>zsoelim</command> is the GNU implementation of soelim.</para>
</sect3>
</sect2>

15
appendixa/grub-desc.xml
View File

@ -2,6 +2,19 @@
<sect2><title>Descriptions</title>
<para>(To be determined)</para>
<para>(Last checked against version &grub-contversion;.)</para>
<para><command>grub</command> is the GRand Unified Bootloader's command
shell.</para>
<para><command>grub-install</command> installs GRUB on the given device.</para>
<para><command>grub-md5-crypt</command> encrypts a password in MD5
format.</para>
<para><command>grub-terminfo</command> generates a terminfo command from a
terminfo name. It can be used if you have an uncommon terminal.</para>
<para><command>mbchk</command> checks the format of a multiboot kernel.</para>
</sect2>

49
appendixa/gzip-desc.xml
View File

@ -6,46 +6,35 @@
<sect3><title>Program file descriptions</title>
<sect4><title>gunzip, uncompress</title>
<para>gunzip and uncompress decompress files which are compressed with
gzip.</para></sect4>
<para><command>gunzip</command> decompresses gzipped files.</para>
<sect4><title>gzexe</title>
<para>gzexe allows you to compress executables in place and have them
automatically uncompress and execute when they are run (at a penalty in
performance).</para></sect4>
<para><command>gzexe</command> is used to create self-uncompressing
executable files.</para>
<sect4><title>gzip</title>
<para>gzip reduces the size of the named files using
Lempel-Ziv coding (LZ77).</para></sect4>
<para><command>gzip</command> compresses the given files, using
Lempel-Ziv (LZ77) coding.</para>
<sect4><title>zcat</title>
<para>zcat uncompresses, and writes to standard output, either a list of files
on the command line or a file being read from standard input.</para></sect4>
<para><command>zcat</command> uncompresses the given gzipped files to
standard output.</para>
<sect4><title>zcmp</title>
<para>zcmp invokes the cmp program on compressed files.</para></sect4>
<para><command>zcmp</command> runs cmp on gzipped files.</para>
<sect4><title>zdiff</title>
<para>zdiff invokes the diff program on compressed files.</para></sect4>
<para><command>zdiff</command> runs diff on gzipped files.</para>
<sect4><title>zforce</title>
<para>zforce forces a .gz extension on all gzip files so that gzip will not
compress them twice. This can be useful for files with names truncated
after a file transfer.</para></sect4>
<para><command>zforce</command> 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>
<sect4><title>zgrep</title>
<para>zgrep invokes the grep program on compressed files.</para></sect4>
<para><command>zgrep</command> runs grep on gzipped files.</para>
<sect4><title>zmore</title>
<para>zmore is a filter which allows examination of compressed or plain text
files, one screen at a time on a soft-copy terminal (similar to the
more program).</para></sect4>
<para><command>zless</command> runs less on gzipped files.</para>
<sect4><title>znew</title>
<para>znew re-compresses files from .Z (compress) format to
.gz (gzip) format.</para></sect4>
<para><command>zmore</command> runs more on gzipped files.</para>
<para><command>znew</command> recompresses files from compress format
to gzip format -- .Z to .gz.</para>
</sect3>
</sect2>

57
appendixa/inetutils-desc.xml
View File

@ -6,59 +6,44 @@
<sect3><title>Program file descriptions</title>
<sect4><title>ftp</title>
<para>ARPANET file transfer program.</para></sect4>
<para><command>ftp</command> is the ARPANET file transfer program.</para>
<sect4><title>ping</title>
<para>send ICMP_ECHO_REQUEST packets to network hosts.</para></sect4>
<para><command>ping</command> sends echo-request packets and reports how
long the replies take.</para>
<sect4><title>rcp</title>
<para>remote file copy.</para></sect4>
<para><command>rcp</command> does remote file copy.</para>
<sect4><title>rlogin</title>
<para>remote login.</para></sect4>
<para><command>rlogin</command> does remote login.</para>
<sect4><title>rsh</title>
<para>remote shell.</para></sect4>
<para><command>rsh</command> runs a remote shell.</para>
<sect4><title>talk</title>
<para>talk to another user.</para></sect4>
<para><command>talk</command> is used to chat up another user.</para>
<sect4><title>telnet</title>
<para>user interface to the TELNET protocol.</para></sect4>
<para><command>telnet</command> is an interface to the TELNET protocol.</para>
<sect4><title>tftp</title>
<para>trivial file transfer program.</para></sect4>
<para><command>tftp</command> is a trivial file transfer program.</para>
<sect4><title>whois</title>
<para>client for whois directory service.</para></sect4>
<para><command>whois</command> queries the whois directory service.</para>
<sect4><title>ftpd</title>
<para>DARPA Internet File Transfer Protocol server.</para></sect4>
<para><command>ftpd</command> is a daemon for trivial file transfers.</para>
<sect4><title>inetd</title>
<para>internet super-service.</para></sect4>
<para><command>inetd</command> is the internet super-service.</para>
<sect4><title>rexecd</title>
<para>remote execution server.</para></sect4>
<para><command>rexecd</command> is the remote execution server.</para>
<sect4><title>rlogind</title>
<para>remote login server.</para></sect4>
<para><command>rlogind</command> is the remote login server.</para>
<sect4><title>rshd</title>
<para>remote shell server.</para></sect4>
<para><command>rshd</command> is the remote shell server.</para>
<sect4><title>talkd</title>
<para>remote user communication server.</para></sect4>
<para><command>talkd</command> is the remote user communication server.</para>
<sect4><title>telnetd</title>
<para>DARPA TELNET protocol server.</para></sect4>
<para><command>telnetd</command> is the TELNET protocol server.</para>
<sect4><title>tftpd</title>
<para>Internet Trivial File Transfer Protocol server.</para></sect4>
<para><command>tftpd</command> is another daemon for trivial file transfers.</para>
<para><command>uucpd</command>...</para>
<sect4><title>uucpd</title>
<para>No description available.</para></sect4>
</sect3>
</sect2>

95
appendixa/kbd-desc.xml
View File

@ -6,89 +6,64 @@
<sect3><title>Program file descriptions</title>
<sect4><title>chvt</title>
<para>chvt changes foreground virtual terminal.</para></sect4>
<para><command>chvt</command> changes the foreground virtual terminal.</para>
<sect4><title>deallocvt</title>
<para>deallocvt deallocates unused virtual terminals.</para></sect4>
<para><command>deallocvt</command> deallocates unused virtual terminals.</para>
<sect4><title>dumpkeys</title>
<para>dumpkeys dumps keyboard translation tables.</para></sect4>
<para><command>dumpkeys</command> dumps the keyboard translation tables.</para>
<sect4><title>fgconsole</title>
<para>fgconsole prints the number of the active virtual terminal.</para></sect4>
<para><command>fgconsole</command> prints the number of the active virtual terminal.</para>
<sect4><title>getkeycodes</title>
<para>getkeycodes prints the kernel scancode-to-keycode
mapping table.</para></sect4>
<para><command>getkeycodes</command> prints the kernel scancode-to-keycode
mapping table.</para>
<sect4><title>getunimap</title>
<para>getunimap prints the currently used unimap.</para></sect4>
<para><command>getunimap</command> prints the currently used unimap.</para>
<sect4><title>kbd_mode</title>
<para>kbd_mode reports or sets the keyboard mode.</para></sect4>
<para><command>kbd_mode</command> reports or sets the keyboard mode.</para>
<sect4><title>kbdrate</title>
<para>kbdrate sets the keyboard repeat and delay rates.</para></sect4>
<para><command>kbdrate</command> sets the keyboard repeat and delay rates.</para>
<sect4><title>loadkeys</title>
<para>loadkeys loads keyboard translation tables.</para></sect4>
<para><command>loadkeys</command> loads the keyboard translation tables.</para>
<sect4><title>loadunimap</title>
<para>loadunimap loads the kernel unicode-to-font mapping table.</para></sect4>
<para><command>loadunimap</command> loads the kernel unicode-to-font mapping table.</para>
<sect4><title>mapscrn</title>
<para>mapscrn loads a user defined output character
mapping table into the console driver. Note that it is obsolete and that its
features are built into setfont.</para></sect4>
<para><command>mapscrn</command> 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>
<sect4><title>openvt</title>
<para>openvt starts a program on a new virtual terminal (VT).</para></sect4>
<para><command>openvt</command> starts a program on a new virtual terminal (VT).</para>
<sect4><title>psfaddtable, psfgettable, psfstriptable, psfxtable</title>
<para>These are a set of tools for handling Unicode character tables for
console fonts.</para></sect4>
<para><command>psf*</command> are a set of tools for handling Unicode
character tables for console fonts.</para>
<sect4><title>resizecons</title>
<para>resizecons changes the kernel idea of the console size.</para></sect4>
<para><command>resizecons</command> changes the kernel idea of the console size.</para>
<sect4><title>setfont</title>
<para>This lets you change the EGA/VGA fonts in console.</para></sect4>
<para><command>setfont</command> lets you change the EGA/VGA fonts on the console.</para>
<sect4><title>setkeycodes</title>
<para>setkeycodes loads kernel scancode-to-keycode mapping
table entries.</para></sect4>
<para><command>setkeycodes</command> loads kernel scancode-to-keycode
mapping table entries, useful if you have some unusual keys on your keyboard.</para>
<sect4><title>setleds</title>
<para>setleds sets the keyboard LEDs. Many people find it useful to have numlock
enabled by default and, by using this program, you can
achieve this.</para></sect4>
<para><command>setleds</command> sets the keyboard flags and LEDs. Many
people find it useful to have NumLock on by default, setleds +num achieves this.</para>
<sect4><title>setlogcons</title>
<para>setlogcons sends kernel messages to the console.</para></sect4>
<para><command>setlogcons</command> sends kernel messages to the console.</para>
<sect4><title>setmetamode</title>
<para>setmetamode defines the keyboard meta key handling.</para></sect4>
<para><command>setmetamode</command> defines the keyboard meta key handling.</para>
<sect4><title>setvesablank</title>
<para>This lets you fiddle with the built-in hardware screensaver
(not toasters, only a blank screen).</para></sect4>
<para><command>setvesablank</command> lets you fiddle with the built-in
hardware screensaver (no toasters, just a blank screen).</para>
<sect4><title>showfont</title>
<para>showfont displays data about a font. The information shown includes font
information, font properties, character metrics and
character bitmaps.</para></sect4>
<para><command>showfont</command> displays data about a font, including
font properties, character metrics and character bitmaps.</para>
<sect4><title>showkey</title>
<para>showkey examines the scancodes and keycodes sent by
the keyboard.</para></sect4>
<para><command>showkey</command> reports the scancodes and keycodes and
ASCII codes of the keys pressed on the keyboard.</para>
<sect4><title>unicode_start</title>
<para>unicode_start puts the console in Unicode mode.</para></sect4>
<para><command>unicode_start</command> puts the keyboard and console in
unicode mode.</para>
<sect4><title>unicode_stop</title>
<para>unicode_stop reverts keyboard and console from
unicode mode.</para></sect4>
<para><command>unicode_stop</command> reverts keyboard and console from
unicode mode.</para>
</sect3>

29
appendixa/kernel-desc.xml
View File

@ -4,23 +4,20 @@
<para>(Last checked against version &kernel-contversion;.)</para>
<sect3><title>Program file descriptions</title>
<sect3><title>File descriptions</title>
<sect4><title>linux kernel</title>
<para>The Linux kernel is at the core of every Linux system. It's what makes
Linux tick. When a computer is turned on and boots a Linux system, the
very first piece of Linux software that gets loaded is the kernel. The
kernel initializes the system's hardware components: serial ports, parallel
ports, sound cards, network cards, IDE controllers, SCSI controllers and a
lot more. In a nutshell the kernel makes the hardware available so that the
software can run.</para></sect4>
<sect4><title>linux kernel headers</title>
<para>These are the files we copy to
<filename>/usr/include/{linux,asm}</filename> in Chapter 6. They should
match those which glibc was compiled against and therefore should
<emphasis>not</emphasis> be replaced when upgrading the kernel. They are
essential for compiling many programs.</para></sect4>
<para>The <emphasis>kernel</emphasis> 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>
<para>The <emphasis>kernel headers</emphasis> 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>
</sect3>

2
appendixa/kernel-shortdesc.xml
View File

@ -12,7 +12,7 @@ software can run.</para>
<para>Linux installs the following files:</para>
<sect3><title>Program Files</title>
<sect3><title>Files</title>
<para>kernel and kernel headers</para></sect3>
</sect2>

19
appendixa/less-desc.xml
View File

@ -6,20 +6,15 @@
<sect3><title>Program file descriptions</title>
<sect4><title>less</title>
<para>The less program is a file pager (or text viewer). It
displays the contents of a file and has the ability to scroll. Less is an
improvement on the common pager called <quote>more</quote>. Less has
the ability to scroll backwards through files as well and it doesn't need
to read the entire file when it starts, which makes it faster when reading
large files.</para></sect4>
<para><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>
<sect4><title>lessecho</title>
<para>lessecho is needed to expand metacharacters, such as * and ?, in
filenames on Unix systems.</para></sect4>
<para><command>lessecho</command> is needed to expand metacharacters,
such as * and ?, in filenames on Unix systems.</para>
<sect4><title>lesskey</title>
<para>lesskey is used to specify key bindings for less.</para></sect4>
<para><command>lesskey</command> is used to specify the key bindings
for less.</para>
</sect3>

23
appendixa/lfs-utils-desc.xml
View File

@ -6,21 +6,20 @@
<sect3><title>Program file descriptions</title>
<sect4><title>mktemp</title>
<para>mktemp creates temporary files in a secure manner for use in scripts.</para></sect4>
<para><command>mktemp</command> creates temporary files in a secure manner.
It is used in scripts.</para>
<sect4><title>tempfile</title>
<para>tempfile creates temporary files in a less secure manner than mktemp.
It is installed for backwards-compatibility.</para></sect4>
<para><command>tempfile</command> creates temporary files in a less secure
manner than <userinput>mktemp</userinput>. It is installed for
backwards-compatibility.</para>
<sect4><title>http-get</title>
<para>http-get is a script that takes advantage of a little known
feature of Bash called "net redirection". It is used to download from
websites without using any third-party programs.</para></sect4>
<para>The <command>http-get</command> script takes advantage of a little known
feature of <userinput>bash</userinput> called "net redirection". It is used to
download from websites without using any other programs.</para>
<sect4><title>iana-net</title>
<para>iana-net uses the http-get to simplify the process of procuring
IANA's services and protocols configuration files.</para></sect4>
<para><command>iana-net</command> uses the <userinput>http-get</userinput>
script to simplify the process of procuring IANA's services and protocols
configuration files.</para>
</sect3>

14
appendixa/libtool-desc.xml
View File

@ -6,21 +6,17 @@
<sect3><title>Program file descriptions</title>
<sect4><title>libtool</title>
<para>libtool provides generalized library-building
support services.</para></sect4>
<para><command>libtool</command> provides generalized library-building
support services.</para>
<sect4><title>libtoolize</title>
<para>libtoolize provides a standard way to add libtool support to a
package.</para></sect4>
<para><command>libtoolize</command> provides a standard way to add
libtool support to a package.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libltdl, libltdl.so.3, libltdl.so.3.1.0</title>
<para>A small library that aims at hiding, from programmers,
the various difficulties of dlopening libraries.</para></sect4>
<para><command>libltdl*</command>...</para>
</sect3>

16
appendixa/m4-desc.xml
View File

@ -6,15 +6,15 @@
<sect3><title>Program file descriptions</title>
<sect4><title>m4</title>
<para>m4 is a macro processor. It copies input to output, expanding macros as it
goes. 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, etc. The m4 program can be used either
as a front-end to a compiler or as a macro processor in its own
right.</para></sect4>
<para><command>m4</command> copies the given files
while expanding the macros that it contains. 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>
</sect3>
</sect2>

5
appendixa/make-desc.xml
View File

@ -6,9 +6,8 @@
<sect3><title>Program file descriptions</title>
<sect4><title>make</title>
<para>make determines, automatically, which pieces of a large program need
to be recompiled and issues the commands to recompile them.</para></sect4>
<para><command>make</command> automatically determines which pieces of a
large package need to be recompiled, and then issues the relevant commands.</para>
</sect3>

9
appendixa/makedev-desc.xml
View File

@ -6,12 +6,9 @@
<sect3><title>Program file descriptions</title>
<sect4><title>MAKEDEV</title>
<para><filename>MAKEDEV</filename> is a script that creates the necessary
static device nodes usually residing in the
<filename class="directory">/dev</filename> directory.
Detailed information on device nodes can be found in the Linux kernel source
tree in <filename>Documentation/devices.txt</filename>.</para></sect4>
<para><command>MAKEDEV</command> is a script for creating the necessary
static device nodes, usually residing in the <filename>/dev</filename>
directory.</para>
</sect3>

33
appendixa/man-desc.xml
View File

@ -6,32 +6,23 @@
<sect3><title>Program file descriptions</title>
<sect4><title>apropos</title>
<para>apropos searches for keywords in a set of database files, containing
short descriptions of system commands, and displays the result on the standard
output.</para></sect4>
<para><command>apropos</command> searches the whatis database and displays
the short descriptions of system commands that contain a given string.</para>
<sect4><title>makewhatis</title>
<para>makewhatis reads all the manual pages contained in given sections of
manpath or the pre-formatted pages contained in the given sections of
catpath. For each page, it writes a line in the whatis database. Each
line consists of the name of the page and a short description,
separated by a dash. The description is extracted using the content of
the NAME section of the manual page.</para></sect4>
<para><command>makewhatis</command> 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>
<sect4><title>man</title>
<para>man formats and displays the on-line manual pages.</para></sect4>
<para><command>man</command> formats and displays the requested on-line
manual page.</para>
<sect4><title>man2dvi</title>
<para>man2dvi converts a manual page into dvi format.</para></sect4>
<para><command>man2dvi</command> converts a manual page into dvi format.</para>
<sect4><title>man2html</title>
<para>man2html converts a manual page into html.</para></sect4>
<para><command>man2html</command> converts a manual page into html.</para>
<sect4><title>whatis</title>
<para>whatis searches for keywords in a set of database files, containing short
descriptions of system commands, and displays the result on the standard
output. Only complete word matches are displayed.</para></sect4>
<para><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>
</sect3>

46
appendixa/modutils-desc.xml
View File

@ -6,45 +6,33 @@
<sect3><title>Program file descriptions</title>
<sect4><title>depmod</title>
<para>depmod handles dependency descriptions for loadable
kernel modules.</para></sect4>
<para><command>depmod</command> 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>
<sect4><title>genksyms</title>
<para>genksyms reads (on standard input) the output from gcc -E source.c
and generates a file containing version information.</para></sect4>
<para><command>genksyms</command> generates symbol version information.</para>
<sect4><title>insmod</title>
<para>insmod installs a loadable module in the running kernel.</para></sect4>
<para><command>insmod</command> installs a loadable module in the running kernel.</para>
<sect4><title>insmod_ksymoops_clean</title>
<para>insmod_ksymoops_clean deletes saved ksyms and modules not accessed in
2 days.</para></sect4>
<para><command>insmod_ksymoops_clean</command> deletes saved ksyms and
modules not accessed for two days.</para>
<sect4><title>kallsyms</title>
<para>kallsyms extracts all kernel symbols for debugging.</para></sect4>
<para><command>kallsyms</command> extracts all kernel symbols for debugging.</para>
<sect4><title>kernelversion</title>
<para>kernelversion reports the major version of the
running kernel.</para></sect4>
<para><command>kernelversion</command> reports the major version of the
running kernel.</para>
<sect4><title>ksyms</title>
<para>ksyms displays exported kernel symbols.</para></sect4>
<para><command>ksyms</command> displays exported kernel symbols.</para>
<sect4><title>lsmod</title>
<para>lsmod shows information about all loaded modules.</para></sect4>
<para><command>lsmod</command> shows which modules are loaded.</para>
<sect4><title>modinfo</title>
<para>modinfo examines an object file associated with a kernel module and
displays any information that it can glean.</para></sect4>
<para><command>modinfo</command> examines an object file associated with
a kernel module and displays any information that it can glean.</para>
<sect4><title>modprobe</title>
<para>modprobe uses a Makefile-like dependency file, created by depmod,
to automatically load the relevant module(s) from the set of modules
available in predefined directory trees.</para></sect4>
<para><command>modprobe</command> uses a dependency file, created by
depmod, to automatically load the relevant modules.</para>
<sect4><title>rmmod</title>
<para>rmmod unloads loadable modules from the running kernel.</para></sect4>
<para><command>rmmod</command> unloads modules from the running kernel.</para>
</sect3>

77
appendixa/ncurses-desc.xml
View File

@ -6,73 +6,52 @@
<sect3><title>Program file descriptions</title>
<sect4><title>captoinfo</title>
<para>captoinfo converts a termcap description into a terminfo
description.</para></sect4>
<para><command>captoinfo</command> converts a termcap description into a
terminfo description.</para>
<sect4><title>clear</title>
<para>clear clears the screen if this is possible. It looks in
the environment for the terminal type and then in the terminfo database
to figure out how to clear the screen.</para></sect4>
<para><command>clear</command> clears the screen, if this is possible.</para>
<sect4><title>infocmp</title>
<para>infocmp can be used to compare a binary terminfo entry with
other terminfo entries, rewrite a terminfo description to
take advantage of the use= terminfo field, or print out a
terminfo description from the binary file (term) in a variety of
formats (the opposite of what tic does).</para></sect4>
<para><command>infocmp</command> compares or prints out terminfo
descriptions.</para>
<sect4><title>infotocap</title>
<para>info to cap converts a terminfo description into a termcap
description.</para></sect4>
<para><command>infotocap</command> converts a terminfo description into
a termcap description.</para>
<sect4><title>reset</title>
<para>reset sets cooked and echo modes, turns off cbreak and raw modes,
turns on new-line translation and resets any unset special characters to
their default values before doing terminal initialization the same way
as tset.</para></sect4>
<para><command>reset</command> reinitializes a terminal to its default
values.</para>
<sect4><title>tack</title>
<para>tack is the terminfo action checker.</para></sect4>
<para><command>tack</command> is the terminfo action checker. It is mainly
used to test the correctness of an entry in the terminfo database.</para>
<sect4><title>tic</title>
<para>tic is the terminfo entry-description compiler. The program translates a
terminfo file from source format into the binary format for use with the
ncurses library routines. Terminfo files contain information about the
capabilities of a terminal.</para></sect4>
<para><command>tic</command> 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>
<sect4><title>toe</title>
<para>toe lists all available terminal types by primary name with
descriptions.</para></sect4>
<para><command>toe</command> lists all available terminal types, for each
giving its primary name and its description.</para>
<sect4><title>tput</title>
<para>tput uses the terminfo database to make the values of
terminal-dependent capabilities and information available to the shell,
to initialize or reset the terminal, or return the long name of the
requested terminal type.</para></sect4>
<para><command>tput</command> 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>
<sect4><title>tset</title>
<para>tset initializes terminals so they can be used, but it's not
widely used anymore. It's provided for 4.4BSD compatibility.</para></sect4>
<para><command>tset</command> can be used to initialize terminals.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libcurses, libncurses++, libncurses, libncurses_g</title>
<para>These libraries are the base of the system and are used to display
text (often in a fancy way) on the screen. An example where ncurses is used
is in the kernel's <quote>make menuconfig</quote> process.</para></sect4>
<para><command>libncurses*</command> contain 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>
<sect4><title>libform, libform_g</title>
<para>libform is used to implement forms in ncurses.</para></sect4>
<para><command>libform*</command> contain functions to implement forms.</para>
<sect4><title>libmenu, libmenu_g</title>
<para>libmenu is used to implement menus in ncurses.</para></sect4>
<para><command>libmenu*</command> contain functions to implement menus.</para>
<sect4><title>libpanel, libpanel_g</title>
<para>libpanel is used to implement panels in ncurses.</para></sect4>
<para><command>libpanel*</command> contain functions to implement panels.</para>
</sect3>
</sect2>

64
appendixa/nettools-desc.xml
View File

@ -6,57 +6,43 @@
<sect3><title>Program file descriptions</title>
<sect4><title>arp</title>
<para>arp is used to manipulate the kernel's ARP cache, usually to add
or delete an entry, or to dump the ARP cache.</para></sect4>
<para><command>arp</command> is used to manipulate the kernel's ARP cache,
usually to add or delete an entry, or to dump the entire cache.</para>
<sect4><title>dnsdomainname</title>
<para>dnsdomainname shows the system's DNS domain name.</para></sect4>
<para><command>dnsdomainname</command> reports the system's DNS domain
name.</para>
<sect4><title>domainname</title>
<para>domainname shows or sets the system's NIS/YP domain
name.</para></sect4>
<para><command>domainname</command> reports or sets the system's NIS/YP
domain name.</para>
<sect4><title>hostname</title>
<para>hostname prints or sets the name of the current host
system.</para></sect4>
<para><command>hostname</command> reports or sets the name of the current
host system.</para>
<sect4><title>ifconfig</title>
<para>The ifconfig command is the general command used to configure network
interfaces.</para></sect4>
<para><command>ifconfig</command> is the main utility for configuring
network interfaces.</para>
<sect4><title>nameif</title>
<para>nameif names network interfaces based on MAC
addresses.</para></sect4>
<para><command>nameif</command> names network interfaces based on MAC
addresses.</para>
<sect4><title>netstat</title>
<para>netstat is a multi-purpose tool used to print the network connections,
routing tables, interface statistics, masquerade connections and multicast
memberships.</para></sect4>
<para><command>netstat</command> is used to report network connections,
routing tables, and interface statistics..</para>
<sect4><title>nisdomainname</title>
<para>nisdomainname shows or sets system's NIS/YP domain
name.</para></sect4>
<para><command>nisdomainname</command> does the same as domainname.</para>
<sect4><title>plipconfig</title>
<para>plipconfig is used to fine-tune the PLIP device parameters, hopefully
making it faster.</para></sect4>
<para><command>plipconfig</command> is used to fine tune the PLIP device
parameters, to improve its performance.</para>
<sect4><title>rarp</title>
<para>Akin to the arp program, the rarp program manipulates the system's
RARP table.</para></sect4>
<para><command>rarp</command> is used to manipulate the kernel's RARP
table.</para>
<sect4><title>route</title>
<para>route is the general utility which is used to manipulate the IP
routing table.</para></sect4>
<para><command>route</command> is used to manipulate the IP routing
table.</para>
<sect4><title>slattach</title>
<para>slattach attaches a network interface to a serial line, i.e.. puts a
normal terminal line into one of several "network" modes.</para></sect4>
<para><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>
<sect4><title>ypdomainname</title>
<para>ypdomainname shows or sets the system's NIS/YP domain
name.</para></sect4>
<para><command>ypdomainname</command> does the same as domainname.</para>
</sect3>

16
appendixa/patch-desc.xml
View File

@ -6,17 +6,11 @@
<sect3><title>Program files descriptions</title>
<sect4><title>patch</title>
<para>The patch program modifies a file according to a patch file. A patch
file usually is a list, created by the diff program, that contains
instructions on how an original file needs to be modified. Patch is used
a lot for source code patches since it saves time and space. Imagine
a package that is 1 MB in size. The next version of that package
only has changes in two files of the first version. It can be shipped as an
entirely new package of 1 MB or just as a patch file of 1 KB, which will
update the first version to make it identical to the second version. So
if the first version was downloaded already, a patch file avoids
a second large download.</para></sect4>
<para><command>patch</command> 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 a entire new tarballs to keep your sources
up-to-date can save you a lot of download time.</para>
</sect3>

146
appendixa/perl-desc.xml
View File

@ -6,141 +6,105 @@
<sect3><title>Program file descriptions</title>
<sect4><title>a2p</title>
<para>a2p is an awk to perl translator.</para></sect4>
<para><command>a2p</command> translates awk to perl.</para>
<sect4><title>c2ph</title>
<para>c2ph dumps C structures as generated from "cc -g -S" stabs.</para></sect4>
<para><command>c2ph</command> dumps C structures as generated from
"cc -g -S" stabs.</para>
<sect4><title>dprofpp</title>
<para>dprofpp displays perl profile data.</para></sect4>
<para><command>dprofpp</command> displays perl profile data.</para>
<sect4><title>find2perl</title>
<para>find2perl translates find command lines to Perl code.</para></sect4>
<para><command>find2perl</command> translates find commands to perl.</para>
<sect4><title>h2ph</title>
<para>h2ph converts .h C header files to .ph Perl header files.</para></sect4>
<para><command>h2ph</command> converts .h C header files to .ph Perl header files.</para>
<sect4><title>h2xs</title>
<para>h2xs converts .h C header files to Perl extensions.</para></sect4>
<para><command>h2xs</command> converts .h C header files to Perl extensions.</para>
<sect4><title>perl, perl5.6.1</title>
<para>perl is the Practical Extraction and Report Language. It combines
some of the best features of C, sed, awk and sh into one powerful
language.</para></sect4>
<para><command>perl</command> combines some of the best features of C, sed,
awk and sh into a single swiss-army language.</para>
<sect4><title>perlbug</title>
<para>perlbug helps to generate bug reports about perl or the
modules that come with it, and mail them.</para></sect4>
<para><command>perlbug</command> is used to generate bug reports about
Perl or the modules that come with it, and mail them.</para>
<sect4><title>perlcc</title>
<para>perlcc generates executables from Perl programs.</para></sect4>
<para><command>perlcc</command> generates executables from Perl programs.</para>
<sect4><title>perldoc</title>
<para>perldoc looks up a piece of documentation in .pod format that is
embedded in the perl installation tree or in a perl script and displays it
via "pod2man | nroff -man | $PAGER".</para></sect4>
<para><command>perldoc</command> displays a piece of documentation in pod
format that is embedded in the perl installation tree or in a perl script.</para>
<sect4><title>pl2pm</title>
<para>pl2pm is a tool to aid in the conversion of Perl4-style .pl library
files to Perl5-style library modules.</para></sect4>
<para><command>pl2pm</command> is a rough tool for converting Perl4 .pl
files to Perl5 .pm modules.</para>
<sect4><title>pod2html</title>
<para>pod2html converts files from pod format to HTML format.</para></sect4>
<para><command>pod2html</command> converts files from pod format to HTML
format.</para>
<sect4><title>pod2latex</title>
<para>pod2latex converts files from pod format to LaTeX format.</para></sect4>
<para><command>pod2latex</command> converts files from pod format to LaTeX
format.</para>
<sect4><title>pod2man</title>
<para>pod2man converts pod data to formatted *roff input.</para></sect4>
<para><command>pod2man</command> converts pod data to formatted *roff
input.</para>
<sect4><title>pod2text</title>
<para>pod2text converts pod data to formatted ASCII text.</para></sect4>
<para><command>pod2text</command> converts pod data to formatted ASCII
text.</para>
<sect4><title>pod2usage</title>
<para>pod2usage prints usage messages from embedded pod docs in
files.</para></sect4>
<para><command>pod2usage</command> prints usage messages from embedded
pod docs in files.</para>
<sect4><title>podchecker</title>
<para>podchecker checks the syntax of pod format documentation
files.</para></sect4>
<para><command>podchecker</command> checks the syntax of pod format
documentation files.</para>
<sect4><title>podselect</title>
<para>podselect prints selected sections of pod documentation on
standard output.</para></sect4>
<para><command>podselect</command> displays selected sections of pod
documentation.</para>
<sect4><title>pstruct</title>
<para>pstruct dumps C structures as generated from "cc -g -S"
stabs.</para></sect4>
<para><command>pstruct</command> dumps C structures as generated from
"cc -g -S" stabs.</para>
<sect4><title>s2p</title>
<para>s2p is a sed to perl translator.</para></sect4>
<para><command>s2p</command> translates sed to perl.</para>
<sect4><title>splain</title>
<para>splain is a program to force verbose warning diagnostics
in perl.</para></sect4>
<para><command>splain</command> is used to force verbose warning
diagnostics in perl.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>attrs</title>
<para>No description is currently available.</para></sect4>
<para><command>attrs</command>...</para>
<sect4><title>B</title>
<para>No description is currently available.</para></sect4>
<para><command>B</command>...</para>
<sect4><title>ByteLoader</title>
<para>No description is currently available.</para></sect4>
<para><command>ByteLoader</command>...</para>
<sect4><title>DProf</title>
<para>No description is currently available.</para></sect4>
<para><command>DProf</command>...</para>
<sect4><title>Dumper</title>
<para>No description is currently available.</para></sect4>
<para><command>Dumper</command>...</para>
<sect4><title>DynaLoader</title>
<para>No description is currently available.</para></sect4>
<para><command>DynaLoader</command>...</para>
<sect4><title>Fcntl</title>
<para>No description is currently available.</para></sect4>
<para><command>Fcntl</command>...</para>
<sect4><title>Glob</title>
<para>No description is currently available.</para></sect4>
<para><command>Glob</command>...</para>
<sect4><title>Hostname</title>
<para>No description is currently available.</para></sect4>
<para><command>Hostname</command>...</para>
<sect4><title>IO</title>
<para>No description is currently available.</para></sect4>
<para><command>IO</command>...</para>
<sect4><title>libperl</title>
<para>No description is currently available.</para></sect4>
<para><command>libperl</command>...</para>
<sect4><title>Opcode</title>
<para>No description is currently available.</para></sect4>
<para><command>Opcode</command>...</para>
<sect4><title>Peek</title>
<para>No description is currently available.</para></sect4>
<para><command>Peek</command>...</para>
<sect4><title>POSIX</title>
<para>No description is currently available.</para></sect4>
<para><command>POSIX</command>...</para>
<sect4><title>re</title>
<para>No description is currently available.</para></sect4>
<para><command>re</command>...</para>
<sect4><title>SDBM_File</title>
<para>No description is currently available.</para></sect4>
<para><command>SDBM_File</command>...</para>
<sect4><title>Socket</title>
<para>No description is currently available.</para></sect4>
<para><command>Socket</command>...</para>
<sect4><title>Syslog</title>
<para>No description is currently available.</para></sect4>
<para><command>Syslog</command>...</para>
<sect4><title>SysV</title>
<para>No description is currently available.</para></sect4>
<para><command>SysV</command>...</para>
</sect3>
</sect2>

19
appendixa/procinfo-desc.xml
View File

@ -6,21 +6,14 @@
<sect3><title>Program file descriptions</title>
<sect4><title>lsdev</title>
<para>lsdev gathers information about your computer's installed hardware from
the interrupts, ioports and dma files in the /proc directory, thus giving
you a quick overview of which hardware uses what I/O addresses and what
IRQ and DMA channels.</para></sect4>
<para><command>lsdev</command> lists the devices present in your system,
and which IRQs and IO ports they use.</para>
<sect4><title>procinfo</title>
<para>procinfo gathers some system data from the /proc directory
and prints it nicely formatted on the standard output
device.</para></sect4>
<para><command>procinfo</command> displays an overview of some of the info
present in the virtual proc filesystem.</para>
<sect4><title>socklist</title>
<para>is a Perl script that gives you a list of all open sockets, enumerating
types, port, inode, uid, pid, fd and the program to which it
belongs.</para></sect4>
<para><command>socklist</command> lists the open sockets, reporting their
type, portnumber, and other specifics.</para>
</sect3>

66
appendixa/procps-desc.xml
View File

@ -6,62 +6,50 @@
<sect3><title>Program file descriptions</title>
<sect4><title>free</title>
<para>free displays the total amount of free and used physical and swap memory
in the system, as well as the shared memory and buffers used by the
kernel.</para></sect4>
<para><command>free</command> reports the amount of free and used memory
in the system, both physical and swap memory.</para>
<sect4><title>kill</title>
<para>kills sends signals to processes.</para></sect4>
<para><command>kill</command> is used to send signals to processes.</para>
<sect4><title>oldps and ps</title>
<para>ps gives a snapshot of the current processes.</para></sect4>
<para><command>ps</command> gives a snapshot of the current processes.</para>
<sect4><title>pgrep</title>
<para>pgrep looks up processes based on name and other attributes.</para></sect4>
<para><command>pgrep</command> looks up processes based on their name
and other attributes.</para>
<sect4><title>pkill</title>
<para>pkill signals processes based on name and other attributes.</para></sect4>
<para><command>pkill</command> signals processes based on their name
and other attributes.</para>
<sect4><title>skill</title>
<para>skill sends signals to process matching a criteria.</para></sect4>
<para><command>skill</command> sends signals to processes matching the
given criteria.</para>
<sect4><title>snice</title>
<para>snice changes the scheduling priority for process matching a
criteria.</para></sect4>
<para><command>snice</command> changes the scheduling priority of processes
matching the given criteria.</para>
<sect4><title>sysctl</title>
<para>sysctl modifies kernel parameters at runtime.</para></sect4>
<para><command>sysctl</command> modifies kernel parameters at run time.</para>
<sect4><title>tload</title>
<para>tload prints a graph of the current system load average to the
specified tty or, if none is specified, the tty of the tload
process.</para></sect4>
<para><command>tload</command> prints a graph of the current system load
average.</para>
<sect4><title>top</title>
<para>top provides an ongoing look at processor activity
in real time.</para></sect4>
<para><command>top</command> displays the top CPU processes. It provides
an ongoing look at processor activity in real time.</para>
<sect4><title>vmstat</title>
<para>vmstat reports information about processes, memory, paging, block IO,
traps and cpu activity.</para></sect4>
<para><command>vmstat</command> reports virtual memory statistics, giving
information about processes, memory, paging, block IO, traps, and CPU
activity.</para>
<sect4><title>w</title>
<para>w displays information about the users, and their processes,
currently on the machine.</para></sect4>
<para><command>w</command> shows which users are currently logged on,
where and since when.</para>
<sect4><title>watch</title>
<para>watch runs command repeatedly, displaying its output (the first
screen full).</para></sect4>
<para><command>watch</command> runs a given command repeatedly,
displaying the first screenful of its output. This allows you to watch the
output change over time.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libproc</title>
<para>libproc is the library against which most of the programs in this
set are linked to save disk space by implementing common functions only
once.</para></sect4>
<para><command>libproc</command> contains the functions used by most
programs in this package.</para>
</sect3>

17
appendixa/psmisc-desc.xml
View File

@ -6,19 +6,16 @@
<sect3><title>Program file descriptions</title>
<para>Note that in LFS we don't install the pidof link by default
because we use pidof from sysvinit instead.</para>
<para><command>fuser</command> reports the PIDs of processes that use
the given files or filesystems.</para>
<sect4><title>fuser</title>
<para>fuser displays the PIDs of processes that use the specified
files or file systems.</para></sect4>
<para><command>killall</command> kills processes by name. It sends a signal
to all processes running any of the given commands.</para>
<sect4><title>killall</title>
<para>killall sends a signal to all processes running any of the specified
commands.</para></sect4>
<para><command>pidof</command> reports the PIDs of the given programs.
(Not this pidof program is used, however, but the one from Sysvinit.)</para>
<sect4><title>pstree</title>
<para>pstree shows running processes as a tree.</para></sect4>
<para><command>pstree</command> displays running processes as a tree.</para>
</sect3>

6
appendixa/sed-desc.xml
View File

@ -6,10 +6,8 @@
<sect3><title>Program file descriptions</title>
<sect4><title>sed</title>
<para>sed is a stream editor. A stream editor is used to perform basic text
transformations on an input stream (a file or input from a
pipeline).</para></sect4>
<para><command>sed</command> is used to filter and transform text files
in a single pass.</para>
</sect3>

162
appendixa/shadowpwd-desc.xml
View File

@ -6,136 +6,110 @@
<sect3><title>Program file descriptions</title>
<sect4><title>chage</title>
<para>chage changes the number of days between password changes and the date of
the last password change.</para></sect4>
<para><command>chage</command> is used to change the maximum number of
days between obligatory password changes.</para>
<sect4><title>chfn</title>
<para>chfn changes a user's full name and other information
(office room number, office phone number, and
home phone number).</para></sect4>
<para><command>chfn</command> is used to change a user's full name and
some other info.</para>
<sect4><title>chpasswd</title>
<para>chpasswd reads a file of user name and password pairs from standard
input and uses this information to update a group of
existing users.</para></sect4>
<para><command>chpasswd</command> is used to update the passwords of a
whole series of user accounts in one go.</para>
<sect4><title>chsh</title>
<para>chsh changes the user login shell.</para></sect4>
<para><command>chsh</command> is used to change a user's default
login shell.</para>
<sect4><title>dpasswd</title>
<para>dpasswd adds, deletes and updates dial-up passwords for
user login shells.</para></sect4>
<para><command>dpasswd</command> is used to change dial-up passwords for
user login shells.</para>
<sect4><title>expiry</title>
<para>expiry checks and enforces a password expiration policy.</para></sect4>
<para><command>expiry</command> checks and enforces the current password
expiration policy.</para>
<sect4><title>faillog</title>
<para>faillog formats the contents of the failure log, /var/log/faillog, and
maintains failure counts and limits.</para></sect4>
<para><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>
<sect4><title>gpasswd</title>
<para>gpasswd is used to administer the /etc/group file.</para></sect4>
<para><command>gpasswd</command> is used to add and delete members and
administrators to groups.</para>
<sect4><title>groupadd</title>
<para>The groupadd command creates a new group account using the values
specified on the command line and the default values from
the system.</para></sect4>
<para><command>groupadd</command> creates a group with the given
name.</para>
<sect4><title>groupdel</title>
<para>The groupdel command modifies the system account files, deleting all
entries that refer to group.</para></sect4>
<para><command>groupdel</command> deletes the group with the given
name.</para>
<sect4><title>groupmod</title>
<para>The groupmod command modifies the system account files to reflect the
changes that are specified on the command line.</para></sect4>
<para><command>groupmod</command> is used to modify the given group's
name or GID.</para>
<sect4><title>groups</title>
<para>groups prints the groups which a user is in.</para></sect4>
<para><command>groups</command> reports the groups of which the given
users are members.</para>
<sect4><title>grpck</title>
<para>grpck verifies the integrity of the system authentication
information.</para></sect4>
<para><command>grpck</command> verifies the integrity of the group files,
<filename>/etc/group</filename> and <filename>/etc/gshadow</filename>.</para>
<sect4><title>grpconv</title>
<para>grpunconv converts to shadow group files from normal
group files.</para></sect4>
<para><command>grpconv</command> creates or updates the shadow group file
from the normal group file.</para>
<sect4><title>grpunconv</title>
<para>grpunconv converts from shadow group files to normal
group files.</para></sect4>
<para><command>grpunconv</command> updates <filename>/etc/group</filename>
from <filename>/etc/gshadow</filename> and then deletes the latter.</para>
<sect4><title>lastlog</title>
<para>lastlog formats and prints the contents of the last login log,
/var/log/lastlog. The login-name, port and last login time will be
printed.</para></sect4>
<para><command>lastlog</command> reports the most recent login of all
users, or of a given user.</para>
<sect4><title>login</title>
<para>login is used to establish a new session with the system.</para></sect4>
<para><command>login</command> is used by the system let users sign on.</para>
<sect4><title>logoutd</title>
<para>logoutd enforces the login time and port restrictions specified in
/etc/porttime.</para></sect4>
<para><command>logoutd</command> is a daemon used to enforce restrictions
on log-on time and ports.</para>
<sect4><title>mkpasswd</title>
<para>mkpasswd reads a file in the format given by the flags and converts it
to the corresponding database file format.</para></sect4>
<para><command>mkpasswd</command> encrypts the given password using the
also given perturbation.</para>
<sect4><title>newgrp</title>
<para>newgrp is used to change the current group ID during a
login session.</para></sect4>
<para><command>newgrp</command> is used to change the current GID during
a login session.</para>
<sect4><title>newusers</title>
<para>newusers reads a file of user name and clear text password pairs and uses
this information to update a group of existing users or to create new
users.</para></sect4>
<para><command>newusers</command> is used to create or update a whole
series of user accounts in one go.</para>
<sect4><title>passwd</title>
<para>passwd changes passwords for user and group accounts.</para></sect4>
<para><command>passwd</command> is used to change the password for a user
or group account.</para>
<sect4><title>pwck</title>
<para>pwck verifies the integrity of the password files.</para></sect4>
<para><command>pwck</command> verifies the integrity of the password files,
<filename>/etc/passwd</filename> and <filename>/etc/shadow</filename>.</para>
<sect4><title>pwconv</title>
<para>pwconv converts the normal password file
to a shadowed password file.</para></sect4>
<para><command>pwconv</command> creates or updates the shadow password file
from the normal password file.</para>
<sect4><title>pwunconv</title>
<para>pwunconv converts a shadowed password file
to a normal password file.</para></sect4>
<para><command>pwunconv</command> updates <filename>/etc/passwd</filename>
from <filename>/etc/shadow</filename> and then deletes the latter.</para>
<sect4><title>sg</title>
<para>sg sets the user's GID to that of the given group, or executes a
given command as member of the given group.</para></sect4>
<para><command>sg</command> executes a given command while the user's GID
is set to that of the given group.</para>
<sect4><title>useradd</title>
<para>useradd creates a new user or updates default new user
information.</para></sect4>
<para><command>useradd</command> creates a new user with the given name,
or updates the default new-user information.</para>
<sect4><title>userdel</title>
<para>userdel modifies the system account files, deleting all entries that
refer to a specified login name.</para></sect4>
<para><command>userdel</command> deletes the given user account.</para>
<sect4><title>usermod</title>
<para>usermod modifies the system account files to reflect the changes that
are specified on the command line.</para></sect4>
<para><command>usermod</command> is used to modify the given user's
login name, UID, shell, initial group, home directory, and the like.</para>
<sect4><title>vipw and vigr</title>
<para>vipw and vigr will edit the files /etc/passwd and /etc/group,
respectively. With the -s flag, they will edit the shadow versions of
those files, /etc/shadow and /etc/gshadow, respectively.</para></sect4>
<para><command>vigr</command> can be used to edit the
<filename>/etc/group</filename> or <filename>/etc/gshadow</filename>
files.</para>
<para><command>vipw</command> can be used to edit the
<filename>/etc/passwd</filename> or <filename>/etc/shadow</filename>
files.</para>
</sect3>
<sect3><title>Library file descriptions</title>
<sect4><title>libmisc</title>
<para>No description is currently available.</para></sect4>
<para><command>libmisc</command>...</para>
<sect4><title>libshadow</title>
<para>libshadow provides common functionality for the shadow
programs.</para></sect4>
<para><command>libshadow</command> contains functions used by most
programs in this package.</para>
</sect3>
</sect2>

14
appendixa/sysklogd-desc.xml
View File

@ -6,15 +6,13 @@
<sect3><title>Program file descriptions</title>
<sect4><title>klogd</title>
<para>klogd is a system daemon which intercepts and logs Linux kernel
messages.</para></sect4>
<para><command>klogd</command> is a system daemon for intercepting and
logging kernel messages.</para>
<sect4><title>syslogd</title>
<para>syslogd provides the kind of logging that many modern programs use. Every
logged message contains at least a time and a hostname field and, normally, a
program name field, too. But that depends on how trusty the logging
program is.</para></sect4>
<para><command>syslogd</command> 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>
</sect3>

90
appendixa/sysvinit-desc.xml
View File

@ -6,77 +6,53 @@
<sect3><title>Program file descriptions</title>
<sect4><title>halt</title>
<para>halt notes, in the file /var/log/wtmp, that the system is being
brought down and then tells the kernel to either halt, reboot or
poweroff the system. If halt or reboot is called when the system is not
in runlevel 0 or 6, shutdown will be invoked instead (with
the flag -h or -r).</para></sect4>
<para><command>halt</command> normally invokes shutdown with the -h flag,
except when already in runlevel 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>
<sect4><title>init</title>
<para>init is the parent of all processes. Its primary role is to create
processes from a script stored in the file /etc/inittab. This
file usually has entries which cause init to spawn gettys on each line from
which users can log in. It also controls autonomous processes required by any
particular system.</para></sect4>
<para><command>init</command> 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 runlevel, and how many gettys to spawn.</para>
<sect4><title>killall5</title>
<para>killall5 is the SystemV killall command. It sends a signal to all
processes except the processes in its own session, so it won't kill the
shell that is running the script it was called from.</para></sect4>
<para><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>
<sect4><title>last</title>
<para>last searches back through the file /var/log/wtmp (or the file designated
by the -f flag) and displays a list of all users logged in (and out)
since that file was created.</para></sect4>
<para><command>last</command> 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 runlevel changes.</para>
<sect4><title>lastb</title>
<para>lastb is the same as last, except that by default it shows a log of the
file /var/log/btmp, which contains all the bad login attempts.</para></sect4>
<para><command>lastb</command> shows the failed login attempts, as logged
in <filename>/var/log/btmp</filename>.</para>
<sect4><title>mesg</title>
<para>mesg controls the access to the user's terminal by others. It's typically
used to allow or disallow other users to write to his terminal.</para></sect4>
<para><command>mesg</command> controls whether other users can send
messages to the current user's terminal.</para>
<sect4><title>pidof</title>
<para>pidof displays the process identifiers (PIDs) of the named
programs.</para></sect4>
<para><command>pidof</command> reports the PIDs of the given programs.</para>
<sect4><title>poweroff</title>
<para>poweroff is equivalent to shutdown -h -p now. It halts the computer and
switches off the computer (when using an APM compliant BIOS and APM is
enabled in the kernel).</para></sect4>
<para><command>poweroff</command> tells the kernel to halt the system and
switch off the computer. But see halt.</para>
<sect4><title>reboot</title>
<para>reboot is equivalent to shutdown -r now. It reboots
the computer.</para></sect4>
<para><command>reboot</command> tells the kernel to reboot the system.
But see halt.</para>
<sect4><title>runlevel</title>
<para>runlevel reads the system utmp file (usually /var/run/utmp), locates
the runlevel record and prints the previous and current system
runlevel on its standard output, separated by a single space.</para></sect4>
<para><command>runlevel</command> reports the previous and the current
runlevel, as noted in the last runlevel record in
<filename>/var/run/utmp</filename>.</para>
<sect4><title>shutdown</title>
<para>shutdown brings the system down in a secure way. All logged-in users are
notified that the system is going down and login is blocked.</para></sect4>
<para><command>shutdown</command> brings the system down in a secure way,
signaling all processes and notifying all logged-in users.</para>
<sect4><title>sulogin</title>
<para>sulogin is invoked by init when the system goes into single user mode
(this is done through an entry in /etc/inittab). Init also tries to
execute sulogin when it is passed the -b flag from the boot loader
(LILO, for example).</para></sect4>
<para><command>sulogin</command> allows the superuser to log in. It is
normally invoked by init when the system goes into single user mode.</para>
<sect4><title>telinit</title>
<para>telinit sends appropriate signals to init, telling it which runlevel to
enter.</para></sect4>
<para><command>telinit</command> tells init which runlevel to enter.</para>
<sect4><title>utmpdump</title>
<para>utmpdumps prints the content of a file (usually /var/run/utmp) on
standard output in a user friendly format.</para></sect4>
<para><command>utmpdump</command> displays the content of the given login
file in a friendlier format.</para>
<sect4><title>wall</title>
<para>wall sends a message to logged in users that have their mesg permission
set to yes.</para></sect4>
<para><command>wall</command> writes a message to all logged-in users.</para>
</sect3>

11
appendixa/tar-desc.xml
View File

@ -6,14 +6,11 @@
<sect3><title>Program file descriptions</title>
<sect4><title>rmt</title>
<para>rmt is a program used by the remote dump and restore programs to
manipulate a magnetic tape drive through an interprocess communication
connection.</para></sect4>
<para><command>rmt</command> is used to remotely manipulate a magnetic
tape drive, through an interprocess communication connection.</para>
<sect4><title>tar</title>
<para>tar is an archiving program designed to store and extract files from
an archive file known as a tar file.</para></sect4>
<para><command>tar</command> is used to create and extract files from
archives, also known as tarballs.</para>
</sect3>

35
appendixa/texinfo-desc.xml
View File

@ -6,34 +6,23 @@
<sect3><title>Program file descriptions</title>
<sect4><title>info</title>
<para>The info program reads Info documents, usually contained in the
/usr/share/info directory. Info documents are like man(ual) pages, but
they tend to go deeper than just explaining the options to a
program.</para></sect4>
<para><command>info</command> 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>
<sect4><title>infokey</title>
<para>infokey compiles a source file containing Info customizations into
a binary format.</para></sect4>
<para><command>infokey</command> compiles a source file containing Info
customizations into a binary format.</para>
<sect4><title>install-info</title>
<para>The install-info program updates the info entries. When the info
program is run, a list with available topics (ie: available info documents)
will be presented. The install-info program is used to maintain this list of
available topics. If info files are removed manually, you must also delete
the topic in the index file. This program is used for
that. It also works the other way around when info documents are
added.</para></sect4>
<para><command>install-info</command> is used to install Info files. It
updates entries in the Info index file.</para>
<sect4><title>makeinfo</title>
<para>The makeinfo program translates Texinfo source documents into various
formats. Available formats are: info files, plain text and HTML.</para></sect4>
<para><command>makeinfo</command> translates the given Texinfo source
documents into various other formats: Info files, plain text, or HTML.</para>
<sect4><title>texi2dvi</title>
<para>The texi2dvi program prints Texinfo documents.</para></sect4>
<para><command>texi2dvi</command> is used to format the given Texinfo
document into a device-independent file that can be printed.</para>
<sect4><title>texindex</title>
<para>The texindex program is used to sort Texinfo index files.</para></sect4>
<para><command>texindex</command> is used to sort Texinfo index files.</para>
</sect3>

248
appendixa/utillinux-desc.xml
View File

@ -6,214 +6,166 @@
<sect3><title>Program file descriptions</title>
<sect4><title>agetty</title>
<para>agetty opens a tty port, prompts for a login name and invokes the
/bin/login command.</para></sect4>
<para><command>agetty</command> opens a tty port, prompts for a login name,
and then invokes the login program.</para>
<sect4><title>arch</title>
<para>arch prints the machine architecture.</para></sect4>
<para><command>arch</command> reports the machine's architecture.</para>
<sect4><title>blockdev</title>
<para>blockdev allows to call block device ioctls from the command
line.</para></sect4>
<para><command>blockdev</command> allows you to call block device ioctls
from the command line.</para>
<sect4><title>cal</title>
<para>cal displays a simple calender.</para></sect4>
<para><command>cal</command> displays a simple calender.</para>
<sect4><title>cfdisk</title>
<para>cfdisk is a libncurses based disk partition table
manipulator.</para></sect4>
<para><command>cfdisk</command> is used to manipulate the partition table
of the given device.</para>
<sect4><title>chkdupexe</title>
<para>chkdupexe finds duplicate executables.</para></sect4>
<para><command>chkdupexe</command> finds duplicate executables.</para>
<sect4><title>col</title>
<para>col filters reverse line feeds from input.</para></sect4>
<para><command>col</command> filters out reverse line feeds.</para>
<sect4><title>colcrt</title>
<para>colcrt filters nroff output for CRT previewing.</para></sect4>
<para><command>colcrt</command> is used to filter nroff output for terminals
that lack some capabilities such as overstriking and half-lines.</para>
<sect4><title>colrm</title>
<para>colrm removes columns from a file.</para></sect4>
<para><command>colrm</command> filters out the given columns.</para>
<sect4><title>column</title>
<para>column columnates lists.</para></sect4>
<para><command>column</command> formats a given file into multiple
columns.</para>
<sect4><title>ctrlaltdel</title>
<para>ctrlaltdel sets the function of the CTRL+ALT+DEL key combination (hard
or soft reset).</para></sect4>
<para><command>ctrlaltdel</command> sets the function of the Ctrl+Alt+Del
key combination, to a hard or a soft reset.</para>
<sect4><title>cytune</title>
<para>cytune queries and modifies the interruption threshold for the Cyclades
driver.</para></sect4>
<para><command>cytune</command> was used to tune the parameters of the
serial line drivers for Cyclades cards.</para>
<sect4><title>ddate</title>
<para>ddate converts Gregorian dates to Discordian dates.</para></sect4>
<para><command>ddate</command> gives the Discordian date, or converts the
given Gregorian date to a Discordian one.</para>
<sect4><title>dmesg</title>
<para>dmesg is used to examine or control the kernel ring buffer (boot
messages from the kernel).</para></sect4>
<para><command>dmesg</command> dumps the kernel boot messages.</para>
<sect4><title>elvtune</title>
<para>elvtune lets you tune the I/O elevator per block device queue
basis.</para></sect4>
<para><command>elvtune</command> can be used to tune the performance
and interactiveness of a block device.</para>
<sect4><title>fdformat</title>
<para>fdformat low-level formats a floppy disk.</para></sect4>
<para><command>fdformat</command> low-level formats a floppy disk.</para>
<sect4><title>fdisk</title>
<para>fdisk is a disk partition table manipulator.</para></sect4>
<para><command>fdisk</command> could be used to manipulate the partition
table of the given device.</para>
<sect4><title>fsck.cramfs</title>
<para>No description is currently available.</para></sect4>
<para><command>fsck.cramfs</command>...</para>
<sect4><title>fsck.minix</title>
<para>fsck.minix performs a consistency check for the Linux MINIX
filesystem.</para></sect4>
<para><command>fsck.minix</command> performs a consistency check on the
Minix filesystem on the given device.</para>
<sect4><title>getopt</title>
<para>getopt parses command options the same way as the getopt C
command.</para></sect4>
<para><command>getopt</command> parses options in the given command line.</para>
<sect4><title>hexdump</title>
<para>hexdump displays specified files, or standard input, in a user specified
format (ascii, decimal, hexadecimal, octal).</para></sect4>
<para><command>hexdump</command> dumps the given file in hexadecimal, or
in another given format.</para>
<sect4><title>hwclock</title>
<para>hwclock queries and sets the hardware clock (also called the RTC or BIOS
clock).</para></sect4>
<para><command>hwclock</command> is used to read or set the system's
hardware clock (also called the RTC or BIOS clock).</para>
<sect4><title>ipcrm</title>
<para>ipcrm removes a specified resource.</para></sect4>
<para><command>ipcrm</command> removes the given IPC resource.</para>
<sect4><title>ipcs</title>
<para>ipcs provides information on IPC facilities.</para></sect4>
<para><command>ipcs</command> provides IPC status information.</para>
<sect4><title>isosize</title>
<para>isosize outputs the length of an iso9660 file system.</para></sect4>
<para><command>isosize</command> reports the size of an iso9660
filesystem.</para>
<sect4><title>line</title>
<para>line copies one line (up to a newline) from standard input and writes it
to standard output.</para></sect4>
<para><command>line</command> copies a single line.</para>
<sect4><title>logger</title>
<para>logger makes entries in the system log.</para></sect4>
<para><command>logger</command> enters the given message into the system
log.</para>
<sect4><title>look</title>
<para>look displays lines beginning with a given string.</para></sect4>
<para><command>look</command> displays lines that begin with the given
string.</para>
<sect4><title>losetup</title>
<para>losetup sets up and controls loop devices.</para></sect4>
<para><command>losetup</command> is used to set up and control loop devices.</para>
<sect4><title>mcookie</title>
<para>mcookie generates magic cookies for xauth.</para></sect4>
<para><command>mcookie</command> generates magic cookies, 128-bit random
hexadecimal numbers, for xauth.</para>
<sect4><title>mkfs</title>
<para>mkfs builds a Linux filesystem on a device, usually a harddisk
partition.</para></sect4>
<para><command>mkfs</command> is used to build a filesystem on a device
(usually a harddisk partition).</para>
<sect4><title>mkfs.bfs</title>
<para>mkfs.bfs creates an SCO bfs file system on a device, usually a harddisk
partition.</para></sect4>
<para><command>mkfs.bfs</command> creates an SCO bfs filesystem.</para>
<sect4><title>mkfs.cramfs</title>
<para>No description is currently available.</para></sect4>
<para><command>mkfs.cramfs</command>...</para>
<sect4><title>mkfs.minix</title>
<para>mkfs.minix creates a Linux MINIX filesystem on a device, usually a
harddisk partition.</para></sect4>
<para><command>mkfs.minix</command> creates a Minix filesystem.</para>
<sect4><title>mkswap</title>
<para>mkswap sets up a Linux swap area on a device or in a file.</para></sect4>
<para><command>mkswap</command> initializes the given device or file to be
used as a swap area.</para>
<sect4><title>more</title>
<para>more is a filter for paging through text one screen full at a
time.</para></sect4>
<para><command>more</command> is a filter for paging through text one
screenful at a time. But less is much better.</para>
<sect4><title>mount</title>
<para>mount mounts, from many possible sources, filesystems or directories
on a directory (mount point).</para></sect4>
<para><command>mount</command> attaches the filesystem on the given device
to the given directory in the system's file tree.</para>
<sect4><title>namei</title>
<para>namei follows a pathname until a terminal point is found.</para></sect4>
<para><command>namei</command> shows the symbolic links in the given
pathnames.</para>
<sect4><title>parse.bash, parse.tcsh, test.bash, test.tcsh</title>
<para>These are example scripts for using the getopt program with either
BASH or TCSH.</para></sect4>
<para><command>pg</command>...</para>
<sect4><title>pg</title>
<para>No description is currently available.</para></sect4>
<para><command>pivot_root</command> makes the given filesystem the new
root filesystem of the current process.</para>
<sect4><title>pivot_root</title>
<para>pivot_root moves the root file system of the current process.</para></sect4>
<para><command>ramsize</command> could be used to set the size of the
RAM disk in a bootable image.</para>
<sect4><title>ramsize</title>
<para>ramsize queries and sets RAM disk size.</para></sect4>
<para><command>rdev</command> could be used to query and set the root
device and other things in a bootable image.</para>
<sect4><title>raw</title>
<para>raw is used to bind a Linux raw character device to a block device.</para></sect4>
<para><command>readprofile</command> reads kernel profiling information.</para>
<sect4><title>rdev</title>
<para>rdev queries and sets image root device, swap device, RAM disk size or
video mode.</para></sect4>
<para><command>rename</command> renames the given files, replacing a given
string with another.</para>
<sect4><title>readprofile</title>
<para>readprofile reads kernel profiling information.</para></sect4>
<para><command>renice</command> is used to alter the priority of running
processes.</para>
<sect4><title>rename</title>
<para>rename renames files.</para></sect4>
<para><command>rev</command> reverses the lines of a given file.</para>
<sect4><title>renice</title>
<para>renice alters priority of running processes.</para></sect4>
<para><command>rootflags</command> could be used to set the rootflags
in a bootable image.</para>
<sect4><title>rev</title>
<para>rev reverses lines of a file.</para></sect4>
<para><command>script</command> makes a typescript of a terminal
session, of everything printed to the terminal.</para>
<sect4><title>rootflags</title>
<para>rootflags queries and sets extra information used when mounting
root.</para></sect4>
<para><command>setfdprm</command> sets user-provided floppy disk
parameters.</para>
<sect4><title>script</title>
<para>script makes a typescript of terminal session.</para></sect4>
<para><command>setsid</command> runs the given program in a new session.</para>
<sect4><title>setfdprm</title>
<para>setfdprm sets user-provided floppy disk parameters.</para></sect4>
<para><command>setterm</command> is used to set terminal attributes.</para>
<sect4><title>setsid</title>
<para>setsid runs programs in a new session.</para></sect4>
<para><command>sfdisk</command> is a disk partition table manipulator.</para>
<sect4><title>setterm</title>
<para>setterm sets terminal attributes.</para></sect4>
<para><command>swapdev</command> could be used to set the swap device
in a bootable image.</para>
<sect4><title>sfdisk</title>
<para>sfdisk is a disk partition table manipulator.</para></sect4>
<para><command>swapoff</command> disables devices and files for paging
and swapping.</para>
<sect4><title>swapoff</title>
<para>swapoff disables devices and files for paging and swapping.</para></sect4>
<para><command>swapon</command> enables devices and files for paging
and swapping.</para>
<sect4><title>swapon</title>
<para>swapon enables devices and files for paging and swapping.</para></sect4>
<para><command>tunelp</command> is used to tune the parameters of the
line printer.</para>
<sect4><title>tunelp</title>
<para>tunelp sets various parameters for the LP device.</para></sect4>
<para><command>ul</command> is a filter for translating underscores into
escape sequences indicating underlining for the terminal in use.</para>
<sect4><title>ul</title>
<para>ul reads a file and translates occurrences of underscores to the sequence
which indicates underlining for the terminal in use.</para></sect4>
<para><command>umount</command> disconnects a filesystem from the
system's file tree.</para>
<sect4><title>umount</title>
<para>umount unmounts a mounted filesystem or directory.</para></sect4>
<para><command>vidmode</command> could be used to set the video mode
in a bootable image.</para>
<sect4><title>vidmode</title>
<para>vidmode queries and sets the video mode.</para></sect4>
<para><command>whereis</command> reports the location of binary, the
source, and the manual page for the given command.</para>
<sect4><title>whereis</title>
<para>whereis locates a binary, source and manual page for a
command.</para></sect4>
<sect4><title>write</title>
<para>write sends a message to another user, if that user has writing
enabled (usually by using mesg).</para></sect4>
<para><command>write</command> sends a message to the given user. That is,
if that user has not disabled such messages.</para>
</sect3>

84
appendixa/vim-desc.xml
View File

@ -6,77 +6,61 @@
<sect3><title>Program file descriptions</title>
<sect4><title>efm_filter.pl</title>
<para>efm_filter.pl is a filter which reads from stdin, copies to
stdout and creates an error file that can be read by vim.</para></sect4>
<para><command>efm_filter.pl</command> is a filter for creating an error
file that can be read by vim.</para>
<sect4><title>efm_perl.pl</title>
<para>efm_perl.pl reformats the error messages of the Perl interpreter for
use with the quickfix mode of vim.</para></sect4>
<para><command>efm_perl.pl</command> reformats the error messages of the
Perl interpreter for use with the quickfix mode of vim.</para>
<sect4><title>ex</title>
<para>ex starts vim in Ex mode.</para></sect4>
<para><command>ex</command> starts vim in ex mode.</para>
<sect4><title>less.sh</title>
<para>less.sh is a script which starts vim with less.vim.</para></sect4>
<para><command>less.sh</command> is a script that starts vim with less.vim.</para>
<sect4><title>mve.awk</title>
<para>mve.awk processes vim errors.</para></sect4>
<para><command>mve.awk</command> processes vim errors.</para>
<sect4><title>pltags.pl</title>
<para>pltags.pl creates a tags file for Perl code, for use by
vim.</para></sect4>
<para><command>pltags.pl</command> creates a tags file for perl code,
for use by vim.</para>
<sect4><title>ref</title>
<para>ref checks the spelling of arguments.</para></sect4>
<para><command>ref</command> checks the spelling of arguments.</para>
<sect4><title>rview</title>
<para>rview is a restricted version of view. No shell commands can be started
and vim can't be suspended.</para></sect4>
<para><command>rview</command> is a restricted version of view: no shell
commands can be started and view can't be suspended.</para>
<sect4><title>rvim</title>
<para>rvim is the restricted version of vim. No shell commands can be started
and vim can't be suspended.</para></sect4>
<para><command>rvim</command> is a restricted version of vim: no shell
commands can be started and vim can't be suspended.</para>
<sect4><title>shtags.pl</title>
<para>shtags.pl generates a tag file for perl scripts.</para></sect4>
<para><command>shtags.pl</command> generates a tag file for perl scripts.</para>
<sect4><title>tcltags</title>
<para>tcltags generates a tag file for Tcl code.</para></sect4>
<para><command>tcltags</command> generates a tag file for TCL code.</para>
<sect4><title>vi</title>
<para>vi starts vim in vi-compatible mode.</para></sect4>
<para><command>vi</command> starts vim in vi-compatible mode.</para>
<sect4><title>view</title>
<para>view starts vim in read-only mode.</para></sect4>
<para><command>view</command> starts vim in read-only mode.</para>
<sect4><title>vim</title>
<para>vim starts vim in the normal, default way.</para></sect4>
<para><command>vim</command> is the editor.</para>
<sect4><title>vim132</title>
<para>vim132 starts vim with the terminal in 132 column mode.</para></sect4>
<para><command>vim132</command> starts vim with the terminal in
132-column mode.</para>
<sect4><title>vim2html.pl</title>
<para>vim2html.pl converts vim documentation to HTML.</para></sect4>
<para><command>vim2html.pl</command> converts vim documentation to
HTML.</para>
<sect4><title>vimdiff</title>
<para>vimdiff edits two or three versions of a file with vim and show
differences.</para></sect4>
<para><command>vimdiff</command> edits two or three versions of a file with
vim and show differences.</para>
<sect4><title>vimm</title>
<para>vimm enables the DEC locator input model on a remote
terminal.</para></sect4>
<para><command>vimm</command> enables the DEC locator input model on a
remote terminal.</para>
<sect4><title>vimspell.sh</title>
<para>vimspell.sh is a script which spells a file and generates the syntax
statements necessary to highlight in vim.</para></sect4>
<para><command>vimspell.sh</command> is a script which spells a file and generates the syntax
statements necessary to highlight in vim.</para>
<sect4><title>vimtutor</title>
<para>vimtutor starts the Vim tutor.</para></sect4>
<para><command>vimtutor</command> teaches you the basic keys and commands
of vim.</para>
<sect4><title>xxd</title>
<para>xxd makes a hexdump or does the reverse.</para></sect4>
<para><command>xxd</command> makes a hexdump of the given file. It can
also do the reverse, so it can be used for binary patching.</para>
</sect3>
</sect2>

5
appendixa/zlib-desc.xml
View File

@ -6,9 +6,8 @@
<sect3><title>Program file descriptions</title>
<sect4><title>libz</title>
<para>This is the zlib library, which is used by many programs for its
compression and uncompression functions.</para></sect4>
<para><command>libz</command> contains compression and uncompression
functions used by some programs.</para>
</sect3>