GNU Core-utils

@insertcopying

1. Introduction		Caveats, overview, and authors.
2. Common options
3. Output of entire files		cat tac nl od
4. Formatting file contents		fmt pr fold
5. Output of parts of files		head tail split csplit
6. Summarizing files		wc sum cksum md5sum
7. Operating on sorted files		sort uniq comm ptx tsort
8. Operating on fields within a line		cut paste join
9. Operating on characters		tr expand unexpand
10. Directory listing		ls dir vdir d v dircolors
11. Basic operations		cp dd install mv rm shred
12. Special file types		ln mkdir rmdir mkfifo mknod
13. Changing file attributes		chgrp chmod chown touch
14. Disk usage		df du stat sync
15. Printing text		echo printf yes
16. Conditions		false true test expr
17. Redirection		tee
18. File name manipulation		dirname basename pathchk
19. Working context		pwd stty printenv tty
20. User information		id logname whoami groups users who
21. System context		date uname hostname
22. Modified command invocation		chroot env nice nohup su
23. Process control		kill
24. Delaying		sleep
25. Numeric operations		factor seq
26. File permissions		Access modes.
27. Date input formats		Specifying date strings.
28. Opening the Software Toolbox		The software tools philosophy.
A. GNU Free Documentation License		The license for this documentation.
Index		General index.

 -- The Detailed Node Listing ---

Common Options

2.1 Backup options
2.2 Block size
2.3 Target directory
2.4 Trailing slashes
2.5 Standards conformance

Output of entire files

3.1 cat: Concatenate and write files		Concatenate and write files.
3.2 tac: Concatenate and write files in reverse		Concatenate and write files in reverse.
3.3 nl: Number lines and write files		Number lines and write files.
3.4 od: Write files in octal or other formats		Write files in octal or other formats.

Formatting file contents

4.1 fmt: Reformat paragraph text		Reformat paragraph text.
4.2 pr: Paginate or columnate files for printing		Paginate or columnate files for printing.
4.3 fold: Wrap input lines to fit in specified width		Wrap input lines to fit in specified width.

Output of parts of files

5.1 head: Output the first part of files		Output the first part of files.
5.2 tail: Output the last part of files		Output the last part of files.
5.3 split: Split a file into fixed-size pieces		Split a file into fixed-size pieces.
5.4 csplit: Split a file into context-determined pieces		Split a file into context-determined pieces.

Summarizing files

6.1 wc: Print byte, word, and line counts		Print byte, word, and line counts.
6.2 sum: Print checksum and block counts		Print checksum and block counts.
6.3 cksum: Print CRC checksum and byte counts		Print CRC checksum and byte counts.
6.4 md5sum: Print or check message-digests		Print or check message-digests.

Operating on sorted files

7.1 sort: Sort text files		Sort text files.
7.2 uniq: Uniquify files		Uniquify files.
7.3 comm: Compare two sorted files line by line		Compare two sorted files line by line.
7.6 ptx: Produce permuted indexes		Produce a permuted index of file contents.
7.4 tsort: Topological sort		Topological sort.

ptx: Produce permuted indexes

7.6.1 General options		Options which affect general program behavior.
7.6.2 Charset selection		Underlying character set considerations.
7.6.3 Word selection and input processing		Input fields, contexts, and keyword selection.
7.6.4 Output formatting		Types of output format, and sizing the fields.
7.6.5 The GNU extensions to ptx

Operating on fields within a line

8.1 cut: Print selected parts of lines		Print selected parts of lines.
8.2 paste: Merge lines of files		Merge lines of files.
8.3 join: Join lines on a common field		Join lines on a common field.

Operating on characters

9.1 tr: Translate, squeeze, and/or delete characters		Translate, squeeze, and/or delete characters.
9.2 expand: Convert tabs to spaces		Convert tabs to spaces.
9.3 unexpand: Convert spaces to tabs		Convert spaces to tabs.

tr: Translate, squeeze, and/or delete characters

9.1.1 Specifying sets of characters
9.1.2 Translating		Changing one characters to another.
9.1.3 Squeezing repeats and deleting
9.1.4 Warning messages

Directory listing

10.1 ls: List directory contents		List directory contents
10.2 dir: Briefly list directory contents		Briefly list directory contents
10.3 vdir: Verbosely list directory contents		Verbosely list directory contents
10.4 dircolors: Color setup for ls		Color setup for ls

ls:  List directory contents

10.1.1 Which files are listed
10.1.2 What information is listed
10.1.3 Sorting the output
10.1.4 More details about version sort
10.1.5 General output formatting
10.1.7 Formatting the file names

Basic operations

11.1 cp: Copy files and directories		Copy files and directories
11.2 dd: Convert and copy a file		Convert and copy a file
11.3 install: Copy files and set attributes		Copy files and set attributes
11.4 mv: Move (rename) files		Move (rename) files
11.5 rm: Remove files or directories		Remove files or directories
11.6 shred: Remove files more securely		Remove files more securely

Special file types

12.1 link: Make a hard link via the link syscall		Make a hard link via the link syscall
12.2 ln: Make links between files		Make links between files
12.3 mkdir: Make directories		Make directories
12.4 mkfifo: Make FIFOs (named pipes)		Make FIFOs (named pipes)
12.5 mknod: Make block or character special files		Make block or character special files
12.6 rmdir: Remove empty directories		Remove empty directories
12.7 unlink: Remove files via the unlink syscall		Remove files via unlink syscall

Changing file attributes

13.1 chown: Change file owner and group		Change file owner and group
13.2 chgrp: Change group ownership		Change group ownership
13.3 chmod: Change access permissions		Change access permissions
13.4 touch: Change file timestamps		Change file timestamps

Disk usage

14.1 df: Report filesystem disk space usage		Report filesystem disk space usage
14.2 du: Estimate file space usage		Estimate file space usage
14.3 stat: Report file or filesystem status		Report file or filesystem status
14.4 sync: Synchronize data on disk with memory		Synchronize data on disk with memory

Printing text

15.1 echo: Print a line of text		Print a line of text
15.2 printf: Format and print data		Format and print data
15.3 yes: Print a string until interrupted		Print a string until interrupted

Conditions

16.1 false: Do nothing, unsuccessfully		Do nothing, unsuccessfully
16.2 true: Do nothing, successfully		Do nothing, successfully
16.3 test: Check file types and compare values		Check file types and compare values
16.4 expr: Evaluate expressions		Evaluate expressions

test: Check file types and compare values

16.3.1 File type tests
16.3.2 Access permission tests
16.3.3 File characteristic tests
16.3.4 String tests
16.3.5 Numeric tests

expr: Evaluate expression

16.4.1 String expressions		+ : match substr index length
16.4.2 Numeric expressions		+ - * / %
16.4.3 Relations for expr		| & < <= = == != >= >
16.4.4 Examples of using expr

Redirection

17.1 tee: Redirect output to multiple files

Redirect output to multiple files

File name manipulation

18.1 basename: Strip directory and suffix from a file name		Strip directory and suffix from a file name
18.2 dirname: Strip non-directory suffix from a file name		Strip non-directory suffix from a file name
18.3 pathchk: Check file name portability		Check file name portability

Working context

19.1 pwd: Print working directory		Print working directory
19.2 stty: Print or change terminal characteristics		Print or change terminal characteristics
19.3 printenv: Print all or some environment variables		Print all or some environment variables
19.4 tty: Print file name of terminal on standard input		Print file name of terminal on standard input

stty: Print or change terminal characteristics

19.2.1 Control settings
19.2.2 Input settings
19.2.3 Output settings
19.2.4 Local settings
19.2.5 Combination settings
19.2.6 Special characters
19.2.7 Special settings

User information

20.1 id: Print real and effective uid and gid		Print real and effective uid and gid
20.2 logname: Print current login name		Print current login name
20.3 whoami: Print effective user id		Print effective user id
20.4 groups: Print group names a user is in		Print group names a user is in
20.5 users: Print login names of users currently logged in		Print login names of users currently logged in
20.6 who: Print who is currently logged in		Print who is currently logged in

System context

21.1 date: Print or set system date and time		Print or set system date and time
21.2 uname: Print system information		Print system information
21.3 hostname: Print or set system name		Print or set system name
21.4 hostid: Print numeric host identifier.		Print numeric host identifier.

date: Print or set system date and time

21.1.1 Time directives
21.1.2 Date directives
21.1.3 Literal directives
21.1.4 Padding
21.1.5 Setting the time
21.1.6 Options for date
21.1.7 Examples of date

Modified command invocation

22.1 chroot: Run a command with a different root directory		Run a command with a different root directory
22.2 env: Run a command in a modified environment		Run a command in a modified environment
22.3 nice: Run a command with modified scheduling priority		Run a command with modified scheduling priority
22.4 nohup: Run a command immune to hangups		Run a command immune to hangups
22.5 su: Run a command with substitute user and group id		Run a command with substitute user and group id

Process control

23.1 kill: Send a signal to processes

Sending a signal to processes.

Delaying

24.1 sleep: Delay for a specified time

Delay for a specified time

Numeric operations

25.1 factor: Print prime factors		Print prime factors
25.2 seq: Print numeric sequences		Print numeric sequences

File permissions

26.1 Structure of File Permissions
26.2 Symbolic Modes		Mnemonic permissions representation
26.3 Numeric Modes		Permissions as octal numbers

Date input formats

27.1 General date syntax
27.2 Calendar date items
27.3 Time of day items
27.4 Time zone items
27.5 Day of week items
27.6 Relative items in date strings
27.7 Pure numbers in date strings
27.8 Authors of getdate

Opening the software toolbox

Toolbox Introduction		Toolbox introduction
I/O Redirection		I/O redirection
The who Command		The who command
The cut Command		The cut command
The sort Command		The sort command
The uniq Command		The uniq command
Putting the Tools Together		Putting the tools together

GNU Free Documentation License

ADDENDUM: How to use this License for your documents

1. Introduction

This manual is a work in progress: many sections make no attempt to explain basic concepts in a way suitable for novices. Thus, if you are interested, please get involved in improving this manual. The entire GNU community will benefit.

The GNU utilities documented here are mostly compatible with the POSIX standard. Please report bugs to bug-coreutils@gnu.org. Remember to include the version number, machine architecture, input files, and any other information needed to reproduce the bug: your input, what you expected, what you got, and why it is wrong. Diffs are welcome, but please include a description of the problem as well, since this is sometimes difficult to infer. See section `Bugs' in Using and Porting GNU CC.

This manual was originally derived from the Unix man pages in the distributions, which were written by David MacKenzie and updated by Jim Meyering. What you are reading now is the authoritative documentation for these utilities; the man pages are no longer being maintained. The original fmt man page was written by Ross Paterson. François Pinard did the initial conversion to Texinfo format. Karl Berry did the indexing, some reorganization, and editing of the results. Brian Youmans of the Free Software Foundation office staff combined the manuals for textutils, fileutils, and sh-utils to produce the present omnibus manual. Richard Stallman contributed his usual invaluable insights to the overall process.

2. Common options

Certain options are available in all of these programs. Rather than writing identical descriptions for each of the programs, they are described here. (In fact, every GNU program accepts (or should accept) these options.)

Normally options and operands can appear in any order, and programs act as if all the options appear before any operands. For example, `sort -r passwd -t :' acts like `sort -r -t : passwd', since `:' is an option-argument of `-t'. However, if the POSIXLY_CORRECT environment variable is set, options must appear before operands, unless otherwise specified for a particular command.

Some of these programs recognize the `--help' and `--version' options only when one of them is the sole command line argument.

`--help'

Print a usage message listing all available options, then exit successfully.

`--version'

Print the version number, then exit successfully.

`--'

Delimit the option list. Later arguments, if any, are treated as operands even if they begin with `-'. For example, `sort -- -r' reads from the file named `-r'.

A single `-' is not really an option, though it looks like one. It stands for standard input, or for standard output if that is clear from the context, and it can be used either as an operand or as an option-argument. For example, `sort -o - -' outputs to standard output and reads from standard input, and is equivalent to plain `sort'. Unless otherwise specified, `-' can appear in any context that requires a file name.

2.1 Backup options		-b -S -V, in some programs.
2.2 Block size		BLOCK_SIZE and --block-size, in some programs.
2.3 Target directory		--target-directory, in some programs.
2.4 Trailing slashes		--strip-trailing-slashes, in some programs.
2.5 Standards conformance		Conformance to the POSIX standard.

2.1 Backup options

Some GNU programs (at least cp, install, ln, and mv) optionally make backups of files before writing new versions. These options control the details of these backups. The options are also briefly mentioned in the descriptions of the particular programs.

`-b'

`--backup[=method]'

Make a backup of each file that would otherwise be overwritten or removed. Without this option, the original versions are destroyed. Use method to determine the type of backups to make. When this option is used but method is not specified, then the value of the VERSION_CONTROL environment variable is used. And if VERSION_CONTROL is not set, the default backup type is `existing'.

Note that the short form of this option, `-b' does not accept any argument. Using `-b' is equivalent to using `--backup=existing'.

This option corresponds to the Emacs variable `version-control'; the values for method are the same as those used in Emacs. This option also accepts more descriptive names. The valid methods are (unique abbreviations are accepted):

`none'

`off'

Never make backups.

`numbered'

`t'

Always make numbered backups.

`existing'

`nil'

Make numbered backups of files that already have them, simple backups of the others.

`simple'

`never'

