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, 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/mips64el, 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/utillinux-desc.xml

    raa49729 r978d0bf  
    77<sect3><title>Program file descriptions</title>
    88
    9 <sect4><title>agetty</title>
    10 <para>agetty opens a tty port, prompts for a login name and invokes the
    11 /bin/login command.</para></sect4>
     9<para><command>agetty</command> opens a tty port, prompts for a login name,
     10and then invokes the login program.</para>
    1211
    13 <sect4><title>arch</title>
    14 <para>arch prints the machine architecture.</para></sect4>
     12<para><command>arch</command> reports the machine's architecture.</para>
    1513
    16 <sect4><title>blockdev</title>
    17 <para>blockdev allows to call block device ioctls from the command
    18 line.</para></sect4>
     14<para><command>blockdev</command> allows you to call block device ioctls
     15from the command line.</para>
    1916
    20 <sect4><title>cal</title>
    21 <para>cal displays a simple calender.</para></sect4>
     17<para><command>cal</command> displays a simple calender.</para>
    2218
    23 <sect4><title>cfdisk</title>
    24 <para>cfdisk is a libncurses based disk partition table
    25 manipulator.</para></sect4>
     19<para><command>cfdisk</command> is used to manipulate the partition table
     20of the given device.</para>
    2621
    27 <sect4><title>chkdupexe</title>
    28 <para>chkdupexe finds duplicate executables.</para></sect4>
     22<para><command>chkdupexe</command> finds duplicate executables.</para>
    2923
    30 <sect4><title>col</title>
    31 <para>col filters reverse line feeds from input.</para></sect4>
     24<para><command>col</command> filters out reverse line feeds.</para>
    3225
    33 <sect4><title>colcrt</title>
    34 <para>colcrt filters nroff output for CRT previewing.</para></sect4>
     26<para><command>colcrt</command> is used to filter nroff output for terminals
     27that lack some capabilities such as overstriking and half-lines.</para>
    3528
    36 <sect4><title>colrm</title>
    37 <para>colrm removes columns from a file.</para></sect4>
     29<para><command>colrm</command> filters out the given columns.</para>
    3830
    39 <sect4><title>column</title>
    40 <para>column columnates lists.</para></sect4>
     31<para><command>column</command> formats a given file into multiple
     32columns.</para>
    4133
    42 <sect4><title>ctrlaltdel</title>
    43 <para>ctrlaltdel sets the function of the CTRL+ALT+DEL key combination (hard
    44 or soft reset).</para></sect4>
     34<para><command>ctrlaltdel</command> sets the function of the Ctrl+Alt+Del
     35 key combination, to a hard or a soft reset.</para>
    4536
    46 <sect4><title>cytune</title>
    47 <para>cytune queries and modifies the interruption threshold for the Cyclades
    48 driver.</para></sect4>
     37<para><command>cytune</command> was used to tune the parameters of the
     38serial line drivers for Cyclades cards.</para>
    4939
    50 <sect4><title>ddate</title>
    51 <para>ddate converts Gregorian dates to Discordian dates.</para></sect4>
     40<para><command>ddate</command> gives the Discordian date, or converts the
     41given Gregorian date to a Discordian one.</para>
    5242
    53 <sect4><title>dmesg</title>
    54 <para>dmesg is used to examine or control the kernel ring buffer (boot
    55 messages from the kernel).</para></sect4>
     43<para><command>dmesg</command> dumps the kernel boot messages.</para>
    5644
    57 <sect4><title>elvtune</title>
    58 <para>elvtune lets you tune the I/O elevator per block device queue
    59 basis.</para></sect4>
     45<para><command>elvtune</command> can be used to tune the performance
     46and interactiveness of a block device.</para>
    6047
    61 <sect4><title>fdformat</title>
    62 <para>fdformat low-level formats a floppy disk.</para></sect4>
     48<para><command>fdformat</command> low-level formats a floppy disk.</para>
    6349
    64 <sect4><title>fdisk</title>
    65 <para>fdisk is a disk partition table manipulator.</para></sect4>
     50<para><command>fdisk</command> could be used to manipulate the partition
     51table of the given device.</para>
    6652
    67 <sect4><title>fsck.cramfs</title>
    68 <para>No description is currently available.</para></sect4>
     53<para><command>fsck.cramfs</command>...</para>
    6954
    70 <sect4><title>fsck.minix</title>
    71 <para>fsck.minix performs a consistency check for the Linux MINIX
    72 filesystem.</para></sect4>
     55<para><command>fsck.minix</command> performs a consistency check on the
     56Minix filesystem on the given device.</para>
    7357
    74 <sect4><title>getopt</title>
    75 <para>getopt parses command options the same way as the getopt C
    76 command.</para></sect4>
     58<para><command>getopt</command> parses options in the given command line.</para>
    7759
    78 <sect4><title>hexdump</title>
    79 <para>hexdump displays specified files, or standard input, in a user specified
    80 format (ascii, decimal, hexadecimal, octal).</para></sect4>
     60<para><command>hexdump</command> dumps the given file in hexadecimal, or
     61in another given format.</para>
    8162
    82 <sect4><title>hwclock</title>
    83 <para>hwclock queries and sets the hardware clock (also called the RTC or BIOS
    84 clock).</para></sect4>
     63<para><command>hwclock</command> is used to read or set the system's
     64hardware clock (also called the RTC or BIOS clock).</para>
    8565
    86 <sect4><title>ipcrm</title>
    87 <para>ipcrm removes a specified resource.</para></sect4>
     66<para><command>ipcrm</command> removes the given IPC resource.</para>
    8867
    89 <sect4><title>ipcs</title>
    90 <para>ipcs provides information on IPC facilities.</para></sect4>
     68<para><command>ipcs</command> provides IPC status information.</para>
    9169
    92 <sect4><title>isosize</title>
    93 <para>isosize outputs the length of an iso9660 file system.</para></sect4>
     70<para><command>isosize</command> reports the size of an iso9660
     71filesystem.</para>
    9472
    95 <sect4><title>line</title>
    96 <para>line copies one line (up to a newline) from standard input and writes it
    97 to standard output.</para></sect4>
     73<para><command>line</command> copies a single line.</para>
    9874
    99 <sect4><title>logger</title>
    100 <para>logger makes entries in the system log.</para></sect4>
     75<para><command>logger</command> enters the given message into the system
     76log.</para>
    10177
    102 <sect4><title>look</title>
    103 <para>look displays lines beginning with a given string.</para></sect4>
     78<para><command>look</command> displays lines that begin with the given
     79string.</para>
    10480
    105 <sect4><title>losetup</title>
    106 <para>losetup sets up and controls loop devices.</para></sect4>
     81<para><command>losetup</command> is used to set up and control loop devices.</para>
    10782
    108 <sect4><title>mcookie</title>
    109 <para>mcookie generates magic cookies for xauth.</para></sect4>
     83<para><command>mcookie</command> generates magic cookies, 128-bit random
     84hexadecimal numbers, for xauth.</para>
    11085
    111 <sect4><title>mkfs</title>
    112 <para>mkfs builds a Linux filesystem on a device, usually a harddisk
    113 partition.</para></sect4>
     86<para><command>mkfs</command> is used to build a filesystem on a device
     87(usually a harddisk partition).</para>
    11488
    115 <sect4><title>mkfs.bfs</title>
    116 <para>mkfs.bfs creates an SCO bfs file system on a device, usually a harddisk
    117 partition.</para></sect4>
     89<para><command>mkfs.bfs</command> creates an SCO bfs filesystem.</para>
    11890
    119 <sect4><title>mkfs.cramfs</title>
    120 <para>No description is currently available.</para></sect4>
     91<para><command>mkfs.cramfs</command>...</para>
    12192
    122 <sect4><title>mkfs.minix</title>
    123 <para>mkfs.minix creates a Linux MINIX filesystem on a device, usually a
    124 harddisk partition.</para></sect4>
     93<para><command>mkfs.minix</command> creates a Minix filesystem.</para>
    12594
    126 <sect4><title>mkswap</title>
    127 <para>mkswap sets up a Linux swap area on a device or in a file.</para></sect4>
     95<para><command>mkswap</command> initializes the given device or file to be
     96used as a swap area.</para>
    12897
    129 <sect4><title>more</title>
    130 <para>more is a filter for paging through text one screen full at a
    131 time.</para></sect4>
     98<para><command>more</command> is a filter for paging through text one
     99screenful at a time. But less is much better.</para>
    132100
    133 <sect4><title>mount</title>
    134 <para>mount mounts, from many possible sources, filesystems or directories
    135 on a directory (mount point).</para></sect4>
     101<para><command>mount</command> attaches the filesystem on the given device
     102to the given directory in the system's file tree.</para>
    136103
    137 <sect4><title>namei</title>
    138 <para>namei follows a pathname until a terminal point is found.</para></sect4>
     104<para><command>namei</command> shows the symbolic links in the given
     105pathnames.</para>
    139106
    140 <sect4><title>parse.bash, parse.tcsh, test.bash, test.tcsh</title>
    141 <para>These are example scripts for using the getopt program with either
    142 BASH or TCSH.</para></sect4>
     107<para><command>pg</command>...</para>
    143108
    144 <sect4><title>pg</title>
    145 <para>No description is currently available.</para></sect4>
     109<para><command>pivot_root</command> makes the given filesystem the new
     110root filesystem of the current process.</para>
    146111
    147 <sect4><title>pivot_root</title>
    148 <para>pivot_root moves the root file system of the current process.</para></sect4>
     112<para><command>ramsize</command> could be used to set the size of the
     113RAM disk in a bootable image.</para>
    149114
    150 <sect4><title>ramsize</title>
    151 <para>ramsize queries and sets RAM disk size.</para></sect4>
     115<para><command>rdev</command> could be used to query and set the root
     116device and other things in a bootable image.</para>
    152117
    153 <sect4><title>raw</title>
    154 <para>raw is used to bind a Linux raw character device to a block device.</para></sect4>
     118<para><command>readprofile</command> reads kernel profiling information.</para>
    155119
    156 <sect4><title>rdev</title>
    157 <para>rdev queries and sets image root device, swap device, RAM disk size or
    158 video mode.</para></sect4>
     120<para><command>rename</command> renames the given files, replacing a given
     121string with another.</para>
    159122
    160 <sect4><title>readprofile</title>
    161 <para>readprofile reads kernel profiling information.</para></sect4>
     123<para><command>renice</command> is used to alter the priority of running
     124processes.</para>
    162125
    163 <sect4><title>rename</title>
    164 <para>rename renames files.</para></sect4>
     126<para><command>rev</command> reverses the lines of a given file.</para>
    165127
    166 <sect4><title>renice</title>
    167 <para>renice alters priority of running processes.</para></sect4>
     128<para><command>rootflags</command> could be used to set the rootflags
     129in a bootable image.</para>
    168130
    169 <sect4><title>rev</title>
    170 <para>rev reverses lines of a file.</para></sect4>
     131<para><command>script</command> makes a typescript of a terminal
     132session, of everything printed to the terminal.</para>
    171133
    172 <sect4><title>rootflags</title>
    173 <para>rootflags queries and sets extra information used when mounting
    174 root.</para></sect4>
     134<para><command>setfdprm</command> sets user-provided floppy disk
     135parameters.</para>
    175136
    176 <sect4><title>script</title>
    177 <para>script makes a typescript of terminal session.</para></sect4>
     137<para><command>setsid</command> runs the given program in a new session.</para>
    178138
    179 <sect4><title>setfdprm</title>
    180 <para>setfdprm sets user-provided floppy disk parameters.</para></sect4>
     139<para><command>setterm</command> is used to set terminal attributes.</para>
    181140
    182 <sect4><title>setsid</title>
    183 <para>setsid runs programs in a new session.</para></sect4>
     141<para><command>sfdisk</command> is a disk partition table manipulator.</para>
    184142
    185 <sect4><title>setterm</title>
    186 <para>setterm sets terminal attributes.</para></sect4>
     143<para><command>swapdev</command> could be used to set the swap device
     144in a bootable image.</para>
    187145
    188 <sect4><title>sfdisk</title>
    189 <para>sfdisk is a disk partition table manipulator.</para></sect4>
     146<para><command>swapoff</command> disables devices and files for paging
     147and swapping.</para>
    190148
    191 <sect4><title>swapoff</title>
    192 <para>swapoff disables devices and files for paging and swapping.</para></sect4>
     149<para><command>swapon</command> enables devices and files for paging
     150and swapping.</para>
    193151
    194 <sect4><title>swapon</title>
    195 <para>swapon enables devices and files for paging and swapping.</para></sect4>
     152<para><command>tunelp</command> is used to tune the parameters of the
     153line printer.</para>
    196154
    197 <sect4><title>tunelp</title>
    198 <para>tunelp sets various parameters for the LP device.</para></sect4>
     155<para><command>ul</command> is a filter for translating underscores into
     156escape sequences indicating underlining for the terminal in use.</para>
    199157
    200 <sect4><title>ul</title>
    201 <para>ul reads a file and translates occurrences of underscores to the sequence
    202 which indicates underlining for the terminal in use.</para></sect4>
     158<para><command>umount</command> disconnects a filesystem from the
     159system's file tree.</para>
    203160
    204 <sect4><title>umount</title>
    205 <para>umount unmounts a mounted filesystem or directory.</para></sect4>
     161<para><command>vidmode</command> could be used to set the video mode
     162in a bootable image.</para>
    206163
    207 <sect4><title>vidmode</title>
    208 <para>vidmode queries and sets the video mode.</para></sect4>
     164<para><command>whereis</command> reports the location of binary, the
     165source, and the manual page for the given command.</para>
    209166
    210 <sect4><title>whereis</title>
    211 <para>whereis locates a binary, source and manual page for a
    212 command.</para></sect4>
    213 
    214 <sect4><title>write</title>
    215 <para>write sends a message to another user, if that user has writing
    216 enabled (usually by using mesg).</para></sect4>
     167<para><command>write</command> sends a message to the given user. That is,
     168if that user has not disabled such messages.</para>
    217169
    218170</sect3>
Note: See TracChangeset for help on using the changeset viewer.