Ignore:
Timestamp:
09/24/2003 10:29:16 PM (21 years ago)
Author:
Alex Gronenwoud <alex@…>
Branches:
10.0, 10.0-rc1, 10.1, 10.1-rc1, 11.0, 11.0-rc1, 11.0-rc2, 11.0-rc3, 11.1, 11.1-rc1, 11.2, 11.2-rc1, 11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, 12.2, 12.2-rc1, 6.0, 6.1, 6.1.1, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.5-systemd, 7.6, 7.6-systemd, 7.7, 7.7-systemd, 7.8, 7.8-systemd, 7.9, 7.9-systemd, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, arm, bdubbs/gcc13, ml-11.0, multilib, renodr/libudev-from-systemd, s6-init, trunk, v5_0, v5_1, v5_1_1, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/lfs-next, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/loongarch-12.2, xry111/mips64el, xry111/multilib, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc
Children:
3a788f0c
Parents:
aa49729
Message:

Changing the style of the command descriptions in appendix A.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@2879 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

File:
1 edited

Legend:

Unmodified
Added
Removed
  • appendixa/glibc-desc.xml

    raa49729 r978d0bf  
    77<sect3><title>Program file descriptions</title>
    88
    9 <sect4><title>catchsegv</title>
    10 <para>catchsegv can be used to create a stack trace when a program
    11 terminates with a segmentation fault.</para></sect4>
     9<para><command>catchsegv</command> can be used to create a stack trace
     10when a program terminates with a segmentation fault.</para>
    1211
    13 <sect4><title>gencat</title>
    14 <para>gencat generates message catalogues.</para></sect4>
     12<para><command>gencat</command> generates message catalogues.</para>
    1513
    16 <sect4><title>getconf</title>
    17 <para>getconf displays the system configuration values for filesystem
    18 specific variables.</para></sect4>
     14<para><command>getconf</command> displays the system configuration values
     15for filesystem specific variables.</para>
    1916
    20 <sect4><title>getent</title>
    21 <para>getent gets entries from an administrative database.</para></sect4>
     17<para><command>getent</command> gets entries from an administrative
     18database.</para>
    2219
    23 <sect4><title>glibcbug</title>
    24 <para>glibcbug creates a bug report about glibc and and mails it to the
    25 bug email address.</para></sect4>
     20<para><command>glibcbug</command> creates a bug report and mails it to the
     21bug email address.</para>
    2622
    27 <sect4><title>iconv</title>
    28 <para>iconv performs character set conversion.</para></sect4>
     23<para><command>iconv</command> performs character set conversion.</para>
    2924
    30 <sect4><title>iconvconfig</title>
    31 <para>iconvconfig creates fastloading iconv module
    32 configuration file.</para></sect4>
     25<para><command>iconvconfig</command> creates fastloading iconv module
     26configuration file.</para>
    3327
    34 <sect4><title>ldconfig</title>
    35 <para>ldconfig configures the dynamic linker run time bindings.</para></sect4>
     28<para><command>ldconfig</command> configures the dynamic linker runtime
     29bindings.</para>
    3630
    37 <sect4><title>ldd</title>
    38 <para>ldd prints the shared libraries required by each program or shared
    39 library specified on the command line.</para></sect4>
     31<para><command>ldd</command> reports which shared libraries are required
     32by each given program or shared library.</para>
    4033
    41 <sect4><title>lddlibc4</title>
    42 <para>lddlibc4 assists ldd with object files.</para></sect4>
     34<para><command>lddlibc4</command> assists ldd with object files.</para>
    4335
    44 <sect4><title>locale</title>
    45 <para>locale is a Perl program which tells the compiler to enable
    46 (or disable) the use of POSIX locales for built-in operations.</para></sect4>
     36<para><command>locale</command> is a Perl program that tells the compiler
     37to enable or disable the use of POSIX locales for built-in operations.</para>
    4738
    48 <sect4><title>localedef</title>
    49 <para>localedef compiles locale specifications.</para></sect4>
     39<para><command>localedef</command> compiles locale specifications.</para>
    5040
    51 <sect4><title>mtrace</title>
    52 <para>(No description available yet.)</para></sect4>
     41<para><command>mtrace</command>...</para>
    5342
    54 <sect4><title>nscd</title>
    55 <para>nscd is a daemon that provides a cache for the most common name
    56 service requests.</para></sect4>
     43<para><command>nscd</command> is a name service cache daemon providing a
     44cache for the most common name service requests.</para>
    5745
    58 <sect4><title>nscd_nischeck</title>
    59 <para>nscd_nischeck checks whether or not secure mode is necessary for
    60 NIS+ lookup.</para></sect4>
     46<para><command>nscd_nischeck</command> checks whether or not secure mode
     47is necessary for NIS+ lookup.</para>
    6148
    62 <sect4><title>pcprofiledump</title>
    63 <para>pcprofiledump dumps information generated by
    64 PC profiling.</para></sect4>
     49<para><command>pcprofiledump</command> dumps information generated by
     50PC profiling.</para>
    6551
    66 <sect4><title>pt_chown</title>
    67 <para>pt_chown sets the owner, group and access permission of the
    68 slave pseudo terminal corresponding to the master pseudo terminal passed
    69 on file descriptor `3'. This is the helper program for the `grantpt'
    70 function. It is not intended to be run directly from the command
    71 line.</para></sect4>
     52<para><command>pt_chown</command> is a helper program for grantpt to set
     53the owner, group and access permissions of a slave pseudo terminal.</para>
    7254
    73 <sect4><title>rpcgen</title>
    74 <para>rpcgen generates C code to implement the RPC protocol.</para></sect4>
     55<para><command>rpcgen</command> generates C code to implement the
     56RPC protocol.</para>
    7557
    76 <sect4><title>rpcinfo</title>
    77 <para>rpcinfo makes an RPC call to an RPC server.</para></sect4>
     58<para><command>rpcinfo</command> makes an RPC call to an RPC server.</para>
    7859
    79 <sect4><title>sln</title>
    80 <para>sln symbolically links dest to source. It is statically linked,
    81 needing no dynamic linking at all. Thus sln is useful to make symbolic
    82 links to dynamic libraries if the dynamic linking system for some reason
    83 is nonfunctional.</para></sect4>
     60<para><command>sln</command> is used to make symbolic links. The program
     61is statically linked, so it is useful for making symbolic links to dynamic
     62libraries if the dynamic linking system for some reason is nonfunctional.</para>
    8463
    85 <sect4><title>sprof</title>
    86 <para>sprof reads and displays shared object profiling data.</para></sect4>
     64<para><command>sprof</command> reads and displays shared object profiling
     65data.</para>
    8766
    88 <sect4><title>tzselect</title>
    89 <para>tzselect asks the user for information about the current location and
    90 outputs the resulting time zone description to standard output.</para></sect4>
     67<para><command>tzselect</command> asks the user about the location of the
     68system and reports the corresponding time zone description.</para>
    9169
    92 <sect4><title>xtrace</title>
    93 <para>xtrace traces execution of program by printing the currently executed
    94 function.</para></sect4>
     70<para><command>xtrace</command> traces the execution of a program by
     71printing the currently executed function.</para>
    9572
    96 <sect4><title>zdump</title>
    97 <para>zdump is the time zone dumper.</para></sect4>
     73<para><command>zdump</command> is the time zone dumper.</para>
    9874
    99 <sect4><title>zic</title>
    100 <para>zic is the time zone compiler.</para></sect4>
     75<para><command>zic</command> is the time zone compiler.</para>
    10176
    10277</sect3>
     
    10479<sect3><title>Library file descriptions</title>
    10580
    106 <sect4><title>ld.so</title>
    107 <para>ld.so is the helper program for shared library
    108 executables.</para></sect4>
     81<para><command>ld.so</command> is the helper program for shared library
     82executables.</para>
    10983
    110 <sect4><title>libBrokenLocale</title>
    111 <para>Used by software, such as Mozilla, to solve broken locales.</para></sect4>
     84<para><command>libBrokenLocale</command> is used by programs, such as
     85Mozilla, to solve broken locales.</para>
    11286
    113 <sect4><title>libSegFault</title>
    114 <para>libSegFault is a segmentation fault signal handler. It tries to catch
    115 segfaults.</para></sect4>
     87<para><command>libSegFault</command> is a segmentation fault signal
     88handler. It tries to catch segfaults.</para>
    11689
    117 <sect4><title>libanl</title>
    118 <para>libanl is an asynchronous name lookup library.</para></sect4>
     90<para><command>libanl</command> is an asynchronous name lookup
     91library.</para>
    11992
    120 <sect4><title>libbsd-compat</title>
    121 <para>libbsd-compat provides the portability needed in order to run certain
    122 programs in Linux.</para></sect4>
     93<para><command>libbsd-compat</command> provides the portability needed
     94in order to run certain BSD programs under Linux.</para>
    12395
    124 <sect4><title>libc, libc_nonshared</title>
    125 <para>These files constitute the main C library. The C library is a
    126 collection of commonly used functions in programs.
    127 This way a programmer doesn't need to create his own functions for every
    128 single task. The most common things like writing a string to the screen
    129 are already present and at the disposal of the programmer.</para>
     96<para><command>libc</command> is the main C library -- a collection of
     97commonly used functions.</para>
    13098
    131 <para>The C library (actually almost every library) comes in two flavors:
    132 a dynamic and a static one. In short, when a program uses a static C
    133 library, the code from the C library is copied into the executable file.
    134 When a program uses a dynamic library, the executable will not
    135 contain the code from the C library, but instead a routine that loads
    136 the functions from the library at the time the program is run. This
    137 means a significant decrease in the file size of a program. The
    138 documentation that comes with the C library describes this in more
    139 detail, as it is too complicated to explain here in one or two
    140 lines.</para></sect4>
     99<para><command>libcrypt</command> is the cryptography library.</para>
    141100
    142 <sect4><title>libcrypt</title>
    143 <para>libcrypt is the cryptography library.</para></sect4>
     101<para><command>libdl</command> is the dynamic linking interface library.</para>
    144102
    145 <sect4><title>libdl</title>
    146 <para>libdl is the dynamic linking interface library.</para></sect4>
     103<para><command>libg</command> is a runtime library for g++.</para>
    147104
    148 <sect4><title>libg</title>
    149 <para>libg is a runtime library for g++.</para></sect4>
     105<para><command>libieee</command> is the IEEE floating point library.</para>
    150106
    151 <sect4><title>libieee</title>
    152 <para>libieee is the IEEE floating point library.</para></sect4>
     107<para><command>libm</command> is the mathematical library.</para>
    153108
    154 <sect4><title>libm</title>
    155 <para>libm is the mathematical library.</para></sect4>
     109<para><command>libmcheck</command> contains code run at boot.</para>
    156110
    157 <sect4><title>libmcheck</title>
    158 <para>libmcheck contains code run at boot.</para></sect4>
     111<para><command>libmemusage</command> is used by memusage to help collect
     112information about the memory usage of a program.</para>
    159113
    160 <sect4><title>libmemusage</title>
    161 <para>libmemusage is used by memusage to help collect information about the
    162 memory usage of a program.</para></sect4>
     114<para><command>libnsl</command> is the network services library.</para>
    163115
    164 <sect4><title>libnsl</title>
    165 <para>libnsl is the network services library.</para></sect4>
     116<para><command>libnss*</command> are the Name Service Switch libraries,
     117containing functions for resolving host names, user names, group names,
     118aliases, services, protocols,and the like.</para>
    166119
    167 <sect4><title>libnss_compat, libnss_dns, libnss_files,
    168 libnss_hesiod, libnss_nis, libnss_nisplus</title>
    169 <para>The basic idea is to put the implementation of the different services
    170 offered to access the databases in separate modules. This has some
    171 advantages:</para>
    172 <itemizedlist>
    173 <listitem><para>contributors can add new services without adding them to
    174 GNU C library,</para></listitem>
    175 <listitem><para>the modules can be updated separately,</para></listitem>
    176 <listitem><para>the C library image is smaller.</para></listitem>
    177 </itemizedlist></sect4>
     120<para><command>libpcprofile</command> contains profiling functions used
     121to track the amount of CPU time spent in which source code lines.</para>
    178122
    179 <sect4><title>libpcprofile</title>
    180 <para>Code used by the kernel to track CPU time spent in functions, source
    181 code lines, and instructions.</para></sect4>
     123<para><command>libpthread</command> is the POSIX threads library.</para>
    182124
    183 <sect4><title>libpthread</title>
    184 <para>The POSIX threads library.</para></sect4>
     125<para><command>libresolv</command> contains functions for creating,
     126sending, and interpreting packets to the Internet domain name servers.</para>
    185127
    186 <sect4><title>libresolv</title>
    187 <para>Functions in this library provide for creating, sending, and
    188 interpreting packets to the Internet domain name servers.</para></sect4>
     128<para><command>librpcsvc</command>contains functions providing
     129miscellaneous RPC services.</para>
    189130
    190 <sect4><title>librpcsvc</title>
    191 <para>Functions in this library provide miscellaneous RPC services.</para></sect4>
     131<para><command>librt</command> contains functions providing most of the
     132interfaces specified by the POSIX.1b Realtime Extension.</para>
    192133
    193 <sect4><title>librt</title>
    194 <para>Functions in this library provide most of the interfaces specified by
    195 the POSIX.1b Realtime Extension.</para></sect4>
     134<para><command>libthread_db</command> contains functions useful for
     135building debuggers for multi-threaded programs.</para>
    196136
    197 <sect4><title>libthread_db</title>
    198 <para>Functions is this library are useful for building debuggers for
    199 multi-threaded programs.</para></sect4>
    200 
    201 <sect4><title>libutil</title>
    202 <para>Contains code for "standard" functions used in many different Unix
    203 utilities.</para></sect4>
     137<para><command>libutil</command> contains code for "standard" functions
     138used in many different Unix utilities.</para>
    204139
    205140</sect3>
Note: See TracChangeset for help on using the changeset viewer.