Always make simple backups. Please note `never' is not to be confused with `none'.

`-S suffix'

`--suffix=suffix'

Append suffix to each backup file made with `-b'. If this option is not specified, the value of the SIMPLE_BACKUP_SUFFIX environment variable is used. And if SIMPLE_BACKUP_SUFFIX is not set, the default is `~', just as in Emacs.

`--version-control=method'

This option is obsolete and will be removed in a future release. It has been replaced with --backup.

2.2 Block size

Some GNU programs (at least df, du, and ls) display sizes in "blocks". You can adjust the block size and method of display to make sizes easier to read. The block size used for display is independent of any filesystem block size. Fractional block counts are rounded up to the nearest integer.

The default block size is chosen by examining the following environment variables in turn; the first one that is set determines the block size.

DF_BLOCK_SIZE

This specifies the default block size for the df command. Similarly, DU_BLOCK_SIZE specifies the default for du and LS_BLOCK_SIZE for ls.

BLOCK_SIZE

This specifies the default block size for all three commands, if the above command-specific environment variables are not set.

POSIXLY_CORRECT

If neither the command_BLOCK_SIZE nor the BLOCK_SIZE variables are set, but this variable is set, the block size defaults to 512.

If none of the above environment variables are set, the block size currently defaults to 1024 bytes in most contexts, but this number may change in the future. For ls file sizes, the block size defaults to 1 byte.

A block size specification can be a positive integer specifying the number of bytes per block, or it can be human-readable or si to select a human-readable format. Integers may be followed by suffixes that are upward compatible with the SI prefixes for decimal multiples and with the IEC 60027-2 prefixes for binary multiples.

With human-readable formats, output sizes are followed by a size letter such as `M' for megabytes. BLOCK_SIZE=human-readable uses powers of 1024; `M' stands for 1,048,576 bytes. BLOCK_SIZE=si is similar, but uses powers of 1000 and appends `B'; `MB' stands for 1,000,000 bytes.

A block size specification preceded by `'' causes output sizes to be displayed with thousands separators. The LC_NUMERIC locale specifies the thousands separator and grouping. For example, in an American English locale, `--block-size="'1kB"' would cause a size of 1234000 bytes to be displayed as `1,234'. In the default C locale, there is no thousands separator so a leading `'' has no effect.

An integer block size can be followed by a suffix to specify a multiple of that size. A bare size letter, or one followed by `iB', specifies a multiple using powers of 1024. A size letter followed by `B' specifies powers of 1000 instead. For example, `1M' and `1MiB' are equivalent to `1048576', whereas `1MB' is equivalent to `1000000'.

A plain suffix without a preceding integer acts as if `1' were prepended, except that it causes a size indication to be appended to the output. For example, `--block-size="kB"' displays 3000 as `3kB'.

The following suffixes are defined. Large sizes like 1Y may be rejected by your computer due to limitations of its arithmetic.

`kB'

kilobyte: 10^3 = 1000.

`k'

`K'

`KiB'

kibibyte: 2^10 = 1024. `K' is special: the SI prefix is `k' and the IEC 60027-2 prefix is `Ki', but tradition and POSIX use `k' to mean `KiB'.

`MB'

megabyte: 10^6 = 1,000,000.

`M'

`MiB'

mebibyte: 2^20 = 1,048,576.

`GB'

gigabyte: 10^9 = 1,000,000,000.

`G'

`GiB'

gibibyte: 2^30 = 1,073,741,824.

`TB'

terabyte: 10^12 = 1,000,000,000,000.

`T'

`TiB'

tebibyte: 2^40 = 1,099,511,627,776.

`PB'

petabyte: 10^15 = 1,000,000,000,000,000.

`P'

`PiB'

pebibyte: 2^50 = 1,125,899,906,842,624.

`EB'

exabyte: 10^18 = 1,000,000,000,000,000,000.

`E'

`EiB'

exbibyte: 2^60 = 1,152,921,504,606,846,976.

`ZB'

zettabyte: 10^21 = 1,000,000,000,000,000,000,000

`Z'

`ZiB'

