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