2^70 = 1,180,591,620,717,411,303,424. (`Zi' is a GNU extension to IEC 60027-2.)

`YB'

yottabyte: 10^24 = 1,000,000,000,000,000,000,000,000.

`Y'

`YiB'

2^80 = 1,208,925,819,614,629,174,706,176. (`Yi' is a GNU extension to IEC 60027-2.)

Block size defaults can be overridden by an explicit `--block-size=size' option. The `-k' option is equivalent to `--block-size=1K', which is the default unless the POSIXLY_CORRECT environment variable is set. The `-h' or `--human-readable' option is equivalent to `--block-size=human-readable'. The `--si' option is equivalent to `--block-size=si'.

2.3 Target directory

Some GNU programs (at least cp, install, ln, and mv) allow you to specify the target directory via this option:

`--target-directory=directory'

Specify the destination directory.

The interface for most programs is that after processing options and a finite (possibly zero) number of fixed-position arguments, the remaining argument list is either expected to be empty, or is a list of items (usually files) that will all be handled identically. The xargs program is designed to work well with this convention.

The commands in the mv-family are unusual in that they take a variable number of arguments with a special case at the end (namely, the target directory). This makes it nontrivial to perform some operations, e.g., "move all files from here to ../d/", because mv * ../d/ might exhaust the argument space, and ls | xargs ... doesn't have a clean way to specify an extra final argument for each invocation of the subject command. (It can be done by going through a shell command, but that requires more human labor and brain power than it should.)

The --target-directory option allows the cp, install, ln, and mv programs to be used conveniently with xargs. For example, you can move the files from the current directory to a sibling directory, d like this: (However, this doesn't move files whose names begin with `.'.)

ls |xargs mv --target-directory=../d

If you use the GNU find program, you can move all files with this command:

find . -mindepth 1 -maxdepth 1 \ | xargs mv --target-directory=../d

But that will fail if there are no files in the current directory or if any file has a name containing a newline character. The following example removes those limitations and requires both GNU find and GNU xargs:

find . -mindepth 1 -maxdepth 1 -print0 \ | xargs --null --no-run-if-empty \ mv --target-directory=../d

2.4 Trailing slashes

Some GNU programs (at least cp and mv) allow you to remove any trailing slashes from each source argument before operating on it. The --strip-trailing-slashes option enables this behavior.

This is useful when a source argument may have a trailing slash and specify a symbolic link to a directory. This scenario is in fact rather common because some shells can automatically append a trailing slash when performing file name completion on such symbolic links. Without this option, mv, for example, (via the system's rename function) must interpret a trailing slash as a request to dereference the symbolic link and so must rename the indirectly referenced directory and not the symbolic link. Although it may seem surprising that such behavior be the default, it is required by POSIX and is consistent with other parts of that standard.

2.5 Standards conformance

In a few cases, the GNU utilities' default behavior is incompatible with the POSIX standard. To suppress these incompatibilities, define the POSIXLY_CORRECT environment variable. Unless you are checking for POSIX conformance, you probably do not need to define POSIXLY_CORRECT.

Newer versions of POSIX are occasionally incompatible with older versions. For example, older versions of POSIX required the command `sort +1' to sort based on the second and succeeding fields in each input line, but starting with POSIX 1003.1-2001 the same command is required to sort the file named `+1', and you must instead use the command `sort -k 2' to get the field-based sort.

The GNU utilities normally conform to the version of POSIX that is standard for your system. To cause them to conform to a different version of POSIX, define the _POSIX2_VERSION environment variable to a value of the form yyyymm specifying the year and month the standard was adopted. Two values are currently supported for _POSIX2_VERSION: `199209' stands for POSIX 1003.2-1992, and `200112' stands for POSIX 1003.1-2001. For example, if you are running older software that assumes an older version of POSIX and uses `sort +1', you can work around the compatibility problems by setting `_POSIX2_VERSION=199209' in your environment.

3. Output of entire files

These commands read and write entire files, possibly transforming them in some way.

3.1 cat: Concatenate and write files		Concatenate and write files.
3.2 tac: Concatenate and write files in reverse		Concatenate and write files in reverse.
3.3 nl: Number lines and write files		Number lines and write files.
3.4 od: Write files in octal or other formats		Write files in octal or other formats.

3.1 cat: Concatenate and write files

cat copies each file (`-' means standard input), or standard input if none are given, to standard output. Synopsis:

cat [option] [file]...

The program accepts the following options. Also see 2. Common options.

`-A'

`--show-all'

Equivalent to `-vET'.

`-B'

`--binary'

On MS-DOS and MS-Windows only, read and write the files in binary mode. By default, cat on MS-DOS/MS-Windows uses binary mode only when standard output is redirected to a file or a pipe; this option overrides that. Binary file I/O is used so that the files retain their format (Unix text as opposed to DOS text and binary), because cat is frequently used as a file-copying program. Some options (see below) cause cat to read and write files in text mode because in those cases the original file contents aren't important (e.g., when lines are numbered by cat, or when line endings should be marked). This is so these options work as DOS/Windows users would expect; for example, DOS-style text files have their lines end with the CR-LF pair of characters, which won't be processed as an empty line by `-b' unless the file is read in text mode.

`-b'

`--number-nonblank'

Number all nonblank output lines, starting with 1. On MS-DOS and MS-Windows, this option causes cat to read and write files in text mode.

`-e'

Equivalent to `-vE'.

`-E'

`--show-ends'

Display a `$' after the end of each line. On MS-DOS and MS-Windows, this option causes cat to read and write files in text mode.

`-n'

`--number'

Number all output lines, starting with 1. On MS-DOS and MS-Windows, this option causes cat to read and write files in text mode.

`-s'

`--squeeze-blank'

Replace multiple adjacent blank lines with a single blank line. On MS-DOS and MS-Windows, this option causes cat to read and write files in text mode.

`-t'

Equivalent to `-vT'.

`-T'

`--show-tabs'

Display TAB characters as `^I'.

`-u'

Ignored; for Unix compatibility.

`-v'

`--show-nonprinting'

Display control characters except for LFD and TAB using `^' notation and precede characters that have the high bit set with `M-'. On MS-DOS and MS-Windows, this option causes cat to read files and standard input in DOS binary mode, so the CR characters at the end of each line are also visible.

3.2 tac: Concatenate and write files in reverse

tac copies each file (`-' means standard input), or standard input if none are given, to standard output, reversing the records (lines by default) in each separately. Synopsis:

tac [option]... [file]...

Records are separated by instances of a string (newline by default). By default, this separator string is attached to the end of the record that it follows in the file.

The program accepts the following options. Also see 2. Common options.

`-b'

`--before'

The separator is attached to the beginning of the record that it precedes in the file.

`-r'

`--regex'

Treat the separator string as a regular expression. Users of tac on MS-DOS/MS-Windows should note that, since tac reads files in binary mode, each line of a text file might end with a CR/LF pair instead of the Unix-style LF.

`-s separator'

`--separator=separator'

Use separator as the record separator, instead of newline.

3.3 nl: Number lines and write files

nl writes each file (`-' means standard input), or standard input if none are given, to standard output, with line numbers added to some or all of the lines. Synopsis:

nl [option]... [file]...

nl decomposes its input into (logical) pages; by default, the line number is reset to 1 at the top of each logical page. nl treats all of the input files as a single document; it does not reset line numbers or logical pages between files.

A logical page consists of three sections: header, body, and footer. Any of the sections can be empty. Each can be numbered in a different style from the others.

The beginnings of the sections of logical pages are indicated in the input file by a line containing exactly one of these delimiter strings:

`\:\:\:'

start of header;

`\:\:'

start of body;

`\:'

start of footer.

The two characters from which these strings are made can be changed from `\' and `:' via options (see below), but the pattern and length of each string cannot be changed.

A section delimiter is replaced by an empty line on output. Any text that comes before the first section delimiter string in the input file is considered to be part of a body section, so nl treats a file that contains no section delimiters as a single body section.

The program accepts the following options. Also see 2. Common options.

`-b style'

`--body-numbering=style'

Select the numbering style for lines in the body section of each logical page. When a line is not numbered, the current line number is not incremented, but the line number separator character is still prepended to the line. The styles are:

`a'

number all lines,

`t'

number only nonempty lines (default for body),

`n'

do not number lines (default for header and footer),

`pregexp'

number only lines that contain a match for regexp.

`-d cd'

`--section-delimiter=cd'

Set the section delimiter characters to cd; default is `\:'. If only c is given, the second remains `:'. (Remember to protect `\' or other metacharacters from shell expansion with quotes or extra backslashes.)

`-f style'

`--footer-numbering=style'

Analogous to `--body-numbering'.

`-h style'

`--header-numbering=style'

Analogous to `--body-numbering'.

`-i number'

`--page-increment=number'

Increment line numbers by number (default 1).

`-l number'

`--join-blank-lines=number'

Consider number (default 1) consecutive empty lines to be one logical line for numbering, and only number the last one. Where fewer than number consecutive empty lines occur, do not number them. An empty line is one that contains no characters, not even spaces or tabs.

`-n format'

`--number-format=format'

Select the line numbering format (default is rn):

`ln'

left justified, no leading zeros;

`rn'

right justified, no leading zeros;

`rz'

right justified, leading zeros.

`-p'

`--no-renumber'

Do not reset the line number at the start of a logical page.

`-s string'

`--number-separator=string'

Separate the line number from the text line in the output with string (default is the TAB character).

`-v number'

`--starting-line-number=number'

Set the initial line number on each logical page to number (default 1).

`-w number'

`--number-width=number'

Use number characters for line numbers (default 6).

3.4 od: Write files in octal or other formats

od writes an unambiguous representation of each file (`-' means standard input), or standard input if none are given. Synopses:

od [option]... [file]... od --traditional [file] [[+]offset [[+]label]]

Each line of output consists of the offset in the input, followed by groups of data from the file. By default, od prints the offset in octal, and each group of file data is two bytes of input printed as a single octal number.

The program accepts the following options. Also see 2. Common options.

`-A radix'

`--address-radix=radix'

Select the base in which file offsets are printed. radix can be one of the following:

`d'

decimal;

`o'

octal;

`x'

hexadecimal;

`n'

none (do not print offsets).

The default is octal.

`-j bytes'

`--skip-bytes=bytes'

Skip bytes input bytes before formatting and writing. If bytes begins with `0x' or `0X', it is interpreted in hexadecimal; otherwise, if it begins with `0', in octal; otherwise, in decimal. Appending `b' multiplies bytes by 512, `k' by 1024, and `m' by 1048576.

`-N bytes'

`--read-bytes=bytes'

Output at most bytes bytes of the input. Prefixes and suffixes on bytes are interpreted as for the `-j' option.

`-s n'

`--strings[=n]'

Instead of the normal output, output only string constants: at least n consecutive ASCII graphic characters, followed by a null (zero) byte.

If n is omitted with `--strings', the default is 3. On older systems, GNU od instead supports an obsolete option `-s[n]', where n also defaults to 3. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow `-s' without an argument; use `--strings' instead.

`-t type'

`--format=type'

Select the format in which to output the file data. type is a string of one or more of the below type indicator characters. If you include more than one type indicator character in a single type string, or use this option more than once, od writes one copy of each output line using each of the data types that you specified, in the order that you specified.

Adding a trailing "z" to any type specification appends a display of the ASCII character representation of the printable characters to the output line generated by the type specification.

`a'

named character

`c'

ASCII character or backslash escape,

`d'

signed decimal

`f'

floating point

`o'

octal

`u'

unsigned decimal

`x'

hexadecimal

The type a outputs things like `sp' for space, `nl' for newline, and `nul' for a null (zero) byte. Type c outputs ` ', `\n', and \0, respectively.

Except for types `a' and `c', you can specify the number of bytes to use in interpreting each number in the given data type by following the type indicator character with a decimal integer. Alternately, you can specify the size of one of the C compiler's built-in data types by following the type indicator character with one of the following characters. For integers (`d', `o', `u', `x'):

`C'

char

`S'

short

`I'

int

`L'

long

For floating point (f):

F

float

D

double

L

long double

`-v'

`--output-duplicates'

Output consecutive lines that are identical. By default, when two or more consecutive output lines would be identical, od outputs only the first line, and puts just an asterisk on the following line to indicate the elision.

`-w n'

`--width[=n]'

Dump n input bytes per output line. This must be a multiple of the least common multiple of the sizes associated with the specified output types.

If this option is not given at all, the default is 16. If n is omitted with `--width', the default is 32. On older systems, GNU od instead supports an obsolete option `-w[n]', where n also defaults to 32. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow `-w' without an argument; use `--width' instead.

The next several options are shorthands for format specifications. GNU od accepts any combination of shorthands and format specification options. These options accumulate.

`-a'

Output as named characters. Equivalent to `-ta'.

`-b'

Output as octal bytes. Equivalent to `-toC'.

`-c'

Output as ASCII characters or backslash escapes. Equivalent to `-tc'.

`-d'

Output as unsigned decimal shorts. Equivalent to `-tu2'.

`-f'

Output as floats. Equivalent to `-tfF'.

`-h'

Output as hexadecimal shorts. Equivalent to `-tx2'.

`-i'

Output as decimal shorts. Equivalent to `-td2'.

`-l'

Output as decimal longs. Equivalent to `-td4'.

`-o'

Output as octal shorts. Equivalent to `-to2'.

`-x'

Output as hexadecimal shorts. Equivalent to `-tx2'.

`--traditional'

Recognize the non-option arguments that traditional od accepted. The following syntax:

od --traditional [file] [[+]offset[.][b] [[+]label[.][b]]]

can be used to specify at most one file and optional arguments specifying an offset and a pseudo-start address, label. By default, offset is interpreted as an octal number specifying how many input bytes to skip before formatting and writing. The optional trailing decimal point forces the interpretation of offset as a decimal number. If no decimal is specified and the offset begins with `0x' or `0X' it is interpreted as a hexadecimal number. If there is a trailing `b', the number of bytes skipped will be offset multiplied by 512. The label argument is interpreted just like offset, but it specifies an initial pseudo-address. The pseudo-addresses are displayed in parentheses following any normal address.

4. Formatting file contents

These commands reformat the contents of files.

4.1 fmt: Reformat paragraph text		Reformat paragraph text.
4.2 pr: Paginate or columnate files for printing		Paginate or columnate files for printing.
4.3 fold: Wrap input lines to fit in specified width		Wrap input lines to fit in specified width.

4.1 fmt: Reformat paragraph text

fmt fills and joins lines to produce output lines of (at most) a given number of characters (75 by default). Synopsis:

fmt [option]... [file]...

fmt reads from the specified file arguments (or standard input if none are given), and writes to standard output.

By default, blank lines, spaces between words, and indentation are preserved in the output; successive input lines with different indentation are not joined; tabs are expanded on input and introduced on output.

fmt prefers breaking lines at the end of a sentence, and tries to avoid line breaks after the first word of a sentence or before the last word of a sentence. A sentence break is defined as either the end of a paragraph or a word ending in any of `.?!', followed by two spaces or end of line, ignoring any intervening parentheses or quotes. Like TeX, fmt reads entire "paragraphs" before choosing line breaks; the algorithm is a variant of that in "Breaking Paragraphs Into Lines" (Donald E. Knuth and Michael F. Plass, Software--Practice and Experience, 11 (1981), 1119--1184).

The program accepts the following options. Also see 2. Common options.

`-c'

`--crown-margin'

Crown margin mode: preserve the indentation of the first two lines within a paragraph, and align the left margin of each subsequent line with that of the second line.

`-t'

`--tagged-paragraph'

Tagged paragraph mode: like crown margin mode, except that if indentation of the first line of a paragraph is the same as the indentation of the second, the first line is treated as a one-line paragraph.

`-s'

`--split-only'

Split lines only. Do not join short lines to form longer ones. This prevents sample lines of code, and other such "formatted" text from being unduly combined.

`-u'

`--uniform-spacing'

Uniform spacing. Reduce spacing between words to one space, and spacing between sentences to two spaces.

`-width'

`-w width'

`--width=width'

Fill output lines up to width characters (default 75). fmt initially tries to make lines about 7% shorter than this, to give it room to balance line lengths.

`-p prefix'

`--prefix=prefix'

Only lines beginning with prefix (possibly preceded by whitespace) are subject to formatting. The prefix and any preceding whitespace are stripped for the formatting and then re-attached to each formatted output line. One use is to format certain kinds of program comments, while leaving the code unchanged.

4.2 pr: Paginate or columnate files for printing

pr writes each file (`-' means standard input), or standard input if none are given, to standard output, paginating and optionally outputting in multicolumn format; optionally merges all files, printing all in parallel, one per column. Synopsis:

pr [option]... [file]...

By default, a 5-line header is printed at each page: two blank lines; a line with the date, the filename, and the page count; and two more blank lines. A footer of five blank lines is also printed. With the `-F' option, a 3-line header is printed: the leading two blank lines are omitted; no footer is used. The default page_length in both cases is 66 lines. The default number of text lines changes from 56 (without `-F') to 63 (with `-F'). The text line of the header takes the form `date string page', with spaces inserted around string so that the line takes up the full page_width. Here, date is the date (see the `-D' or `--date-format' option for details), string is the centered header string, and page identifies the page number. The LC_MESSAGES locale category affects the spelling of page; in the default C locale, it is `Page number' where number is the decimal page number.

Form feeds in the input cause page breaks in the output. Multiple form feeds produce empty pages.

Columns are of equal width, separated by an optional string (default is `space'). For multicolumn output, lines will always be truncated to page_width (default 72), unless you use the `-J' option. For single column output no line truncation occurs by default. Use `-W' option to truncate lines in that case.

The following changes were made in version 1.22i and apply to later versions of pr:  - Brian

• Some small letter options (`-s', `-w') have been redefined for better POSIX compliance. The output of some further cases has been adapted to other Unix systems. These changes are not compatible with earlier versions of the program.

• Some new capital letter options (`-J', `-S', `-W') have been introduced to turn off unexpected interferences of small letter options. The `-N' option and the second argument last_page of `+FIRST_PAGE' offer more flexibility. The detailed handling of form feeds set in the input files requires the `-T' option.

• Capital letter options override small letter ones.

• Some of the option-arguments (compare `-s', `-e', `-i', `-n') cannot be specified as separate arguments from the preceding option letter (already stated in the POSIX specification).

The program accepts the following options. Also see 2. Common options.

`+first_page[:last_page]'

`--pages=first_page[:last_page]'

Begin printing with page first_page and stop with last_page. Missing `:last_page' implies end of file. While estimating the number of skipped pages each form feed in the input file results in a new page. Page counting with and without `+first_page' is identical. By default, counting starts with the first page of input file (not first page printed). Line numbering may be altered by `-N' option.

`-column'

`--columns=column'

With each single file, produce column columns of output (default is 1) and print columns down, unless `-a' is used. The column width is automatically decreased as column increases; unless you use the `-W/-w' option to increase page_width as well. This option might well cause some lines to be truncated. The number of lines in the columns on each page are balanced. The options `-e' and `-i' are on for multiple text-column output. Together with `-J' option column alignment and line truncation is turned off. Lines of full length are joined in a free field format and `-S' option may set field separators. `-column' may not be used with `-m' option.

`-a'

`--across'

With each single file, print columns across rather than down. The `-column' option must be given with column greater than one. If a line is too long to fit in a column, it is truncated.

`-c'

`--show-control-chars'

Print control characters using hat notation (e.g., `^G'); print other nonprinting characters in octal backslash notation. By default, nonprinting characters are not changed.

`-d'

`--double-space'

Double space the output.

`-D format'

`--date-format=format'

Format header dates using format, using the same conventions as for the the command `date +format'; See section 21.1 date: Print or set system date and time. Except for directives, which start with `%', characters in format are printed unchanged. You can use this option to specify an arbitrary string in place of the header date, e.g., `--date-format="Monday morning"'.

If the POSIXLY_CORRECT environment variable is not set, the date format defaults to `%Y-%m-%d %H:%M' (for example, `2001-12-04 23:59'); otherwise, the format depends on the LC_TIME locale category, with the default being `%b %e %H:%M %Y' (for example, `Dec  4 23:59 2001'.

`-e[in-tabchar[in-tabwidth]]'

`--expand-tabs[=in-tabchar[in-tabwidth]]'

Expand tabs to spaces on input. Optional argument in-tabchar is the input tab character (default is the TAB character). Second optional argument in-tabwidth is the input tab character's width (default is 8).

`-f'

`-F'

`--form-feed'

Use a form feed instead of newlines to separate output pages. The default page length of 66 lines is not altered. But the number of lines of text per page changes from default 56 to 63 lines.

`-h HEADER'

`--header=HEADER'

Replace the filename in the header with the centered string header. When using the shell, header should be quoted and should be separated from `-h' by a space.

`-i[out-tabchar[out-tabwidth]]'

`--output-tabs[=out-tabchar[out-tabwidth]]'

Replace spaces with tabs on output. Optional argument out-tabchar is the output tab character (default is the TAB character). Second optional argument out-tabwidth is the output tab character's width (default is 8).

`-J'

`--join-lines'

Merge lines of full length. Used together with the column options `-column', `-a -column' or `-m'. Turns off `-W/-w' line truncation; no column alignment used; may be used with `--sep-string[=string]'. `-J' has been introduced (together with `-W' and `--sep-string') to disentangle the old (POSIX-compliant) options `-w' and `-s' along with the three column options.

`-l page_length'

`--length=page_length'

Set the page length to page_length (default 66) lines, including the lines of the header [and the footer]. If page_length is less than or equal to 10 (or <= 3 with `-F'), the header and footer are omitted, and all form feeds set in input files are eliminated, as if the `-T' option had been given.

`-m'

`--merge'

Merge and print all files in parallel, one in each column. If a line is too long to fit in a column, it is truncated, unless the `-J' option is used. `--sep-string[=string]' may be used. Empty pages in some files (form feeds set) produce empty columns, still marked by string. The result is a continuous line numbering and column marking throughout the whole merged file. Completely empty merged pages show no separators or line numbers. The default header becomes `date page' with spaces inserted in the middle; this may be used with the `-h' or `--header' option to fill up the middle blank part.

`-n[number-separator[digits]]'

`--number-lines[=number-separator[digits]]'

Provide digits digit line numbering (default for digits is 5). With multicolumn output the number occupies the first digits column positions of each text column or only each line of `-m' output. With single column output the number precedes each line just as `-m' does. Default counting of the line numbers starts with the first line of the input file (not the first line printed, compare the `--page' option and `-N' option). Optional argument number-separator is the character appended to the line number to separate it from the text followed. The default separator is the TAB character. In a strict sense a TAB is always printed with single column output only. The TAB-width varies with the TAB-position, e.g. with the left margin specified by `-o' option. With multicolumn output priority is given to `equal width of output columns' (a POSIX specification). The TAB-width is fixed to the value of the first column and does not change with different values of left margin. That means a fixed number of spaces is always printed in the place of the number-separator tab. The tabification depends upon the output position.

`-N line_number'

`--first-line-number=line_number'

Start line counting with the number line_number at first line of first page printed (in most cases not the first line of the input file).

`-o margin'

`--indent=margin'

Indent each line with a margin margin spaces wide (default is zero). The total page width is the size of the margin plus the page_width set with the `-W/-w' option. A limited overflow may occur with numbered single column output (compare `-n' option).

`-r'

`--no-file-warnings'

Do not print a warning message when an argument file cannot be opened. (The exit status will still be nonzero, however.)

`-s[char]'

`--separator[=char]'

Separate columns by a single character char. The default for char is the TAB character without `-w' and `no character' with `-w'. Without `-s' the default separator `space' is set. `-s[char]' turns off line truncation of all three column options (`-COLUMN'|`-a -COLUMN'|`-m') unless `-w' is set. This is a POSIX-compliant formulation.

`-S string'

`--sep-string[=string]'

Use string to separate output columns. The `-S' option doesn't affect the `-W/-w' option, unlike the `-s' option which does. It does not affect line truncation or column alignment. Without `-S', and with `-J', pr uses the default output separator, TAB. Without `-S' or `-J', pr uses a `space' (same as `-S" "'). With `-Sstring', string must be nonempty; `--sep-string' with no string is equivalent to `--sep-string=""'.

On older systems, pr instead supports an obsolete option `-S[string]', where string is optional. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this older usage. To specify an empty string portably, use `--sep-string'.

`-t'

`--omit-header'

Do not print the usual header [and footer] on each page, and do not fill out the bottom of pages (with blank lines or a form feed). No page structure is produced, but form feeds set in the input files are retained. The predefined pagination is not changed. `-t' or `-T' may be useful together with other options; e.g.: `-t -e4', expand TAB characters in the input file to 4 spaces but don't make any other changes. Use of `-t' overrides `-h'.

`-T'

`--omit-pagination'

Do not print header [and footer]. In addition eliminate all form feeds set in the input files.

`-v'

`--show-nonprinting'

Print nonprinting characters in octal backslash notation.

`-w page_width'

`--width=page_width'

Set page width to page_width characters for multiple text-column output only (default for page_width is 72). `-s[CHAR]' turns off the default page width and any line truncation and column alignment. Lines of full length are merged, regardless of the column options set. No page_width setting is possible with single column output. A POSIX-compliant formulation.

`-W page_width'

`--page_width=page_width'

Set the page width to page_width characters. That's valid with and without a column option. Text lines are truncated, unless `-J' is used. Together with one of the three column options (`-column', `-a -column' or `-m') column alignment is always used. The separator options `-S' or `-s' don't affect the `-W' option. Default is 72 characters. Without `-W page_width' and without any of the column options NO line truncation is used (defined to keep downward compatibility and to meet most frequent tasks). That's equivalent to `-W 72 -J'. The header line is never truncated.

4.3 fold: Wrap input lines to fit in specified width

fold writes each file (`-' means standard input), or standard input if none are given, to standard output, breaking long lines. Synopsis:

fold [option]... [file]...

By default, fold breaks lines wider than 80 columns. The output is split into as many lines as necessary.

fold counts screen columns by default; thus, a tab may count more than one column, backspace decreases the column count, and carriage return sets the column to zero.

The program accepts the following options. Also see 2. Common options.

`-b'

`--bytes'

Count bytes rather than columns, so that tabs, backspaces, and carriage returns are each counted as taking up one column, just like other characters.

`-s'

`--spaces'

Break at word boundaries: the line is broken after the last blank before the maximum line length. If the line contains no such blanks, the line is broken at the maximum line length as usual.

`-w width'

`--width=width'

Use a maximum line length of width columns instead of 80.

On older systems, fold supports an obsolete option `-width'. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-w width' instead.

5. Output of parts of files

These commands output pieces of the input.

5.1 head: Output the first part of files		Output the first part of files.
5.2 tail: Output the last part of files		Output the last part of files.
5.3 split: Split a file into fixed-size pieces		Split a file into fixed-size pieces.
5.4 csplit: Split a file into context-determined pieces		Split a file into context-determined pieces.

5.1 head: Output the first part of files

head prints the first part (10 lines by default) of each file; it reads from standard input if no files are given or when given a file of `-'. Synopsis:

head [option]... [file]...

If more than one file is specified, head prints a one-line header consisting of

==> file name <==

before the output for each file.

The program accepts the following options. Also see 2. Common options.

`-c bytes'

`--bytes=bytes'

Print the first bytes bytes, instead of initial lines. Appending `b' multiplies bytes by 512, `k' by 1024, and `m' by 1048576.

`-n n'

`--lines=n'

Output the first n lines.

`-q'

`--quiet'

`--silent'

Never print file name headers.

`-v'

`--verbose'

Always print file name headers.

On older systems, head supports an obsolete option `-countoptions', which is recognized only if it is specified first. count is a decimal number optionally followed by a size letter (`b', `k', `m') as in -c, or `l' to mean count by lines, or other option letters (`cqv'). POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-c count' or `-n count' instead.

5.2 tail: Output the last part of files

tail prints the last part (10 lines by default) of each file; it reads from standard input if no files are given or when given a file of `-'. Synopsis:

tail [option]... [file]...

If more than one file is specified, tail prints a one-line header consisting of

==> file name <==

before the output for each file.

GNU tail can output any amount of data (some other versions of tail cannot). It also has no `-r' option (print in reverse), since reversing a file is really a different job from printing the end of a file; BSD tail (which is the one with -r) can only reverse files that are at most as large as its buffer, which is typically 32 KiB. A more reliable and versatile way to reverse files is the GNU tac command.

If any option-argument is a number n starting with a `+', tail begins printing with the nth item from the start of each file, instead of from the end.

The program accepts the following options. Also see 2. Common options.

`-c bytes'

`--bytes=bytes'

Output the last bytes bytes, instead of final lines. Appending `b' multiplies bytes by 512, `k' by 1024, and `m' by 1048576.

`-f'

`--follow[=how]'

Loop forever trying to read more characters at the end of the file, presumably because the file is growing. This option is ignored when reading from a pipe. If more than one file is given, tail prints a header whenever it gets output from a different file, to indicate which file that output is from.

There are two ways to specify how you'd like to track files with this option, but that difference is noticeable only when a followed file is removed or renamed. If you'd like to continue to track the end of a growing file even after it has been unlinked, use `--follow=descriptor'. This is the default behavior, but it is not useful if you're tracking a log file that may be rotated (removed or renamed, then reopened). In that case, use `--follow=name' to track the named file by reopening it periodically to see if it has been removed and recreated by some other program.

No matter which method you use, if the tracked file is determined to have shrunk, tail prints a message saying the file has been truncated and resumes tracking the end of the file from the newly-determined endpoint.

When a file is removed, tail's behavior depends on whether it is following the name or the descriptor. When following by name, tail can detect that a file has been removed and gives a message to that effect, and if `--retry' has been specified it will continue checking periodically to see if the file reappears. When following a descriptor, tail does not detect that the file has been unlinked or renamed and issues no message; even though the file may no longer be accessible via its original name, it may still be growing.

The option values `descriptor' and `name' may be specified only with the long form of the option, not with `-f'.

`-F'

This option is the same as `--follow=name --retry'. That is, tail will attempt to reopen a file when it is removed. Should this fail, tail will keep trying until it becomes accessible again.

`--retry'

This option is meaningful only when following by name. Without this option, when tail encounters a file that doesn't exist or is otherwise inaccessible, it reports that fact and never checks it again.

`--sleep-interval=number'

Change the number of seconds to wait between iterations (the default is 1.0). During one iteration, every specified file is checked to see if it has Historical implementations of tail have required that number be an integer. However, GNU tail accepts an arbitrary floating point number.

`--pid=pid'

When following by name or by descriptor, you may specify the process ID, pid, of the sole writer of all file arguments. Then, shortly after that process terminates, tail will also terminate. This will work properly only if the writer and the tailing process are running on the same machine. For example, to save the output of a build in a file and to watch the file grow, if you invoke make and tail like this then the tail process will stop when your build completes. Without this option, you would have had to kill the tail -f process yourself.

$ make >& makerr & tail --pid=$! -f makerr

If you specify a pid that is not in use or that does not correspond to the process that is writing to the tailed files, then tail may terminate long before any files stop growing or it may not terminate until long after the real writer has terminated. Note that `--pid' cannot be supported on some systems; tail will print a warning if this is the case.

`--max-unchanged-stats=n'

When tailing a file by name, if there have been n (default n=5) consecutive iterations for which the size has remained the same, then open/fstat the file to determine if that file name is still associated with the same device/inode-number pair as before. When following a log file that is rotated, this is approximately the number of seconds between when tail prints the last pre-rotation lines and when it prints the lines that have accumulated in the new log file. This option is meaningful only when following by name.

`-n n'

`--lines=n'

Output the last n lines.

`-q'

`--quiet'

`--silent'

Never print file name headers.

`-v'

`--verbose'

Always print file name headers.

On older systems, tail supports an obsolete option `-countoptions', which is recognized only if it is specified first. count is a decimal number optionally followed by a size letter (`b', `k', `m') as in -c, or `l' to mean count by lines, or other option letters (`cfqv'). Some older tail implementations also support an obsolete option `+count' with the same meaning as `-+count'. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow these options; use `-c count' or `-n count' instead.

5.3 split: Split a file into fixed-size pieces

split creates output files containing consecutive sections of input (standard input if none is given or input is `-'). Synopsis:

split [option] [input [prefix]]

By default, split puts 1000 lines of input (or whatever is left over for the last section), into each output file.

The output files' names consist of prefix (`x' by default) followed by a group of letters (`aa', `ab', ... by default), such that concatenating the output files in sorted order by file name produces the original input file. If the output file names are exhausted, split reports an error without deleting the output files that it did create.

The program accepts the following options. Also see 2. Common options.

`-a length'

`--suffix-length=length'

Use suffixes of length length. The default length is 2.

`-l lines'

`--lines=lines'

Put lines lines of input into each output file.

On older systems, split supports an obsolete option `-lines'. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-l lines' instead.

`-b bytes'

`--bytes=bytes'

Put the first bytes bytes of input into each output file. Appending `b' multiplies bytes by 512, `k' by 1024, and `m' by 1048576.

`-C bytes'

`--line-bytes=bytes'

Put into each output file as many complete lines of input as possible without exceeding bytes bytes. For lines longer than bytes bytes, put bytes bytes into each output file until less than bytes bytes of the line are left, then continue normally. bytes has the same format as for the `--bytes' option.

`--verbose'

Write a diagnostic to standard error just before each output file is opened.

5.4 csplit: Split a file into context-determined pieces

csplit creates zero or more output files containing sections of input (standard input if input is `-'). Synopsis:

csplit [option]... input pattern...

The contents of the output files are determined by the pattern arguments, as detailed below. An error occurs if a pattern argument refers to a nonexistent line of the input file (e.g., if no remaining line matches a given regular expression). After every pattern has been matched, any remaining input is copied into one last output file.

By default, csplit prints the number of bytes written to each output file after it has been created.

The types of pattern arguments are:

`n'

Create an output file containing the input up to but not including line n (a positive integer). If followed by a repeat count, also create an output file containing the next line lines of the input file once for each repeat.

`/regexp/[offset]'

Create an output file containing the current line up to (but not including) the next line of the input file that contains a match for regexp. The optional offset is a `+' or `-' followed by a positive integer. If it is given, the input up to the matching line plus or minus offset is put into the output file, and the line after that begins the next section of input.

`%regexp%[offset]'

Like the previous type, except that it does not create an output file, so that section of the input file is effectively ignored.

`{repeat-count}'

Repeat the previous pattern repeat-count additional times. repeat-count can either be a positive integer or an asterisk, meaning repeat as many times as necessary until the input is exhausted.

The output files' names consist of a prefix (`xx' by default) followed by a suffix. By default, the suffix is an ascending sequence of two-digit decimal numbers from `00' to `99'. In any case, concatenating the output files in sorted order by filename produces the original input file.

By default, if csplit encounters an error or receives a hangup, interrupt, quit, or terminate signal, it removes any output files that it has created so far before it exits.

The program accepts the following options. Also see 2. Common options.

`-f prefix'

`--prefix=prefix'

Use prefix as the output file name prefix.

`-b suffix'

`--suffix=suffix'

Use suffix as the output file name suffix. When this option is specified, the suffix string must include exactly one printf(3)-style conversion specification, possibly including format specification flags, a field width, a precision specifications, or all of these kinds of modifiers. The format letter must convert a binary integer argument to readable form; thus, only `d', `i', `u', `o', `x', and `X' conversions are allowed. The entire suffix is given (with the current output file number) to sprintf(3) to form the file name suffixes for each of the individual output files in turn. If this option is used, the `--digits' option is ignored.

`-n digits'

`--digits=digits'

Use output file names containing numbers that are digits digits long instead of the default 2.

`-k'

`--keep-files'

Do not remove output files when errors are encountered.

`-z'

`--elide-empty-files'

Suppress the generation of zero-length output files. (In cases where the section delimiters of the input file are supposed to mark the first lines of each of the sections, the first output file will generally be a zero-length file unless you use this option.) The output file sequence numbers always run consecutively starting from 0, even when this option is specified.

`-s'

`-q'

`--silent'

`--quiet'

Do not print counts of output file sizes.

6. Summarizing files

These commands generate just a few numbers representing entire contents of files.

6.1 wc: Print byte, word, and line counts		Print byte, word, and line counts.
6.2 sum: Print checksum and block counts		Print checksum and block counts.
6.3 cksum: Print CRC checksum and byte counts		Print CRC checksum and byte counts.
6.4 md5sum: Print or check message-digests		Print or check message-digests.

6.1 wc: Print byte, word, and line counts

wc counts the number of bytes, characters, whitespace-separated words, and newlines in each given file, or standard input if none are given or for a file of `-'. Synopsis:

wc [option]... [file]...

wc prints one line of counts for each file, and if the file was given as an argument, it prints the file name following the counts. If more than one file is given, wc prints a final line containing the cumulative counts, with the file name `total'. The counts are printed in this order: newlines, words, characters, bytes. By default, each count is output right-justified in a 7-byte field with one space between fields so that the numbers and file names line up nicely in columns. However, POSIX requires that there be exactly one space separating columns. You can make wc use the POSIX-mandated output format by setting the POSIXLY_CORRECT environment variable.

By default, wc prints three counts: the newline, words, and byte counts. Options can specify that only certain counts be printed. Options do not undo others previously given, so

wc --bytes --words

prints both the byte counts and the word counts.

With the --max-line-length option, wc prints the length of the longest line per file, and if there is more than one file it prints the maximum (not the sum) of those lengths.

The program accepts the following options. Also see 2. Common options.

`-c'

`--bytes'

Print only the byte counts.

`-m'

`--chars'

Print only the character counts.

`-w'

`--words'

Print only the word counts.

`-l'

`--lines'

Print only the newline counts.

`-L'

`--max-line-length'

Print only the maximum line lengths.

6.2 sum: Print checksum and block counts

sum computes a 16-bit checksum for each given file, or standard input if none are given or for a file of `-'. Synopsis:

sum [option]... [file]...

sum prints the checksum for each file followed by the number of blocks in the file (rounded up). If more than one file is given, file names are also printed (by default). (With the `--sysv' option, corresponding file names are printed when there is at least one file argument.)

By default, GNU sum computes checksums using an algorithm compatible with BSD sum and prints file sizes in units of 1024-byte blocks.

The program accepts the following options. Also see 2. Common options.

`-r'

Use the default (BSD compatible) algorithm. This option is included for compatibility with the System V sum. Unless `-s' was also given, it has no effect.

`-s'

`--sysv'

Compute checksums using an algorithm compatible with System V sum's default, and print file sizes in units of 512-byte blocks.

sum is provided for compatibility; the cksum program (see next section) is preferable in new applications.

6.3 cksum: Print CRC checksum and byte counts

cksum computes a cyclic redundancy check (CRC) checksum for each given file, or standard input if none are given or for a file of `-'. Synopsis:

cksum [option]... [file]...

cksum prints the CRC checksum for each file along with the number of bytes in the file, and the filename unless no arguments were given.

cksum is typically used to ensure that files transferred by unreliable means (e.g., netnews) have not been corrupted, by comparing the cksum output for the received files with the cksum output for the original files (typically given in the distribution).

The CRC algorithm is specified by the POSIX standard. It is not compatible with the BSD or System V sum algorithms (see the previous section); it is more robust.

The only options are `--help' and `--version'. See section 2. Common options.

6.4 md5sum: Print or check message-digests

md5sum computes a 128-bit checksum (or fingerprint or message-digest) for each specified file. If a file is specified as `-' or if no files are given md5sum computes the checksum for the standard input. md5sum can also determine whether a file and checksum are consistent. Synopses:

md5sum [option]... [file]... md5sum [option]... --check [file]

For each file, `md5sum' outputs the MD5 checksum, a flag indicating a binary or text input file, and the filename. If file is omitted or specified as `-', standard input is read.

The program accepts the following options. Also see 2. Common options.

`-b'

`--binary'

Treat all input files as binary. This option has no effect on Unix systems, since they don't distinguish between binary and text files. This option is useful on systems that have different internal and external character representations. On MS-DOS and MS-Windows, this is the default.

`-c'

`--check'

Read filenames and checksum information from the single file (or from stdin if no file was specified) and report whether each named file and the corresponding checksum data are consistent. The input to this mode of md5sum is usually the output of a prior, checksum-generating run of `md5sum'. Each valid line of input consists of an MD5 checksum, a binary/text flag, and then a filename. Binary files are marked with `*', text with ` '. For each such line, md5sum reads the named file and computes its MD5 checksum. Then, if the computed message digest does not match the one on the line with the filename, the file is noted as having failed the test. Otherwise, the file passes the test. By default, for each valid line, one line is written to standard output indicating whether the named file passed the test. After all checks have been performed, if there were any failures, a warning is issued to standard error. Use the `--status' option to inhibit that output. If any listed file cannot be opened or read, if any valid line has an MD5 checksum inconsistent with the associated file, or if no valid line is found, md5sum exits with nonzero status. Otherwise, it exits successfully.

`--status'

This option is useful only when verifying checksums. When verifying checksums, don't generate the default one-line-per-file diagnostic and don't output the warning summarizing any failures. Failures to open or read a file still evoke individual diagnostics to standard error. If all listed files are readable and are consistent with the associated MD5 checksums, exit successfully. Otherwise exit with a status code indicating there was a failure.

`-t'

`--text'

Treat all input files as text files. This is the reverse of `--binary'.

`-w'

`--warn'

When verifying checksums, warn about improperly formatted MD5 checksum lines. This option is useful only if all but a few lines in the checked input are valid.

7. Operating on sorted files

These commands work with (or produce) sorted files.

7.1 sort: Sort text files		Sort text files.
7.2 uniq: Uniquify files		Uniquify files.
7.3 comm: Compare two sorted files line by line		Compare two sorted files line by line.
7.6 ptx: Produce permuted indexes		Produce a permuted index of file contents.
7.4 tsort: Topological sort		Topological sort.
7.5 tsort: Background		Where tsort came from.

7.1 sort: Sort text files

sort sorts, merges, or compares all the lines from the given files, or standard input if none are given or for a file of `-'. By default, sort writes the results to standard output. Synopsis:

sort [option]... [file]...

sort has three modes of operation: sort (the default), merge, and check for sortedness. The following options change the operation mode:

`-c'

`--check'

Check whether the given files are already sorted: if they are not all sorted, print an error message and exit with a status of 1. Otherwise, exit successfully.

`-m'

`--merge'

Merge the given files by sorting them as a group. Each input file must always be individually sorted. It always works to sort instead of merge; merging is provided because it is faster, in the case where it works.

A pair of lines is compared as follows: if any key fields have been specified, sort compares each pair of fields, in the order specified on the command line, according to the associated ordering options, until a difference is found or no fields are left. Unless otherwise specified, all comparisons use the character collating sequence specified by the LC_COLLATE locale. (1)

If any of the global options `bdfgiMnr' are given but no key fields are specified, sort compares the entire lines according to the global options.

Finally, as a last resort when all keys compare equal (or if no ordering options were specified at all), sort compares the entire lines. The last resort comparison honors the `--reverse' (`-r') global option. The `--stable' (`-s') option disables this last-resort comparison so that lines in which all fields compare equal are left in their original relative order. If no fields or global options are specified, `--stable' (`-s') has no effect.

GNU sort (as specified for all GNU utilities) has no limits on input line length or restrictions on bytes allowed within lines. In addition, if the final byte of an input file is not a newline, GNU sort silently supplies one. A line's trailing newline is not part of the line for comparison purposes.

Upon any error, sort exits with a status of `2'.

If the environment variable TMPDIR is set, sort uses its value as the directory for temporary files instead of `/tmp'. The `--temporary-directory' (`-T') option in turn overrides the environment variable.

The following options affect the ordering of output lines. They may be specified globally or as part of a specific key field. If no key fields are specified, global options apply to comparison of entire lines; otherwise the global options are inherited by key fields that do not specify any special options of their own. In pre-POSIX versions of sort, global options affect only later key fields, so portable shell scripts should specify global options first.

`-b'

`--ignore-leading-blanks'

Ignore leading blanks when finding sort keys in each line. The LC_CTYPE locale determines character types.

`-d'

`--dictionary-order'

Sort in phone directory order: ignore all characters except letters, digits and blanks when sorting. The LC_CTYPE locale determines character types.

`-f'

`--ignore-case'

Fold lowercase characters into the equivalent uppercase characters when comparing so that, for example, `b' and `B' sort as equal. The LC_CTYPE locale determines character types.

`-g'

`--general-numeric-sort'

Sort numerically, using the standard C function strtod to convert a prefix of each line to a double-precision floating point number. This allows floating point numbers to be specified in scientific notation, like 1.0e-34 and 10e100. The LC_NUMERIC locale determines the decimal-point character. Do not report overflow, underflow, or conversion errors. Use the following collating sequence:

• Lines that do not start with numbers (all considered to be equal).
• NaNs ("Not a Number" values, in IEEE floating point arithmetic) in a consistent but machine-dependent order.
• Minus infinity.
• Finite numbers in ascending numeric order (with -0 and +0 equal).
• Plus infinity.

Use this option only if there is no alternative; it is much slower than `--numeric-sort' (`-n') and it can lose information when converting to floating point.

`-i'

`--ignore-nonprinting'

Ignore nonprinting characters. The LC_CTYPE locale determines character types.

`-M'

`--month-sort'

An initial string, consisting of any amount of whitespace, followed by a month name abbreviation, is folded to UPPER case and compared in the order `JAN' < `FEB' < ... < `DEC'. Invalid names compare low to valid names. The LC_TIME locale category determines the month spellings.

`-n'

`--numeric-sort'

Sort numerically: the number begins each line; specifically, it consists of optional whitespace, an optional `-' sign, and zero or more digits possibly separated by thousands separators, optionally followed by a decimal-point character and zero or more digits. The LC_NUMERIC locale specifies the decimal-point character and thousands separator.

Numeric sort uses what might be considered an unconventional method to compare strings representing floating point numbers. Rather than first converting each string to the C double type and then comparing those values, sort aligns the decimal-point characters in the two strings and compares the strings a character at a time. One benefit of using this approach is its speed. In practice this is much more efficient than performing the two corresponding string-to-double (or even string-to-integer) conversions and then comparing doubles. In addition, there is no corresponding loss of precision. Converting each string to double before comparison would limit precision to about 16 digits on most systems.

Neither a leading `+' nor exponential notation is recognized. To compare such strings numerically, use the `--general-numeric-sort' (`-g') option.

`-r'

`--reverse'

Reverse the result of comparison, so that lines with greater key values appear earlier in the output instead of later.

Other options are:

`-o output-file'

`--output=output-file'

Write output to output-file instead of standard output. If necessary, sort reads input before opening output-file, so you can safely sort a file in place by using commands like sort -o F F and cat F | sort -o F.

On newer systems, `-o' cannot appear after an input file if POSIXLY_CORRECT is set, e.g., `sort F -o F'. Portable scripts should specify `-o output-file' before any input files.

`-S size'

`--buffer-size=size'

Use a main-memory sort buffer of the given size. By default, size is in units of 1024 bytes. Appending `%' causes size to be interpreted as a percentage of physical memory. Appending `K' multiplies size by 1024 (the default), `M' by 1,048,576, `G' by 1,073,741,824, and so on for `T', `P', `E', `Z', and `Y'. Appending `b' causes size to be interpreted as a byte count, with no multiplication.

This option can improve the performance of sort by causing it to start with a larger or smaller sort buffer than the default. However, this option affects only the initial buffer size. The buffer grows beyond size if sort encounters input lines larger than size.

`-t separator'

`--field-separator=separator'

Use character separator as the field separator when finding the sort keys in each line. By default, fields are separated by the empty string between a non-whitespace character and a whitespace character. That is, given the input line ` foo bar', sort breaks it into fields ` foo' and ` bar'. The field separator is not considered to be part of either the field preceding or the field following. But note that sort fields that extend to the end of the line, as `-k 2', or sort fields consisting of a range, as `-k 2,3', retain the field separators present between the endpoints of the range.

`-T tempdir'

`--temporary-directory=tempdir'

Use directory tempdir to store temporary files, overriding the TMPDIR environment variable. If this option is given more than once, temporary files are stored in all the directories given. If you have a large sort or merge that is I/O-bound, you can often improve performance by using this option to specify directories on different disks and controllers.

`-u'

`--unique'

Normally, output only the first of a sequence of lines that compare equal. For the `--check' (`-c') option, check that no pair of consecutive lines compares equal.

`-k pos1[,pos2]'

`--key=pos1[,pos2]'

Specify a sort field that consists of the part of the line between pos1 and pos2 (or the end of the line, if pos2 is omitted), inclusive. Fields and character positions are numbered starting with 1. So to sort on the second field, you'd use `--key=2,2' (`-k 2,2'). See below for more examples.

`-z'

`--zero-terminated'

Treat the input as a set of lines, each terminated by a zero byte (ASCII NUL (Null) character) instead of an ASCII LF (Line Feed). This option can be useful in conjunction with `perl -0' or `find -print0' and `xargs -0' which do the same in order to reliably handle arbitrary pathnames (even those which contain Line Feed characters.)

Historical (BSD and System V) implementations of sort have differed in their interpretation of some options, particularly `-b', `-f', and `-n'. GNU sort follows the POSIX behavior, which is usually (but not always!) like the System V behavior. According to POSIX, `-n' no longer implies `-b'. For consistency, `-M' has been changed in the same way. This may affect the meaning of character positions in field specifications in obscure cases. The only fix is to add an explicit `-b'.

A position in a sort field specified with the `-k' option has the form `f.c', where f is the number of the field to use and c is the number of the first character from the beginning of the field. In a start position, an omitted `.c' stands for the field's first character. In an end position, an omitted or zero `.c' stands for the field's last character. If the `-b' option was specified, the `.c' part of a field specification is counted from the first nonblank character of the field.

A sort key position may also have any of the option letters `Mbdfinr' appended to it, in which case the global ordering options are not used for that particular field. The `-b' option may be independently attached to either or both of the start and end positions of a field specification, and if it is inherited from the global options it will be attached to both. Keys may span multiple fields.

On older systems, sort supports an obsolete origin-zero syntax `+pos1 [-pos2]' for specifying sort keys. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-k' instead.

Here are some examples to illustrate various combinations of options.

• Sort in descending (reverse) numeric order.

  sort -nr

• Sort alphabetically, omitting the first and second fields. This uses a single key composed of the characters beginning at the start of field three and extending to the end of each line.

  sort -k 3

• Sort numerically on the second field and resolve ties by sorting alphabetically on the third and fourth characters of field five. Use `:' as the field delimiter.

  sort -t : -k 2,2n -k 5.3,5.4

  Note that if you had written `-k 2' instead of `-k 2,2' sort would have used all characters beginning in the second field and extending to the end of the line as the primary numeric key. For the large majority of applications, treating keys spanning more than one field as numeric will not do what you expect.

  Also note that the `n' modifier was applied to the field-end specifier for the first key. It would have been equivalent to specify `-k 2n,2' or `-k 2n,2n'. All modifiers except `b' apply to the associated field, regardless of whether the modifier character is attached to the field-start and/or the field-end part of the key specifier.

• Sort the password file on the fifth field and ignore any leading white space. Sort lines with equal values in field five on the numeric user ID in field three.

  sort -t : -k 5b,5 -k 3,3n /etc/passwd

  An alternative is to use the global numeric modifier `-n'.

  sort -t : -n -k 5b,5 -k 3,3 /etc/passwd

• Generate a tags file in case-insensitive sorted order.

  find src -type f -print0 | sort -t / -z -f | xargs -0 etags --append

  The use of `-print0', `-z', and `-0' in this case means that pathnames that contain Line Feed characters will not get broken up by the sort operation.

  Finally, to ignore both leading and trailing white space, you could have applied the `b' modifier to the field-end specifier for the first key,

  sort -t : -n -k 5b,5b -k 3,3 /etc/passwd

  or by using the global `-b' modifier instead of `-n' and an explicit `n' with the second key specifier.

  sort -t : -b -k 5,5 -k 3,3n /etc/passwd

7.2 uniq: Uniquify files

uniq writes the unique lines in the given `input', or standard input if nothing is given or for an input name of `-'. Synopsis:

uniq [option]... [input [output]]

By default, uniq prints the unique lines in a sorted file, i.e., discards all but one of identical successive lines. Optionally, it can instead show only lines that appear exactly once, or lines that appear more than once.

The input need not be sorted, but duplicate input lines are detected only if they are adjacent. If you want to discard non-adjacent duplicate lines, perhaps you want to use sort -u.

Comparisons use the character collating sequence specified by the LC_COLLATE locale category.

If no output file is specified, uniq writes to standard output.

The program accepts the following options. Also see 2. Common options.

`-f n'

`--skip-fields=n'

Skip n fields on each line before checking for uniqueness. Fields are sequences of non-space non-tab characters that are separated from each other by at least one space or tab.

On older systems, uniq supports an obsolete option `-n'. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-f n' instead.

`-s n'

`--skip-chars=n'

Skip n characters before checking for uniqueness. If you use both the field and character skipping options, fields are skipped over first.

On older systems, uniq supports an obsolete option `+n'. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-s n' instead.

`-c'

`--count'

Print the number of times each line occurred along with the line.

`-i'

`--ignore-case'

Ignore differences in case when comparing lines.

`-d'

`--repeated'

Print one copy of each duplicate line.

`-D'

`--all-repeated[=delimit-method]'

Print all copies of each duplicate line. This option is useful mainly in conjunction with other options e.g., to ignore case or to compare only selected fields. The optional delimit-method tells how to delimit groups of duplicate lines, and must be one of the following:

`none'

Do not delimit groups of duplicate lines. This is equivalent to `--all-repeated' (`-D').

`prepend'

Output a newline before each group of duplicate lines.

`separate'

Separate groups of duplicate lines with a single newline. This is the same as using `prepend', except that there is no newline before the first group, and hence may be better suited for output direct to users.

Note that when groups are delimited and the input stream contains two or more consecutive blank lines, then the output is ambiguous. To avoid that, filter the input through `tr -s '\n'' to replace each sequence of consecutive newlines with a single newline.

This is a GNU extension.

`-u'

`--unique'

Print non-duplicate lines.

`-w n'

`--check-chars=n'

Compare n characters on each line (after skipping any specified fields and characters). By default the entire rest of the lines are compared.

7.3 comm: Compare two sorted files line by line

comm writes to standard output lines that are common, and lines that are unique, to two input files; a file name of `-' means standard input. Synopsis:

comm [option]... file1 file2

Before comm can be used, the input files must be sorted using the collating sequence specified by the LC_COLLATE locale. If an input file ends in a non-newline character, a newline is silently appended. The sort command with no options always outputs a file that is suitable input to comm.

With no options, comm produces three column output. Column one contains lines unique to file1, column two contains lines unique to file2, and column three contains lines common to both files. Columns are separated by a single TAB character.

The options `-1', `-2', and `-3' suppress printing of the corresponding columns. Also see 2. Common options.

Unlike some other comparison utilities, comm has an exit status that does not depend on the result of the comparison. Upon normal completion comm produces an exit code of zero. If there is an error it exits with nonzero status.

7.4 tsort: Topological sort

tsort performs a topological sort on the given file, or standard input if no input file is given or for a file of `-'. For more details and some history, see 7.5 tsort: Background. Synopsis:

tsort [option] [file]

tsort reads its input as pairs of strings, separated by blanks, indicating a partial ordering. The output is a total ordering that corresponds to the given partial ordering.

For example

tsort <<EOF a b c d e f b c d e EOF

will produce the output

a b c d e f

Consider a more realistic example. You have a large set of functions all in one file, and they may all be declared static except one. Currently that one (say main) is the first function defined in the file, and the ones it calls directly follow it, followed by those they call, etc. Let's say that you are determined to take advantage of prototypes, so you have to choose between declaring all of those functions (which means duplicating a lot of information from the definitions) and rearranging the functions so that as many as possible are defined before they are used. One way to automate the latter process is to get a list for each function of the functions it calls directly. Many programs can generate such lists. They describe a call graph. Consider the following list, in which a given line indicates that the function on the left calls the one on the right directly.

main parse_options main tail_file main tail_forever tail_file pretty_name tail_file write_header tail_file tail tail_forever recheck tail_forever pretty_name tail_forever write_header tail_forever dump_remainder tail tail_lines tail tail_bytes tail_lines start_lines tail_lines dump_remainder tail_lines file_lines tail_lines pipe_lines tail_bytes xlseek tail_bytes start_bytes tail_bytes dump_remainder tail_bytes pipe_bytes file_lines dump_remainder recheck pretty_name

then you can use tsort to produce an ordering of those functions that satisfies your requirement.

example$ tsort call-graph | tac dump_remainder start_lines file_lines pipe_lines xlseek start_bytes pipe_bytes tail_lines tail_bytes pretty_name write_header tail recheck parse_options tail_file tail_forever main

tsort detects any cycles in the input and writes the first cycle encountered to standard error.

Note that for a given partial ordering, generally there is no unique total ordering. In the context of the call graph above, the function parse_options may be placed anywhere in the list as long as it precedes main.

The only options are `--help' and `--version'. See section 2. Common options.

7.5 tsort: Background

tsort exists because very early versions of the Unix linker processed an archive file exactly once, and in order. As ld read each object in the archive, it decided whether it was needed in the program based on whether it defined any symbols which were undefined at that point in the link.

This meant that dependencies within the archive had to be handled specially. For example, scanf probably calls read. That means that in a single pass through an archive, it was important for scanf.o to appear before read.o, because otherwise a program which calls scanf but not read might end up with an unexpected unresolved reference to read.

The way to address this problem was to first generate a set of dependencies of one object file on another. This was done by a shell script called lorder. The GNU tools don't provide a version of lorder, as far as I know, but you can still find it in BSD distributions.

Then you ran tsort over the lorder output, and you used the resulting sort to define the order in which you added objects to the archive.

This whole procedure has been obsolete since about 1980, because Unix archives now contain a symbol table (traditionally built by ranlib, now generally built by ar itself), and the Unix linker uses the symbol table to effectively make multiple passes over an archive file.

Anyhow, that's where tsort came from. To solve an old problem with the way the linker handled archive files, which has since been solved in different ways.

7.6 ptx: Produce permuted indexes

ptx reads a text file and essentially produces a permuted index, with each keyword in its context. The calling sketch is either one of:

ptx [option ...] [file ...] ptx -G [option ...] [input [output]]

The `-G' (or its equivalent: `--traditional') option disables all GNU extensions and reverts to traditional mode, thus introducing some limitations and changing several of the program's default option values. When `-G' is not specified, GNU extensions are always enabled. GNU extensions to ptx are documented wherever appropriate in this document. For the full list, see See section 7.6.5 The GNU extensions to ptx.

Individual options are explained in the following sections.

When GNU extensions are enabled, there may be zero, one or several files after the options. If there is no file, the program reads the standard input. If there is one or several files, they give the name of input files which are all read in turn, as if all the input files were concatenated. However, there is a full contextual break between each file and, when automatic referencing is requested, file names and line numbers refer to individual text input files. In all cases, the program outputs the permuted index to the standard output.

When GNU extensions are not enabled, that is, when the program operates in traditional mode, there may be zero, one or two parameters besides the options. If there are no parameters, the program reads the standard input and outputs the permuted index to the standard output. If there is only one parameter, it names the text input to be read instead of the standard input. If two parameters are given, they give respectively the name of the input file to read and the name of the output file to produce. Be very careful to note that, in this case, the contents of file given by the second parameter is destroyed. This behavior is dictated by System V ptx compatibility; GNU Standards normally discourage output parameters not introduced by an option.

Note that for any file named as the value of an option or as an input text file, a single dash - may be used, in which case standard input is assumed. However, it would not make sense to use this convention more than once per program invocation.

7.6.1 General options		Options which affect general program behavior.
7.6.2 Charset selection		Underlying character set considerations.
7.6.3 Word selection and input processing		Input fields, contexts, and keyword selection.
7.6.4 Output formatting		Types of output format, and sizing the fields.
7.6.5 The GNU extensions to ptx

7.6.1 General options

`-C'

`--copyright'

Print a short note about the copyright and copying conditions, then exit without further processing.

`-G'

`--traditional'

As already explained, this option disables all GNU extensions to ptx and switches to traditional mode.

`--help'

Print a short help on standard output, then exit without further processing.

`--version'

Print the program version on standard output, then exit without further processing.

7.6.2 Charset selection

As it is set up now, the program assumes that the input file is coded using 8-bit ISO 8859-1 code, also known as Latin-1 character set, unless it is compiled for MS-DOS, in which case it uses the character set of the IBM-PC. (GNU ptx is not known to work on smaller MS-DOS machines anymore.) Compared to 7-bit ASCII, the set of characters which are letters is different; this alters the behavior of regular expression matching. Thus, the default regular expression for a keyword allows foreign or diacriticized letters. Keyword sorting, however, is still crude; it obeys the underlying character set ordering quite blindly.

`-f'

`--ignore-case'

Fold lower case letters to upper case for sorting.

7.6.3 Word selection and input processing

`-b file'

`--break-file=file'

This option provides an alternative (to `-W') method of describing which characters make up words. It introduces the name of a file which contains a list of characters which cannot be part of one word; this file is called the Break file. Any character which is not part of the Break file is a word constituent. If both options `-b' and `-W' are specified, then `-W' has precedence and `-b' is ignored.

When GNU extensions are enabled, the only way to avoid newline as a break character is to write all the break characters in the file with no newline at all, not even at the end of the file. When GNU extensions are disabled, spaces, tabs and newlines are always considered as break characters even if not included in the Break file.

`-i file'

`--ignore-file=file'

The file associated with this option contains a list of words which will never be taken as keywords in concordance output. It is called the Ignore file. The file contains exactly one word in each line; the end of line separation of words is not subject to the value of the `-S' option.

There is a default Ignore file used by ptx when this option is not specified, usually found in `/usr/local/lib/eign' if this has not been changed at installation time. If you want to deactivate the default Ignore file, specify /dev/null instead.

`-o file'

`--only-file=file'

The file associated with this option contains a list of words which will be retained in concordance output; any word not mentioned in this file is ignored. The file is called the Only file. The file contains exactly one word in each line; the end of line separation of words is not subject to the value of the `-S' option.

There is no default for the Only file. When both an Only file and an Ignore file are specified, a word is considered a keyword only if it is listed in the Only file and not in the Ignore file.

`-r'

`--references'

On each input line, the leading sequence of non-white space characters will be taken to be a reference that has the purpose of identifying this input line in the resulting permuted index. For more information about reference production, see See section 7.6.4 Output formatting. Using this option changes the default value for option `-S'.

Using this option, the program does not try very hard to remove references from contexts in output, but it succeeds in doing so when the context ends exactly at the newline. If option `-r' is used with `-S' default value, or when GNU extensions are disabled, this condition is always met and references are completely excluded from the output contexts.

`-S regexp'

`--sentence-regexp=regexp'

This option selects which regular expression will describe the end of a line or the end of a sentence. In fact, this regular expression is not the only distinction between end of lines or end of sentences, and input line boundaries have no special significance outside this option. By default, when GNU extensions are enabled and if `-r' option is not used, end of sentences are used. In this case, this regex is imported from GNU Emacs:

[.?!][]\"')}]*\\($\\|\t\\| \\)[ \t\n]*

Whenever GNU extensions are disabled or if `-r' option is used, end of lines are used; in this case, the default regexp is just:

\n

Using an empty regexp is equivalent to completely disabling end of line or end of sentence recognition. In this case, the whole file is considered to be a single big line or sentence. The user might want to disallow all truncation flag generation as well, through option `-F ""'. See section `Syntax of Regular Expressions' in The GNU Emacs Manual.

When the keywords happen to be near the beginning of the input line or sentence, this often creates an unused area at the beginning of the output context line; when the keywords happen to be near the end of the input line or sentence, this often creates an unused area at the end of the output context line. The program tries to fill those unused areas by wrapping around context in them; the tail of the input line or sentence is used to fill the unused area on the left of the output line; the head of the input line or sentence is used to fill the unused area on the right of the output line.

As a matter of convenience to the user, many usual backslashed escape sequences from the C language are recognized and converted to the corresponding characters by ptx itself.

`-W regexp'

`--word-regexp=regexp'

This option selects which regular expression will describe each keyword. By default, if GNU extensions are enabled, a word is a sequence of letters; the regexp used is `\w+'. When GNU extensions are disabled, a word is by default anything which ends with a space, a tab or a newline; the regexp used is `[^ \t\n]+'.

An empty regexp is equivalent to not using this option. See section `Syntax of Regular Expressions' in The GNU Emacs Manual.

As a matter of convenience to the user, many usual backslashed escape sequences, as found in the C language, are recognized and converted to the corresponding characters by ptx itself.

7.6.4 Output formatting

Output format is mainly controlled by the `-O' and `-T' options described in the table below. When neither `-O' nor `-T' are selected, and if GNU extensions are enabled, the program chooses an output format suitable for a dumb terminal. Each keyword occurrence is output to the center of one line, surrounded by its left and right contexts. Each field is properly justified, so the concordance output can be readily observed. As a special feature, if automatic references are selected by option `-A' and are output before the left context, that is, if option `-R' is not selected, then a colon is added after the reference; this nicely interfaces with GNU Emacs next-error processing. In this default output format, each white space character, like newline and tab, is merely changed to exactly one space, with no special attempt to compress consecutive spaces. This might change in the future. Except for those white space characters, every other character of the underlying set of 256 characters is transmitted verbatim.

Output format is further controlled by the following options.

`-g number'

`--gap-size=number'

Select the size of the minimum white space gap between the fields on the output line.

`-w number'

`--width=number'

Select the maximum output width of each final line. If references are used, they are included or excluded from the maximum output width depending on the value of option `-R'. If this option is not selected, that is, when references are output before the left context, the maximum output width takes into account the maximum length of all references. If this option is selected, that is, when references are output after the right context, the maximum output width does not take into account the space taken by references, nor the gap that precedes them.

`-A'

`--auto-reference'

Select automatic references. Each input line will have an automatic reference made up of the file name and the line ordinal, with a single colon between them. However, the file name will be empty when standard input is being read. If both `-A' and `-r' are selected, then the input reference is still read and skipped, but the automatic reference is used at output time, overriding the input reference.

`-R'

`--right-side-refs'

In the default output format, when option `-R' is not used, any references produced by the effect of options `-r' or `-A' are placed to the far right of output lines, after the right context. With default output format, when the `-R' option is specified, references are rather placed at the beginning of each output line, before the left context. For any other output format, option `-R' is ignored, with one exception: with `-R' the width of references is not taken into account in total output width given by `-w'.

This option is automatically selected whenever GNU extensions are disabled.

`-F string'

`--flac-truncation=string'

This option will request that any truncation in the output be reported using the string string. Most output fields theoretically extend towards the beginning or the end of the current line, or current sentence, as selected with option `-S'. But there is a maximum allowed output line width, changeable through option `-w', which is further divided into space for various output fields. When a field has to be truncated because it cannot extend beyond the beginning or the end of the current line to fit in, then a truncation occurs. By default, the string used is a single slash, as in `-F /'.

string may have more than one character, as in `-F ...'. Also, in the particular case when string is empty (`-F ""'), truncation flagging is disabled, and no truncation marks are appended in this case.

As a matter of convenience to the user, many usual backslashed escape sequences, as found in the C language, are recognized and converted to the corresponding characters by ptx itself.

`-M string'

`--macro-name=string'

Select another string to be used instead of `xx', while generating output suitable for nroff, troff or TeX.

`-O'

`--format=roff'

Choose an output format suitable for nroff or troff processing. Each output line will look like:

.xx "tail" "before" "keyword_and_after" "head" "ref"

so it will be possible to write a `.xx' roff macro to take care of the output typesetting. This is the default output format when GNU extensions are disabled. Option `-M' can be used to change `xx' to another macro name.

In this output format, each non-graphical character, like newline and tab, is merely changed to exactly one space, with no special attempt to compress consecutive spaces. Each quote character: " is doubled so it will be correctly processed by nroff or troff.

`-T'

`--format=tex'

Choose an output format suitable for TeX processing. Each output line will look like:

\xx {tail}{before}{keyword}{after}{head}{ref}

so it will be possible to write a \xx definition to take care of the output typesetting. Note that when references are not being produced, that is, neither option `-A' nor option `-r' is selected, the last parameter of each \xx call is inhibited. Option `-M' can be used to change `xx' to another macro name.

In this output format, some special characters, like $, %, &, # and _ are automatically protected with a backslash. Curly brackets {, } are protected with a backslash and a pair of dollar signs (to force mathematical mode). The backslash itself produces the sequence \backslash{}. Circumflex and tilde diacritical marks produce the sequence ^\{ } and ~\{ } respectively. Other diacriticized characters of the underlying character set produce an appropriate TeX sequence as far as possible. The other non-graphical characters, like newline and tab, and all other characters which are not part of ASCII, are merely changed to exactly one space, with no special attempt to compress consecutive spaces. Let me know how to improve this special character processing for TeX.

7.6.5 The GNU extensions to ptx

This version of ptx contains a few features which do not exist in System V ptx. These extra features are suppressed by using the `-G' command line option, unless overridden by other command line options. Some GNU extensions cannot be recovered by overriding, so the simple rule is to avoid `-G' if you care about GNU extensions. Here are the differences between this program and System V ptx.

• This program can read many input files at once, it always writes the resulting concordance on standard output. On the other hand, System V ptx reads only one file and sends the result to standard output or, if a second file parameter is given on the command, to that file.

  Having output parameters not introduced by options is a dangerous practice which GNU avoids as far as possible. So, for using ptx portably between GNU and System V, you should always use it with a single input file, and always expect the result on standard output. You might also want to automatically configure in a `-G' option to ptx calls in products using ptx, if the configurator finds that the installed ptx accepts `-G'.

• The only options available in System V ptx are options `-b', `-f', `-g', `-i', `-o', `-r', `-t' and `-w'. All other options are GNU extensions and are not repeated in this enumeration. Moreover, some options have a slightly different meaning when GNU extensions are enabled, as explained below.

• By default, concordance output is not formatted for troff or nroff. It is rather formatted for a dumb terminal. troff or nroff output may still be selected through option `-O'.

• Unless `-R' option is used, the maximum reference width is subtracted from the total output line width. With GNU extensions disabled, width of references is not taken into account in the output line width computations.

• All 256 characters, even NULs, are always read and processed from input file with no adverse effect, even if GNU extensions are disabled. However, System V ptx does not accept 8-bit characters, a few control characters are rejected, and the tilde ~ is also rejected.

• Input line length is only limited by available memory, even if GNU extensions are disabled. However, System V ptx processes only the first 200 characters in each line.

• The break (non-word) characters default to be every character except all letters of the underlying character set, diacriticized or not. When GNU extensions are disabled, the break characters default to space, tab and newline only.

• The program makes better use of output line width. If GNU extensions are disabled, the program rather tries to imitate System V ptx, but still, there are some slight disposition glitches this program does not completely reproduce.

• The user can specify both an Ignore file and an Only file. This is not allowed with System V ptx.

8. Operating on fields within a line

8.1 cut: Print selected parts of lines		Print selected parts of lines.
8.2 paste: Merge lines of files		Merge lines of files.
8.3 join: Join lines on a common field		Join lines on a common field.

8.1 cut: Print selected parts of lines

cut writes to standard output selected parts of each line of each input file, or standard input if no files are given or for a file name of `-'. Synopsis:

cut [option]... [file]...

In the table which follows, the byte-list, character-list, and field-list are one or more numbers or ranges (two numbers separated by a dash) separated by commas. Bytes, characters, and fields are numbered starting at 1. Incomplete ranges may be given: `-m' means `1-m'; `n-' means `n' through end of line or last field. The list elements can be repeated, can overlap, and can be specified in any order; but the selected input is written in the same order that it is read, and is written exactly once.

The program accepts the following options. Also see 2. Common options.

`-b byte-list'

`--bytes=byte-list'

Print only the bytes in positions listed in byte-list. Tabs and backspaces are treated like any other character; they take up 1 byte.

`-c character-list'

`--characters=character-list'

Print only characters in positions listed in character-list. The same as `-b' for now, but internationalization will change that. Tabs and backspaces are treated like any other character; they take up 1 character.

`-f field-list'

`--fields=field-list'

Print only the fields listed in field-list. Fields are separated by a TAB character by default. Also print any line that contains no delimiter character, unless the `--only-delimited' (`-s') option is specified

`-d input_delim_byte'

`--delimiter=input_delim_byte'

For `-f', fields are separated in the input by the first character in input_delim_byte (default is TAB).

`-n'

Do not split multi-byte characters (no-op for now).

`-s'

`--only-delimited'

For `-f', do not print lines that do not contain the field separator character. Normally, any line without a field separator is printed verbatim.

`--output-delimiter=output_delim_string'

For `-f', output fields are separated by output_delim_string. The default is to use the input delimiter.

8.2 paste: Merge lines of files

paste writes to standard output lines consisting of sequentially corresponding lines of each given file, separated by a TAB character. Standard input is used for a file name of `-' or if no input files are given.

For example:

$ cat num2 1 2 $ cat let3 a b c $ paste num2 let3 1 a 2 b c

Synopsis:

paste [option]... [file]...

The program accepts the following options. Also see 2. Common options.

`-s'

`--serial'

Paste the lines of one file at a time rather than one line from each file. Using the above example data:

$ paste -s num2 let3 1 2 a b c

`-d delim-list'

`--delimiters=delim-list'

Consecutively use the characters in delim-list instead of TAB to separate merged lines. When delim-list is exhausted, start again at its beginning. Using the above example data:

$ paste -d '%_' num2 let3 num2 1%a_1 2%b_2 %c_

8.3 join: Join lines on a common field

join writes to standard output a line for each pair of input lines that have identical join fields. Synopsis:

join [option]... file1 file2

Either file1 or file2 (but not both) can be `-', meaning standard input. file1 and file2 should be sorted on the join fields.

Normally, the sort order is that of the collating sequence specified by the LC_COLLATE locale. Unless the `-t' option is given, the sort comparison ignores blanks at the start of the join field, as in sort -b. If the `--ignore-case' option is given, the sort comparison ignores the case of characters in the join field, as in sort -f.

However, as a GNU extension, if the input has no unpairable lines the sort order can be any order that considers two fields to be equal if and only if the sort comparison described above considers them to be equal. For example:

$ cat file1 a a1 c c1 b b1 $ cat file2 a a2 c c2 b b2 $ join file1 file2 a a1 a2 c c1 c2 b b1 b2

The defaults are: the join field is the first field in each line; fields in the input are separated by one or more blanks, with leading blanks on the line ignored; fields in the output are separated by a space; each output line consists of the join field, the remaining fields from file1, then the remaining fields from file2.

The program accepts the following options. Also see 2. Common options.

`-a file-number'

Print a line for each unpairable line in file file-number (either `1' or `2'), in addition to the normal output.

`-e string'

Replace those output fields that are missing in the input with string.

`-i'

`--ignore-case'

Ignore differences in case when comparing keys. With this option, the lines of the input files must be ordered in the same way. Use `sort -f' to produce this ordering.

`-1 field'

`-j1 field'

Join on field field (a positive integer) of file 1.

`-2 field'

`-j2 field'

Join on field field (a positive integer) of file 2.

`-j field'

Equivalent to `-1 field -2 field'.

`-o field-list...'

Construct each output line according to the format in field-list. Each element in field-list is either the single character `0' or has the form m.n where the file number, m, is `1' or `2' and n is a positive field number.

A field specification of `0' denotes the join field. In most cases, the functionality of the `0' field spec may be reproduced using the explicit m.n that corresponds to the join field. However, when printing unpairable lines (using either of the `-a' or `-v' options), there is no way to specify the join field using m.n in field-list if there are unpairable lines in both files. To give join that functionality, POSIX invented the `0' field specification notation.

The elements in field-list are separated by commas or blanks. Multiple field-list arguments can be given after a single `-o' option; the values of all lists given with `-o' are concatenated together. All output lines -- including those printed because of any -a or -v option -- are subject to the specified field-list.

`-t char'

Use character char as the input and output field separator.

`-v file-number'

Print a line for each unpairable line in file file-number (either `1' or `2'), instead of the normal output.

In addition, when GNU join is invoked with exactly one argument, the `--help' and `--version' options are recognized. See section 2. Common options.

9. Operating on characters

This commands operate on individual characters.

9.1 tr: Translate, squeeze, and/or delete characters		Translate, squeeze, and/or delete characters.
9.2 expand: Convert tabs to spaces		Convert tabs to spaces.
9.3 unexpand: Convert spaces to tabs		Convert spaces to tabs.

9.1 tr: Translate, squeeze, and/or delete characters

Synopsis:

tr [option]... set1 [set2]

tr copies standard input to standard output, performing one of the following operations:

• translate, and optionally squeeze repeated characters in the result,
• squeeze repeated characters,
• delete characters,
• delete characters, then squeeze repeated characters from the result.

The set1 and (if given) set2 arguments define ordered sets of characters, referred to below as set1 and set2. These sets are the characters of the input that tr operates on. The `--complement' (`-c') option replaces set1 with its complement (all of the characters that are not in set1).

9.1.1 Specifying sets of characters
9.1.2 Translating		Changing one characters to another.
9.1.3 Squeezing repeats and deleting
9.1.4 Warning messages

9.1.1 Specifying sets of characters

The format of the set1 and set2 arguments resembles the format of regular expressions; however, they are not regular expressions, only lists of characters. Most characters simply represent themselves in these strings, but the strings can contain the shorthands listed below, for convenience. Some of them can be used only in set1 or set2, as noted below.

Backslash escapes

A backslash followed by a character not listed below causes an error message.

`\a'

Control-G.

`\b'

Control-H.

`\f'

Control-L.

`\n'

Control-J.

`\r'

Control-M.

`\t'

Control-I.

`\v'

Control-K.

`\ooo'

The character with the value given by ooo, which is 1 to 3 octal digits,

`\\'

A backslash.

Ranges

The notation `m-n' expands to all of the characters from m through n, in ascending order. m should collate before n; if it doesn't, an error results. As an example, `0-9' is the same as `0123456789'.

GNU tr does not support the System V syntax that uses square brackets to enclose ranges. Translations specified in that format sometimes work as expected, since the brackets are often transliterated to themselves. However, they should be avoided because they sometimes behave unexpectedly. For example, `tr -d '[0-9]'' deletes brackets as well as digits.

Many historically common and even accepted uses of ranges are not portable. For example, on EBCDIC hosts using the `A-Z' range will not do what most would expect because `A' through `Z' are not contiguous as they are in ASCII. If you can rely on a POSIX compliant version of tr, then the best way to work around this is to use character classes (see below). Otherwise, it is most portable (and most ugly) to enumerate the members of the ranges.

Repeated characters

The notation `[c*n]' in set2 expands to n copies of character c. Thus, `[y*6]' is the same as `yyyyyy'. The notation `[c*]' in string2 expands to as many copies of c as are needed to make set2 as long as set1. If n begins with `0', it is interpreted in octal, otherwise in decimal.

Character classes

The notation `[:class:]' expands to all of the characters in the (predefined) class class. The characters expand in no particular order, except for the upper and lower classes, which expand in ascending order. When the `--delete' (`-d') and `--squeeze-repeats' (`-s') options are both given, any character class can be used in set2. Otherwise, only the character classes lower and upper are accepted in set2, and then only if the corresponding character class (upper and lower, respectively) is specified in the same relative position in set1. Doing this specifies case conversion. The class names are given below; an error results when an invalid class name is given.

alnum

Letters and digits.

alpha

Letters.

blank

Horizontal whitespace.

cntrl

Control characters.

digit

Digits.

graph

Printable characters, not including space.

lower

Lowercase letters.

print

Printable characters, including space.

punct

Punctuation characters.

space

Horizontal or vertical whitespace.

upper

Uppercase letters.

xdigit

Hexadecimal digits.

Equivalence classes

The syntax `[=c=]' expands to all of the characters that are equivalent to c, in no particular order. Equivalence classes are a relatively recent invention intended to support non-English alphabets. But there seems to be no standard way to define them or determine their contents. Therefore, they are not fully implemented in GNU tr; each character's equivalence class consists only of that character, which is of no particular use.

9.1.2 Translating

tr performs translation when set1 and set2 are both given and the `--delete' (`-d') option is not given. tr translates each character of its input that is in set1 to the corresponding character in set2. Characters not in set1 are passed through unchanged. When a character appears more than once in set1 and the corresponding characters in set2 are not all the same, only the final one is used. For example, these two commands are equivalent:

tr aaa xyz tr a z

A common use of tr is to convert lowercase characters to uppercase. This can be done in many ways. Here are three of them:

tr abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ tr a-z A-Z tr '[:lower:]' '[:upper:]'

But note that using ranges like a-z above is not portable.

When tr is performing translation, set1 and set2 typically have the same length. If set1 is shorter than set2, the extra characters at the end of set2 are ignored.

On the other hand, making set1 longer than set2 is not portable; POSIX says that the result is undefined. In this situation, BSD tr pads set2 to the length of set1 by repeating the last character of set2 as many times as necessary. System V tr truncates set1 to the length of set2.

By default, GNU tr handles this case like BSD tr. When the `--truncate-set1' (`-t') option is given, GNU tr handles this case like the System V tr instead. This option is ignored for operations other than translation.

Acting like System V tr in this case breaks the relatively common BSD idiom:

tr -cs A-Za-z0-9 '\012'

because it converts only zero bytes (the first element in the complement of set1), rather than all non-alphanumerics, to newlines.

By the way, the above idiom is not portable because it uses ranges. Assuming a POSIX compliant tr, here is a better way to write it:

tr -cs '[:alnum:]' '[\n*]'

9.1.3 Squeezing repeats and deleting

When given just the `--delete' (`-d') option, tr removes any input characters that are in set1.

When given just the `--squeeze-repeats' (`-s') option, tr replaces each input sequence of a repeated character that is in set1 with a single occurrence of that character.

When given both `--delete' and `--squeeze-repeats', tr first performs any deletions using set1, then squeezes repeats from any remaining characters using set2.

The `--squeeze-repeats' option may also be used when translating, in which case tr first performs translation, then squeezes repeats from any remaining characters using set2.

Here are some examples to illustrate various combinations of options:

• Remove all zero bytes:

  tr -d '\000'

• Put all words on lines by themselves. This converts all non-alphanumeric characters to newlines, then squeezes each string of repeated newlines into a single newline:

  tr -cs '[:alnum:]' '[\n*]'

• Convert each sequence of repeated newlines to a single newline:

  tr -s '\n'

• Find doubled occurrences of words in a document. For example, people often write "the the" with the duplicated words separated by a newline. The bourne shell script below works first by converting each sequence of punctuation and blank characters to a single newline. That puts each "word" on a line by itself. Next it maps all uppercase characters to lower case, and finally it runs uniq with the `-d' option to print out only the words that were adjacent duplicates.

  #!/bin/sh cat "$@" \ | tr -s '[:punct:][:blank:]' '\n' \ | tr '[:upper:]' '[:lower:]' \ | uniq -d

• Deleting a small set of characters is usually straightforward. For example, to remove all `a's, `x's, and `M's you would do this:

  tr -d axM

  However, when `-' is one of those characters, it can be tricky because `-' has special meanings. Performing the same task as above but also removing all `-' characters, we might try tr -d -axM, but that would fail because tr would try to interpret `-a' as a command-line option. Alternatively, we could try putting the hyphen inside the string, tr -d a-xM, but that wouldn't work either because it would make tr interpret a-x as the range of characters `a'...`x' rather than the three. One way to solve the problem is to put the hyphen at the end of the list of characters:

  tr -d axM-

  More generally, use the character class notation [=c=] with `-' (or any other character) in place of the `c':

  tr -d '[=-=]axM'

  Note how single quotes are used in the above example to protect the square brackets from interpretation by a shell.

9.1.4 Warning messages

Setting the environment variable POSIXLY_CORRECT turns off the following warning and error messages, for strict compliance with POSIX. Otherwise, the following diagnostics are issued:

1. When the `--delete' option is given but `--squeeze-repeats' is not, and set2 is given, GNU tr by default prints a usage message and exits, because set2 would not be used. The POSIX specification says that set2 must be ignored in this case. Silently ignoring arguments is a bad idea.

2. When an ambiguous octal escape is given. For example, `\400' is actually `\40' followed by the digit `0', because the value 400 octal does not fit into a single byte.

GNU tr does not provide complete BSD or System V compatibility. For example, it is impossible to disable interpretation of the POSIX constructs `[:alpha:]', `[=c=]', and `[c*10]'. Also, GNU tr does not delete zero bytes automatically, unlike traditional Unix versions, which provide no way to preserve zero bytes.

9.2 expand: Convert tabs to spaces

expand writes the contents of each given file, or standard input if none are given or for a file of `-', to standard output, with tab characters converted to the appropriate number of spaces. Synopsis:

expand [option]... [file]...

By default, expand converts all tabs to spaces. It preserves backspace characters in the output; they decrement the column count for tab calculations. The default action is equivalent to `-t 8' (set tabs every 8 columns).

The program accepts the following options. Also see 2. Common options.

`-t tab1[,tab2]...'

`--tabs=tab1[,tab2]...'

If only one tab stop is given, set the tabs tab1 spaces apart (default is 8). Otherwise, set the tabs at columns tab1, tab2, ... (numbered from 0), and replace any tabs beyond the last tabstop given with single spaces. Tabstops can be separated by blanks as well as by commas.

On older systems, expand supports an obsolete option `-tab1[,tab2]...', where tabstops must be separated by commas. POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `-t tab1[,tab2]...' instead.

`-i'

`--initial'

Only convert initial tabs (those that precede all non-space or non-tab characters) on each line to spaces.

9.3 unexpand: Convert spaces to tabs

unexpand writes the contents of each given file, or standard input if none are given or for a file of `-', to standard output, with strings of two or more space or tab characters converted to as many tabs as possible followed by as many spaces as are needed. Synopsis:

unexpand [option]... [file]...

By default, unexpand converts only initial spaces and tabs (those that precede all non space or tab characters) on each line. It preserves backspace characters in the output; they decrement the column count for tab calculations. By default, tabs are set at every 8th column.

The program accepts the following options. Also see 2. Common options.

`-t tab1[,tab2]...'

`--tabs=tab1[,tab2]...'

If only one tab stop is given, set the tabs tab1 spaces apart instead of the default 8. Otherwise, set the tabs at columns tab1, tab2, ... (numbered from 0), and leave spaces and tabs beyond the tabstops given unchanged. Tabstops can be separated by blanks as well as by commas. This option implies the `-a' option.

On older systems, unexpand supports an obsolete option `-tab1[,tab2]...', where tabstops must be separated by commas. (Unlike `-t', this obsolete option does not imply `-a'.) POSIX 1003.1-2001 (see section 2.5 Standards conformance) does not allow this; use `--first-only -t tab1[,tab2]...' instead.

`-a'

`--all'

Convert all strings of two or more spaces or tabs, not just initial ones, to tabs.

10. Directory listing

This chapter describes the ls command and its variants dir and vdir, which list information about files.

10.1 ls: List directory contents		List directory contents.
10.2 dir: Briefly list directory contents		Briefly ls.
10.3 vdir: Verbosely list directory contents		Verbosely ls.
10.4 dircolors: Color setup for ls		Color setup for ls, etc.

10.1 ls: List directory contents

The ls program lists information about files (of any type, including directories). Options and file arguments can be intermixed arbitrarily, as usual.

For non-option command-line arguments that are directories, by default ls lists the contents of directories, not recursively, and omitting files with names beginning with `.'. For other non-option arguments, by default ls lists just the file name. If no non-option argument is specified, ls operates on the current directory, acting as if it had been invoked with a single argument of `.'.

By default, the output is sorted alphabetically, according to the locale settings in effect. (2) If standard output is a terminal, the output is in columns (sorted vertically) and control characters are output as question marks; otherwise, the output is listed one per line and control characters are output as-is.

Because ls is such a fundamental program, it has accumulated many options over the years. They are described in the subsections below; within each section, options are listed alphabetically (ignoring case). The division of options into the subsections is not absolute, since some options affect more than one aspect of ls's operation.

Also see 2. Common options.

10.1.1 Which files are listed
10.1.2 What information is listed
10.1.3 Sorting the output
10.1.4 More details about version sort
10.1.5 General output formatting
10.1.6 Formatting file timestamps
10.1.7 Formatting the file names