docs: mention POSIX 2008
[platform/upstream/coreutils.git] / doc / coreutils.texi
1 \input texinfo
2 @c %**start of header
3 @setfilename coreutils.info
4 @settitle @sc{gnu} Coreutils
5
6 @c %**end of header
7
8 @include version.texi
9 @include constants.texi
10
11 @c Define new indices.
12 @defcodeindex op
13 @defcodeindex fl
14
15 @c Put everything in one index (arbitrarily chosen to be the concept index).
16 @syncodeindex fl cp
17 @syncodeindex fn cp
18 @syncodeindex ky cp
19 @syncodeindex op cp
20 @syncodeindex pg cp
21 @syncodeindex vr cp
22
23 @dircategory Basics
24 @direntry
25 * Coreutils: (coreutils).       Core GNU (file, text, shell) utilities.
26 * Common options: (coreutils)Common options.      Common options.
27 * File permissions: (coreutils)File permissions.  Access modes.
28 * Date input formats: (coreutils)Date input formats.
29 @end direntry
30
31 @c FIXME: the following need documentation
32 @c * [: (coreutils)[ invocation.                   File/string tests.
33 @c * pinky: (coreutils)pinky invocation.           FIXME.
34
35 @dircategory Individual utilities
36 @direntry
37 * arch: (coreutils)arch invocation.             Print machine hardware name.
38 * base64: (coreutils)base64 invocation.         Base64 encode/decode data.
39 * basename: (coreutils)basename invocation.     Strip directory and suffix.
40 * cat: (coreutils)cat invocation.               Concatenate and write files.
41 * chcon: (coreutils)chcon invocation.           Change SELinux CTX of files.
42 * chgrp: (coreutils)chgrp invocation.           Change file groups.
43 * chmod: (coreutils)chmod invocation.           Change file permissions.
44 * chown: (coreutils)chown invocation.           Change file owners/groups.
45 * chroot: (coreutils)chroot invocation.         Specify the root directory.
46 * cksum: (coreutils)cksum invocation.           Print POSIX CRC checksum.
47 * comm: (coreutils)comm invocation.             Compare sorted files by line.
48 * cp: (coreutils)cp invocation.                 Copy files.
49 * csplit: (coreutils)csplit invocation.         Split by context.
50 * cut: (coreutils)cut invocation.               Print selected parts of lines.
51 * date: (coreutils)date invocation.             Print/set system date and time.
52 * dd: (coreutils)dd invocation.                 Copy and convert a file.
53 * df: (coreutils)df invocation.                 Report file system disk usage.
54 * dir: (coreutils)dir invocation.               List directories briefly.
55 * dircolors: (coreutils)dircolors invocation.   Color setup for ls.
56 * dirname: (coreutils)dirname invocation.       Strip last file name component.
57 * du: (coreutils)du invocation.                 Report on disk usage.
58 * echo: (coreutils)echo invocation.             Print a line of text.
59 * env: (coreutils)env invocation.               Modify the environment.
60 * expand: (coreutils)expand invocation.         Convert tabs to spaces.
61 * expr: (coreutils)expr invocation.             Evaluate expressions.
62 * factor: (coreutils)factor invocation.         Print prime factors
63 * false: (coreutils)false invocation.           Do nothing, unsuccessfully.
64 * fmt: (coreutils)fmt invocation.               Reformat paragraph text.
65 * fold: (coreutils)fold invocation.             Wrap long input lines.
66 * groups: (coreutils)groups invocation.         Print group names a user is in.
67 * head: (coreutils)head invocation.             Output the first part of files.
68 * hostid: (coreutils)hostid invocation.         Print numeric host identifier.
69 * hostname: (coreutils)hostname invocation.     Print or set system name.
70 * id: (coreutils)id invocation.                 Print user identity.
71 * install: (coreutils)install invocation.       Copy and change attributes.
72 * join: (coreutils)join invocation.             Join lines on a common field.
73 * kill: (coreutils)kill invocation.             Send a signal to processes.
74 * link: (coreutils)link invocation.             Make hard links between files.
75 * ln: (coreutils)ln invocation.                 Make links between files.
76 * logname: (coreutils)logname invocation.       Print current login name.
77 * ls: (coreutils)ls invocation.                 List directory contents.
78 * md5sum: (coreutils)md5sum invocation.         Print or check MD5 digests.
79 * mkdir: (coreutils)mkdir invocation.           Create directories.
80 * mkfifo: (coreutils)mkfifo invocation.         Create FIFOs (named pipes).
81 * mknod: (coreutils)mknod invocation.           Create special files.
82 * mktemp: (coreutils)mktemp invocation.         Create temporary files.
83 * mv: (coreutils)mv invocation.                 Rename files.
84 * nice: (coreutils)nice invocation.             Modify niceness.
85 * nl: (coreutils)nl invocation.                 Number lines and write files.
86 * nohup: (coreutils)nohup invocation.           Immunize to hangups.
87 * nproc: (coreutils)nproc invocation.           Print the number of processors.
88 * od: (coreutils)od invocation.                 Dump files in octal, etc.
89 * paste: (coreutils)paste invocation.           Merge lines of files.
90 * pathchk: (coreutils)pathchk invocation.       Check file name portability.
91 * pr: (coreutils)pr invocation.                 Paginate or columnate files.
92 * printenv: (coreutils)printenv invocation.     Print environment variables.
93 * printf: (coreutils)printf invocation.         Format and print data.
94 * ptx: (coreutils)ptx invocation.               Produce permuted indexes.
95 * pwd: (coreutils)pwd invocation.               Print working directory.
96 * readlink: (coreutils)readlink invocation.     Print referent of a symlink.
97 * rm: (coreutils)rm invocation.                 Remove files.
98 * rmdir: (coreutils)rmdir invocation.           Remove empty directories.
99 * runcon: (coreutils)runcon invocation.         Run in specified SELinux CTX.
100 * seq: (coreutils)seq invocation.               Print numeric sequences
101 * sha1sum: (coreutils)sha1sum invocation.       Print or check SHA-1 digests.
102 * sha2: (coreutils)sha2 utilities.              Print or check SHA-2 digests.
103 * shred: (coreutils)shred invocation.           Remove files more securely.
104 * shuf: (coreutils)shuf invocation.             Shuffling text files.
105 * sleep: (coreutils)sleep invocation.           Delay for a specified time.
106 * sort: (coreutils)sort invocation.             Sort text files.
107 * split: (coreutils)split invocation.           Split into pieces.
108 * stat: (coreutils)stat invocation.             Report file(system) status.
109 * stdbuf: (coreutils)stdbuf invocation.         Modify stdio buffering.
110 * stty: (coreutils)stty invocation.             Print/change terminal settings.
111 * su: (coreutils)su invocation.                 Modify user and group ID.
112 * sum: (coreutils)sum invocation.               Print traditional checksum.
113 * sync: (coreutils)sync invocation.             Synchronize memory and disk.
114 * tac: (coreutils)tac invocation.               Reverse files.
115 * tail: (coreutils)tail invocation.             Output the last part of files.
116 * tee: (coreutils)tee invocation.               Redirect to multiple files.
117 * test: (coreutils)test invocation.             File/string tests.
118 * timeout: (coreutils)timeout invocation.       Run with time limit.
119 * touch: (coreutils)touch invocation.           Change file timestamps.
120 * tr: (coreutils)tr invocation.                 Translate characters.
121 * true: (coreutils)true invocation.             Do nothing, successfully.
122 * truncate: (coreutils)truncate invocation.     Shrink/extend size of a file.
123 * tsort: (coreutils)tsort invocation.           Topological sort.
124 * tty: (coreutils)tty invocation.               Print terminal name.
125 * uname: (coreutils)uname invocation.           Print system information.
126 * unexpand: (coreutils)unexpand invocation.     Convert spaces to tabs.
127 * uniq: (coreutils)uniq invocation.             Uniquify files.
128 * unlink: (coreutils)unlink invocation.         Removal via unlink(2).
129 * uptime: (coreutils)uptime invocation.         Print uptime and load.
130 * users: (coreutils)users invocation.           Print current user names.
131 * vdir: (coreutils)vdir invocation.             List directories verbosely.
132 * wc: (coreutils)wc invocation.                 Line, word, and byte counts.
133 * who: (coreutils)who invocation.               Print who is logged in.
134 * whoami: (coreutils)whoami invocation.         Print effective user ID.
135 * yes: (coreutils)yes invocation.               Print a string indefinitely.
136 @end direntry
137
138 @copying
139 This manual documents version @value{VERSION} of the @sc{gnu} core
140 utilities, including the standard programs for text and file manipulation.
141
142 Copyright @copyright{} 1994-1996, 2000-2011 Free Software Foundation, Inc.
143
144 @quotation
145 Permission is granted to copy, distribute and/or modify this document
146 under the terms of the GNU Free Documentation License, Version 1.3 or
147 any later version published by the Free Software Foundation; with no
148 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
149 Texts.  A copy of the license is included in the section entitled ``GNU
150 Free Documentation License''.
151 @end quotation
152 @end copying
153
154 @titlepage
155 @title @sc{gnu} @code{Coreutils}
156 @subtitle Core GNU utilities
157 @subtitle for version @value{VERSION}, @value{UPDATED}
158 @author David MacKenzie et al.
159
160 @page
161 @vskip 0pt plus 1filll
162 @insertcopying
163 @end titlepage
164 @shortcontents
165 @contents
166
167 @ifnottex
168 @node Top
169 @top GNU Coreutils
170
171 @insertcopying
172 @end ifnottex
173
174 @cindex core utilities
175 @cindex text utilities
176 @cindex shell utilities
177 @cindex file utilities
178
179 @menu
180 * Introduction::                 Caveats, overview, and authors
181 * Common options::               Common options
182 * Output of entire files::       cat tac nl od base64
183 * Formatting file contents::     fmt pr fold
184 * Output of parts of files::     head tail split csplit
185 * Summarizing files::            wc sum cksum md5sum sha1sum sha2
186 * Operating on sorted files::    sort shuf uniq comm ptx tsort
187 * Operating on fields::          cut paste join
188 * Operating on characters::      tr expand unexpand
189 * Directory listing::            ls dir vdir dircolors
190 * Basic operations::             cp dd install mv rm shred
191 * Special file types::         mkdir rmdir unlink mkfifo mknod ln link readlink
192 * Changing file attributes::     chgrp chmod chown touch
193 * Disk usage::                   df du stat sync truncate
194 * Printing text::                echo printf yes
195 * Conditions::                   false true test expr
196 * Redirection::                  tee
197 * File name manipulation::       dirname basename pathchk mktemp
198 * Working context::              pwd stty printenv tty
199 * User information::             id logname whoami groups users who
200 * System context::               date arch nproc uname hostname hostid uptime
201 * SELinux context::              chcon runcon
202 * Modified command invocation::  chroot env nice nohup stdbuf su timeout
203 * Process control::              kill
204 * Delaying::                     sleep
205 * Numeric operations::           factor seq
206 * File permissions::             Access modes
207 * Date input formats::           Specifying date strings
208 * Opening the software toolbox:: The software tools philosophy
209 * GNU Free Documentation License:: Copying and sharing this manual
210 * Concept index::                General index
211
212 @detailmenu
213  --- The Detailed Node Listing ---
214
215 Common Options
216
217 * Exit status::                  Indicating program success or failure
218 * Backup options::               Backup options
219 * Block size::                   Block size
220 * Floating point::               Floating point number representation
221 * Signal specifications::        Specifying signals
222 * Disambiguating names and IDs:: chgrp and chown owner and group syntax
223 * Random sources::               Sources of random data
224 * Target directory::             Target directory
225 * Trailing slashes::             Trailing slashes
226 * Traversing symlinks::          Traversing symlinks to directories
227 * Treating / specially::         Treating / specially
228 * Standards conformance::        Standards conformance
229
230 Output of entire files
231
232 * cat invocation::               Concatenate and write files
233 * tac invocation::               Concatenate and write files in reverse
234 * nl invocation::                Number lines and write files
235 * od invocation::                Write files in octal or other formats
236 * base64 invocation::            Transform data into printable data
237
238 Formatting file contents
239
240 * fmt invocation::               Reformat paragraph text
241 * pr invocation::                Paginate or columnate files for printing
242 * fold invocation::              Wrap input lines to fit in specified width
243
244 Output of parts of files
245
246 * head invocation::              Output the first part of files
247 * tail invocation::              Output the last part of files
248 * split invocation::             Split a file into fixed-size pieces
249 * csplit invocation::            Split a file into context-determined pieces
250
251 Summarizing files
252
253 * wc invocation::                Print newline, word, and byte counts
254 * sum invocation::               Print checksum and block counts
255 * cksum invocation::             Print CRC checksum and byte counts
256 * md5sum invocation::            Print or check MD5 digests
257 * sha1sum invocation::           Print or check SHA-1 digests
258 * sha2 utilities::               Print or check SHA-2 digests
259
260 Operating on sorted files
261
262 * sort invocation::              Sort text files
263 * shuf invocation::              Shuffle text files
264 * uniq invocation::              Uniquify files
265 * comm invocation::              Compare two sorted files line by line
266 * ptx invocation::               Produce a permuted index of file contents
267 * tsort invocation::             Topological sort
268
269 @command{ptx}: Produce permuted indexes
270
271 * General options in ptx::       Options which affect general program behavior
272 * Charset selection in ptx::     Underlying character set considerations
273 * Input processing in ptx::      Input fields, contexts, and keyword selection
274 * Output formatting in ptx::     Types of output format, and sizing the fields
275 * Compatibility in ptx::         The @acronym{GNU} extensions to @command{ptx}
276
277 Operating on fields
278
279 * cut invocation::               Print selected parts of lines
280 * paste invocation::             Merge lines of files
281 * join invocation::              Join lines on a common field
282
283 Operating on characters
284
285 * tr invocation::                Translate, squeeze, and/or delete characters
286 * expand invocation::            Convert tabs to spaces
287 * unexpand invocation::          Convert spaces to tabs
288
289 @command{tr}: Translate, squeeze, and/or delete characters
290
291 * Character sets::               Specifying sets of characters
292 * Translating::                  Changing one set of characters to another
293 * Squeezing::                    Squeezing repeats and deleting
294
295 Directory listing
296
297 * ls invocation::                List directory contents
298 * dir invocation::               Briefly list directory contents
299 * vdir invocation::              Verbosely list directory contents
300 * dircolors invocation::         Color setup for @command{ls}
301
302 @command{ls}:  List directory contents
303
304 * Which files are listed::       Which files are listed
305 * What information is listed::   What information is listed
306 * Sorting the output::           Sorting the output
307 * Details about version sort::   More details about version sort
308 * General output formatting::    General output formatting
309 * Formatting the file names::    Formatting the file names
310
311 Basic operations
312
313 * cp invocation::                Copy files and directories
314 * dd invocation::                Convert and copy a file
315 * install invocation::           Copy files and set attributes
316 * mv invocation::                Move (rename) files
317 * rm invocation::                Remove files or directories
318 * shred invocation::             Remove files more securely
319
320 Special file types
321
322 * link invocation::              Make a hard link via the link syscall
323 * ln invocation::                Make links between files
324 * mkdir invocation::             Make directories
325 * mkfifo invocation::            Make FIFOs (named pipes)
326 * mknod invocation::             Make block or character special files
327 * readlink invocation::          Print value of a symlink or canonical file name
328 * rmdir invocation::             Remove empty directories
329 * unlink invocation::            Remove files via unlink syscall
330
331 Changing file attributes
332
333 * chown invocation::             Change file owner and group
334 * chgrp invocation::             Change group ownership
335 * chmod invocation::             Change access permissions
336 * touch invocation::             Change file timestamps
337
338 Disk usage
339
340 * df invocation::                Report file system disk space usage
341 * du invocation::                Estimate file space usage
342 * stat invocation::              Report file or file system status
343 * sync invocation::              Synchronize data on disk with memory
344 * truncate invocation::          Shrink or extend the size of a file
345
346 Printing text
347
348 * echo invocation::              Print a line of text
349 * printf invocation::            Format and print data
350 * yes invocation::               Print a string until interrupted
351
352 Conditions
353
354 * false invocation::             Do nothing, unsuccessfully
355 * true invocation::              Do nothing, successfully
356 * test invocation::              Check file types and compare values
357 * expr invocation::              Evaluate expressions
358
359 @command{test}: Check file types and compare values
360
361 * File type tests::              File type tests
362 * Access permission tests::      Access permission tests
363 * File characteristic tests::    File characteristic tests
364 * String tests::                 String tests
365 * Numeric tests::                Numeric tests
366
367 @command{expr}: Evaluate expression
368
369 * String expressions::           + : match substr index length
370 * Numeric expressions::          + - * / %
371 * Relations for expr::           | & < <= = == != >= >
372 * Examples of expr::             Examples of using @command{expr}
373
374 Redirection
375
376 * tee invocation::               Redirect output to multiple files or processes
377
378 File name manipulation
379
380 * basename invocation::          Strip directory and suffix from a file name
381 * dirname invocation::           Strip last file name component
382 * pathchk invocation::           Check file name validity and portability
383 * mktemp invocation::            Create temporary file or directory
384
385 Working context
386
387 * pwd invocation::               Print working directory
388 * stty invocation::              Print or change terminal characteristics
389 * printenv invocation::          Print all or some environment variables
390 * tty invocation::               Print file name of terminal on standard input
391
392 @command{stty}: Print or change terminal characteristics
393
394 * Control::                      Control settings
395 * Input::                        Input settings
396 * Output::                       Output settings
397 * Local::                        Local settings
398 * Combination::                  Combination settings
399 * Characters::                   Special characters
400 * Special::                      Special settings
401
402 User information
403
404 * id invocation::                Print user identity
405 * logname invocation::           Print current login name
406 * whoami invocation::            Print effective user ID
407 * groups invocation::            Print group names a user is in
408 * users invocation::             Print login names of users currently logged in
409 * who invocation::               Print who is currently logged in
410
411 System context
412
413 * arch invocation::              Print machine hardware name
414 * date invocation::              Print or set system date and time
415 * nproc invocation::             Print the number of processors
416 * uname invocation::             Print system information
417 * hostname invocation::          Print or set system name
418 * hostid invocation::            Print numeric host identifier
419 * uptime invocation::            Print system uptime and load
420
421 @command{date}: Print or set system date and time
422
423 * Time conversion specifiers::   %[HIklMNpPrRsSTXzZ]
424 * Date conversion specifiers::   %[aAbBcCdDeFgGhjmuUVwWxyY]
425 * Literal conversion specifiers:: %[%nt]
426 * Padding and other flags::      Pad with zeros, spaces, etc.
427 * Setting the time::             Changing the system clock
428 * Options for date::             Instead of the current time
429 * Date input formats::           Specifying date strings
430 * Examples of date::             Examples
431
432 SELinux context
433
434 * chcon invocation::             Change SELinux context of file
435 * runcon invocation::            Run a command in specified SELinux context
436
437 Modified command invocation
438
439 * chroot invocation::            Run a command with a different root directory
440 * env invocation::               Run a command in a modified environment
441 * nice invocation::              Run a command with modified niceness
442 * nohup invocation::             Run a command immune to hangups
443 * stdbuf invocation::            Run a command with modified I/O buffering
444 * su invocation::                Run a command with substitute user and group ID
445 * timeout invocation::           Run a command with a time limit
446
447 Process control
448
449 * kill invocation::              Sending a signal to processes.
450
451 Delaying
452
453 * sleep invocation::             Delay for a specified time
454
455 Numeric operations
456
457 * factor invocation::            Print prime factors
458 * seq invocation::               Print numeric sequences
459
460 File permissions
461
462 * Mode Structure::               Structure of file mode bits
463 * Symbolic Modes::               Mnemonic representation of file mode bits
464 * Numeric Modes::                File mode bits as octal numbers
465 * Directory Setuid and Setgid::  Set-user-ID and set-group-ID on directories
466
467 Date input formats
468
469 * General date syntax::          Common rules
470 * Calendar date items::          19 Dec 1994
471 * Time of day items::            9:20pm
472 * Time zone items::              @sc{est}, @sc{pdt}, @sc{gmt}
473 * Day of week items::            Monday and others
474 * Relative items in date strings:: next tuesday, 2 years ago
475 * Pure numbers in date strings:: 19931219, 1440
476 * Seconds since the Epoch::      @@1078100502
477 * Specifying time zone rules::   TZ="America/New_York", TZ="UTC0"
478 * Authors of parse_datetime::    Bellovin, Eggert, Salz, Berets, et al
479
480 Opening the software toolbox
481
482 * Toolbox introduction::         Toolbox introduction
483 * I/O redirection::              I/O redirection
484 * The who command::              The @command{who} command
485 * The cut command::              The @command{cut} command
486 * The sort command::             The @command{sort} command
487 * The uniq command::             The @command{uniq} command
488 * Putting the tools together::   Putting the tools together
489
490 Copying This Manual
491
492 * GNU Free Documentation License::     Copying and sharing this manual
493
494 @end detailmenu
495 @end menu
496
497
498 @node Introduction
499 @chapter Introduction
500
501 This manual is a work in progress: many sections make no attempt to explain
502 basic concepts in a way suitable for novices.  Thus, if you are interested,
503 please get involved in improving this manual.  The entire @sc{gnu} community
504 will benefit.
505
506 @cindex @acronym{POSIX}
507 The @sc{gnu} utilities documented here are mostly compatible with the
508 @acronym{POSIX} standard.
509 @cindex bugs, reporting
510 Please report bugs to @email{bug-coreutils@@gnu.org}.  Remember
511 to include the version number, machine architecture, input files, and
512 any other information needed to reproduce the bug: your input, what you
513 expected, what you got, and why it is wrong.  Diffs are welcome, but
514 please include a description of the problem as well, since this is
515 sometimes difficult to infer.  @xref{Bugs, , , gcc, Using and Porting GNU CC}.
516
517 @cindex Berry, K.
518 @cindex Paterson, R.
519 @cindex Stallman, R.
520 @cindex Pinard, F.
521 @cindex MacKenzie, D.
522 @cindex Meyering, J.
523 @cindex Youmans, B.
524 This manual was originally derived from the Unix man pages in the
525 distributions, which were written by David MacKenzie and updated by Jim
526 Meyering.  What you are reading now is the authoritative documentation
527 for these utilities; the man pages are no longer being maintained.  The
528 original @command{fmt} man page was written by Ross Paterson.  Fran@,{c}ois
529 Pinard did the initial conversion to Texinfo format.  Karl Berry did the
530 indexing, some reorganization, and editing of the results.  Brian
531 Youmans of the Free Software Foundation office staff combined the
532 manuals for textutils, fileutils, and sh-utils to produce the present
533 omnibus manual.  Richard Stallman contributed his usual invaluable
534 insights to the overall process.
535
536 @node Common options
537 @chapter Common options
538
539 @macro optBackup
540 @item -b
541 @itemx @w{@kbd{--backup}[=@var{method}]}
542 @opindex -b
543 @opindex --backup
544 @vindex VERSION_CONTROL
545 @cindex backups, making
546 @xref{Backup options}.
547 Make a backup of each file that would otherwise be overwritten or removed.
548 @end macro
549
550 @macro optBackupSuffix
551 @item -S @var{suffix}
552 @itemx --suffix=@var{suffix}
553 @opindex -S
554 @opindex --suffix
555 Append @var{suffix} to each backup file made with @option{-b}.
556 @xref{Backup options}.
557 @end macro
558
559 @macro optTargetDirectory
560 @item -t @var{directory}
561 @itemx @w{@kbd{--target-directory}=@var{directory}}
562 @opindex -t
563 @opindex --target-directory
564 @cindex target directory
565 @cindex destination directory
566 Specify the destination @var{directory}.
567 @xref{Target directory}.
568 @end macro
569
570 @macro optNoTargetDirectory
571 @item -T
572 @itemx --no-target-directory
573 @opindex -T
574 @opindex --no-target-directory
575 @cindex target directory
576 @cindex destination directory
577 Do not treat the last operand specially when it is a directory or a
578 symbolic link to a directory.  @xref{Target directory}.
579 @end macro
580
581 @macro optNull{cmd}
582 @item -0
583 @opindex -0
584 @itemx --null
585 @opindex --null
586 @cindex output @sc{nul}-byte-terminated lines
587 Output a zero byte (@acronym{ASCII} @sc{nul}) at the end of each line,
588 rather than a newline. This option enables other programs to parse the
589 output of @command{\cmd\} even when that output would contain data
590 with embedded newlines.
591 @end macro
592
593 @macro optSi
594 @itemx --si
595 @opindex --si
596 @cindex SI output
597 Append an SI-style abbreviation to each size, such as @samp{M} for
598 megabytes.  Powers of 1000 are used, not 1024; @samp{M} stands for
599 1,000,000 bytes.  This option is equivalent to
600 @option{--block-size=si}.  Use the @option{-h} or
601 @option{--human-readable} option if
602 you prefer powers of 1024.
603 @end macro
604
605 @macro optHumanReadable
606 @item -h
607 @itemx --human-readable
608 @opindex -h
609 @opindex --human-readable
610 @cindex human-readable output
611 Append a size letter to each size, such as @samp{M} for mebibytes.
612 Powers of 1024 are used, not 1000; @samp{M} stands for 1,048,576 bytes.
613 This option is equivalent to @option{--block-size=human-readable}.
614 Use the @option{--si} option if you prefer powers of 1000.
615 @end macro
616
617 @macro optStripTrailingSlashes
618 @itemx @w{@kbd{--strip-trailing-slashes}}
619 @opindex --strip-trailing-slashes
620 @cindex stripping trailing slashes
621 Remove any trailing slashes from each @var{source} argument.
622 @xref{Trailing slashes}.
623 @end macro
624
625 @macro mayConflictWithShellBuiltIn{cmd}
626 @cindex conflicts with shell built-ins
627 @cindex built-in shell commands, conflicts with
628 Due to shell aliases and built-in @command{\cmd\} functions, using an
629 unadorned @command{\cmd\} interactively or in a script may get you
630 different functionality than that described here.  Invoke it via
631 @command{env} (i.e., @code{env \cmd\ @dots{}}) to avoid interference
632 from the shell.
633
634 @end macro
635
636 @macro multiplierSuffixes{varName}
637 @var{\varName\} may be, or may be an integer optionally followed by,
638 one of the following multiplicative suffixes:
639 @example
640 @samp{b}  =>            512 ("blocks")
641 @samp{KB} =>           1000 (KiloBytes)
642 @samp{K}  =>           1024 (KibiBytes)
643 @samp{MB} =>      1000*1000 (MegaBytes)
644 @samp{M}  =>      1024*1024 (MebiBytes)
645 @samp{GB} => 1000*1000*1000 (GigaBytes)
646 @samp{G}  => 1024*1024*1024 (GibiBytes)
647 @end example
648 and so on for @samp{T}, @samp{P}, @samp{E}, @samp{Z}, and @samp{Y}.
649 @end macro
650
651 @c FIXME: same as above, but no ``blocks'' line.
652 @macro multiplierSuffixesNoBlocks{varName}
653 @var{\varName\} may be, or may be an integer optionally followed by,
654 one of the following multiplicative suffixes:
655 @example
656 @samp{KB} =>           1000 (KiloBytes)
657 @samp{K}  =>           1024 (KibiBytes)
658 @samp{MB} =>      1000*1000 (MegaBytes)
659 @samp{M}  =>      1024*1024 (MebiBytes)
660 @samp{GB} => 1000*1000*1000 (GigaBytes)
661 @samp{G}  => 1024*1024*1024 (GibiBytes)
662 @end example
663 and so on for @samp{T}, @samp{P}, @samp{E}, @samp{Z}, and @samp{Y}.
664 @end macro
665
666 @cindex common options
667
668 Certain options are available in all of these programs.  Rather than
669 writing identical descriptions for each of the programs, they are
670 described here.  (In fact, every @sc{gnu} program accepts (or should accept)
671 these options.)
672
673 @vindex POSIXLY_CORRECT
674 Normally options and operands can appear in any order, and programs act
675 as if all the options appear before any operands.  For example,
676 @samp{sort -r passwd -t :} acts like @samp{sort -r -t : passwd}, since
677 @samp{:} is an option-argument of @option{-t}.  However, if the
678 @env{POSIXLY_CORRECT} environment variable is set, options must appear
679 before operands, unless otherwise specified for a particular command.
680
681 A few programs can usefully have trailing operands with leading
682 @samp{-}.  With such a program, options must precede operands even if
683 @env{POSIXLY_CORRECT} is not set, and this fact is noted in the
684 program description.  For example, the @command{env} command's options
685 must appear before its operands, since in some cases the operands
686 specify a command that itself contains options.
687
688 Most programs that accept long options recognize unambiguous
689 abbreviations of those options.  For example, @samp{rmdir
690 --ignore-fail-on-non-empty} can be invoked as @samp{rmdir
691 --ignore-fail} or even @samp{rmdir --i}.  Ambiguous options, such as
692 @samp{ls --h}, are identified as such.
693
694 Some of these programs recognize the @option{--help} and @option{--version}
695 options only when one of them is the sole command line argument.  For
696 these programs, abbreviations of the long options are not always recognized.
697
698 @table @samp
699
700 @item --help
701 @opindex --help
702 @cindex help, online
703 Print a usage message listing all available options, then exit successfully.
704
705 @item --version
706 @opindex --version
707 @cindex version number, finding
708 Print the version number, then exit successfully.
709
710 @item --
711 @opindex --
712 @cindex option delimiter
713 Delimit the option list.  Later arguments, if any, are treated as
714 operands even if they begin with @samp{-}.  For example, @samp{sort --
715 -r} reads from the file named @file{-r}.
716
717 @end table
718
719 @cindex standard input
720 @cindex standard output
721 A single @samp{-} operand is not really an option, though it looks like one.  It
722 stands for standard input, or for standard output if that is clear from
723 the context.  For example, @samp{sort -} reads from standard input,
724 and is equivalent to plain @samp{sort}, and @samp{tee -} writes an
725 extra copy of its input to standard output.  Unless otherwise
726 specified, @samp{-} can appear as any operand that requires a file
727 name.
728
729 @menu
730 * Exit status::                 Indicating program success or failure.
731 * Backup options::              -b -S, in some programs.
732 * Block size::                  BLOCK_SIZE and --block-size, in some programs.
733 * Floating point::              Floating point number representation.
734 * Signal specifications::       Specifying signals using the --signal option.
735 * Disambiguating names and IDs:: chgrp and chown owner and group syntax
736 * Random sources::              --random-source, in some programs.
737 * Target directory::            Specifying a target directory, in some programs.
738 * Trailing slashes::            --strip-trailing-slashes, in some programs.
739 * Traversing symlinks::         -H, -L, or -P, in some programs.
740 * Treating / specially::        --preserve-root and --no-preserve-root.
741 * Special built-in utilities::  @command{break}, @command{:}, @dots{}
742 * Standards conformance::       Conformance to the @acronym{POSIX} standard.
743 @end menu
744
745
746 @node Exit status
747 @section Exit status
748
749 @macro exitstatus
750 An exit status of zero indicates success,
751 and a nonzero value indicates failure.
752 @end macro
753
754 Nearly every command invocation yields an integral @dfn{exit status}
755 that can be used to change how other commands work.
756 For the vast majority of commands, an exit status of zero indicates
757 success.  Failure is indicated by a nonzero value---typically
758 @samp{1}, though it may differ on unusual platforms as @acronym{POSIX}
759 requires only that it be nonzero.
760
761 However, some of the programs documented here do produce
762 other exit status values and a few associate different
763 meanings with the values @samp{0} and @samp{1}.
764 Here are some of the exceptions:
765 @command{chroot}, @command{env}, @command{expr}, @command{nice},
766 @command{nohup}, @command{printenv}, @command{sort}, @command{stdbuf},
767 @command{su}, @command{test}, @command{timeout}, @command{tty}.
768
769
770 @node Backup options
771 @section Backup options
772
773 @cindex backup options
774
775 Some @sc{gnu} programs (at least @command{cp}, @command{install},
776 @command{ln}, and @command{mv}) optionally make backups of files
777 before writing new versions.
778 These options control the details of these backups.  The options are also
779 briefly mentioned in the descriptions of the particular programs.
780
781 @table @samp
782
783 @item -b
784 @itemx @w{@kbd{--backup}[=@var{method}]}
785 @opindex -b
786 @opindex --backup
787 @vindex VERSION_CONTROL
788 @cindex backups, making
789 Make a backup of each file that would otherwise be overwritten or removed.
790 Without this option, the original versions are destroyed.
791 Use @var{method} to determine the type of backups to make.
792 When this option is used but @var{method} is not specified,
793 then the value of the @env{VERSION_CONTROL}
794 environment variable is used.  And if @env{VERSION_CONTROL} is not set,
795 the default backup type is @samp{existing}.
796
797 Note that the short form of this option, @option{-b} does not accept any
798 argument.  Using @option{-b} is equivalent to using @option{--backup=existing}.
799
800 @vindex version-control @r{Emacs variable}
801 This option corresponds to the Emacs variable @samp{version-control};
802 the values for @var{method} are the same as those used in Emacs.
803 This option also accepts more descriptive names.
804 The valid @var{method}s are (unique abbreviations are accepted):
805
806 @table @samp
807 @item none
808 @itemx off
809 @opindex none @r{backup method}
810 Never make backups.
811
812 @item numbered
813 @itemx t
814 @opindex numbered @r{backup method}
815 Always make numbered backups.
816
817 @item existing
818 @itemx nil
819 @opindex existing @r{backup method}
820 Make numbered backups of files that already have them, simple backups
821 of the others.
822
823 @item simple
824 @itemx never
825 @opindex simple @r{backup method}
826 Always make simple backups.  Please note @samp{never} is not to be
827 confused with @samp{none}.
828
829 @end table
830
831 @item -S @var{suffix}
832 @itemx --suffix=@var{suffix}
833 @opindex -S
834 @opindex --suffix
835 @cindex backup suffix
836 @vindex SIMPLE_BACKUP_SUFFIX
837 Append @var{suffix} to each backup file made with @option{-b}.  If this
838 option is not specified, the value of the @env{SIMPLE_BACKUP_SUFFIX}
839 environment variable is used.  And if @env{SIMPLE_BACKUP_SUFFIX} is not
840 set, the default is @samp{~}, just as in Emacs.
841
842 @end table
843
844 @node Block size
845 @section Block size
846
847 @cindex block size
848
849 Some @sc{gnu} programs (at least @command{df}, @command{du}, and
850 @command{ls}) display sizes in ``blocks''.  You can adjust the block size
851 and method of display to make sizes easier to read.  The block size
852 used for display is independent of any file system block size.
853 Fractional block counts are rounded up to the nearest integer.
854
855 @opindex --block-size=@var{size}
856 @vindex BLOCKSIZE
857 @vindex BLOCK_SIZE
858 @vindex DF_BLOCK_SIZE
859 @vindex DU_BLOCK_SIZE
860 @vindex LS_BLOCK_SIZE
861 @vindex POSIXLY_CORRECT@r{, and block size}
862
863 The default block size is chosen by examining the following environment
864 variables in turn; the first one that is set determines the block size.
865
866 @table @code
867
868 @item DF_BLOCK_SIZE
869 This specifies the default block size for the @command{df} command.
870 Similarly, @env{DU_BLOCK_SIZE} specifies the default for @command{du} and
871 @env{LS_BLOCK_SIZE} for @command{ls}.
872
873 @item BLOCK_SIZE
874 This specifies the default block size for all three commands, if the
875 above command-specific environment variables are not set.
876
877 @item BLOCKSIZE
878 This specifies the default block size for all values that are normally
879 printed as blocks, if neither @env{BLOCK_SIZE} nor the above
880 command-specific environment variables are set.  Unlike the other
881 environment variables, @env{BLOCKSIZE} does not affect values that are
882 normally printed as byte counts, e.g., the file sizes contained in
883 @code{ls -l} output.
884
885 @item POSIXLY_CORRECT
886 If neither @env{@var{command}_BLOCK_SIZE}, nor @env{BLOCK_SIZE}, nor
887 @env{BLOCKSIZE} is set, but this variable is set, the block size
888 defaults to 512.
889
890 @end table
891
892 If none of the above environment variables are set, the block size
893 currently defaults to 1024 bytes in most contexts, but this number may
894 change in the future.  For @command{ls} file sizes, the block size
895 defaults to 1 byte.
896
897 @cindex human-readable output
898 @cindex SI output
899
900 A block size specification can be a positive integer specifying the number
901 of bytes per block, or it can be @code{human-readable} or @code{si} to
902 select a human-readable format.  Integers may be followed by suffixes
903 that are upward compatible with the
904 @uref{http://www.bipm.fr/enus/3_SI/si-prefixes.html, SI prefixes}
905 for decimal multiples and with the
906 @uref{http://physics.nist.gov/cuu/Units/binary.html, IEC 60027-2
907 prefixes for binary multiples}.
908
909 With human-readable formats, output sizes are followed by a size letter
910 such as @samp{M} for megabytes.  @code{BLOCK_SIZE=human-readable} uses
911 powers of 1024; @samp{M} stands for 1,048,576 bytes.
912 @code{BLOCK_SIZE=si} is similar, but uses powers of 1000 and appends
913 @samp{B}; @samp{MB} stands for 1,000,000 bytes.
914
915 @vindex LC_NUMERIC
916 A block size specification preceded by @samp{'} causes output sizes to
917 be displayed with thousands separators.  The @env{LC_NUMERIC} locale
918 specifies the thousands separator and grouping.  For example, in an
919 American English locale, @samp{--block-size="'1kB"} would cause a size
920 of 1234000 bytes to be displayed as @samp{1,234}.  In the default C
921 locale, there is no thousands separator so a leading @samp{'} has no
922 effect.
923
924 An integer block size can be followed by a suffix to specify a
925 multiple of that size.  A bare size letter,
926 or one followed by @samp{iB}, specifies
927 a multiple using powers of 1024.  A size letter followed by @samp{B}
928 specifies powers of 1000 instead.  For example, @samp{1M} and
929 @samp{1MiB} are equivalent to @samp{1048576}, whereas @samp{1MB} is
930 equivalent to @samp{1000000}.
931
932 A plain suffix without a preceding integer acts as if @samp{1} were
933 prepended, except that it causes a size indication to be appended to
934 the output.  For example, @samp{--block-size="kB"} displays 3000 as
935 @samp{3kB}.
936
937 The following suffixes are defined.  Large sizes like @code{1Y}
938 may be rejected by your computer due to limitations of its arithmetic.
939
940 @table @samp
941 @item kB
942 @cindex kilobyte, definition of
943 kilobyte: @math{10^3 = 1000}.
944 @item k
945 @itemx K
946 @itemx KiB
947 @cindex kibibyte, definition of
948 kibibyte: @math{2^{10} = 1024}.  @samp{K} is special: the SI prefix is
949 @samp{k} and the IEC 60027-2 prefix is @samp{Ki}, but tradition and
950 @acronym{POSIX} use @samp{k} to mean @samp{KiB}.
951 @item MB
952 @cindex megabyte, definition of
953 megabyte: @math{10^6 = 1,000,000}.
954 @item M
955 @itemx MiB
956 @cindex mebibyte, definition of
957 mebibyte: @math{2^{20} = 1,048,576}.
958 @item GB
959 @cindex gigabyte, definition of
960 gigabyte: @math{10^9 = 1,000,000,000}.
961 @item G
962 @itemx GiB
963 @cindex gibibyte, definition of
964 gibibyte: @math{2^{30} = 1,073,741,824}.
965 @item TB
966 @cindex terabyte, definition of
967 terabyte:  @math{10^{12} = 1,000,000,000,000}.
968 @item T
969 @itemx TiB
970 @cindex tebibyte, definition of
971 tebibyte: @math{2^{40} = 1,099,511,627,776}.
972 @item PB
973 @cindex petabyte, definition of
974 petabyte: @math{10^{15} = 1,000,000,000,000,000}.
975 @item P
976 @itemx PiB
977 @cindex pebibyte, definition of
978 pebibyte: @math{2^{50} = 1,125,899,906,842,624}.
979 @item EB
980 @cindex exabyte, definition of
981 exabyte: @math{10^{18} = 1,000,000,000,000,000,000}.
982 @item E
983 @itemx EiB
984 @cindex exbibyte, definition of
985 exbibyte: @math{2^{60} = 1,152,921,504,606,846,976}.
986 @item ZB
987 @cindex zettabyte, definition of
988 zettabyte: @math{10^{21} = 1,000,000,000,000,000,000,000}
989 @item Z
990 @itemx ZiB
991 @math{2^{70} = 1,180,591,620,717,411,303,424}.
992 (@samp{Zi} is a @acronym{GNU} extension to IEC 60027-2.)
993 @item YB
994 @cindex yottabyte, definition of
995 yottabyte: @math{10^{24} = 1,000,000,000,000,000,000,000,000}.
996 @item Y
997 @itemx YiB
998 @math{2^{80} = 1,208,925,819,614,629,174,706,176}.
999 (@samp{Yi} is a @acronym{GNU} extension to IEC 60027-2.)
1000 @end table
1001
1002 @opindex -k
1003 @opindex -h
1004 @opindex --block-size
1005 @opindex --human-readable
1006 @opindex --si
1007
1008 Block size defaults can be overridden by an explicit
1009 @option{--block-size=@var{size}} option.  The @option{-k}
1010 option is equivalent to @option{--block-size=1K}, which
1011 is the default unless the @env{POSIXLY_CORRECT} environment variable is
1012 set.  The @option{-h} or @option{--human-readable} option is equivalent to
1013 @option{--block-size=human-readable}.  The @option{--si} option is
1014 equivalent to @option{--block-size=si}.
1015
1016 @node Floating point
1017 @section Floating point numbers
1018 @cindex floating point
1019 @cindex IEEE floating point
1020
1021 Commands that accept or produce floating point numbers employ the
1022 floating point representation of the underlying system, and suffer
1023 from rounding error, overflow, and similar floating-point issues.
1024 Almost all modern systems use IEEE-754 floating point, and it is
1025 typically portable to assume IEEE-754 behavior these days.  IEEE-754
1026 has positive and negative infinity, distinguishes positive from
1027 negative zero, and uses special values called NaNs to represent
1028 invalid computations such as dividing zero by itself.  For more
1029 information, please see David Goldberg's paper
1030 @uref{http://@/www.validlab.com/@/goldberg/@/paper.pdf, What Every
1031 Computer Scientist Should Know About Floating-Point Arithmetic}.
1032
1033 @vindex LC_NUMERIC
1034 Commands that accept floating point numbers as options, operands or
1035 input use the standard C functions @code{strtod} and @code{strtold} to
1036 convert from text to floating point numbers.  These floating point
1037 numbers therefore can use scientific notation like @code{1.0e-34} and
1038 @code{-10e100}.  Modern C implementations also accept hexadecimal
1039 floating point numbers such as @code{-0x.ep-3}, which stands for
1040 @minus{}14/16 times @math{2^-3}, which equals @minus{}0.109375.  The
1041 @env{LC_NUMERIC} locale determines the decimal-point character.
1042 @xref{Parsing of Floats,,, libc, The GNU C Library Reference Manual}.
1043
1044 @node Signal specifications
1045 @section Signal specifications
1046 @cindex signals, specifying
1047
1048 A @var{signal} may be a signal name like @samp{HUP}, or a signal
1049 number like @samp{1}, or an exit status of a process terminated by the
1050 signal.  A signal name can be given in canonical form or prefixed by
1051 @samp{SIG}.  The case of the letters is ignored. The following signal names
1052 and numbers are supported on all @acronym{POSIX} compliant systems:
1053
1054 @table @samp
1055 @item HUP
1056 1.  Hangup.
1057 @item INT
1058 2.  Terminal interrupt.
1059 @item QUIT
1060 3.  Terminal quit.
1061 @item ABRT
1062 6.  Process abort.
1063 @item KILL
1064 9.  Kill (cannot be caught or ignored).
1065 @item ALRM
1066 14.  Alarm Clock.
1067 @item TERM
1068 15.  Termination.
1069 @end table
1070
1071 @noindent
1072 Other supported signal names have system-dependent corresponding
1073 numbers.  All systems conforming to @acronym{POSIX} 1003.1-2001 also
1074 support the following signals:
1075
1076 @table @samp
1077 @item BUS
1078 Access to an undefined portion of a memory object.
1079 @item CHLD
1080 Child process terminated, stopped, or continued.
1081 @item CONT
1082 Continue executing, if stopped.
1083 @item FPE
1084 Erroneous arithmetic operation.
1085 @item ILL
1086 Illegal Instruction.
1087 @item PIPE
1088 Write on a pipe with no one to read it.
1089 @item SEGV
1090 Invalid memory reference.
1091 @item STOP
1092 Stop executing (cannot be caught or ignored).
1093 @item TSTP
1094 Terminal stop.
1095 @item TTIN
1096 Background process attempting read.
1097 @item TTOU
1098 Background process attempting write.
1099 @item URG
1100 High bandwidth data is available at a socket.
1101 @item USR1
1102 User-defined signal 1.
1103 @item USR2
1104 User-defined signal 2.
1105 @end table
1106
1107 @noindent
1108 @acronym{POSIX} 1003.1-2001 systems that support the @acronym{XSI} extension
1109 also support the following signals:
1110
1111 @table @samp
1112 @item POLL
1113 Pollable event.
1114 @item PROF
1115 Profiling timer expired.
1116 @item SYS
1117 Bad system call.
1118 @item TRAP
1119 Trace/breakpoint trap.
1120 @item VTALRM
1121 Virtual timer expired.
1122 @item XCPU
1123 CPU time limit exceeded.
1124 @item XFSZ
1125 File size limit exceeded.
1126 @end table
1127
1128 @noindent
1129 @acronym{POSIX} 1003.1-2001 systems that support the @acronym{XRT} extension
1130 also support at least eight real-time signals called @samp{RTMIN},
1131 @samp{RTMIN+1}, @dots{}, @samp{RTMAX-1}, @samp{RTMAX}.
1132
1133 @node Disambiguating names and IDs
1134 @section chown and chgrp: Disambiguating user names and IDs
1135 @cindex user names, disambiguating
1136 @cindex user IDs, disambiguating
1137 @cindex group names, disambiguating
1138 @cindex group IDs, disambiguating
1139 @cindex disambiguating group names and IDs
1140
1141 Since the @var{owner} and @var{group} arguments to @command{chown} and
1142 @command{chgrp} may be specified as names or numeric IDs, there is an
1143 apparent ambiguity.
1144 What if a user or group @emph{name} is a string of digits?
1145 @footnote{Using a number as a user name is common in some environments.}
1146 Should the command interpret it as a user name or as an ID?
1147 @acronym{POSIX} requires that @command{chown} and @command{chgrp}
1148 first attempt to resolve the specified string as a name, and
1149 only once that fails, then try to interpret it as an ID.
1150 This is troublesome when you want to specify a numeric ID, say 42,
1151 and it must work even in a pathological situation where
1152 @samp{42} is a user name that maps to some other user ID, say 1000.
1153 Simply invoking @code{chown 42 F}, will set @file{F}s owner ID to
1154 1000---not what you intended.
1155
1156 GNU @command{chown} and @command{chgrp} provide a way to work around this,
1157 that at the same time may result in a significant performance improvement
1158 by eliminating a database look-up.
1159 Simply precede each numeric user ID and/or group ID with a @samp{+},
1160 in order to force its interpretation as an integer:
1161
1162 @example
1163 chown +42 F
1164 chgrp +$numeric_group_id another-file
1165 chown +0:+0 /
1166 @end example
1167
1168 GNU @command{chown} and @command{chgrp}
1169 skip the name look-up process for each @samp{+}-prefixed string,
1170 because a string containing @samp{+} is never a valid user or group name.
1171 This syntax is accepted on most common Unix systems, but not on Solaris 10.
1172
1173 @node Random sources
1174 @section Sources of random data
1175
1176 @cindex random sources
1177
1178 The @command{shuf}, @command{shred}, and @command{sort} commands
1179 sometimes need random data to do their work.  For example, @samp{sort
1180 -R} must choose a hash function at random, and it needs random data to
1181 make this selection.
1182
1183 By default these commands use an internal pseudorandom generator
1184 initialized by a small amount of entropy, but can be directed to use
1185 an external source with the @option{--random-source=@var{file}} option.
1186 An error is reported if @var{file} does not contain enough bytes.
1187
1188 For example, the device file @file{/dev/urandom} could be used as the
1189 source of random data.  Typically, this device gathers environmental
1190 noise from device drivers and other sources into an entropy pool, and
1191 uses the pool to generate random bits.  If the pool is short of data,
1192 the device reuses the internal pool to produce more bits, using a
1193 cryptographically secure pseudorandom number generator.  But be aware
1194 that this device is not designed for bulk random data generation
1195 and is relatively slow.
1196
1197 @file{/dev/urandom} suffices for most practical uses, but applications
1198 requiring high-value or long-term protection of private data may
1199 require an alternate data source like @file{/dev/random} or
1200 @file{/dev/arandom}.  The set of available sources depends on your
1201 operating system.
1202
1203 To reproduce the results of an earlier invocation of a command, you
1204 can save some random data into a file and then use that file as the
1205 random source in earlier and later invocations of the command.
1206
1207 @node Target directory
1208 @section Target directory
1209
1210 @cindex target directory
1211
1212 The @command{cp}, @command{install}, @command{ln}, and @command{mv}
1213 commands normally treat the last operand specially when it is a
1214 directory or a symbolic link to a directory.  For example, @samp{cp
1215 source dest} is equivalent to @samp{cp source dest/source} if
1216 @file{dest} is a directory.  Sometimes this behavior is not exactly
1217 what is wanted, so these commands support the following options to
1218 allow more fine-grained control:
1219
1220 @table @samp
1221
1222 @item -T
1223 @itemx --no-target-directory
1224 @opindex --no-target-directory
1225 @cindex target directory
1226 @cindex destination directory
1227 Do not treat the last operand specially when it is a directory or a
1228 symbolic link to a directory.  This can help avoid race conditions in
1229 programs that operate in a shared area.  For example, when the command
1230 @samp{mv /tmp/source /tmp/dest} succeeds, there is no guarantee that
1231 @file{/tmp/source} was renamed to @file{/tmp/dest}: it could have been
1232 renamed to @file{/tmp/dest/source} instead, if some other process
1233 created @file{/tmp/dest} as a directory.  However, if @file{mv
1234 -T /tmp/source /tmp/dest} succeeds, there is no
1235 question that @file{/tmp/source} was renamed to @file{/tmp/dest}.
1236
1237 In the opposite situation, where you want the last operand to be
1238 treated as a directory and want a diagnostic otherwise, you can use
1239 the @option{--target-directory} (@option{-t}) option.
1240
1241 @item -t @var{directory}
1242 @itemx @w{@kbd{--target-directory}=@var{directory}}
1243 @opindex --target-directory
1244 @cindex target directory
1245 @cindex destination directory
1246 Use @var{directory} as the directory component of each destination
1247 file name.
1248
1249 The interface for most programs is that after processing options and a
1250 finite (possibly zero) number of fixed-position arguments, the remaining
1251 argument list is either expected to be empty, or is a list of items
1252 (usually files) that will all be handled identically.  The @command{xargs}
1253 program is designed to work well with this convention.
1254
1255 The commands in the @command{mv}-family are unusual in that they take
1256 a variable number of arguments with a special case at the @emph{end}
1257 (namely, the target directory).  This makes it nontrivial to perform some
1258 operations, e.g., ``move all files from here to ../d/'', because
1259 @code{mv * ../d/} might exhaust the argument space, and @code{ls | xargs ...}
1260 doesn't have a clean way to specify an extra final argument for each
1261 invocation of the subject command.  (It can be done by going through a
1262 shell command, but that requires more human labor and brain power than
1263 it should.)
1264
1265 The @w{@kbd{--target-directory}} (@option{-t}) option allows the @command{cp},
1266 @command{install}, @command{ln}, and @command{mv} programs to be used
1267 conveniently with @command{xargs}.  For example, you can move the files
1268 from the current directory to a sibling directory, @code{d} like this:
1269
1270 @smallexample
1271 ls | xargs mv -t ../d --
1272 @end smallexample
1273
1274 However, this doesn't move files whose names begin with @samp{.}.
1275 If you use the @sc{gnu} @command{find} program, you can move those
1276 files too, with this command:
1277
1278 @example
1279 find . -mindepth 1 -maxdepth 1 \
1280   | xargs mv -t ../d
1281 @end example
1282
1283 But both of the above approaches fail if there are no files in the
1284 current directory, or if any file has a name containing a blank or
1285 some other special characters.
1286 The following example removes those limitations and requires both
1287 @sc{gnu} @command{find} and @sc{gnu} @command{xargs}:
1288
1289 @example
1290 find . -mindepth 1 -maxdepth 1 -print0 \
1291   | xargs --null --no-run-if-empty \
1292       mv -t ../d
1293 @end example
1294
1295 @end table
1296
1297 @noindent
1298 The @option{--target-directory} (@option{-t}) and
1299 @option{--no-target-directory} (@option{-T})
1300 options cannot be combined.
1301
1302 @node Trailing slashes
1303 @section Trailing slashes
1304
1305 @cindex trailing slashes
1306
1307 Some @sc{gnu} programs (at least @command{cp} and @command{mv}) allow you to
1308 remove any trailing slashes from each @var{source} argument before
1309 operating on it.  The @w{@kbd{--strip-trailing-slashes}} option enables
1310 this behavior.
1311
1312 This is useful when a @var{source} argument may have a trailing slash and
1313 @c FIXME: mv's behavior in this case is system-dependent
1314 specify a symbolic link to a directory.  This scenario is in fact rather
1315 common because some shells can automatically append a trailing slash when
1316 performing file name completion on such symbolic links.  Without this
1317 option, @command{mv}, for example, (via the system's rename function) must
1318 interpret a trailing slash as a request to dereference the symbolic link
1319 and so must rename the indirectly referenced @emph{directory} and not
1320 the symbolic link.  Although it may seem surprising that such behavior
1321 be the default, it is required by @acronym{POSIX} and is consistent with
1322 other parts of that standard.
1323
1324 @node Traversing symlinks
1325 @section Traversing symlinks
1326
1327 @cindex symbolic link to directory, controlling traversal of
1328
1329 The following options modify how @command{chown} and @command{chgrp}
1330 @c FIXME: note that `du' has these options, too, but they have slightly
1331 @c different meaning.
1332 traverse a hierarchy when the @option{--recursive} (@option{-R})
1333 option is also specified.
1334 If more than one of the following options is specified, only the final
1335 one takes effect.
1336 These options specify whether processing a symbolic link to a directory
1337 entails operating on just the symbolic link or on all files in the
1338 hierarchy rooted at that directory.
1339
1340 These options are independent of @option{--dereference} and
1341 @option{--no-dereference} (@option{-h}), which control whether to modify
1342 a symlink or its referent.
1343
1344 @table @samp
1345
1346 @macro choptH
1347 @item -H
1348 @opindex -H
1349 @cindex symbolic link to directory, traverse if on the command line
1350 If @option{--recursive} (@option{-R}) is specified and
1351 a command line argument is a symbolic link to a directory, traverse it.
1352 @end macro
1353 @choptH
1354
1355 @macro choptL
1356 @item -L
1357 @opindex -L
1358 @cindex symbolic link to directory, traverse each that is encountered
1359 In a recursive traversal, traverse every symbolic link to a directory
1360 that is encountered.
1361 @end macro
1362 @choptL
1363
1364 @macro choptP
1365 @item -P
1366 @opindex -P
1367 @cindex symbolic link to directory, never traverse
1368 Do not traverse any symbolic links.
1369 This is the default if none of @option{-H}, @option{-L},
1370 or @option{-P} is specified.
1371 @end macro
1372 @choptP
1373
1374 @end table
1375
1376
1377 @node Treating / specially
1378 @section Treating @file{/} specially
1379
1380 Certain commands can operate destructively on entire hierarchies.
1381 For example, if a user with appropriate privileges mistakenly runs
1382 @samp{rm -rf / tmp/junk}, that may remove
1383 all files on the entire system.  Since there are so few
1384 legitimate uses for such a command,
1385 @sc{gnu} @command{rm} normally declines to operate on any directory
1386 that resolves to @file{/}.  If you really want to try to remove all
1387 the files on your system, you can use the @option{--no-preserve-root}
1388 option, but the default behavior, specified by the
1389 @option{--preserve-option}, is safer for most purposes.
1390
1391 The commands @command{chgrp}, @command{chmod} and @command{chown}
1392 can also operate destructively on entire hierarchies, so they too
1393 support these options.  Although, unlike @command{rm}, they don't
1394 actually unlink files, these commands are arguably more dangerous
1395 when operating recursively on @file{/}, since they often work much
1396 more quickly, and hence damage more files before an alert user can
1397 interrupt them.  Tradition and @acronym{POSIX} require these commands
1398 to operate recursively on @file{/}, so they default to
1399 @option{--no-preserve-root}, but using the @option{--preserve-root}
1400 option makes them safer for most purposes.  For convenience you can
1401 specify @option{--preserve-root} in an alias or in a shell function.
1402
1403 Note that the @option{--preserve-root} option also ensures
1404 that @command{chgrp} and @command{chown} do not modify @file{/}
1405 even when dereferencing a symlink pointing to @file{/}.
1406
1407 @node Special built-in utilities
1408 @section Special built-in utilities
1409
1410 Some programs like @command{nice} can invoke other programs; for
1411 example, the command @samp{nice cat file} invokes the program
1412 @command{cat} by executing the command @samp{cat file}.  However,
1413 @dfn{special built-in utilities} like @command{exit} cannot be invoked
1414 this way.  For example, the command @samp{nice exit} does not have a
1415 well-defined behavior: it may generate an error message instead of
1416 exiting.
1417
1418 Here is a list of the special built-in utilities that are standardized
1419 by @acronym{POSIX} 1003.1-2004.
1420
1421 @quotation
1422 @t{.@: : break continue eval exec exit export readonly
1423 return set shift times trap unset}
1424 @end quotation
1425
1426 For example, because @samp{.}, @samp{:}, and @samp{exec} are special,
1427 the commands @samp{nice . foo.sh}, @samp{nice :}, and @samp{nice exec
1428 pwd} do not work as you might expect.
1429
1430 Many shells extend this list.  For example, Bash has several extra
1431 special built-in utilities like @command{history}, and
1432 @command{suspend}, and with Bash the command @samp{nice suspend}
1433 generates an error message instead of suspending.
1434
1435 @node Standards conformance
1436 @section Standards conformance
1437
1438 @vindex POSIXLY_CORRECT
1439 In a few cases, the @sc{gnu} utilities' default behavior is
1440 incompatible with the @acronym{POSIX} standard.  To suppress these
1441 incompatibilities, define the @env{POSIXLY_CORRECT} environment
1442 variable.  Unless you are checking for @acronym{POSIX} conformance, you
1443 probably do not need to define @env{POSIXLY_CORRECT}.
1444
1445 Newer versions of @acronym{POSIX} are occasionally incompatible with older
1446 versions.  For example, older versions of @acronym{POSIX} required the
1447 command @samp{sort +1} to sort based on the second and succeeding
1448 fields in each input line, but starting with @acronym{POSIX} 1003.1-2001
1449 the same command is required to sort the file named @file{+1}, and you
1450 must instead use the command @samp{sort -k 2} to get the field-based
1451 sort.
1452
1453 @vindex _POSIX2_VERSION
1454 The @sc{gnu} utilities normally conform to the version of @acronym{POSIX}
1455 that is standard for your system.  To cause them to conform to a
1456 different version of @acronym{POSIX}, define the @env{_POSIX2_VERSION}
1457 environment variable to a value of the form @var{yyyymm} specifying
1458 the year and month the standard was adopted.  Three values are currently
1459 supported for @env{_POSIX2_VERSION}: @samp{199209} stands for
1460 @acronym{POSIX} 1003.2-1992, @samp{200112} stands for @acronym{POSIX}
1461 1003.1-2001, and @samp{200809} stands for @acronym{POSIX} 1003.1-2008.
1462 For example, if you have a newer system but are running software
1463 that assumes an older version of @acronym{POSIX} and uses @samp{sort +1}
1464 or @samp{tail +10}, you can work around any compatibility problems by setting
1465 @samp{_POSIX2_VERSION=199209} in your environment.
1466
1467 @node Output of entire files
1468 @chapter Output of entire files
1469
1470 @cindex output of entire files
1471 @cindex entire files, output of
1472
1473 These commands read and write entire files, possibly transforming them
1474 in some way.
1475
1476 @menu
1477 * cat invocation::              Concatenate and write files.
1478 * tac invocation::              Concatenate and write files in reverse.
1479 * nl invocation::               Number lines and write files.
1480 * od invocation::               Write files in octal or other formats.
1481 * base64 invocation::           Transform data into printable data.
1482 @end menu
1483
1484 @node cat invocation
1485 @section @command{cat}: Concatenate and write files
1486
1487 @pindex cat
1488 @cindex concatenate and write files
1489 @cindex copying files
1490
1491 @command{cat} copies each @var{file} (@samp{-} means standard input), or
1492 standard input if none are given, to standard output.  Synopsis:
1493
1494 @example
1495 cat [@var{option}] [@var{file}]@dots{}
1496 @end example
1497
1498 The program accepts the following options.  Also see @ref{Common options}.
1499
1500 @table @samp
1501
1502 @item -A
1503 @itemx --show-all
1504 @opindex -A
1505 @opindex --show-all
1506 Equivalent to @option{-vET}.
1507
1508 @item -b
1509 @itemx --number-nonblank
1510 @opindex -b
1511 @opindex --number-nonblank
1512 Number all nonempty output lines, starting with 1.
1513
1514 @item -e
1515 @opindex -e
1516 Equivalent to @option{-vE}.
1517
1518 @item -E
1519 @itemx --show-ends
1520 @opindex -E
1521 @opindex --show-ends
1522 Display a @samp{$} after the end of each line.
1523
1524 @item -n
1525 @itemx --number
1526 @opindex -n
1527 @opindex --number
1528 Number all output lines, starting with 1.  This option is ignored
1529 if @option{-b} is in effect.
1530
1531 @item -s
1532 @itemx --squeeze-blank
1533 @opindex -s
1534 @opindex --squeeze-blank
1535 @cindex squeezing empty lines
1536 Suppress repeated adjacent empty lines; output just one empty line
1537 instead of several.
1538
1539 @item -t
1540 @opindex -t
1541 Equivalent to @option{-vT}.
1542
1543 @item -T
1544 @itemx --show-tabs
1545 @opindex -T
1546 @opindex --show-tabs
1547 Display TAB characters as @samp{^I}.
1548
1549 @item -u
1550 @opindex -u
1551 Ignored; for @acronym{POSIX} compatibility.
1552
1553 @item -v
1554 @itemx --show-nonprinting
1555 @opindex -v
1556 @opindex --show-nonprinting
1557 Display control characters except for LFD and TAB using
1558 @samp{^} notation and precede characters that have the high bit set with
1559 @samp{M-}.
1560
1561 @end table
1562
1563 On systems like MS-DOS that distinguish between text and binary files,
1564 @command{cat} normally reads and writes in binary mode.  However,
1565 @command{cat} reads in text mode if one of the options
1566 @option{-bensAE} is used or if @command{cat} is reading from standard
1567 input and standard input is a terminal.  Similarly, @command{cat}
1568 writes in text mode if one of the options @option{-bensAE} is used or
1569 if standard output is a terminal.
1570
1571 @exitstatus
1572
1573 Examples:
1574
1575 @smallexample
1576 # Output f's contents, then standard input, then g's contents.
1577 cat f - g
1578
1579 # Copy standard input to standard output.
1580 cat
1581 @end smallexample
1582
1583
1584 @node tac invocation
1585 @section @command{tac}: Concatenate and write files in reverse
1586
1587 @pindex tac
1588 @cindex reversing files
1589
1590 @command{tac} copies each @var{file} (@samp{-} means standard input), or
1591 standard input if none are given, to standard output, reversing the
1592 records (lines by default) in each separately.  Synopsis:
1593
1594 @example
1595 tac [@var{option}]@dots{} [@var{file}]@dots{}
1596 @end example
1597
1598 @dfn{Records} are separated by instances of a string (newline by
1599 default).  By default, this separator string is attached to the end of
1600 the record that it follows in the file.
1601
1602 The program accepts the following options.  Also see @ref{Common options}.
1603
1604 @table @samp
1605
1606 @item -b
1607 @itemx --before
1608 @opindex -b
1609 @opindex --before
1610 The separator is attached to the beginning of the record that it
1611 precedes in the file.
1612
1613 @item -r
1614 @itemx --regex
1615 @opindex -r
1616 @opindex --regex
1617 Treat the separator string as a regular expression.  Users of @command{tac}
1618 on MS-DOS/MS-Windows should note that, since @command{tac} reads files in
1619 binary mode, each line of a text file might end with a CR/LF pair
1620 instead of the Unix-style LF.
1621
1622 @item -s @var{separator}
1623 @itemx --separator=@var{separator}
1624 @opindex -s
1625 @opindex --separator
1626 Use @var{separator} as the record separator, instead of newline.
1627
1628 @end table
1629
1630 @exitstatus
1631
1632
1633 @node nl invocation
1634 @section @command{nl}: Number lines and write files
1635
1636 @pindex nl
1637 @cindex numbering lines
1638 @cindex line numbering
1639
1640 @command{nl} writes each @var{file} (@samp{-} means standard input), or
1641 standard input if none are given, to standard output, with line numbers
1642 added to some or all of the lines.  Synopsis:
1643
1644 @example
1645 nl [@var{option}]@dots{} [@var{file}]@dots{}
1646 @end example
1647
1648 @cindex logical pages, numbering on
1649 @command{nl} decomposes its input into (logical) pages; by default, the
1650 line number is reset to 1 at the top of each logical page.  @command{nl}
1651 treats all of the input files as a single document; it does not reset
1652 line numbers or logical pages between files.
1653
1654 @cindex headers, numbering
1655 @cindex body, numbering
1656 @cindex footers, numbering
1657 A logical page consists of three sections: header, body, and footer.
1658 Any of the sections can be empty.  Each can be numbered in a different
1659 style from the others.
1660
1661 The beginnings of the sections of logical pages are indicated in the
1662 input file by a line containing exactly one of these delimiter strings:
1663
1664 @table @samp
1665 @item \:\:\:
1666 start of header;
1667 @item \:\:
1668 start of body;
1669 @item \:
1670 start of footer.
1671 @end table
1672
1673 The two characters from which these strings are made can be changed from
1674 @samp{\} and @samp{:} via options (see below), but the pattern and
1675 length of each string cannot be changed.
1676
1677 A section delimiter is replaced by an empty line on output.  Any text
1678 that comes before the first section delimiter string in the input file
1679 is considered to be part of a body section, so @command{nl} treats a
1680 file that contains no section delimiters as a single body section.
1681
1682 The program accepts the following options.  Also see @ref{Common options}.
1683
1684 @table @samp
1685
1686 @item -b @var{style}
1687 @itemx --body-numbering=@var{style}
1688 @opindex -b
1689 @opindex --body-numbering
1690 Select the numbering style for lines in the body section of each
1691 logical page.  When a line is not numbered, the current line number
1692 is not incremented, but the line number separator character is still
1693 prepended to the line.  The styles are:
1694
1695 @table @samp
1696 @item a
1697 number all lines,
1698 @item t
1699 number only nonempty lines (default for body),
1700 @item n
1701 do not number lines (default for header and footer),
1702 @item p@var{bre}
1703 number only lines that contain a match for the basic regular
1704 expression @var{bre}.
1705 @xref{Regular Expressions, , Regular Expressions, grep, The GNU Grep Manual}.
1706 @end table
1707
1708 @item -d @var{cd}
1709 @itemx --section-delimiter=@var{cd}
1710 @opindex -d
1711 @opindex --section-delimiter
1712 @cindex section delimiters of pages
1713 Set the section delimiter characters to @var{cd}; default is
1714 @samp{\:}.  If only @var{c} is given, the second remains @samp{:}.
1715 (Remember to protect @samp{\} or other metacharacters from shell
1716 expansion with quotes or extra backslashes.)
1717
1718 @item -f @var{style}
1719 @itemx --footer-numbering=@var{style}
1720 @opindex -f
1721 @opindex --footer-numbering
1722 Analogous to @option{--body-numbering}.
1723
1724 @item -h @var{style}
1725 @itemx --header-numbering=@var{style}
1726 @opindex -h
1727 @opindex --header-numbering
1728 Analogous to @option{--body-numbering}.
1729
1730 @item -i @var{number}
1731 @itemx --line-increment=@var{number}
1732 @opindex -i
1733 @opindex --line-increment
1734 Increment line numbers by @var{number} (default 1).
1735
1736 @item -l @var{number}
1737 @itemx --join-blank-lines=@var{number}
1738 @opindex -l
1739 @opindex --join-blank-lines
1740 @cindex empty lines, numbering
1741 @cindex blank lines, numbering
1742 Consider @var{number} (default 1) consecutive empty lines to be one
1743 logical line for numbering, and only number the last one.  Where fewer
1744 than @var{number} consecutive empty lines occur, do not number them.
1745 An empty line is one that contains no characters, not even spaces
1746 or tabs.
1747
1748 @item -n @var{format}
1749 @itemx --number-format=@var{format}
1750 @opindex -n
1751 @opindex --number-format
1752 Select the line numbering format (default is @code{rn}):
1753
1754 @table @samp
1755 @item ln
1756 @opindex ln @r{format for @command{nl}}
1757 left justified, no leading zeros;
1758 @item rn
1759 @opindex rn @r{format for @command{nl}}
1760 right justified, no leading zeros;
1761 @item rz
1762 @opindex rz @r{format for @command{nl}}
1763 right justified, leading zeros.
1764 @end table
1765
1766 @item -p
1767 @itemx --no-renumber
1768 @opindex -p
1769 @opindex --no-renumber
1770 Do not reset the line number at the start of a logical page.
1771
1772 @item -s @var{string}
1773 @itemx --number-separator=@var{string}
1774 @opindex -s
1775 @opindex --number-separator
1776 Separate the line number from the text line in the output with
1777 @var{string} (default is the TAB character).
1778
1779 @item -v @var{number}
1780 @itemx --starting-line-number=@var{number}
1781 @opindex -v
1782 @opindex --starting-line-number
1783 Set the initial line number on each logical page to @var{number} (default 1).
1784
1785 @item -w @var{number}
1786 @itemx --number-width=@var{number}
1787 @opindex -w
1788 @opindex --number-width
1789 Use @var{number} characters for line numbers (default 6).
1790
1791 @end table
1792
1793 @exitstatus
1794
1795
1796 @node od invocation
1797 @section @command{od}: Write files in octal or other formats
1798
1799 @pindex od
1800 @cindex octal dump of files
1801 @cindex hex dump of files
1802 @cindex ASCII dump of files
1803 @cindex file contents, dumping unambiguously
1804
1805 @command{od} writes an unambiguous representation of each @var{file}
1806 (@samp{-} means standard input), or standard input if none are given.
1807 Synopses:
1808
1809 @smallexample
1810 od [@var{option}]@dots{} [@var{file}]@dots{}
1811 od [-abcdfilosx]@dots{} [@var{file}] [[+]@var{offset}[.][b]]
1812 od [@var{option}]@dots{} --traditional [@var{file}]@c
1813  [[+]@var{offset}[.][b] [[+]@var{label}[.][b]]]
1814 @end smallexample
1815
1816 Each line of output consists of the offset in the input, followed by
1817 groups of data from the file.  By default, @command{od} prints the offset in
1818 octal, and each group of file data is a C @code{short int}'s worth of input
1819 printed as a single octal number.
1820
1821 If @var{offset} is given, it specifies how many input bytes to skip
1822 before formatting and writing.  By default, it is interpreted as an
1823 octal number, but the optional trailing decimal point causes it to be
1824 interpreted as decimal.  If no decimal is specified and the offset
1825 begins with @samp{0x} or @samp{0X} it is interpreted as a hexadecimal
1826 number.  If there is a trailing @samp{b}, the number of bytes skipped
1827 will be @var{offset} multiplied by 512.
1828
1829 If a command is of both the first and second forms, the second form is
1830 assumed if the last operand begins with @samp{+} or (if there are two
1831 operands) a digit.  For example, in @samp{od foo 10} and @samp{od +10}
1832 the @samp{10} is an offset, whereas in @samp{od 10} the @samp{10} is a
1833 file name.
1834
1835 The program accepts the following options.  Also see @ref{Common options}.
1836
1837 @table @samp
1838
1839 @item -A @var{radix}
1840 @itemx --address-radix=@var{radix}
1841 @opindex -A
1842 @opindex --address-radix
1843 @cindex radix for file offsets
1844 @cindex file offset radix
1845 Select the base in which file offsets are printed.  @var{radix} can
1846 be one of the following:
1847
1848 @table @samp
1849 @item d
1850 decimal;
1851 @item o
1852 octal;
1853 @item x
1854 hexadecimal;
1855 @item n
1856 none (do not print offsets).
1857 @end table
1858
1859 The default is octal.
1860
1861 @item -j @var{bytes}
1862 @itemx --skip-bytes=@var{bytes}
1863 @opindex -j
1864 @opindex --skip-bytes
1865 Skip @var{bytes} input bytes before formatting and writing.  If
1866 @var{bytes} begins with @samp{0x} or @samp{0X}, it is interpreted in
1867 hexadecimal; otherwise, if it begins with @samp{0}, in octal; otherwise,
1868 in decimal.
1869 @multiplierSuffixes{bytes}
1870
1871 @item -N @var{bytes}
1872 @itemx --read-bytes=@var{bytes}
1873 @opindex -N
1874 @opindex --read-bytes
1875 Output at most @var{bytes} bytes of the input.  Prefixes and suffixes on
1876 @code{bytes} are interpreted as for the @option{-j} option.
1877
1878 @item -S @var{bytes}
1879 @itemx --strings[=@var{bytes}]
1880 @opindex -S
1881 @opindex --strings
1882 @cindex string constants, outputting
1883 Instead of the normal output, output only @dfn{string constants}: at
1884 least @var{bytes} consecutive @acronym{ASCII} graphic characters,
1885 followed by a zero byte (@acronym{ASCII} @sc{nul}).
1886 Prefixes and suffixes on @code{bytes} are interpreted as for the
1887 @option{-j} option.
1888
1889 If @var{n} is omitted with @option{--strings}, the default is 3.
1890
1891 @item -t @var{type}
1892 @itemx --format=@var{type}
1893 @opindex -t
1894 @opindex --format
1895 Select the format in which to output the file data.  @var{type} is a
1896 string of one or more of the below type indicator characters.  If you
1897 include more than one type indicator character in a single @var{type}
1898 string, or use this option more than once, @command{od} writes one copy
1899 of each output line using each of the data types that you specified,
1900 in the order that you specified.
1901
1902 Adding a trailing ``z'' to any type specification appends a display
1903 of the @acronym{ASCII} character representation of the printable characters
1904 to the output line generated by the type specification.
1905
1906 @table @samp
1907 @item a
1908 named character, ignoring high-order bit
1909 @item c
1910 @acronym{ASCII} character or backslash escape,
1911 @item d
1912 signed decimal
1913 @item f
1914 floating point (@pxref{Floating point})
1915 @item o
1916 octal
1917 @item u
1918 unsigned decimal
1919 @item x
1920 hexadecimal
1921 @end table
1922
1923 The type @code{a} outputs things like @samp{sp} for space, @samp{nl} for
1924 newline, and @samp{nul} for a zero byte.  Only the least significant
1925 seven bits of each byte is used; the high-order bit is ignored.
1926 Type @code{c} outputs
1927 @samp{ }, @samp{\n}, and @code{\0}, respectively.
1928
1929 @cindex type size
1930 Except for types @samp{a} and @samp{c}, you can specify the number
1931 of bytes to use in interpreting each number in the given data type
1932 by following the type indicator character with a decimal integer.
1933 Alternately, you can specify the size of one of the C compiler's
1934 built-in data types by following the type indicator character with
1935 one of the following characters.  For integers (@samp{d}, @samp{o},
1936 @samp{u}, @samp{x}):
1937
1938 @table @samp
1939 @item C
1940 char
1941 @item S
1942 short
1943 @item I
1944 int
1945 @item L
1946 long
1947 @end table
1948
1949 For floating point (@code{f}):
1950
1951 @table @asis
1952 @item F
1953 float
1954 @item D
1955 double
1956 @item L
1957 long double
1958 @end table
1959
1960 @item -v
1961 @itemx --output-duplicates
1962 @opindex -v
1963 @opindex --output-duplicates
1964 Output consecutive lines that are identical.  By default, when two or
1965 more consecutive output lines would be identical, @command{od} outputs only
1966 the first line, and puts just an asterisk on the following line to
1967 indicate the elision.
1968
1969 @item -w[@var{n}]
1970 @itemx --width[=@var{n}]
1971 @opindex -w
1972 @opindex --width
1973 Dump @code{n} input bytes per output line.  This must be a multiple of
1974 the least common multiple of the sizes associated with the specified
1975 output types.
1976
1977 If this option is not given at all, the default is 16.  If @var{n} is
1978 omitted, the default is 32.
1979
1980 @end table
1981
1982 The next several options are shorthands for format specifications.
1983 @sc{gnu} @command{od} accepts any combination of shorthands and format
1984 specification options.  These options accumulate.
1985
1986 @table @samp
1987
1988 @item -a
1989 @opindex -a
1990 Output as named characters.  Equivalent to @samp{-t a}.
1991
1992 @item -b
1993 @opindex -b
1994 Output as octal bytes.  Equivalent to @samp{-t o1}.
1995
1996 @item -c
1997 @opindex -c
1998 Output as @acronym{ASCII} characters or backslash escapes.  Equivalent to
1999 @samp{-t c}.
2000
2001 @item -d
2002 @opindex -d
2003 Output as unsigned decimal two-byte units.  Equivalent to @samp{-t u2}.
2004
2005 @item -f
2006 @opindex -f
2007 Output as floats.  Equivalent to @samp{-t fF}.
2008
2009 @item -i
2010 @opindex -i
2011 Output as decimal ints.  Equivalent to @samp{-t dI}.
2012
2013 @item -l
2014 @opindex -l
2015 Output as decimal long ints.  Equivalent to @samp{-t dL}.
2016
2017 @item -o
2018 @opindex -o
2019 Output as octal two-byte units.  Equivalent to @option{-t o2}.
2020
2021 @item -s
2022 @opindex -s
2023 Output as decimal two-byte units.  Equivalent to @option{-t d2}.
2024
2025 @item -x
2026 @opindex -x
2027 Output as hexadecimal two-byte units.  Equivalent to @samp{-t x2}.
2028
2029 @item --traditional
2030 @opindex --traditional
2031 Recognize the non-option label argument that traditional @command{od}
2032 accepted.  The following syntax:
2033
2034 @smallexample
2035 od --traditional [@var{file}] [[+]@var{offset}[.][b] [[+]@var{label}[.][b]]]
2036 @end smallexample
2037
2038 @noindent
2039 can be used to specify at most one file and optional arguments
2040 specifying an offset and a pseudo-start address, @var{label}.
2041 The @var{label} argument is interpreted
2042 just like @var{offset}, but it specifies an initial pseudo-address.  The
2043 pseudo-addresses are displayed in parentheses following any normal
2044 address.
2045
2046 @end table
2047
2048 @exitstatus
2049
2050 @node base64 invocation
2051 @section @command{base64}: Transform data into printable data
2052
2053 @pindex base64
2054 @cindex base64 encoding
2055
2056 @command{base64} transforms data read from a file, or standard input,
2057 into (or from) base64 encoded form.  The base64 encoded form uses
2058 printable @acronym{ASCII} characters to represent binary data.
2059 Synopses:
2060
2061 @smallexample
2062 base64 [@var{option}]@dots{} [@var{file}]
2063 base64 --decode [@var{option}]@dots{} [@var{file}]
2064 @end smallexample
2065
2066 The base64 encoding expands data to roughly 133% of the original.
2067 The format conforms to
2068 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc4648.txt, RFC 4648}.
2069
2070 The program accepts the following options.  Also see @ref{Common options}.
2071
2072 @table @samp
2073
2074 @item -w @var{cols}
2075 @itemx --wrap=@var{cols}
2076 @opindex -w
2077 @opindex --wrap
2078 @cindex wrap data
2079 @cindex column to wrap data after
2080 During encoding, wrap lines after @var{cols} characters.  This must be
2081 a positive number.
2082
2083 The default is to wrap after 76 characters.  Use the value 0 to
2084 disable line wrapping altogether.
2085
2086 @item -d
2087 @itemx --decode
2088 @opindex -d
2089 @opindex --decode
2090 @cindex Decode base64 data
2091 @cindex Base64 decoding
2092 Change the mode of operation, from the default of encoding data, to
2093 decoding data.  Input is expected to be base64 encoded data, and the
2094 output will be the original data.
2095
2096 @item -i
2097 @itemx --ignore-garbage
2098 @opindex -i
2099 @opindex --ignore-garbage
2100 @cindex Ignore garbage in base64 stream
2101 When decoding, newlines are always accepted.
2102 During decoding, ignore unrecognized bytes,
2103 to permit distorted data to be decoded.
2104
2105 @end table
2106
2107 @exitstatus
2108
2109
2110 @node Formatting file contents
2111 @chapter Formatting file contents
2112
2113 @cindex formatting file contents
2114
2115 These commands reformat the contents of files.
2116
2117 @menu
2118 * fmt invocation::              Reformat paragraph text.
2119 * pr invocation::               Paginate or columnate files for printing.
2120 * fold invocation::             Wrap input lines to fit in specified width.
2121 @end menu
2122
2123
2124 @node fmt invocation
2125 @section @command{fmt}: Reformat paragraph text
2126
2127 @pindex fmt
2128 @cindex reformatting paragraph text
2129 @cindex paragraphs, reformatting
2130 @cindex text, reformatting
2131
2132 @command{fmt} fills and joins lines to produce output lines of (at most)
2133 a given number of characters (75 by default).  Synopsis:
2134
2135 @example
2136 fmt [@var{option}]@dots{} [@var{file}]@dots{}
2137 @end example
2138
2139 @command{fmt} reads from the specified @var{file} arguments (or standard
2140 input if none are given), and writes to standard output.
2141
2142 By default, blank lines, spaces between words, and indentation are
2143 preserved in the output; successive input lines with different
2144 indentation are not joined; tabs are expanded on input and introduced on
2145 output.
2146
2147 @cindex line-breaking
2148 @cindex sentences and line-breaking
2149 @cindex Knuth, Donald E.
2150 @cindex Plass, Michael F.
2151 @command{fmt} prefers breaking lines at the end of a sentence, and tries to
2152 avoid line breaks after the first word of a sentence or before the last
2153 word of a sentence.  A @dfn{sentence break} is defined as either the end
2154 of a paragraph or a word ending in any of @samp{.?!}, followed by two
2155 spaces or end of line, ignoring any intervening parentheses or quotes.
2156 Like @TeX{}, @command{fmt} reads entire ``paragraphs'' before choosing line
2157 breaks; the algorithm is a variant of that given by Donald E. Knuth
2158 and Michael F. Plass in ``Breaking Paragraphs Into Lines'',
2159 @cite{Software---Practice & Experience} @b{11}, 11 (November 1981),
2160 1119--1184.
2161
2162 The program accepts the following options.  Also see @ref{Common options}.
2163
2164 @table @samp
2165
2166 @item -c
2167 @itemx --crown-margin
2168 @opindex -c
2169 @opindex --crown-margin
2170 @cindex crown margin
2171 @dfn{Crown margin} mode: preserve the indentation of the first two
2172 lines within a paragraph, and align the left margin of each subsequent
2173 line with that of the second line.
2174
2175 @item -t
2176 @itemx --tagged-paragraph
2177 @opindex -t
2178 @opindex --tagged-paragraph
2179 @cindex tagged paragraphs
2180 @dfn{Tagged paragraph} mode: like crown margin mode, except that if
2181 indentation of the first line of a paragraph is the same as the
2182 indentation of the second, the first line is treated as a one-line
2183 paragraph.
2184
2185 @item -s
2186 @itemx --split-only
2187 @opindex -s
2188 @opindex --split-only
2189 Split lines only.  Do not join short lines to form longer ones.  This
2190 prevents sample lines of code, and other such ``formatted'' text from
2191 being unduly combined.
2192
2193 @item -u
2194 @itemx --uniform-spacing
2195 @opindex -u
2196 @opindex --uniform-spacing
2197 Uniform spacing.  Reduce spacing between words to one space, and spacing
2198 between sentences to two spaces.
2199
2200 @item -@var{width}
2201 @itemx -w @var{width}
2202 @itemx --width=@var{width}
2203 @opindex -@var{width}
2204 @opindex -w
2205 @opindex --width
2206 Fill output lines up to @var{width} characters (default 75).  @command{fmt}
2207 initially tries to make lines about 7% shorter than this, to give it
2208 room to balance line lengths.
2209
2210 @item -p @var{prefix}
2211 @itemx --prefix=@var{prefix}
2212 Only lines beginning with @var{prefix} (possibly preceded by whitespace)
2213 are subject to formatting.  The prefix and any preceding whitespace are
2214 stripped for the formatting and then re-attached to each formatted output
2215 line.  One use is to format certain kinds of program comments, while
2216 leaving the code unchanged.
2217
2218 @end table
2219
2220 @exitstatus
2221
2222
2223 @node pr invocation
2224 @section @command{pr}: Paginate or columnate files for printing
2225
2226 @pindex pr
2227 @cindex printing, preparing files for
2228 @cindex multicolumn output, generating
2229 @cindex merging files in parallel
2230
2231 @command{pr} writes each @var{file} (@samp{-} means standard input), or
2232 standard input if none are given, to standard output, paginating and
2233 optionally outputting in multicolumn format; optionally merges all
2234 @var{file}s, printing all in parallel, one per column.  Synopsis:
2235
2236 @example
2237 pr [@var{option}]@dots{} [@var{file}]@dots{}
2238 @end example
2239
2240 @vindex LC_MESSAGES
2241 By default, a 5-line header is printed at each page: two blank lines;
2242 a line with the date, the file name, and the page count; and two more
2243 blank lines.  A footer of five blank lines is also printed.
2244 The default @var{page_length} is 66
2245 lines.  The default number of text lines is therefore 56.
2246 The text line of the header takes the form
2247 @samp{@var{date} @var{string} @var{page}}, with spaces inserted around
2248 @var{string} so that the line takes up the full @var{page_width}.  Here,
2249 @var{date} is the date (see the @option{-D} or @option{--date-format}
2250 option for details), @var{string} is the centered header string, and
2251 @var{page} identifies the page number.  The @env{LC_MESSAGES} locale
2252 category affects the spelling of @var{page}; in the default C locale, it
2253 is @samp{Page @var{number}} where @var{number} is the decimal page
2254 number.
2255
2256 Form feeds in the input cause page breaks in the output.  Multiple form
2257 feeds produce empty pages.
2258
2259 Columns are of equal width, separated by an optional string (default
2260 is @samp{space}).  For multicolumn output, lines will always be truncated to
2261 @var{page_width} (default 72), unless you use the @option{-J} option.
2262 For single
2263 column output no line truncation occurs by default.  Use @option{-W} option to
2264 truncate lines in that case.
2265
2266 The following changes were made in version 1.22i and apply to later
2267 versions of @command{pr}:
2268 @c FIXME: this whole section here sounds very awkward to me. I
2269 @c made a few small changes, but really it all needs to be redone. - Brian
2270 @c OK, I fixed another sentence or two, but some of it I just don't understand.
2271 @ - Brian
2272 @itemize @bullet
2273
2274 @item
2275 Some small @var{letter options} (@option{-s}, @option{-w}) have been
2276 redefined for better @acronym{POSIX} compliance.  The output of some further
2277 cases has been adapted to other Unix systems.  These changes are not
2278 compatible with earlier versions of the program.
2279
2280 @item
2281 Some @var{new capital letter} options (@option{-J}, @option{-S}, @option{-W})
2282 have been introduced to turn off unexpected interferences of small letter
2283 options.  The @option{-N} option and the second argument @var{last_page}
2284 of @samp{+FIRST_PAGE} offer more flexibility.  The detailed handling of
2285 form feeds set in the input files requires the @option{-T} option.
2286
2287 @item
2288 Capital letter options override small letter ones.
2289
2290 @item
2291 Some of the option-arguments (compare @option{-s}, @option{-e},
2292 @option{-i}, @option{-n}) cannot be specified as separate arguments from the
2293 preceding option letter (already stated in the @acronym{POSIX} specification).
2294 @end itemize
2295
2296 The program accepts the following options.  Also see @ref{Common options}.
2297
2298 @table @samp
2299
2300 @item +@var{first_page}[:@var{last_page}]
2301 @itemx --pages=@var{first_page}[:@var{last_page}]
2302 @c The two following @opindex lines evoke warnings because they contain `:'
2303 @c The `info' spec does not permit that.  If we use those lines, we end
2304 @c up with truncated index entries that don't work.
2305 @c @opindex +@var{first_page}[:@var{last_page}]
2306 @c @opindex --pages=@var{first_page}[:@var{last_page}]
2307 @opindex +@var{page_range}
2308 @opindex --pages=@var{page_range}
2309 Begin printing with page @var{first_page} and stop with @var{last_page}.
2310 Missing @samp{:@var{last_page}} implies end of file.  While estimating
2311 the number of skipped pages each form feed in the input file results
2312 in a new page.  Page counting with and without @samp{+@var{first_page}}
2313 is identical.  By default, counting starts with the first page of input
2314 file (not first page printed).  Line numbering may be altered by @option{-N}
2315 option.
2316
2317 @item -@var{column}
2318 @itemx --columns=@var{column}
2319 @opindex -@var{column}
2320 @opindex --columns
2321 @cindex down columns
2322 With each single @var{file}, produce @var{column} columns of output
2323 (default is 1) and print columns down, unless @option{-a} is used.  The
2324 column width is automatically decreased as @var{column} increases; unless
2325 you use the @option{-W/-w} option to increase @var{page_width} as well.
2326 This option might well cause some lines to be truncated.  The number of
2327 lines in the columns on each page are balanced.  The options @option{-e}
2328 and @option{-i} are on for multiple text-column output.  Together with
2329 @option{-J} option column alignment and line truncation is turned off.
2330 Lines of full length are joined in a free field format and @option{-S}
2331 option may set field separators.  @option{-@var{column}} may not be used
2332 with @option{-m} option.
2333
2334 @item -a
2335 @itemx --across
2336 @opindex -a
2337 @opindex --across
2338 @cindex across columns
2339 With each single @var{file}, print columns across rather than down.  The
2340 @option{-@var{column}} option must be given with @var{column} greater than one.
2341 If a line is too long to fit in a column, it is truncated.
2342
2343 @item -c
2344 @itemx --show-control-chars
2345 @opindex -c
2346 @opindex --show-control-chars
2347 Print control characters using hat notation (e.g., @samp{^G}); print
2348 other nonprinting characters in octal backslash notation.  By default,
2349 nonprinting characters are not changed.
2350
2351 @item -d
2352 @itemx --double-space
2353 @opindex -d
2354 @opindex --double-space
2355 @cindex double spacing
2356 Double space the output.
2357
2358 @item -D @var{format}
2359 @itemx --date-format=@var{format}
2360 @cindex time formats
2361 @cindex formatting times
2362 Format header dates using @var{format}, using the same conventions as
2363 for the command @samp{date +@var{format}}; @xref{date invocation}.
2364 Except for directives, which start with
2365 @samp{%}, characters in @var{format} are printed unchanged.  You can use
2366 this option to specify an arbitrary string in place of the header date,
2367 e.g., @option{--date-format="Monday morning"}.
2368
2369 @vindex POSIXLY_CORRECT
2370 @vindex LC_TIME
2371 The default date format is @samp{%Y-%m-%d %H:%M} (for example,
2372 @samp{2001-12-04 23:59});
2373 but if the @env{POSIXLY_CORRECT} environment variable is set
2374 and the @env{LC_TIME} locale category specifies the @acronym{POSIX}
2375 locale, the default is @samp{%b %e %H:%M %Y} (for example,
2376 @samp{Dec@ @ 4 23:59 2001}.
2377
2378 @vindex TZ
2379 Time stamps are listed according to the time zone rules specified by
2380 the @env{TZ} environment variable, or by the system default rules if
2381 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
2382 with @env{TZ}, libc, The GNU C Library Reference Manual}.
2383
2384 @item -e[@var{in-tabchar}[@var{in-tabwidth}]]
2385 @itemx --expand-tabs[=@var{in-tabchar}[@var{in-tabwidth}]]
2386 @opindex -e
2387 @opindex --expand-tabs
2388 @cindex input tabs
2389 Expand @var{tab}s to spaces on input.  Optional argument @var{in-tabchar} is
2390 the input tab character (default is the TAB character).  Second optional
2391 argument @var{in-tabwidth} is the input tab character's width (default
2392 is 8).
2393
2394 @item -f
2395 @itemx -F
2396 @itemx --form-feed
2397 @opindex -F
2398 @opindex -f
2399 @opindex --form-feed
2400 Use a form feed instead of newlines to separate output pages.  This does
2401 not alter the default page length of 66 lines.
2402
2403 @item -h @var{header}
2404 @itemx --header=@var{header}
2405 @opindex -h
2406 @opindex --header
2407 Replace the file name in the header with the centered string @var{header}.
2408 When using the shell, @var{header} should be quoted and should be
2409 separated from @option{-h} by a space.
2410
2411 @item -i[@var{out-tabchar}[@var{out-tabwidth}]]
2412 @itemx --output-tabs[=@var{out-tabchar}[@var{out-tabwidth}]]
2413 @opindex -i
2414 @opindex --output-tabs
2415 @cindex output tabs
2416 Replace spaces with @var{tab}s on output.  Optional argument @var{out-tabchar}
2417 is the output tab character (default is the TAB character).  Second optional
2418 argument @var{out-tabwidth} is the output tab character's width (default
2419 is 8).
2420
2421 @item -J
2422 @itemx --join-lines
2423 @opindex -J
2424 @opindex --join-lines
2425 Merge lines of full length.  Used together with the column options
2426 @option{-@var{column}}, @option{-a -@var{column}} or @option{-m}.  Turns off
2427 @option{-W/-w} line truncation;
2428 no column alignment used; may be used with
2429 @option{--sep-string[=@var{string}]}.  @option{-J} has been introduced
2430 (together with @option{-W} and @option{--sep-string})
2431 to disentangle the old (@acronym{POSIX}-compliant) options @option{-w} and
2432 @option{-s} along with the three column options.
2433
2434
2435 @item -l @var{page_length}
2436 @itemx --length=@var{page_length}
2437 @opindex -l
2438 @opindex --length
2439 Set the page length to @var{page_length} (default 66) lines, including
2440 the lines of the header [and the footer].  If @var{page_length} is less
2441 than or equal to 10, the header and footer are omitted, as if the
2442 @option{-t} option had been given.
2443
2444 @item -m
2445 @itemx --merge
2446 @opindex -m
2447 @opindex --merge
2448 Merge and print all @var{file}s in parallel, one in each column.  If a
2449 line is too long to fit in a column, it is truncated, unless the @option{-J}
2450 option is used.  @option{--sep-string[=@var{string}]} may be used.
2451 Empty pages in
2452 some @var{file}s (form feeds set) produce empty columns, still marked
2453 by @var{string}.  The result is a continuous line numbering and column
2454 marking throughout the whole merged file.  Completely empty merged pages
2455 show no separators or line numbers.  The default header becomes
2456 @samp{@var{date} @var{page}} with spaces inserted in the middle; this
2457 may be used with the @option{-h} or @option{--header} option to fill up
2458 the middle blank part.
2459
2460 @item -n[@var{number-separator}[@var{digits}]]
2461 @itemx --number-lines[=@var{number-separator}[@var{digits}]]
2462 @opindex -n
2463 @opindex --number-lines
2464 Provide @var{digits} digit line numbering (default for @var{digits} is
2465 5).  With multicolumn output the number occupies the first @var{digits}
2466 column positions of each text column or only each line of @option{-m}
2467 output.  With single column output the number precedes each line just as
2468 @option{-m} does.  Default counting of the line numbers starts with the
2469 first line of the input file (not the first line printed, compare the
2470 @option{--page} option and @option{-N} option).
2471 Optional argument @var{number-separator} is the character appended to
2472 the line number to separate it from the text followed.  The default
2473 separator is the TAB character.  In a strict sense a TAB is always
2474 printed with single column output only.  The TAB width varies
2475 with the TAB position, e.g., with the left @var{margin} specified
2476 by @option{-o} option.  With multicolumn output priority is given to
2477 @samp{equal width of output columns} (a @acronym{POSIX} specification).
2478 The TAB width is fixed to the value of the first column and does
2479 not change with different values of left @var{margin}.  That means a
2480 fixed number of spaces is always printed in the place of the
2481 @var{number-separator} TAB.  The tabification depends upon the output
2482 position.
2483
2484 @item -N @var{line_number}
2485 @itemx --first-line-number=@var{line_number}
2486 @opindex -N
2487 @opindex --first-line-number
2488 Start line counting with the number @var{line_number} at first line of
2489 first page printed (in most cases not the first line of the input file).
2490
2491 @item -o @var{margin}
2492 @itemx --indent=@var{margin}
2493 @opindex -o
2494 @opindex --indent
2495 @cindex indenting lines
2496 @cindex left margin
2497 Indent each line with a margin @var{margin} spaces wide (default is zero).
2498 The total page width is the size of the margin plus the @var{page_width}
2499 set with the @option{-W/-w} option.  A limited overflow may occur with
2500 numbered single column output (compare @option{-n} option).
2501
2502 @item -r
2503 @itemx --no-file-warnings
2504 @opindex -r
2505 @opindex --no-file-warnings
2506 Do not print a warning message when an argument @var{file} cannot be
2507 opened.  (The exit status will still be nonzero, however.)
2508
2509 @item -s[@var{char}]
2510 @itemx --separator[=@var{char}]
2511 @opindex -s
2512 @opindex --separator
2513 Separate columns by a single character @var{char}.  The default for
2514 @var{char} is the TAB character without @option{-w} and @samp{no
2515 character} with @option{-w}.  Without @option{-s} the default separator
2516 @samp{space} is set.  @option{-s[char]} turns off line truncation of all
2517 three column options (@option{-COLUMN}|@option{-a -COLUMN}|@option{-m}) unless
2518 @option{-w} is set.  This is a @acronym{POSIX}-compliant formulation.
2519
2520
2521 @item -S@var{string}
2522 @itemx --sep-string[=@var{string}]
2523 @opindex -S
2524 @opindex --sep-string
2525 Use @var{string} to separate output columns.  The @option{-S} option doesn't
2526 affect the @option{-W/-w} option, unlike the @option{-s} option which does.  It
2527 does not affect line truncation or column alignment.
2528 Without @option{-S}, and with @option{-J}, @command{pr} uses the default output
2529 separator, TAB@.
2530 Without @option{-S} or @option{-J}, @command{pr} uses a @samp{space}
2531 (same as @option{-S"@w{ }"}).  @option{--sep-string} with no
2532 @samp{=@var{string}} is equivalent to @option{--sep-string=""}.
2533
2534 @item -t
2535 @itemx --omit-header
2536 @opindex -t
2537 @opindex --omit-header
2538 Do not print the usual header [and footer] on each page, and do not fill
2539 out the bottom of pages (with blank lines or a form feed).  No page
2540 structure is produced, but form feeds set in the input files are retained.
2541 The predefined pagination is not changed.  @option{-t} or @option{-T} may be
2542 useful together with other options; e.g.: @option{-t -e4}, expand TAB characters
2543 in the input file to 4 spaces but don't make any other changes.  Use of
2544 @option{-t} overrides @option{-h}.
2545
2546 @item -T
2547 @itemx --omit-pagination
2548 @opindex -T
2549 @opindex --omit-pagination
2550 Do not print header [and footer].  In addition eliminate all form feeds
2551 set in the input files.
2552
2553 @item -v
2554 @itemx --show-nonprinting
2555 @opindex -v
2556 @opindex --show-nonprinting
2557 Print nonprinting characters in octal backslash notation.
2558
2559 @item -w @var{page_width}
2560 @itemx --width=@var{page_width}
2561 @opindex -w
2562 @opindex --width
2563 Set page width to @var{page_width} characters for multiple text-column
2564 output only (default for @var{page_width} is 72).  @option{-s[CHAR]} turns
2565 off the default page width and any line truncation and column alignment.
2566 Lines of full length are merged, regardless of the column options
2567 set.  No @var{page_width} setting is possible with single column output.
2568 A @acronym{POSIX}-compliant formulation.
2569
2570 @item -W @var{page_width}
2571 @itemx --page_width=@var{page_width}
2572 @opindex -W
2573 @opindex --page_width
2574 Set the page width to @var{page_width} characters.  That's valid with and
2575 without a column option.  Text lines are truncated, unless @option{-J}
2576 is used.  Together with one of the three column options
2577 (@option{-@var{column}}, @option{-a -@var{column}} or @option{-m}) column
2578 alignment is always used.  The separator options @option{-S} or @option{-s}
2579 don't affect the @option{-W} option.  Default is 72 characters.  Without
2580 @option{-W @var{page_width}} and without any of the column options NO line
2581 truncation is used (defined to keep downward compatibility and to meet
2582 most frequent tasks).  That's equivalent to @option{-W 72 -J}.  The header
2583 line is never truncated.
2584
2585 @end table
2586
2587 @exitstatus
2588
2589
2590 @node fold invocation
2591 @section @command{fold}: Wrap input lines to fit in specified width
2592
2593 @pindex fold
2594 @cindex wrapping long input lines
2595 @cindex folding long input lines
2596
2597 @command{fold} writes each @var{file} (@option{-} means standard input), or
2598 standard input if none are given, to standard output, breaking long
2599 lines.  Synopsis:
2600
2601 @example
2602 fold [@var{option}]@dots{} [@var{file}]@dots{}
2603 @end example
2604
2605 By default, @command{fold} breaks lines wider than 80 columns.  The output
2606 is split into as many lines as necessary.
2607
2608 @cindex screen columns
2609 @command{fold} counts screen columns by default; thus, a tab may count more
2610 than one column, backspace decreases the column count, and carriage
2611 return sets the column to zero.
2612
2613 The program accepts the following options.  Also see @ref{Common options}.
2614
2615 @table @samp
2616
2617 @item -b
2618 @itemx --bytes
2619 @opindex -b
2620 @opindex --bytes
2621 Count bytes rather than columns, so that tabs, backspaces, and carriage
2622 returns are each counted as taking up one column, just like other
2623 characters.
2624
2625 @item -s
2626 @itemx --spaces
2627 @opindex -s
2628 @opindex --spaces
2629 Break at word boundaries: the line is broken after the last blank before
2630 the maximum line length.  If the line contains no such blanks, the line
2631 is broken at the maximum line length as usual.
2632
2633 @item -w @var{width}
2634 @itemx --width=@var{width}
2635 @opindex -w
2636 @opindex --width
2637 Use a maximum line length of @var{width} columns instead of 80.
2638
2639 For compatibility @command{fold} supports an obsolete option syntax
2640 @option{-@var{width}}.  New scripts should use @option{-w @var{width}}
2641 instead.
2642
2643 @end table
2644
2645 @exitstatus
2646
2647
2648 @node Output of parts of files
2649 @chapter Output of parts of files
2650
2651 @cindex output of parts of files
2652 @cindex parts of files, output of
2653
2654 These commands output pieces of the input.
2655
2656 @menu
2657 * head invocation::             Output the first part of files.
2658 * tail invocation::             Output the last part of files.
2659 * split invocation::            Split a file into pieces.
2660 * csplit invocation::           Split a file into context-determined pieces.
2661 @end menu
2662
2663 @node head invocation
2664 @section @command{head}: Output the first part of files
2665
2666 @pindex head
2667 @cindex initial part of files, outputting
2668 @cindex first part of files, outputting
2669
2670 @command{head} prints the first part (10 lines by default) of each
2671 @var{file}; it reads from standard input if no files are given or
2672 when given a @var{file} of @option{-}.  Synopsis:
2673
2674 @example
2675 head [@var{option}]@dots{} [@var{file}]@dots{}
2676 @end example
2677
2678 If more than one @var{file} is specified, @command{head} prints a
2679 one-line header consisting of:
2680
2681 @example
2682 ==> @var{file name} <==
2683 @end example
2684
2685 @noindent
2686 before the output for each @var{file}.
2687
2688 The program accepts the following options.  Also see @ref{Common options}.
2689
2690 @table @samp
2691
2692 @item -c @var{k}
2693 @itemx --bytes=@var{k}
2694 @opindex -c
2695 @opindex --bytes
2696 Print the first @var{k} bytes, instead of initial lines.
2697 However, if @var{k} starts with a @samp{-},
2698 print all but the last @var{k} bytes of each file.
2699 @multiplierSuffixes{k}
2700
2701 @itemx -n @var{k}
2702 @itemx --lines=@var{k}
2703 @opindex -n
2704 @opindex --lines
2705 Output the first @var{k} lines.
2706 However, if @var{k} starts with a @samp{-},
2707 print all but the last @var{k} lines of each file.
2708 Size multiplier suffixes are the same as with the @option{-c} option.
2709
2710 @item -q
2711 @itemx --quiet
2712 @itemx --silent
2713 @opindex -q
2714 @opindex --quiet
2715 @opindex --silent
2716 Never print file name headers.
2717
2718 @item -v
2719 @itemx --verbose
2720 @opindex -v
2721 @opindex --verbose
2722 Always print file name headers.
2723
2724 @end table
2725
2726 For compatibility @command{head} also supports an obsolete option syntax
2727 @option{-@var{count}@var{options}}, which is recognized only if it is
2728 specified first.  @var{count} is a decimal number optionally followed
2729 by a size letter (@samp{b}, @samp{k}, @samp{m}) as in @option{-c}, or
2730 @samp{l} to mean count by lines, or other option letters (@samp{cqv}).
2731 Scripts intended for standard hosts should use @option{-c @var{count}}
2732 or @option{-n @var{count}} instead.  If your script must also run on
2733 hosts that support only the obsolete syntax, it is usually simpler to
2734 avoid @command{head}, e.g., by using @samp{sed 5q} instead of
2735 @samp{head -5}.
2736
2737 @exitstatus
2738
2739
2740 @node tail invocation
2741 @section @command{tail}: Output the last part of files
2742
2743 @pindex tail
2744 @cindex last part of files, outputting
2745
2746 @command{tail} prints the last part (10 lines by default) of each
2747 @var{file}; it reads from standard input if no files are given or
2748 when given a @var{file} of @samp{-}.  Synopsis:
2749
2750 @example
2751 tail [@var{option}]@dots{} [@var{file}]@dots{}
2752 @end example
2753
2754 If more than one @var{file} is specified, @command{tail} prints a
2755 one-line header consisting of:
2756
2757 @example
2758 ==> @var{file name} <==
2759 @end example
2760
2761 @noindent
2762 before the output for each @var{file}.
2763
2764 @cindex BSD @command{tail}
2765 @sc{gnu} @command{tail} can output any amount of data (some other versions of
2766 @command{tail} cannot).  It also has no @option{-r} option (print in
2767 reverse), since reversing a file is really a different job from printing
2768 the end of a file; BSD @command{tail} (which is the one with @option{-r}) can
2769 only reverse files that are at most as large as its buffer, which is
2770 typically 32 KiB@.  A more reliable and versatile way to reverse files is
2771 the @sc{gnu} @command{tac} command.
2772
2773 The program accepts the following options.  Also see @ref{Common options}.
2774
2775 @table @samp
2776
2777 @item -c @var{k}
2778 @itemx --bytes=@var{k}
2779 @opindex -c
2780 @opindex --bytes
2781 Output the last @var{k} bytes, instead of final lines.
2782 However, if @var{k} starts with a @samp{+}, start printing with the
2783 @var{k}th byte from the start of each file, instead of from the end.
2784 @multiplierSuffixes{k}
2785
2786 @item -f
2787 @itemx --follow[=@var{how}]
2788 @opindex -f
2789 @opindex --follow
2790 @cindex growing files
2791 @vindex name @r{follow option}
2792 @vindex descriptor @r{follow option}
2793 Loop forever trying to read more characters at the end of the file,
2794 presumably because the file is growing.
2795 If more than one file is given, @command{tail} prints a header whenever it
2796 gets output from a different file, to indicate which file that output is
2797 from.
2798
2799 There are two ways to specify how you'd like to track files with this option,
2800 but that difference is noticeable only when a followed file is removed or
2801 renamed.
2802 If you'd like to continue to track the end of a growing file even after
2803 it has been unlinked, use @option{--follow=descriptor}.  This is the default
2804 behavior, but it is not useful if you're tracking a log file that may be
2805 rotated (removed or renamed, then reopened).  In that case, use
2806 @option{--follow=name} to track the named file, perhaps by reopening it
2807 periodically to see if it has been removed and recreated by some other program.
2808 Note that the inotify-based implementation handles this case without
2809 the need for any periodic reopening.
2810
2811 No matter which method you use, if the tracked file is determined to have
2812 shrunk, @command{tail} prints a message saying the file has been truncated
2813 and resumes tracking the end of the file from the newly-determined endpoint.
2814
2815 When a file is removed, @command{tail}'s behavior depends on whether it is
2816 following the name or the descriptor.  When following by name, tail can
2817 detect that a file has been removed and gives a message to that effect,
2818 and if @option{--retry} has been specified it will continue checking
2819 periodically to see if the file reappears.
2820 When following a descriptor, tail does not detect that the file has
2821 been unlinked or renamed and issues no message;  even though the file
2822 may no longer be accessible via its original name, it may still be
2823 growing.
2824
2825 The option values @samp{descriptor} and @samp{name} may be specified only
2826 with the long form of the option, not with @option{-f}.
2827
2828 The @option{-f} option is ignored if
2829 no @var{file} operand is specified and standard input is a FIFO or a pipe.
2830 Likewise, the @option{-f} option has no effect for any
2831 operand specified as @samp{-}, when standard input is a FIFO or a pipe.
2832
2833 @item -F
2834 @opindex -F
2835 This option is the same as @option{--follow=name --retry}.  That is, tail
2836 will attempt to reopen a file when it is removed.  Should this fail, tail
2837 will keep trying until it becomes accessible again.
2838
2839 @itemx --retry
2840 @opindex --retry
2841 This option is useful mainly when following by name (i.e., with
2842 @option{--follow=name}).
2843 Without this option, when tail encounters a file that doesn't
2844 exist or is otherwise inaccessible, it reports that fact and
2845 never checks it again.
2846
2847 @itemx --sleep-interval=@var{number}
2848 @opindex --sleep-interval
2849 Change the number of seconds to wait between iterations (the default is 1.0).
2850 During one iteration, every specified file is checked to see if it has
2851 changed size.
2852 Historical implementations of @command{tail} have required that
2853 @var{number} be an integer.  However, GNU @command{tail} accepts
2854 an arbitrary floating point number.  @xref{Floating point}.
2855 When @command{tail} uses inotify, this polling-related option is ignored.
2856
2857 @itemx --pid=@var{pid}
2858 @opindex --pid
2859 When following by name or by descriptor, you may specify the process ID,
2860 @var{pid}, of the sole writer of all @var{file} arguments.  Then, shortly
2861 after that process terminates, tail will also terminate.  This will
2862 work properly only if the writer and the tailing process are running on
2863 the same machine.  For example, to save the output of a build in a file
2864 and to watch the file grow, if you invoke @command{make} and @command{tail}
2865 like this then the tail process will stop when your build completes.
2866 Without this option, you would have had to kill the @code{tail -f}
2867 process yourself.
2868
2869 @example
2870 $ make >& makerr & tail --pid=$! -f makerr
2871 @end example
2872
2873 If you specify a @var{pid} that is not in use or that does not correspond
2874 to the process that is writing to the tailed files, then @command{tail}
2875 may terminate long before any @var{file}s stop growing or it may not
2876 terminate until long after the real writer has terminated.
2877 Note that @option{--pid} cannot be supported on some systems; @command{tail}
2878 will print a warning if this is the case.
2879
2880 @itemx --max-unchanged-stats=@var{n}
2881 @opindex --max-unchanged-stats
2882 When tailing a file by name, if there have been @var{n} (default
2883 n=@value{DEFAULT_MAX_N_UNCHANGED_STATS_BETWEEN_OPENS}) consecutive
2884 iterations for which the file has not changed, then
2885 @code{open}/@code{fstat} the file to determine if that file name is
2886 still associated with the same device/inode-number pair as before.
2887 When following a log file that is rotated, this is approximately the
2888 number of seconds between when tail prints the last pre-rotation lines
2889 and when it prints the lines that have accumulated in the new log file.
2890 This option is meaningful only when polling (i.e., without inotify)
2891 and when following by name.
2892
2893 @itemx -n @var{k}
2894 @itemx --lines=@var{k}
2895 @opindex -n
2896 @opindex --lines
2897 Output the last @var{k} lines.
2898 However, if @var{k} starts with a @samp{+}, start printing with the
2899 @var{k}th line from the start of each file, instead of from the end.
2900 Size multiplier suffixes are the same as with the @option{-c} option.
2901
2902 @item -q
2903 @itemx --quiet
2904 @itemx --silent
2905 @opindex -q
2906 @opindex --quiet
2907 @opindex --silent
2908 Never print file name headers.
2909
2910 @item -v
2911 @itemx --verbose
2912 @opindex -v
2913 @opindex --verbose
2914 Always print file name headers.
2915
2916 @end table
2917
2918 For compatibility @command{tail} also supports an obsolete usage
2919 @samp{tail -[@var{count}][bcl][f] [@var{file}]}, which is recognized
2920 only if it does not conflict with the usage described
2921 above.  This obsolete form uses exactly one option and at most one
2922 file.  In the option, @var{count} is an optional decimal number optionally
2923 followed by a size letter (@samp{b}, @samp{c}, @samp{l}) to mean count
2924 by 512-byte blocks, bytes, or lines, optionally followed by @samp{f}
2925 which has the same meaning as @option{-f}.
2926
2927 @vindex _POSIX2_VERSION
2928 On older systems, the leading @samp{-} can be replaced by @samp{+} in
2929 the obsolete option syntax with the same meaning as in counts, and
2930 obsolete usage overrides normal usage when the two conflict.
2931 This obsolete behavior can be enabled or disabled with the
2932 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
2933 conformance}).
2934
2935 Scripts intended for use on standard hosts should avoid obsolete
2936 syntax and should use @option{-c @var{count}[b]}, @option{-n
2937 @var{count}}, and/or @option{-f} instead.  If your script must also
2938 run on hosts that support only the obsolete syntax, you can often
2939 rewrite it to avoid problematic usages, e.g., by using @samp{sed -n
2940 '$p'} rather than @samp{tail -1}.  If that's not possible, the script
2941 can use a test like @samp{if tail -c +1 </dev/null >/dev/null 2>&1;
2942 then @dots{}} to decide which syntax to use.
2943
2944 Even if your script assumes the standard behavior, you should still
2945 beware usages whose behaviors differ depending on the @acronym{POSIX}
2946 version.  For example, avoid @samp{tail - main.c}, since it might be
2947 interpreted as either @samp{tail main.c} or as @samp{tail -- -
2948 main.c}; avoid @samp{tail -c 4}, since it might mean either @samp{tail
2949 -c4} or @samp{tail -c 10 4}; and avoid @samp{tail +4}, since it might
2950 mean either @samp{tail ./+4} or @samp{tail -n +4}.
2951
2952 @exitstatus
2953
2954
2955 @node split invocation
2956 @section @command{split}: Split a file into pieces.
2957
2958 @pindex split
2959 @cindex splitting a file into pieces
2960 @cindex pieces, splitting a file into
2961
2962 @command{split} creates output files containing consecutive or interleaved
2963 sections of @var{input}  (standard input if none is given or @var{input}
2964 is @samp{-}).  Synopsis:
2965
2966 @example
2967 split [@var{option}] [@var{input} [@var{prefix}]]
2968 @end example
2969
2970 By default, @command{split} puts 1000 lines of @var{input} (or whatever is
2971 left over for the last section), into each output file.
2972
2973 @cindex output file name prefix
2974 The output files' names consist of @var{prefix} (@samp{x} by default)
2975 followed by a group of characters (@samp{aa}, @samp{ab}, @dots{} by
2976 default), such that concatenating the output files in traditional
2977 sorted order by file name produces the original input file (except
2978 @option{-r}).  If the output file names are exhausted, @command{split}
2979 reports an error without deleting the output files that it did create.
2980
2981 The program accepts the following options.  Also see @ref{Common options}.
2982
2983 @table @samp
2984
2985 @item -l @var{lines}
2986 @itemx --lines=@var{lines}
2987 @opindex -l
2988 @opindex --lines
2989 Put @var{lines} lines of @var{input} into each output file.
2990
2991 For compatibility @command{split} also supports an obsolete
2992 option syntax @option{-@var{lines}}.  New scripts should use @option{-l
2993 @var{lines}} instead.
2994
2995 @item -b @var{size}
2996 @itemx --bytes=@var{size}
2997 @opindex -b
2998 @opindex --bytes
2999 Put @var{size} bytes of @var{input} into each output file.
3000 @multiplierSuffixes{size}
3001
3002 @item -C @var{size}
3003 @itemx --line-bytes=@var{size}
3004 @opindex -C
3005 @opindex --line-bytes
3006 Put into each output file as many complete lines of @var{input} as
3007 possible without exceeding @var{size} bytes.  Individual lines longer than
3008 @var{size} bytes are broken into multiple files.
3009 @var{size} has the same format as for the @option{--bytes} option.
3010
3011 @item -n @var{chunks}
3012 @itemx --number=@var{chunks}
3013 @opindex -n
3014 @opindex --number
3015
3016 Split @var{input} to @var{chunks} output files where @var{chunks} may be:
3017
3018 @example
3019 @var{n}      generate @var{n} files based on current size of @var{input}
3020 @var{k}/@var{n}    only output @var{k}th of @var{n} to stdout
3021 l/@var{n}    generate @var{n} files without splitting lines
3022 l/@var{k}/@var{n}  likewise but only output @var{k}th of @var{n} to stdout
3023 r/@var{n}    like @samp{l} but use round robin distribution
3024 r/@var{k}/@var{n}  likewise but only output @var{k}th of @var{n} to stdout
3025 @end example
3026
3027 Any excess bytes remaining after dividing the @var{input}
3028 into @var{n} chunks, are assigned to the last chunk.
3029 Any excess bytes appearing after the initial calculation are discarded
3030 (except when using @samp{r} mode).
3031
3032 All @var{n} files are created even if there are fewer than @var{n} lines,
3033 or the @var{input} is truncated.
3034
3035 For @samp{l} mode, chunks are approximately @var{input} size / @var{n}.
3036 The @var{input} is partitioned into @var{n} equal sized portions, with
3037 the last assigned any excess.  If a line @emph{starts} within a partition
3038 it is written completely to the corresponding file.  Since lines
3039 are not split even if they overlap a partition, the files written
3040 can be larger or smaller than the partition size, and even empty
3041 if a line is so long as to completely overlap the partition.
3042
3043 For @samp{r} mode, the size of @var{input} is irrelevant,
3044 and so can be a pipe for example.
3045
3046 @item -a @var{length}
3047 @itemx --suffix-length=@var{length}
3048 @opindex -a
3049 @opindex --suffix-length
3050 Use suffixes of length @var{length}.  The default @var{length} is 2.
3051
3052 @item -d
3053 @itemx --numeric-suffixes
3054 @opindex -d
3055 @opindex --numeric-suffixes
3056 Use digits in suffixes rather than lower-case letters.
3057
3058 @item -e
3059 @itemx --elide-empty-files
3060 @opindex -e
3061 @opindex --elide-empty-files
3062 Suppress the generation of zero-length output files.  This can happen
3063 with the @option{--number} option if a file is (truncated to be) shorter
3064 than the number requested, or if a line is so long as to completely
3065 span a chunk.  The output file sequence numbers, always run consecutively
3066 even when this option is specified.
3067
3068 @item -u
3069 @itemx --unbuffered
3070 @opindex -u
3071 @opindex --unbuffered
3072 Immediately copy input to output in @option{--number r/...} mode,
3073 which is a much slower mode of operation.
3074
3075 @itemx --verbose
3076 @opindex --verbose
3077 Write a diagnostic just before each output file is opened.
3078
3079 @end table
3080
3081 @exitstatus
3082
3083 Here are a few examples to illustrate how the
3084 @option{--number} (@option{-n}) option works:
3085
3086 Notice how, by default, one line may be split onto two or more:
3087
3088 @example
3089 $ seq -w 6 10 > k; split -n3 k; head xa?
3090 ==> xaa <==
3091 06
3092 07
3093 ==> xab <==
3094
3095 08
3096 0
3097 ==> xac <==
3098 9
3099 10
3100 @end example
3101
3102 Use the "l/" modifier to suppress that:
3103
3104 @example
3105 $ seq -w 6 10 > k; split -nl/3 k; head xa?
3106 ==> xaa <==
3107 06
3108 07
3109
3110 ==> xab <==
3111 08
3112 09
3113
3114 ==> xac <==
3115 10
3116 @end example
3117
3118 Use the "r/" modifier to distribute lines in a round-robin fashion:
3119
3120 @example
3121 $ seq -w 6 10 > k; split -nr/3 k; head xa?
3122 ==> xaa <==
3123 06
3124 09
3125
3126 ==> xab <==
3127 07
3128 10
3129
3130 ==> xac <==
3131 08
3132 @end example
3133
3134 You can also extract just the Kth chunk.
3135 This extracts and prints just the 7th "chunk" of 33:
3136
3137 @example
3138 $ seq 100 > k; split -nl/7/33 k
3139 20
3140 21
3141 22
3142 @end example
3143
3144
3145 @node csplit invocation
3146 @section @command{csplit}: Split a file into context-determined pieces
3147
3148 @pindex csplit
3149 @cindex context splitting
3150 @cindex splitting a file into pieces by context
3151
3152 @command{csplit} creates zero or more output files containing sections of
3153 @var{input} (standard input if @var{input} is @samp{-}).  Synopsis:
3154
3155 @example
3156 csplit [@var{option}]@dots{} @var{input} @var{pattern}@dots{}
3157 @end example
3158
3159 The contents of the output files are determined by the @var{pattern}
3160 arguments, as detailed below.  An error occurs if a @var{pattern}
3161 argument refers to a nonexistent line of the input file (e.g., if no
3162 remaining line matches a given regular expression).  After every
3163 @var{pattern} has been matched, any remaining input is copied into one
3164 last output file.
3165
3166 By default, @command{csplit} prints the number of bytes written to each
3167 output file after it has been created.
3168
3169 The types of pattern arguments are:
3170
3171 @table @samp
3172
3173 @item @var{n}
3174 Create an output file containing the input up to but not including line
3175 @var{n} (a positive integer).  If followed by a repeat count, also
3176 create an output file containing the next @var{n} lines of the input
3177 file once for each repeat.
3178
3179 @item /@var{regexp}/[@var{offset}]
3180 Create an output file containing the current line up to (but not
3181 including) the next line of the input file that contains a match for
3182 @var{regexp}.  The optional @var{offset} is an integer.
3183 If it is given, the input up to (but not including) the
3184 matching line plus or minus @var{offset} is put into the output file,
3185 and the line after that begins the next section of input.
3186
3187 @item %@var{regexp}%[@var{offset}]
3188 Like the previous type, except that it does not create an output
3189 file, so that section of the input file is effectively ignored.
3190
3191 @item @{@var{repeat-count}@}
3192 Repeat the previous pattern @var{repeat-count} additional
3193 times.  The @var{repeat-count} can either be a positive integer or an
3194 asterisk, meaning repeat as many times as necessary until the input is
3195 exhausted.
3196
3197 @end table
3198
3199 The output files' names consist of a prefix (@samp{xx} by default)
3200 followed by a suffix.  By default, the suffix is an ascending sequence
3201 of two-digit decimal numbers from @samp{00} to @samp{99}.  In any case,
3202 concatenating the output files in sorted order by file name produces the
3203 original input file.
3204
3205 By default, if @command{csplit} encounters an error or receives a hangup,
3206 interrupt, quit, or terminate signal, it removes any output files
3207 that it has created so far before it exits.
3208
3209 The program accepts the following options.  Also see @ref{Common options}.
3210
3211 @table @samp
3212
3213 @item -f @var{prefix}
3214 @itemx --prefix=@var{prefix}
3215 @opindex -f
3216 @opindex --prefix
3217 @cindex output file name prefix
3218 Use @var{prefix} as the output file name prefix.
3219
3220 @item -b @var{suffix}
3221 @itemx --suffix=@var{suffix}
3222 @opindex -b
3223 @opindex --suffix
3224 @cindex output file name suffix
3225 Use @var{suffix} as the output file name suffix.  When this option is
3226 specified, the suffix string must include exactly one
3227 @code{printf(3)}-style conversion specification, possibly including
3228 format specification flags, a field width, a precision specifications,
3229 or all of these kinds of modifiers.  The format letter must convert a
3230 binary unsigned integer argument to readable form.  The format letters
3231 @samp{d} and @samp{i} are aliases for @samp{u}, and the
3232 @samp{u}, @samp{o}, @samp{x}, and @samp{X} conversions are allowed.  The
3233 entire @var{suffix} is given (with the current output file number) to
3234 @code{sprintf(3)} to form the file name suffixes for each of the
3235 individual output files in turn.  If this option is used, the
3236 @option{--digits} option is ignored.
3237
3238 @item -n @var{digits}
3239 @itemx --digits=@var{digits}
3240 @opindex -n
3241 @opindex --digits
3242 Use output file names containing numbers that are @var{digits} digits
3243 long instead of the default 2.
3244
3245 @item -k
3246 @itemx --keep-files
3247 @opindex -k
3248 @opindex --keep-files
3249 Do not remove output files when errors are encountered.
3250
3251 @item -z
3252 @itemx --elide-empty-files
3253 @opindex -z
3254 @opindex --elide-empty-files
3255 Suppress the generation of zero-length output files.  (In cases where
3256 the section delimiters of the input file are supposed to mark the first
3257 lines of each of the sections, the first output file will generally be a
3258 zero-length file unless you use this option.)  The output file sequence
3259 numbers always run consecutively starting from 0, even when this option
3260 is specified.
3261
3262 @item -s
3263 @itemx -q
3264 @itemx --silent
3265 @itemx --quiet
3266 @opindex -s
3267 @opindex -q
3268 @opindex --silent
3269 @opindex --quiet
3270 Do not print counts of output file sizes.
3271
3272 @end table
3273
3274 @exitstatus
3275
3276 Here is an example of its usage.
3277 First, create an empty directory for the exercise,
3278 and cd into it:
3279
3280 @example
3281 $ mkdir d && cd d
3282 @end example
3283
3284 Now, split the sequence of 1..14 on lines that end with 0 or 5:
3285
3286 @example
3287 $ seq 14 | csplit - '/[05]$/' '@{*@}'
3288 8
3289 10
3290 15
3291 @end example
3292
3293 Each number printed above is the size of an output
3294 file that csplit has just created.
3295 List the names of those output files:
3296
3297 @example
3298 $ ls
3299 xx00  xx01  xx02
3300 @end example
3301
3302 Use @command{head} to show their contents:
3303
3304 @example
3305 $ head xx*
3306 ==> xx00 <==
3307 1
3308 2
3309 3
3310 4
3311
3312 ==> xx01 <==
3313 5
3314 6
3315 7
3316 8
3317 9
3318
3319 ==> xx02 <==
3320 10
3321 11
3322 12
3323 13
3324 14
3325 @end example
3326
3327 @node Summarizing files
3328 @chapter Summarizing files
3329
3330 @cindex summarizing files
3331
3332 These commands generate just a few numbers representing entire
3333 contents of files.
3334
3335 @menu
3336 * wc invocation::               Print newline, word, and byte counts.
3337 * sum invocation::              Print checksum and block counts.
3338 * cksum invocation::            Print CRC checksum and byte counts.
3339 * md5sum invocation::           Print or check MD5 digests.
3340 * sha1sum invocation::          Print or check SHA-1 digests.
3341 * sha2 utilities::              Print or check SHA-2 digests.
3342 @end menu
3343
3344
3345 @node wc invocation
3346 @section @command{wc}: Print newline, word, and byte counts
3347
3348 @pindex wc
3349 @cindex byte count
3350 @cindex character count
3351 @cindex word count
3352 @cindex line count
3353
3354 @command{wc} counts the number of bytes, characters, whitespace-separated
3355 words, and newlines in each given @var{file}, or standard input if none
3356 are given or for a @var{file} of @samp{-}.  Synopsis:
3357
3358 @example
3359 wc [@var{option}]@dots{} [@var{file}]@dots{}
3360 @end example
3361
3362 @cindex total counts
3363 @command{wc} prints one line of counts for each file, and if the file was
3364 given as an argument, it prints the file name following the counts.  If
3365 more than one @var{file} is given, @command{wc} prints a final line
3366 containing the cumulative counts, with the file name @file{total}.  The
3367 counts are printed in this order: newlines, words, characters, bytes,
3368 maximum line length.
3369 Each count is printed right-justified in a field with at least one
3370 space between fields so that the numbers and file names normally line
3371 up nicely in columns.  The width of the count fields varies depending
3372 on the inputs, so you should not depend on a particular field width.
3373 However, as a @acronym{GNU} extension, if only one count is printed,
3374 it is guaranteed to be printed without leading spaces.
3375
3376 By default, @command{wc} prints three counts: the newline, words, and byte
3377 counts.  Options can specify that only certain counts be printed.
3378 Options do not undo others previously given, so
3379
3380 @example
3381 wc --bytes --words
3382 @end example
3383
3384 @noindent
3385 prints both the byte counts and the word counts.
3386
3387 With the @option{--max-line-length} option, @command{wc} prints the length
3388 of the longest line per file, and if there is more than one file it
3389 prints the maximum (not the sum) of those lengths.  The line lengths here
3390 are measured in screen columns, according to the current locale and
3391 assuming tab positions in every 8th column.
3392
3393 The program accepts the following options.  Also see @ref{Common options}.
3394
3395 @table @samp
3396
3397 @item -c
3398 @itemx --bytes
3399 @opindex -c
3400 @opindex --bytes
3401 Print only the byte counts.
3402
3403 @item -m
3404 @itemx --chars
3405 @opindex -m
3406 @opindex --chars
3407 Print only the character counts.
3408
3409 @item -w
3410 @itemx --words
3411 @opindex -w
3412 @opindex --words
3413 Print only the word counts.
3414
3415 @item -l
3416 @itemx --lines
3417 @opindex -l
3418 @opindex --lines
3419 Print only the newline counts.
3420
3421 @item -L
3422 @itemx --max-line-length
3423 @opindex -L
3424 @opindex --max-line-length
3425 Print only the maximum line lengths.
3426
3427 @macro filesZeroFromOption{cmd,withTotalOption,subListOutput}
3428 @itemx --files0-from=@var{file}
3429 @opindex --files0-from=@var{file}
3430 @c This is commented out to avoid a texi2dvi failure.
3431 @c texi2dvi (GNU Texinfo 4.11) 1.104
3432 @c @cindex including files from @command{\cmd\}
3433 Disallow processing files named on the command line, and instead process
3434 those named in file @var{file}; each name being terminated by a zero byte
3435 (@acronym{ASCII} @sc{nul}).
3436 This is useful \withTotalOption\
3437 when the list of file names is so long that it may exceed a command line
3438 length limitation.
3439 In such cases, running @command{\cmd\} via @command{xargs} is undesirable
3440 because it splits the list into pieces and makes @command{\cmd\} print
3441 \subListOutput\ for each sublist rather than for the entire list.
3442 One way to produce a list of @acronym{ASCII} @sc{nul} terminated file
3443 names is with @sc{gnu}
3444 @command{find}, using its @option{-print0} predicate.
3445 If @var{file} is @samp{-} then the @acronym{ASCII} @sc{nul} terminated
3446 file names are read from standard input.
3447 @end macro
3448 @filesZeroFromOption{wc,,a total}
3449
3450 For example, to find the length of the longest line in any @file{.c} or
3451 @file{.h} file in the current hierarchy, do this:
3452
3453 @example
3454 find . -name '*.[ch]' -print0 |
3455   wc -L --files0-from=- | tail -n1
3456 @end example
3457
3458 @end table
3459
3460 @exitstatus
3461
3462
3463 @node sum invocation
3464 @section @command{sum}: Print checksum and block counts
3465
3466 @pindex sum
3467 @cindex 16-bit checksum
3468 @cindex checksum, 16-bit
3469
3470 @command{sum} computes a 16-bit checksum for each given @var{file}, or
3471 standard input if none are given or for a @var{file} of @samp{-}.  Synopsis:
3472
3473 @example
3474 sum [@var{option}]@dots{} [@var{file}]@dots{}
3475 @end example
3476
3477 @command{sum} prints the checksum for each @var{file} followed by the
3478 number of blocks in the file (rounded up).  If more than one @var{file}
3479 is given, file names are also printed (by default).  (With the
3480 @option{--sysv} option, corresponding file names are printed when there is
3481 at least one file argument.)
3482
3483 By default, @sc{gnu} @command{sum} computes checksums using an algorithm
3484 compatible with BSD @command{sum} and prints file sizes in units of
3485 1024-byte blocks.
3486
3487 The program accepts the following options.  Also see @ref{Common options}.
3488
3489 @table @samp
3490
3491 @item -r
3492 @opindex -r
3493 @cindex BSD @command{sum}
3494 Use the default (BSD compatible) algorithm.  This option is included for
3495 compatibility with the System V @command{sum}.  Unless @option{-s} was also
3496 given, it has no effect.
3497
3498 @item -s
3499 @itemx --sysv
3500 @opindex -s
3501 @opindex --sysv
3502 @cindex System V @command{sum}
3503 Compute checksums using an algorithm compatible with System V
3504 @command{sum}'s default, and print file sizes in units of 512-byte blocks.
3505
3506 @end table
3507
3508 @command{sum} is provided for compatibility; the @command{cksum} program (see
3509 next section) is preferable in new applications.
3510
3511 @exitstatus
3512
3513
3514 @node cksum invocation
3515 @section @command{cksum}: Print CRC checksum and byte counts
3516
3517 @pindex cksum
3518 @cindex cyclic redundancy check
3519 @cindex CRC checksum
3520
3521 @command{cksum} computes a cyclic redundancy check (CRC) checksum for each
3522 given @var{file}, or standard input if none are given or for a
3523 @var{file} of @samp{-}.  Synopsis:
3524
3525 @example
3526 cksum [@var{option}]@dots{} [@var{file}]@dots{}
3527 @end example
3528
3529 @command{cksum} prints the CRC checksum for each file along with the number
3530 of bytes in the file, and the file name unless no arguments were given.
3531
3532 @command{cksum} is typically used to ensure that files
3533 transferred by unreliable means (e.g., netnews) have not been corrupted,
3534 by comparing the @command{cksum} output for the received files with the
3535 @command{cksum} output for the original files (typically given in the
3536 distribution).
3537
3538 The CRC algorithm is specified by the @acronym{POSIX} standard.  It is not
3539 compatible with the BSD or System V @command{sum} algorithms (see the
3540 previous section); it is more robust.
3541
3542 The only options are @option{--help} and @option{--version}.  @xref{Common
3543 options}.
3544
3545 @exitstatus
3546
3547
3548 @node md5sum invocation
3549 @section @command{md5sum}: Print or check MD5 digests
3550
3551 @pindex md5sum
3552 @cindex MD5
3553 @cindex 128-bit checksum
3554 @cindex checksum, 128-bit
3555 @cindex fingerprint, 128-bit
3556 @cindex message-digest, 128-bit
3557
3558 @command{md5sum} computes a 128-bit checksum (or @dfn{fingerprint} or
3559 @dfn{message-digest}) for each specified @var{file}.
3560
3561 Note: The MD5 digest is more reliable than a simple CRC (provided by
3562 the @command{cksum} command) for detecting accidental file corruption,
3563 as the chances of accidentally having two files with identical MD5
3564 are vanishingly small.  However, it should not be considered secure
3565 against malicious tampering: although finding a file with a given MD5
3566 fingerprint is considered infeasible at the moment, it is known how
3567 to modify certain files, including digital certificates, so that they
3568 appear valid when signed with an MD5 digest.
3569 For more secure hashes, consider using SHA-2.  @xref{sha2 utilities}.
3570
3571 If a @var{file} is specified as @samp{-} or if no files are given
3572 @command{md5sum} computes the checksum for the standard input.
3573 @command{md5sum} can also determine whether a file and checksum are
3574 consistent.  Synopsis:
3575
3576 @example
3577 md5sum [@var{option}]@dots{} [@var{file}]@dots{}
3578 @end example
3579
3580 For each @var{file}, @samp{md5sum} outputs the MD5 checksum, a flag
3581 indicating a binary or text input file, and the file name.
3582 If @var{file} contains a backslash or newline, the
3583 line is started with a backslash, and each problematic character in
3584 the file name is escaped with a backslash, making the output
3585 unambiguous even in the presence of arbitrary file names.
3586 If @var{file} is omitted or specified as @samp{-}, standard input is read.
3587
3588 The program accepts the following options.  Also see @ref{Common options}.
3589
3590 @table @samp
3591
3592 @item -b
3593 @itemx --binary
3594 @opindex -b
3595 @opindex --binary
3596 @cindex binary input files
3597 Treat each input file as binary, by reading it in binary mode and
3598 outputting a @samp{*} flag.  This is the inverse of @option{--text}.
3599 On systems like @acronym{GNU} that do not distinguish between binary
3600 and text files, this option merely flags each input file as binary:
3601 the MD5 checksum is unaffected.  This option is the default on systems
3602 like MS-DOS that distinguish between binary and text files, except
3603 for reading standard input when standard input is a terminal.
3604
3605 @item -c
3606 @itemx --check
3607 Read file names and checksum information (not data) from each
3608 @var{file} (or from stdin if no @var{file} was specified) and report
3609 whether the checksums match the contents of the named files.
3610 The input to this mode of @command{md5sum} is usually the output of
3611 a prior, checksum-generating run of @samp{md5sum}.
3612 Each valid line of input consists of an MD5 checksum, a binary/text
3613 flag, and then a file name.
3614 Binary files are marked with @samp{*}, text with @samp{ }.
3615 For each such line, @command{md5sum} reads the named file and computes its
3616 MD5 checksum.  Then, if the computed message digest does not match the
3617 one on the line with the file name, the file is noted as having
3618 failed the test.  Otherwise, the file passes the test.
3619 By default, for each valid line, one line is written to standard
3620 output indicating whether the named file passed the test.
3621 After all checks have been performed, if there were any failures,
3622 a warning is issued to standard error.
3623 Use the @option{--status} option to inhibit that output.
3624 If any listed file cannot be opened or read, if any valid line has
3625 an MD5 checksum inconsistent with the associated file, or if no valid
3626 line is found, @command{md5sum} exits with nonzero status.  Otherwise,
3627 it exits successfully.
3628
3629 @itemx --quiet
3630 @opindex --quiet
3631 @cindex verifying MD5 checksums
3632 This option is useful only when verifying checksums.
3633 When verifying checksums, don't generate an 'OK' message per successfully
3634 checked file.  Files that fail the verification are reported in the
3635 default one-line-per-file format.  If there is any checksum mismatch,
3636 print a warning summarizing the failures to standard error.
3637
3638 @itemx --status
3639 @opindex --status
3640 @cindex verifying MD5 checksums
3641 This option is useful only when verifying checksums.
3642 When verifying checksums, don't generate the default one-line-per-file
3643 diagnostic and don't output the warning summarizing any failures.
3644 Failures to open or read a file still evoke individual diagnostics to
3645 standard error.
3646 If all listed files are readable and are consistent with the associated
3647 MD5 checksums, exit successfully.  Otherwise exit with a status code
3648 indicating there was a failure.
3649
3650 @item -t
3651 @itemx --text
3652 @opindex -t
3653 @opindex --text
3654 @cindex text input files
3655 Treat each input file as text, by reading it in text mode and
3656 outputting a @samp{ } flag.  This is the inverse of @option{--binary}.
3657 This option is the default on systems like @acronym{GNU} that do not
3658 distinguish between binary and text files.  On other systems, it is
3659 the default for reading standard input when standard input is a
3660 terminal.
3661
3662 @item -w
3663 @itemx --warn
3664 @opindex -w
3665 @opindex --warn
3666 @cindex verifying MD5 checksums
3667 When verifying checksums, warn about improperly formatted MD5 checksum lines.
3668 This option is useful only if all but a few lines in the checked input
3669 are valid.
3670
3671 @end table
3672
3673 @exitstatus
3674
3675
3676 @node sha1sum invocation
3677 @section @command{sha1sum}: Print or check SHA-1 digests
3678
3679 @pindex sha1sum
3680 @cindex SHA-1
3681 @cindex 160-bit checksum
3682 @cindex checksum, 160-bit
3683 @cindex fingerprint, 160-bit
3684 @cindex message-digest, 160-bit
3685
3686 @command{sha1sum} computes a 160-bit checksum for each specified
3687 @var{file}.  The usage and options of this command are precisely the
3688 same as for @command{md5sum}.  @xref{md5sum invocation}.
3689
3690 Note: The SHA-1 digest is more secure than MD5, and no collisions of
3691 it are known (different files having the same fingerprint).  However,
3692 it is known that they can be produced with considerable, but not
3693 unreasonable, resources.  For this reason, it is generally considered
3694 that SHA-1 should be gradually phased out in favor of the more secure
3695 SHA-2 hash algorithms.  @xref{sha2 utilities}.
3696
3697
3698 @node sha2 utilities
3699 @section sha2 utilities: Print or check SHA-2 digests
3700
3701 @pindex sha224sum
3702 @pindex sha256sum
3703 @pindex sha384sum
3704 @pindex sha512sum
3705 @cindex SHA-2
3706 @cindex 224-bit checksum
3707 @cindex 256-bit checksum
3708 @cindex 384-bit checksum
3709 @cindex 512-bit checksum
3710 @cindex checksum, 224-bit
3711 @cindex checksum, 256-bit
3712 @cindex checksum, 384-bit
3713 @cindex checksum, 512-bit
3714 @cindex fingerprint, 224-bit
3715 @cindex fingerprint, 256-bit
3716 @cindex fingerprint, 384-bit
3717 @cindex fingerprint, 512-bit
3718 @cindex message-digest, 224-bit
3719 @cindex message-digest, 256-bit
3720 @cindex message-digest, 384-bit
3721 @cindex message-digest, 512-bit
3722
3723 The commands @command{sha224sum}, @command{sha256sum},
3724 @command{sha384sum} and @command{sha512sum} compute checksums of
3725 various lengths (respectively 224, 256, 384 and 512 bits),
3726 collectively known as the SHA-2 hashes.  The usage and options of
3727 these commands are precisely the same as for @command{md5sum}.
3728 @xref{md5sum invocation}.
3729
3730 Note: The SHA384 and SHA512 digests are considerably slower to
3731 compute, especially on 32-bit computers, than SHA224 or SHA256.
3732
3733
3734 @node Operating on sorted files
3735 @chapter Operating on sorted files
3736
3737 @cindex operating on sorted files
3738 @cindex sorted files, operations on
3739
3740 These commands work with (or produce) sorted files.
3741
3742 @menu
3743 * sort invocation::             Sort text files.
3744 * shuf invocation::             Shuffle text files.
3745 * uniq invocation::             Uniquify files.
3746 * comm invocation::             Compare two sorted files line by line.
3747 * ptx invocation::              Produce a permuted index of file contents.
3748 * tsort invocation::            Topological sort.
3749 @end menu
3750
3751
3752 @node sort invocation
3753 @section @command{sort}: Sort text files
3754
3755 @pindex sort
3756 @cindex sorting files
3757
3758 @command{sort} sorts, merges, or compares all the lines from the given
3759 files, or standard input if none are given or for a @var{file} of
3760 @samp{-}.  By default, @command{sort} writes the results to standard
3761 output.  Synopsis:
3762
3763 @example
3764 sort [@var{option}]@dots{} [@var{file}]@dots{}
3765 @end example
3766
3767 @command{sort} has three modes of operation: sort (the default), merge,
3768 and check for sortedness.  The following options change the operation
3769 mode:
3770
3771 @table @samp
3772
3773 @item -c
3774 @itemx --check
3775 @itemx --check=diagnose-first
3776 @opindex -c
3777 @opindex --check
3778 @cindex checking for sortedness
3779 Check whether the given file is already sorted: if it is not all
3780 sorted, print a diagnostic containing the first out-of-order line and
3781 exit with a status of 1.
3782 Otherwise, exit successfully.
3783 At most one input file can be given.
3784
3785 @item -C
3786 @itemx --check=quiet
3787 @itemx --check=silent
3788 @opindex -c
3789 @opindex --check
3790 @cindex checking for sortedness
3791 Exit successfully if the given file is already sorted, and
3792 exit with status 1 otherwise.
3793 At most one input file can be given.
3794 This is like @option{-c}, except it does not print a diagnostic.
3795
3796 @item -m
3797 @itemx --merge
3798 @opindex -m
3799 @opindex --merge
3800 @cindex merging sorted files
3801 Merge the given files by sorting them as a group.  Each input file must
3802 always be individually sorted.  It always works to sort instead of
3803 merge; merging is provided because it is faster, in the case where it
3804 works.
3805
3806 @end table
3807
3808 @cindex sort stability
3809 @cindex sort's last-resort comparison
3810 A pair of lines is compared as follows:
3811 @command{sort} compares each pair of fields, in the
3812 order specified on the command line, according to the associated
3813 ordering options, until a difference is found or no fields are left.
3814 If no key fields are specified, @command{sort} uses a default key of
3815 the entire line.  Finally, as a last resort when all keys compare
3816 equal, @command{sort} compares entire lines as if no ordering options
3817 other than @option{--reverse} (@option{-r}) were specified.  The
3818 @option{--stable} (@option{-s}) option disables this @dfn{last-resort
3819 comparison} so that lines in which all fields compare equal are left
3820 in their original relative order.  The @option{--unique}
3821 (@option{-u}) option also disables the last-resort comparison.
3822
3823 @vindex LC_ALL
3824 @vindex LC_COLLATE
3825 Unless otherwise specified, all comparisons use the character collating
3826 sequence specified by the @env{LC_COLLATE} locale.@footnote{If you
3827 use a non-@acronym{POSIX} locale (e.g., by setting @env{LC_ALL}
3828 to @samp{en_US}), then @command{sort} may produce output that is sorted
3829 differently than you're accustomed to.  In that case, set the @env{LC_ALL}
3830 environment variable to @samp{C}.  Note that setting only @env{LC_COLLATE}
3831 has two problems.  First, it is ineffective if @env{LC_ALL} is also set.
3832 Second, it has undefined behavior if @env{LC_CTYPE} (or @env{LANG}, if
3833 @env{LC_CTYPE} is unset) is set to an incompatible value.  For example,
3834 you get undefined behavior if @env{LC_CTYPE} is @code{ja_JP.PCK} but
3835 @env{LC_COLLATE} is @code{en_US.UTF-8}.}
3836
3837 @sc{gnu} @command{sort} (as specified for all @sc{gnu} utilities) has no
3838 limit on input line length or restrictions on bytes allowed within lines.
3839 In addition, if the final byte of an input file is not a newline, @sc{gnu}
3840 @command{sort} silently supplies one.  A line's trailing newline is not
3841 part of the line for comparison purposes.
3842
3843 @cindex exit status of @command{sort}
3844 Exit status:
3845
3846 @display
3847 0 if no error occurred
3848 1 if invoked with @option{-c} or @option{-C} and the input is not sorted
3849 2 if an error occurred
3850 @end display
3851
3852 @vindex TMPDIR
3853 If the environment variable @env{TMPDIR} is set, @command{sort} uses its
3854 value as the directory for temporary files instead of @file{/tmp}.  The
3855 @option{--temporary-directory} (@option{-T}) option in turn overrides
3856 the environment variable.
3857
3858 The following options affect the ordering of output lines.  They may be
3859 specified globally or as part of a specific key field.  If no key
3860 fields are specified, global options apply to comparison of entire
3861 lines; otherwise the global options are inherited by key fields that do
3862 not specify any special options of their own.  In pre-@acronym{POSIX}
3863 versions of @command{sort}, global options affect only later key fields,
3864 so portable shell scripts should specify global options first.
3865
3866 @table @samp
3867
3868 @item -b
3869 @itemx --ignore-leading-blanks
3870 @opindex -b
3871 @opindex --ignore-leading-blanks
3872 @cindex blanks, ignoring leading
3873 @vindex LC_CTYPE
3874 Ignore leading blanks when finding sort keys in each line.
3875 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
3876 can change this.  Note blanks may be ignored by your locale's collating
3877 rules, but without this option they will be significant for character
3878 positions specified in keys with the @option{-k} option.
3879
3880 @item -d
3881 @itemx --dictionary-order
3882 @opindex -d
3883 @opindex --dictionary-order
3884 @cindex dictionary order
3885 @cindex phone directory order
3886 @cindex telephone directory order
3887 @vindex LC_CTYPE
3888 Sort in @dfn{phone directory} order: ignore all characters except
3889 letters, digits and blanks when sorting.
3890 By default letters and digits are those of @acronym{ASCII} and a blank
3891 is a space or a tab, but the @env{LC_CTYPE} locale can change this.
3892
3893 @item -f
3894 @itemx --ignore-case
3895 @opindex -f
3896 @opindex --ignore-case
3897 @cindex ignoring case
3898 @cindex case folding
3899 @vindex LC_CTYPE
3900 Fold lowercase characters into the equivalent uppercase characters when
3901 comparing so that, for example, @samp{b} and @samp{B} sort as equal.
3902 The @env{LC_CTYPE} locale determines character types.
3903 When used with @option{--unique} those lower case equivalent lines are
3904 thrown away. (There is currently no way to throw away the upper case
3905 equivalent instead. (Any @option{--reverse} given would only affect
3906 the final result, after the throwing away.))
3907
3908 @item -g
3909 @itemx --general-numeric-sort
3910 @itemx --sort=general-numeric
3911 @opindex -g
3912 @opindex --general-numeric-sort
3913 @opindex --sort
3914 @cindex general numeric sort
3915 @vindex LC_NUMERIC
3916 Sort numerically, converting a prefix of each line to a long
3917 double-precision floating point number.  @xref{Floating point}.
3918 Do not report overflow, underflow, or conversion errors.
3919 Use the following collating sequence:
3920
3921 @itemize @bullet
3922 @item
3923 Lines that do not start with numbers (all considered to be equal).
3924 @item
3925 NaNs (``Not a Number'' values, in IEEE floating point arithmetic)
3926 in a consistent but machine-dependent order.
3927 @item
3928 Minus infinity.
3929 @item
3930 Finite numbers in ascending numeric order (with @math{-0} and @math{+0} equal).
3931 @item
3932 Plus infinity.
3933 @end itemize
3934
3935 Use this option only if there is no alternative; it is much slower than
3936 @option{--numeric-sort} (@option{-n}) and it can lose information when
3937 converting to floating point.
3938
3939 @item -h
3940 @itemx --human-numeric-sort
3941 @itemx --sort=human-numeric
3942 @opindex -h
3943 @opindex --human-numeric-sort
3944 @opindex --sort
3945 @cindex human numeric sort
3946 @vindex LC_NUMERIC
3947 Sort numerically, first by numeric sign (negative, zero, or positive);
3948 then by @acronym{SI} suffix (either empty, or @samp{k} or @samp{K}, or
3949 one of @samp{MGTPEZY}, in that order; @pxref{Block size}); and finally
3950 by numeric value.  For example, @samp{1023M} sorts before @samp{1G}
3951 because @samp{M} (mega) precedes @samp{G} (giga) as an @acronym{SI}
3952 suffix.  This option sorts values that are consistently scaled to the
3953 nearest suffix, regardless of whether suffixes denote powers of 1000
3954 or 1024, and it therefore sorts the output of any single invocation of
3955 the @command{df}, @command{du}, or @command{ls} commands that are
3956 invoked with their @option{--human-readable} or @option{--si} options.
3957 The syntax for numbers is the same as for the @option{--numeric-sort}
3958 option; the @acronym{SI} suffix must immediately follow the number.
3959
3960 @item -i
3961 @itemx --ignore-nonprinting
3962 @opindex -i
3963 @opindex --ignore-nonprinting
3964 @cindex nonprinting characters, ignoring
3965 @cindex unprintable characters, ignoring
3966 @vindex LC_CTYPE
3967 Ignore nonprinting characters.
3968 The @env{LC_CTYPE} locale determines character types.
3969 This option has no effect if the stronger @option{--dictionary-order}
3970 (@option{-d}) option is also given.
3971
3972 @item -M
3973 @itemx --month-sort
3974 @itemx --sort=month
3975 @opindex -M
3976 @opindex --month-sort
3977 @opindex --sort
3978 @cindex months, sorting by
3979 @vindex LC_TIME
3980 An initial string, consisting of any amount of blanks, followed
3981 by a month name abbreviation, is folded to UPPER case and
3982 compared in the order @samp{JAN} < @samp{FEB} < @dots{} < @samp{DEC}.
3983 Invalid names compare low to valid names.  The @env{LC_TIME} locale
3984 category determines the month spellings.
3985 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
3986 can change this.
3987
3988 @item -n
3989 @itemx --numeric-sort
3990 @itemx --sort=numeric
3991 @opindex -n
3992 @opindex --numeric-sort
3993 @opindex --sort
3994 @cindex numeric sort
3995 @vindex LC_NUMERIC
3996 Sort numerically.  The number begins each line and consists
3997 of optional blanks, an optional @samp{-} sign, and zero or more
3998 digits possibly separated by thousands separators, optionally followed
3999 by a decimal-point character and zero or more digits.  An empty
4000 number is treated as @samp{0}.  The @env{LC_NUMERIC}
4001 locale specifies the decimal-point character and thousands separator.
4002 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
4003 can change this.
4004
4005 Comparison is exact; there is no rounding error.
4006
4007 Neither a leading @samp{+} nor exponential notation is recognized.
4008 To compare such strings numerically, use the
4009 @option{--general-numeric-sort} (@option{-g}) option.
4010
4011 @item -V
4012 @itemx --version-sort
4013 @opindex -V
4014 @opindex --version-sort
4015 @cindex version number sort
4016 Sort by version name and number.  It behaves like a standard sort,
4017 except that each sequence of decimal digits is treated numerically
4018 as an index/version number.  (@xref{Details about version sort}.)
4019
4020 @item -r
4021 @itemx --reverse
4022 @opindex -r
4023 @opindex --reverse
4024 @cindex reverse sorting
4025 Reverse the result of comparison, so that lines with greater key values
4026 appear earlier in the output instead of later.
4027
4028 @item -R
4029 @itemx --random-sort
4030 @itemx --sort=random
4031 @opindex -R
4032 @opindex --random-sort
4033 @opindex --sort
4034 @cindex random sort
4035 Sort by hashing the input keys and then sorting the hash values.
4036 Choose the hash function at random, ensuring that it is free of
4037 collisions so that differing keys have differing hash values.  This is
4038 like a random permutation of the inputs (@pxref{shuf invocation}),
4039 except that keys with the same value sort together.
4040
4041 If multiple random sort fields are specified, the same random hash
4042 function is used for all fields.  To use different random hash
4043 functions for different fields, you can invoke @command{sort} more
4044 than once.
4045
4046 The choice of hash function is affected by the
4047 @option{--random-source} option.
4048
4049 @end table
4050
4051 Other options are:
4052
4053 @table @samp
4054
4055 @item --compress-program=@var{prog}
4056 Compress any temporary files with the program @var{prog}.
4057
4058 With no arguments, @var{prog} must compress standard input to standard
4059 output, and when given the @option{-d} option it must decompress
4060 standard input to standard output.
4061
4062 Terminate with an error if @var{prog} exits with nonzero status.
4063
4064 White space and the backslash character should not appear in
4065 @var{prog}; they are reserved for future use.
4066
4067 @filesZeroFromOption{sort,,sorted output}
4068
4069 @item -k @var{pos1}[,@var{pos2}]
4070 @itemx --key=@var{pos1}[,@var{pos2}]
4071 @opindex -k
4072 @opindex --key
4073 @cindex sort field
4074 Specify a sort field that consists of the part of the line between
4075 @var{pos1} and @var{pos2} (or the end of the line, if @var{pos2} is
4076 omitted), @emph{inclusive}.
4077
4078 Each @var{pos} has the form @samp{@var{f}[.@var{c}][@var{opts}]},
4079 where @var{f} is the number of the field to use, and @var{c} is the number
4080 of the first character from the beginning of the field.  Fields and character
4081 positions are numbered starting with 1; a character position of zero in
4082 @var{pos2} indicates the field's last character.  If @samp{.@var{c}} is
4083 omitted from @var{pos1}, it defaults to 1 (the beginning of the field);
4084 if omitted from @var{pos2}, it defaults to 0 (the end of the field).
4085 @var{opts} are ordering options, allowing individual keys to be sorted
4086 according to different rules; see below for details.  Keys can span
4087 multiple fields.
4088
4089 Example:  To sort on the second field, use @option{--key=2,2}
4090 (@option{-k 2,2}).  See below for more notes on keys and more examples.
4091 See also the @option{--debug} option to help determine the part
4092 of the line being used in the sort.
4093
4094 @item --debug
4095 Highlight the portion of each line used for sorting.
4096 Also issue warnings about questionable usage to stderr.
4097
4098 @item --batch-size=@var{nmerge}
4099 @opindex --batch-size
4100 @cindex number of inputs to merge, nmerge
4101 Merge at most @var{nmerge} inputs at once.
4102
4103 When @command{sort} has to merge more than @var{nmerge} inputs,
4104 it merges them in groups of @var{nmerge}, saving the result in
4105 a temporary file, which is then used as an input in a subsequent merge.
4106
4107 A large value of @var{nmerge} may improve merge performance and decrease
4108 temporary storage utilization at the expense of increased memory usage
4109 and I/0.  Conversely a small value of @var{nmerge} may reduce memory
4110 requirements and I/0 at the expense of temporary storage consumption and
4111 merge performance.
4112
4113 The value of @var{nmerge} must be at least 2.  The default value is
4114 currently 16, but this is implementation-dependent and may change in
4115 the future.
4116
4117 The value of @var{nmerge} may be bounded by a resource limit for open
4118 file descriptors.  The commands @samp{ulimit -n} or @samp{getconf
4119 OPEN_MAX} may display limits for your systems; these limits may be
4120 modified further if your program already has some files open, or if
4121 the operating system has other limits on the number of open files.  If
4122 the value of @var{nmerge} exceeds the resource limit, @command{sort}
4123 silently uses a smaller value.
4124
4125 @item -o @var{output-file}
4126 @itemx --output=@var{output-file}
4127 @opindex -o
4128 @opindex --output
4129 @cindex overwriting of input, allowed
4130 Write output to @var{output-file} instead of standard output.
4131 Normally, @command{sort} reads all input before opening
4132 @var{output-file}, so you can safely sort a file in place by using
4133 commands like @code{sort -o F F} and @code{cat F | sort -o F}.
4134 However, @command{sort} with @option{--merge} (@option{-m}) can open
4135 the output file before reading all input, so a command like @code{cat
4136 F | sort -m -o F - G} is not safe as @command{sort} might start
4137 writing @file{F} before @command{cat} is done reading it.
4138
4139 @vindex POSIXLY_CORRECT
4140 On newer systems, @option{-o} cannot appear after an input file if
4141 @env{POSIXLY_CORRECT} is set, e.g., @samp{sort F -o F}.  Portable
4142 scripts should specify @option{-o @var{output-file}} before any input
4143 files.
4144
4145 @item --random-source=@var{file}
4146 @opindex --random-source
4147 @cindex random source for sorting
4148 Use @var{file} as a source of random data used to determine which
4149 random hash function to use with the @option{-R} option.  @xref{Random
4150 sources}.
4151
4152 @item -s
4153 @itemx --stable
4154 @opindex -s
4155 @opindex --stable
4156 @cindex sort stability
4157 @cindex sort's last-resort comparison
4158
4159 Make @command{sort} stable by disabling its last-resort comparison.
4160 This option has no effect if no fields or global ordering options
4161 other than @option{--reverse} (@option{-r}) are specified.
4162
4163 @item -S @var{size}
4164 @itemx --buffer-size=@var{size}
4165 @opindex -S
4166 @opindex --buffer-size
4167 @cindex size for main memory sorting
4168 Use a main-memory sort buffer of the given @var{size}.  By default,
4169 @var{size} is in units of 1024 bytes.  Appending @samp{%} causes
4170 @var{size} to be interpreted as a percentage of physical memory.
4171 Appending @samp{K} multiplies @var{size} by 1024 (the default),
4172 @samp{M} by 1,048,576, @samp{G} by 1,073,741,824, and so on for
4173 @samp{T}, @samp{P}, @samp{E}, @samp{Z}, and @samp{Y}.  Appending
4174 @samp{b} causes @var{size} to be interpreted as a byte count, with no
4175 multiplication.
4176
4177 This option can improve the performance of @command{sort} by causing it
4178 to start with a larger or smaller sort buffer than the default.
4179 However, this option affects only the initial buffer size.  The buffer
4180 grows beyond @var{size} if @command{sort} encounters input lines larger
4181 than @var{size}.
4182
4183 @item -t @var{separator}
4184 @itemx --field-separator=@var{separator}
4185 @opindex -t
4186 @opindex --field-separator
4187 @cindex field separator character
4188 Use character @var{separator} as the field separator when finding the
4189 sort keys in each line.  By default, fields are separated by the empty
4190 string between a non-blank character and a blank character.
4191 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
4192 can change this.
4193
4194 That is, given the input line @w{@samp{ foo bar}}, @command{sort} breaks it
4195 into fields @w{@samp{ foo}} and @w{@samp{ bar}}.  The field separator is
4196 not considered to be part of either the field preceding or the field
4197 following, so with @samp{sort @w{-t " "}} the same input line has
4198 three fields: an empty field, @samp{foo}, and @samp{bar}.
4199 However, fields that extend to the end of the line,
4200 as @option{-k 2}, or fields consisting of a range, as @option{-k 2,3},
4201 retain the field separators present between the endpoints of the range.
4202
4203 To specify @acronym{ASCII} @sc{nul} as the field separator,
4204 use the two-character string @samp{\0}, e.g., @samp{sort -t '\0'}.
4205
4206 @item -T @var{tempdir}
4207 @itemx --temporary-directory=@var{tempdir}
4208 @opindex -T
4209 @opindex --temporary-directory
4210 @cindex temporary directory
4211 @vindex TMPDIR
4212 Use directory @var{tempdir} to store temporary files, overriding the
4213 @env{TMPDIR} environment variable.  If this option is given more than
4214 once, temporary files are stored in all the directories given.  If you
4215 have a large sort or merge that is I/O-bound, you can often improve
4216 performance by using this option to specify directories on different
4217 disks and controllers.
4218
4219 @item --parallel=@var{n}
4220 @opindex --parallel
4221 @cindex multithreaded sort
4222 Set the number of sorts run in parallel to @var{n}. By default,
4223 @var{n} is set to the number of available processors, but limited
4224 to 8, as there are diminishing performance gains after that.
4225 Note also that using @var{n} threads increases the memory usage by
4226 a factor of log @var{n}.  Also see @ref{nproc invocation}.
4227
4228 @item -u
4229 @itemx --unique
4230 @opindex -u
4231 @opindex --unique
4232 @cindex uniquifying output
4233
4234 Normally, output only the first of a sequence of lines that compare
4235 equal.  For the @option{--check} (@option{-c} or @option{-C}) option,
4236 check that no pair of consecutive lines compares equal.
4237
4238 This option also disables the default last-resort comparison.
4239
4240 The commands @code{sort -u} and @code{sort | uniq} are equivalent, but
4241 this equivalence does not extend to arbitrary @command{sort} options.
4242 For example, @code{sort -n -u} inspects only the value of the initial
4243 numeric string when checking for uniqueness, whereas @code{sort -n |
4244 uniq} inspects the entire line.  @xref{uniq invocation}.
4245
4246 @macro zeroTerminatedOption
4247 @item -z
4248 @itemx --zero-terminated
4249 @opindex -z
4250 @opindex --zero-terminated
4251 @cindex process zero-terminated items
4252 Delimit items with a zero byte rather than a newline (@acronym{ASCII} @sc{lf}).
4253 I.E. treat input as items separated by @acronym{ASCII} @sc{nul}
4254 and terminate output items with @acronym{ASCII} @sc{nul}.
4255 This option can be useful in conjunction with @samp{perl -0} or
4256 @samp{find -print0} and @samp{xargs -0} which do the same in order to
4257 reliably handle arbitrary file names (even those containing blanks
4258 or other special characters).
4259 @end macro
4260 @zeroTerminatedOption
4261
4262 @end table
4263
4264 Historical (BSD and System V) implementations of @command{sort} have
4265 differed in their interpretation of some options, particularly
4266 @option{-b}, @option{-f}, and @option{-n}.
4267 @sc{gnu} sort follows the @acronym{POSIX}
4268 behavior, which is usually (but not always!) like the System V behavior.
4269 According to @acronym{POSIX}, @option{-n} no longer implies @option{-b}.  For
4270 consistency, @option{-M} has been changed in the same way.  This may
4271 affect the meaning of character positions in field specifications in
4272 obscure cases.  The only fix is to add an explicit @option{-b}.
4273
4274 A position in a sort field specified with @option{-k} may have any
4275 of the option letters @samp{MbdfghinRrV} appended to it, in which case no
4276 global ordering options are inherited by that particular field.  The
4277 @option{-b} option may be independently attached to either or both of
4278 the start and end positions of a field specification, and if it is
4279 inherited from the global options it will be attached to both.
4280 If input lines can contain leading or adjacent blanks and @option{-t}
4281 is not used, then @option{-k} is typically combined with @option{-b} or
4282 an option that implicitly ignores leading blanks (@samp{Mghn}) as otherwise
4283 the varying numbers of leading blanks in fields can cause confusing results.
4284
4285 If the start position in a sort field specifier falls after the end of
4286 the line or after the end field, the field is empty.  If the @option{-b}
4287 option was specified, the @samp{.@var{c}} part of a field specification
4288 is counted from the first nonblank character of the field.
4289
4290 @vindex _POSIX2_VERSION
4291 @vindex POSIXLY_CORRECT
4292 On older systems, @command{sort} supports an obsolete origin-zero
4293 syntax @samp{+@var{pos1} [-@var{pos2}]} for specifying sort keys.
4294 The obsolete sequence @samp{sort +@var{a}.@var{x} -@var{b}.@var{y}}
4295 is equivalent to @samp{sort -k @var{a+1}.@var{x+1},@var{b}} if @var{y}
4296 is @samp{0} or absent, otherwise it is equivalent to @samp{sort -k
4297 @var{a+1}.@var{x+1},@var{b+1}.@var{y}}.
4298
4299 This obsolete behavior can be enabled or disabled with the
4300 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
4301 conformance}); it can also be enabled when @env{POSIXLY_CORRECT} is
4302 not set by using the obsolete syntax with @samp{-@var{pos2}} present.
4303
4304 Scripts intended for use on standard hosts should avoid obsolete
4305 syntax and should use @option{-k} instead.  For example, avoid
4306 @samp{sort +2}, since it might be interpreted as either @samp{sort
4307 ./+2} or @samp{sort -k 3}.  If your script must also run on hosts that
4308 support only the obsolete syntax, it can use a test like @samp{if sort
4309 -k 1 </dev/null >/dev/null 2>&1; then @dots{}} to decide which syntax
4310 to use.
4311
4312 Here are some examples to illustrate various combinations of options.
4313
4314 @itemize @bullet
4315
4316 @item
4317 Sort in descending (reverse) numeric order.
4318
4319 @example
4320 sort -n -r
4321 @end example
4322
4323 @item
4324 Run no more that 4 sorts concurrently, using a buffer size of 10M.
4325
4326 @example
4327 sort --parallel=4 -S 10M
4328 @end example
4329
4330 @item
4331 Sort alphabetically, omitting the first and second fields
4332 and the blanks at the start of the third field.
4333 This uses a single key composed of the characters beginning
4334 at the start of the first nonblank character in field three
4335 and extending to the end of each line.
4336
4337 @example
4338 sort -k 3b
4339 @end example
4340
4341 @item
4342 Sort numerically on the second field and resolve ties by sorting
4343 alphabetically on the third and fourth characters of field five.
4344 Use @samp{:} as the field delimiter.
4345
4346 @example
4347 sort -t : -k 2,2n -k 5.3,5.4
4348 @end example
4349
4350 Note that if you had written @option{-k 2n} instead of @option{-k 2,2n}
4351 @command{sort} would have used all characters beginning in the second field
4352 and extending to the end of the line as the primary @emph{numeric}
4353 key.  For the large majority of applications, treating keys spanning
4354 more than one field as numeric will not do what you expect.
4355
4356 Also note that the @samp{n} modifier was applied to the field-end
4357 specifier for the first key.  It would have been equivalent to
4358 specify @option{-k 2n,2} or @option{-k 2n,2n}.  All modifiers except
4359 @samp{b} apply to the associated @emph{field}, regardless of whether
4360 the modifier character is attached to the field-start and/or the
4361 field-end part of the key specifier.
4362
4363 @item
4364 Sort the password file on the fifth field and ignore any
4365 leading blanks.  Sort lines with equal values in field five
4366 on the numeric user ID in field three.  Fields are separated
4367 by @samp{:}.
4368
4369 @example
4370 sort -t : -k 5b,5 -k 3,3n /etc/passwd
4371 sort -t : -n -k 5b,5 -k 3,3 /etc/passwd
4372 sort -t : -b -k 5,5 -k 3,3n /etc/passwd
4373 @end example
4374
4375 These three commands have equivalent effect.  The first specifies that
4376 the first key's start position ignores leading blanks and the second
4377 key is sorted numerically.  The other two commands rely on global
4378 options being inherited by sort keys that lack modifiers.  The inheritance
4379 works in this case because @option{-k 5b,5b} and @option{-k 5b,5} are
4380 equivalent, as the location of a field-end lacking a @samp{.@var{c}}
4381 character position is not affected by whether initial blanks are
4382 skipped.
4383
4384 @item
4385 Sort a set of log files, primarily by IPv4 address and secondarily by
4386 time stamp.  If two lines' primary and secondary keys are identical,
4387 output the lines in the same order that they were input.  The log
4388 files contain lines that look like this:
4389
4390 @example
4391 4.150.156.3 - - [01/Apr/2004:06:31:51 +0000] message 1
4392 211.24.3.231 - - [24/Apr/2004:20:17:39 +0000] message 2
4393 @end example
4394
4395 Fields are separated by exactly one space.  Sort IPv4 addresses
4396 lexicographically, e.g., 212.61.52.2 sorts before 212.129.233.201
4397 because 61 is less than 129.
4398
4399 @example
4400 sort -s -t ' ' -k 4.9n -k 4.5M -k 4.2n -k 4.14,4.21 file*.log |
4401 sort -s -t '.' -k 1,1n -k 2,2n -k 3,3n -k 4,4n
4402 @end example
4403
4404 This example cannot be done with a single @command{sort} invocation,
4405 since IPv4 address components are separated by @samp{.} while dates
4406 come just after a space.  So it is broken down into two invocations of
4407 @command{sort}: the first sorts by time stamp and the second by IPv4
4408 address.  The time stamp is sorted by year, then month, then day, and
4409 finally by hour-minute-second field, using @option{-k} to isolate each
4410 field.  Except for hour-minute-second there's no need to specify the
4411 end of each key field, since the @samp{n} and @samp{M} modifiers sort
4412 based on leading prefixes that cannot cross field boundaries.  The
4413 IPv4 addresses are sorted lexicographically.  The second sort uses
4414 @samp{-s} so that ties in the primary key are broken by the secondary
4415 key; the first sort uses @samp{-s} so that the combination of the two
4416 sorts is stable.
4417
4418 @item
4419 Generate a tags file in case-insensitive sorted order.
4420
4421 @smallexample
4422 find src -type f -print0 | sort -z -f | xargs -0 etags --append
4423 @end smallexample
4424
4425 The use of @option{-print0}, @option{-z}, and @option{-0} in this case means
4426 that file names that contain blanks or other special characters are
4427 not broken up
4428 by the sort operation.
4429
4430 @c This example is a bit contrived and needs more explanation.
4431 @c @item
4432 @c Sort records separated by an arbitrary string by using a pipe to convert
4433 @c each record delimiter string to @samp{\0}, then using sort's -z option,
4434 @c and converting each @samp{\0} back to the original record delimiter.
4435 @c
4436 @c @example
4437 @c printf 'c\n\nb\n\na\n' |
4438 @c perl -0pe 's/\n\n/\n\0/g' |
4439 @c sort -z |
4440 @c perl -0pe 's/\0/\n/g'
4441 @c @end example
4442
4443 @item
4444 Use the common @acronym{DSU, Decorate Sort Undecorate} idiom to
4445 sort lines according to their length.
4446
4447 @example
4448 awk '@{print length, $0@}' /etc/passwd | sort -n | cut -f2- -d' '
4449 @end example
4450
4451 In general this technique can be used to sort data that the @command{sort}
4452 command does not support, or is inefficient at, sorting directly.
4453
4454 @item
4455 Shuffle a list of directories, but preserve the order of files within
4456 each directory.  For instance, one could use this to generate a music
4457 playlist in which albums are shuffled but the songs of each album are
4458 played in order.
4459
4460 @example
4461 ls */* | sort -t / -k 1,1R -k 2,2
4462 @end example
4463
4464 @end itemize
4465
4466
4467 @node shuf invocation
4468 @section @command{shuf}: Shuffling text
4469
4470 @pindex shuf
4471 @cindex shuffling files
4472
4473 @command{shuf} shuffles its input by outputting a random permutation
4474 of its input lines.  Each output permutation is equally likely.
4475 Synopses:
4476
4477 @example
4478 shuf [@var{option}]@dots{} [@var{file}]
4479 shuf -e [@var{option}]@dots{} [@var{arg}]@dots{}
4480 shuf -i @var{lo}-@var{hi} [@var{option}]@dots{}
4481 @end example
4482
4483 @command{shuf} has three modes of operation that affect where it
4484 obtains its input lines.  By default, it reads lines from standard
4485 input.  The following options change the operation mode:
4486
4487 @table @samp
4488
4489 @item -e
4490 @itemx --echo
4491 @opindex -c
4492 @opindex --echo
4493 @cindex command-line operands to shuffle
4494 Treat each command-line operand as an input line.
4495
4496 @item -i @var{lo}-@var{hi}
4497 @itemx --input-range=@var{lo}-@var{hi}
4498 @opindex -i
4499 @opindex --input-range
4500 @cindex input range to shuffle
4501 Act as if input came from a file containing the range of unsigned
4502 decimal integers @var{lo}@dots{}@var{hi}, one per line.
4503
4504 @end table
4505
4506 @command{shuf}'s other options can affect its behavior in all
4507 operation modes:
4508
4509 @table @samp
4510
4511 @item -n @var{lines}
4512 @itemx --head-count=@var{count}
4513 @opindex -n
4514 @opindex --head-count
4515 @cindex head of output
4516 Output at most @var{count} lines.  By default, all input lines are
4517 output.
4518
4519 @item -o @var{output-file}
4520 @itemx --output=@var{output-file}
4521 @opindex -o
4522 @opindex --output
4523 @cindex overwriting of input, allowed
4524 Write output to @var{output-file} instead of standard output.
4525 @command{shuf} reads all input before opening
4526 @var{output-file}, so you can safely shuffle a file in place by using
4527 commands like @code{shuf -o F <F} and @code{cat F | shuf -o F}.
4528
4529 @item --random-source=@var{file}
4530 @opindex --random-source
4531 @cindex random source for shuffling
4532 Use @var{file} as a source of random data used to determine which
4533 permutation to generate.  @xref{Random sources}.
4534
4535 @zeroTerminatedOption
4536
4537 @end table
4538
4539 For example:
4540
4541 @example
4542 shuf <<EOF
4543 A man,
4544 a plan,
4545 a canal:
4546 Panama!
4547 EOF
4548 @end example
4549
4550 @noindent
4551 might produce the output
4552
4553 @example
4554 Panama!
4555 A man,
4556 a canal:
4557 a plan,
4558 @end example
4559
4560 @noindent
4561 Similarly, the command:
4562
4563 @example
4564 shuf -e clubs hearts diamonds spades
4565 @end example
4566
4567 @noindent
4568 might output:
4569
4570 @example
4571 clubs
4572 diamonds
4573 spades
4574 hearts
4575 @end example
4576
4577 @noindent
4578 and the command @samp{shuf -i 1-4} might output:
4579
4580 @example
4581 4
4582 2
4583 1
4584 3
4585 @end example
4586
4587 @noindent
4588 These examples all have four input lines, so @command{shuf} might
4589 produce any of the twenty-four possible permutations of the input.  In
4590 general, if there are @var{n} input lines, there are @var{n}! (i.e.,
4591 @var{n} factorial, or @var{n} * (@var{n} - 1) * @dots{} * 1) possible
4592 output permutations.
4593
4594 @exitstatus
4595
4596
4597 @node uniq invocation
4598 @section @command{uniq}: Uniquify files
4599
4600 @pindex uniq
4601 @cindex uniquify files
4602
4603 @command{uniq} writes the unique lines in the given @file{input}, or
4604 standard input if nothing is given or for an @var{input} name of
4605 @samp{-}.  Synopsis:
4606
4607 @example
4608 uniq [@var{option}]@dots{} [@var{input} [@var{output}]]
4609 @end example
4610
4611 By default, @command{uniq} prints its input lines, except that
4612 it discards all but the first of adjacent repeated lines, so that
4613 no output lines are repeated.  Optionally, it can instead discard
4614 lines that are not repeated, or all repeated lines.
4615
4616 The input need not be sorted, but repeated input lines are detected
4617 only if they are adjacent.  If you want to discard non-adjacent
4618 duplicate lines, perhaps you want to use @code{sort -u}.
4619 @xref{sort invocation}.
4620
4621 @vindex LC_COLLATE
4622 Comparisons honor the rules specified by the @env{LC_COLLATE}
4623 locale category.
4624
4625 If no @var{output} file is specified, @command{uniq} writes to standard
4626 output.
4627
4628 The program accepts the following options.  Also see @ref{Common options}.
4629
4630 @table @samp
4631
4632 @item -f @var{n}
4633 @itemx --skip-fields=@var{n}
4634 @opindex -f
4635 @opindex --skip-fields
4636 Skip @var{n} fields on each line before checking for uniqueness.  Use
4637 a null string for comparison if a line has fewer than @var{n} fields.  Fields
4638 are sequences of non-space non-tab characters that are separated from
4639 each other by at least one space or tab.
4640
4641 For compatibility @command{uniq} supports an obsolete option syntax
4642 @option{-@var{n}}.  New scripts should use @option{-f @var{n}} instead.
4643
4644 @item -s @var{n}
4645 @itemx --skip-chars=@var{n}
4646 @opindex -s
4647 @opindex --skip-chars
4648 Skip @var{n} characters before checking for uniqueness.  Use a null string
4649 for comparison if a line has fewer than @var{n} characters.  If you use both
4650 the field and character skipping options, fields are skipped over first.
4651
4652 @vindex _POSIX2_VERSION
4653 On older systems, @command{uniq} supports an obsolete option syntax
4654 @option{+@var{n}}.
4655 This obsolete behavior can be enabled or disabled with the
4656 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
4657 conformance}), but portable scripts should avoid commands whose
4658 behavior depends on this variable.
4659 For example, use @samp{uniq ./+10} or @samp{uniq -s 10} rather than
4660 the ambiguous @samp{uniq +10}.
4661
4662 @item -c
4663 @itemx --count
4664 @opindex -c
4665 @opindex --count
4666 Print the number of times each line occurred along with the line.
4667
4668 @item -i
4669 @itemx --ignore-case
4670 @opindex -i
4671 @opindex --ignore-case
4672 Ignore differences in case when comparing lines.
4673
4674 @item -d
4675 @itemx --repeated
4676 @opindex -d
4677 @opindex --repeated
4678 @cindex repeated lines, outputting
4679 Discard lines that are not repeated.  When used by itself, this option
4680 causes @command{uniq} to print the first copy of each repeated line,
4681 and nothing else.
4682
4683 @item -D
4684 @itemx --all-repeated[=@var{delimit-method}]
4685 @opindex -D
4686 @opindex --all-repeated
4687 @cindex all repeated lines, outputting
4688 Do not discard the second and subsequent repeated input lines,
4689 but discard lines that are not repeated.
4690 This option is useful mainly in conjunction with other options e.g.,
4691 to ignore case or to compare only selected fields.
4692 The optional @var{delimit-method} tells how to delimit
4693 groups of repeated lines, and must be one of the following:
4694
4695 @table @samp
4696
4697 @item none
4698 Do not delimit groups of repeated lines.
4699 This is equivalent to @option{--all-repeated} (@option{-D}).
4700
4701 @item prepend
4702 Output a newline before each group of repeated lines.
4703 With @option{--zero-terminated} (@option{-z}), use a zero
4704 byte (@acronym{ASCII} @sc{nul}) instead of a newline.
4705
4706 @item separate
4707 Separate groups of repeated lines with a single newline.
4708 With @option{--zero-terminated} (@option{-z}), use a zero
4709 byte (@acronym{ASCII} @sc{nul}) instead of a newline.
4710 This is the same as using @samp{prepend}, except that
4711 no delimiter is inserted before the first group, and hence
4712 may be better suited for output direct to users.
4713 @end table
4714
4715 Note that when groups are delimited and the input stream contains
4716 two or more consecutive blank lines, then the output is ambiguous.
4717 To avoid that, filter the input through @samp{tr -s '\n'} to replace
4718 each sequence of consecutive newlines with a single newline.
4719
4720 This is a @sc{gnu} extension.
4721 @c FIXME: give an example showing *how* it's useful
4722
4723 @item -u
4724 @itemx --unique
4725 @opindex -u
4726 @opindex --unique
4727 @cindex unique lines, outputting
4728 Discard the first repeated line.  When used by itself, this option
4729 causes @command{uniq} to print unique lines, and nothing else.
4730
4731 @item -w @var{n}
4732 @itemx --check-chars=@var{n}
4733 @opindex -w
4734 @opindex --check-chars
4735 Compare at most @var{n} characters on each line (after skipping any specified
4736 fields and characters).  By default the entire rest of the lines are
4737 compared.
4738
4739 @zeroTerminatedOption
4740
4741 @end table
4742
4743 @exitstatus
4744
4745
4746 @node comm invocation
4747 @section @command{comm}: Compare two sorted files line by line
4748
4749 @pindex comm
4750 @cindex line-by-line comparison
4751 @cindex comparing sorted files
4752
4753 @command{comm} writes to standard output lines that are common, and lines
4754 that are unique, to two input files; a file name of @samp{-} means
4755 standard input.  Synopsis:
4756
4757 @example
4758 comm [@var{option}]@dots{} @var{file1} @var{file2}
4759 @end example
4760
4761 @vindex LC_COLLATE
4762 Before @command{comm} can be used, the input files must be sorted using the
4763 collating sequence specified by the @env{LC_COLLATE} locale.
4764 If an input file ends in a non-newline
4765 character, a newline is silently appended.  The @command{sort} command with
4766 no options always outputs a file that is suitable input to @command{comm}.
4767
4768 @cindex differing lines
4769 @cindex common lines
4770 With no options, @command{comm} produces three-column output.  Column one
4771 contains lines unique to @var{file1}, column two contains lines unique
4772 to @var{file2}, and column three contains lines common to both files.
4773 Columns are separated by a single TAB character.
4774 @c FIXME: when there's an option to supply an alternative separator
4775 @c string, append `by default' to the above sentence.
4776
4777 @opindex -1
4778 @opindex -2
4779 @opindex -3
4780 The options @option{-1}, @option{-2}, and @option{-3} suppress printing of
4781 the corresponding columns (and separators).  Also see @ref{Common options}.
4782
4783 Unlike some other comparison utilities, @command{comm} has an exit
4784 status that does not depend on the result of the comparison.
4785 Upon normal completion @command{comm} produces an exit code of zero.
4786 If there is an error it exits with nonzero status.
4787
4788 @macro checkOrderOption{cmd}
4789 If the @option{--check-order} option is given, unsorted inputs will
4790 cause a fatal error message.  If the option @option{--nocheck-order}
4791 is given, unsorted inputs will never cause an error message.  If neither
4792 of these options is given, wrongly sorted inputs are diagnosed
4793 only if an input file is found to contain unpairable
4794 @ifset JOIN_COMMAND
4795 lines, and when both input files are non empty.
4796 @end ifset
4797 @ifclear JOIN_COMMAND
4798 lines.
4799 @end ifclear
4800 If an input file is diagnosed as being unsorted, the @command{\cmd\}
4801 command will exit with a nonzero status (and the output should not be used).
4802
4803 Forcing @command{\cmd\} to process wrongly sorted input files
4804 containing unpairable lines by specifying @option{--nocheck-order} is
4805 not guaranteed to produce any particular output.  The output will
4806 probably not correspond with whatever you hoped it would be.
4807 @end macro
4808 @checkOrderOption{comm}
4809
4810 @table @samp
4811
4812 @item --check-order
4813 Fail with an error message if either input file is wrongly ordered.
4814
4815 @item --nocheck-order
4816 Do not check that both input files are in sorted order.
4817
4818 Other options are:
4819
4820 @item --output-delimiter=@var{str}
4821 Print @var{str} between adjacent output columns,
4822 rather than the default of a single TAB character.
4823
4824 The delimiter @var{str} may not be empty.
4825
4826 @end table
4827
4828 @node ptx invocation
4829 @section @command{ptx}: Produce permuted indexes
4830
4831 @pindex ptx
4832
4833 @command{ptx} reads a text file and essentially produces a permuted index, with
4834 each keyword in its context.  The calling sketch is either one of:
4835
4836 @example
4837 ptx [@var{option} @dots{}] [@var{file} @dots{}]
4838 ptx -G [@var{option} @dots{}] [@var{input} [@var{output}]]
4839 @end example
4840
4841 The @option{-G} (or its equivalent: @option{--traditional}) option disables
4842 all @sc{gnu} extensions and reverts to traditional mode, thus introducing some
4843 limitations and changing several of the program's default option values.
4844 When @option{-G} is not specified, @sc{gnu} extensions are always enabled.
4845 @sc{gnu} extensions to @command{ptx} are documented wherever appropriate in this
4846 document.  For the full list, see @xref{Compatibility in ptx}.
4847
4848 Individual options are explained in the following sections.
4849
4850 When @sc{gnu} extensions are enabled, there may be zero, one or several
4851 @var{file}s after the options.  If there is no @var{file}, the program
4852 reads the standard input.  If there is one or several @var{file}s, they
4853 give the name of input files which are all read in turn, as if all the
4854 input files were concatenated.  However, there is a full contextual
4855 break between each file and, when automatic referencing is requested,
4856 file names and line numbers refer to individual text input files.  In
4857 all cases, the program outputs the permuted index to the standard
4858 output.
4859
4860 When @sc{gnu} extensions are @emph{not} enabled, that is, when the program
4861 operates in traditional mode, there may be zero, one or two parameters
4862 besides the options.  If there are no parameters, the program reads the
4863 standard input and outputs the permuted index to the standard output.
4864 If there is only one parameter, it names the text @var{input} to be read
4865 instead of the standard input.  If two parameters are given, they give
4866 respectively the name of the @var{input} file to read and the name of
4867 the @var{output} file to produce.  @emph{Be very careful} to note that,
4868 in this case, the contents of file given by the second parameter is
4869 destroyed.  This behavior is dictated by System V @command{ptx}
4870 compatibility; @sc{gnu} Standards normally discourage output parameters not
4871 introduced by an option.
4872
4873 Note that for @emph{any} file named as the value of an option or as an
4874 input text file, a single dash @kbd{-} may be used, in which case
4875 standard input is assumed.  However, it would not make sense to use this
4876 convention more than once per program invocation.
4877
4878 @menu
4879 * General options in ptx::      Options which affect general program behavior.
4880 * Charset selection in ptx::    Underlying character set considerations.
4881 * Input processing in ptx::     Input fields, contexts, and keyword selection.
4882 * Output formatting in ptx::    Types of output format, and sizing the fields.
4883 * Compatibility in ptx::
4884 @end menu
4885
4886
4887 @node General options in ptx
4888 @subsection General options
4889
4890 @table @samp
4891
4892 @item -G
4893 @itemx --traditional
4894 As already explained, this option disables all @sc{gnu} extensions to
4895 @command{ptx} and switches to traditional mode.
4896
4897 @item --help
4898 Print a short help on standard output, then exit without further
4899 processing.
4900
4901 @item --version
4902 Print the program version on standard output, then exit without further
4903 processing.
4904
4905 @end table
4906
4907 @exitstatus
4908
4909
4910 @node Charset selection in ptx
4911 @subsection Charset selection
4912
4913 @c FIXME:  People don't necessarily know what an IBM-PC was these days.
4914 As it is set up now, the program assumes that the input file is coded
4915 using 8-bit @acronym{ISO} 8859-1 code, also known as Latin-1 character set,
4916 @emph{unless} it is compiled for MS-DOS, in which case it uses the
4917 character set of the IBM-PC@.  (@sc{gnu} @command{ptx} is not known to work on
4918 smaller MS-DOS machines anymore.)  Compared to 7-bit @acronym{ASCII}, the set
4919 of characters which are letters is different; this alters the behavior
4920 of regular expression matching.  Thus, the default regular expression
4921 for a keyword allows foreign or diacriticized letters.  Keyword sorting,
4922 however, is still crude; it obeys the underlying character set ordering
4923 quite blindly.
4924
4925 @table @samp
4926
4927 @item -f
4928 @itemx --ignore-case
4929 Fold lower case letters to upper case for sorting.
4930
4931 @end table
4932
4933
4934 @node Input processing in ptx
4935 @subsection Word selection and input processing
4936
4937 @table @samp
4938
4939 @item -b @var{file}
4940 @itemx --break-file=@var{file}
4941
4942 This option provides an alternative (to @option{-W}) method of describing
4943 which characters make up words.  It introduces the name of a
4944 file which contains a list of characters which can@emph{not} be part of
4945 one word; this file is called the @dfn{Break file}.  Any character which
4946 is not part of the Break file is a word constituent.  If both options
4947 @option{-b} and @option{-W} are specified, then @option{-W} has precedence and
4948 @option{-b} is ignored.
4949
4950 When @sc{gnu} extensions are enabled, the only way to avoid newline as a
4951 break character is to write all the break characters in the file with no
4952 newline at all, not even at the end of the file.  When @sc{gnu} extensions
4953 are disabled, spaces, tabs and newlines are always considered as break
4954 characters even if not included in the Break file.
4955
4956 @item -i @var{file}
4957 @itemx --ignore-file=@var{file}
4958
4959 The file associated with this option contains a list of words which will
4960 never be taken as keywords in concordance output.  It is called the
4961 @dfn{Ignore file}.  The file contains exactly one word in each line; the
4962 end of line separation of words is not subject to the value of the
4963 @option{-S} option.
4964
4965 @item -o @var{file}
4966 @itemx --only-file=@var{file}
4967
4968 The file associated with this option contains a list of words which will
4969 be retained in concordance output; any word not mentioned in this file
4970 is ignored.  The file is called the @dfn{Only file}.  The file contains
4971 exactly one word in each line; the end of line separation of words is
4972 not subject to the value of the @option{-S} option.
4973
4974 There is no default for the Only file.  When both an Only file and an
4975 Ignore file are specified, a word is considered a keyword only
4976 if it is listed in the Only file and not in the Ignore file.
4977
4978 @item -r
4979 @itemx --references
4980
4981 On each input line, the leading sequence of non-white space characters will be
4982 taken to be a reference that has the purpose of identifying this input
4983 line in the resulting permuted index.  For more information about reference
4984 production, see @xref{Output formatting in ptx}.
4985 Using this option changes the default value for option @option{-S}.
4986
4987 Using this option, the program does not try very hard to remove
4988 references from contexts in output, but it succeeds in doing so
4989 @emph{when} the context ends exactly at the newline.  If option
4990 @option{-r} is used with @option{-S} default value, or when @sc{gnu} extensions
4991 are disabled, this condition is always met and references are completely
4992 excluded from the output contexts.
4993
4994 @item -S @var{regexp}
4995 @itemx --sentence-regexp=@var{regexp}
4996
4997 This option selects which regular expression will describe the end of a
4998 line or the end of a sentence.  In fact, this regular expression is not
4999 the only distinction between end of lines or end of sentences, and input
5000 line boundaries have no special significance outside this option.  By
5001 default, when @sc{gnu} extensions are enabled and if @option{-r} option is not
5002 used, end of sentences are used.  In this case, this @var{regex} is
5003 imported from @sc{gnu} Emacs:
5004
5005 @example
5006 [.?!][]\"')@}]*\\($\\|\t\\|  \\)[ \t\n]*
5007 @end example
5008
5009 Whenever @sc{gnu} extensions are disabled or if @option{-r} option is used, end
5010 of lines are used; in this case, the default @var{regexp} is just:
5011
5012 @example
5013 \n
5014 @end example
5015
5016 Using an empty @var{regexp} is equivalent to completely disabling end of
5017 line or end of sentence recognition.  In this case, the whole file is
5018 considered to be a single big line or sentence.  The user might want to
5019 disallow all truncation flag generation as well, through option @option{-F
5020 ""}.  @xref{Regexps, , Syntax of Regular Expressions, emacs, The GNU Emacs
5021 Manual}.
5022
5023 When the keywords happen to be near the beginning of the input line or
5024 sentence, this often creates an unused area at the beginning of the
5025 output context line; when the keywords happen to be near the end of the
5026 input line or sentence, this often creates an unused area at the end of
5027 the output context line.  The program tries to fill those unused areas
5028 by wrapping around context in them; the tail of the input line or
5029 sentence is used to fill the unused area on the left of the output line;
5030 the head of the input line or sentence is used to fill the unused area
5031 on the right of the output line.
5032
5033 As a matter of convenience to the user, many usual backslashed escape
5034 sequences from the C language are recognized and converted to the
5035 corresponding characters by @command{ptx} itself.
5036
5037 @item -W @var{regexp}
5038 @itemx --word-regexp=@var{regexp}
5039
5040 This option selects which regular expression will describe each keyword.
5041 By default, if @sc{gnu} extensions are enabled, a word is a sequence of
5042 letters; the @var{regexp} used is @samp{\w+}.  When @sc{gnu} extensions are
5043 disabled, a word is by default anything which ends with a space, a tab
5044 or a newline; the @var{regexp} used is @samp{[^ \t\n]+}.
5045
5046 An empty @var{regexp} is equivalent to not using this option.
5047 @xref{Regexps, , Syntax of Regular Expressions, emacs, The GNU Emacs
5048 Manual}.
5049
5050 As a matter of convenience to the user, many usual backslashed escape
5051 sequences, as found in the C language, are recognized and converted to
5052 the corresponding characters by @command{ptx} itself.
5053
5054 @end table
5055
5056
5057 @node Output formatting in ptx
5058 @subsection Output formatting
5059
5060 Output format is mainly controlled by the @option{-O} and @option{-T} options
5061 described in the table below.  When neither @option{-O} nor @option{-T} are
5062 selected, and if @sc{gnu} extensions are enabled, the program chooses an
5063 output format suitable for a dumb terminal.  Each keyword occurrence is
5064 output to the center of one line, surrounded by its left and right
5065 contexts.  Each field is properly justified, so the concordance output
5066 can be readily observed.  As a special feature, if automatic
5067 references are selected by option @option{-A} and are output before the
5068 left context, that is, if option @option{-R} is @emph{not} selected, then
5069 a colon is added after the reference; this nicely interfaces with @sc{gnu}
5070 Emacs @code{next-error} processing.  In this default output format, each
5071 white space character, like newline and tab, is merely changed to
5072 exactly one space, with no special attempt to compress consecutive
5073 spaces.  This might change in the future.  Except for those white space
5074 characters, every other character of the underlying set of 256
5075 characters is transmitted verbatim.
5076
5077 Output format is further controlled by the following options.
5078
5079 @table @samp
5080
5081 @item -g @var{number}
5082 @itemx --gap-size=@var{number}
5083
5084 Select the size of the minimum white space gap between the fields on the
5085 output line.
5086
5087 @item -w @var{number}
5088 @itemx --width=@var{number}
5089
5090 Select the maximum output width of each final line.  If references are
5091 used, they are included or excluded from the maximum output width
5092 depending on the value of option @option{-R}.  If this option is not
5093 selected, that is, when references are output before the left context,
5094 the maximum output width takes into account the maximum length of all
5095 references.  If this option is selected, that is, when references are
5096 output after the right context, the maximum output width does not take
5097 into account the space taken by references, nor the gap that precedes
5098 them.
5099
5100 @item -A
5101 @itemx --auto-reference
5102
5103 Select automatic references.  Each input line will have an automatic
5104 reference made up of the file name and the line ordinal, with a single
5105 colon between them.  However, the file name will be empty when standard
5106 input is being read.  If both @option{-A} and @option{-r} are selected, then
5107 the input reference is still read and skipped, but the automatic
5108 reference is used at output time, overriding the input reference.
5109
5110 @item -R
5111 @itemx --right-side-refs
5112
5113 In the default output format, when option @option{-R} is not used, any
5114 references produced by the effect of options @option{-r} or @option{-A} are
5115 placed to the far right of output lines, after the right context.  With
5116 default output format, when the @option{-R} option is specified, references
5117 are rather placed at the beginning of each output line, before the left
5118 context.  For any other output format, option @option{-R} is
5119 ignored, with one exception:  with @option{-R} the width of references
5120 is @emph{not} taken into account in total output width given by @option{-w}.
5121
5122 This option is automatically selected whenever @sc{gnu} extensions are
5123 disabled.
5124
5125 @item -F @var{string}
5126 @itemx --flac-truncation=@var{string}
5127
5128 This option will request that any truncation in the output be reported
5129 using the string @var{string}.  Most output fields theoretically extend
5130 towards the beginning or the end of the current line, or current
5131 sentence, as selected with option @option{-S}.  But there is a maximum
5132 allowed output line width, changeable through option @option{-w}, which is
5133 further divided into space for various output fields.  When a field has
5134 to be truncated because it cannot extend beyond the beginning or the end of
5135 the current line to fit in, then a truncation occurs.  By default,
5136 the string used is a single slash, as in @option{-F /}.
5137
5138 @var{string} may have more than one character, as in @option{-F ...}.
5139 Also, in the particular case when @var{string} is empty (@option{-F ""}),
5140 truncation flagging is disabled, and no truncation marks are appended in
5141 this case.
5142
5143 As a matter of convenience to the user, many usual backslashed escape
5144 sequences, as found in the C language, are recognized and converted to
5145 the corresponding characters by @command{ptx} itself.
5146
5147 @item -M @var{string}
5148 @itemx --macro-name=@var{string}
5149
5150 Select another @var{string} to be used instead of @samp{xx}, while
5151 generating output suitable for @command{nroff}, @command{troff} or @TeX{}.
5152
5153 @item -O
5154 @itemx --format=roff
5155
5156 Choose an output format suitable for @command{nroff} or @command{troff}
5157 processing.  Each output line will look like:
5158
5159 @smallexample
5160 .xx "@var{tail}" "@var{before}" "@var{keyword_and_after}"@c
5161  "@var{head}" "@var{ref}"
5162 @end smallexample
5163
5164 so it will be possible to write a @samp{.xx} roff macro to take care of
5165 the output typesetting.  This is the default output format when @sc{gnu}
5166 extensions are disabled.  Option @option{-M} can be used to change
5167 @samp{xx} to another macro name.
5168
5169 In this output format, each non-graphical character, like newline and
5170 tab, is merely changed to exactly one space, with no special attempt to
5171 compress consecutive spaces.  Each quote character: @kbd{"} is doubled
5172 so it will be correctly processed by @command{nroff} or @command{troff}.
5173
5174 @item -T
5175 @itemx --format=tex
5176
5177 Choose an output format suitable for @TeX{} processing.  Each output
5178 line will look like:
5179
5180 @smallexample
5181 \xx @{@var{tail}@}@{@var{before}@}@{@var{keyword}@}@c
5182 @{@var{after}@}@{@var{head}@}@{@var{ref}@}
5183 @end smallexample
5184
5185 @noindent
5186 so it will be possible to write a @code{\xx} definition to take care of
5187 the output typesetting.  Note that when references are not being
5188 produced, that is, neither option @option{-A} nor option @option{-r} is
5189 selected, the last parameter of each @code{\xx} call is inhibited.
5190 Option @option{-M} can be used to change @samp{xx} to another macro
5191 name.
5192
5193 In this output format, some special characters, like @kbd{$}, @kbd{%},
5194 @kbd{&}, @kbd{#} and @kbd{_} are automatically protected with a
5195 backslash.  Curly brackets @kbd{@{}, @kbd{@}} are protected with a
5196 backslash and a pair of dollar signs (to force mathematical mode).  The
5197 backslash itself produces the sequence @code{\backslash@{@}}.
5198 Circumflex and tilde diacritical marks produce the sequence @code{^\@{ @}} and
5199 @code{~\@{ @}} respectively.  Other diacriticized characters of the
5200 underlying character set produce an appropriate @TeX{} sequence as far
5201 as possible.  The other non-graphical characters, like newline and tab,
5202 and all other characters which are not part of @acronym{ASCII}, are merely
5203 changed to exactly one space, with no special attempt to compress
5204 consecutive spaces.  Let me know how to improve this special character
5205 processing for @TeX{}.
5206
5207 @end table
5208
5209
5210 @node Compatibility in ptx
5211 @subsection The @sc{gnu} extensions to @command{ptx}
5212
5213 This version of @command{ptx} contains a few features which do not exist in
5214 System V @command{ptx}.  These extra features are suppressed by using the
5215 @option{-G} command line option, unless overridden by other command line
5216 options.  Some @sc{gnu} extensions cannot be recovered by overriding, so the
5217 simple rule is to avoid @option{-G} if you care about @sc{gnu} extensions.
5218 Here are the differences between this program and System V @command{ptx}.
5219
5220 @itemize @bullet
5221
5222 @item
5223 This program can read many input files at once, it always writes the
5224 resulting concordance on standard output.  On the other hand, System V
5225 @command{ptx} reads only one file and sends the result to standard output
5226 or, if a second @var{file} parameter is given on the command, to that
5227 @var{file}.
5228
5229 Having output parameters not introduced by options is a dangerous
5230 practice which @sc{gnu} avoids as far as possible.  So, for using @command{ptx}
5231 portably between @sc{gnu} and System V, you should always use it with a
5232 single input file, and always expect the result on standard output.  You
5233 might also want to automatically configure in a @option{-G} option to
5234 @command{ptx} calls in products using @command{ptx}, if the configurator finds
5235 that the installed @command{ptx} accepts @option{-G}.
5236
5237 @item
5238 The only options available in System V @command{ptx} are options @option{-b},
5239 @option{-f}, @option{-g}, @option{-i}, @option{-o}, @option{-r}, @option{-t} and
5240 @option{-w}.  All other options are @sc{gnu} extensions and are not repeated in
5241 this enumeration.  Moreover, some options have a slightly different
5242 meaning when @sc{gnu} extensions are enabled, as explained below.
5243
5244 @item
5245 By default, concordance output is not formatted for @command{troff} or
5246 @command{nroff}.  It is rather formatted for a dumb terminal.  @command{troff}
5247 or @command{nroff} output may still be selected through option @option{-O}.
5248
5249 @item
5250 Unless @option{-R} option is used, the maximum reference width is
5251 subtracted from the total output line width.  With @sc{gnu} extensions
5252 disabled, width of references is not taken into account in the output
5253 line width computations.
5254
5255 @item
5256 All 256 bytes, even @acronym{ASCII} @sc{nul} bytes, are always read and
5257 processed from input file with no adverse effect, even if @sc{gnu} extensions
5258 are disabled. However, System V @command{ptx} does not accept 8-bit characters,
5259 a few control characters are rejected, and the tilde @kbd{~} is also rejected.
5260
5261 @item
5262 Input line length is only limited by available memory, even if @sc{gnu}
5263 extensions are disabled.  However, System V @command{ptx} processes only
5264 the first 200 characters in each line.
5265
5266 @item
5267 The break (non-word) characters default to be every character except all
5268 letters of the underlying character set, diacriticized or not.  When @sc{gnu}
5269 extensions are disabled, the break characters default to space, tab and
5270 newline only.
5271
5272 @item
5273 The program makes better use of output line width.  If @sc{gnu} extensions
5274 are disabled, the program rather tries to imitate System V @command{ptx},
5275 but still, there are some slight disposition glitches this program does
5276 not completely reproduce.
5277
5278 @item
5279 The user can specify both an Ignore file and an Only file.  This is not
5280 allowed with System V @command{ptx}.
5281
5282 @end itemize
5283
5284
5285 @node tsort invocation
5286 @section @command{tsort}: Topological sort
5287
5288 @pindex tsort
5289 @cindex topological sort
5290
5291 @command{tsort} performs a topological sort on the given @var{file}, or
5292 standard input if no input file is given or for a @var{file} of
5293 @samp{-}.  For more details and some history, see @ref{tsort background}.
5294 Synopsis:
5295
5296 @example
5297 tsort [@var{option}] [@var{file}]
5298 @end example
5299
5300 @command{tsort} reads its input as pairs of strings, separated by blanks,
5301 indicating a partial ordering.  The output is a total ordering that
5302 corresponds to the given partial ordering.
5303
5304 For example
5305
5306 @example
5307 tsort <<EOF
5308 a b c
5309 d
5310 e f
5311 b c d e
5312 EOF
5313 @end example
5314
5315 @noindent
5316 will produce the output
5317
5318 @example
5319 a
5320 b
5321 c
5322 d
5323 e
5324 f
5325 @end example
5326
5327 Consider a more realistic example.
5328 You have a large set of functions all in one file, and they may all be
5329 declared static except one.  Currently that one (say @code{main}) is the
5330 first function defined in the file, and the ones it calls directly follow
5331 it, followed by those they call, etc.  Let's say that you are determined
5332 to take advantage of prototypes, so you have to choose between declaring
5333 all of those functions (which means duplicating a lot of information from
5334 the definitions) and rearranging the functions so that as many as possible
5335 are defined before they are used.  One way to automate the latter process
5336 is to get a list for each function of the functions it calls directly.
5337 Many programs can generate such lists.  They describe a call graph.
5338 Consider the following list, in which a given line indicates that the
5339 function on the left calls the one on the right directly.
5340
5341 @example
5342 main parse_options
5343 main tail_file
5344 main tail_forever
5345 tail_file pretty_name
5346 tail_file write_header
5347 tail_file tail
5348 tail_forever recheck
5349 tail_forever pretty_name
5350 tail_forever write_header
5351 tail_forever dump_remainder
5352 tail tail_lines
5353 tail tail_bytes
5354 tail_lines start_lines
5355 tail_lines dump_remainder
5356 tail_lines file_lines
5357 tail_lines pipe_lines
5358 tail_bytes xlseek
5359 tail_bytes start_bytes
5360 tail_bytes dump_remainder
5361 tail_bytes pipe_bytes
5362 file_lines dump_remainder
5363 recheck pretty_name
5364 @end example
5365
5366 then you can use @command{tsort} to produce an ordering of those
5367 functions that satisfies your requirement.
5368
5369 @example
5370 example$ tsort call-graph | tac
5371 dump_remainder
5372 start_lines
5373 file_lines
5374 pipe_lines
5375 xlseek
5376 start_bytes
5377 pipe_bytes
5378 tail_lines
5379 tail_bytes
5380 pretty_name
5381 write_header
5382 tail
5383 recheck
5384 parse_options
5385 tail_file
5386 tail_forever
5387 main
5388 @end example
5389
5390 @command{tsort} detects any cycles in the input and writes the first cycle
5391 encountered to standard error.
5392
5393 Note that for a given partial ordering, generally there is no unique
5394 total ordering.  In the context of the call graph above, the function
5395 @code{parse_options} may be placed anywhere in the list as long as it
5396 precedes @code{main}.
5397
5398 The only options are @option{--help} and @option{--version}.  @xref{Common
5399 options}.
5400
5401 @exitstatus
5402
5403 @menu
5404 * tsort background::            Where tsort came from.
5405 @end menu
5406
5407 @node tsort background
5408 @subsection @command{tsort}: Background
5409
5410 @command{tsort} exists because very early versions of the Unix linker processed
5411 an archive file exactly once, and in order.  As @command{ld} read each object
5412 in the archive, it decided whether it was needed in the program based on
5413 whether it defined any symbols which were undefined at that point in
5414 the link.
5415
5416 This meant that dependencies within the archive had to be handled
5417 specially.  For example, @code{scanf} probably calls @code{read}.  That means
5418 that in a single pass through an archive, it was important for @code{scanf.o}
5419 to appear before read.o, because otherwise a program which calls
5420 @code{scanf} but not @code{read} might end up with an unexpected unresolved
5421 reference to @code{read}.
5422
5423 The way to address this problem was to first generate a set of
5424 dependencies of one object file on another.  This was done by a shell
5425 script called @command{lorder}.  The GNU tools don't provide a version of
5426 lorder, as far as I know, but you can still find it in BSD
5427 distributions.
5428
5429 Then you ran @command{tsort} over the @command{lorder} output, and you used the
5430 resulting sort to define the order in which you added objects to the archive.
5431
5432 This whole procedure has been obsolete since about 1980, because
5433 Unix archives now contain a symbol table (traditionally built by
5434 @command{ranlib}, now generally built by @command{ar} itself), and the Unix
5435 linker uses the symbol table to effectively make multiple passes over
5436 an archive file.
5437
5438 Anyhow, that's where tsort came from.  To solve an old problem with
5439 the way the linker handled archive files, which has since been solved
5440 in different ways.
5441
5442
5443 @node Operating on fields
5444 @chapter Operating on fields
5445
5446 @menu
5447 * cut invocation::              Print selected parts of lines.
5448 * paste invocation::            Merge lines of files.
5449 * join invocation::             Join lines on a common field.
5450 @end menu
5451
5452
5453 @node cut invocation
5454 @section @command{cut}: Print selected parts of lines
5455
5456 @pindex cut
5457 @command{cut} writes to standard output selected parts of each line of each
5458 input file, or standard input if no files are given or for a file name of
5459 @samp{-}.  Synopsis:
5460
5461 @example
5462 cut @var{option}@dots{} [@var{file}]@dots{}
5463 @end example
5464
5465 In the table which follows, the @var{byte-list}, @var{character-list},
5466 and @var{field-list} are one or more numbers or ranges (two numbers
5467 separated by a dash) separated by commas.  Bytes, characters, and
5468 fields are numbered starting at 1.  Incomplete ranges may be
5469 given: @option{-@var{m}} means @samp{1-@var{m}}; @samp{@var{n}-} means
5470 @samp{@var{n}} through end of line or last field.  The list elements
5471 can be repeated, can overlap, and can be specified in any order; but
5472 the selected input is written in the same order that it is read, and
5473 is written exactly once.
5474
5475 The program accepts the following options.  Also see @ref{Common
5476 options}.
5477
5478 @table @samp
5479
5480 @item -b @var{byte-list}
5481 @itemx --bytes=@var{byte-list}
5482 @opindex -b
5483 @opindex --bytes
5484 Select for printing only the bytes in positions listed in
5485 @var{byte-list}.  Tabs and backspaces are treated like any other
5486 character; they take up 1 byte.  If an output delimiter is specified,
5487 (see the description of @option{--output-delimiter}), then output that
5488 string between ranges of selected bytes.
5489
5490 @item -c @var{character-list}
5491 @itemx --characters=@var{character-list}
5492 @opindex -c
5493 @opindex --characters
5494 Select for printing only the characters in positions listed in
5495 @var{character-list}.  The same as @option{-b} for now, but
5496 internationalization will change that.  Tabs and backspaces are
5497 treated like any other character; they take up 1 character.  If an
5498 output delimiter is specified, (see the description of
5499 @option{--output-delimiter}), then output that string between ranges
5500 of selected bytes.
5501
5502 @item -f @var{field-list}
5503 @itemx --fields=@var{field-list}
5504 @opindex -f
5505 @opindex --fields
5506 Select for printing only the fields listed in @var{field-list}.
5507 Fields are separated by a TAB character by default.  Also print any
5508 line that contains no delimiter character, unless the
5509 @option{--only-delimited} (@option{-s}) option is specified.
5510
5511 Note @command{awk} supports more sophisticated field processing,
5512 and by default will use (and discard) runs of blank characters to
5513 separate fields, and ignore leading and trailing blanks.
5514 @example
5515 @verbatim
5516 awk '{print $2}'    # print the second field
5517 awk '{print $NF-1}' # print the penultimate field
5518 awk '{print $2,$1}' # reorder the first two fields
5519 @end verbatim
5520 @end example
5521
5522 In the unlikely event that @command{awk} is unavailable,
5523 one can use the @command{join} command, to process blank
5524 characters as @command{awk} does above.
5525 @example
5526 @verbatim
5527 join -a1 -o 1.2     - /dev/null # print the second field
5528 join -a1 -o 1.2,1.1 - /dev/null # reorder the first two fields
5529 @end verbatim
5530 @end example
5531
5532 @item -d @var{input_delim_byte}
5533 @itemx --delimiter=@var{input_delim_byte}
5534 @opindex -d
5535 @opindex --delimiter
5536 With @option{-f}, use the first byte of @var{input_delim_byte} as
5537 the input fields separator (default is TAB).
5538
5539 @item -n
5540 @opindex -n
5541 Do not split multi-byte characters (no-op for now).
5542
5543 @item -s
5544 @itemx --only-delimited
5545 @opindex -s
5546 @opindex --only-delimited
5547 For @option{-f}, do not print lines that do not contain the field separator
5548 character.  Normally, any line without a field separator is printed verbatim.
5549
5550 @item --output-delimiter=@var{output_delim_string}
5551 @opindex --output-delimiter
5552 With @option{-f}, output fields are separated by @var{output_delim_string}.
5553 The default with @option{-f} is to use the input delimiter.
5554 When using @option{-b} or @option{-c} to select ranges of byte or
5555 character offsets (as opposed to ranges of fields),
5556 output @var{output_delim_string} between non-overlapping
5557 ranges of selected bytes.
5558
5559 @item --complement
5560 @opindex --complement
5561 This option is a @acronym{GNU} extension.
5562 Select for printing the complement of the bytes, characters or fields
5563 selected with the @option{-b}, @option{-c} or @option{-f} options.
5564 In other words, do @emph{not} print the bytes, characters or fields
5565 specified via those options.  This option is useful when you have
5566 many fields and want to print all but a few of them.
5567
5568 @end table
5569
5570 @exitstatus
5571
5572
5573 @node paste invocation
5574 @section @command{paste}: Merge lines of files
5575
5576 @pindex paste
5577 @cindex merging files
5578
5579 @command{paste} writes to standard output lines consisting of sequentially
5580 corresponding lines of each given file, separated by a TAB character.
5581 Standard input is used for a file name of @samp{-} or if no input files
5582 are given.
5583
5584 For example:
5585
5586 @example
5587 $ cat num2
5588 1
5589 2
5590 $ cat let3
5591 a
5592 b
5593 c
5594 $ paste num2 let3
5595 1       a
5596 2       b
5597        @ c
5598 @end example
5599
5600 Synopsis:
5601
5602 @example
5603 paste [@var{option}]@dots{} [@var{file}]@dots{}
5604 @end example
5605
5606 The program accepts the following options.  Also see @ref{Common options}.
5607
5608 @table @samp
5609
5610 @item -s
5611 @itemx --serial
5612 @opindex -s
5613 @opindex --serial
5614 Paste the lines of one file at a time rather than one line from each
5615 file.  Using the above example data:
5616
5617 @example
5618 $ paste -s num2 let3
5619 1       2
5620 a       b       c
5621 @end example
5622
5623 @item -d @var{delim-list}
5624 @itemx --delimiters=@var{delim-list}
5625 @opindex -d
5626 @opindex --delimiters
5627 Consecutively use the characters in @var{delim-list} instead of
5628 TAB to separate merged lines.  When @var{delim-list} is
5629 exhausted, start again at its beginning.  Using the above example data:
5630
5631 @example
5632 $ paste -d '%_' num2 let3 num2
5633 1%a_1
5634 2%b_2
5635 %c_
5636 @end example
5637
5638 @end table
5639
5640 @exitstatus
5641
5642
5643 @node join invocation
5644 @section @command{join}: Join lines on a common field
5645
5646 @pindex join
5647 @cindex common field, joining on
5648
5649 @command{join} writes to standard output a line for each pair of input
5650 lines that have identical join fields.  Synopsis:
5651
5652 @example
5653 join [@var{option}]@dots{} @var{file1} @var{file2}
5654 @end example
5655
5656 Either @var{file1} or @var{file2} (but not both) can be @samp{-},
5657 meaning standard input.  @var{file1} and @var{file2} should be
5658 sorted on the join fields.
5659
5660 @vindex LC_COLLATE
5661 Normally, the sort order is that of the
5662 collating sequence specified by the @env{LC_COLLATE} locale.  Unless
5663 the @option{-t} option is given, the sort comparison ignores blanks at
5664 the start of the join field, as in @code{sort -b}.  If the
5665 @option{--ignore-case} option is given, the sort comparison ignores
5666 the case of characters in the join field, as in @code{sort -f}.
5667
5668 The @command{sort} and @command{join} commands should use consistent
5669 locales and options if the output of @command{sort} is fed to
5670 @command{join}.  You can use a command like @samp{sort -k 1b,1} to
5671 sort a file on its default join field, but if you select a non-default
5672 locale, join field, separator, or comparison options, then you should
5673 do so consistently between @command{join} and @command{sort}.
5674 If @samp{join -t ''} is specified then the whole line is considered which
5675 matches the default operation of sort.
5676
5677 If the input has no unpairable lines, a @acronym{GNU} extension is
5678 available; the sort order can be any order that considers two fields
5679 to be equal if and only if the sort comparison described above
5680 considers them to be equal.  For example:
5681
5682 @example
5683 $ cat file1
5684 a a1
5685 c c1
5686 b b1
5687 $ cat file2
5688 a a2
5689 c c2
5690 b b2
5691 $ join file1 file2
5692 a a1 a2
5693 c c1 c2
5694 b b1 b2
5695 @end example
5696
5697 @set JOIN_COMMAND
5698 @checkOrderOption{join}
5699 @clear JOIN_COMMAND
5700
5701 The defaults are:
5702 @itemize
5703 @item the join field is the first field in each line;
5704 @item fields in the input are separated by one or more blanks, with leading
5705 blanks on the line ignored;
5706 @item fields in the output are separated by a space;
5707 @item each output line consists of the join field, the remaining
5708 fields from @var{file1}, then the remaining fields from @var{file2}.
5709 @end itemize
5710
5711 The program accepts the following options.  Also see @ref{Common options}.
5712
5713 @table @samp
5714
5715 @item -a @var{file-number}
5716 @opindex -a
5717 Print a line for each unpairable line in file @var{file-number} (either
5718 @samp{1} or @samp{2}), in addition to the normal output.
5719
5720 @item --check-order
5721 Fail with an error message if either input file is wrongly ordered.
5722
5723 @item --nocheck-order
5724 Do not check that both input files are in sorted order.  This is the default.
5725
5726 @item -e @var{string}
5727 @opindex -e
5728 Replace those output fields that are missing in the input with @var{string}.
5729 I.E. missing fields specified with the @option{-12jo} options.
5730
5731 @item --header
5732 @opindex --header
5733 Treat the first line of each input file as a header line. The header lines will
5734 be joined and printed as the first output line.  If @option{-o} is used to
5735 specify output format, the header line will be printed according to the
5736 specified format.  The header lines will not be checked for ordering even if
5737 @option{--check-order} is specified.  Also if the header lines from each file
5738 do not match, the heading fields from the first file will be used.
5739
5740 @item -i
5741 @itemx --ignore-case
5742 @opindex -i
5743 @opindex --ignore-case
5744 Ignore differences in case when comparing keys.
5745 With this option, the lines of the input files must be ordered in the same way.
5746 Use @samp{sort -f} to produce this ordering.
5747
5748 @item -1 @var{field}
5749 @opindex -1
5750 Join on field @var{field} (a positive integer) of file 1.
5751
5752 @item -2 @var{field}
5753 @opindex -2
5754 Join on field @var{field} (a positive integer) of file 2.
5755
5756 @item -j @var{field}
5757 Equivalent to @option{-1 @var{field} -2 @var{field}}.
5758
5759 @item -o @var{field-list}
5760 @itemx -o auto
5761 If the keyword @samp{auto} is specified, infer the output format from
5762 the first line in each file.  This is the same as the default output format
5763 but also ensures the same number of fields are output for each line.
5764 Missing fields are replaced with the @option{-e} option and extra fields
5765 are discarded.
5766
5767 Otherwise, construct each output line according to the format in
5768 @var{field-list}.  Each element in @var{field-list} is either the single
5769 character @samp{0} or has the form @var{m.n} where the file number, @var{m},
5770 is @samp{1} or @samp{2} and @var{n} is a positive field number.
5771
5772 A field specification of @samp{0} denotes the join field.
5773 In most cases, the functionality of the @samp{0} field spec
5774 may be reproduced using the explicit @var{m.n} that corresponds
5775 to the join field.  However, when printing unpairable lines
5776 (using either of the @option{-a} or @option{-v} options), there is no way
5777 to specify the join field using @var{m.n} in @var{field-list}
5778 if there are unpairable lines in both files.
5779 To give @command{join} that functionality, @acronym{POSIX} invented the @samp{0}
5780 field specification notation.
5781
5782 The elements in @var{field-list}
5783 are separated by commas or blanks.
5784 Blank separators typically need to be quoted for the shell.  For
5785 example, the commands @samp{join -o 1.2,2.2} and @samp{join -o '1.2
5786 2.2'} are equivalent.
5787
5788 All output lines---including those printed because of any -a or -v
5789 option---are subject to the specified @var{field-list}.
5790
5791 @item -t @var{char}
5792 Use character @var{char} as the input and output field separator.
5793 Treat as significant each occurrence of @var{char} in the input file.
5794 Use @samp{sort -t @var{char}}, without the @option{-b} option of
5795 @samp{sort}, to produce this ordering.  If @samp{join -t ''} is specified,
5796 the whole line is considered, matching the default operation of sort.
5797 If @samp{-t '\0'} is specified then the @acronym{ASCII} @sc{nul}
5798 character is used to delimit the fields.
5799
5800 @item -v @var{file-number}
5801 Print a line for each unpairable line in file @var{file-number}
5802 (either @samp{1} or @samp{2}), instead of the normal output.
5803
5804 @end table
5805
5806 @exitstatus
5807
5808
5809 @node Operating on characters
5810 @chapter Operating on characters
5811
5812 @cindex operating on characters
5813
5814 This commands operate on individual characters.
5815
5816 @menu
5817 * tr invocation::               Translate, squeeze, and/or delete characters.
5818 * expand invocation::           Convert tabs to spaces.
5819 * unexpand invocation::         Convert spaces to tabs.
5820 @end menu
5821
5822
5823 @node tr invocation
5824 @section @command{tr}: Translate, squeeze, and/or delete characters
5825
5826 @pindex tr
5827
5828 Synopsis:
5829
5830 @example
5831 tr [@var{option}]@dots{} @var{set1} [@var{set2}]
5832 @end example
5833
5834 @command{tr} copies standard input to standard output, performing
5835 one of the following operations:
5836
5837 @itemize @bullet
5838 @item
5839 translate, and optionally squeeze repeated characters in the result,
5840 @item
5841 squeeze repeated characters,
5842 @item
5843 delete characters,
5844 @item
5845 delete characters, then squeeze repeated characters from the result.
5846 @end itemize
5847
5848 The @var{set1} and (if given) @var{set2} arguments define ordered
5849 sets of characters, referred to below as @var{set1} and @var{set2}.  These
5850 sets are the characters of the input that @command{tr} operates on.
5851 The @option{--complement} (@option{-c}, @option{-C}) option replaces
5852 @var{set1} with its
5853 complement (all of the characters that are not in @var{set1}).
5854
5855 Currently @command{tr} fully supports only single-byte characters.
5856 Eventually it will support multibyte characters; when it does, the
5857 @option{-C} option will cause it to complement the set of characters,
5858 whereas @option{-c} will cause it to complement the set of values.
5859 This distinction will matter only when some values are not characters,
5860 and this is possible only in locales using multibyte encodings when
5861 the input contains encoding errors.
5862
5863 The program accepts the @option{--help} and @option{--version}
5864 options.  @xref{Common options}.  Options must precede operands.
5865
5866 @exitstatus
5867
5868 @menu
5869 * Character sets::              Specifying sets of characters.
5870 * Translating::                 Changing one set of characters to another.
5871 * Squeezing::                   Squeezing repeats and deleting.
5872 @end menu
5873
5874
5875 @node Character sets
5876 @subsection Specifying sets of characters
5877
5878 @cindex specifying sets of characters
5879
5880 The format of the @var{set1} and @var{set2} arguments resembles
5881 the format of regular expressions; however, they are not regular
5882 expressions, only lists of characters.  Most characters simply
5883 represent themselves in these strings, but the strings can contain
5884 the shorthands listed below, for convenience.  Some of them can be
5885 used only in @var{set1} or @var{set2}, as noted below.
5886
5887 @table @asis
5888
5889 @item Backslash escapes
5890 @cindex backslash escapes
5891
5892 The following backslash escape sequences are recognized:
5893
5894 @table @samp
5895 @item \a
5896 Control-G.
5897 @item \b
5898 Control-H.
5899 @item \f
5900 Control-L.
5901 @item \n
5902 Control-J.
5903 @item \r
5904 Control-M.
5905 @item \t
5906 Control-I.
5907 @item \v
5908 Control-K.
5909 @item \@var{ooo}
5910 The 8-bit character with the value given by @var{ooo}, which is 1 to 3
5911 octal digits.  Note that @samp{\400} is interpreted as the two-byte
5912 sequence, @samp{\040} @samp{0}.
5913 @item \\
5914 A backslash.
5915 @end table
5916
5917 While a backslash followed by a character not listed above is
5918 interpreted as that character, the backslash also effectively
5919 removes any special significance, so it is useful to escape
5920 @samp{[}, @samp{]}, @samp{*}, and @samp{-}.
5921
5922 @item Ranges
5923 @cindex ranges
5924
5925 The notation @samp{@var{m}-@var{n}} expands to all of the characters
5926 from @var{m} through @var{n}, in ascending order.  @var{m} should
5927 collate before @var{n}; if it doesn't, an error results.  As an example,
5928 @samp{0-9} is the same as @samp{0123456789}.
5929
5930 @sc{gnu} @command{tr} does not support the System V syntax that uses square
5931 brackets to enclose ranges.  Translations specified in that format
5932 sometimes work as expected, since the brackets are often transliterated
5933 to themselves.  However, they should be avoided because they sometimes
5934 behave unexpectedly.  For example, @samp{tr -d '[0-9]'} deletes brackets
5935 as well as digits.
5936
5937 Many historically common and even accepted uses of ranges are not
5938 portable.  For example, on @acronym{EBCDIC} hosts using the @samp{A-Z}
5939 range will not do what most would expect because @samp{A} through @samp{Z}
5940 are not contiguous as they are in @acronym{ASCII}.
5941 If you can rely on a @acronym{POSIX} compliant version of @command{tr}, then
5942 the best way to work around this is to use character classes (see below).
5943 Otherwise, it is most portable (and most ugly) to enumerate the members
5944 of the ranges.
5945
5946 @item Repeated characters
5947 @cindex repeated characters
5948
5949 The notation @samp{[@var{c}*@var{n}]} in @var{set2} expands to @var{n}
5950 copies of character @var{c}.  Thus, @samp{[y*6]} is the same as
5951 @samp{yyyyyy}.  The notation @samp{[@var{c}*]} in @var{string2} expands
5952 to as many copies of @var{c} as are needed to make @var{set2} as long as
5953 @var{set1}.  If @var{n} begins with @samp{0}, it is interpreted in
5954 octal, otherwise in decimal.
5955
5956 @item Character classes
5957 @cindex character classes
5958
5959 The notation @samp{[:@var{class}:]} expands to all of the characters in
5960 the (predefined) class @var{class}.  The characters expand in no
5961 particular order, except for the @code{upper} and @code{lower} classes,
5962 which expand in ascending order.  When the @option{--delete} (@option{-d})
5963 and @option{--squeeze-repeats} (@option{-s}) options are both given, any
5964 character class can be used in @var{set2}.  Otherwise, only the
5965 character classes @code{lower} and @code{upper} are accepted in
5966 @var{set2}, and then only if the corresponding character class
5967 (@code{upper} and @code{lower}, respectively) is specified in the same
5968 relative position in @var{set1}.  Doing this specifies case conversion.
5969 The class names are given below; an error results when an invalid class
5970 name is given.
5971
5972 @table @code
5973 @item alnum
5974 @opindex alnum
5975 Letters and digits.
5976 @item alpha
5977 @opindex alpha
5978 Letters.
5979 @item blank
5980 @opindex blank
5981 Horizontal whitespace.
5982 @item cntrl
5983 @opindex cntrl
5984 Control characters.
5985 @item digit
5986 @opindex digit
5987 Digits.
5988 @item graph
5989 @opindex graph
5990 Printable characters, not including space.
5991 @item lower
5992 @opindex lower
5993 Lowercase letters.
5994 @item print
5995 @opindex print
5996 Printable characters, including space.
5997 @item punct
5998 @opindex punct
5999 Punctuation characters.
6000 @item space
6001 @opindex space
6002 Horizontal or vertical whitespace.
6003 @item upper
6004 @opindex upper
6005 Uppercase letters.
6006 @item xdigit
6007 @opindex xdigit
6008 Hexadecimal digits.
6009 @end table
6010
6011 @item Equivalence classes
6012 @cindex equivalence classes
6013
6014 The syntax @samp{[=@var{c}=]} expands to all of the characters that are
6015 equivalent to @var{c}, in no particular order.  Equivalence classes are
6016 a relatively recent invention intended to support non-English alphabets.
6017 But there seems to be no standard way to define them or determine their
6018 contents.  Therefore, they are not fully implemented in @sc{gnu} @command{tr};
6019 each character's equivalence class consists only of that character,
6020 which is of no particular use.
6021
6022 @end table
6023
6024
6025 @node Translating
6026 @subsection Translating
6027
6028 @cindex translating characters
6029
6030 @command{tr} performs translation when @var{set1} and @var{set2} are
6031 both given and the @option{--delete} (@option{-d}) option is not given.
6032 @command{tr} translates each character of its input that is in @var{set1}
6033 to the corresponding character in @var{set2}.  Characters not in
6034 @var{set1} are passed through unchanged.  When a character appears more
6035 than once in @var{set1} and the corresponding characters in @var{set2}
6036 are not all the same, only the final one is used.  For example, these
6037 two commands are equivalent:
6038
6039 @example
6040 tr aaa xyz
6041 tr a z
6042 @end example
6043
6044 A common use of @command{tr} is to convert lowercase characters to
6045 uppercase.  This can be done in many ways.  Here are three of them:
6046
6047 @example
6048 tr abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ
6049 tr a-z A-Z
6050 tr '[:lower:]' '[:upper:]'
6051 @end example
6052
6053 @noindent
6054 But note that using ranges like @code{a-z} above is not portable.
6055
6056 When @command{tr} is performing translation, @var{set1} and @var{set2}
6057 typically have the same length.  If @var{set1} is shorter than
6058 @var{set2}, the extra characters at the end of @var{set2} are ignored.
6059
6060 On the other hand, making @var{set1} longer than @var{set2} is not
6061 portable; @acronym{POSIX} says that the result is undefined.  In this situation,
6062 BSD @command{tr} pads @var{set2} to the length of @var{set1} by repeating
6063 the last character of @var{set2} as many times as necessary.  System V
6064 @command{tr} truncates @var{set1} to the length of @var{set2}.
6065
6066 By default, @sc{gnu} @command{tr} handles this case like BSD @command{tr}.
6067 When the @option{--truncate-set1} (@option{-t}) option is given,
6068 @sc{gnu} @command{tr} handles this case like the System V @command{tr}
6069 instead.  This option is ignored for operations other than translation.
6070
6071 Acting like System V @command{tr} in this case breaks the relatively common
6072 BSD idiom:
6073
6074 @example
6075 tr -cs A-Za-z0-9 '\012'
6076 @end example
6077
6078 @noindent
6079 because it converts only zero bytes (the first element in the
6080 complement of @var{set1}), rather than all non-alphanumerics, to
6081 newlines.
6082
6083 @noindent
6084 By the way, the above idiom is not portable because it uses ranges, and
6085 it assumes that the octal code for newline is 012.
6086 Assuming a @acronym{POSIX} compliant @command{tr}, here is a better
6087 way to write it:
6088
6089 @example
6090 tr -cs '[:alnum:]' '[\n*]'
6091 @end example
6092
6093
6094 @node Squeezing
6095 @subsection Squeezing repeats and deleting
6096
6097 @cindex squeezing repeat characters
6098 @cindex deleting characters
6099
6100 When given just the @option{--delete} (@option{-d}) option, @command{tr}
6101 removes any input characters that are in @var{set1}.
6102
6103 When given just the @option{--squeeze-repeats} (@option{-s}) option,
6104 @command{tr} replaces each input sequence of a repeated character that
6105 is in @var{set1} with a single occurrence of that character.
6106
6107 When given both @option{--delete} and @option{--squeeze-repeats}, @command{tr}
6108 first performs any deletions using @var{set1}, then squeezes repeats
6109 from any remaining characters using @var{set2}.
6110
6111 The @option{--squeeze-repeats} option may also be used when translating,
6112 in which case @command{tr} first performs translation, then squeezes
6113 repeats from any remaining characters using @var{set2}.
6114
6115 Here are some examples to illustrate various combinations of options:
6116
6117 @itemize @bullet
6118
6119 @item
6120 Remove all zero bytes:
6121
6122 @example
6123 tr -d '\0'
6124 @end example
6125
6126 @item
6127 Put all words on lines by themselves.  This converts all
6128 non-alphanumeric characters to newlines, then squeezes each string
6129 of repeated newlines into a single newline:
6130
6131 @example
6132 tr -cs '[:alnum:]' '[\n*]'
6133 @end example
6134
6135 @item
6136 Convert each sequence of repeated newlines to a single newline:
6137
6138 @example
6139 tr -s '\n'
6140 @end example
6141
6142 @item
6143 Find doubled occurrences of words in a document.
6144 @c Separate the following two "the"s, so typo checkers don't complain.
6145 For example, people often write ``the @w{}the'' with the repeated words
6146 separated by a newline.  The Bourne shell script below works first
6147 by converting each sequence of punctuation and blank characters to a
6148 single newline.  That puts each ``word'' on a line by itself.
6149 Next it maps all uppercase characters to lower case, and finally it
6150 runs @command{uniq} with the @option{-d} option to print out only the words
6151 that were repeated.
6152
6153 @example
6154 #!/bin/sh
6155 cat -- "$@@" \
6156   | tr -s '[:punct:][:blank:]' '[\n*]' \
6157   | tr '[:upper:]' '[:lower:]' \
6158   | uniq -d
6159 @end example
6160
6161 @item
6162 Deleting a small set of characters is usually straightforward.  For example,
6163 to remove all @samp{a}s, @samp{x}s, and @samp{M}s you would do this:
6164
6165 @example
6166 tr -d axM
6167 @end example
6168
6169 However, when @samp{-} is one of those characters, it can be tricky because
6170 @samp{-} has special meanings.  Performing the same task as above but also
6171 removing all @samp{-} characters, we might try @code{tr -d -axM}, but
6172 that would fail because @command{tr} would try to interpret @option{-a} as
6173 a command-line option.  Alternatively, we could try putting the hyphen
6174 inside the string, @code{tr -d a-xM}, but that wouldn't work either because
6175 it would make @command{tr} interpret @code{a-x} as the range of characters
6176 @samp{a}@dots{}@samp{x} rather than the three.
6177 One way to solve the problem is to put the hyphen at the end of the list
6178 of characters:
6179
6180 @example
6181 tr -d axM-
6182 @end example
6183
6184 Or you can use @samp{--} to terminate option processing:
6185
6186 @example
6187 tr -d -- -axM
6188 @end example
6189
6190 More generally, use the character class notation @code{[=c=]}
6191 with @samp{-} (or any other character) in place of the @samp{c}:
6192
6193 @example
6194 tr -d '[=-=]axM'
6195 @end example
6196
6197 Note how single quotes are used in the above example to protect the
6198 square brackets from interpretation by a shell.
6199
6200 @end itemize
6201
6202
6203 @node expand invocation
6204 @section @command{expand}: Convert tabs to spaces
6205
6206 @pindex expand
6207 @cindex tabs to spaces, converting
6208 @cindex converting tabs to spaces
6209
6210 @command{expand} writes the contents of each given @var{file}, or standard
6211 input if none are given or for a @var{file} of @samp{-}, to standard
6212 output, with tab characters converted to the appropriate number of
6213 spaces.  Synopsis:
6214
6215 @example
6216 expand [@var{option}]@dots{} [@var{file}]@dots{}
6217 @end example
6218
6219 By default, @command{expand} converts all tabs to spaces.  It preserves
6220 backspace characters in the output; they decrement the column count for
6221 tab calculations.  The default action is equivalent to @option{-t 8} (set
6222 tabs every 8 columns).
6223
6224 The program accepts the following options.  Also see @ref{Common options}.
6225
6226 @table @samp
6227
6228 @item -t @var{tab1}[,@var{tab2}]@dots{}
6229 @itemx --tabs=@var{tab1}[,@var{tab2}]@dots{}
6230 @opindex -t
6231 @opindex --tabs
6232 @cindex tab stops, setting
6233 If only one tab stop is given, set the tabs @var{tab1} spaces apart
6234 (default is 8).  Otherwise, set the tabs at columns @var{tab1},
6235 @var{tab2}, @dots{} (numbered from 0), and replace any tabs beyond the
6236 last tab stop given with single spaces.  Tab stops can be separated by
6237 blanks as well as by commas.
6238
6239 For compatibility, GNU @command{expand} also accepts the obsolete
6240 option syntax, @option{-@var{t1}[,@var{t2}]@dots{}}.  New scripts
6241 should use @option{-t @var{t1}[,@var{t2}]@dots{}} instead.
6242
6243 @item -i
6244 @itemx --initial
6245 @opindex -i
6246 @opindex --initial
6247 @cindex initial tabs, converting
6248 Only convert initial tabs (those that precede all non-space or non-tab
6249 characters) on each line to spaces.
6250
6251 @end table
6252
6253 @exitstatus
6254
6255
6256 @node unexpand invocation
6257 @section @command{unexpand}: Convert spaces to tabs
6258
6259 @pindex unexpand
6260
6261 @command{unexpand} writes the contents of each given @var{file}, or
6262 standard input if none are given or for a @var{file} of @samp{-}, to
6263 standard output, converting blanks at the beginning of each line into
6264 as many tab characters as needed.  In the default @acronym{POSIX}
6265 locale, a @dfn{blank} is a space or a tab; other locales may specify
6266 additional blank characters.  Synopsis:
6267
6268 @example
6269 unexpand [@var{option}]@dots{} [@var{file}]@dots{}
6270 @end example
6271
6272 By default, @command{unexpand} converts only initial blanks (those
6273 that precede all non-blank characters) on each line.  It
6274 preserves backspace characters in the output; they decrement the column
6275 count for tab calculations.  By default, tabs are set at every 8th
6276 column.
6277
6278 The program accepts the following options.  Also see @ref{Common options}.
6279
6280 @table @samp
6281
6282 @item -t @var{tab1}[,@var{tab2}]@dots{}
6283 @itemx --tabs=@var{tab1}[,@var{tab2}]@dots{}
6284 @opindex -t
6285 @opindex --tabs
6286 If only one tab stop is given, set the tabs @var{tab1} columns apart
6287 instead of the default 8.  Otherwise, set the tabs at columns
6288 @var{tab1}, @var{tab2}, @dots{} (numbered from 0), and leave blanks
6289 beyond the tab stops given unchanged.  Tab stops can be separated by
6290 blanks as well as by commas.  This option implies the @option{-a} option.
6291
6292 For compatibility, GNU @command{unexpand} supports the obsolete option syntax,
6293 @option{-@var{tab1}[,@var{tab2}]@dots{}}, where tab stops must be
6294 separated by commas.  (Unlike @option{-t}, this obsolete option does
6295 not imply @option{-a}.)  New scripts should use @option{--first-only -t
6296 @var{tab1}[,@var{tab2}]@dots{}} instead.
6297
6298 @item -a
6299 @itemx --all
6300 @opindex -a
6301 @opindex --all
6302 Also convert all sequences of two or more blanks just before a tab stop,
6303 even if they occur after non-blank characters in a line.
6304
6305 @end table
6306
6307 @exitstatus
6308
6309
6310 @node Directory listing
6311 @chapter Directory listing
6312
6313 This chapter describes the @command{ls} command and its variants @command{dir}
6314 and @command{vdir}, which list information about files.
6315
6316 @menu
6317 * ls invocation::               List directory contents.
6318 * dir invocation::              Briefly ls.
6319 * vdir invocation::             Verbosely ls.
6320 * dircolors invocation::        Color setup for ls, etc.
6321 @end menu
6322
6323
6324 @node ls invocation
6325 @section @command{ls}: List directory contents
6326
6327 @pindex ls
6328 @cindex directory listing
6329
6330 The @command{ls} program lists information about files (of any type,
6331 including directories).  Options and file arguments can be intermixed
6332 arbitrarily, as usual.
6333
6334 For non-option command-line arguments that are directories, by default
6335 @command{ls} lists the contents of directories, not recursively, and
6336 omitting files with names beginning with @samp{.}.  For other non-option
6337 arguments, by default @command{ls} lists just the file name.  If no
6338 non-option argument is specified, @command{ls} operates on the current
6339 directory, acting as if it had been invoked with a single argument of @samp{.}.
6340
6341 @vindex LC_ALL
6342 By default, the output is sorted alphabetically, according to the locale
6343 settings in effect.@footnote{If you use a non-@acronym{POSIX}
6344 locale (e.g., by setting @env{LC_ALL} to @samp{en_US}), then @command{ls} may
6345 produce output that is sorted differently than you're accustomed to.
6346 In that case, set the @env{LC_ALL} environment variable to @samp{C}.}
6347 If standard output is
6348 a terminal, the output is in columns (sorted vertically) and control
6349 characters are output as question marks; otherwise, the output is listed
6350 one per line and control characters are output as-is.
6351
6352 Because @command{ls} is such a fundamental program, it has accumulated many
6353 options over the years.  They are described in the subsections below;
6354 within each section, options are listed alphabetically (ignoring case).
6355 The division of options into the subsections is not absolute, since some
6356 options affect more than one aspect of @command{ls}'s operation.
6357
6358 @cindex exit status of @command{ls}
6359 Exit status:
6360
6361 @display
6362 0 success
6363 1 minor problems  (e.g., failure to access a file or directory not
6364   specified as a command line argument.  This happens when listing a
6365   directory in which entries are actively being removed or renamed.)
6366 2 serious trouble (e.g., memory exhausted, invalid option, failure
6367   to access a file or directory specified as a command line argument
6368   or a directory loop)
6369 @end display
6370
6371 Also see @ref{Common options}.
6372
6373 @menu
6374 * Which files are listed::
6375 * What information is listed::
6376 * Sorting the output::
6377 * Details about version sort::
6378 * General output formatting::
6379 * Formatting file timestamps::
6380 * Formatting the file names::
6381 @end menu
6382
6383
6384 @node Which files are listed
6385 @subsection Which files are listed
6386
6387 These options determine which files @command{ls} lists information for.
6388 By default, @command{ls} lists files and the contents of any
6389 directories on the command line, except that in directories it ignores
6390 files whose names start with @samp{.}.
6391
6392 @table @samp
6393
6394 @item -a
6395 @itemx --all
6396 @opindex -a
6397 @opindex --all
6398 In directories, do not ignore file names that start with @samp{.}.
6399
6400 @item -A
6401 @itemx --almost-all
6402 @opindex -A
6403 @opindex --almost-all
6404 In directories, do not ignore all file names that start with @samp{.};
6405 ignore only @file{.} and @file{..}.  The @option{--all} (@option{-a})
6406 option overrides this option.
6407
6408 @item -B
6409 @itemx --ignore-backups
6410 @opindex -B
6411 @opindex --ignore-backups
6412 @cindex backup files, ignoring
6413 In directories, ignore files that end with @samp{~}.  This option is
6414 equivalent to @samp{--ignore='*~' --ignore='.*~'}.
6415
6416 @item -d
6417 @itemx --directory
6418 @opindex -d
6419 @opindex --directory
6420 List just the names of directories, as with other types of files, rather
6421 than listing their contents.
6422 @c The following sentence is the same as the one for -F.
6423 Do not follow symbolic links listed on the
6424 command line unless the @option{--dereference-command-line} (@option{-H}),
6425 @option{--dereference} (@option{-L}), or
6426 @option{--dereference-command-line-symlink-to-dir} options are specified.
6427
6428 @item -H
6429 @itemx --dereference-command-line
6430 @opindex -H
6431 @opindex --dereference-command-line
6432 @cindex symbolic links, dereferencing
6433 If a command line argument specifies a symbolic link, show information
6434 for the file the link references rather than for the link itself.
6435
6436 @itemx --dereference-command-line-symlink-to-dir
6437 @opindex --dereference-command-line-symlink-to-dir
6438 @cindex symbolic links, dereferencing
6439 Do not dereference symbolic links, with one exception:
6440 if a command line argument specifies a symbolic link that refers to
6441 a directory, show information for that directory rather than for the
6442 link itself.
6443 This is the default behavior when no other dereferencing-related
6444 option has been specified (@option{--classify} (@option{-F}),
6445 @option{--directory} (@option{-d}),
6446 (@option{-l}),
6447 @option{--dereference} (@option{-L}), or
6448 @option{--dereference-command-line} (@option{-H})).
6449
6450 @item --group-directories-first
6451 @opindex --group-directories-first
6452 Group all the directories before the files and then sort the
6453 directories and the files separately using the selected sort key
6454 (see --sort option).
6455 That is, this option specifies a primary sort key,
6456 and the --sort option specifies a secondary key.
6457 However, any use of @option{--sort=none}
6458 (@option{-U}) disables this option altogether.
6459
6460 @item --hide=PATTERN
6461 @opindex --hide=@var{pattern}
6462 In directories, ignore files whose names match the shell pattern
6463 @var{pattern}, unless the @option{--all} (@option{-a}) or
6464 @option{--almost-all} (@option{-A}) is also given.  This
6465 option acts like @option{--ignore=@var{pattern}} except that it has no
6466 effect if @option{--all} (@option{-a}) or @option{--almost-all}
6467 (@option{-A}) is also given.
6468
6469 This option can be useful in shell aliases.  For example, if
6470 @command{lx} is an alias for @samp{ls --hide='*~'} and @command{ly} is
6471 an alias for @samp{ls --ignore='*~'}, then the command @samp{lx -A}
6472 lists the file @file{README~} even though @samp{ly -A} would not.
6473
6474 @item -I @var{pattern}
6475 @itemx --ignore=@var{pattern}
6476 @opindex -I
6477 @opindex --ignore=@var{pattern}
6478 In directories, ignore files whose names match the shell pattern
6479 (not regular expression) @var{pattern}.  As
6480 in the shell, an initial @samp{.} in a file name does not match a
6481 wildcard at the start of @var{pattern}.  Sometimes it is useful
6482 to give this option several times.  For example,
6483
6484 @smallexample
6485 $ ls --ignore='.??*' --ignore='.[^.]' --ignore='#*'
6486 @end smallexample
6487
6488 The first option ignores names of length 3 or more that start with @samp{.},
6489 the second ignores all two-character names that start with @samp{.}
6490 except @samp{..}, and the third ignores names that start with @samp{#}.
6491
6492 @item -L
6493 @itemx --dereference
6494 @opindex -L
6495 @opindex --dereference
6496 @cindex symbolic links, dereferencing
6497 When showing file information for a symbolic link, show information
6498 for the file the link references rather than the link itself.
6499 However, even with this option, @command{ls} still prints the name
6500 of the link itself, not the name of the file that the link points to.
6501
6502 @item -R
6503 @itemx --recursive
6504 @opindex -R
6505 @opindex --recursive
6506 @cindex recursive directory listing
6507 @cindex directory listing, recursive
6508 List the contents of all directories recursively.
6509
6510 @end table
6511
6512
6513 @node What information is listed
6514 @subsection What information is listed
6515
6516 These options affect the information that @command{ls} displays.  By
6517 default, only file names are shown.
6518
6519 @table @samp
6520
6521 @item --author
6522 @opindex --author
6523 @cindex hurd, author, printing
6524 List each file's author when producing long format directory listings.
6525 In GNU/Hurd, file authors can differ from their owners, but in other
6526 operating systems the two are the same.
6527
6528 @item -D
6529 @itemx --dired
6530 @opindex -D
6531 @opindex --dired
6532 @cindex dired Emacs mode support
6533 With the long listing (@option{-l}) format, print an additional line after
6534 the main output:
6535
6536 @example
6537 //DIRED// @var{beg1} @var{end1} @var{beg2} @var{end2} @dots{}
6538 @end example
6539
6540 @noindent
6541 The @var{begn} and @var{endn} are unsigned integers that record the
6542 byte position of the beginning and end of each file name in the output.
6543 This makes it easy for Emacs to find the names, even when they contain
6544 unusual characters such as space or newline, without fancy searching.
6545
6546 If directories are being listed recursively (@option{-R}), output a similar
6547 line with offsets for each subdirectory name:
6548
6549 @example
6550 //SUBDIRED// @var{beg1} @var{end1} @dots{}
6551 @end example
6552
6553 Finally, output a line of the form:
6554
6555 @example
6556 //DIRED-OPTIONS// --quoting-style=@var{word}
6557 @end example
6558
6559 @noindent
6560 where @var{word} is the quoting style (@pxref{Formatting the file names}).
6561
6562 Here is an actual example:
6563
6564 @example
6565 $ mkdir -p a/sub/deeper a/sub2
6566 $ touch a/f1 a/f2
6567 $ touch a/sub/deeper/file
6568 $ ls -gloRF --dired a
6569   a:
6570   total 8
6571   -rw-r--r-- 1    0 Jun 10 12:27 f1
6572   -rw-r--r-- 1    0 Jun 10 12:27 f2
6573   drwxr-xr-x 3 4096 Jun 10 12:27 sub/
6574   drwxr-xr-x 2 4096 Jun 10 12:27 sub2/
6575
6576   a/sub:
6577   total 4
6578   drwxr-xr-x 2 4096 Jun 10 12:27 deeper/
6579
6580   a/sub/deeper:
6581   total 0
6582   -rw-r--r-- 1 0 Jun 10 12:27 file
6583
6584   a/sub2:
6585   total 0
6586 //DIRED// 48 50 84 86 120 123 158 162 217 223 282 286
6587 //SUBDIRED// 2 3 167 172 228 240 290 296
6588 //DIRED-OPTIONS// --quoting-style=literal
6589 @end example
6590
6591 Note that the pairs of offsets on the @samp{//DIRED//} line above delimit
6592 these names: @file{f1}, @file{f2}, @file{sub}, @file{sub2}, @file{deeper},
6593 @file{file}.
6594 The offsets on the @samp{//SUBDIRED//} line delimit the following
6595 directory names: @file{a}, @file{a/sub}, @file{a/sub/deeper}, @file{a/sub2}.
6596
6597 Here is an example of how to extract the fifth entry name, @samp{deeper},
6598 corresponding to the pair of offsets, 222 and 228:
6599
6600 @example
6601 $ ls -gloRF --dired a > out
6602 $ dd bs=1 skip=222 count=6 < out 2>/dev/null; echo
6603 deeper
6604 @end example
6605
6606 Note that although the listing above includes a trailing slash
6607 for the @samp{deeper} entry, the offsets select the name without
6608 the trailing slash.  However, if you invoke @command{ls} with @option{--dired}
6609 along with an option like @option{--escape} (aka @option{-b}) and operate
6610 on a file whose name contains special characters, notice that the backslash
6611 @emph{is} included:
6612
6613 @example
6614 $ touch 'a b'
6615 $ ls -blog --dired 'a b'
6616   -rw-r--r-- 1 0 Jun 10 12:28 a\ b
6617 //DIRED// 30 34
6618 //DIRED-OPTIONS// --quoting-style=escape
6619 @end example
6620
6621 If you use a quoting style that adds quote marks
6622 (e.g., @option{--quoting-style=c}), then the offsets include the quote marks.
6623 So beware that the user may select the quoting style via the environment
6624 variable @env{QUOTING_STYLE}.  Hence, applications using @option{--dired}
6625 should either specify an explicit @option{--quoting-style=literal} option
6626 (aka @option{-N} or @option{--literal}) on the command line, or else be
6627 prepared to parse the escaped names.
6628
6629 @item --full-time
6630 @opindex --full-time
6631 Produce long format directory listings, and list times in full.  It is
6632 equivalent to using @option{--format=long} with
6633 @option{--time-style=full-iso} (@pxref{Formatting file timestamps}).
6634
6635 @item -g
6636 @opindex -g
6637 Produce long format directory listings, but don't display owner information.
6638
6639 @item -G
6640 @itemx --no-group
6641 @opindex -G
6642 @opindex --no-group
6643 Inhibit display of group information in a long format directory listing.
6644 (This is the default in some non-@sc{gnu} versions of @command{ls}, so we
6645 provide this option for compatibility.)
6646
6647 @optHumanReadable
6648
6649 @item -i
6650 @itemx --inode
6651 @opindex -i
6652 @opindex --inode
6653 @cindex inode number, printing
6654 Print the inode number (also called the file serial number and index
6655 number) of each file to the left of the file name.  (This number
6656 uniquely identifies each file within a particular file system.)
6657
6658 @item -l
6659 @itemx --format=long
6660 @itemx --format=verbose
6661 @opindex -l
6662 @opindex --format
6663 @opindex long ls @r{format}
6664 @opindex verbose ls @r{format}
6665 In addition to the name of each file, print the file type, file mode bits,
6666 number of hard links, owner name, group name, size, and
6667 timestamp (@pxref{Formatting file timestamps}), normally
6668 the modification time.  Print question marks for information that
6669 cannot be determined.
6670
6671 Normally the size is printed as a byte count without punctuation, but
6672 this can be overridden (@pxref{Block size}).  For example, @option{-h}
6673 prints an abbreviated, human-readable count, and
6674 @samp{--block-size="'1"} prints a byte count with the thousands
6675 separator of the current locale.
6676
6677 For each directory that is listed, preface the files with a line
6678 @samp{total @var{blocks}}, where @var{blocks} is the total disk allocation
6679 for all files in that directory.  The block size currently defaults to 1024
6680 bytes, but this can be overridden (@pxref{Block size}).
6681 The @var{blocks} computed counts each hard link separately;
6682 this is arguably a deficiency.
6683
6684 The file type is one of the following characters:
6685
6686 @c The commented-out entries are ones we're not sure about.
6687
6688 @table @samp
6689 @item -
6690 regular file
6691 @item b
6692 block special file
6693 @item c
6694 character special file
6695 @item C
6696 high performance (``contiguous data'') file
6697 @item d
6698 directory
6699 @item D
6700 door (Solaris 2.5 and up)
6701 @c @item F
6702 @c semaphore, if this is a distinct file type
6703 @item l
6704 symbolic link
6705 @c @item m
6706 @c multiplexed file (7th edition Unix; obsolete)
6707 @item M
6708 off-line (``migrated'') file (Cray DMF)
6709 @item n
6710 network special file (HP-UX)
6711 @item p
6712 FIFO (named pipe)
6713 @item P
6714 port (Solaris 10 and up)
6715 @c @item Q
6716 @c message queue, if this is a distinct file type
6717 @item s
6718 socket
6719 @c @item S
6720 @c shared memory object, if this is a distinct file type
6721 @c @item T
6722 @c typed memory object, if this is a distinct file type
6723 @c @item w
6724 @c whiteout (4.4BSD; not implemented)
6725 @item ?
6726 some other file type
6727 @end table
6728
6729 @cindex permissions, output by @command{ls}
6730 The file mode bits listed are similar to symbolic mode specifications
6731 (@pxref{Symbolic Modes}).  But @command{ls} combines multiple bits into the
6732 third character of each set of permissions as follows:
6733
6734 @table @samp
6735 @item s
6736 If the set-user-ID or set-group-ID bit and the corresponding executable bit
6737 are both set.
6738
6739 @item S
6740 If the set-user-ID or set-group-ID bit is set but the corresponding
6741 executable bit is not set.
6742
6743 @item t
6744 If the restricted deletion flag or sticky bit, and the
6745 other-executable bit, are both set.  The restricted deletion flag is
6746 another name for the sticky bit.  @xref{Mode Structure}.
6747
6748 @item T
6749 If the restricted deletion flag or sticky bit is set but the
6750 other-executable bit is not set.
6751
6752 @item x
6753 If the executable bit is set and none of the above apply.
6754
6755 @item -
6756 Otherwise.
6757 @end table
6758
6759 Following the file mode bits is a single character that specifies
6760 whether an alternate access method such as an access control list
6761 applies to the file.  When the character following the file mode bits is a
6762 space, there is no alternate access method.  When it is a printing
6763 character, then there is such a method.
6764
6765 GNU @command{ls} uses a @samp{.} character to indicate a file
6766 with an SELinux security context, but no other alternate access method.
6767
6768 A file with any other combination of alternate access methods
6769 is marked with a @samp{+} character.
6770
6771 @item -n
6772 @itemx --numeric-uid-gid
6773 @opindex -n
6774 @opindex --numeric-uid-gid
6775 @cindex numeric uid and gid
6776 @cindex numeric user and group IDs
6777 Produce long format directory listings, but
6778 display numeric user and group IDs instead of the owner and group names.
6779
6780 @item -o
6781 @opindex -o
6782 Produce long format directory listings, but don't display group information.
6783 It is equivalent to using @option{--format=long} with @option{--no-group} .
6784
6785 @item -s
6786 @itemx --size
6787 @opindex -s
6788 @opindex --size
6789 @cindex disk allocation
6790 @cindex size of files, reporting
6791 Print the disk allocation of each file to the left of the file name.
6792 This is the amount of disk space used by the file, which is usually a
6793 bit more than the file's size, but it can be less if the file has holes.
6794
6795 Normally the disk allocation is printed in units of
6796 1024 bytes, but this can be overridden (@pxref{Block size}).
6797
6798 @cindex NFS mounts from BSD to HP-UX
6799 For files that are NFS-mounted from an HP-UX system to a BSD system,
6800 this option reports sizes that are half the correct values.  On HP-UX
6801 systems, it reports sizes that are twice the correct values for files
6802 that are NFS-mounted from BSD systems.  This is due to a flaw in HP-UX;
6803 it also affects the HP-UX @command{ls} program.
6804
6805 @optSi
6806
6807 @item -Z
6808 @itemx --context
6809 @opindex -Z
6810 @opindex --context
6811 @cindex SELinux
6812 @cindex security context
6813 Display the SELinux security context or @samp{?} if none is found.
6814 When used with the @option{-l} option, print the security context
6815 to the left of the size column.
6816
6817 @end table
6818
6819
6820 @node Sorting the output
6821 @subsection Sorting the output
6822
6823 @cindex sorting @command{ls} output
6824 These options change the order in which @command{ls} sorts the information
6825 it outputs.  By default, sorting is done by character code
6826 (e.g., @acronym{ASCII} order).
6827
6828 @table @samp
6829
6830 @item -c
6831 @itemx --time=ctime
6832 @itemx --time=status
6833 @opindex -c
6834 @opindex --time
6835 @opindex ctime@r{, printing or sorting by}
6836 @opindex status time@r{, printing or sorting by}
6837 @opindex use time@r{, printing or sorting files by}
6838 If the long listing format (e.g., @option{-l}, @option{-o}) is being used,
6839 print the status change time (the @samp{ctime} in the inode) instead of
6840 the modification time.
6841 When explicitly sorting by time (@option{--sort=time} or @option{-t})
6842 or when not using a long listing format,
6843 sort according to the status change time.
6844
6845 @item -f
6846 @opindex -f
6847 @cindex unsorted directory listing
6848 @cindex directory order, listing by
6849 Primarily, like @option{-U}---do not sort; list the files in whatever
6850 order they are stored in the directory.  But also enable @option{-a} (list
6851 all files) and disable @option{-l}, @option{--color}, and @option{-s} (if they
6852 were specified before the @option{-f}).
6853
6854 @item -r
6855 @itemx --reverse
6856 @opindex -r
6857 @opindex --reverse
6858 @cindex reverse sorting
6859 Reverse whatever the sorting method is---e.g., list files in reverse
6860 alphabetical order, youngest first, smallest first, or whatever.
6861
6862 @item -S
6863 @itemx --sort=size
6864 @opindex -S
6865 @opindex --sort
6866 @opindex size of files@r{, sorting files by}
6867 Sort by file size, largest first.
6868
6869 @item -t
6870 @itemx --sort=time
6871 @opindex -t
6872 @opindex --sort
6873 @opindex modification time@r{, sorting files by}
6874 Sort by modification time (the @samp{mtime} in the inode), newest first.
6875
6876 @item -u
6877 @itemx --time=atime
6878 @itemx --time=access
6879 @itemx --time=use
6880 @opindex -u
6881 @opindex --time
6882 @opindex use time@r{, printing or sorting files by}
6883 @opindex atime@r{, printing or sorting files by}
6884 @opindex access time@r{, printing or sorting files by}
6885 If the long listing format (e.g., @option{--format=long}) is being used,
6886 print the last access time (the @samp{atime} in the inode).
6887 When explicitly sorting by time (@option{--sort=time} or @option{-t})
6888 or when not using a long listing format, sort according to the access time.
6889
6890 @item -U
6891 @itemx --sort=none
6892 @opindex -U
6893 @opindex --sort
6894 @opindex none@r{, sorting option for @command{ls}}
6895 Do not sort; list the files in whatever order they are
6896 stored in the directory.  (Do not do any of the other unrelated things
6897 that @option{-f} does.)  This is especially useful when listing very large
6898 directories, since not doing any sorting can be noticeably faster.
6899
6900 @item -v
6901 @itemx --sort=version
6902 @opindex -v
6903 @opindex --sort
6904 @opindex version@r{, sorting option for @command{ls}}
6905 Sort by version name and number, lowest first.  It behaves like a default
6906 sort, except that each sequence of decimal digits is treated numerically
6907 as an index/version number.  (@xref{Details about version sort}.)
6908
6909 @item -X
6910 @itemx --sort=extension
6911 @opindex -X
6912 @opindex --sort
6913 @opindex extension@r{, sorting files by}
6914 Sort directory contents alphabetically by file extension (characters
6915 after the last @samp{.}); files with no extension are sorted first.
6916
6917 @end table
6918
6919
6920 @node Details about version sort
6921 @subsection Details about version sort
6922
6923 Version sorting handles the fact that file names frequently include indices or
6924 version numbers.  Standard sorting usually does not produce the order that one
6925 expects because comparisons are made on a character-by-character basis.
6926 Version sorting is especially useful when browsing directories that contain
6927 many files with indices/version numbers in their names:
6928
6929 @example
6930 $ ls -1            $ ls -1v
6931 abc.zml-1.gz       abc.zml-1.gz
6932 abc.zml-12.gz      abc.zml-2.gz
6933 abc.zml-2.gz       abc.zml-12.gz
6934 @end example
6935
6936 Version-sorted strings are compared such that if @var{ver1} and @var{ver2}
6937 are version numbers and @var{prefix} and @var{suffix} (@var{suffix} matching
6938 the regular expression @samp{(\.[A-Za-z~][A-Za-z0-9~]*)*}) are strings then
6939 @var{ver1} < @var{ver2} implies that the name composed of
6940 ``@var{prefix} @var{ver1} @var{suffix}'' sorts before
6941 ``@var{prefix} @var{ver2} @var{suffix}''.
6942
6943 Note also that leading zeros of numeric parts are ignored:
6944
6945 @example
6946 $ ls -1            $ ls -1v
6947 abc-1.007.tgz      abc-1.01a.tgz
6948 abc-1.012b.tgz     abc-1.007.tgz
6949 abc-1.01a.tgz      abc-1.012b.tgz
6950 @end example
6951
6952 This functionality is implemented using gnulib's @code{filevercmp} function,
6953 which has some caveats worth noting.
6954
6955 @itemize @bullet
6956 @item @env{LC_COLLATE} is ignored, which means @samp{ls -v} and @samp{sort -V}
6957 will sort non-numeric prefixes as if the @env{LC_COLLATE} locale category
6958 was set to @samp{C}.
6959 @item Some suffixes will not be matched by the regular
6960 expression mentioned above.  Consequently these examples may
6961 not sort as you expect:
6962
6963 @example
6964 abc-1.2.3.4.7z
6965 abc-1.2.3.7z
6966 @end example
6967
6968 @example
6969 abc-1.2.3.4.x86_64.rpm
6970 abc-1.2.3.x86_64.rpm
6971 @end example
6972 @end itemize
6973
6974 @node General output formatting
6975 @subsection General output formatting
6976
6977 These options affect the appearance of the overall output.
6978
6979 @table @samp
6980
6981 @item -1
6982 @itemx --format=single-column
6983 @opindex -1
6984 @opindex --format
6985 @opindex single-column @r{output of files}
6986 List one file per line.  This is the default for @command{ls} when standard
6987 output is not a terminal.
6988
6989 @item -C
6990 @itemx --format=vertical
6991 @opindex -C
6992 @opindex --format
6993 @opindex vertical @r{sorted files in columns}
6994 List files in columns, sorted vertically.  This is the default for
6995 @command{ls} if standard output is a terminal.  It is always the default
6996 for the @command{dir} program.
6997 @sc{gnu} @command{ls} uses variable width columns to display as many files as
6998 possible in the fewest lines.
6999
7000 @item --color [=@var{when}]
7001 @opindex --color
7002 @cindex color, distinguishing file types with
7003 Specify whether to use color for distinguishing file types.  @var{when}
7004 may be omitted, or one of:
7005 @itemize @bullet
7006 @item none
7007 @vindex none @r{color option}
7008 - Do not use color at all.  This is the default.
7009 @item auto
7010 @vindex auto @r{color option}
7011 @cindex terminal, using color iff
7012 - Only use color if standard output is a terminal.
7013 @item always
7014 @vindex always @r{color option}
7015 - Always use color.
7016 @end itemize
7017 Specifying @option{--color} and no @var{when} is equivalent to
7018 @option{--color=always}.
7019 Piping a colorized listing through a pager like @command{more} or
7020 @command{less} usually produces unreadable results.  However, using
7021 @code{more -f} does seem to work.
7022
7023 @item -F
7024 @itemx --classify
7025 @itemx --indicator-style=classify
7026 @opindex -F
7027 @opindex --classify
7028 @opindex --indicator-style
7029 @cindex file type and executables, marking
7030 @cindex executables and file type, marking
7031 Append a character to each file name indicating the file type.  Also,
7032 for regular files that are executable, append @samp{*}.  The file type
7033 indicators are @samp{/} for directories, @samp{@@} for symbolic links,
7034 @samp{|} for FIFOs, @samp{=} for sockets, @samp{>} for doors,
7035 and nothing for regular files.
7036 @c The following sentence is the same as the one for -d.
7037 Do not follow symbolic links listed on the
7038 command line unless the @option{--dereference-command-line} (@option{-H}),
7039 @option{--dereference} (@option{-L}), or
7040 @option{--dereference-command-line-symlink-to-dir} options are specified.
7041
7042 @item --file-type
7043 @itemx --indicator-style=file-type
7044 @opindex --file-type
7045 @opindex --indicator-style
7046 @cindex file type, marking
7047 Append a character to each file name indicating the file type.  This is
7048 like @option{-F}, except that executables are not marked.
7049
7050 @item --indicator-style=@var{word}
7051 @opindex --indicator-style
7052 Append a character indicator with style @var{word} to entry names,
7053 as follows:
7054
7055 @table @samp
7056 @item none
7057 Do not append any character indicator; this is the default.
7058 @item slash
7059 Append @samp{/} for directories.  This is the same as the @option{-p}
7060 option.
7061 @item file-type
7062 Append @samp{/} for directories, @samp{@@} for symbolic links, @samp{|}
7063 for FIFOs, @samp{=} for sockets, and nothing for regular files.  This is
7064 the same as the @option{--file-type} option.
7065 @item classify
7066 Append @samp{*} for executable regular files, otherwise behave as for
7067 @samp{file-type}.  This is the same as the @option{-F} or
7068 @option{--classify} option.
7069 @end table
7070
7071 @item -k
7072 @opindex -k
7073 Print file sizes in 1024-byte blocks, overriding the default block
7074 size (@pxref{Block size}).
7075 This option is equivalent to @option{--block-size=1K}.
7076
7077 @item -m
7078 @itemx --format=commas
7079 @opindex -m
7080 @opindex --format
7081 @opindex commas@r{, outputting between files}
7082 List files horizontally, with as many as will fit on each line,
7083 separated by @samp{, } (a comma and a space).
7084
7085 @item -p
7086 @itemx --indicator-style=slash
7087 @opindex -p
7088 @opindex --indicator-style
7089 @cindex file type, marking
7090 Append a @samp{/} to directory names.
7091
7092 @item -x
7093 @itemx --format=across
7094 @itemx --format=horizontal
7095 @opindex -x
7096 @opindex --format
7097 @opindex across@r{, listing files}
7098 @opindex horizontal@r{, listing files}
7099 List the files in columns, sorted horizontally.
7100
7101 @item -T @var{cols}
7102 @itemx --tabsize=@var{cols}
7103 @opindex -T
7104 @opindex --tabsize
7105 Assume that each tab stop is @var{cols} columns wide.  The default is 8.
7106 @command{ls} uses tabs where possible in the output, for efficiency.  If
7107 @var{cols} is zero, do not use tabs at all.
7108
7109 @c FIXME: remove in 2009, if Apple Terminal has been fixed for long enough.
7110 Some terminal emulators (at least Apple Terminal 1.5 (133) from Mac OS X 10.4.8)
7111 do not properly align columns to the right of a TAB following a
7112 non-@acronym{ASCII} byte.  If you use such a terminal emulator, use the
7113 @option{-T0} option or put @code{TABSIZE=0} in your environment to tell
7114 @command{ls} to align using spaces, not tabs.
7115
7116 @item -w
7117 @itemx --width=@var{cols}
7118 @opindex -w
7119 @opindex --width
7120 @vindex COLUMNS
7121 Assume the screen is @var{cols} columns wide.  The default is taken
7122 from the terminal settings if possible; otherwise the environment
7123 variable @env{COLUMNS} is used if it is set; otherwise the default
7124 is 80.
7125
7126 @end table
7127
7128
7129 @node Formatting file timestamps
7130 @subsection Formatting file timestamps
7131
7132 By default, file timestamps are listed in abbreviated form, using
7133 a date like @samp{Mar 30@ @ 2002} for non-recent timestamps, and a
7134 date-without-year and time like @samp{Mar 30 23:45} for recent timestamps.
7135 This format can change depending on the current locale as detailed below.
7136
7137 A timestamp is considered to be @dfn{recent} if it is less than six
7138 months old, and is not dated in the future.  If a timestamp dated
7139 today is not listed in recent form, the timestamp is in the future,
7140 which means you probably have clock skew problems which may break
7141 programs like @command{make} that rely on file timestamps.
7142
7143 @vindex TZ
7144 Time stamps are listed according to the time zone rules specified by
7145 the @env{TZ} environment variable, or by the system default rules if
7146 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
7147 with @env{TZ}, libc, The GNU C Library Reference Manual}.
7148
7149 The following option changes how file timestamps are printed.
7150
7151 @table @samp
7152 @item --time-style=@var{style}
7153 @opindex --time-style
7154 @cindex time style
7155 List timestamps in style @var{style}.  The @var{style} should
7156 be one of the following:
7157
7158 @table @samp
7159 @item +@var{format}
7160 @vindex LC_TIME
7161 List timestamps using @var{format}, where @var{format} is interpreted
7162 like the format argument of @command{date} (@pxref{date invocation}).
7163 For example, @option{--time-style="+%Y-%m-%d %H:%M:%S"} causes
7164 @command{ls} to list timestamps like @samp{2002-03-30 23:45:56}.  As
7165 with @command{date}, @var{format}'s interpretation is affected by the
7166 @env{LC_TIME} locale category.
7167
7168 If @var{format} contains two format strings separated by a newline,
7169 the former is used for non-recent files and the latter for recent
7170 files; if you want output columns to line up, you may need to insert
7171 spaces in one of the two formats.
7172
7173 @item full-iso
7174 List timestamps in full using @acronym{ISO} 8601 date, time, and time zone
7175 format with nanosecond precision, e.g., @samp{2002-03-30
7176 23:45:56.477817180 -0700}.  This style is equivalent to
7177 @samp{+%Y-%m-%d %H:%M:%S.%N %z}.
7178
7179 This is useful because the time output includes all the information that
7180 is available from the operating system.  For example, this can help
7181 explain @command{make}'s behavior, since @acronym{GNU} @command{make}
7182 uses the full timestamp to determine whether a file is out of date.
7183
7184 @item long-iso
7185 List @acronym{ISO} 8601 date and time in minutes, e.g.,
7186 @samp{2002-03-30 23:45}.  These timestamps are shorter than
7187 @samp{full-iso} timestamps, and are usually good enough for everyday
7188 work.  This style is equivalent to @samp{+%Y-%m-%d %H:%M}.
7189
7190 @item iso
7191 List @acronym{ISO} 8601 dates for non-recent timestamps (e.g.,
7192 @samp{2002-03-30@ }), and @acronym{ISO} 8601 month, day, hour, and
7193 minute for recent timestamps (e.g., @samp{03-30 23:45}).  These
7194 timestamps are uglier than @samp{long-iso} timestamps, but they carry
7195 nearly the same information in a smaller space and their brevity helps
7196 @command{ls} output fit within traditional 80-column output lines.
7197 The following two @command{ls} invocations are equivalent:
7198
7199 @example
7200 newline='
7201 '
7202 ls -l --time-style="+%Y-%m-%d $newline%m-%d %H:%M"
7203 ls -l --time-style="iso"
7204 @end example
7205
7206 @item locale
7207 @vindex LC_TIME
7208 List timestamps in a locale-dependent form.  For example, a Finnish
7209 locale might list non-recent timestamps like @samp{maalis 30@ @ 2002}
7210 and recent timestamps like @samp{maalis 30 23:45}.  Locale-dependent
7211 timestamps typically consume more space than @samp{iso} timestamps and
7212 are harder for programs to parse because locale conventions vary so
7213 widely, but they are easier for many people to read.
7214
7215 The @env{LC_TIME} locale category specifies the timestamp format.  The
7216 default @acronym{POSIX} locale uses timestamps like @samp{Mar 30@
7217 @ 2002} and @samp{Mar 30 23:45}; in this locale, the following two
7218 @command{ls} invocations are equivalent:
7219
7220 @example
7221 newline='
7222 '
7223 ls -l --time-style="+%b %e  %Y$newline%b %e %H:%M"
7224 ls -l --time-style="locale"
7225 @end example
7226
7227 Other locales behave differently.  For example, in a German locale,
7228 @option{--time-style="locale"} might be equivalent to
7229 @option{--time-style="+%e. %b %Y $newline%e. %b %H:%M"}
7230 and might generate timestamps like @samp{30. M@"ar 2002@ } and
7231 @samp{30. M@"ar 23:45}.
7232
7233 @item posix-@var{style}
7234 @vindex LC_TIME
7235 List @acronym{POSIX}-locale timestamps if the @env{LC_TIME} locale
7236 category is @acronym{POSIX}, @var{style} timestamps otherwise.  For
7237 example, the @samp{posix-long-iso} style lists
7238 timestamps like @samp{Mar 30@ @ 2002} and @samp{Mar 30 23:45} when in
7239 the @acronym{POSIX} locale, and like @samp{2002-03-30 23:45} otherwise.
7240 @end table
7241 @end table
7242
7243 @vindex TIME_STYLE
7244 You can specify the default value of the @option{--time-style} option
7245 with the environment variable @env{TIME_STYLE}; if @env{TIME_STYLE} is not set
7246 the default style is @samp{locale}.  @acronym{GNU} Emacs 21.3 and
7247 later use the @option{--dired} option and therefore can parse any date
7248 format, but if you are using Emacs 21.1 or 21.2 and specify a
7249 non-@acronym{POSIX} locale you may need to set
7250 @samp{TIME_STYLE="posix-long-iso"}.
7251
7252 To avoid certain denial-of-service attacks, timestamps that would be
7253 longer than 1000 bytes may be treated as errors.
7254
7255
7256 @node Formatting the file names
7257 @subsection Formatting the file names
7258
7259 These options change how file names themselves are printed.
7260
7261 @table @samp
7262
7263 @item -b
7264 @itemx --escape
7265 @itemx --quoting-style=escape
7266 @opindex -b
7267 @opindex --escape
7268 @opindex --quoting-style
7269 @cindex backslash sequences for file names
7270 Quote nongraphic characters in file names using alphabetic and octal
7271 backslash sequences like those used in C.
7272
7273 @item -N
7274 @itemx --literal
7275 @itemx --quoting-style=literal
7276 @opindex -N
7277 @opindex --literal
7278 @opindex --quoting-style
7279 Do not quote file names.  However, with @command{ls} nongraphic
7280 characters are still printed as question marks if the output is a
7281 terminal and you do not specify the @option{--show-control-chars}
7282 option.
7283
7284 @item -q
7285 @itemx --hide-control-chars
7286 @opindex -q
7287 @opindex --hide-control-chars
7288 Print question marks instead of nongraphic characters in file names.
7289 This is the default if the output is a terminal and the program is
7290 @command{ls}.
7291
7292 @item -Q
7293 @itemx --quote-name
7294 @itemx --quoting-style=c
7295 @opindex -Q
7296 @opindex --quote-name
7297 @opindex --quoting-style
7298 Enclose file names in double quotes and quote nongraphic characters as
7299 in C.
7300
7301 @item --quoting-style=@var{word}
7302 @opindex --quoting-style
7303 @cindex quoting style
7304 Use style @var{word} to quote file names and other strings that may
7305 contain arbitrary characters.  The @var{word} should
7306 be one of the following:
7307
7308 @table @samp
7309 @item literal
7310 Output strings as-is; this is the same as the @option{-N} or
7311 @option{--literal} option.
7312 @item shell
7313 Quote strings for the shell if they contain shell metacharacters or would
7314 cause ambiguous output.
7315 The quoting is suitable for @acronym{POSIX}-compatible shells like
7316 @command{bash}, but it does not always work for incompatible shells
7317 like @command{csh}.
7318 @item shell-always
7319 Quote strings for the shell, even if they would normally not require quoting.
7320 @item c
7321 Quote strings as for C character string literals, including the
7322 surrounding double-quote characters; this is the same as the
7323 @option{-Q} or @option{--quote-name} option.
7324 @item escape
7325 Quote strings as for C character string literals, except omit the
7326 surrounding double-quote
7327 characters; this is the same as the @option{-b} or @option{--escape} option.
7328 @item clocale
7329 Quote strings as for C character string literals, except use
7330 surrounding quotation marks appropriate for the
7331 locale.
7332 @item locale
7333 @c Use @t instead of @samp to avoid duplicate quoting in some output styles.
7334 Quote strings as for C character string literals, except use
7335 surrounding quotation marks appropriate for the locale, and quote
7336 @t{`like this'} instead of @t{"like
7337 this"} in the default C locale.  This looks nicer on many displays.
7338 @end table
7339
7340 You can specify the default value of the @option{--quoting-style} option
7341 with the environment variable @env{QUOTING_STYLE}.  If that environment
7342 variable is not set, the default value is @samp{literal}, but this
7343 default may change to @samp{shell} in a future version of this package.
7344
7345 @item --show-control-chars
7346 @opindex --show-control-chars
7347 Print nongraphic characters as-is in file names.
7348 This is the default unless the output is a terminal and the program is
7349 @command{ls}.
7350
7351 @end table
7352
7353
7354 @node dir invocation
7355 @section @command{dir}: Briefly list directory contents
7356
7357 @pindex dir
7358 @cindex directory listing, brief
7359
7360 @command{dir} is equivalent to @code{ls -C
7361 -b}; that is, by default files are listed in columns, sorted vertically,
7362 and special characters are represented by backslash escape sequences.
7363
7364 @xref{ls invocation, @command{ls}}.
7365
7366
7367 @node vdir invocation
7368 @section @command{vdir}: Verbosely list directory contents
7369
7370 @pindex vdir
7371 @cindex directory listing, verbose
7372
7373 @command{vdir} is equivalent to @code{ls -l
7374 -b}; that is, by default files are listed in long format and special
7375 characters are represented by backslash escape sequences.
7376
7377 @node dircolors invocation
7378 @section @command{dircolors}: Color setup for @command{ls}
7379
7380 @pindex dircolors
7381 @cindex color setup
7382 @cindex setup for color
7383
7384 @command{dircolors} outputs a sequence of shell commands to set up the
7385 terminal for color output from @command{ls} (and @command{dir}, etc.).
7386 Typical usage:
7387
7388 @example
7389 eval "`dircolors [@var{option}]@dots{} [@var{file}]`"
7390 @end example
7391
7392 If @var{file} is specified, @command{dircolors} reads it to determine which
7393 colors to use for which file types and extensions.  Otherwise, a
7394 precompiled database is used.  For details on the format of these files,
7395 run @samp{dircolors --print-database}.
7396
7397 To make @command{dircolors} read a @file{~/.dircolors} file if it
7398 exists, you can put the following lines in your @file{~/.bashrc} (or
7399 adapt them to your favorite shell):
7400
7401 @example
7402 d=.dircolors
7403 test -r $d && eval "$(dircolors $d)"
7404 @end example
7405
7406 @vindex LS_COLORS
7407 @vindex SHELL @r{environment variable, and color}
7408 The output is a shell command to set the @env{LS_COLORS} environment
7409 variable.  You can specify the shell syntax to use on the command line,
7410 or @command{dircolors} will guess it from the value of the @env{SHELL}
7411 environment variable.
7412
7413 The program accepts the following options.  Also see @ref{Common options}.
7414
7415 @table @samp
7416 @item -b
7417 @itemx --sh
7418 @itemx --bourne-shell
7419 @opindex -b
7420 @opindex --sh
7421 @opindex --bourne-shell
7422 @cindex Bourne shell syntax for color setup
7423 @cindex @command{sh} syntax for color setup
7424 Output Bourne shell commands.  This is the default if the @env{SHELL}
7425 environment variable is set and does not end with @samp{csh} or
7426 @samp{tcsh}.
7427
7428 @item -c
7429 @itemx --csh
7430 @itemx --c-shell
7431 @opindex -c
7432 @opindex --csh
7433 @opindex --c-shell
7434 @cindex C shell syntax for color setup
7435 @cindex @command{csh} syntax for color setup
7436 Output C shell commands.  This is the default if @code{SHELL} ends with
7437 @command{csh} or @command{tcsh}.
7438
7439 @item -p
7440 @itemx --print-database
7441 @opindex -p
7442 @opindex --print-database
7443 @cindex color database, printing
7444 @cindex database for color setup, printing
7445 @cindex printing color database
7446 Print the (compiled-in) default color configuration database.  This
7447 output is itself a valid configuration file, and is fairly descriptive
7448 of the possibilities.
7449
7450 @end table
7451
7452 @exitstatus
7453
7454
7455 @node Basic operations
7456 @chapter Basic operations
7457
7458 @cindex manipulating files
7459
7460 This chapter describes the commands for basic file manipulation:
7461 copying, moving (renaming), and deleting (removing).
7462
7463 @menu
7464 * cp invocation::               Copy files.
7465 * dd invocation::               Convert and copy a file.
7466 * install invocation::          Copy files and set attributes.
7467 * mv invocation::               Move (rename) files.
7468 * rm invocation::               Remove files or directories.
7469 * shred invocation::            Remove files more securely.
7470 @end menu
7471
7472
7473 @node cp invocation
7474 @section @command{cp}: Copy files and directories
7475
7476 @pindex cp
7477 @cindex copying files and directories
7478 @cindex files, copying
7479 @cindex directories, copying
7480
7481 @command{cp} copies files (or, optionally, directories).  The copy is
7482 completely independent of the original.  You can either copy one file to
7483 another, or copy arbitrarily many files to a destination directory.
7484 Synopses:
7485
7486 @example
7487 cp [@var{option}]@dots{} [-T] @var{source} @var{dest}
7488 cp [@var{option}]@dots{} @var{source}@dots{} @var{directory}
7489 cp [@var{option}]@dots{} -t @var{directory} @var{source}@dots{}
7490 @end example
7491
7492 @itemize @bullet
7493 @item
7494 If two file names are given, @command{cp} copies the first file to the
7495 second.
7496
7497 @item
7498 If the @option{--target-directory} (@option{-t}) option is given, or
7499 failing that if the last file is a directory and the
7500 @option{--no-target-directory} (@option{-T}) option is not given,
7501 @command{cp} copies each @var{source} file to the specified directory,
7502 using the @var{source}s' names.
7503 @end itemize
7504
7505 Generally, files are written just as they are read.  For exceptions,
7506 see the @option{--sparse} option below.
7507
7508 By default, @command{cp} does not copy directories.  However, the
7509 @option{-R}, @option{-a}, and @option{-r} options cause @command{cp} to
7510 copy recursively by descending into source directories and copying files
7511 to corresponding destination directories.
7512
7513 When copying from a symbolic link, @command{cp} normally follows the
7514 link only when not copying
7515 recursively.  This default can be overridden with the
7516 @option{--archive} (@option{-a}), @option{-d}, @option{--dereference}
7517 (@option{-L}), @option{--no-dereference} (@option{-P}), and
7518 @option{-H} options.  If more than one of these options is specified,
7519 the last one silently overrides the others.
7520
7521 When copying to a symbolic link, @command{cp} follows the
7522 link only when it refers to an existing regular file.
7523 However, when copying to a dangling symbolic link, @command{cp}
7524 refuses by default, and fails with a diagnostic, since the operation
7525 is inherently dangerous.  This behavior is contrary to historical
7526 practice and to @acronym{POSIX}.
7527 Set @env{POSIXLY_CORRECT} to make @command{cp} attempt to create
7528 the target of a dangling destination symlink, in spite of the possible risk.
7529 Also, when an option like
7530 @option{--backup} or @option{--link} acts to rename or remove the
7531 destination before copying, @command{cp} renames or removes the
7532 symbolic link rather than the file it points to.
7533
7534 By default, @command{cp} copies the contents of special files only
7535 when not copying recursively.  This default can be overridden with the
7536 @option{--copy-contents} option.
7537
7538 @cindex self-backups
7539 @cindex backups, making only
7540 @command{cp} generally refuses to copy a file onto itself, with the
7541 following exception: if @option{--force --backup} is specified with
7542 @var{source} and @var{dest} identical, and referring to a regular file,
7543 @command{cp} will make a backup file, either regular or numbered, as
7544 specified in the usual ways (@pxref{Backup options}).  This is useful when
7545 you simply want to make a backup of an existing file before changing it.
7546
7547 The program accepts the following options.  Also see @ref{Common options}.
7548
7549 @table @samp
7550 @item -a
7551 @itemx --archive
7552 @opindex -a
7553 @opindex --archive
7554 Preserve as much as possible of the structure and attributes of the
7555 original files in the copy (but do not attempt to preserve internal
7556 directory structure; i.e., @samp{ls -U} may list the entries in a copied
7557 directory in a different order).
7558 Try to preserve SELinux security context and extended attributes (xattr),
7559 but ignore any failure to do that and print no corresponding diagnostic.
7560 Equivalent to @option{-dR --preserve=all} with the reduced diagnostics.
7561
7562 @itemx --attributes-only
7563 @opindex --attributes-only
7564 Preserve the specified attributes of the original files in the copy,
7565 but do not copy any data.  See the @option{--preserve} option for
7566 controlling which attributes to copy.
7567
7568 @item -b
7569 @itemx @w{@kbd{--backup}[=@var{method}]}
7570 @opindex -b
7571 @opindex --backup
7572 @vindex VERSION_CONTROL
7573 @cindex backups, making
7574 @xref{Backup options}.
7575 Make a backup of each file that would otherwise be overwritten or removed.
7576 As a special case, @command{cp} makes a backup of @var{source} when the force
7577 and backup options are given and @var{source} and @var{dest} are the same
7578 name for an existing, regular file.  One useful application of this
7579 combination of options is this tiny Bourne shell script:
7580
7581 @example
7582 #!/bin/sh
7583 # Usage: backup FILE...
7584 # Create a @sc{gnu}-style backup of each listed FILE.
7585 for i; do
7586   cp --backup --force -- "$i" "$i"
7587 done
7588 @end example
7589
7590 @item --copy-contents
7591 @cindex directories, copying recursively
7592 @cindex copying directories recursively
7593 @cindex recursively copying directories
7594 @cindex non-directories, copying as special files
7595 If copying recursively, copy the contents of any special files (e.g.,
7596 FIFOs and device files) as if they were regular files.  This means
7597 trying to read the data in each source file and writing it to the
7598 destination.  It is usually a mistake to use this option, as it
7599 normally has undesirable effects on special files like FIFOs and the
7600 ones typically found in the @file{/dev} directory.  In most cases,
7601 @code{cp -R --copy-contents} will hang indefinitely trying to read
7602 from FIFOs and special files like @file{/dev/console}, and it will
7603 fill up your destination disk if you use it to copy @file{/dev/zero}.
7604 This option has no effect unless copying recursively, and it does not
7605 affect the copying of symbolic links.
7606
7607 @item -d
7608 @opindex -d
7609 @cindex symbolic links, copying
7610 @cindex hard links, preserving
7611 Copy symbolic links as symbolic links rather than copying the files that
7612 they point to, and preserve hard links between source files in the copies.
7613 Equivalent to @option{--no-dereference --preserve=links}.
7614
7615 @item -f
7616 @itemx --force
7617 @opindex -f
7618 @opindex --force
7619 When copying without this option and an existing destination file cannot
7620 be opened for writing, the copy fails.  However, with @option{--force}),
7621 when a destination file cannot be opened, @command{cp} then removes it and
7622 tries to open it again.  Contrast this behavior with that enabled by
7623 @option{--link} and @option{--symbolic-link}, whereby the destination file
7624 is never opened but rather is removed unconditionally.  Also see the
7625 description of @option{--remove-destination}.
7626
7627 This option is independent of the @option{--interactive} or
7628 @option{-i} option: neither cancels the effect of the other.
7629
7630 This option is redundant if the @option{--no-clobber} or @option{-n} option is
7631 used.
7632
7633 @item -H
7634 @opindex -H
7635 If a command line argument specifies a symbolic link, then copy the
7636 file it points to rather than the symbolic link itself.  However,
7637 copy (preserving its nature) any symbolic link that is encountered
7638 via recursive traversal.
7639
7640 @item -i
7641 @itemx --interactive
7642 @opindex -i
7643 @opindex --interactive
7644 When copying a file other than a directory, prompt whether to
7645 overwrite an existing destination file. The @option{-i} option overrides
7646 a previous @option{-n} option.
7647
7648 @item -l
7649 @itemx --link
7650 @opindex -l
7651 @opindex --link
7652 Make hard links instead of copies of non-directories.
7653
7654 @item -L
7655 @itemx --dereference
7656 @opindex -L
7657 @opindex --dereference
7658 Follow symbolic links when copying from them.
7659 With this option, @command{cp} cannot create a symbolic link.
7660 For example, a symlink (to regular file) in the source tree will be copied to
7661 a regular file in the destination tree.
7662
7663 @item -n
7664 @itemx --no-clobber
7665 @opindex -n
7666 @opindex --no-clobber
7667 Do not overwrite an existing file. The @option{-n} option overrides a previous
7668 @option{-i} option. This option is mutually exclusive with @option{-b} or
7669 @option{--backup} option.
7670
7671 @item -P
7672 @itemx --no-dereference
7673 @opindex -P
7674 @opindex --no-dereference
7675 @cindex symbolic links, copying
7676 Copy symbolic links as symbolic links rather than copying the files that
7677 they point to.  This option affects only symbolic links in the source;
7678 symbolic links in the destination are always followed if possible.
7679
7680 @item -p
7681 @itemx @w{@kbd{--preserve}[=@var{attribute_list}]}
7682 @opindex -p
7683 @opindex --preserve
7684 @cindex file information, preserving, extended attributes, xattr
7685 Preserve the specified attributes of the original files.
7686 If specified, the @var{attribute_list} must be a comma-separated list
7687 of one or more of the following strings:
7688
7689 @table @samp
7690 @itemx mode
7691 Preserve the file mode bits and access control lists.
7692 @itemx ownership
7693 Preserve the owner and group.  On most modern systems,
7694 only users with appropriate privileges may change the owner of a file,
7695 and ordinary users
7696 may preserve the group ownership of a file only if they happen to be
7697 a member of the desired group.
7698 @itemx timestamps
7699 Preserve the times of last access and last modification, when possible.
7700 On older systems, it is not possible to preserve these attributes
7701 when the affected file is a symbolic link.
7702 However, many systems now provide the @code{utimensat} function,
7703 which makes it possible even for symbolic links.
7704 @itemx links
7705 Preserve in the destination files
7706 any links between corresponding source files.
7707 Note that with @option{-L} or @option{-H}, this option can convert
7708 symbolic links to hard links.  For example,
7709 @example
7710 $ mkdir c; : > a; ln -s a b; cp -aH a b c; ls -i1 c
7711 74161745 a
7712 74161745 b
7713 @end example
7714 @noindent
7715 Note the inputs: @file{b} is a symlink to regular file @file{a},
7716 yet the files in destination directory, @file{c/}, are hard-linked.
7717 Since @option{-a} implies @option{--preserve=links}, and since @option{-H}
7718 tells @command{cp} to dereference command line arguments, it sees two files
7719 with the same inode number, and preserves the perceived hard link.
7720
7721 Here is a similar example that exercises @command{cp}'s @option{-L} option:
7722 @smallexample
7723 $ mkdir b c; (cd b; : > a; ln -s a b); cp -aL b c; ls -i1 c/b
7724 74163295 a
7725 74163295 b
7726 @end smallexample
7727
7728 @itemx context
7729 Preserve SELinux security context of the file, or fail with full diagnostics.
7730 @itemx xattr
7731 Preserve extended attributes of the file, or fail with full diagnostics.
7732 If @command{cp} is built without xattr support, ignore this option.
7733 If SELinux context, ACLs or Capabilities are implemented using xattrs,
7734 they are preserved by this option as well.
7735 @itemx all
7736 Preserve all file attributes.
7737 Equivalent to specifying all of the above, but with the difference
7738 that failure to preserve SELinux security context or extended attributes
7739 does not change @command{cp}'s exit status.  In contrast to @option{-a},
7740 all but @samp{Operation not supported} warnings are output.
7741 @end table
7742
7743 Using @option{--preserve} with no @var{attribute_list} is equivalent
7744 to @option{--preserve=mode,ownership,timestamps}.
7745
7746 In the absence of this option, each destination file is created with the
7747 mode bits of the corresponding source file, minus the bits set in the
7748 umask and minus the set-user-ID and set-group-ID bits.
7749 @xref{File permissions}.
7750
7751 @itemx @w{@kbd{--no-preserve}=@var{attribute_list}}
7752 @cindex file information, preserving
7753 Do not preserve the specified attributes.  The @var{attribute_list}
7754 has the same form as for @option{--preserve}.
7755
7756 @itemx --parents
7757 @opindex --parents
7758 @cindex parent directories and @command{cp}
7759 Form the name of each destination file by appending to the target
7760 directory a slash and the specified name of the source file.  The last
7761 argument given to @command{cp} must be the name of an existing directory.
7762 For example, the command:
7763
7764 @example
7765 cp --parents a/b/c existing_dir
7766 @end example
7767
7768 @noindent
7769 copies the file @file{a/b/c} to @file{existing_dir/a/b/c}, creating
7770 any missing intermediate directories.
7771
7772 @item -R
7773 @itemx -r
7774 @itemx --recursive
7775 @opindex -R
7776 @opindex -r
7777 @opindex --recursive
7778 @cindex directories, copying recursively
7779 @cindex copying directories recursively
7780 @cindex recursively copying directories
7781 @cindex non-directories, copying as special files
7782 Copy directories recursively.  By default, do not follow symbolic
7783 links in the source; see the @option{--archive} (@option{-a}), @option{-d},
7784 @option{--dereference} (@option{-L}), @option{--no-dereference}
7785 (@option{-P}), and @option{-H} options.  Special files are copied by
7786 creating a destination file of the same type as the source; see the
7787 @option{--copy-contents} option.  It is not portable to use
7788 @option{-r} to copy symbolic links or special files.  On some
7789 non-@sc{gnu} systems, @option{-r} implies the equivalent of
7790 @option{-L} and @option{--copy-contents} for historical reasons.
7791 Also, it is not portable to use @option{-R} to copy symbolic links
7792 unless you also specify @option{-P}, as @acronym{POSIX} allows
7793 implementations that dereference symbolic links by default.
7794
7795 @item --reflink[=@var{when}]
7796 @opindex --reflink[=@var{when}]
7797 @cindex COW
7798 @cindex clone
7799 @cindex copy on write
7800 Perform a lightweight, copy-on-write (COW) copy, if supported by the
7801 file system. Once it has succeeded, beware that the source and destination
7802 files share the same disk data blocks as long as they remain unmodified.
7803 Thus, if a disk I/O error affects data blocks of one of the files,
7804 the other suffers the same fate.
7805
7806 The @var{when} value can be one of the following:
7807
7808 @table @samp
7809 @item always
7810 The default behavior: if the copy-on-write operation is not supported
7811 then report the failure for each file and exit with a failure status.
7812
7813 @item auto
7814 If the copy-on-write operation is not supported then fall back
7815 to the standard copy behaviour.
7816 @end table
7817
7818 This option is overridden by the @option{--link}, @option{--symbolic-link}
7819 and @option{--attributes-only} options, thus allowing it to be used
7820 to configure the default data copying behavior for @command{cp}.
7821 For example, with the following alias, @command{cp} will use the
7822 minimum amount of space supported by the file system.
7823
7824 @example
7825 alias cp='cp --reflink=auto --sparse=always'
7826 @end example
7827
7828 @item --remove-destination
7829 @opindex --remove-destination
7830 Remove each existing destination file before attempting to open it
7831 (contrast with @option{-f} above).
7832
7833 @item --sparse=@var{when}
7834 @opindex --sparse=@var{when}
7835 @cindex sparse files, copying
7836 @cindex holes, copying files with
7837 @findex read @r{system call, and holes}
7838 A @dfn{sparse file} contains @dfn{holes}---a sequence of zero bytes that
7839 does not occupy any physical disk blocks; the @samp{read} system call
7840 reads these as zeros.  This can both save considerable disk space and
7841 increase speed, since many binary files contain lots of consecutive zero
7842 bytes.  By default, @command{cp} detects holes in input source files via a crude
7843 heuristic and makes the corresponding output file sparse as well.
7844 Only regular files may be sparse.
7845
7846 The @var{when} value can be one of the following:
7847
7848 @table @samp
7849 @item auto
7850 The default behavior: if the input file is sparse, attempt to make
7851 the output file sparse, too.  However, if an output file exists but
7852 refers to a non-regular file, then do not attempt to make it sparse.
7853
7854 @item always
7855 For each sufficiently long sequence of zero bytes in the input file,
7856 attempt to create a corresponding hole in the output file, even if the
7857 input file does not appear to be sparse.
7858 This is useful when the input file resides on a file system
7859 that does not support sparse files
7860 (for example,  @samp{efs} file systems in SGI IRIX 5.3 and earlier),
7861 but the output file is on a type of file system that does support them.
7862 Holes may be created only in regular files, so if the destination file
7863 is of some other type, @command{cp} does not even try to make it sparse.
7864
7865 @item never
7866 Never make the output file sparse.
7867 This is useful in creating a file for use with the @command{mkswap} command,
7868 since such a file must not have any holes.
7869 @end table
7870
7871 @optStripTrailingSlashes
7872
7873 @item -s
7874 @itemx --symbolic-link
7875 @opindex -s
7876 @opindex --symbolic-link
7877 @cindex symbolic links, copying with
7878 Make symbolic links instead of copies of non-directories.  All source
7879 file names must be absolute (starting with @samp{/}) unless the
7880 destination files are in the current directory.  This option merely
7881 results in an error message on systems that do not support symbolic links.
7882
7883 @optBackupSuffix
7884
7885 @optTargetDirectory
7886
7887 @optNoTargetDirectory
7888
7889 @item -u
7890 @itemx --update
7891 @opindex -u
7892 @opindex --update
7893 @cindex newer files, copying only
7894 Do not copy a non-directory that has an existing destination with the
7895 same or newer modification time.  If time stamps are being preserved,
7896 the comparison is to the source time stamp truncated to the
7897 resolutions of the destination file system and of the system calls
7898 used to update time stamps; this avoids duplicate work if several
7899 @samp{cp -pu} commands are executed with the same source and
7900 destination.
7901
7902 @item -v
7903 @itemx --verbose
7904 @opindex -v
7905 @opindex --verbose
7906 Print the name of each file before copying it.
7907
7908 @item -x
7909 @itemx --one-file-system
7910 @opindex -x
7911 @opindex --one-file-system
7912 @cindex file systems, omitting copying to different
7913 Skip subdirectories that are on different file systems from the one that
7914 the copy started on.
7915 However, mount point directories @emph{are} copied.
7916
7917 @end table
7918
7919 @exitstatus
7920
7921
7922 @node dd invocation
7923 @section @command{dd}: Convert and copy a file
7924
7925 @pindex dd
7926 @cindex converting while copying a file
7927
7928 @command{dd} copies a file (from standard input to standard output, by
7929 default) with a changeable I/O block size, while optionally performing
7930 conversions on it.  Synopses:
7931
7932 @example
7933 dd [@var{operand}]@dots{}
7934 dd @var{option}
7935 @end example
7936
7937 The only options are @option{--help} and @option{--version}.
7938 @xref{Common options}.  @command{dd} accepts the following operands.
7939
7940 @table @samp
7941
7942 @item if=@var{file}
7943 @opindex if
7944 Read from @var{file} instead of standard input.
7945
7946 @item of=@var{file}
7947 @opindex of
7948 Write to @var{file} instead of standard output.  Unless
7949 @samp{conv=notrunc} is given, @command{dd} truncates @var{file} to zero
7950 bytes (or the size specified with @samp{seek=}).
7951
7952 @item ibs=@var{bytes}
7953 @opindex ibs
7954 @cindex block size of input
7955 @cindex input block size
7956 Set the input block size to @var{bytes}.
7957 This makes @command{dd} read @var{bytes} per block.
7958 The default is 512 bytes.
7959
7960 @item obs=@var{bytes}
7961 @opindex obs
7962 @cindex block size of output
7963 @cindex output block size
7964 Set the output block size to @var{bytes}.
7965 This makes @command{dd} write @var{bytes} per block.
7966 The default is 512 bytes.
7967
7968 @item bs=@var{bytes}
7969 @opindex bs
7970 @cindex block size
7971 Set both input and output block sizes to @var{bytes}.
7972 This makes @command{dd} read and write @var{bytes} per block,
7973 overriding any @samp{ibs} and @samp{obs} settings.
7974 In addition, if no data-transforming @option{conv} option is specified,
7975 input is copied to the output as soon as it's read,
7976 even if it is smaller than the block size.
7977
7978 @item cbs=@var{bytes}
7979 @opindex cbs
7980 @cindex block size of conversion
7981 @cindex conversion block size
7982 @cindex fixed-length records, converting to variable-length
7983 @cindex variable-length records, converting to fixed-length
7984 Set the conversion block size to @var{bytes}.
7985 When converting variable-length records to fixed-length ones
7986 (@option{conv=block}) or the reverse (@option{conv=unblock}),
7987 use @var{bytes} as the fixed record length.
7988
7989 @item skip=@var{blocks}
7990 @opindex skip
7991 Skip @var{blocks} @samp{ibs}-byte blocks in the input file before copying.
7992
7993 @item seek=@var{blocks}
7994 @opindex seek
7995 Skip @var{blocks} @samp{obs}-byte blocks in the output file before copying.
7996
7997 @item count=@var{blocks}
7998 @opindex count
7999 Copy @var{blocks} @samp{ibs}-byte blocks from the input file, instead
8000 of everything until the end of the file.
8001
8002 @item status=noxfer
8003 @opindex status
8004 Do not print the overall transfer rate and volume statistics
8005 that normally make up the third status line when @command{dd} exits.
8006
8007 @item conv=@var{conversion}[,@var{conversion}]@dots{}
8008 @opindex conv
8009 Convert the file as specified by the @var{conversion} argument(s).
8010 (No spaces around any comma(s).)
8011
8012 Conversions:
8013
8014 @table @samp
8015
8016 @item ascii
8017 @opindex ascii@r{, converting to}
8018 Convert @acronym{EBCDIC} to @acronym{ASCII},
8019 using the conversion table specified by @acronym{POSIX}.
8020 This provides a 1:1 translation for all 256 bytes.
8021
8022 @item ebcdic
8023 @opindex ebcdic@r{, converting to}
8024 Convert @acronym{ASCII} to @acronym{EBCDIC}.
8025 This is the inverse of the @samp{ascii} conversion.
8026
8027 @item ibm
8028 @opindex alternate ebcdic@r{, converting to}
8029 Convert @acronym{ASCII} to alternate @acronym{EBCDIC},
8030 using the alternate conversion table specified by @acronym{POSIX}.
8031 This is not a 1:1 translation, but reflects common historical practice
8032 for @samp{~}, @samp{[}, and @samp{]}.
8033
8034 The @samp{ascii}, @samp{ebcdic}, and @samp{ibm} conversions are
8035 mutually exclusive.
8036
8037 @item block
8038 @opindex block @r{(space-padding)}
8039 For each line in the input, output @samp{cbs} bytes, replacing the
8040 input newline with a space and padding with spaces as necessary.
8041
8042 @item unblock
8043 @opindex unblock
8044 Remove any trailing spaces in each @samp{cbs}-sized input block,
8045 and append a newline.
8046
8047 The @samp{block} and @samp{unblock} conversions are mutually exclusive.
8048
8049 @item lcase
8050 @opindex lcase@r{, converting to}
8051 Change uppercase letters to lowercase.
8052
8053 @item ucase
8054 @opindex ucase@r{, converting to}
8055 Change lowercase letters to uppercase.
8056
8057 The @samp{lcase} and @samp{ucase} conversions are mutually exclusive.
8058
8059 @item swab
8060 @opindex swab @r{(byte-swapping)}
8061 @cindex byte-swapping
8062 Swap every pair of input bytes.  @sc{gnu} @command{dd}, unlike others, works
8063 when an odd number of bytes are read---the last byte is simply copied
8064 (since there is nothing to swap it with).
8065
8066 @item sync
8067 @opindex sync @r{(padding with @acronym{ASCII} @sc{nul}s)}
8068 Pad every input block to size of @samp{ibs} with trailing zero bytes.
8069 When used with @samp{block} or @samp{unblock}, pad with spaces instead of
8070 zero bytes.
8071
8072 @end table
8073
8074 The following ''conversions'' are really file flags
8075 and don't effect and internal processing:
8076
8077 @table @samp
8078 @item excl
8079 @opindex excl
8080 @cindex creating output file, requiring
8081 Fail if the output file already exists; @command{dd} must create the
8082 output file itself.
8083
8084 @item nocreat
8085 @opindex nocreat
8086 @cindex creating output file, avoiding
8087 Do not create the output file; the output file must already exist.
8088
8089 The @samp{excl} and @samp{nocreat} conversions are mutually exclusive.
8090
8091 @item notrunc
8092 @opindex notrunc
8093 @cindex truncating output file, avoiding
8094 Do not truncate the output file.
8095
8096 @item noerror
8097 @opindex noerror
8098 @cindex read errors, ignoring
8099 Continue after read errors.
8100
8101 @item fdatasync
8102 @opindex fdatasync
8103 @cindex synchronized data writes, before finishing
8104 Synchronize output data just before finishing.  This forces a physical
8105 write of output data.
8106
8107 @item fsync
8108 @opindex fsync
8109 @cindex synchronized data and metadata writes, before finishing
8110 Synchronize output data and metadata just before finishing.  This
8111 forces a physical write of output data and metadata.
8112
8113 @end table
8114
8115 @item iflag=@var{flag}[,@var{flag}]@dots{}
8116 @opindex iflag
8117 Access the input file using the flags specified by the @var{flag}
8118 argument(s).  (No spaces around any comma(s).)
8119
8120 @item oflag=@var{flag}[,@var{flag}]@dots{}
8121 @opindex oflag
8122 Access the output file using the flags specified by the @var{flag}
8123 argument(s).  (No spaces around any comma(s).)
8124
8125 Here are the flags.  Not every flag is supported on every operating
8126 system.
8127
8128 @table @samp
8129
8130 @item append
8131 @opindex append
8132 @cindex appending to the output file
8133 Write in append mode, so that even if some other process is writing to
8134 this file, every @command{dd} write will append to the current
8135 contents of the file.  This flag makes sense only for output.
8136 If you combine this flag with the @samp{of=@var{file}} operand,
8137 you should also specify @samp{conv=notrunc} unless you want the
8138 output file to be truncated before being appended to.
8139
8140 @item cio
8141 @opindex cio
8142 @cindex concurrent I/O
8143 Use concurrent I/O mode for data.  This mode performs direct I/O
8144 and drops the @acronym{POSIX} requirement to serialize all I/O to the same file.
8145 A file cannot be opened in CIO mode and with a standard open at the
8146 same time.
8147
8148 @item direct
8149 @opindex direct
8150 @cindex direct I/O
8151 Use direct I/O for data, avoiding the buffer cache.
8152 Note that the kernel may impose restrictions on read or write buffer sizes.
8153 For example, with an ext4 destination file system and a linux-based kernel,
8154 using @samp{oflag=direct} will cause writes to fail with @code{EINVAL} if the
8155 output buffer size is not a multiple of 512.
8156
8157 @item directory
8158 @opindex directory
8159 @cindex directory I/O
8160
8161 Fail unless the file is a directory.  Most operating systems do not
8162 allow I/O to a directory, so this flag has limited utility.
8163
8164 @item dsync
8165 @opindex dsync
8166 @cindex synchronized data reads
8167 Use synchronized I/O for data.  For the output file, this forces a
8168 physical write of output data on each write.  For the input file,
8169 this flag can matter when reading from a remote file that has been
8170 written to synchronously by some other process.  Metadata (e.g.,
8171 last-access and last-modified time) is not necessarily synchronized.
8172
8173 @item sync
8174 @opindex sync
8175 @cindex synchronized data and metadata I/O
8176 Use synchronized I/O for both data and metadata.
8177
8178 @item nocache
8179 @opindex nocache
8180 @cindex discarding file cache
8181 Discard the data cache for a file.
8182 When count=0 all cache is discarded,
8183 otherwise the cache is dropped for the processed
8184 portion of the file.  Also when count=0
8185 failure to discard the cache is diagnosed
8186 and reflected in the exit status.
8187 Here as some usage examples:
8188
8189 @example
8190 # Advise to drop cache for whole file
8191 dd if=ifile iflag=nocache count=0
8192
8193 # Ensure drop cache for the whole file
8194 dd of=ofile oflag=nocache conv=notrunc,fdatasync count=0
8195
8196 # Drop cache for part of file
8197 dd if=ifile iflag=nocache skip=10 count=10 of=/dev/null
8198
8199 # Stream data using just the read-ahead cache
8200 dd if=ifile of=ofile iflag=nocache oflag=nocache
8201 @end example
8202
8203 @item nonblock
8204 @opindex nonblock
8205 @cindex nonblocking I/O
8206 Use non-blocking I/O.
8207
8208 @item noatime
8209 @opindex noatime
8210 @cindex access time
8211 Do not update the file's access time.
8212 Some older file systems silently ignore this flag, so it is a good
8213 idea to test it on your files before relying on it.
8214
8215 @item noctty
8216 @opindex noctty
8217 @cindex controlling terminal
8218 Do not assign the file to be a controlling terminal for @command{dd}.
8219 This has no effect when the file is not a terminal.
8220 On many hosts (e.g., @acronym{GNU}/Linux hosts), this option has no effect
8221 at all.
8222
8223 @item nofollow
8224 @opindex nofollow
8225 @cindex symbolic links, following
8226 Do not follow symbolic links.
8227
8228 @item nolinks
8229 @opindex nolinks
8230 @cindex hard links
8231 Fail if the file has multiple hard links.
8232
8233 @item binary
8234 @opindex binary
8235 @cindex binary I/O
8236 Use binary I/O.  This option has an effect only on nonstandard
8237 platforms that distinguish binary from text I/O.
8238
8239 @item text
8240 @opindex text
8241 @cindex text I/O
8242 Use text I/O.  Like @samp{binary}, this option has no effect on
8243 standard platforms.
8244
8245 @item fullblock
8246 @opindex fullblock
8247 Accumulate full blocks from input.  The @code{read} system call
8248 may return early if a full block is not available.
8249 When that happens, continue calling @code{read} to fill the remainder
8250 of the block.
8251 This flag can be used only with @code{iflag}.
8252
8253 @end table
8254
8255 These flags are not supported on all systems, and @samp{dd} rejects
8256 attempts to use them when they are not supported.  When reading from
8257 standard input or writing to standard output, the @samp{nofollow} and
8258 @samp{noctty} flags should not be specified, and the other flags
8259 (e.g., @samp{nonblock}) can affect how other processes behave with the
8260 affected file descriptors, even after @command{dd} exits.
8261
8262 @end table
8263
8264 @cindex multipliers after numbers
8265 The numeric-valued strings above (@var{bytes} and @var{blocks}) can be
8266 followed by a multiplier: @samp{b}=512, @samp{c}=1,
8267 @samp{w}=2, @samp{x@var{m}}=@var{m}, or any of the
8268 standard block size suffixes like @samp{k}=1024 (@pxref{Block size}).
8269
8270 Any block size you specify via @samp{bs=}, @samp{ibs=}, @samp{obs=}, @samp{cbs=}
8271 should not be too large---values larger than a few megabytes
8272 are generally wasteful or (as in the gigabyte..exabyte case) downright
8273 counterproductive or error-inducing.
8274
8275 Use different @command{dd} invocations to use different block sizes for
8276 skipping and I/O@.  For example, the following shell commands copy data
8277 in 512 KiB blocks between a disk and a tape, but do not save or restore a
8278 4 KiB label at the start of the disk:
8279
8280 @example
8281 disk=/dev/rdsk/c0t1d0s2
8282 tape=/dev/rmt/0
8283
8284 # Copy all but the label from disk to tape.
8285 (dd bs=4k skip=1 count=0 && dd bs=512k) <$disk >$tape
8286
8287 # Copy from tape back to disk, but leave the disk label alone.
8288 (dd bs=4k seek=1 count=0 && dd bs=512k) <$tape >$disk
8289 @end example
8290
8291 Sending an @samp{INFO} signal to a running @command{dd}
8292 process makes it print I/O statistics to standard error
8293 and then resume copying.  In the example below,
8294 @command{dd} is run in the background to copy 10 million blocks.
8295 The @command{kill} command makes it output intermediate I/O statistics,
8296 and when @command{dd} completes normally or is killed by the
8297 @code{SIGINT} signal, it outputs the final statistics.
8298
8299 @example
8300 $ dd if=/dev/zero of=/dev/null count=10MB & pid=$!
8301 $ kill -s INFO $pid; wait $pid
8302 3385223+0 records in
8303 3385223+0 records out
8304 1733234176 bytes (1.7 GB) copied, 6.42173 seconds, 270 MB/s
8305 10000000+0 records in
8306 10000000+0 records out
8307 5120000000 bytes (5.1 GB) copied, 18.913 seconds, 271 MB/s
8308 @end example
8309
8310 @vindex POSIXLY_CORRECT
8311 On systems lacking the @samp{INFO} signal @command{dd} responds to the
8312 @samp{USR1} signal instead, unless the @env{POSIXLY_CORRECT}
8313 environment variable is set.
8314
8315 @exitstatus
8316
8317
8318 @node install invocation
8319 @section @command{install}: Copy files and set attributes
8320
8321 @pindex install
8322 @cindex copying files and setting attributes
8323
8324 @command{install} copies files while setting their file mode bits and, if
8325 possible, their owner and group.  Synopses:
8326
8327 @example
8328 install [@var{option}]@dots{} [-T] @var{source} @var{dest}
8329 install [@var{option}]@dots{} @var{source}@dots{} @var{directory}
8330 install [@var{option}]@dots{} -t @var{directory} @var{source}@dots{}
8331 install [@var{option}]@dots{} -d @var{directory}@dots{}
8332 @end example
8333
8334 @itemize @bullet
8335 @item
8336 If two file names are given, @command{install} copies the first file to the
8337 second.
8338
8339 @item
8340 If the @option{--target-directory} (@option{-t}) option is given, or
8341 failing that if the last file is a directory and the
8342 @option{--no-target-directory} (@option{-T}) option is not given,
8343 @command{install} copies each @var{source} file to the specified
8344 directory, using the @var{source}s' names.
8345
8346 @item
8347 If the @option{--directory} (@option{-d}) option is given,
8348 @command{install} creates each @var{directory} and any missing parent
8349 directories.  Parent directories are created with mode
8350 @samp{u=rwx,go=rx} (755), regardless of the @option{-m} option or the
8351 current umask.  @xref{Directory Setuid and Setgid}, for how the
8352 set-user-ID and set-group-ID bits of parent directories are inherited.
8353 @end itemize
8354
8355 @cindex Makefiles, installing programs in
8356 @command{install} is similar to @command{cp}, but allows you to control the
8357 attributes of destination files.  It is typically used in Makefiles to
8358 copy programs into their destination directories.  It refuses to copy
8359 files onto themselves.
8360
8361 @cindex extended attributes, xattr
8362 @command{install} never preserves extended attributes (xattr).
8363
8364 The program accepts the following options.  Also see @ref{Common options}.
8365
8366 @table @samp
8367
8368 @optBackup
8369
8370 @item -C
8371 @itemx --compare
8372 @opindex -C
8373 @opindex --compare
8374 Compare each pair of source and destination files, and if the destination has
8375 identical content and any specified owner, group, permissions, and possibly
8376 SELinux context, then do not modify the destination at all.
8377
8378 @item -c
8379 @opindex -c
8380 Ignored; for compatibility with old Unix versions of @command{install}.
8381
8382 @item -D
8383 @opindex -D
8384 Create any missing parent directories of @var{dest},
8385 then copy @var{source} to @var{dest}.
8386 This option is ignored if a destination directory is specified
8387 via @option{--target-directory=DIR}.
8388
8389 @item -d
8390 @itemx --directory
8391 @opindex -d
8392 @opindex --directory
8393 @cindex directories, creating with given attributes
8394 @cindex parent directories, creating missing
8395 @cindex leading directories, creating missing
8396 Create any missing parent directories, giving them the default
8397 attributes.  Then create each given directory, setting their owner,
8398 group and mode as given on the command line or to the defaults.
8399
8400 @item -g @var{group}
8401 @itemx --group=@var{group}
8402 @opindex -g
8403 @opindex --group
8404 @cindex group ownership of installed files, setting
8405 Set the group ownership of installed files or directories to
8406 @var{group}.  The default is the process's current group.  @var{group}
8407 may be either a group name or a numeric group ID.
8408
8409 @item -m @var{mode}
8410 @itemx --mode=@var{mode}
8411 @opindex -m
8412 @opindex --mode
8413 @cindex permissions of installed files, setting
8414 Set the file mode bits for the installed file or directory to @var{mode},
8415 which can be either an octal number, or a symbolic mode as in
8416 @command{chmod}, with @samp{a=} (no access allowed to anyone) as the
8417 point of departure (@pxref{File permissions}).
8418 The default mode is @samp{u=rwx,go=rx,a-s}---read, write, and
8419 execute for the owner, read and execute for group and other, and with
8420 set-user-ID and set-group-ID disabled.
8421 This default is not quite the same as @samp{755}, since it disables
8422 instead of preserving set-user-ID and set-group-ID on directories.
8423 @xref{Directory Setuid and Setgid}.
8424
8425 @item -o @var{owner}
8426 @itemx --owner=@var{owner}
8427 @opindex -o
8428 @opindex --owner
8429 @cindex ownership of installed files, setting
8430 @cindex appropriate privileges
8431 @vindex root @r{as default owner}
8432 If @command{install} has appropriate privileges (is run as root), set the
8433 ownership of installed files or directories to @var{owner}.  The default
8434 is @code{root}.  @var{owner} may be either a user name or a numeric user
8435 ID.
8436
8437 @item --preserve-context
8438 @opindex --preserve-context
8439 @cindex SELinux
8440 @cindex security context
8441 Preserve the SELinux security context of files and directories.
8442 Failure to preserve the context in all of the files or directories
8443 will result in an exit status of 1.  If SELinux is disabled then
8444 print a warning and ignore the option.
8445
8446 @item -p
8447 @itemx --preserve-timestamps
8448 @opindex -p
8449 @opindex --preserve-timestamps
8450 @cindex timestamps of installed files, preserving
8451 Set the time of last access and the time of last modification of each
8452 installed file to match those of each corresponding original file.
8453 When a file is installed without this option, its last access and
8454 last modification times are both set to the time of installation.
8455 This option is useful if you want to use the last modification times
8456 of installed files to keep track of when they were last built as opposed
8457 to when they were last installed.
8458
8459 @item -s
8460 @itemx --strip
8461 @opindex -s
8462 @opindex --strip
8463 @cindex symbol table information, stripping
8464 @cindex stripping symbol table information
8465 Strip the symbol tables from installed binary executables.
8466
8467 @itemx --strip-program=@var{program}
8468 @opindex --strip-program
8469 @cindex symbol table information, stripping, program
8470 Program used to strip binaries.
8471
8472 @optBackupSuffix
8473
8474 @optTargetDirectory
8475
8476 @optNoTargetDirectory
8477
8478 @item -v
8479 @itemx --verbose
8480 @opindex -v
8481 @opindex --verbose
8482 Print the name of each file before copying it.
8483
8484 @item -Z @var{context}
8485 @itemx --context=@var{context}
8486 @opindex -Z
8487 @opindex --context
8488 @cindex SELinux
8489 @cindex security context
8490 Set the default SELinux security context to be used for any
8491 created files and directories.  If SELinux is disabled then
8492 print a warning and ignore the option.
8493
8494 @end table
8495
8496 @exitstatus
8497
8498
8499 @node mv invocation
8500 @section @command{mv}: Move (rename) files
8501
8502 @pindex mv
8503
8504 @command{mv} moves or renames files (or directories).  Synopses:
8505
8506 @example
8507 mv [@var{option}]@dots{} [-T] @var{source} @var{dest}
8508 mv [@var{option}]@dots{} @var{source}@dots{} @var{directory}
8509 mv [@var{option}]@dots{} -t @var{directory} @var{source}@dots{}
8510 @end example
8511
8512 @itemize @bullet
8513 @item
8514 If two file names are given, @command{mv} moves the first file to the
8515 second.
8516
8517 @item
8518 If the @option{--target-directory} (@option{-t}) option is given, or
8519 failing that if the last file is a directory and the
8520 @option{--no-target-directory} (@option{-T}) option is not given,
8521 @command{mv} moves each @var{source} file to the specified
8522 directory, using the @var{source}s' names.
8523 @end itemize
8524
8525 @command{mv} can move any type of file from one file system to another.
8526 Prior to version @code{4.0} of the fileutils,
8527 @command{mv} could move only regular files between file systems.
8528 For example, now @command{mv} can move an entire directory hierarchy
8529 including special device files from one partition to another.  It first
8530 uses some of the same code that's used by @code{cp -a} to copy the
8531 requested directories and files, then (assuming the copy succeeded)
8532 it removes the originals.  If the copy fails, then the part that was
8533 copied to the destination partition is removed.  If you were to copy
8534 three directories from one partition to another and the copy of the first
8535 directory succeeded, but the second didn't, the first would be left on
8536 the destination partition and the second and third would be left on the
8537 original partition.
8538
8539 @cindex extended attributes, xattr
8540 @command{mv} always tries to copy extended attributes (xattr), which may
8541 include SELinux context, ACLs or Capabilities.
8542 Upon failure all but @samp{Operation not supported} warnings are output.
8543
8544 @cindex prompting, and @command{mv}
8545 If a destination file exists but is normally unwritable, standard input
8546 is a terminal, and the @option{-f} or @option{--force} option is not given,
8547 @command{mv} prompts the user for whether to replace the file.  (You might
8548 own the file, or have write permission on its directory.)  If the
8549 response is not affirmative, the file is skipped.
8550
8551 @emph{Warning}: Avoid specifying a source name with a trailing slash,
8552 when it might be a symlink to a directory.
8553 Otherwise, @command{mv} may do something very surprising, since
8554 its behavior depends on the underlying rename system call.
8555 On a system with a modern Linux-based kernel, it fails with
8556 @code{errno=ENOTDIR}.
8557 However, on other systems (at least FreeBSD 6.1 and Solaris 10) it silently
8558 renames not the symlink but rather the directory referenced by the symlink.
8559 @xref{Trailing slashes}.
8560
8561 The program accepts the following options.  Also see @ref{Common options}.
8562
8563 @table @samp
8564
8565 @optBackup
8566
8567 @item -f
8568 @itemx --force
8569 @opindex -f
8570 @opindex --force
8571 @cindex prompts, omitting
8572 Do not prompt the user before removing a destination file.
8573 @macro mvOptsIfn
8574 If you specify more than one of the @option{-i}, @option{-f}, @option{-n}
8575 options, only the final one takes effect.
8576 @end macro
8577 @mvOptsIfn
8578
8579 @item -i
8580 @itemx --interactive
8581 @opindex -i
8582 @opindex --interactive
8583 @cindex prompts, forcing
8584 Prompt whether to overwrite each existing destination file, regardless
8585 of its permissions.
8586 If the response is not affirmative, the file is skipped.
8587 @mvOptsIfn
8588
8589 @item -n
8590 @itemx --no-clobber
8591 @opindex -n
8592 @opindex --no-clobber
8593 @cindex prompts, omitting
8594 Do not overwrite an existing file.
8595 @mvOptsIfn
8596 This option is mutually exclusive with @option{-b} or @option{--backup} option.
8597
8598 @item -u
8599 @itemx --update
8600 @opindex -u
8601 @opindex --update
8602 @cindex newer files, moving only
8603 Do not move a non-directory that has an existing destination with the
8604 same or newer modification time.
8605 If the move is across file system boundaries, the comparison is to the
8606 source time stamp truncated to the resolutions of the destination file
8607 system and of the system calls used to update time stamps; this avoids
8608 duplicate work if several @samp{mv -u} commands are executed with the
8609 same source and destination.
8610
8611 @item -v
8612 @itemx --verbose
8613 @opindex -v
8614 @opindex --verbose
8615 Print the name of each file before moving it.
8616
8617 @optStripTrailingSlashes
8618
8619 @optBackupSuffix
8620
8621 @optTargetDirectory
8622
8623 @optNoTargetDirectory
8624
8625 @end table
8626
8627 @exitstatus
8628
8629
8630 @node rm invocation
8631 @section @command{rm}: Remove files or directories
8632
8633 @pindex rm
8634 @cindex removing files or directories
8635
8636 @command{rm} removes each given @var{file}.  By default, it does not remove
8637 directories.  Synopsis:
8638
8639 @example
8640 rm [@var{option}]@dots{} [@var{file}]@dots{}
8641 @end example
8642
8643 @cindex prompting, and @command{rm}
8644 If the @option{-I} or @option{--interactive=once} option is given,
8645 and there are more than three files or the @option{-r}, @option{-R},
8646 or @option{--recursive} are given, then @command{rm} prompts the user
8647 for whether to proceed with the entire operation.  If the response is
8648 not affirmative, the entire command is aborted.
8649
8650 Otherwise, if a file is unwritable, standard input is a terminal, and
8651 the @option{-f} or @option{--force} option is not given, or the
8652 @option{-i} or @option{--interactive=always} option @emph{is} given,
8653 @command{rm} prompts the user for whether to remove the file.
8654 If the response is not affirmative, the file is skipped.
8655
8656 Any attempt to remove a file whose last file name component is
8657 @file{.} or @file{..} is rejected without any prompting.
8658
8659 @emph{Warning}: If you use @command{rm} to remove a file, it is usually
8660 possible to recover the contents of that file.  If you want more assurance
8661 that the contents are truly unrecoverable, consider using @command{shred}.
8662
8663 The program accepts the following options.  Also see @ref{Common options}.
8664
8665 @table @samp
8666
8667 @item -f
8668 @itemx --force
8669 @opindex -f
8670 @opindex --force
8671 Ignore nonexistent files and never prompt the user.
8672 Ignore any previous @option{--interactive} (@option{-i}) option.
8673
8674 @item -i
8675 @opindex -i
8676 Prompt whether to remove each file.
8677 If the response is not affirmative, the file is skipped.
8678 Ignore any previous @option{--force} (@option{-f}) option.
8679 Equivalent to @option{--interactive=always}.
8680
8681 @item -I
8682 @opindex -I
8683 Prompt once whether to proceed with the command, if more than three
8684 files are named or if a recursive removal is requested.  Ignore any
8685 previous @option{--force} (@option{-f}) option.  Equivalent to
8686 @option{--interactive=once}.
8687
8688 @itemx --interactive [=@var{when}]
8689 @opindex --interactive
8690 Specify when to issue an interactive prompt.  @var{when} may be
8691 omitted, or one of:
8692 @itemize @bullet
8693 @item never
8694 @vindex never @r{interactive option}
8695 - Do not prompt at all.
8696 @item once
8697 @vindex once @r{interactive option}
8698 - Prompt once if more than three files are named or if a recursive
8699 removal is requested.  Equivalent to @option{-I}.
8700 @item always
8701 @vindex always @r{interactive option}
8702 - Prompt for every file being removed.  Equivalent to @option{-i}.
8703 @end itemize
8704 @option{--interactive} with no @var{when} is equivalent to
8705 @option{--interactive=always}.
8706
8707 @itemx --one-file-system
8708 @opindex --one-file-system
8709 @cindex one file system, restricting @command{rm} to
8710 When removing a hierarchy recursively, skip any directory that is on a
8711 file system different from that of the corresponding command line argument.
8712
8713 @cindex bind mount
8714 This option is useful when removing a build ``chroot'' hierarchy,
8715 which normally contains no valuable data.  However, it is not uncommon
8716 to bind-mount @file{/home} into such a hierarchy, to make it easier to
8717 use one's start-up file.  The catch is that it's easy to forget to
8718 unmount @file{/home}.  Then, when you use @command{rm -rf} to remove
8719 your normally throw-away chroot, that command will remove everything
8720 under @file{/home}, too.
8721 Use the @option{--one-file-system} option, and it will
8722 warn about and skip directories on other file systems.
8723 Of course, this will not save your @file{/home} if it and your
8724 chroot happen to be on the same file system.
8725
8726 @itemx --preserve-root
8727 @opindex --preserve-root
8728 @cindex root directory, disallow recursive destruction
8729 Fail upon any attempt to remove the root directory, @file{/},
8730 when used with the @option{--recursive} option.
8731 This is the default behavior.
8732 @xref{Treating / specially}.
8733
8734 @itemx --no-preserve-root
8735 @opindex --no-preserve-root
8736 @cindex root directory, allow recursive destruction
8737 Do not treat @file{/} specially when removing recursively.
8738 This option is not recommended unless you really want to
8739 remove all the files on your computer.
8740 @xref{Treating / specially}.
8741
8742 @item -r
8743 @itemx -R
8744 @itemx --recursive
8745 @opindex -r
8746 @opindex -R
8747 @opindex --recursive
8748 @cindex directories, removing (recursively)
8749 Remove the listed directories and their contents recursively.
8750
8751 @item -v
8752 @itemx --verbose
8753 @opindex -v
8754 @opindex --verbose
8755 Print the name of each file before removing it.
8756
8757 @end table
8758
8759 @cindex files beginning with @samp{-}, removing
8760 @cindex @samp{-}, removing files beginning with
8761 One common question is how to remove files whose names begin with a
8762 @samp{-}.  @sc{gnu} @command{rm}, like every program that uses the @code{getopt}
8763 function to parse its arguments, lets you use the @samp{--} option to
8764 indicate that all following arguments are non-options.  To remove a file
8765 called @file{-f} in the current directory, you could type either:
8766
8767 @example
8768 rm -- -f
8769 @end example
8770
8771 @noindent
8772 or:
8773
8774 @example
8775 rm ./-f
8776 @end example
8777
8778 @opindex - @r{and Unix @command{rm}}
8779 The Unix @command{rm} program's use of a single @samp{-} for this purpose
8780 predates the development of the getopt standard syntax.
8781
8782 @exitstatus
8783
8784
8785 @node shred invocation
8786 @section @command{shred}: Remove files more securely
8787
8788 @pindex shred
8789 @cindex data, erasing
8790 @cindex erasing data
8791
8792 @command{shred} overwrites devices or files, to help prevent even
8793 very expensive hardware from recovering the data.
8794
8795 Ordinarily when you remove a file (@pxref{rm invocation}), the data is
8796 not actually destroyed.  Only the index listing where the file is
8797 stored is destroyed, and the storage is made available for reuse.
8798 There are undelete utilities that will attempt to reconstruct the index
8799 and can bring the file back if the parts were not reused.
8800
8801 On a busy system with a nearly-full drive, space can get reused in a few
8802 seconds.  But there is no way to know for sure.  If you have sensitive
8803 data, you may want to be sure that recovery is not possible by actually
8804 overwriting the file with non-sensitive data.
8805
8806 However, even after doing that, it is possible to take the disk back
8807 to a laboratory and use a lot of sensitive (and expensive) equipment
8808 to look for the faint ``echoes'' of the original data underneath the
8809 overwritten data.  If the data has only been overwritten once, it's not
8810 even that hard.
8811
8812 The best way to remove something irretrievably is to destroy the media
8813 it's on with acid, melt it down, or the like.  For cheap removable media
8814 like floppy disks, this is the preferred method.  However, hard drives
8815 are expensive and hard to melt, so the @command{shred} utility tries
8816 to achieve a similar effect non-destructively.
8817
8818 This uses many overwrite passes, with the data patterns chosen to
8819 maximize the damage they do to the old data.  While this will work on
8820 floppies, the patterns are designed for best effect on hard drives.
8821 For more details, see the source code and Peter Gutmann's paper
8822 @uref{http://www.cs.auckland.ac.nz/~pgut001/pubs/secure_del.html,
8823 @cite{Secure Deletion of Data from Magnetic and Solid-State Memory}},
8824 from the proceedings of the Sixth @acronym{USENIX} Security Symposium (San Jose,
8825 California, July 22--25, 1996).
8826
8827 @strong{Please note} that @command{shred} relies on a very important assumption:
8828 that the file system overwrites data in place.  This is the traditional
8829 way to do things, but many modern file system designs do not satisfy this
8830 assumption.  Exceptions include:
8831
8832 @itemize @bullet
8833
8834 @item
8835 Log-structured or journaled file systems, such as those supplied with
8836 AIX and Solaris, and JFS, ReiserFS, XFS, Ext3 (in @code{data=journal} mode),
8837 BFS, NTFS, etc.@: when they are configured to journal @emph{data}.
8838
8839 @item
8840 File systems that write redundant data and carry on even if some writes
8841 fail, such as RAID-based file systems.
8842
8843 @item
8844 File systems that make snapshots, such as Network Appliance's NFS server.
8845
8846 @item
8847 File systems that cache in temporary locations, such as NFS version 3
8848 clients.
8849
8850 @item
8851 Compressed file systems.
8852 @end itemize
8853
8854 In the particular case of ext3 file systems, the above disclaimer applies (and
8855 @command{shred} is thus of limited effectiveness) only in @code{data=journal}
8856 mode, which journals file data in addition to just metadata. In both
8857 the @code{data=ordered} (default) and @code{data=writeback} modes,
8858 @command{shred} works as usual.  Ext3 journaling modes can be changed
8859 by adding the @code{data=something} option to the mount options for a
8860 particular file system in the @file{/etc/fstab} file, as documented in
8861 the mount man page (man mount).
8862
8863 If you are not sure how your file system operates, then you should assume
8864 that it does not overwrite data in place, which means that shred cannot
8865 reliably operate on regular files in your file system.
8866
8867 Generally speaking, it is more reliable to shred a device than a file,
8868 since this bypasses the problem of file system design mentioned above.
8869 However, even shredding devices is not always completely reliable.  For
8870 example, most disks map out bad sectors invisibly to the application; if
8871 the bad sectors contain sensitive data, @command{shred} won't be able to
8872 destroy it.
8873
8874 @command{shred} makes no attempt to detect or report this problem, just as
8875 it makes no attempt to do anything about backups.  However, since it is
8876 more reliable to shred devices than files, @command{shred} by default does
8877 not truncate or remove the output file.  This default is more suitable
8878 for devices, which typically cannot be truncated and should not be
8879 removed.
8880
8881 Finally, consider the risk of backups and mirrors.
8882 File system backups and remote mirrors may contain copies of the
8883 file that cannot be removed, and that will allow a shredded file
8884 to be recovered later.  So if you keep any data you may later want
8885 to destroy using @command{shred}, be sure that it is not backed up or mirrored.
8886
8887 @example
8888 shred [@var{option}]@dots{} @var{file}[@dots{}]
8889 @end example
8890
8891 The program accepts the following options.  Also see @ref{Common options}.
8892
8893 @table @samp
8894
8895 @item -f
8896 @itemx --force
8897 @opindex -f
8898 @opindex --force
8899 @cindex force deletion
8900 Override file permissions if necessary to allow overwriting.
8901
8902 @item -@var{number}
8903 @itemx -n @var{number}
8904 @itemx --iterations=@var{number}
8905 @opindex -n @var{number}
8906 @opindex --iterations=@var{number}
8907 @cindex iterations, selecting the number of
8908 By default, @command{shred} uses @value{SHRED_DEFAULT_PASSES} passes of
8909 overwrite. You can reduce this to save time, or increase it if you think it's
8910 appropriate. After 25 passes all of the internal overwrite patterns will have
8911 been used at least once.
8912
8913 @item --random-source=@var{file}
8914 @opindex --random-source
8915 @cindex random source for shredding
8916 Use @var{file} as a source of random data used to overwrite and to
8917 choose pass ordering.  @xref{Random sources}.
8918
8919 @item -s @var{bytes}
8920 @itemx --size=@var{bytes}
8921 @opindex -s @var{bytes}
8922 @opindex --size=@var{bytes}
8923 @cindex size of file to shred
8924 Shred the first @var{bytes} bytes of the file.  The default is to shred
8925 the whole file.  @var{bytes} can be followed by a size specification like
8926 @samp{K}, @samp{M}, or @samp{G} to specify a multiple.  @xref{Block size}.
8927
8928 @item -u
8929 @itemx --remove
8930 @opindex -u
8931 @opindex --remove
8932 @cindex removing files after shredding
8933 After shredding a file, truncate it (if possible) and then remove it.
8934 If a file has multiple links, only the named links will be removed.
8935
8936 @item -v
8937 @itemx --verbose
8938 @opindex -v
8939 @opindex --verbose
8940 Display to standard error all status updates as sterilization proceeds.
8941
8942 @item -x
8943 @itemx --exact
8944 @opindex -x
8945 @opindex --exact
8946 By default, @command{shred} rounds the size of a regular file up to the next
8947 multiple of the file system block size to fully erase the last block
8948 of the file.
8949 Use @option{--exact} to suppress that behavior.
8950 Thus, by default if you shred a 10-byte regular file on a system with 512-byte
8951 blocks, the resulting file will be 512 bytes long.  With this option,
8952 shred does not increase the apparent size of the file.
8953
8954 @item -z
8955 @itemx --zero
8956 @opindex -z
8957 @opindex --zero
8958 Normally, the last pass that @command{shred} writes is made up of
8959 random data.  If this would be conspicuous on your hard drive (for
8960 example, because it looks like encrypted data), or you just think
8961 it's tidier, the @option{--zero} option adds an additional overwrite pass with
8962 all zero bits.  This is in addition to the number of passes specified
8963 by the @option{--iterations} option.
8964
8965 @end table
8966
8967 You might use the following command to erase all trace of the
8968 file system you'd created on the floppy disk in your first drive.
8969 That command takes about 20 minutes to erase a ``1.44MB'' (actually
8970 1440 KiB) floppy.
8971
8972 @example
8973 shred --verbose /dev/fd0
8974 @end example
8975
8976 Similarly, to erase all data on a selected partition of
8977 your hard disk, you could give a command like this:
8978
8979 @example
8980 shred --verbose /dev/sda5
8981 @end example
8982
8983 On modern disks, a single pass should be adequate,
8984 and it will take one third the time of the default three-pass approach.
8985
8986 @example
8987 # 1 pass, write pseudo-random data; 3x faster than the default
8988 shred --verbose -n1 /dev/sda5
8989 @end example
8990
8991 To be on the safe side, use at least one pass that overwrites using
8992 pseudo-random data.  I.e., don't be tempted to use @samp{-n0 --zero},
8993 in case some disk controller optimizes the process of writing blocks
8994 of all zeros, and thereby does not clear all bytes in a block.
8995 Some SSDs may do just that.
8996
8997 A @var{file} of @samp{-} denotes standard output.
8998 The intended use of this is to shred a removed temporary file.
8999 For example:
9000
9001 @example
9002 i=`mktemp`
9003 exec 3<>"$i"
9004 rm -- "$i"
9005 echo "Hello, world" >&3
9006 shred - >&3
9007 exec 3>-
9008 @end example
9009
9010 However, the command @samp{shred - >file} does not shred the contents
9011 of @var{file}, since the shell truncates @var{file} before invoking
9012 @command{shred}.  Use the command @samp{shred file} or (if using a
9013 Bourne-compatible shell) the command @samp{shred - 1<>file} instead.
9014
9015 @exitstatus
9016
9017
9018 @node Special file types
9019 @chapter Special file types
9020
9021 @cindex special file types
9022 @cindex file types, special
9023
9024 This chapter describes commands which create special types of files (and
9025 @command{rmdir}, which removes directories, one special file type).
9026
9027 @cindex special file types
9028 @cindex file types
9029 Although Unix-like operating systems have markedly fewer special file
9030 types than others, not @emph{everything} can be treated only as the
9031 undifferentiated byte stream of @dfn{normal files}.  For example, when a
9032 file is created or removed, the system must record this information,
9033 which it does in a @dfn{directory}---a special type of file.  Although
9034 you can read directories as normal files, if you're curious, in order
9035 for the system to do its job it must impose a structure, a certain
9036 order, on the bytes of the file.  Thus it is a ``special'' type of file.
9037
9038 Besides directories, other special file types include named pipes
9039 (FIFOs), symbolic links, sockets, and so-called @dfn{special files}.
9040
9041 @menu
9042 * link invocation::             Make a hard link via the link syscall
9043 * ln invocation::               Make links between files.
9044 * mkdir invocation::            Make directories.
9045 * mkfifo invocation::           Make FIFOs (named pipes).
9046 * mknod invocation::            Make block or character special files.
9047 * readlink invocation::         Print value of a symlink or canonical file name.
9048 * rmdir invocation::            Remove empty directories.
9049 * unlink invocation::           Remove files via the unlink syscall
9050 @end menu
9051
9052
9053 @node link invocation
9054 @section @command{link}: Make a hard link via the link syscall
9055
9056 @pindex link
9057 @cindex links, creating
9058 @cindex hard links, creating
9059 @cindex creating links (hard only)
9060
9061 @command{link} creates a single hard link at a time.
9062 It is a minimalist interface to the system-provided
9063 @code{link} function.  @xref{Hard Links, , , libc,
9064 The GNU C Library Reference Manual}.
9065 It avoids the bells and whistles of the more commonly-used
9066 @command{ln} command (@pxref{ln invocation}).
9067 Synopsis:
9068
9069 @example
9070 link @var{filename} @var{linkname}
9071 @end example
9072
9073 @var{filename} must specify an existing file, and @var{linkname}
9074 must specify a nonexistent entry in an existing directory.
9075 @command{link} simply calls @code{link (@var{filename}, @var{linkname})}
9076 to create the link.
9077
9078 On a @acronym{GNU} system, this command acts like @samp{ln --directory
9079 --no-target-directory @var{filename} @var{linkname}}.  However, the
9080 @option{--directory} and @option{--no-target-directory} options are
9081 not specified by @acronym{POSIX}, and the @command{link} command is
9082 more portable in practice.
9083
9084 If @var{filename} is a symbolic link, it is unspecified whether
9085 @var{linkname} will be a hard link to the symbolic link or to the
9086 target of the symbolic link.  Use @command{ln -P} or @command{ln -L}
9087 to specify which behavior is desired.
9088
9089 @exitstatus
9090
9091
9092 @node ln invocation
9093 @section @command{ln}: Make links between files
9094
9095 @pindex ln
9096 @cindex links, creating
9097 @cindex hard links, creating
9098 @cindex symbolic (soft) links, creating
9099 @cindex creating links (hard or soft)
9100
9101 @cindex file systems and hard links
9102 @command{ln} makes links between files.  By default, it makes hard links;
9103 with the @option{-s} option, it makes symbolic (or @dfn{soft}) links.
9104 Synopses:
9105
9106 @example
9107 ln [@var{option}]@dots{} [-T] @var{target} @var{linkname}
9108 ln [@var{option}]@dots{} @var{target}
9109 ln [@var{option}]@dots{} @var{target}@dots{} @var{directory}
9110 ln [@var{option}]@dots{} -t @var{directory} @var{target}@dots{}
9111 @end example
9112
9113 @itemize @bullet
9114
9115 @item
9116 If two file names are given, @command{ln} creates a link to the first
9117 file from the second.
9118
9119 @item
9120 If one @var{target} is given, @command{ln} creates a link to that file
9121 in the current directory.
9122
9123 @item
9124 If the @option{--target-directory} (@option{-t}) option is given, or
9125 failing that if the last file is a directory and the
9126 @option{--no-target-directory} (@option{-T}) option is not given,
9127 @command{ln} creates a link to each @var{target} file in the specified
9128 directory, using the @var{target}s' names.
9129
9130 @end itemize
9131
9132 Normally @command{ln} does not remove existing files.  Use the
9133 @option{--force} (@option{-f}) option to remove them unconditionally,
9134 the @option{--interactive} (@option{-i}) option to remove them
9135 conditionally, and the @option{--backup} (@option{-b}) option to
9136 rename them.
9137
9138 @cindex hard link, defined
9139 @cindex inode, and hard links
9140 A @dfn{hard link} is another name for an existing file; the link and the
9141 original are indistinguishable.  Technically speaking, they share the
9142 same inode, and the inode contains all the information about a
9143 file---indeed, it is not incorrect to say that the inode @emph{is} the
9144 file.  Most systems prohibit making a hard link to
9145 a directory; on those where it is allowed, only the super-user can do
9146 so (and with caution, since creating a cycle will cause problems to many
9147 other utilities).  Hard links cannot cross file system boundaries.  (These
9148 restrictions are not mandated by @acronym{POSIX}, however.)
9149
9150 @cindex dereferencing symbolic links
9151 @cindex symbolic link, defined
9152 @dfn{Symbolic links} (@dfn{symlinks} for short), on the other hand, are
9153 a special file type (which not all kernels support: System V release 3
9154 (and older) systems lack symlinks) in which the link file actually
9155 refers to a different file, by name.  When most operations (opening,
9156 reading, writing, and so on) are passed the symbolic link file, the
9157 kernel automatically @dfn{dereferences} the link and operates on the
9158 target of the link.  But some operations (e.g., removing) work on the
9159 link file itself, rather than on its target.  The owner and group of a
9160 symlink are not significant to file access performed through
9161 the link, but do have implications on deleting a symbolic link from a
9162 directory with the restricted deletion bit set.  On the GNU system,
9163 the mode of a symlink has no significance and cannot be changed, but
9164 on some BSD systems, the mode can be changed and will affect whether
9165 the symlink will be traversed in file name resolution.  @xref{Symbolic Links,,,
9166 libc, The GNU C Library Reference Manual}.
9167
9168 Symbolic links can contain arbitrary strings; a @dfn{dangling symlink}
9169 occurs when the string in the symlink does not resolve to a file.
9170 There are no restrictions against creating dangling symbolic links.
9171 There are trade-offs to using absolute or relative symlinks.  An
9172 absolute symlink always points to the same file, even if the directory
9173 containing the link is moved.  However, if the symlink is visible from
9174 more than one machine (such as on a networked file system), the file
9175 pointed to might not always be the same.  A relative symbolic link is
9176 resolved in relation to the directory that contains the link, and is
9177 often useful in referring to files on the same device without regards
9178 to what name that device is mounted on when accessed via networked
9179 machines.
9180
9181 When creating a relative symlink in a different location than the
9182 current directory, the resolution of the symlink will be different
9183 than the resolution of the same string from the current directory.
9184 Therefore, many users prefer to first change directories to the
9185 location where the relative symlink will be created, so that
9186 tab-completion or other file resolution will find the same target as
9187 what will be placed in the symlink.
9188
9189 The program accepts the following options.  Also see @ref{Common options}.
9190
9191 @table @samp
9192
9193 @optBackup
9194
9195 @item -d
9196 @itemx -F
9197 @itemx --directory
9198 @opindex -d
9199 @opindex -F
9200 @opindex --directory
9201 @cindex hard links to directories
9202 Allow users with appropriate privileges to attempt to make hard links
9203 to directories.
9204 However, note that this will probably fail due to
9205 system restrictions, even for the super-user.
9206
9207 @item -f
9208 @itemx --force
9209 @opindex -f
9210 @opindex --force
9211 Remove existing destination files.
9212
9213 @item -i
9214 @itemx --interactive
9215 @opindex -i
9216 @opindex --interactive
9217 @cindex prompting, and @command{ln}
9218 Prompt whether to remove existing destination files.
9219
9220 @item -L
9221 @itemx --logical
9222 @opindex -L
9223 @opindex --logical
9224 If @option{-s} is not in effect, and the source file is a symbolic
9225 link, create the hard link to the file referred to by the symbolic
9226 link, rather than the symbolic link itself.
9227
9228 @item -n
9229 @itemx --no-dereference
9230 @opindex -n
9231 @opindex --no-dereference
9232 Do not treat the last operand specially when it is a symbolic link to
9233 a directory.  Instead, treat it as if it were a normal file.
9234
9235 When the destination is an actual directory (not a symlink to one),
9236 there is no ambiguity.  The link is created in that directory.
9237 But when the specified destination is a symlink to a directory,
9238 there are two ways to treat the user's request.  @command{ln} can
9239 treat the destination just as it would a normal directory and create
9240 the link in it.  On the other hand, the destination can be viewed as a
9241 non-directory---as the symlink itself.  In that case, @command{ln}
9242 must delete or backup that symlink before creating the new link.
9243 The default is to treat a destination that is a symlink to a directory
9244 just like a directory.
9245
9246 This option is weaker than the @option{--no-target-directory}
9247 (@option{-T}) option, so it has no effect if both options are given.
9248
9249 @item -P
9250 @itemx --physical
9251 @opindex -P
9252 @opindex --physical
9253 If @option{-s} is not in effect, and the source file is a symbolic
9254 link, create the hard link to the symbolic link itself.  On platforms
9255 where this is not supported by the kernel, this option creates a
9256 symbolic link with identical contents; since symbolic link contents
9257 cannot be edited, any file name resolution performed through either
9258 link will be the same as if a hard link had been created.
9259
9260 @item -s
9261 @itemx --symbolic
9262 @opindex -s
9263 @opindex --symbolic
9264 Make symbolic links instead of hard links.  This option merely produces
9265 an error message on systems that do not support symbolic links.
9266
9267 @optBackupSuffix
9268
9269 @optTargetDirectory
9270
9271 @optNoTargetDirectory
9272
9273 @item -v
9274 @itemx --verbose
9275 @opindex -v
9276 @opindex --verbose
9277 Print the name of each file after linking it successfully.
9278
9279 @end table
9280
9281 @cindex hard links to symbolic links
9282 @cindex symbolic links and @command{ln}
9283 If @option{-L} and @option{-P} are both given, the last one takes
9284 precedence.  If @option{-s} is also given, @option{-L} and @option{-P}
9285 are silently ignored.  If neither option is given, then this
9286 implementation defaults to @option{-P} if the system @code{link} supports
9287 hard links to symbolic links (such as the GNU system), and @option{-L}
9288 if @code{link} follows symbolic links (such as on BSD).
9289
9290 @exitstatus
9291
9292 Examples:
9293
9294 @smallexample
9295 Bad Example:
9296
9297 # Create link ../a pointing to a in that directory.
9298 # Not really useful because it points to itself.
9299 ln -s a ..
9300
9301 Better Example:
9302
9303 # Change to the target before creating symlinks to avoid being confused.
9304 cd ..
9305 ln -s adir/a .
9306
9307 Bad Example:
9308
9309 # Hard coded file names don't move well.
9310 ln -s $(pwd)/a /some/dir/
9311
9312 Better Example:
9313
9314 # Relative file names survive directory moves and also
9315 # work across networked file systems.
9316 ln -s afile anotherfile
9317 ln -s ../adir/afile yetanotherfile
9318 @end smallexample
9319
9320
9321 @node mkdir invocation
9322 @section @command{mkdir}: Make directories
9323
9324 @pindex mkdir
9325 @cindex directories, creating
9326 @cindex creating directories
9327
9328 @command{mkdir} creates directories with the specified names.  Synopsis:
9329
9330 @example
9331 mkdir [@var{option}]@dots{} @var{name}@dots{}
9332 @end example
9333
9334 @command{mkdir} creates each directory @var{name} in the order given.
9335 It reports an error if @var{name} already exists, unless the
9336 @option{-p} option is given and @var{name} is a directory.
9337
9338 The program accepts the following options.  Also see @ref{Common options}.
9339
9340 @table @samp
9341
9342 @item -m @var{mode}
9343 @itemx --mode=@var{mode}
9344 @opindex -m
9345 @opindex --mode
9346 @cindex modes of created directories, setting
9347 Set the file permission bits of created directories to @var{mode},
9348 which uses the same syntax as
9349 in @command{chmod} and uses @samp{a=rwx} (read, write and execute allowed for
9350 everyone) for the point of the departure.  @xref{File permissions}.
9351
9352 Normally the directory has the desired file mode bits at the moment it
9353 is created.  As a @acronym{GNU} extension, @var{mode} may also mention
9354 special mode bits, but in this case there may be a temporary window
9355 during which the directory exists but its special mode bits are
9356 incorrect.  @xref{Directory Setuid and Setgid}, for how the
9357 set-user-ID and set-group-ID bits of directories are inherited unless
9358 overridden in this way.
9359
9360 @item -p
9361 @itemx --parents
9362 @opindex -p
9363 @opindex --parents
9364 @cindex parent directories, creating
9365 Make any missing parent directories for each argument, setting their
9366 file permission bits to the umask modified by @samp{u+wx}.  Ignore
9367 existing parent directories, and do not change their file permission
9368 bits.
9369
9370 To set the file permission bits of any newly-created parent
9371 directories to a value that includes @samp{u+wx}, you can set the
9372 umask before invoking @command{mkdir}.  For example, if the shell
9373 command @samp{(umask u=rwx,go=rx; mkdir -p P/Q)} creates the parent
9374 @file{P} it sets the parent's permission bits to @samp{u=rwx,go=rx}.
9375 To set a parent's special mode bits as well, you can invoke
9376 @command{chmod} after @command{mkdir}.  @xref{Directory Setuid and
9377 Setgid}, for how the set-user-ID and set-group-ID bits of
9378 newly-created parent directories are inherited.
9379
9380 @item -v
9381 @itemx --verbose
9382 @opindex -v
9383 @opindex --verbose
9384 Print a message for each created directory.  This is most useful with
9385 @option{--parents}.
9386
9387 @item -Z @var{context}
9388 @itemx --context=@var{context}
9389 @opindex -Z
9390 @opindex --context
9391 @cindex SELinux
9392 @cindex security context
9393 Set the default SELinux security context to be used for created directories.
9394
9395 @end table
9396
9397 @exitstatus
9398
9399
9400 @node mkfifo invocation
9401 @section @command{mkfifo}: Make FIFOs (named pipes)
9402
9403 @pindex mkfifo
9404 @cindex FIFOs, creating
9405 @cindex named pipes, creating
9406 @cindex creating FIFOs (named pipes)
9407
9408 @command{mkfifo} creates FIFOs (also called @dfn{named pipes}) with the
9409 specified names.  Synopsis:
9410
9411 @example
9412 mkfifo [@var{option}] @var{name}@dots{}
9413 @end example
9414
9415 A @dfn{FIFO} is a special file type that permits independent processes
9416 to communicate.  One process opens the FIFO file for writing, and
9417 another for reading, after which data can flow as with the usual
9418 anonymous pipe in shells or elsewhere.
9419
9420 The program accepts the following option.  Also see @ref{Common options}.
9421
9422 @table @samp
9423
9424 @item -m @var{mode}
9425 @itemx --mode=@var{mode}
9426 @opindex -m
9427 @opindex --mode
9428 @cindex modes of created FIFOs, setting
9429 Set the mode of created FIFOs to @var{mode}, which is symbolic as in
9430 @command{chmod} and uses @samp{a=rw} (read and write allowed for everyone)
9431 for the point of departure.  @var{mode} should specify only file
9432 permission bits.  @xref{File permissions}.
9433
9434 @item -Z @var{context}
9435 @itemx --context=@var{context}
9436 @opindex -Z
9437 @opindex --context
9438 @cindex SELinux
9439 @cindex security context
9440 Set the default SELinux security context to be used for created FIFOs.
9441
9442 @end table
9443
9444 @exitstatus
9445
9446
9447 @node mknod invocation
9448 @section @command{mknod}: Make block or character special files
9449
9450 @pindex mknod
9451 @cindex block special files, creating
9452 @cindex character special files, creating
9453
9454 @command{mknod} creates a FIFO, character special file, or block special
9455 file with the specified name.  Synopsis:
9456
9457 @example
9458 mknod [@var{option}]@dots{} @var{name} @var{type} [@var{major} @var{minor}]
9459 @end example
9460
9461 @cindex special files
9462 @cindex block special files
9463 @cindex character special files
9464 Unlike the phrase ``special file type'' above, the term @dfn{special
9465 file} has a technical meaning on Unix: something that can generate or
9466 receive data.  Usually this corresponds to a physical piece of hardware,
9467 e.g., a printer or a disk.  (These files are typically created at
9468 system-configuration time.)  The @command{mknod} command is what creates
9469 files of this type.  Such devices can be read either a character at a
9470 time or a ``block'' (many characters) at a time, hence we say there are
9471 @dfn{block special} files and @dfn{character special} files.
9472
9473 @c mknod is a shell built-in at least with OpenBSD's /bin/sh
9474 @mayConflictWithShellBuiltIn{mknod}
9475
9476 The arguments after @var{name} specify the type of file to make:
9477
9478 @table @samp
9479
9480 @item p
9481 @opindex p @r{for FIFO file}
9482 for a FIFO
9483
9484 @item b
9485 @opindex b @r{for block special file}
9486 for a block special file
9487
9488 @item c
9489 @c Don't document the `u' option -- it's just a synonym for `c'.
9490 @c Do *any* versions of mknod still use it?
9491 @c @itemx u
9492 @opindex c @r{for character special file}
9493 @c @opindex u @r{for character special file}
9494 for a character special file
9495
9496 @end table
9497
9498 When making a block or character special file, the major and minor
9499 device numbers must be given after the file type.
9500 If a major or minor device number begins with @samp{0x} or @samp{0X},
9501 it is interpreted as hexadecimal; otherwise, if it begins with @samp{0},
9502 as octal; otherwise, as decimal.
9503
9504 The program accepts the following option.  Also see @ref{Common options}.
9505
9506 @table @samp
9507
9508 @item -m @var{mode}
9509 @itemx --mode=@var{mode}
9510 @opindex -m
9511 @opindex --mode
9512 Set the mode of created files to @var{mode}, which is symbolic as in
9513 @command{chmod} and uses @samp{a=rw} as the point of departure.
9514 @var{mode} should specify only file permission bits.
9515 @xref{File permissions}.
9516
9517 @item -Z @var{context}
9518 @itemx --context=@var{context}
9519 @opindex -Z
9520 @opindex --context
9521 @cindex SELinux
9522 @cindex security context
9523 Set the default SELinux security context to be used for created files.
9524
9525 @end table
9526
9527 @exitstatus
9528
9529
9530 @node readlink invocation
9531 @section @command{readlink}: Print value of a symlink or canonical file name
9532
9533 @pindex readlink
9534 @cindex displaying value of a symbolic link
9535 @cindex canonical file name
9536 @cindex canonicalize a file name
9537 @pindex realpath
9538 @findex realpath
9539
9540 @command{readlink} may work in one of two supported modes:
9541
9542 @table @samp
9543
9544 @item Readlink mode
9545
9546 @command{readlink} outputs the value of the given symbolic link.
9547 If @command{readlink} is invoked with an argument other than the name
9548 of a symbolic link, it produces no output and exits with a nonzero exit code.
9549
9550 @item Canonicalize mode
9551
9552 @command{readlink} outputs the absolute name of the given file which contains
9553 no @file{.}, @file{..} components nor any repeated separators
9554 (@file{/}) or symbolic links.
9555
9556 @end table
9557
9558 @example
9559 readlink [@var{option}] @var{file}
9560 @end example
9561
9562 By default, @command{readlink} operates in readlink mode.
9563
9564 The program accepts the following options.  Also see @ref{Common options}.
9565
9566 @table @samp
9567
9568 @item -f
9569 @itemx --canonicalize
9570 @opindex -f
9571 @opindex --canonicalize
9572 Activate canonicalize mode.
9573 If any component of the file name except the last one is missing or unavailable,
9574 @command{readlink} produces no output and exits with a nonzero exit
9575 code.  A trailing slash is ignored.
9576
9577 @item -e
9578 @itemx --canonicalize-existing
9579 @opindex -e
9580 @opindex --canonicalize-existing
9581 Activate canonicalize mode.
9582 If any component is missing or unavailable, @command{readlink} produces
9583 no output and exits with a nonzero exit code.  A trailing slash
9584 requires that the name resolve to a directory.
9585
9586 @item -m
9587 @itemx --canonicalize-missing
9588 @opindex -m
9589 @opindex --canonicalize-missing
9590 Activate canonicalize mode.
9591 If any component is missing or unavailable, @command{readlink} treats it
9592 as a directory.
9593
9594 @item -n
9595 @itemx --no-newline
9596 @opindex -n
9597 @opindex --no-newline
9598 Do not output the trailing newline.
9599
9600 @item -s
9601 @itemx -q
9602 @itemx --silent
9603 @itemx --quiet
9604 @opindex -s
9605 @opindex -q
9606 @opindex --silent
9607 @opindex --quiet
9608 Suppress most error messages.
9609
9610 @item -v
9611 @itemx --verbose
9612 @opindex -v
9613 @opindex --verbose
9614 Report error messages.
9615
9616 @end table
9617
9618 The @command{readlink} utility first appeared in OpenBSD 2.1.
9619
9620 There is a @command{realpath} command on some systems
9621 which operates like @command{readlink} in canonicalize mode.
9622
9623 @exitstatus
9624
9625
9626 @node rmdir invocation
9627 @section @command{rmdir}: Remove empty directories
9628
9629 @pindex rmdir
9630 @cindex removing empty directories
9631 @cindex directories, removing empty
9632
9633 @command{rmdir} removes empty directories.  Synopsis:
9634
9635 @example
9636 rmdir [@var{option}]@dots{} @var{directory}@dots{}
9637 @end example
9638
9639 If any @var{directory} argument does not refer to an existing empty
9640 directory, it is an error.
9641
9642 The program accepts the following options.  Also see @ref{Common options}.
9643
9644 @table @samp
9645
9646 @item --ignore-fail-on-non-empty
9647 @opindex --ignore-fail-on-non-empty
9648 @cindex directory deletion, ignoring failures
9649 Ignore each failure to remove a directory that is solely because
9650 the directory is non-empty.
9651
9652 @item -p
9653 @itemx --parents
9654 @opindex -p
9655 @opindex --parents
9656 @cindex parent directories, removing
9657 Remove @var{directory}, then try to remove each component of @var{directory}.
9658 So, for example, @samp{rmdir -p a/b/c} is similar to @samp{rmdir a/b/c a/b a}.
9659 As such, it fails if any of those directories turns out not to be empty.
9660 Use the @option{--ignore-fail-on-non-empty} option to make it so such
9661 a failure does not evoke a diagnostic and does not cause @command{rmdir} to
9662 exit unsuccessfully.
9663
9664 @item -v
9665 @itemx --verbose
9666 @opindex -v
9667 @opindex --verbose
9668 @cindex directory deletion, reporting
9669 Give a diagnostic for each successful removal.
9670 @var{directory} is removed.
9671
9672 @end table
9673
9674 @xref{rm invocation}, for how to remove non-empty directories (recursively).
9675
9676 @exitstatus
9677
9678
9679 @node unlink invocation
9680 @section @command{unlink}: Remove files via the unlink syscall
9681
9682 @pindex unlink
9683 @cindex removing files or directories (via the unlink syscall)
9684
9685 @command{unlink} deletes a single specified file name.
9686 It is a minimalist interface to the system-provided
9687 @code{unlink} function.  @xref{Deleting Files, , , libc,
9688 The GNU C Library Reference Manual}.  Synopsis:
9689 It avoids the bells and whistles of the more commonly-used
9690 @command{rm} command (@pxref{rm invocation}).
9691
9692 @example
9693 unlink @var{filename}
9694 @end example
9695
9696 On some systems @code{unlink} can be used to delete the name of a
9697 directory.  On others, it can be used that way only by a privileged user.
9698 In the GNU system @code{unlink} can never delete the name of a directory.
9699
9700 The @command{unlink} command honors the @option{--help} and
9701 @option{--version} options.  To remove a file whose name begins with
9702 @samp{-}, prefix the name with @samp{./}, e.g., @samp{unlink ./--help}.
9703
9704 @exitstatus
9705
9706
9707 @node Changing file attributes
9708 @chapter Changing file attributes
9709
9710 @cindex changing file attributes
9711 @cindex file attributes, changing
9712 @cindex attributes, file
9713
9714 A file is not merely its contents, a name, and a file type
9715 (@pxref{Special file types}).  A file also has an owner (a user ID), a
9716 group (a group ID), permissions (what the owner can do with the file,
9717 what people in the group can do, and what everyone else can do), various
9718 timestamps, and other information.  Collectively, we call these a file's
9719 @dfn{attributes}.
9720
9721 These commands change file attributes.
9722
9723 @menu
9724 * chgrp invocation::            Change file groups.
9725 * chmod invocation::            Change access permissions.
9726 * chown invocation::            Change file owners and groups.
9727 * touch invocation::            Change file timestamps.
9728 @end menu
9729
9730
9731 @node chown invocation
9732 @section @command{chown}: Change file owner and group
9733
9734 @pindex chown
9735 @cindex file ownership, changing
9736 @cindex group ownership, changing
9737 @cindex changing file ownership
9738 @cindex changing group ownership
9739
9740 @command{chown} changes the user and/or group ownership of each given @var{file}
9741 to @var{new-owner} or to the user and group of an existing reference file.
9742 Synopsis:
9743
9744 @example
9745 chown [@var{option}]@dots{} @{@var{new-owner} | --reference=@var{ref_file}@}@c
9746  @var{file}@dots{}
9747 @end example
9748
9749 If used, @var{new-owner} specifies the new owner and/or group as follows
9750 (with no embedded white space):
9751
9752 @example
9753 [@var{owner}] [ : [@var{group}] ]
9754 @end example
9755
9756 Specifically:
9757
9758 @table @var
9759 @item owner
9760 If only an @var{owner} (a user name or numeric user ID) is given, that
9761 user is made the owner of each given file, and the files' group is not
9762 changed.
9763
9764 @item owner@samp{:}group
9765 If the @var{owner} is followed by a colon and a @var{group} (a
9766 group name or numeric group ID), with no spaces between them, the group
9767 ownership of the files is changed as well (to @var{group}).
9768
9769 @item owner@samp{:}
9770 If a colon but no group name follows @var{owner}, that user is
9771 made the owner of the files and the group of the files is changed to
9772 @var{owner}'s login group.
9773
9774 @item @samp{:}group
9775 If the colon and following @var{group} are given, but the owner
9776 is omitted, only the group of the files is changed; in this case,
9777 @command{chown} performs the same function as @command{chgrp}.
9778
9779 @item @samp{:}
9780 If only a colon is given, or if @var{new-owner} is empty, neither the
9781 owner nor the group is changed.
9782
9783 @end table
9784
9785 If @var{owner} or @var{group} is intended to represent a numeric user
9786 or group ID, then you may specify it with a leading @samp{+}.
9787 @xref{Disambiguating names and IDs}.
9788
9789 Some older scripts may still use @samp{.} in place of the @samp{:} separator.
9790 @acronym{POSIX} 1003.1-2001 (@pxref{Standards conformance}) does not
9791 require support for that, but for backward compatibility @acronym{GNU}
9792 @command{chown} supports @samp{.} so long as no ambiguity results.
9793 New scripts should avoid the use of @samp{.} because it is not
9794 portable, and because it has undesirable results if the entire
9795 @var{owner@samp{.}group} happens to identify a user whose name
9796 contains @samp{.}.
9797
9798 The @command{chown} command sometimes clears the set-user-ID or
9799 set-group-ID permission bits.  This behavior depends on the policy and
9800 functionality of the underlying @code{chown} system call, which may
9801 make system-dependent file mode modifications outside the control of
9802 the @command{chown} command.  For example, the @command{chown} command
9803 might not affect those bits when invoked by a user with appropriate
9804 privileges, or when the
9805 bits signify some function other than executable permission (e.g.,
9806 mandatory locking).
9807 When in doubt, check the underlying system behavior.
9808
9809 The program accepts the following options.  Also see @ref{Common options}.
9810
9811 @table @samp
9812
9813 @item -c
9814 @itemx --changes
9815 @opindex -c
9816 @opindex --changes
9817 @cindex changed owners, verbosely describing
9818 Verbosely describe the action for each @var{file} whose ownership
9819 actually changes.
9820
9821 @item -f
9822 @itemx --silent
9823 @itemx --quiet
9824 @opindex -f
9825 @opindex --silent
9826 @opindex --quiet
9827 @cindex error messages, omitting
9828 Do not print error messages about files whose ownership cannot be
9829 changed.
9830
9831 @itemx @w{@kbd{--from}=@var{old-owner}}
9832 @opindex --from
9833 @cindex symbolic links, changing owner
9834 Change a @var{file}'s ownership only if it has current attributes specified
9835 by @var{old-owner}.  @var{old-owner} has the same form as @var{new-owner}
9836 described above.
9837 This option is useful primarily from a security standpoint in that
9838 it narrows considerably the window of potential abuse.
9839 For example, to reflect a user ID numbering change for one user's files
9840 without an option like this, @code{root} might run
9841
9842 @smallexample
9843 find / -owner OLDUSER -print0 | xargs -0 chown -h NEWUSER
9844 @end smallexample
9845
9846 But that is dangerous because the interval between when the @command{find}
9847 tests the existing file's owner and when the @command{chown} is actually run
9848 may be quite large.
9849 One way to narrow the gap would be to invoke chown for each file
9850 as it is found:
9851
9852 @example
9853 find / -owner OLDUSER -exec chown -h NEWUSER @{@} \;
9854 @end example
9855
9856 But that is very slow if there are many affected files.
9857 With this option, it is safer (the gap is narrower still)
9858 though still not perfect:
9859
9860 @example
9861 chown -h -R --from=OLDUSER NEWUSER /
9862 @end example
9863
9864 @item --dereference
9865 @opindex --dereference
9866 @cindex symbolic links, changing owner
9867 @findex lchown
9868 Do not act on symbolic links themselves but rather on what they point to.
9869 This is the default.
9870
9871 @item -h
9872 @itemx --no-dereference
9873 @opindex -h
9874 @opindex --no-dereference
9875 @cindex symbolic links, changing owner
9876 @findex lchown
9877 Act on symbolic links themselves instead of what they point to.
9878 This mode relies on the @code{lchown} system call.
9879 On systems that do not provide the @code{lchown} system call,
9880 @command{chown} fails when a file specified on the command line
9881 is a symbolic link.
9882 By default, no diagnostic is issued for symbolic links encountered
9883 during a recursive traversal, but see @option{--verbose}.
9884
9885 @itemx --preserve-root
9886 @opindex --preserve-root
9887 @cindex root directory, disallow recursive modification
9888 Fail upon any attempt to recursively change the root directory, @file{/}.
9889 Without @option{--recursive}, this option has no effect.
9890 @xref{Treating / specially}.
9891
9892 @itemx --no-preserve-root
9893 @opindex --no-preserve-root
9894 @cindex root directory, allow recursive modification
9895 Cancel the effect of any preceding @option{--preserve-root} option.
9896 @xref{Treating / specially}.
9897
9898 @item --reference=@var{ref_file}
9899 @opindex --reference
9900 Change the user and group of each @var{file} to be the same as those of
9901 @var{ref_file}.  If @var{ref_file} is a symbolic link, do not use the
9902 user and group of the symbolic link, but rather those of the file it
9903 refers to.
9904
9905 @item -v
9906 @itemx --verbose
9907 @opindex -v
9908 @opindex --verbose
9909 Output a diagnostic for every file processed.
9910 If a symbolic link is encountered during a recursive traversal
9911 on a system without the @code{lchown} system call, and @option{--no-dereference}
9912 is in effect, then issue a diagnostic saying neither the symbolic link nor
9913 its referent is being changed.
9914
9915 @item -R
9916 @itemx --recursive
9917 @opindex -R
9918 @opindex --recursive
9919 @cindex recursively changing file ownership
9920 Recursively change ownership of directories and their contents.
9921
9922 @choptH
9923 @xref{Traversing symlinks}.
9924
9925 @choptL
9926 @xref{Traversing symlinks}.
9927
9928 @choptP
9929 @xref{Traversing symlinks}.
9930
9931 @end table
9932
9933 @exitstatus
9934
9935 Examples:
9936
9937 @smallexample
9938 # Change the owner of /u to "root".
9939 chown root /u
9940
9941 # Likewise, but also change its group to "staff".
9942 chown root:staff /u
9943
9944 # Change the owner of /u and subfiles to "root".
9945 chown -hR root /u
9946 @end smallexample
9947
9948
9949 @node chgrp invocation
9950 @section @command{chgrp}: Change group ownership
9951
9952 @pindex chgrp
9953 @cindex group ownership, changing
9954 @cindex changing group ownership
9955
9956 @command{chgrp} changes the group ownership of each given @var{file}
9957 to @var{group} (which can be either a group name or a numeric group ID)
9958 or to the group of an existing reference file.  Synopsis:
9959
9960 @example
9961 chgrp [@var{option}]@dots{} @{@var{group} | --reference=@var{ref_file}@}@c
9962  @var{file}@dots{}
9963 @end example
9964
9965 If @var{group} is intended to represent a
9966 numeric group ID, then you may specify it with a leading @samp{+}.
9967 @xref{Disambiguating names and IDs}.
9968
9969 The program accepts the following options.  Also see @ref{Common options}.
9970
9971 @table @samp
9972
9973 @item -c
9974 @itemx --changes
9975 @opindex -c
9976 @opindex --changes
9977 @cindex changed files, verbosely describing
9978 Verbosely describe the action for each @var{file} whose group actually
9979 changes.
9980
9981 @item -f
9982 @itemx --silent
9983 @itemx --quiet
9984 @opindex -f
9985 @opindex --silent
9986 @opindex --quiet
9987 @cindex error messages, omitting
9988 Do not print error messages about files whose group cannot be
9989 changed.
9990
9991 @item --dereference
9992 @opindex --dereference
9993 @cindex symbolic links, changing owner
9994 @findex lchown
9995 Do not act on symbolic links themselves but rather on what they point to.
9996 This is the default.
9997
9998 @item -h
9999 @itemx --no-dereference
10000 @opindex -h
10001 @opindex --no-dereference
10002 @cindex symbolic links, changing group
10003 @findex lchown
10004 Act on symbolic links themselves instead of what they point to.
10005 This mode relies on the @code{lchown} system call.
10006 On systems that do not provide the @code{lchown} system call,
10007 @command{chgrp} fails when a file specified on the command line
10008 is a symbolic link.
10009 By default, no diagnostic is issued for symbolic links encountered
10010 during a recursive traversal, but see @option{--verbose}.
10011
10012 @itemx --preserve-root
10013 @opindex --preserve-root
10014 @cindex root directory, disallow recursive modification
10015 Fail upon any attempt to recursively change the root directory, @file{/}.
10016 Without @option{--recursive}, this option has no effect.
10017 @xref{Treating / specially}.
10018
10019 @itemx --no-preserve-root
10020 @opindex --no-preserve-root
10021 @cindex root directory, allow recursive modification
10022 Cancel the effect of any preceding @option{--preserve-root} option.
10023 @xref{Treating / specially}.
10024
10025 @item --reference=@var{ref_file}
10026 @opindex --reference
10027 Change the group of each @var{file} to be the same as that of
10028 @var{ref_file}.  If @var{ref_file} is a symbolic link, do not use the
10029 group of the symbolic link, but rather that of the file it refers to.
10030
10031 @item -v
10032 @itemx --verbose
10033 @opindex -v
10034 @opindex --verbose
10035 Output a diagnostic for every file processed.
10036 If a symbolic link is encountered during a recursive traversal
10037 on a system without the @code{lchown} system call, and @option{--no-dereference}
10038 is in effect, then issue a diagnostic saying neither the symbolic link nor
10039 its referent is being changed.
10040
10041 @item -R
10042 @itemx --recursive
10043 @opindex -R
10044 @opindex --recursive
10045 @cindex recursively changing group ownership
10046 Recursively change the group ownership of directories and their contents.
10047
10048 @choptH
10049 @xref{Traversing symlinks}.
10050
10051 @choptL
10052 @xref{Traversing symlinks}.
10053
10054 @choptP
10055 @xref{Traversing symlinks}.
10056
10057 @end table
10058
10059 @exitstatus
10060
10061 Examples:
10062
10063 @smallexample
10064 # Change the group of /u to "staff".
10065 chgrp staff /u
10066
10067 # Change the group of /u and subfiles to "staff".
10068 chgrp -hR staff /u
10069 @end smallexample
10070
10071
10072 @node chmod invocation
10073 @section @command{chmod}: Change access permissions
10074
10075 @pindex chmod
10076 @cindex changing access permissions
10077 @cindex access permissions, changing
10078 @cindex permissions, changing access
10079
10080 @command{chmod} changes the access permissions of the named files.  Synopsis:
10081
10082 @example
10083 chmod [@var{option}]@dots{} @{@var{mode} | --reference=@var{ref_file}@}@c
10084  @var{file}@dots{}
10085 @end example
10086
10087 @cindex symbolic links, permissions of
10088 @command{chmod} never changes the permissions of symbolic links, since
10089 the @command{chmod} system call cannot change their permissions.
10090 This is not a problem since the permissions of symbolic links are
10091 never used.  However, for each symbolic link listed on the command
10092 line, @command{chmod} changes the permissions of the pointed-to file.
10093 In contrast, @command{chmod} ignores symbolic links encountered during
10094 recursive directory traversals.
10095
10096 A successful use of @command{chmod} clears the set-group-ID bit of a
10097 regular file if the file's group ID does not match the user's
10098 effective group ID or one of the user's supplementary group IDs,
10099 unless the user has appropriate privileges.  Additional restrictions
10100 may cause the set-user-ID and set-group-ID bits of @var{mode} or
10101 @var{ref_file} to be ignored.  This behavior depends on the policy and
10102 functionality of the underlying @code{chmod} system call.  When in
10103 doubt, check the underlying system behavior.
10104
10105 If used, @var{mode} specifies the new file mode bits.
10106 For details, see the section on @ref{File permissions}.
10107 If you really want @var{mode} to have a leading @samp{-}, you should
10108 use @option{--} first, e.g., @samp{chmod -- -w file}.  Typically,
10109 though, @samp{chmod a-w file} is preferable, and @command{chmod -w
10110 file} (without the @option{--}) complains if it behaves differently
10111 from what @samp{chmod a-w file} would do.
10112
10113 The program accepts the following options.  Also see @ref{Common options}.
10114
10115 @table @samp
10116
10117 @item -c
10118 @itemx --changes
10119 @opindex -c
10120 @opindex --changes
10121 Verbosely describe the action for each @var{file} whose permissions
10122 actually changes.
10123
10124 @item -f
10125 @itemx --silent
10126 @itemx --quiet
10127 @opindex -f
10128 @opindex --silent
10129 @opindex --quiet
10130 @cindex error messages, omitting
10131 Do not print error messages about files whose permissions cannot be
10132 changed.
10133
10134 @itemx --preserve-root
10135 @opindex --preserve-root
10136 @cindex root directory, disallow recursive modification
10137 Fail upon any attempt to recursively change the root directory, @file{/}.
10138 Without @option{--recursive}, this option has no effect.
10139 @xref{Treating / specially}.
10140
10141 @itemx --no-preserve-root
10142 @opindex --no-preserve-root
10143 @cindex root directory, allow recursive modification
10144 Cancel the effect of any preceding @option{--preserve-root} option.
10145 @xref{Treating / specially}.
10146
10147 @item -v
10148 @itemx --verbose
10149 @opindex -v
10150 @opindex --verbose
10151 Verbosely describe the action or non-action taken for every @var{file}.
10152
10153 @item --reference=@var{ref_file}
10154 @opindex --reference
10155 Change the mode of each @var{file} to be the same as that of @var{ref_file}.
10156 @xref{File permissions}.
10157 If @var{ref_file} is a symbolic link, do not use the mode
10158 of the symbolic link, but rather that of the file it refers to.
10159
10160 @item -R
10161 @itemx --recursive
10162 @opindex -R
10163 @opindex --recursive
10164 @cindex recursively changing access permissions
10165 Recursively change permissions of directories and their contents.
10166
10167 @end table
10168
10169 @exitstatus
10170
10171
10172 @node touch invocation
10173 @section @command{touch}: Change file timestamps
10174
10175 @pindex touch
10176 @cindex changing file timestamps
10177 @cindex file timestamps, changing
10178 @cindex timestamps, changing file
10179
10180 @command{touch} changes the access and/or modification times of the
10181 specified files.  Synopsis:
10182
10183 @example
10184 touch [@var{option}]@dots{} @var{file}@dots{}
10185 @end example
10186
10187 @cindex empty files, creating
10188 Any @var{file} argument that does not exist is created empty, unless
10189 option @option{--no-create} (@option{-c}) or @option{--no-dereference}
10190 (@option{-h}) was in effect.
10191
10192 A @var{file} argument string of @samp{-} is handled specially and
10193 causes @command{touch} to change the times of the file associated with
10194 standard output.
10195
10196 @cindex permissions, for changing file timestamps
10197 If changing both the access and modification times to the current
10198 time, @command{touch} can change the timestamps for files that the user
10199 running it does not own but has write permission for.  Otherwise, the
10200 user must own the files.
10201
10202 Although @command{touch} provides options for changing two of the times---the
10203 times of last access and modification---of a file, there is actually
10204 a standard third one as well: the inode change time.  This is often
10205 referred to as a file's @code{ctime}.
10206 The inode change time represents the time when the file's meta-information
10207 last changed.  One common example of this is when the permissions of a
10208 file change.  Changing the permissions doesn't access the file, so
10209 the atime doesn't change, nor does it modify the file, so the mtime
10210 doesn't change.  Yet, something about the file itself has changed,
10211 and this must be noted somewhere.  This is the job of the ctime field.
10212 This is necessary, so that, for example, a backup program can make a
10213 fresh copy of the file, including the new permissions value.
10214 Another operation that modifies a file's ctime without affecting
10215 the others is renaming.  In any case, it is not possible, in normal
10216 operations, for a user to change the ctime field to a user-specified value.
10217 Some operating systems and file systems support a fourth time: the
10218 birth time, when the file was first created; by definition, this
10219 timestamp never changes.
10220
10221 @vindex TZ
10222 Time stamps assume the time zone rules specified by the @env{TZ}
10223 environment variable, or by the system default rules if @env{TZ} is
10224 not set.  @xref{TZ Variable,, Specifying the Time Zone with @env{TZ},
10225 libc, The GNU C Library Reference Manual}.
10226 You can avoid ambiguities during
10227 daylight saving transitions by using @sc{utc} time stamps.
10228
10229 The program accepts the following options.  Also see @ref{Common options}.
10230
10231 @table @samp
10232
10233 @item -a
10234 @itemx --time=atime
10235 @itemx --time=access
10236 @itemx --time=use
10237 @opindex -a
10238 @opindex --time
10239 @opindex atime@r{, changing}
10240 @opindex access @r{time, changing}
10241 @opindex use @r{time, changing}
10242 Change the access time only.
10243
10244 @item -c
10245 @itemx --no-create
10246 @opindex -c
10247 @opindex --no-create
10248 Do not warn about or create files that do not exist.
10249
10250 @item -d
10251 @itemx --date=@var{time}
10252 @opindex -d
10253 @opindex --date
10254 @opindex time
10255 Use @var{time} instead of the current time.  It can contain month names,
10256 time zones, @samp{am} and @samp{pm}, @samp{yesterday}, etc.  For
10257 example, @option{--date="2004-02-27 14:19:13.489392193 +0530"}
10258 specifies the instant of time that is 489,392,193 nanoseconds after
10259 February 27, 2004 at 2:19:13 PM in a time zone that is 5 hours and 30
10260 minutes east of @acronym{UTC}.  @xref{Date input formats}.
10261 File systems that do not support high-resolution time stamps
10262 silently ignore any excess precision here.
10263
10264 @item -f
10265 @opindex -f
10266 @cindex BSD @command{touch} compatibility
10267 Ignored; for compatibility with BSD versions of @command{touch}.
10268
10269 @item -h
10270 @itemx --no-dereference
10271 @opindex -h
10272 @opindex --no-dereference
10273 @cindex symbolic links, changing time
10274 @findex lutimes
10275 Attempt to change the timestamps of a symbolic link, rather than what
10276 the link refers to.  When using this option, empty files are not
10277 created, but option @option{-c} must also be used to avoid warning
10278 about files that do not exist.  Not all systems support changing the
10279 timestamps of symlinks, since underlying system support for this
10280 action was not required until @acronym{POSIX} 2008.  Also, on some
10281 systems, the mere act of examining a symbolic link changes the access
10282 time, such that only changes to the modification time will persist
10283 long enough to be observable.  When coupled with option @option{-r}, a
10284 reference timestamp is taken from a symbolic link rather than the file
10285 it refers to.
10286
10287 @item -m
10288 @itemx --time=mtime
10289 @itemx --time=modify
10290 @opindex -m
10291 @opindex --time
10292 @opindex mtime@r{, changing}
10293 @opindex modify @r{time, changing}
10294 Change the modification time only.
10295
10296 @item -r @var{file}
10297 @itemx --reference=@var{file}
10298 @opindex -r
10299 @opindex --reference
10300 Use the times of the reference @var{file} instead of the current time.
10301 If this option is combined with the @option{--date=@var{time}}
10302 (@option{-d @var{time}}) option, the reference @var{file}'s time is
10303 the origin for any relative @var{time}s given, but is otherwise ignored.
10304 For example, @samp{-r foo -d '-5 seconds'} specifies a time stamp
10305 equal to five seconds before the corresponding time stamp for @file{foo}.
10306 If @var{file} is a symbolic link, the reference timestamp is taken
10307 from the target of the symlink, unless @option{-h} was also in effect.
10308
10309 @item -t [[@var{cc}]@var{yy}]@var{mmddhhmm}[.@var{ss}]
10310 Use the argument (optional four-digit or two-digit years, months,
10311 days, hours, minutes, optional seconds) instead of the current time.
10312 If the year is specified with only two digits, then @var{cc}
10313 is 20 for years in the range 0 @dots{} 68, and 19 for years in
10314 69 @dots{} 99.  If no digits of the year are specified,
10315 the argument is interpreted as a date in the current year.
10316 Note that @var{ss} may be @samp{60}, to accommodate leap seconds.
10317
10318 @end table
10319
10320 @vindex _POSIX2_VERSION
10321 On older systems, @command{touch} supports an obsolete syntax, as follows.
10322 If no timestamp is given with any of the @option{-d}, @option{-r}, or
10323 @option{-t} options, and if there are two or more @var{file}s and the
10324 first @var{file} is of the form @samp{@var{mmddhhmm}[@var{yy}]} and this
10325 would be a valid argument to the @option{-t} option (if the @var{yy}, if
10326 any, were moved to the front), and if the represented year
10327 is in the range 1969--1999, that argument is interpreted as the time
10328 for the other files instead of as a file name.
10329 This obsolete behavior can be enabled or disabled with the
10330 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
10331 conformance}), but portable scripts should avoid commands whose
10332 behavior depends on this variable.
10333 For example, use @samp{touch ./12312359 main.c} or @samp{touch -t
10334 12312359 main.c} rather than the ambiguous @samp{touch 12312359 main.c}.
10335
10336 @exitstatus
10337
10338
10339 @node Disk usage
10340 @chapter Disk usage
10341
10342 @cindex disk usage
10343
10344 No disk can hold an infinite amount of data.  These commands report
10345 how much disk storage is in use or available, report other file and
10346 file status information, and write buffers to disk.
10347
10348 @menu
10349 * df invocation::               Report file system disk space usage.
10350 * du invocation::               Estimate file space usage.
10351 * stat invocation::             Report file or file system status.
10352 * sync invocation::             Synchronize memory and disk.
10353 * truncate invocation::         Shrink or extend the size of a file.
10354 @end menu
10355
10356
10357 @node df invocation
10358 @section @command{df}: Report file system disk space usage
10359
10360 @pindex df
10361 @cindex file system disk usage
10362 @cindex disk usage by file system
10363
10364 @command{df} reports the amount of disk space used and available on
10365 file systems.  Synopsis:
10366
10367 @example
10368 df [@var{option}]@dots{} [@var{file}]@dots{}
10369 @end example
10370
10371 With no arguments, @command{df} reports the space used and available on all
10372 currently mounted file systems (of all types).  Otherwise, @command{df}
10373 reports on the file system containing each argument @var{file}.
10374
10375 Normally the disk space is printed in units of
10376 1024 bytes, but this can be overridden (@pxref{Block size}).
10377 Non-integer quantities are rounded up to the next higher unit.
10378
10379 @cindex disk device file
10380 @cindex device file, disk
10381 If an argument @var{file} is a disk device file containing a mounted
10382 file system, @command{df} shows the space available on that file system
10383 rather than on the file system containing the device node (i.e., the root
10384 file system).  @sc{gnu} @command{df} does not attempt to determine the
10385 disk usage
10386 on unmounted file systems, because on most kinds of systems doing so
10387 requires extremely nonportable intimate knowledge of file system
10388 structures.
10389
10390 The program accepts the following options.  Also see @ref{Common options}.
10391
10392 @table @samp
10393
10394 @item -a
10395 @itemx --all
10396 @opindex -a
10397 @opindex --all
10398 @cindex automounter file systems
10399 @cindex ignore file systems
10400 Include in the listing dummy file systems, which
10401 are omitted by default.  Such file systems are typically special-purpose
10402 pseudo-file-systems, such as automounter entries.
10403
10404 @item -B @var{size}
10405 @itemx --block-size=@var{size}
10406 @opindex -B
10407 @opindex --block-size
10408 @cindex file system sizes
10409 Scale sizes by @var{size} before printing them (@pxref{Block size}).
10410 For example, @option{-BG} prints sizes in units of 1,073,741,824 bytes.
10411
10412 @itemx --total
10413 @opindex --total
10414 @cindex grand total of disk size, usage and available space
10415 Print a grand total of all arguments after all arguments have
10416 been processed.  This can be used to find out the total disk size, usage
10417 and available space of all listed devices.
10418
10419 @optHumanReadable
10420
10421 @item -H
10422 @opindex -H
10423 Equivalent to @option{--si}.
10424
10425 @item -i
10426 @itemx --inodes
10427 @opindex -i
10428 @opindex --inodes
10429 @cindex inode usage
10430 List inode usage information instead of block usage.  An inode (short
10431 for index node) contains information about a file such as its owner,
10432 permissions, timestamps, and location on the disk.
10433
10434 @item -k
10435 @opindex -k
10436 @cindex kibibytes for file system sizes
10437 Print sizes in 1024-byte blocks, overriding the default block size
10438 (@pxref{Block size}).
10439 This option is equivalent to @option{--block-size=1K}.
10440
10441 @item -l
10442 @itemx --local
10443 @opindex -l
10444 @opindex --local
10445 @cindex file system types, limiting output to certain
10446 Limit the listing to local file systems.  By default, remote file systems
10447 are also listed.
10448
10449 @item --no-sync
10450 @opindex --no-sync
10451 @cindex file system space, retrieving old data more quickly
10452 Do not invoke the @code{sync} system call before getting any usage data.
10453 This may make @command{df} run significantly faster on systems with many
10454 disks, but on some systems (notably SunOS) the results may be slightly
10455 out of date.  This is the default.
10456
10457 @item -P
10458 @itemx --portability
10459 @opindex -P
10460 @opindex --portability
10461 @cindex one-line output format
10462 @cindex @acronym{POSIX} output format
10463 @cindex portable output format
10464 @cindex output format, portable
10465 Use the @acronym{POSIX} output format.  This is like the default format except
10466 for the following:
10467
10468 @enumerate
10469 @item
10470 The information about each file system is always printed on exactly
10471 one line; a mount device is never put on a line by itself.  This means
10472 that if the mount device name is more than 20 characters long (e.g., for
10473 some network mounts), the columns are misaligned.
10474
10475 @item
10476 The labels in the header output line are changed to conform to @acronym{POSIX}.
10477
10478 @item
10479 The default block size and output format are unaffected by the
10480 @env{DF_BLOCK_SIZE}, @env{BLOCK_SIZE} and @env{BLOCKSIZE} environment
10481 variables.  However, the default block size is still affected by
10482 @env{POSIXLY_CORRECT}: it is 512 if @env{POSIXLY_CORRECT} is set, 1024
10483 otherwise.  @xref{Block size}.
10484 @end enumerate
10485
10486 @optSi
10487
10488 @item --sync
10489 @opindex --sync
10490 @cindex file system space, retrieving current data more slowly
10491 Invoke the @code{sync} system call before getting any usage data.  On
10492 some systems (notably SunOS), doing this yields more up to date results,
10493 but in general this option makes @command{df} much slower, especially when
10494 there are many or very busy file systems.
10495
10496 @item -t @var{fstype}
10497 @itemx --type=@var{fstype}
10498 @opindex -t
10499 @opindex --type
10500 @cindex file system types, limiting output to certain
10501 Limit the listing to file systems of type @var{fstype}.  Multiple
10502 file system types can be specified by giving multiple @option{-t} options.
10503 By default, nothing is omitted.
10504
10505 @item -T
10506 @itemx --print-type
10507 @opindex -T
10508 @opindex --print-type
10509 @cindex file system types, printing
10510 Print each file system's type.  The types printed here are the same ones
10511 you can include or exclude with @option{-t} and @option{-x}.  The particular
10512 types printed are whatever is supported by the system.  Here are some of
10513 the common names (this list is certainly not exhaustive):
10514
10515 @table @samp
10516
10517 @item nfs
10518 @cindex @acronym{NFS} file system type
10519 An @acronym{NFS} file system, i.e., one mounted over a network from another
10520 machine.  This is the one type name which seems to be used uniformly by
10521 all systems.
10522
10523 @item 4.2@r{, }ufs@r{, }efs@dots{}
10524 @cindex Linux file system types
10525 @cindex local file system types
10526 @opindex 4.2 @r{file system type}
10527 @opindex ufs @r{file system type}
10528 @opindex efs @r{file system type}
10529 A file system on a locally-mounted hard disk.  (The system might even
10530 support more than one type here; Linux does.)
10531
10532 @item hsfs@r{, }cdfs
10533 @cindex CD-ROM file system type
10534 @cindex High Sierra file system
10535 @opindex hsfs @r{file system type}
10536 @opindex cdfs @r{file system type}
10537 A file system on a CD-ROM drive.  HP-UX uses @samp{cdfs}, most other
10538 systems use @samp{hsfs} (@samp{hs} for ``High Sierra'').
10539
10540 @item pcfs
10541 @cindex PC file system
10542 @cindex DOS file system
10543 @cindex MS-DOS file system
10544 @cindex diskette file system
10545 @opindex pcfs
10546 An MS-DOS file system, usually on a diskette.
10547
10548 @end table
10549
10550 @item -x @var{fstype}
10551 @itemx --exclude-type=@var{fstype}
10552 @opindex -x
10553 @opindex --exclude-type
10554 Limit the listing to file systems not of type @var{fstype}.
10555 Multiple file system types can be eliminated by giving multiple
10556 @option{-x} options.  By default, no file system types are omitted.
10557
10558 @item -v
10559 Ignored; for compatibility with System V versions of @command{df}.
10560
10561 @end table
10562
10563 @exitstatus
10564 Failure includes the case where no output is generated, so you can
10565 inspect the exit status of a command like @samp{df -t ext3 -t reiserfs
10566 @var{dir}} to test whether @var{dir} is on a file system of type
10567 @samp{ext3} or @samp{reiserfs}.
10568
10569
10570 @node du invocation
10571 @section @command{du}: Estimate file space usage
10572
10573 @pindex du
10574 @cindex file space usage
10575 @cindex disk usage for files
10576
10577 @command{du} reports the amount of disk space used by the specified files
10578 and for each subdirectory (of directory arguments).  Synopsis:
10579
10580 @example
10581 du [@var{option}]@dots{} [@var{file}]@dots{}
10582 @end example
10583
10584 With no arguments, @command{du} reports the disk space for the current
10585 directory.  Normally the disk space is printed in units of
10586 1024 bytes, but this can be overridden (@pxref{Block size}).
10587 Non-integer quantities are rounded up to the next higher unit.
10588
10589 If two or more hard links point to the same file, only one of the hard
10590 links is counted.  The @var{file} argument order affects which links
10591 are counted, and changing the argument order may change the numbers
10592 that @command{du} outputs.
10593
10594 The program accepts the following options.  Also see @ref{Common options}.
10595
10596 @table @samp
10597
10598 @item -a
10599 @itemx --all
10600 @opindex -a
10601 @opindex --all
10602 Show counts for all files, not just directories.
10603
10604 @itemx --apparent-size
10605 @opindex --apparent-size
10606 Print apparent sizes, rather than disk usage.  The apparent size of a
10607 file is the number of bytes reported by @code{wc -c} on regular files,
10608 or more generally, @code{ls -l --block-size=1} or @code{stat --format=%s}.
10609 For example, a file containing the word @samp{zoo} with no newline would,
10610 of course, have an apparent size of 3.  Such a small file may require
10611 anywhere from 0 to 16 KiB or more of disk space, depending on
10612 the type and configuration of the file system on which the file resides.
10613 However, a sparse file created with this command:
10614
10615 @example
10616 dd bs=1 seek=2GiB if=/dev/null of=big
10617 @end example
10618
10619 @noindent
10620 has an apparent size of 2 GiB, yet on most modern
10621 systems, it actually uses almost no disk space.
10622
10623 @item -b
10624 @itemx --bytes
10625 @opindex -b
10626 @opindex --bytes
10627 Equivalent to @code{--apparent-size --block-size=1}.
10628
10629 @item -B @var{size}
10630 @itemx --block-size=@var{size}
10631 @opindex -B
10632 @opindex --block-size
10633 @cindex file sizes
10634 Scale sizes by @var{size} before printing them (@pxref{Block size}).
10635 For example, @option{-BG} prints sizes in units of 1,073,741,824 bytes.
10636
10637 @item -c
10638 @itemx --total
10639 @opindex -c
10640 @opindex --total
10641 @cindex grand total of disk space
10642 Print a grand total of all arguments after all arguments have
10643 been processed.  This can be used to find out the total disk usage of
10644 a given set of files or directories.
10645
10646 @item -D
10647 @itemx --dereference-args
10648 @opindex -D
10649 @opindex --dereference-args
10650 Dereference symbolic links that are command line arguments.
10651 Does not affect other symbolic links.  This is helpful for finding
10652 out the disk usage of directories, such as @file{/usr/tmp}, which
10653 are often symbolic links.
10654
10655 @c --files0-from=FILE
10656 @filesZeroFromOption{du,, with the @option{--total} (@option{-c}) option}
10657
10658 @optHumanReadable
10659
10660 @item -H
10661 @opindex -H
10662 Equivalent to @option{--dereference-args} (@option{-D}).
10663
10664 @item -k
10665 @opindex -k
10666 @cindex kibibytes for file sizes
10667 Print sizes in 1024-byte blocks, overriding the default block size
10668 (@pxref{Block size}).
10669 This option is equivalent to @option{--block-size=1K}.
10670
10671 @item -l
10672 @itemx --count-links
10673 @opindex -l
10674 @opindex --count-links
10675 @cindex hard links, counting in @command{du}
10676 Count the size of all files, even if they have appeared already (as a
10677 hard link).
10678
10679 @item -L
10680 @itemx --dereference
10681 @opindex -L
10682 @opindex --dereference
10683 @cindex symbolic links, dereferencing in @command{du}
10684 Dereference symbolic links (show the disk space used by the file
10685 or directory that the link points to instead of the space used by
10686 the link).
10687
10688 @item -m
10689 @opindex -m
10690 @cindex mebibytes for file sizes
10691 Print sizes in 1,048,576-byte blocks, overriding the default block size
10692 (@pxref{Block size}).
10693 This option is equivalent to @option{--block-size=1M}.
10694
10695 @item -P
10696 @itemx --no-dereference
10697 @opindex -P
10698 @opindex --no-dereference
10699 @cindex symbolic links, dereferencing in @command{du}
10700 For each symbolic links encountered by @command{du},
10701 consider the disk space used by the symbolic link.
10702
10703 @item -d @var{depth}
10704 @item --max-depth=@var{depth}
10705 @opindex -d @var{depth}
10706 @opindex --max-depth=@var{depth}
10707 @cindex limiting output of @command{du}
10708 Show the total for each directory (and file if --all) that is at
10709 most MAX_DEPTH levels down from the root of the hierarchy.  The root
10710 is at level 0, so @code{du --max-depth=0} is equivalent to @code{du -s}.
10711
10712 @optNull{du}
10713
10714 @optSi
10715
10716 @item -s
10717 @itemx --summarize
10718 @opindex -s
10719 @opindex --summarize
10720 Display only a total for each argument.
10721
10722 @item -S
10723 @itemx --separate-dirs
10724 @opindex -S
10725 @opindex --separate-dirs
10726 Normally, in the output of @command{du} (when not using @option{--summarize}),
10727 the size listed next to a directory name, @var{d}, represents the sum
10728 of sizes of all entries beneath @var{d} as well as the size of @var{d} itself.
10729 With @option{--separate-dirs}, the size reported for a directory name,
10730 @var{d}, is merely the @code{stat.st_size}-derived size of the directory
10731 entry, @var{d}.
10732
10733 @itemx --time
10734 @opindex --time
10735 @cindex last modified dates, displaying in @command{du}
10736 Show time of the most recent modification of any file in the directory,
10737 or any of its subdirectories.
10738
10739 @itemx --time=ctime
10740 @itemx --time=status
10741 @itemx --time=use
10742 @opindex --time
10743 @opindex ctime@r{, show the most recent}
10744 @opindex status time@r{, show the most recent}
10745 @opindex use time@r{, show the most recent}
10746 Show the most recent status change time (the @samp{ctime} in the inode) of
10747 any file in the directory, instead of the modification time.
10748
10749 @itemx --time=atime
10750 @itemx --time=access
10751 @opindex --time
10752 @opindex atime@r{, show the most recent}
10753 @opindex access time@r{, show the most recent}
10754 Show the most recent access time (the @samp{atime} in the inode) of
10755 any file in the directory, instead of the modification time.
10756
10757 @item --time-style=@var{style}
10758 @opindex --time-style
10759 @cindex time style
10760 List timestamps in style @var{style}.  This option has an effect only if
10761 the @option{--time} option is also specified.  The @var{style} should
10762 be one of the following:
10763
10764 @table @samp
10765 @item +@var{format}
10766 @vindex LC_TIME
10767 List timestamps using @var{format}, where @var{format} is interpreted
10768 like the format argument of @command{date} (@pxref{date invocation}).
10769 For example, @option{--time-style="+%Y-%m-%d %H:%M:%S"} causes
10770 @command{du} to list timestamps like @samp{2002-03-30 23:45:56}.  As
10771 with @command{date}, @var{format}'s interpretation is affected by the
10772 @env{LC_TIME} locale category.
10773
10774 @item full-iso
10775 List timestamps in full using @acronym{ISO} 8601 date, time, and time zone
10776 format with nanosecond precision, e.g., @samp{2002-03-30
10777 23:45:56.477817180 -0700}.  This style is equivalent to
10778 @samp{+%Y-%m-%d %H:%M:%S.%N %z}.
10779
10780 @item long-iso
10781 List @acronym{ISO} 8601 date and time in minutes, e.g.,
10782 @samp{2002-03-30 23:45}.  These timestamps are shorter than
10783 @samp{full-iso} timestamps, and are usually good enough for everyday
10784 work.  This style is equivalent to @samp{+%Y-%m-%d %H:%M}.
10785
10786 @item iso
10787 List @acronym{ISO} 8601 dates for timestamps, e.g., @samp{2002-03-30}.
10788 This style is equivalent to @samp{+%Y-%m-%d}.
10789 @end table
10790
10791 @vindex TIME_STYLE
10792 You can specify the default value of the @option{--time-style} option
10793 with the environment variable @env{TIME_STYLE}; if @env{TIME_STYLE} is not set
10794 the default style is @samp{long-iso}.  For compatibility with @command{ls},
10795 if @env{TIME_STYLE} begins with @samp{+} and contains a newline,
10796 the newline and any later characters are ignored; if @env{TIME_STYLE}
10797 begins with @samp{posix-} the @samp{posix-} is ignored; and if
10798 @env{TIME_STYLE} is @samp{locale} it is ignored.
10799
10800 @item -x
10801 @itemx --one-file-system
10802 @opindex -x
10803 @opindex --one-file-system
10804 @cindex one file system, restricting @command{du} to
10805 Skip directories that are on different file systems from the one that
10806 the argument being processed is on.
10807
10808 @item --exclude=@var{pattern}
10809 @opindex --exclude=@var{pattern}
10810 @cindex excluding files from @command{du}
10811 When recursing, skip subdirectories or files matching @var{pattern}.
10812 For example, @code{du --exclude='*.o'} excludes files whose names
10813 end in @samp{.o}.
10814
10815 @item -X @var{file}
10816 @itemx --exclude-from=@var{file}
10817 @opindex -X @var{file}
10818 @opindex --exclude-from=@var{file}
10819 @cindex excluding files from @command{du}
10820 Like @option{--exclude}, except take the patterns to exclude from @var{file},
10821 one per line.  If @var{file} is @samp{-}, take the patterns from standard
10822 input.
10823
10824 @end table
10825
10826 @cindex NFS mounts from BSD to HP-UX
10827 On BSD systems, @command{du} reports sizes that are half the correct
10828 values for files that are NFS-mounted from HP-UX systems.  On HP-UX
10829 systems, it reports sizes that are twice the correct values for
10830 files that are NFS-mounted from BSD systems.  This is due to a flaw
10831 in HP-UX; it also affects the HP-UX @command{du} program.
10832
10833 @exitstatus
10834
10835
10836 @node stat invocation
10837 @section @command{stat}: Report file or file system status
10838
10839 @pindex stat
10840 @cindex file status
10841 @cindex file system status
10842
10843 @command{stat} displays information about the specified file(s).  Synopsis:
10844
10845 @example
10846 stat [@var{option}]@dots{} [@var{file}]@dots{}
10847 @end example
10848
10849 With no option, @command{stat} reports all information about the given files.
10850 But it also can be used to report the information of the file systems the
10851 given files are located on.  If the files are links, @command{stat} can
10852 also give information about the files the links point to.
10853
10854 @mayConflictWithShellBuiltIn{stat}
10855
10856 @table @samp
10857
10858 @item -L
10859 @itemx --dereference
10860 @opindex -L
10861 @opindex --dereference
10862 @cindex symbolic links, dereferencing in @command{stat}
10863 Change how @command{stat} treats symbolic links.
10864 With this option, @command{stat} acts on the file referenced
10865 by each symbolic link argument.
10866 Without it, @command{stat} acts on any symbolic link argument directly.
10867
10868 @item -f
10869 @itemx --file-system
10870 @opindex -f
10871 @opindex --file-system
10872 @cindex file systems
10873 Report information about the file systems where the given files are located
10874 instead of information about the files themselves.
10875 This option implies the @option{-L} option.
10876
10877 @item -c
10878 @itemx --format=@var{format}
10879 @opindex -c
10880 @opindex --format=@var{format}
10881 @cindex output format
10882 Use @var{format} rather than the default format.
10883 @var{format} is automatically newline-terminated, so
10884 running a command like the following with two or more @var{file}
10885 operands produces a line of output for each operand:
10886 @example
10887 $ stat --format=%d:%i / /usr
10888 2050:2
10889 2057:2
10890 @end example
10891
10892 @itemx --printf=@var{format}
10893 @opindex --printf=@var{format}
10894 @cindex output format
10895 Use @var{format} rather than the default format.
10896 Like @option{--format}, but interpret backslash escapes,
10897 and do not output a mandatory trailing newline.
10898 If you want a newline, include @samp{\n} in the @var{format}.
10899 Here's how you would use @option{--printf} to print the device
10900 and inode numbers of @file{/} and @file{/usr}:
10901 @example
10902 $ stat --printf='%d:%i\n' / /usr
10903 2050:2
10904 2057:2
10905 @end example
10906
10907 @item -t
10908 @itemx --terse
10909 @opindex -t
10910 @opindex --terse
10911 @cindex terse output
10912 Print the information in terse form, suitable for parsing by other programs.
10913
10914 @end table
10915
10916 The valid @var{format} directives for files with @option{--format} and
10917 @option{--printf} are:
10918
10919 @itemize @bullet
10920 @item %a - Access rights in octal
10921 @item %A - Access rights in human readable form
10922 @item %b - Number of blocks allocated (see @samp{%B})
10923 @item %B - The size in bytes of each block reported by @samp{%b}
10924 @item %C - The SELinux security context of a file, if available
10925 @item %d - Device number in decimal
10926 @item %D - Device number in hex
10927 @item %f - Raw mode in hex
10928 @item %F - File type
10929 @item %g - Group ID of owner
10930 @item %G - Group name of owner
10931 @item %h - Number of hard links
10932 @item %i - Inode number
10933 @item %m - Mount point (See note below)
10934 @item %n - File name
10935 @item %N - Quoted file name with dereference if symbolic link
10936 @item %o - I/O block size
10937 @item %s - Total size, in bytes
10938 @item %t - Major device type in hex
10939 @item %T - Minor device type in hex
10940 @item %u - User ID of owner
10941 @item %U - User name of owner
10942 @item %w - Time of file birth, or @samp{-} if unknown
10943 @item %W - Time of file birth as seconds since Epoch, or @samp{0}
10944 @item %x - Time of last access
10945 @item %X - Time of last access as seconds since Epoch
10946 @item %y - Time of last modification
10947 @item %Y - Time of last modification as seconds since Epoch
10948 @item %z - Time of last change
10949 @item %Z - Time of last change as seconds since Epoch
10950 @end itemize
10951
10952 The @samp{%W}, @samp{%X}, @samp{%Y}, and @samp{%Z} formats accept a
10953 precision preceded by a period to specify the number of digits to
10954 print after the decimal point.  For example, @samp{%.3X} outputs the
10955 last access time to millisecond precision.  If a period is given but no
10956 precision, @command{stat} uses 9 digits, so @samp{%.X} is equivalent to
10957 @samp{%.9X}.  When discarding excess precision, time stamps are truncated
10958 toward minus infinity.
10959
10960 @example
10961 zero pad:
10962   $ stat -c '[%015Y]' /usr
10963   [000001288929712]
10964 space align:
10965   $ stat -c '[%15Y]' /usr
10966   [     1288929712]
10967   $ stat -c '[%-15Y]' /usr
10968   [1288929712     ]
10969 precision:
10970   $ stat -c '[%.3Y]' /usr
10971   [1288929712.114]
10972   $ stat -c '[%.Y]' /usr
10973   [1288929712.114951834]
10974 @end example
10975
10976 The mount point printed by @samp{%m} is similar to that output
10977 by @command{df}, except that:
10978 @itemize @bullet
10979 @item
10980 stat does not dereference symlinks by default
10981 (unless @option{-L} is specified)
10982 @item
10983 stat does not search for specified device nodes in the
10984 file system list, instead operating on them directly
10985 @item
10986 @cindex bind mount
10987 stat outputs the alias for a bind mounted file, rather than
10988 the initial mount point of its backing device.
10989 One can recursively call stat until there is no change in output,
10990 to get the current base mount point
10991 @end itemize
10992
10993 When listing file system information (@option{--file-system} (@option{-f})),
10994 you must use a different set of @var{format} directives:
10995
10996 @itemize @bullet
10997 @item %a - Free blocks available to non-super-user
10998 @item %b - Total data blocks in file system
10999 @item %c - Total file nodes in file system
11000 @item %d - Free file nodes in file system
11001 @item %f - Free blocks in file system
11002 @item %i - File System ID in hex
11003 @item %l - Maximum length of file names
11004 @item %n - File name
11005 @item %s - Block size (for faster transfers)
11006 @item %S - Fundamental block size (for block counts)
11007 @item %t - Type in hex
11008 @item %T - Type in human readable form
11009 @end itemize
11010
11011 @vindex TZ
11012 Time stamps are listed according to the time zone rules specified by
11013 the @env{TZ} environment variable, or by the system default rules if
11014 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
11015 with @env{TZ}, libc, The GNU C Library Reference Manual}.
11016
11017 @exitstatus
11018
11019
11020 @node sync invocation
11021 @section @command{sync}: Synchronize data on disk with memory
11022
11023 @pindex sync
11024 @cindex synchronize disk and memory
11025
11026 @cindex superblock, writing
11027 @cindex inodes, written buffered
11028 @command{sync} writes any data buffered in memory out to disk.  This can
11029 include (but is not limited to) modified superblocks, modified inodes,
11030 and delayed reads and writes.  This must be implemented by the kernel;
11031 The @command{sync} program does nothing but exercise the @code{sync} system
11032 call.
11033
11034 @cindex crashes and corruption
11035 The kernel keeps data in memory to avoid doing (relatively slow) disk
11036 reads and writes.  This improves performance, but if the computer
11037 crashes, data may be lost or the file system corrupted as a
11038 result.  The @command{sync} command ensures everything in memory
11039 is written to disk.
11040
11041 Any arguments are ignored, except for a lone @option{--help} or
11042 @option{--version} (@pxref{Common options}).
11043
11044 @exitstatus
11045
11046
11047 @node truncate invocation
11048 @section @command{truncate}: Shrink or extend the size of a file
11049
11050 @pindex truncate
11051 @cindex truncating, file sizes
11052
11053 @command{truncate} shrinks or extends the size of each @var{file} to the
11054 specified size. Synopsis:
11055
11056 @example
11057 truncate @var{option}@dots{} @var{file}@dots{}
11058 @end example
11059
11060 @cindex files, creating
11061 Any @var{file} that does not exist is created.
11062
11063 @cindex sparse files, creating
11064 @cindex holes, creating files with
11065 If a @var{file} is larger than the specified size, the extra data is lost.
11066 If a @var{file} is shorter, it is extended and the extended part (or hole)
11067 reads as zero bytes.
11068
11069 The program accepts the following options.  Also see @ref{Common options}.
11070
11071 @table @samp
11072
11073 @item -c
11074 @itemx --no-create
11075 @opindex -c
11076 @opindex --no-create
11077 Do not create files that do not exist.
11078
11079 @item -o
11080 @itemx --io-blocks
11081 @opindex -o
11082 @opindex --io-blocks
11083 Treat @var{size} as number of I/O blocks of the @var{file} rather than bytes.
11084
11085 @item -r @var{rfile}
11086 @itemx --reference=@var{rfile}
11087 @opindex -r
11088 @opindex --reference
11089 Base the size of each @var{file} on the size of @var{rfile}.
11090
11091 @item -s @var{size}
11092 @itemx --size=@var{size}
11093 @opindex -s
11094 @opindex --size
11095 Set or adjust the size of each @var{file} according to @var{size}.
11096 @multiplierSuffixesNoBlocks{size}
11097
11098 @var{size} may also be prefixed by one of the following to adjust
11099 the size of each @var{file} based on their current size:
11100 @example
11101 @samp{+}  => extend by
11102 @samp{-}  => reduce by
11103 @samp{<}  => at most
11104 @samp{>}  => at least
11105 @samp{/}  => round down to multiple of
11106 @samp{%}  => round up to multiple of
11107 @end example
11108
11109 @end table
11110
11111 @exitstatus
11112
11113
11114 @node Printing text
11115 @chapter Printing text
11116
11117 @cindex printing text, commands for
11118 @cindex commands for printing text
11119
11120 This section describes commands that display text strings.
11121
11122 @menu
11123 * echo invocation::             Print a line of text.
11124 * printf invocation::           Format and print data.
11125 * yes invocation::              Print a string until interrupted.
11126 @end menu
11127
11128
11129 @node echo invocation
11130 @section @command{echo}: Print a line of text
11131
11132 @pindex echo
11133 @cindex displaying text
11134 @cindex printing text
11135 @cindex text, displaying
11136 @cindex arbitrary text, displaying
11137
11138 @command{echo} writes each given @var{string} to standard output, with a
11139 space between each and a newline after the last one.  Synopsis:
11140
11141 @example
11142 echo [@var{option}]@dots{} [@var{string}]@dots{}
11143 @end example
11144
11145 @mayConflictWithShellBuiltIn{echo}
11146
11147 The program accepts the following options.  Also see @ref{Common options}.
11148 Options must precede operands, and the normally-special argument
11149 @samp{--} has no special meaning and is treated like any other
11150 @var{string}.
11151
11152 @table @samp
11153 @item -n
11154 @opindex -n
11155 Do not output the trailing newline.
11156
11157 @item -e
11158 @opindex -e
11159 @cindex backslash escapes
11160 Enable interpretation of the following backslash-escaped characters in
11161 each @var{string}:
11162
11163 @table @samp
11164 @item \a
11165 alert (bell)
11166 @item \b
11167 backspace
11168 @item \c
11169 produce no further output
11170 @item \e
11171 escape
11172 @item \f
11173 form feed
11174 @item \n
11175 newline
11176 @item \r
11177 carriage return
11178 @item \t
11179 horizontal tab
11180 @item \v
11181 vertical tab
11182 @item \\
11183 backslash
11184 @item \0@var{nnn}
11185 the eight-bit value that is the octal number @var{nnn}
11186 (zero to three octal digits), if @var{nnn} is
11187 a nine-bit value, the ninth bit is ignored
11188 @item \@var{nnn}
11189 the eight-bit value that is the octal number @var{nnn}
11190 (one to three octal digits), if @var{nnn} is
11191 a nine-bit value, the ninth bit is ignored
11192 @item \x@var{hh}
11193 the eight-bit value that is the hexadecimal number @var{hh}
11194 (one or two hexadecimal digits)
11195 @end table
11196
11197 @item -E
11198 @opindex -E
11199 @cindex backslash escapes
11200 Disable interpretation of backslash escapes in each @var{string}.
11201 This is the default.  If @option{-e} and @option{-E} are both
11202 specified, the last one given takes effect.
11203
11204 @end table
11205
11206 @vindex POSIXLY_CORRECT
11207 If the @env{POSIXLY_CORRECT} environment variable is set, then when
11208 @command{echo}'s first argument is not @option{-n} it outputs
11209 option-like arguments instead of treating them as options.  For
11210 example, @code{echo -ne hello} outputs @samp{-ne hello} instead of
11211 plain @samp{hello}.
11212
11213 @acronym{POSIX} does not require support for any options, and says
11214 that the behavior of @command{echo} is implementation-defined if any
11215 @var{string} contains a backslash or if the first argument is
11216 @option{-n}.  Portable programs can use the @command{printf} command
11217 if they need to omit trailing newlines or output control characters or
11218 backslashes.  @xref{printf invocation}.
11219
11220 @exitstatus
11221
11222
11223 @node printf invocation
11224 @section @command{printf}: Format and print data
11225
11226 @pindex printf
11227 @command{printf} does formatted printing of text.  Synopsis:
11228
11229 @example
11230 printf @var{format} [@var{argument}]@dots{}
11231 @end example
11232
11233 @command{printf} prints the @var{format} string, interpreting @samp{%}
11234 directives and @samp{\} escapes to format numeric and string arguments
11235 in a way that is mostly similar to the C @samp{printf} function.
11236 @xref{Output Conversion Syntax,, @command{printf} format directives,
11237 libc, The GNU C Library Reference Manual}, for details.
11238 The differences are listed below.
11239
11240 @mayConflictWithShellBuiltIn{printf}
11241
11242 @itemize @bullet
11243
11244 @item
11245 The @var{format} argument is reused as necessary to convert all the
11246 given @var{argument}s.  For example, the command @samp{printf %s a b}
11247 outputs @samp{ab}.
11248
11249 @item
11250 Missing @var{argument}s are treated as null strings or as zeros,
11251 depending on whether the context expects a string or a number.  For
11252 example, the command @samp{printf %sx%d} prints @samp{x0}.
11253
11254 @item
11255 @kindex \c
11256 An additional escape, @samp{\c}, causes @command{printf} to produce no
11257 further output.  For example, the command @samp{printf 'A%sC\cD%sF' B
11258 E} prints @samp{ABC}.
11259
11260 @item
11261 The hexadecimal escape sequence @samp{\x@var{hh}} has at most two
11262 digits, as opposed to C where it can have an unlimited number of
11263 digits.  For example, the command @samp{printf '\x07e'} prints two
11264 bytes, whereas the C statement @samp{printf ("\x07e")} prints just
11265 one.
11266
11267 @item
11268 @kindex %b
11269 @command{printf} has an additional directive, @samp{%b}, which prints its
11270 argument string with @samp{\} escapes interpreted in the same way as in
11271 the @var{format} string, except that octal escapes are of the form
11272 @samp{\0@var{ooo}} where @var{ooo} is 0 to 3 octal digits.  If
11273 @samp{\@var{ooo}} is nine-bit value, ignore the ninth bit.
11274 If a precision is also given, it limits the number of bytes printed
11275 from the converted string.
11276
11277 @item
11278 Numeric arguments must be single C constants, possibly with leading
11279 @samp{+} or @samp{-}.  For example, @samp{printf %.4d -3} outputs
11280 @samp{-0003}.
11281
11282 @item
11283 @vindex POSIXLY_CORRECT
11284 If the leading character of a numeric argument is @samp{"} or @samp{'}
11285 then its value is the numeric value of the immediately following
11286 character.  Any remaining characters are silently ignored if the
11287 @env{POSIXLY_CORRECT} environment variable is set; otherwise, a
11288 warning is printed.  For example, @samp{printf "%d" "'a"} outputs
11289 @samp{97} on hosts that use the @acronym{ASCII} character set, since
11290 @samp{a} has the numeric value 97 in @acronym{ASCII}.
11291
11292 @end itemize
11293
11294 @vindex LC_NUMERIC
11295 A floating-point argument must use a period before any fractional
11296 digits, but is printed according to the @env{LC_NUMERIC} category of the
11297 current locale.  For example, in a locale whose radix character is a
11298 comma, the command @samp{printf %g 3.14} outputs @samp{3,14} whereas
11299 the command @samp{printf %g 3,14} is an error.
11300 @xref{Floating point}.
11301
11302 @kindex \@var{ooo}
11303 @kindex \x@var{hh}
11304 @command{printf} interprets @samp{\@var{ooo}} in @var{format} as an octal number
11305 (if @var{ooo} is 1 to 3 octal digits) specifying a byte to print,
11306 and @samp{\x@var{hh}} as a hexadecimal number (if @var{hh} is 1 to 2 hex
11307 digits) specifying a character to print.
11308 Note however that when @samp{\@var{ooo}} specifies a number larger than 255,
11309 @command{printf} ignores the ninth bit.
11310 For example, @samp{printf '\400'} is equivalent to @samp{printf '\0'}.
11311
11312 @kindex \uhhhh
11313 @kindex \Uhhhhhhhh
11314 @cindex Unicode
11315 @cindex ISO/IEC 10646
11316 @vindex LC_CTYPE
11317 @command{printf} interprets two character syntaxes introduced in
11318 @acronym{ISO} C 99:
11319 @samp{\u} for 16-bit Unicode (@acronym{ISO}/@acronym{IEC} 10646)
11320 characters, specified as
11321 four hexadecimal digits @var{hhhh}, and @samp{\U} for 32-bit Unicode
11322 characters, specified as eight hexadecimal digits @var{hhhhhhhh}.
11323 @command{printf} outputs the Unicode characters
11324 according to the @env{LC_CTYPE} locale.  Unicode characters in the ranges
11325 U+0000...U+009F, U+D800...U+DFFF cannot be specified by this syntax, except
11326 for U+0024 ($), U+0040 (@@), and U+0060 (@`).
11327
11328 The processing of @samp{\u} and @samp{\U} requires a full-featured
11329 @code{iconv} facility.  It is activated on systems with glibc 2.2 (or newer),
11330 or when @code{libiconv} is installed prior to this package.  Otherwise
11331 @samp{\u} and @samp{\U} will print as-is.
11332
11333 The only options are a lone @option{--help} or
11334 @option{--version}.  @xref{Common options}.
11335 Options must precede operands.
11336
11337 The Unicode character syntaxes are useful for writing strings in a locale
11338 independent way.  For example, a string containing the Euro currency symbol
11339
11340 @example
11341 $ env printf '\u20AC 14.95'
11342 @end example
11343
11344 @noindent
11345 will be output correctly in all locales supporting the Euro symbol
11346 (@acronym{ISO}-8859-15, UTF-8, and others).  Similarly, a Chinese string
11347
11348 @example
11349 $ env printf '\u4e2d\u6587'
11350 @end example
11351
11352 @noindent
11353 will be output correctly in all Chinese locales (GB2312, BIG5, UTF-8, etc).
11354
11355 Note that in these examples, the @command{printf} command has been
11356 invoked via @command{env} to ensure that we run the program found via
11357 your shell's search path, and not a shell alias or a built-in function.
11358
11359 For larger strings, you don't need to look up the hexadecimal code
11360 values of each character one by one.  @acronym{ASCII} characters mixed with \u
11361 escape sequences is also known as the JAVA source file encoding.  You can
11362 use GNU recode 3.5c (or newer) to convert strings to this encoding.  Here
11363 is how to convert a piece of text into a shell script which will output
11364 this text in a locale-independent way:
11365
11366 @smallexample
11367 $ LC_CTYPE=zh_CN.big5 /usr/local/bin/printf \
11368     '\u4e2d\u6587\n' > sample.txt
11369 $ recode BIG5..JAVA < sample.txt \
11370     | sed -e "s|^|/usr/local/bin/printf '|" -e "s|$|\\\\n'|" \
11371     > sample.sh
11372 @end smallexample
11373
11374 @exitstatus
11375
11376
11377 @node yes invocation
11378 @section @command{yes}: Print a string until interrupted
11379
11380 @pindex yes
11381 @cindex repeated output of a string
11382
11383 @command{yes} prints the command line arguments, separated by spaces and
11384 followed by a newline, forever until it is killed.  If no arguments are
11385 given, it prints @samp{y} followed by a newline forever until killed.
11386
11387 Upon a write error, @command{yes} exits with status @samp{1}.
11388
11389 The only options are a lone @option{--help} or @option{--version}.
11390 To output an argument that begins with
11391 @samp{-}, precede it with @option{--}, e.g., @samp{yes -- --help}.
11392 @xref{Common options}.
11393
11394
11395 @node Conditions
11396 @chapter Conditions
11397
11398 @cindex conditions
11399 @cindex commands for exit status
11400 @cindex exit status commands
11401
11402 This section describes commands that are primarily useful for their exit
11403 status, rather than their output.  Thus, they are often used as the
11404 condition of shell @code{if} statements, or as the last command in a
11405 pipeline.
11406
11407 @menu
11408 * false invocation::            Do nothing, unsuccessfully.
11409 * true invocation::             Do nothing, successfully.
11410 * test invocation::             Check file types and compare values.
11411 * expr invocation::             Evaluate expressions.
11412 @end menu
11413
11414
11415 @node false invocation
11416 @section @command{false}: Do nothing, unsuccessfully
11417
11418 @pindex false
11419 @cindex do nothing, unsuccessfully
11420 @cindex failure exit status
11421 @cindex exit status of @command{false}
11422
11423 @command{false} does nothing except return an exit status of 1, meaning
11424 @dfn{failure}.  It can be used as a place holder in shell scripts
11425 where an unsuccessful command is needed.
11426 In most modern shells, @command{false} is a built-in command, so when
11427 you use @samp{false} in a script, you're probably using the built-in
11428 command, not the one documented here.
11429
11430 @command{false} honors the @option{--help} and @option{--version} options.
11431
11432 This version of @command{false} is implemented as a C program, and is thus
11433 more secure and faster than a shell script implementation, and may safely
11434 be used as a dummy shell for the purpose of disabling accounts.
11435
11436 Note that @command{false} (unlike all other programs documented herein)
11437 exits unsuccessfully, even when invoked with
11438 @option{--help} or @option{--version}.
11439
11440 Portable programs should not assume that the exit status of
11441 @command{false} is 1, as it is greater than 1 on some
11442 non-@acronym{GNU} hosts.
11443
11444
11445 @node true invocation
11446 @section @command{true}: Do nothing, successfully
11447
11448 @pindex true
11449 @cindex do nothing, successfully
11450 @cindex no-op
11451 @cindex successful exit
11452 @cindex exit status of @command{true}
11453
11454 @command{true} does nothing except return an exit status of 0, meaning
11455 @dfn{success}.  It can be used as a place holder in shell scripts
11456 where a successful command is needed, although the shell built-in
11457 command @code{:} (colon) may do the same thing faster.
11458 In most modern shells, @command{true} is a built-in command, so when
11459 you use @samp{true} in a script, you're probably using the built-in
11460 command, not the one documented here.
11461
11462 @command{true} honors the @option{--help} and @option{--version} options.
11463
11464 Note, however, that it is possible to cause @command{true}
11465 to exit with nonzero status: with the @option{--help} or @option{--version}
11466 option, and with standard
11467 output already closed or redirected to a file that evokes an I/O error.
11468 For example, using a Bourne-compatible shell:
11469
11470 @example
11471 $ ./true --version >&-
11472 ./true: write error: Bad file number
11473 $ ./true --version > /dev/full
11474 ./true: write error: No space left on device
11475 @end example
11476
11477 This version of @command{true} is implemented as a C program, and is thus
11478 more secure and faster than a shell script implementation, and may safely
11479 be used as a dummy shell for the purpose of disabling accounts.
11480
11481 @node test invocation
11482 @section @command{test}: Check file types and compare values
11483
11484 @pindex test
11485 @cindex check file types
11486 @cindex compare values
11487 @cindex expression evaluation
11488
11489 @command{test} returns a status of 0 (true) or 1 (false) depending on the
11490 evaluation of the conditional expression @var{expr}.  Each part of the
11491 expression must be a separate argument.
11492
11493 @command{test} has file status checks, string operators, and numeric
11494 comparison operators.
11495
11496 @command{test} has an alternate form that uses opening and closing
11497 square brackets instead a leading @samp{test}.  For example, instead
11498 of @samp{test -d /}, you can write @samp{[ -d / ]}.  The square
11499 brackets must be separate arguments; for example, @samp{[-d /]} does
11500 not have the desired effect.  Since @samp{test @var{expr}} and @samp{[
11501 @var{expr} ]} have the same meaning, only the former form is discussed
11502 below.
11503
11504 Synopses:
11505
11506 @example
11507 test @var{expression}
11508 test
11509 [ @var{expression} ]
11510 [ ]
11511 [ @var{option}
11512 @end example
11513
11514 @mayConflictWithShellBuiltIn{test}
11515
11516 If @var{expression} is omitted, @command{test} returns false.
11517 If @var{expression} is a single argument,
11518 @command{test} returns false if the argument is null and true
11519 otherwise.  The argument
11520 can be any string, including strings like @samp{-d}, @samp{-1},
11521 @samp{--}, @samp{--help}, and @samp{--version} that most other
11522 programs would treat as options.  To get help and version information,
11523 invoke the commands @samp{[ --help} and @samp{[ --version}, without
11524 the usual closing brackets.  @xref{Common options}.
11525
11526 @cindex exit status of @command{test}
11527 Exit status:
11528
11529 @display
11530 0 if the expression is true,
11531 1 if the expression is false,
11532 2 if an error occurred.
11533 @end display
11534
11535 @menu
11536 * File type tests::             -[bcdfhLpSt]
11537 * Access permission tests::     -[gkruwxOG]
11538 * File characteristic tests::   -e -s -nt -ot -ef
11539 * String tests::                -z -n = == !=
11540 * Numeric tests::               -eq -ne -lt -le -gt -ge
11541 * Connectives for test::        ! -a -o
11542 @end menu
11543
11544
11545 @node File type tests
11546 @subsection File type tests
11547
11548 @cindex file type tests
11549
11550 These options test for particular types of files.  (Everything's a file,
11551 but not all files are the same!)
11552
11553 @table @samp
11554
11555 @item -b @var{file}
11556 @opindex -b
11557 @cindex block special check
11558 True if @var{file} exists and is a block special device.
11559
11560 @item -c @var{file}
11561 @opindex -c
11562 @cindex character special check
11563 True if @var{file} exists and is a character special device.
11564
11565 @item -d @var{file}
11566 @opindex -d
11567 @cindex directory check
11568 True if @var{file} exists and is a directory.
11569
11570 @item -f @var{file}
11571 @opindex -f
11572 @cindex regular file check
11573 True if @var{file} exists and is a regular file.
11574
11575 @item -h @var{file}
11576 @itemx -L @var{file}
11577 @opindex -L
11578 @opindex -h
11579 @cindex symbolic link check
11580 True if @var{file} exists and is a symbolic link.
11581 Unlike all other file-related tests, this test does not dereference
11582 @var{file} if it is a symbolic link.
11583
11584 @item -p @var{file}
11585 @opindex -p
11586 @cindex named pipe check
11587 True if @var{file} exists and is a named pipe.
11588
11589 @item -S @var{file}
11590 @opindex -S
11591 @cindex socket check
11592 True if @var{file} exists and is a socket.
11593
11594 @item -t @var{fd}
11595 @opindex -t
11596 @cindex terminal check
11597 True if @var{fd} is a file descriptor that is associated with a
11598 terminal.
11599
11600 @end table
11601
11602
11603 @node Access permission tests
11604 @subsection Access permission tests
11605
11606 @cindex access permission tests
11607 @cindex permission tests
11608
11609 These options test for particular access permissions.
11610
11611 @table @samp
11612
11613 @item -g @var{file}
11614 @opindex -g
11615 @cindex set-group-ID check
11616 True if @var{file} exists and has its set-group-ID bit set.
11617
11618 @item -k @var{file}
11619 @opindex -k
11620 @cindex sticky bit check
11621 True if @var{file} exists and has its @dfn{sticky} bit set.
11622
11623 @item -r @var{file}
11624 @opindex -r
11625 @cindex readable file check
11626 True if @var{file} exists and read permission is granted.
11627
11628 @item -u @var{file}
11629 @opindex -u
11630 @cindex set-user-ID check
11631 True if @var{file} exists and has its set-user-ID bit set.
11632
11633 @item -w @var{file}
11634 @opindex -w
11635 @cindex writable file check
11636 True if @var{file} exists and write permission is granted.
11637
11638 @item -x @var{file}
11639 @opindex -x
11640 @cindex executable file check
11641 True if @var{file} exists and execute permission is granted
11642 (or search permission, if it is a directory).
11643
11644 @item -O @var{file}
11645 @opindex -O
11646 @cindex owned by effective user ID check
11647 True if @var{file} exists and is owned by the current effective user ID.
11648
11649 @item -G @var{file}
11650 @opindex -G
11651 @cindex owned by effective group ID check
11652 True if @var{file} exists and is owned by the current effective group ID.
11653
11654 @end table
11655
11656 @node File characteristic tests
11657 @subsection File characteristic tests
11658
11659 @cindex file characteristic tests
11660
11661 These options test other file characteristics.
11662
11663 @table @samp
11664
11665 @item -e @var{file}
11666 @opindex -e
11667 @cindex existence-of-file check
11668 True if @var{file} exists.
11669
11670 @item -s @var{file}
11671 @opindex -s
11672 @cindex nonempty file check
11673 True if @var{file} exists and has a size greater than zero.
11674
11675 @item @var{file1} -nt @var{file2}
11676 @opindex -nt
11677 @cindex newer-than file check
11678 True if @var{file1} is newer (according to modification date) than
11679 @var{file2}, or if @var{file1} exists and @var{file2} does not.
11680
11681 @item @var{file1} -ot @var{file2}
11682 @opindex -ot
11683 @cindex older-than file check
11684 True if @var{file1} is older (according to modification date) than
11685 @var{file2}, or if @var{file2} exists and @var{file1} does not.
11686
11687 @item @var{file1} -ef @var{file2}
11688 @opindex -ef
11689 @cindex same file check
11690 @cindex hard link check
11691 True if @var{file1} and @var{file2} have the same device and inode
11692 numbers, i.e., if they are hard links to each other.
11693
11694 @end table
11695
11696
11697 @node String tests
11698 @subsection String tests
11699
11700 @cindex string tests
11701
11702 These options test string characteristics.  You may need to quote
11703 @var{string} arguments for the shell.  For example:
11704
11705 @example
11706 test -n "$V"
11707 @end example
11708
11709 The quotes here prevent the wrong arguments from being passed to
11710 @command{test} if @samp{$V} is empty or contains special characters.
11711
11712 @table @samp
11713
11714 @item -z @var{string}
11715 @opindex -z
11716 @cindex zero-length string check
11717 True if the length of @var{string} is zero.
11718
11719 @item -n @var{string}
11720 @itemx @var{string}
11721 @opindex -n
11722 @cindex nonzero-length string check
11723 True if the length of @var{string} is nonzero.
11724
11725 @item @var{string1} = @var{string2}
11726 @opindex =
11727 @cindex equal string check
11728 True if the strings are equal.
11729
11730 @item @var{string1} == @var{string2}
11731 @opindex ==
11732 @cindex equal string check
11733 True if the strings are equal (synonym for =).
11734
11735 @item @var{string1} != @var{string2}
11736 @opindex !=
11737 @cindex not-equal string check
11738 True if the strings are not equal.
11739
11740 @end table
11741
11742
11743 @node Numeric tests
11744 @subsection Numeric tests
11745
11746 @cindex numeric tests
11747 @cindex arithmetic tests
11748
11749 Numeric relational operators.  The arguments must be entirely numeric
11750 (possibly negative), or the special expression @w{@code{-l @var{string}}},
11751 which evaluates to the length of @var{string}.
11752
11753 @table @samp
11754
11755 @item @var{arg1} -eq @var{arg2}
11756 @itemx @var{arg1} -ne @var{arg2}
11757 @itemx @var{arg1} -lt @var{arg2}
11758 @itemx @var{arg1} -le @var{arg2}
11759 @itemx @var{arg1} -gt @var{arg2}
11760 @itemx @var{arg1} -ge @var{arg2}
11761 @opindex -eq
11762 @opindex -ne
11763 @opindex -lt
11764 @opindex -le
11765 @opindex -gt
11766 @opindex -ge
11767 These arithmetic binary operators return true if @var{arg1} is equal,
11768 not-equal, less-than, less-than-or-equal, greater-than, or
11769 greater-than-or-equal than @var{arg2}, respectively.
11770
11771 @end table
11772
11773 For example:
11774
11775 @example
11776 test -1 -gt -2 && echo yes
11777 @result{} yes
11778 test -l abc -gt 1 && echo yes
11779 @result{} yes
11780 test 0x100 -eq 1
11781 @error{} test: integer expression expected before -eq
11782 @end example
11783
11784
11785 @node Connectives for test
11786 @subsection Connectives for @command{test}
11787
11788 @cindex logical connectives
11789 @cindex connectives, logical
11790
11791 The usual logical connectives.
11792
11793 @table @samp
11794
11795 @item ! @var{expr}
11796 @opindex !
11797 True if @var{expr} is false.
11798
11799 @item @var{expr1} -a @var{expr2}
11800 @opindex -a
11801 @cindex logical and operator
11802 @cindex and operator
11803 True if both @var{expr1} and @var{expr2} are true.
11804
11805 @item @var{expr1} -o @var{expr2}
11806 @opindex -o
11807 @cindex logical or operator
11808 @cindex or operator
11809 True if either @var{expr1} or @var{expr2} is true.
11810
11811 @end table
11812
11813
11814 @node expr invocation
11815 @section @command{expr}: Evaluate expressions
11816
11817 @pindex expr
11818 @cindex expression evaluation
11819 @cindex evaluation of expressions
11820
11821 @command{expr} evaluates an expression and writes the result on standard
11822 output.  Each token of the expression must be a separate argument.
11823
11824 Operands are either integers or strings.  Integers consist of one or
11825 more decimal digits, with an optional leading @samp{-}.
11826 @command{expr} converts
11827 anything appearing in an operand position to an integer or a string
11828 depending on the operation being applied to it.
11829
11830 Strings are not quoted for @command{expr} itself, though you may need to
11831 quote them to protect characters with special meaning to the shell,
11832 e.g., spaces.  However, regardless of whether it is quoted, a string
11833 operand should not be a parenthesis or any of @command{expr}'s
11834 operators like @code{+}, so you cannot safely pass an arbitrary string
11835 @code{$str} to expr merely by quoting it to the shell.  One way to
11836 work around this is to use the @sc{gnu} extension @code{+},
11837 (e.g., @code{+ "$str" = foo}); a more portable way is to use
11838 @code{@w{" $str"}} and to adjust the rest of the expression to take
11839 the leading space into account (e.g., @code{@w{" $str" = " foo"}}).
11840
11841 You should not pass a negative integer or a string with leading
11842 @samp{-} as @command{expr}'s first argument, as it might be
11843 misinterpreted as an option; this can be avoided by parenthesization.
11844 Also, portable scripts should not use a string operand that happens to
11845 take the form of an integer; this can be worked around by inserting
11846 leading spaces as mentioned above.
11847
11848 @cindex parentheses for grouping
11849 Operators may be given as infix symbols or prefix keywords.  Parentheses
11850 may be used for grouping in the usual manner.  You must quote
11851 parentheses and many operators to avoid the shell evaluating them,
11852 however.
11853
11854 When built with support for the GNU MP library, @command{expr} uses
11855 arbitrary-precision arithmetic; otherwise, it uses native arithmetic
11856 types and may fail due to arithmetic overflow.
11857
11858 The only options are @option{--help} and @option{--version}.  @xref{Common
11859 options}.  Options must precede operands.
11860
11861 @cindex exit status of @command{expr}
11862 Exit status:
11863
11864 @display
11865 0 if the expression is neither null nor 0,
11866 1 if the expression is null or 0,
11867 2 if the expression is invalid,
11868 3 if an internal error occurred (e.g., arithmetic overflow).
11869 @end display
11870
11871 @menu
11872 * String expressions::          + : match substr index length
11873 * Numeric expressions::         + - * / %
11874 * Relations for expr::          | & < <= = == != >= >
11875 * Examples of expr::            Examples.
11876 @end menu
11877
11878
11879 @node String expressions
11880 @subsection String expressions
11881
11882 @cindex string expressions
11883 @cindex expressions, string
11884
11885 @command{expr} supports pattern matching and other string operators.  These
11886 have higher precedence than both the numeric and relational operators (in
11887 the next sections).
11888
11889 @table @samp
11890
11891 @item @var{string} : @var{regex}
11892 @cindex pattern matching
11893 @cindex regular expression matching
11894 @cindex matching patterns
11895 Perform pattern matching.  The arguments are converted to strings and the
11896 second is considered to be a (basic, a la GNU @code{grep}) regular
11897 expression, with a @code{^} implicitly prepended.  The first argument is
11898 then matched against this regular expression.
11899
11900 If the match succeeds and @var{regex} uses @samp{\(} and @samp{\)}, the
11901 @code{:} expression returns the part of @var{string} that matched the
11902 subexpression; otherwise, it returns the number of characters matched.
11903
11904 If the match fails, the @code{:} operator returns the null string if
11905 @samp{\(} and @samp{\)} are used in @var{regex}, otherwise 0.
11906
11907 @kindex \( @r{regexp operator}
11908 Only the first @samp{\( @dots{} \)} pair is relevant to the return
11909 value; additional pairs are meaningful only for grouping the regular
11910 expression operators.
11911
11912 @kindex \+ @r{regexp operator}
11913 @kindex \? @r{regexp operator}
11914 @kindex \| @r{regexp operator}
11915 In the regular expression, @code{\+}, @code{\?}, and @code{\|} are
11916 operators which respectively match one or more, zero or one, or separate
11917 alternatives.  SunOS and other @command{expr}'s treat these as regular
11918 characters.  (@acronym{POSIX} allows either behavior.)
11919 @xref{Top, , Regular Expression Library, regex, Regex}, for details of
11920 regular expression syntax.  Some examples are in @ref{Examples of expr}.
11921
11922 @item match @var{string} @var{regex}
11923 @findex match
11924 An alternative way to do pattern matching.  This is the same as
11925 @w{@samp{@var{string} : @var{regex}}}.
11926
11927 @item substr @var{string} @var{position} @var{length}
11928 @findex substr
11929 Returns the substring of @var{string} beginning at @var{position}
11930 with length at most @var{length}.  If either @var{position} or
11931 @var{length} is negative, zero, or non-numeric, returns the null string.
11932
11933 @item index @var{string} @var{charset}
11934 @findex index
11935 Returns the first position in @var{string} where the first character in
11936 @var{charset} was found.  If no character in @var{charset} is found in
11937 @var{string}, return 0.
11938
11939 @item length @var{string}
11940 @findex length
11941 Returns the length of @var{string}.
11942
11943 @item + @var{token}
11944 @kindex +
11945 Interpret @var{token} as a string, even if it is a keyword like @var{match}
11946 or an operator like @code{/}.
11947 This makes it possible to test @code{expr length + "$x"} or
11948 @code{expr + "$x" : '.*/\(.\)'} and have it do the right thing even if
11949 the value of @var{$x} happens to be (for example) @code{/} or @code{index}.
11950 This operator is a @acronym{GNU} extension.  Portable shell scripts should use
11951 @code{@w{" $token"} : @w{' \(.*\)'}} instead of @code{+ "$token"}.
11952
11953 @end table
11954
11955 To make @command{expr} interpret keywords as strings, you must use the
11956 @code{quote} operator.
11957
11958
11959 @node Numeric expressions
11960 @subsection Numeric expressions
11961
11962 @cindex numeric expressions
11963 @cindex expressions, numeric
11964
11965 @command{expr} supports the usual numeric operators, in order of increasing
11966 precedence.  These numeric operators have lower precedence than the
11967 string operators described in the previous section, and higher precedence
11968 than the connectives (next section).
11969
11970 @table @samp
11971
11972 @item + -
11973 @kindex +
11974 @kindex -
11975 @cindex addition
11976 @cindex subtraction
11977 Addition and subtraction.  Both arguments are converted to integers;
11978 an error occurs if this cannot be done.
11979
11980 @item * / %
11981 @kindex *
11982 @kindex /
11983 @kindex %
11984 @cindex multiplication
11985 @cindex division
11986 @cindex remainder
11987 Multiplication, division, remainder.  Both arguments are converted to
11988 integers; an error occurs if this cannot be done.
11989
11990 @end table
11991
11992
11993 @node Relations for expr
11994 @subsection Relations for @command{expr}
11995
11996 @cindex connectives, logical
11997 @cindex logical connectives
11998 @cindex relations, numeric or string
11999
12000 @command{expr} supports the usual logical connectives and relations.  These
12001 have lower precedence than the string and numeric operators
12002 (previous sections).  Here is the list, lowest-precedence operator first.
12003
12004 @table @samp
12005
12006 @item |
12007 @kindex |
12008 @cindex logical or operator
12009 @cindex or operator
12010 Returns its first argument if that is neither null nor zero, otherwise
12011 its second argument if it is neither null nor zero, otherwise 0.  It
12012 does not evaluate its second argument if its first argument is neither
12013 null nor zero.
12014
12015 @item &
12016 @kindex &
12017 @cindex logical and operator
12018 @cindex and operator
12019 Return its first argument if neither argument is null or zero, otherwise
12020 0.  It does not evaluate its second argument if its first argument is
12021 null or zero.
12022
12023 @item < <= = == != >= >
12024 @kindex <
12025 @kindex <=
12026 @kindex =
12027 @kindex ==
12028 @kindex >
12029 @kindex >=
12030 @cindex comparison operators
12031 @vindex LC_COLLATE
12032 Compare the arguments and return 1 if the relation is true, 0 otherwise.
12033 @code{==} is a synonym for @code{=}.  @command{expr} first tries to convert
12034 both arguments to integers and do a numeric comparison; if either
12035 conversion fails, it does a lexicographic comparison using the character
12036 collating sequence specified by the @env{LC_COLLATE} locale.
12037
12038 @end table
12039
12040
12041 @node Examples of expr
12042 @subsection Examples of using @command{expr}
12043
12044 @cindex examples of @command{expr}
12045 Here are a few examples, including quoting for shell metacharacters.
12046
12047 To add 1 to the shell variable @code{foo}, in Bourne-compatible shells:
12048
12049 @example
12050 foo=`expr $foo + 1`
12051 @end example
12052
12053 To print the non-directory part of the file name stored in
12054 @code{$fname}, which need not contain a @code{/}:
12055
12056 @example
12057 expr $fname : '.*/\(.*\)' '|' $fname
12058 @end example
12059
12060 An example showing that @code{\+} is an operator:
12061
12062 @example
12063 expr aaa : 'a\+'
12064 @result{} 3
12065 @end example
12066
12067 @example
12068 expr abc : 'a\(.\)c'
12069 @result{} b
12070 expr index abcdef cz
12071 @result{} 3
12072 expr index index a
12073 @error{} expr: syntax error
12074 expr index + index a
12075 @result{} 0
12076 @end example
12077
12078
12079 @node Redirection
12080 @chapter Redirection
12081
12082 @cindex redirection
12083 @cindex commands for redirection
12084
12085 Unix shells commonly provide several forms of @dfn{redirection}---ways
12086 to change the input source or output destination of a command.  But one
12087 useful redirection is performed by a separate command, not by the shell;
12088 it's described here.
12089
12090 @menu
12091 * tee invocation::              Redirect output to multiple files or processes.
12092 @end menu
12093
12094
12095 @node tee invocation
12096 @section @command{tee}: Redirect output to multiple files or processes
12097
12098 @pindex tee
12099 @cindex pipe fitting
12100 @cindex destinations, multiple output
12101 @cindex read from stdin and write to stdout and files
12102
12103 The @command{tee} command copies standard input to standard output and also
12104 to any files given as arguments.  This is useful when you want not only
12105 to send some data down a pipe, but also to save a copy.  Synopsis:
12106
12107 @example
12108 tee [@var{option}]@dots{} [@var{file}]@dots{}
12109 @end example
12110
12111 If a file being written to does not already exist, it is created.  If a
12112 file being written to already exists, the data it previously contained
12113 is overwritten unless the @option{-a} option is used.
12114
12115 A @var{file} of @samp{-} causes @command{tee} to send another copy of
12116 input to standard output, but this is typically not that useful as the
12117 copies are interleaved.
12118
12119 The program accepts the following options.  Also see @ref{Common options}.
12120
12121 @table @samp
12122 @item -a
12123 @itemx --append
12124 @opindex -a
12125 @opindex --append
12126 Append standard input to the given files rather than overwriting
12127 them.
12128
12129 @item -i
12130 @itemx --ignore-interrupts
12131 @opindex -i
12132 @opindex --ignore-interrupts
12133 Ignore interrupt signals.
12134
12135 @end table
12136
12137 The @command{tee} command is useful when you happen to be transferring a large
12138 amount of data and also want to summarize that data without reading
12139 it a second time.  For example, when you are downloading a DVD image,
12140 you often want to verify its signature or checksum right away.
12141 The inefficient way to do it is simply:
12142
12143 @example
12144 wget http://example.com/some.iso && sha1sum some.iso
12145 @end example
12146
12147 One problem with the above is that it makes you wait for the
12148 download to complete before starting the time-consuming SHA1 computation.
12149 Perhaps even more importantly, the above requires reading
12150 the DVD image a second time (the first was from the network).
12151
12152 The efficient way to do it is to interleave the download
12153 and SHA1 computation.  Then, you'll get the checksum for
12154 free, because the entire process parallelizes so well:
12155
12156 @example
12157 # slightly contrived, to demonstrate process substitution
12158 wget -O - http://example.com/dvd.iso \
12159   | tee >(sha1sum > dvd.sha1) > dvd.iso
12160 @end example
12161
12162 That makes @command{tee} write not just to the expected output file,
12163 but also to a pipe running @command{sha1sum} and saving the final
12164 checksum in a file named @file{dvd.sha1}.
12165
12166 Note, however, that this example relies on a feature of modern shells
12167 called @dfn{process substitution}
12168 (the @samp{>(command)} syntax, above;
12169 @xref{Process Substitution,,Process Substitution, bashref,
12170 The Bash Reference Manual}.),
12171 so it works with @command{zsh}, @command{bash}, and @command{ksh},
12172 but not with @command{/bin/sh}.  So if you write code like this
12173 in a shell script, be sure to start the script with @samp{#!/bin/bash}.
12174
12175 Since the above example writes to one file and one process,
12176 a more conventional and portable use of @command{tee} is even better:
12177
12178 @example
12179 wget -O - http://example.com/dvd.iso \
12180   | tee dvd.iso | sha1sum > dvd.sha1
12181 @end example
12182
12183 You can extend this example to make @command{tee} write to two processes,
12184 computing MD5 and SHA1 checksums in parallel.  In this case,
12185 process substitution is required:
12186
12187 @example
12188 wget -O - http://example.com/dvd.iso \
12189   | tee >(sha1sum > dvd.sha1) \
12190         >(md5sum > dvd.md5) \
12191   > dvd.iso
12192 @end example
12193
12194 This technique is also useful when you want to make a @emph{compressed}
12195 copy of the contents of a pipe.
12196 Consider a tool to graphically summarize disk usage data from @samp{du -ak}.
12197 For a large hierarchy, @samp{du -ak} can run for a long time,
12198 and can easily produce terabytes of data, so you won't want to
12199 rerun the command unnecessarily.  Nor will you want to save
12200 the uncompressed output.
12201
12202 Doing it the inefficient way, you can't even start the GUI
12203 until after you've compressed all of the @command{du} output:
12204
12205 @example
12206 du -ak | gzip -9 > /tmp/du.gz
12207 gzip -d /tmp/du.gz | xdiskusage -a
12208 @end example
12209
12210 With @command{tee} and process substitution, you start the GUI
12211 right away and eliminate the decompression completely:
12212
12213 @example
12214 du -ak | tee >(gzip -9 > /tmp/du.gz) | xdiskusage -a
12215 @end example
12216
12217 Finally, if you regularly create more than one type of
12218 compressed tarball at once, for example when @code{make dist} creates
12219 both @command{gzip}-compressed and @command{bzip2}-compressed tarballs,
12220 there may be a better way.
12221 Typical @command{automake}-generated @file{Makefile} rules create
12222 the two compressed tar archives with commands in sequence, like this
12223 (slightly simplified):
12224
12225 @example
12226 tardir=your-pkg-M.N
12227 tar chof - "$tardir" | gzip  -9 -c > your-pkg-M.N.tar.gz
12228 tar chof - "$tardir" | bzip2 -9 -c > your-pkg-M.N.tar.bz2
12229 @end example
12230
12231 However, if the hierarchy you are archiving and compressing is larger
12232 than a couple megabytes, and especially if you are using a multi-processor
12233 system with plenty of memory, then you can do much better by reading the
12234 directory contents only once and running the compression programs in parallel:
12235
12236 @example
12237 tardir=your-pkg-M.N
12238 tar chof - "$tardir" \
12239   | tee >(gzip -9 -c > your-pkg-M.N.tar.gz) \
12240   | bzip2 -9 -c > your-pkg-M.N.tar.bz2
12241 @end example
12242
12243 @exitstatus
12244
12245
12246 @node File name manipulation
12247 @chapter File name manipulation
12248
12249 @cindex file name manipulation
12250 @cindex manipulation of file names
12251 @cindex commands for file name manipulation
12252
12253 This section describes commands that manipulate file names.
12254
12255 @menu
12256 * basename invocation::         Strip directory and suffix from a file name.
12257 * dirname invocation::          Strip last file name component.
12258 * pathchk invocation::          Check file name validity and portability.
12259 * mktemp invocation::           Create temporary file or directory.
12260 @end menu
12261
12262
12263 @node basename invocation
12264 @section @command{basename}: Strip directory and suffix from a file name
12265
12266 @pindex basename
12267 @cindex strip directory and suffix from file names
12268 @cindex directory, stripping from file names
12269 @cindex suffix, stripping from file names
12270 @cindex file names, stripping directory and suffix
12271 @cindex leading directory components, stripping
12272
12273 @command{basename} removes any leading directory components from
12274 @var{name}.  Synopsis:
12275
12276 @example
12277 basename @var{name} [@var{suffix}]
12278 @end example
12279
12280 If @var{suffix} is specified and is identical to the end of @var{name},
12281 it is removed from @var{name} as well.  Note that since trailing slashes
12282 are removed prior to suffix matching, @var{suffix} will do nothing if it
12283 contains slashes.  @command{basename} prints the result on standard
12284 output.
12285
12286 @c This test is used both here and in the section on dirname.
12287 @macro basenameAndDirname
12288 Together, @command{basename} and @command{dirname} are designed such
12289 that if @samp{ls "$name"} succeeds, then the command sequence @samp{cd
12290 "$(dirname "$name")"; ls "$(basename "$name")"} will, too.  This works
12291 for everything except file names containing a trailing newline.
12292 @end macro
12293 @basenameAndDirname
12294
12295 @acronym{POSIX} allows the implementation to define the results if
12296 @var{name} is empty or @samp{//}.  In the former case, @acronym{GNU}
12297 @command{basename} returns the empty string.  In the latter case, the
12298 result is @samp{//} on platforms where @var{//} is distinct from
12299 @var{/}, and @samp{/} on platforms where there is no difference.
12300
12301 The only options are @option{--help} and @option{--version}.  @xref{Common
12302 options}.  Options must precede operands.
12303
12304 @exitstatus
12305
12306 Examples:
12307
12308 @smallexample
12309 # Output "sort".
12310 basename /usr/bin/sort
12311
12312 # Output "stdio".
12313 basename include/stdio.h .h
12314 @end smallexample
12315
12316
12317 @node dirname invocation
12318 @section @command{dirname}: Strip last file name component
12319
12320 @pindex dirname
12321 @cindex directory components, printing
12322 @cindex stripping non-directory suffix
12323 @cindex non-directory suffix, stripping
12324
12325 @command{dirname} prints all but the final slash-delimited component of
12326 @var{name}.  Slashes on either side of the final component are also
12327 removed.  If the string contains no slash, @command{dirname} prints
12328 @samp{.} (meaning the current directory).  Synopsis:
12329
12330 @example
12331 dirname @var{name}
12332 @end example
12333
12334 @var{name} need not be a file name, but if it is, this operation
12335 effectively lists the directory that contains the final component,
12336 including the case when the final component is itself a directory.
12337
12338 @basenameAndDirname
12339
12340 @acronym{POSIX} allows the implementation to define the results if
12341 @var{name} is @samp{//}.  With @acronym{GNU} @command{dirname}, the
12342 result is @samp{//} on platforms where @var{//} is distinct from
12343 @var{/}, and @samp{/} on platforms where there is no difference.
12344
12345 The only options are @option{--help} and @option{--version}.  @xref{Common
12346 options}.
12347
12348 @exitstatus
12349
12350 Examples:
12351
12352 @smallexample
12353 # Output "/usr/bin".
12354 dirname /usr/bin/sort
12355 dirname /usr/bin//.//
12356
12357 # Output ".".
12358 dirname stdio.h
12359 @end smallexample
12360
12361
12362 @node pathchk invocation
12363 @section @command{pathchk}: Check file name validity and portability
12364
12365 @pindex pathchk
12366 @cindex file names, checking validity and portability
12367 @cindex valid file names, checking for
12368 @cindex portable file names, checking for
12369
12370 @command{pathchk} checks validity and portability of file names.  Synopsis:
12371
12372 @example
12373 pathchk [@var{option}]@dots{} @var{name}@dots{}
12374 @end example
12375
12376 For each @var{name}, @command{pathchk} prints an error message if any of
12377 these conditions is true:
12378
12379 @enumerate
12380 @item
12381 One of the existing directories in @var{name} does not have search
12382 (execute) permission,
12383 @item
12384 The length of @var{name} is larger than the maximum supported by the
12385 operating system.
12386 @item
12387 The length of one component of @var{name} is longer than
12388 its file system's maximum.
12389 @end enumerate
12390
12391 A nonexistent @var{name} is not an error, so long a file with that
12392 name could be created under the above conditions.
12393
12394 The program accepts the following options.  Also see @ref{Common options}.
12395 Options must precede operands.
12396
12397 @table @samp
12398
12399 @item -p
12400 @opindex -p
12401 Instead of performing checks based on the underlying file system,
12402 print an error message if any of these conditions is true:
12403
12404 @enumerate
12405 @item
12406 A file name is empty.
12407
12408 @item
12409 A file name contains a character outside the @acronym{POSIX} portable file
12410 name character set, namely, the ASCII letters and digits, @samp{.},
12411 @samp{_}, @samp{-}, and @samp{/}.
12412
12413 @item
12414 The length of a file name or one of its components exceeds the
12415 @acronym{POSIX} minimum limits for portability.
12416 @end enumerate
12417
12418 @item -P
12419 @opindex -P
12420 Print an error message if a file name is empty, or if it contains a component
12421 that begins with @samp{-}.
12422
12423 @item --portability
12424 @opindex --portability
12425 Print an error message if a file name is not portable to all @acronym{POSIX}
12426 hosts.  This option is equivalent to @samp{-p -P}.
12427
12428 @end table
12429
12430 @cindex exit status of @command{pathchk}
12431 Exit status:
12432
12433 @display
12434 0 if all specified file names passed all checks,
12435 1 otherwise.
12436 @end display
12437
12438 @node mktemp invocation
12439 @section @command{mktemp}: Create temporary file or directory
12440
12441 @pindex mktemp
12442 @cindex file names, creating temporary
12443 @cindex directory, creating temporary
12444 @cindex temporary files and directories
12445
12446 @command{mktemp} manages the creation of temporary files and
12447 directories.  Synopsis:
12448
12449 @example
12450 mktemp [@var{option}]@dots{} [@var{template}]
12451 @end example
12452
12453 Safely create a temporary file or directory based on @var{template},
12454 and print its name.  If given, @var{template} must include at least
12455 three consecutive @samp{X}s in the last component.  If omitted, the template
12456 @samp{tmp.XXXXXXXXXX} is used, and option @option{--tmpdir} is
12457 implied.  The final run of @samp{X}s in the @var{template} will be replaced
12458 by alpha-numeric characters; thus, on a case-sensitive file system,
12459 and with a @var{template} including a run of @var{n} instances of @samp{X},
12460 there are @samp{62**@var{n}} potential file names.
12461
12462 Older scripts used to create temporary files by simply joining the
12463 name of the program with the process id (@samp{$$}) as a suffix.
12464 However, that naming scheme is easily predictable, and suffers from a
12465 race condition where the attacker can create an appropriately named
12466 symbolic link, such that when the script then opens a handle to what
12467 it thought was an unused file, it is instead modifying an existing
12468 file.  Using the same scheme to create a directory is slightly safer,
12469 since the @command{mkdir} will fail if the target already exists, but
12470 it is still inferior because it allows for denial of service attacks.
12471 Therefore, modern scripts should use the @command{mktemp} command to
12472 guarantee that the generated name will be unpredictable, and that
12473 knowledge of the temporary file name implies that the file was created
12474 by the current script and cannot be modified by other users.
12475
12476 When creating a file, the resulting file has read and write
12477 permissions for the current user, but no permissions for the group or
12478 others; these permissions are reduced if the current umask is more
12479 restrictive.
12480
12481 Here are some examples (although note that if you repeat them, you
12482 will most likely get different file names):
12483
12484 @itemize @bullet
12485
12486 @item
12487 Create a temporary file in the current directory.
12488 @example
12489 $ mktemp file.XXXX
12490 file.H47c
12491 @end example
12492
12493 @item
12494 Create a temporary file with a known suffix.
12495 @example
12496 $ mktemp --suffix=.txt file-XXXX
12497 file-H08W.txt
12498 $ mktemp file-XXXX-XXXX.txt
12499 file-XXXX-eI9L.txt
12500 @end example
12501
12502 @item
12503 Create a secure fifo relative to the user's choice of @env{TMPDIR},
12504 but falling back to the current directory rather than @file{/tmp}.
12505 Note that @command{mktemp} does not create fifos, but can create a
12506 secure directory in which the fifo can live.  Exit the shell if the
12507 directory or fifo could not be created.
12508 @example
12509 $ dir=$(mktemp -p "$@{TMPDIR:-.@}" -d dir-XXXX) || exit 1
12510 $ fifo=$dir/fifo
12511 $ mkfifo "$fifo" || @{ rmdir "$dir"; exit 1; @}
12512 @end example
12513
12514 @item
12515 Create and use a temporary file if possible, but ignore failure.  The
12516 file will reside in the directory named by @env{TMPDIR}, if specified,
12517 or else in @file{/tmp}.
12518 @example
12519 $ file=$(mktemp -q) && @{
12520 >   # Safe to use $file only within this block.  Use quotes,
12521 >   # since $TMPDIR, and thus $file, may contain whitespace.
12522 >   echo ... > "$file"
12523 >   rm "$file"
12524 > @}
12525 @end example
12526
12527 @item
12528 Act as a semi-random character generator (it is not fully random,
12529 since it is impacted by the contents of the current directory).  To
12530 avoid security holes, do not use the resulting names to create a file.
12531 @example
12532 $ mktemp -u XXX
12533 Gb9
12534 $ mktemp -u XXX
12535 nzC
12536 @end example
12537
12538 @end itemize
12539
12540 The program accepts the following options.  Also see @ref{Common options}.
12541
12542 @table @samp
12543
12544 @item -d
12545 @itemx --directory
12546 @opindex -d
12547 @opindex --directory
12548 Create a directory rather than a file.  The directory will have read,
12549 write, and search permissions for the current user, but no permissions
12550 for the group or others; these permissions are reduced if the current
12551 umask is more restrictive.
12552
12553 @item -q
12554 @itemx --quiet
12555 @opindex -q
12556 @opindex --quiet
12557 Suppress diagnostics about failure to create a file or directory.  The
12558 exit status will still reflect whether a file was created.
12559
12560 @item -u
12561 @itemx --dry-run
12562 @opindex -u
12563 @opindex --dry-run
12564 Generate a temporary name that does not name an existing file, without
12565 changing the file system contents.  Using the output of this command
12566 to create a new file is inherently unsafe, as there is a window of
12567 time between generating the name and using it where another process
12568 can create an object by the same name.
12569
12570 @item -p @var{dir}
12571 @itemx --tmpdir[=@var{dir}]
12572 @opindex -p
12573 @opindex --tmpdir
12574 Treat @var{template} relative to the directory @var{dir}.  If
12575 @var{dir} is not specified (only possible with the long option
12576 @option{--tmpdir}) or is the empty string, use the value of
12577 @env{TMPDIR} if available, otherwise use @samp{/tmp}.  If this is
12578 specified, @var{template} must not be absolute.  However,
12579 @var{template} can still contain slashes, although intermediate
12580 directories must already exist.
12581
12582 @item --suffix=@var{suffix}
12583 @opindex --suffix
12584 Append @var{suffix} to the @var{template}.  @var{suffix} must not
12585 contain slash.  If @option{--suffix} is specified, @var{template} must
12586 end in @samp{X}; if it is not specified, then an appropriate
12587 @option{--suffix} is inferred by finding the last @samp{X} in
12588 @var{template}.  This option exists for use with the default
12589 @var{template} and for the creation of a @var{suffix} that starts with
12590 @samp{X}.
12591
12592 @item -t
12593 @opindex -t
12594 Treat @var{template} as a single file relative to the value of
12595 @env{TMPDIR} if available, or to the directory specified by
12596 @option{-p}, otherwise to @samp{/tmp}.  @var{template} must not
12597 contain slashes.  This option is deprecated; the use of @option{-p}
12598 without @option{-t} offers better defaults (by favoring the command
12599 line over @env{TMPDIR}) and more flexibility (by allowing intermediate
12600 directories).
12601
12602 @end table
12603
12604 @cindex exit status of @command{mktemp}
12605 Exit status:
12606
12607 @display
12608 0 if the file was created,
12609 1 otherwise.
12610 @end display
12611
12612
12613 @node Working context
12614 @chapter Working context
12615
12616 @cindex working context
12617 @cindex commands for printing the working context
12618
12619 This section describes commands that display or alter the context in
12620 which you are working: the current directory, the terminal settings, and
12621 so forth.  See also the user-related commands in the next section.
12622
12623 @menu
12624 * pwd invocation::              Print working directory.
12625 * stty invocation::             Print or change terminal characteristics.
12626 * printenv invocation::         Print environment variables.
12627 * tty invocation::              Print file name of terminal on standard input.
12628 @end menu
12629
12630
12631 @node pwd invocation
12632 @section @command{pwd}: Print working directory
12633
12634 @pindex pwd
12635 @cindex print name of current directory
12636 @cindex current working directory, printing
12637 @cindex working directory, printing
12638
12639
12640 @command{pwd} prints the name of the current directory.  Synopsis:
12641
12642 @example
12643 pwd [@var{option}]@dots{}
12644 @end example
12645
12646 The program accepts the following options.  Also see @ref{Common options}.
12647
12648 @table @samp
12649 @item -L
12650 @itemx --logical
12651 @opindex -L
12652 @opindex --logical
12653 If the contents of the environment variable @env{PWD} provide an
12654 absolute name of the current directory with no @samp{.} or @samp{..}
12655 components, but possibly with symbolic links, then output those
12656 contents.  Otherwise, fall back to default @option{-P} handling.
12657
12658 @item -P
12659 @itemx --physical
12660 @opindex -P
12661 @opindex --physical
12662 Print a fully resolved name for the current directory.  That is, all
12663 components of the printed name will be actual directory names---none
12664 will be symbolic links.
12665 @end table
12666
12667 @cindex symbolic links and @command{pwd}
12668 If @option{-L} and @option{-P} are both given, the last one takes
12669 precedence.  If neither option is given, then this implementation uses
12670 @option{-P} as the default unless the @env{POSIXLY_CORRECT}
12671 environment variable is set.
12672
12673 @mayConflictWithShellBuiltIn{pwd}
12674
12675 @exitstatus
12676
12677
12678 @node stty invocation
12679 @section @command{stty}: Print or change terminal characteristics
12680
12681 @pindex stty
12682 @cindex change or print terminal settings
12683 @cindex terminal settings
12684 @cindex line settings of terminal
12685
12686 @command{stty} prints or changes terminal characteristics, such as baud rate.
12687 Synopses:
12688
12689 @example
12690 stty [@var{option}] [@var{setting}]@dots{}
12691 stty [@var{option}]
12692 @end example
12693
12694 If given no line settings, @command{stty} prints the baud rate, line
12695 discipline number (on systems that support it), and line settings
12696 that have been changed from the values set by @samp{stty sane}.
12697 By default, mode reading and setting are performed on the tty line
12698 connected to standard input, although this can be modified by the
12699 @option{--file} option.
12700
12701 @command{stty} accepts many non-option arguments that change aspects of
12702 the terminal line operation, as described below.
12703
12704 The program accepts the following options.  Also see @ref{Common options}.
12705
12706 @table @samp
12707 @item -a
12708 @itemx --all
12709 @opindex -a
12710 @opindex --all
12711 Print all current settings in human-readable form.  This option may not
12712 be used in combination with any line settings.
12713
12714 @item -F @var{device}
12715 @itemx --file=@var{device}
12716 @opindex -F
12717 @opindex --file
12718 Set the line opened by the file name specified in @var{device} instead of
12719 the tty line connected to standard input.  This option is necessary
12720 because opening a @acronym{POSIX} tty requires use of the
12721 @code{O_NONDELAY} flag to prevent a @acronym{POSIX} tty from blocking
12722 until the carrier detect line is high if
12723 the @code{clocal} flag is not set.  Hence, it is not always possible
12724 to allow the shell to open the device in the traditional manner.
12725
12726 @item -g
12727 @itemx --save
12728 @opindex -g
12729 @opindex --save
12730 @cindex machine-readable @command{stty} output
12731 Print all current settings in a form that can be used as an argument to
12732 another @command{stty} command to restore the current settings.  This option
12733 may not be used in combination with any line settings.
12734
12735 @end table
12736
12737 Many settings can be turned off by preceding them with a @samp{-}.
12738 Such arguments are marked below with ``May be negated'' in their
12739 description.  The descriptions themselves refer to the positive
12740 case, that is, when @emph{not} negated (unless stated otherwise,
12741 of course).
12742
12743 Some settings are not available on all @acronym{POSIX} systems, since they use
12744 extensions.  Such arguments are marked below with
12745 ``Non-@acronym{POSIX}'' in their description.  On non-@acronym{POSIX}
12746 systems, those or other settings also may not
12747 be available, but it's not feasible to document all the variations: just
12748 try it and see.
12749
12750 @exitstatus
12751
12752 @menu
12753 * Control::                     Control settings
12754 * Input::                       Input settings
12755 * Output::                      Output settings
12756 * Local::                       Local settings
12757 * Combination::                 Combination settings
12758 * Characters::                  Special characters
12759 * Special::                     Special settings
12760 @end menu
12761
12762
12763 @node Control
12764 @subsection Control settings
12765
12766 @cindex control settings
12767 Control settings:
12768
12769 @table @samp
12770 @item parenb
12771 @opindex parenb
12772 @cindex two-way parity
12773 Generate parity bit in output and expect parity bit in input.
12774 May be negated.
12775
12776 @item parodd
12777 @opindex parodd
12778 @cindex odd parity
12779 @cindex even parity
12780 Set odd parity (even if negated).  May be negated.
12781
12782 @item cs5
12783 @itemx cs6
12784 @itemx cs7
12785 @itemx cs8
12786 @opindex cs@var{n}
12787 @cindex character size
12788 @cindex eight-bit characters
12789 Set character size to 5, 6, 7, or 8 bits.
12790
12791 @item hup
12792 @itemx hupcl
12793 @opindex hup[cl]
12794 Send a hangup signal when the last process closes the tty.  May be
12795 negated.
12796
12797 @item cstopb
12798 @opindex cstopb
12799 @cindex stop bits
12800 Use two stop bits per character (one if negated).  May be negated.
12801
12802 @item cread
12803 @opindex cread
12804 Allow input to be received.  May be negated.
12805
12806 @item clocal
12807 @opindex clocal
12808 @cindex modem control
12809 Disable modem control signals.  May be negated.
12810
12811 @item crtscts
12812 @opindex crtscts
12813 @cindex hardware flow control
12814 @cindex flow control, hardware
12815 @cindex RTS/CTS flow control
12816 Enable RTS/CTS flow control.  Non-@acronym{POSIX}.  May be negated.
12817 @end table
12818
12819
12820 @node Input
12821 @subsection Input settings
12822
12823 @cindex input settings
12824 These settings control operations on data received from the terminal.
12825
12826 @table @samp
12827 @item ignbrk
12828 @opindex ignbrk
12829 @cindex breaks, ignoring
12830 Ignore break characters.  May be negated.
12831
12832 @item brkint
12833 @opindex brkint
12834 @cindex breaks, cause interrupts
12835 Make breaks cause an interrupt signal.  May be negated.
12836
12837 @item ignpar
12838 @opindex ignpar
12839 @cindex parity, ignoring
12840 Ignore characters with parity errors.  May be negated.
12841
12842 @item parmrk
12843 @opindex parmrk
12844 @cindex parity errors, marking
12845 Mark parity errors (with a 255-0-character sequence).  May be negated.
12846
12847 @item inpck
12848 @opindex inpck
12849 Enable input parity checking.  May be negated.
12850
12851 @item istrip
12852 @opindex istrip
12853 @cindex eight-bit input
12854 Clear high (8th) bit of input characters.  May be negated.
12855
12856 @item inlcr
12857 @opindex inlcr
12858 @cindex newline, translating to return
12859 Translate newline to carriage return.  May be negated.
12860
12861 @item igncr
12862 @opindex igncr
12863 @cindex return, ignoring
12864 Ignore carriage return.  May be negated.
12865
12866 @item icrnl
12867 @opindex icrnl
12868 @cindex return, translating to newline
12869 Translate carriage return to newline.  May be negated.
12870
12871 @item iutf8
12872 @opindex iutf8
12873 @cindex input encoding, UTF-8
12874 Assume input characters are UTF-8 encoded.  May be negated.
12875
12876 @item ixon
12877 @opindex ixon
12878 @kindex C-s/C-q flow control
12879 @cindex XON/XOFF flow control
12880 Enable XON/XOFF flow control (that is, @kbd{CTRL-S}/@kbd{CTRL-Q}).  May
12881 be negated.
12882
12883 @item ixoff
12884 @itemx tandem
12885 @opindex ixoff
12886 @opindex tandem
12887 @cindex software flow control
12888 @cindex flow control, software
12889 Enable sending of @code{stop} character when the system input buffer
12890 is almost full, and @code{start} character when it becomes almost
12891 empty again.  May be negated.
12892
12893 @item iuclc
12894 @opindex iuclc
12895 @cindex uppercase, translating to lowercase
12896 Translate uppercase characters to lowercase.  Non-@acronym{POSIX}.  May be
12897 negated. Note ilcuc is not implemented, as one would not be able to issue
12898 almost any (lowercase) Unix command, after invoking it.
12899
12900 @item ixany
12901 @opindex ixany
12902 Allow any character to restart output (only the start character
12903 if negated).  Non-@acronym{POSIX}.  May be negated.
12904
12905 @item imaxbel
12906 @opindex imaxbel
12907 @cindex beeping at input buffer full
12908 Enable beeping and not flushing input buffer if a character arrives
12909 when the input buffer is full.  Non-@acronym{POSIX}.  May be negated.
12910 @end table
12911
12912
12913 @node Output
12914 @subsection Output settings
12915
12916 @cindex output settings
12917 These settings control operations on data sent to the terminal.
12918
12919 @table @samp
12920 @item opost
12921 @opindex opost
12922 Postprocess output.  May be negated.
12923
12924 @item olcuc
12925 @opindex olcuc
12926 @cindex lowercase, translating to output
12927 Translate lowercase characters to uppercase.  Non-@acronym{POSIX}.  May be
12928 negated. (Note ouclc is not currently implemented.)
12929
12930 @item ocrnl
12931 @opindex ocrnl
12932 @cindex return, translating to newline
12933 Translate carriage return to newline.  Non-@acronym{POSIX}.  May be negated.
12934
12935 @item onlcr
12936 @opindex onlcr
12937 @cindex newline, translating to crlf
12938 Translate newline to carriage return-newline.  Non-@acronym{POSIX}.  May be
12939 negated.
12940
12941 @item onocr
12942 @opindex onocr
12943 Do not print carriage returns in the first column.  Non-@acronym{POSIX}.
12944 May be negated.
12945
12946 @item onlret
12947 @opindex onlret
12948 Newline performs a carriage return.  Non-@acronym{POSIX}.  May be negated.
12949
12950 @item ofill
12951 @opindex ofill
12952 @cindex pad instead of timing for delaying
12953 Use fill (padding) characters instead of timing for delays.
12954 Non-@acronym{POSIX}.
12955 May be negated.
12956
12957 @item ofdel
12958 @opindex ofdel
12959 @cindex pad character
12960 Use @acronym{ASCII} @sc{del} characters for fill instead of
12961 @acronym{ASCII} @sc{nul} characters.  Non-@acronym{POSIX}.
12962 May be negated.
12963
12964 @item nl1
12965 @itemx nl0
12966 @opindex nl@var{n}
12967 Newline delay style.  Non-@acronym{POSIX}.
12968
12969 @item cr3
12970 @itemx cr2
12971 @itemx cr1
12972 @itemx cr0
12973 @opindex cr@var{n}
12974 Carriage return delay style.  Non-@acronym{POSIX}.
12975
12976 @item tab3
12977 @itemx tab2
12978 @itemx tab1
12979 @itemx tab0
12980 @opindex tab@var{n}
12981 Horizontal tab delay style.  Non-@acronym{POSIX}.
12982
12983 @item bs1
12984 @itemx bs0
12985 @opindex bs@var{n}
12986 Backspace delay style.  Non-@acronym{POSIX}.
12987
12988 @item vt1
12989 @itemx vt0
12990 @opindex vt@var{n}
12991 Vertical tab delay style.  Non-@acronym{POSIX}.
12992
12993 @item ff1
12994 @itemx ff0
12995 @opindex ff@var{n}
12996 Form feed delay style.  Non-@acronym{POSIX}.
12997 @end table
12998
12999
13000 @node Local
13001 @subsection Local settings
13002
13003 @cindex local settings
13004
13005 @table @samp
13006 @item isig
13007 @opindex isig
13008 Enable @code{interrupt}, @code{quit}, and @code{suspend} special
13009 characters.  May be negated.
13010
13011 @item icanon
13012 @opindex icanon
13013 Enable @code{erase}, @code{kill}, @code{werase}, and @code{rprnt}
13014 special characters.  May be negated.
13015
13016 @item iexten
13017 @opindex iexten
13018 Enable non-@acronym{POSIX} special characters.  May be negated.
13019
13020 @item echo
13021 @opindex echo
13022 Echo input characters.  May be negated.
13023
13024 @item echoe
13025 @itemx crterase
13026 @opindex echoe
13027 @opindex crterase
13028 Echo @code{erase} characters as backspace-space-backspace.  May be
13029 negated.
13030
13031 @item echok
13032 @opindex echok
13033 @cindex newline echoing after @code{kill}
13034 Echo a newline after a @code{kill} character.  May be negated.
13035
13036 @item echonl
13037 @opindex echonl
13038 @cindex newline, echoing
13039 Echo newline even if not echoing other characters.  May be negated.
13040
13041 @item noflsh
13042 @opindex noflsh
13043 @cindex flushing, disabling
13044 Disable flushing after @code{interrupt} and @code{quit} special
13045 characters.  May be negated.
13046
13047 @item xcase
13048 @opindex xcase
13049 @cindex case translation
13050 Enable input and output of uppercase characters by preceding their
13051 lowercase equivalents with @samp{\}, when @code{icanon} is set.
13052 Non-@acronym{POSIX}.  May be negated.
13053
13054 @item tostop
13055 @opindex tostop
13056 @cindex background jobs, stopping at terminal write
13057 Stop background jobs that try to write to the terminal.  Non-@acronym{POSIX}.
13058 May be negated.
13059
13060 @item echoprt
13061 @itemx prterase
13062 @opindex echoprt
13063 @opindex prterase
13064 Echo erased characters backward, between @samp{\} and @samp{/}.
13065 Non-@acronym{POSIX}.  May be negated.
13066
13067 @item echoctl
13068 @itemx ctlecho
13069 @opindex echoctl
13070 @opindex ctlecho
13071 @cindex control characters, using @samp{^@var{c}}
13072 @cindex hat notation for control characters
13073 Echo control characters in hat notation (@samp{^@var{c}}) instead
13074 of literally.  Non-@acronym{POSIX}.  May be negated.
13075
13076 @item echoke
13077 @itemx crtkill
13078 @opindex echoke
13079 @opindex crtkill
13080 Echo the @code{kill} special character by erasing each character on
13081 the line as indicated by the @code{echoprt} and @code{echoe} settings,
13082 instead of by the @code{echoctl} and @code{echok} settings.
13083 Non-@acronym{POSIX}.
13084 May be negated.
13085 @end table
13086
13087
13088 @node Combination
13089 @subsection Combination settings
13090
13091 @cindex combination settings
13092 Combination settings:
13093
13094 @table @samp
13095 @item evenp
13096 @opindex evenp
13097 @itemx parity
13098 @opindex parity
13099 Same as @code{parenb -parodd cs7}.  May be negated.  If negated, same
13100 as @code{-parenb cs8}.
13101
13102 @item oddp
13103 @opindex oddp
13104 Same as @code{parenb parodd cs7}.  May be negated.  If negated, same
13105 as @code{-parenb cs8}.
13106
13107 @item nl
13108 @opindex nl
13109 Same as @code{-icrnl -onlcr}.  May be negated.  If negated, same as
13110 @code{icrnl -inlcr -igncr onlcr -ocrnl -onlret}.
13111
13112 @item ek
13113 @opindex ek
13114 Reset the @code{erase} and @code{kill} special characters to their default
13115 values.
13116
13117 @item sane
13118 @opindex sane
13119 Same as:
13120
13121 @c This is too long to write inline.
13122 @example
13123 cread -ignbrk brkint -inlcr -igncr icrnl -ixoff
13124 -iuclc -ixany imaxbel opost -olcuc -ocrnl onlcr
13125 -onocr -onlret -ofill -ofdel nl0 cr0 tab0 bs0 vt0
13126 ff0 isig icanon iexten echo echoe echok -echonl
13127 -noflsh -xcase -tostop -echoprt echoctl echoke
13128 @end example
13129
13130 @noindent
13131 and also sets all special characters to their default values.
13132
13133 @item cooked
13134 @opindex cooked
13135 Same as @code{brkint ignpar istrip icrnl ixon opost isig icanon}, plus
13136 sets the @code{eof} and @code{eol} characters to their default values
13137 if they are the same as the @code{min} and @code{time} characters.
13138 May be negated.  If negated, same as @code{raw}.
13139
13140 @item raw
13141 @opindex raw
13142 Same as:
13143
13144 @example
13145 -ignbrk -brkint -ignpar -parmrk -inpck -istrip
13146 -inlcr -igncr -icrnl -ixon -ixoff -iuclc -ixany
13147 -imaxbel -opost -isig -icanon -xcase min 1 time 0
13148 @end example
13149
13150 @noindent
13151 May be negated.  If negated, same as @code{cooked}.
13152
13153 @item cbreak
13154 @opindex cbreak
13155 Same as @option{-icanon}.  May be negated.  If negated, same as
13156 @code{icanon}.
13157
13158 @item pass8
13159 @opindex pass8
13160 @cindex eight-bit characters
13161 Same as @code{-parenb -istrip cs8}.  May be negated.  If negated,
13162 same as @code{parenb istrip cs7}.
13163
13164 @item litout
13165 @opindex litout
13166 Same as @option{-parenb -istrip -opost cs8}.  May be negated.
13167 If negated, same as @code{parenb istrip opost cs7}.
13168
13169 @item decctlq
13170 @opindex decctlq
13171 Same as @option{-ixany}.  Non-@acronym{POSIX}.  May be negated.
13172
13173 @item tabs
13174 @opindex tabs
13175 Same as @code{tab0}.  Non-@acronym{POSIX}.  May be negated.  If negated, same
13176 as @code{tab3}.
13177
13178 @item lcase
13179 @itemx LCASE
13180 @opindex lcase
13181 @opindex LCASE
13182 Same as @code{xcase iuclc olcuc}.  Non-@acronym{POSIX}.  May be negated.
13183 (Used for terminals with uppercase characters only.)
13184
13185 @item crt
13186 @opindex crt
13187 Same as @code{echoe echoctl echoke}.
13188
13189 @item dec
13190 @opindex dec
13191 Same as @code{echoe echoctl echoke -ixany intr ^C erase ^? kill C-u}.
13192 @end table
13193
13194
13195 @node Characters
13196 @subsection Special characters
13197
13198 @cindex special characters
13199 @cindex characters, special
13200
13201 The special characters' default values vary from system to system.
13202 They are set with the syntax @samp{name value}, where the names are
13203 listed below and the value can be given either literally, in hat
13204 notation (@samp{^@var{c}}), or as an integer which may start with
13205 @samp{0x} to indicate hexadecimal, @samp{0} to indicate octal, or
13206 any other digit to indicate decimal.
13207
13208 @cindex disabling special characters
13209 @kindex u@r{, and disabling special characters}
13210 For GNU stty, giving a value of @code{^-} or @code{undef} disables that
13211 special character.  (This is incompatible with Ultrix @command{stty},
13212 which uses  a value of @samp{u} to disable a special character.  GNU
13213 @command{stty} treats a value @samp{u} like any other, namely to set that
13214 special character to @key{U}.)
13215
13216 @table @samp
13217
13218 @item intr
13219 @opindex intr
13220 Send an interrupt signal.
13221
13222 @item quit
13223 @opindex quit
13224 Send a quit signal.
13225
13226 @item erase
13227 @opindex erase
13228 Erase the last character typed.
13229
13230 @item kill
13231 @opindex kill
13232 Erase the current line.
13233
13234 @item eof
13235 @opindex eof
13236 Send an end of file (terminate the input).
13237
13238 @item eol
13239 @opindex eol
13240 End the line.
13241
13242 @item eol2
13243 @opindex eol2
13244 Alternate character to end the line.  Non-@acronym{POSIX}.
13245
13246 @item swtch
13247 @opindex swtch
13248 Switch to a different shell layer.  Non-@acronym{POSIX}.
13249
13250 @item start
13251 @opindex start
13252 Restart the output after stopping it.
13253
13254 @item stop
13255 @opindex stop
13256 Stop the output.
13257
13258 @item susp
13259 @opindex susp
13260 Send a terminal stop signal.
13261
13262 @item dsusp
13263 @opindex dsusp
13264 Send a terminal stop signal after flushing the input.  Non-@acronym{POSIX}.
13265
13266 @item rprnt
13267 @opindex rprnt
13268 Redraw the current line.  Non-@acronym{POSIX}.
13269
13270 @item werase
13271 @opindex werase
13272 Erase the last word typed.  Non-@acronym{POSIX}.
13273
13274 @item lnext
13275 @opindex lnext
13276 Enter the next character typed literally, even if it is a special
13277 character.  Non-@acronym{POSIX}.
13278 @end table
13279
13280
13281 @node Special
13282 @subsection Special settings
13283
13284 @cindex special settings
13285
13286 @table @samp
13287 @item min @var{n}
13288 @opindex min
13289 Set the minimum number of characters that will satisfy a read until
13290 the time value has expired, when @option{-icanon} is set.
13291
13292 @item time @var{n}
13293 @opindex time
13294 Set the number of tenths of a second before reads time out if the minimum
13295 number of characters have not been read, when @option{-icanon} is set.
13296
13297 @item ispeed @var{n}
13298 @opindex ispeed
13299 Set the input speed to @var{n}.
13300
13301 @item ospeed @var{n}
13302 @opindex ospeed
13303 Set the output speed to @var{n}.
13304
13305 @item rows @var{n}
13306 @opindex rows
13307 Tell the tty kernel driver that the terminal has @var{n} rows.
13308 Non-@acronym{POSIX}.
13309
13310 @item cols @var{n}
13311 @itemx columns @var{n}
13312 @opindex cols
13313 @opindex columns
13314 Tell the kernel that the terminal has @var{n} columns.  Non-@acronym{POSIX}.
13315
13316 @item size
13317 @opindex size
13318 @vindex LINES
13319 @vindex COLUMNS
13320 Print the number of rows and columns that the kernel thinks the
13321 terminal has.  (Systems that don't support rows and columns in the kernel
13322 typically use the environment variables @env{LINES} and @env{COLUMNS}
13323 instead; however, GNU @command{stty} does not know anything about them.)
13324 Non-@acronym{POSIX}.
13325
13326 @item line @var{n}
13327 @opindex line
13328 Use line discipline @var{n}.  Non-@acronym{POSIX}.
13329
13330 @item speed
13331 @opindex speed
13332 Print the terminal speed.
13333
13334 @item @var{n}
13335 @cindex baud rate, setting
13336 Set the input and output speeds to @var{n}.  @var{n} can be one of: 0
13337 50 75 110 134 134.5 150 200 300 600 1200 1800 2400 4800 9600 19200
13338 38400 @code{exta} @code{extb}.  @code{exta} is the same as 19200;
13339 @code{extb} is the same as 38400.  Many systems, including GNU/Linux,
13340 support higher speeds.  The @command{stty} command includes support
13341 for speeds of
13342 57600,
13343 115200,
13344 230400,
13345 460800,
13346 500000,
13347 576000,
13348 921600,
13349 1000000,
13350 1152000,
13351 1500000,
13352 2000000,
13353 2500000,
13354 3000000,
13355 3500000,
13356 or
13357 4000000 where the system supports these.
13358 0 hangs up the line if @option{-clocal} is set.
13359 @end table
13360
13361
13362 @node printenv invocation
13363 @section @command{printenv}: Print all or some environment variables
13364
13365 @pindex printenv
13366 @cindex printing all or some environment variables
13367 @cindex environment variables, printing
13368
13369 @command{printenv} prints environment variable values.  Synopsis:
13370
13371 @example
13372 printenv [@var{option}] [@var{variable}]@dots{}
13373 @end example
13374
13375 If no @var{variable}s are specified, @command{printenv} prints the value of
13376 every environment variable.  Otherwise, it prints the value of each
13377 @var{variable} that is set, and nothing for those that are not set.
13378
13379 The program accepts the following option.  Also see @ref{Common options}.
13380
13381 @table @samp
13382
13383 @optNull{printenv}
13384
13385 @end table
13386
13387 @cindex exit status of @command{printenv}
13388 Exit status:
13389
13390 @display
13391 0 if all variables specified were found
13392 1 if at least one specified variable was not found
13393 2 if a write error occurred
13394 @end display
13395
13396
13397 @node tty invocation
13398 @section @command{tty}: Print file name of terminal on standard input
13399
13400 @pindex tty
13401 @cindex print terminal file name
13402 @cindex terminal file name, printing
13403
13404 @command{tty} prints the file name of the terminal connected to its standard
13405 input.  It prints @samp{not a tty} if standard input is not a terminal.
13406 Synopsis:
13407
13408 @example
13409 tty [@var{option}]@dots{}
13410 @end example
13411
13412 The program accepts the following option.  Also see @ref{Common options}.
13413
13414 @table @samp
13415
13416 @item -s
13417 @itemx --silent
13418 @itemx --quiet
13419 @opindex -s
13420 @opindex --silent
13421 @opindex --quiet
13422 Print nothing; only return an exit status.
13423
13424 @end table
13425
13426 @cindex exit status of @command{tty}
13427 Exit status:
13428
13429 @display
13430 0 if standard input is a terminal
13431 1 if standard input is not a terminal
13432 2 if given incorrect arguments
13433 3 if a write error occurs
13434 @end display
13435
13436
13437 @node User information
13438 @chapter User information
13439
13440 @cindex user information, commands for
13441 @cindex commands for printing user information
13442
13443 This section describes commands that print user-related information:
13444 logins, groups, and so forth.
13445
13446 @menu
13447 * id invocation::               Print user identity.
13448 * logname invocation::          Print current login name.
13449 * whoami invocation::           Print effective user ID.
13450 * groups invocation::           Print group names a user is in.
13451 * users invocation::            Print login names of users currently logged in.
13452 * who invocation::              Print who is currently logged in.
13453 @end menu
13454
13455
13456 @node id invocation
13457 @section @command{id}: Print user identity
13458
13459 @pindex id
13460 @cindex real user and group IDs, printing
13461 @cindex effective user and group IDs, printing
13462 @cindex printing real and effective user and group IDs
13463
13464 @command{id} prints information about the given user, or the process
13465 running it if no user is specified.  Synopsis:
13466
13467 @example
13468 id [@var{option}]@dots{} [@var{username}]
13469 @end example
13470
13471 @vindex POSIXLY_CORRECT
13472 By default, it prints the real user ID, real group ID, effective user ID
13473 if different from the real user ID, effective group ID if different from
13474 the real group ID, and supplemental group IDs.
13475 In addition, if SELinux
13476 is enabled and the @env{POSIXLY_CORRECT} environment variable is not set,
13477 then print @samp{context=@var{c}}, where @var{c} is the security context.
13478
13479 Each of these numeric values is preceded by an identifying string and
13480 followed by the corresponding user or group name in parentheses.
13481
13482 The options cause @command{id} to print only part of the above information.
13483 Also see @ref{Common options}.
13484
13485 @table @samp
13486 @item -g
13487 @itemx --group
13488 @opindex -g
13489 @opindex --group
13490 Print only the group ID.
13491
13492 @item -G
13493 @itemx --groups
13494 @opindex -G
13495 @opindex --groups
13496 Print only the group ID and the supplementary groups.
13497
13498 @item -n
13499 @itemx --name
13500 @opindex -n
13501 @opindex --name
13502 Print the user or group name instead of the ID number.  Requires
13503 @option{-u}, @option{-g}, or @option{-G}.
13504
13505 @item -r
13506 @itemx --real
13507 @opindex -r
13508 @opindex --real
13509 Print the real, instead of effective, user or group ID.  Requires
13510 @option{-u}, @option{-g}, or @option{-G}.
13511
13512 @item -u
13513 @itemx --user
13514 @opindex -u
13515 @opindex --user
13516 Print only the user ID.
13517
13518 @item -Z
13519 @itemx --context
13520 @opindex -Z
13521 @opindex --context
13522 @cindex SELinux
13523 @cindex security context
13524 Print only the security context of the current user.
13525 If SELinux is disabled then print a warning and
13526 set the exit status to 1.
13527
13528 @end table
13529
13530 @exitstatus
13531
13532 @macro primaryAndSupplementaryGroups{cmd,arg}
13533 Primary and supplementary groups for a process are normally inherited
13534 from its parent and are usually unchanged since login.  This means
13535 that if you change the group database after logging in, @command{\cmd\}
13536 will not reflect your changes within your existing login session.
13537 Running @command{\cmd\} with a \arg\ causes the user and group
13538 database to be consulted afresh, and so will give a different result.
13539 @end macro
13540 @primaryAndSupplementaryGroups{id,user argument}
13541
13542 @node logname invocation
13543 @section @command{logname}: Print current login name
13544
13545 @pindex logname
13546 @cindex printing user's login name
13547 @cindex login name, printing
13548 @cindex user name, printing
13549
13550 @flindex utmp
13551 @command{logname} prints the calling user's name, as found in a
13552 system-maintained file (often @file{/var/run/utmp} or
13553 @file{/etc/utmp}), and exits with a status of 0.  If there is no entry
13554 for the calling process, @command{logname} prints
13555 an error message and exits with a status of 1.
13556
13557 The only options are @option{--help} and @option{--version}.  @xref{Common
13558 options}.
13559
13560 @exitstatus
13561
13562
13563 @node whoami invocation
13564 @section @command{whoami}: Print effective user ID
13565
13566 @pindex whoami
13567 @cindex effective user ID, printing
13568 @cindex printing the effective user ID
13569
13570 @command{whoami} prints the user name associated with the current
13571 effective user ID.  It is equivalent to the command @samp{id -un}.
13572
13573 The only options are @option{--help} and @option{--version}.  @xref{Common
13574 options}.
13575
13576 @exitstatus
13577
13578
13579 @node groups invocation
13580 @section @command{groups}: Print group names a user is in
13581
13582 @pindex groups
13583 @cindex printing groups a user is in
13584 @cindex supplementary groups, printing
13585
13586 @command{groups} prints the names of the primary and any supplementary
13587 groups for each given @var{username}, or the current process if no names
13588 are given.  If more than one name is given, the name of each user is
13589 printed before
13590 the list of that user's groups and the user name is separated from the
13591 group list by a colon.  Synopsis:
13592
13593 @example
13594 groups [@var{username}]@dots{}
13595 @end example
13596
13597 The group lists are equivalent to the output of the command @samp{id -Gn}.
13598
13599 @primaryAndSupplementaryGroups{groups,list of users}
13600
13601 The only options are @option{--help} and @option{--version}.  @xref{Common
13602 options}.
13603
13604 @exitstatus
13605
13606
13607 @node users invocation
13608 @section @command{users}: Print login names of users currently logged in
13609
13610 @pindex users
13611 @cindex printing current usernames
13612 @cindex usernames, printing current
13613
13614 @cindex login sessions, printing users with
13615 @command{users} prints on a single line a blank-separated list of user
13616 names of users currently logged in to the current host.  Each user name
13617 corresponds to a login session, so if a user has more than one login
13618 session, that user's name will appear the same number of times in the
13619 output.  Synopsis:
13620
13621 @example
13622 users [@var{file}]
13623 @end example
13624
13625 @flindex utmp
13626 @flindex wtmp
13627 With no @var{file} argument, @command{users} extracts its information from
13628 a system-maintained file (often @file{/var/run/utmp} or
13629 @file{/etc/utmp}).  If a file argument is given, @command{users} uses
13630 that file instead.  A common choice is @file{/var/log/wtmp}.
13631
13632 The only options are @option{--help} and @option{--version}.  @xref{Common
13633 options}.
13634
13635 @exitstatus
13636
13637
13638 @node who invocation
13639 @section @command{who}: Print who is currently logged in
13640
13641 @pindex who
13642 @cindex printing current user information
13643 @cindex information, about current users
13644
13645 @command{who} prints information about users who are currently logged on.
13646 Synopsis:
13647
13648 @example
13649 @command{who} [@var{option}] [@var{file}] [am i]
13650 @end example
13651
13652 @cindex terminal lines, currently used
13653 @cindex login time
13654 @cindex remote hostname
13655 If given no non-option arguments, @command{who} prints the following
13656 information for each user currently logged on: login name, terminal
13657 line, login time, and remote hostname or X display.
13658
13659 @flindex utmp
13660 @flindex wtmp
13661 If given one non-option argument, @command{who} uses that instead of
13662 a default system-maintained file (often @file{/var/run/utmp} or
13663 @file{/etc/utmp}) as the name of the file containing the record of
13664 users logged on.  @file{/var/log/wtmp} is commonly given as an argument
13665 to @command{who} to look at who has previously logged on.
13666
13667 @opindex am i
13668 @opindex who am i
13669 If given two non-option arguments, @command{who} prints only the entry
13670 for the user running it (determined from its standard input), preceded
13671 by the hostname.  Traditionally, the two arguments given are @samp{am
13672 i}, as in @samp{who am i}.
13673
13674 @vindex TZ
13675 Time stamps are listed according to the time zone rules specified by
13676 the @env{TZ} environment variable, or by the system default rules if
13677 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
13678 with @env{TZ}, libc, The GNU C Library Reference Manual}.
13679
13680 The program accepts the following options.  Also see @ref{Common options}.
13681
13682 @table @samp
13683
13684 @item -a
13685 @itemx --all
13686 @opindex -a
13687 @opindex --all
13688 Same as @samp{-b -d --login -p -r -t -T -u}.
13689
13690 @item -b
13691 @itemx --boot
13692 @opindex -b
13693 @opindex --boot
13694 Print the date and time of last system boot.
13695
13696 @item -d
13697 @itemx --dead
13698 @opindex -d
13699 @opindex --dead
13700 Print information corresponding to dead processes.
13701
13702 @item -H
13703 @itemx --heading
13704 @opindex -H
13705 @opindex --heading
13706 Print a line of column headings.
13707
13708 @item -l
13709 @itemx --login
13710 @opindex -l
13711 @opindex --login
13712 List only the entries that correspond to processes via which the
13713 system is waiting for a user to login.  The user name is always @samp{LOGIN}.
13714
13715 @itemx --lookup
13716 @opindex --lookup
13717 Attempt to canonicalize hostnames found in utmp through a DNS lookup.  This
13718 is not the default because it can cause significant delays on systems with
13719 automatic dial-up internet access.
13720
13721 @item -m
13722 @opindex -m
13723 Same as @samp{who am i}.
13724
13725 @item -p
13726 @itemx --process
13727 @opindex -p
13728 @opindex --process
13729 List active processes spawned by init.
13730
13731 @item -q
13732 @itemx --count
13733 @opindex -q
13734 @opindex --count
13735 Print only the login names and the number of users logged on.
13736 Overrides all other options.
13737
13738 @item -r
13739 @itemx --runlevel
13740 @opindex -r
13741 @opindex --runlevel
13742 Print the current (and maybe previous) run-level of the init process.
13743
13744 @item -s
13745 @opindex -s
13746 Ignored; for compatibility with other versions of @command{who}.
13747
13748 @item -t
13749 @itemx --time
13750 @opindex -t
13751 @opindex --time
13752 Print last system clock change.
13753
13754 @itemx -u
13755 @opindex -u
13756 @cindex idle time
13757 After the login time, print the number of hours and minutes that the
13758 user has been idle.  @samp{.} means the user was active in the last minute.
13759 @samp{old} means the user has been idle for more than 24 hours.
13760
13761 @item -w
13762 @itemx -T
13763 @itemx --mesg
13764 @itemx --message
13765 @itemx --writable
13766 @opindex -w
13767 @opindex -T
13768 @opindex --mesg
13769 @opindex --message
13770 @opindex --writable
13771 @cindex message status
13772 @pindex write@r{, allowed}
13773 After each login name print a character indicating the user's message status:
13774
13775 @display
13776 @samp{+} allowing @code{write} messages
13777 @samp{-} disallowing @code{write} messages
13778 @samp{?} cannot find terminal device
13779 @end display
13780
13781 @end table
13782
13783 @exitstatus
13784
13785
13786 @node System context
13787 @chapter System context
13788
13789 @cindex system context
13790 @cindex context, system
13791 @cindex commands for system context
13792
13793 This section describes commands that print or change system-wide
13794 information.
13795
13796 @menu
13797 * date invocation::             Print or set system date and time.
13798 * arch invocation::             Print machine hardware name.
13799 * nproc invocation::            Print the number of processors.
13800 * uname invocation::            Print system information.
13801 * hostname invocation::         Print or set system name.
13802 * hostid invocation::           Print numeric host identifier.
13803 * uptime invocation::           Print system uptime and load.
13804 @end menu
13805
13806 @node date invocation
13807 @section @command{date}: Print or set system date and time
13808
13809 @pindex date
13810 @cindex time, printing or setting
13811 @cindex printing the current time
13812
13813 Synopses:
13814
13815 @example
13816 date [@var{option}]@dots{} [+@var{format}]
13817 date [-u|--utc|--universal] @c this avoids a newline in the output
13818 [ MMDDhhmm[[CC]YY][.ss] ]
13819 @end example
13820
13821 @vindex LC_TIME
13822 Invoking @command{date} with no @var{format} argument is equivalent to invoking
13823 it with a default format that depends on the @env{LC_TIME} locale category.
13824 In the default C locale, this format is @samp{'+%a %b %e %H:%M:%S %Z %Y'},
13825 so the output looks like @samp{Thu Mar @ 3 13:47:51 PST 2005}.
13826
13827 @vindex TZ
13828 Normally, @command{date} uses the time zone rules indicated by the
13829 @env{TZ} environment variable, or the system default rules if @env{TZ}
13830 is not set.  @xref{TZ Variable,, Specifying the Time Zone with
13831 @env{TZ}, libc, The GNU C Library Reference Manual}.
13832
13833 @findex strftime @r{and @command{date}}
13834 @cindex time formats
13835 @cindex formatting times
13836 If given an argument that starts with a @samp{+}, @command{date} prints the
13837 current date and time (or the date and time specified by the
13838 @option{--date} option, see below) in the format defined by that argument,
13839 which is similar to that of the @code{strftime} function.  Except for
13840 conversion specifiers, which start with @samp{%}, characters in the
13841 format string are printed unchanged.  The conversion specifiers are
13842 described below.
13843
13844 @exitstatus
13845
13846 @menu
13847 * Time conversion specifiers::     %[HIklMNpPrRsSTXzZ]
13848 * Date conversion specifiers::     %[aAbBcCdDeFgGhjmuUVwWxyY]
13849 * Literal conversion specifiers::  %[%nt]
13850 * Padding and other flags::        Pad with zeros, spaces, etc.
13851 * Setting the time::               Changing the system clock.
13852 * Options for date::               Instead of the current time.
13853 @detailmenu
13854 * Date input formats::             Specifying date strings.
13855 @end detailmenu
13856 * Examples of date::               Examples.
13857 @end menu
13858
13859 @node Time conversion specifiers
13860 @subsection Time conversion specifiers
13861
13862 @cindex time conversion specifiers
13863 @cindex conversion specifiers, time
13864
13865 @command{date} conversion specifiers related to times.
13866
13867 @table @samp
13868 @item %H
13869 hour (@samp{00}@dots{}@samp{23})
13870 @item %I
13871 hour (@samp{01}@dots{}@samp{12})
13872 @item %k
13873 hour (@samp{ 0}@dots{}@samp{23}).
13874 This is a @acronym{GNU} extension.
13875 @item %l
13876 hour (@samp{ 1}@dots{}@samp{12}).
13877 This is a @acronym{GNU} extension.
13878 @item %M
13879 minute (@samp{00}@dots{}@samp{59})
13880 @item %N
13881 nanoseconds (@samp{000000000}@dots{}@samp{999999999}).
13882 This is a @acronym{GNU} extension.
13883 @item %p
13884 locale's equivalent of either @samp{AM} or @samp{PM};
13885 blank in many locales.
13886 Noon is treated as @samp{PM} and midnight as @samp{AM}.
13887 @item %P
13888 like @samp{%p}, except lower case.
13889 This is a @acronym{GNU} extension.
13890 @item %r
13891 locale's 12-hour clock time (e.g., @samp{11:11:04 PM})
13892 @item %R
13893 24-hour hour and minute.  Same as @samp{%H:%M}.
13894 This is a @acronym{GNU} extension.
13895 @item %s
13896 @cindex epoch, seconds since
13897 @cindex seconds since the epoch
13898 @cindex beginning of time
13899 seconds since the epoch, i.e., since 1970-01-01 00:00:00 UTC.
13900 Leap seconds are not counted unless leap second support is available.
13901 @xref{%s-examples}, for examples.
13902 This is a @acronym{GNU} extension.
13903 @item %S
13904 second (@samp{00}@dots{}@samp{60}).
13905 This may be @samp{60} if leap seconds are supported.
13906 @item %T
13907 24-hour hour, minute, and second.  Same as @samp{%H:%M:%S}.
13908 @item %X
13909 locale's time representation (e.g., @samp{23:13:48})
13910 @item %z
13911 @w{@acronym{RFC} 2822/@acronym{ISO} 8601} style numeric time zone
13912 (e.g., @samp{-0600} or @samp{+0530}), or nothing if no
13913 time zone is determinable.  This value reflects the numeric time zone
13914 appropriate for the current time, using the time zone rules specified
13915 by the @env{TZ} environment variable.
13916 The time (and optionally, the time zone rules) can be overridden
13917 by the @option{--date} option.
13918 This is a @acronym{GNU} extension.
13919 @item %:z
13920 @w{@acronym{RFC} 3339/@acronym{ISO} 8601} style numeric time zone with
13921 @samp{:} (e.g., @samp{-06:00} or @samp{+05:30}), or nothing if no time
13922 zone is determinable.
13923 This is a @acronym{GNU} extension.
13924 @item %::z
13925 Numeric time zone to the nearest second with @samp{:} (e.g.,
13926 @samp{-06:00:00} or @samp{+05:30:00}), or nothing if no time zone is
13927 determinable.
13928 This is a @acronym{GNU} extension.
13929 @item %:::z
13930 Numeric time zone with @samp{:} using the minimum necessary precision
13931 (e.g., @samp{-06}, @samp{+05:30}, or @samp{-04:56:02}), or nothing if
13932 no time zone is determinable.
13933 This is a @acronym{GNU} extension.
13934 @item %Z
13935 alphabetic time zone abbreviation (e.g., @samp{EDT}), or nothing if no
13936 time zone is determinable.  See @samp{%z} for how it is determined.
13937 @end table
13938
13939
13940 @node Date conversion specifiers
13941 @subsection Date conversion specifiers
13942
13943 @cindex date conversion specifiers
13944 @cindex conversion specifiers, date
13945
13946 @command{date} conversion specifiers related to dates.
13947
13948 @table @samp
13949 @item %a
13950 locale's abbreviated weekday name (e.g., @samp{Sun})
13951 @item %A
13952 locale's full weekday name, variable length (e.g., @samp{Sunday})
13953 @item %b
13954 locale's abbreviated month name (e.g., @samp{Jan})
13955 @item %B
13956 locale's full month name, variable length (e.g., @samp{January})
13957 @item %c
13958 locale's date and time (e.g., @samp{Thu Mar @ 3 23:05:25 2005})
13959 @item %C
13960 century.  This is like @samp{%Y}, except the last two digits are omitted.
13961 For example, it is @samp{20} if @samp{%Y} is @samp{2000},
13962 and is @samp{-0} if @samp{%Y} is @samp{-001}.
13963 It is normally at least two characters, but it may be more.
13964 @item %d
13965 day of month (e.g., @samp{01})
13966 @item %D
13967 date; same as @samp{%m/%d/%y}
13968 @item %e
13969 day of month, space padded; same as @samp{%_d}
13970 @item %F
13971 full date in @acronym{ISO} 8601 format; same as @samp{%Y-%m-%d}.
13972 This is a good choice for a date format, as it is standard and
13973 is easy to sort in the usual case where years are in the range
13974 0000@dots{}9999.
13975 This is a @acronym{GNU} extension.
13976 @item %g
13977 year corresponding to the @acronym{ISO} week number, but without the century
13978 (range @samp{00} through @samp{99}).  This has the same format and value
13979 as @samp{%y}, except that if the @acronym{ISO} week number (see
13980 @samp{%V}) belongs
13981 to the previous or next year, that year is used instead.
13982 This is a @acronym{GNU} extension.
13983 @item %G
13984 year corresponding to the @acronym{ISO} week number.  This has the
13985 same format and value as @samp{%Y}, except that if the @acronym{ISO}
13986 week number (see
13987 @samp{%V}) belongs to the previous or next year, that year is used
13988 instead.
13989 It is normally useful only if @samp{%V} is also used;
13990 for example, the format @samp{%G-%m-%d} is probably a mistake,
13991 since it combines the ISO week number year with the conventional month and day.
13992 This is a @acronym{GNU} extension.
13993 @item %h
13994 same as @samp{%b}
13995 @item %j
13996 day of year (@samp{001}@dots{}@samp{366})
13997 @item %m
13998 month (@samp{01}@dots{}@samp{12})
13999 @item %u
14000 day of week (@samp{1}@dots{}@samp{7}) with @samp{1} corresponding to Monday
14001 @item %U
14002 week number of year, with Sunday as the first day of the week
14003 (@samp{00}@dots{}@samp{53}).
14004 Days in a new year preceding the first Sunday are in week zero.
14005 @item %V
14006 @acronym{ISO} week number, that is, the
14007 week number of year, with Monday as the first day of the week
14008 (@samp{01}@dots{}@samp{53}).
14009 If the week containing January 1 has four or more days in
14010 the new year, then it is considered week 1; otherwise, it is week 53 of
14011 the previous year, and the next week is week 1.  (See the @acronym{ISO} 8601
14012 standard.)
14013 @item %w
14014 day of week (@samp{0}@dots{}@samp{6}) with 0 corresponding to Sunday
14015 @item %W
14016 week number of year, with Monday as first day of week
14017 (@samp{00}@dots{}@samp{53}).
14018 Days in a new year preceding the first Monday are in week zero.
14019 @item %x
14020 locale's date representation (e.g., @samp{12/31/99})
14021 @item %y
14022 last two digits of year (@samp{00}@dots{}@samp{99})
14023 @item %Y
14024 year.  This is normally at least four characters, but it may be more.
14025 Year @samp{0000} precedes year @samp{0001}, and year @samp{-001}
14026 precedes year @samp{0000}.
14027 @end table
14028
14029
14030 @node Literal conversion specifiers
14031 @subsection Literal conversion specifiers
14032
14033 @cindex literal conversion specifiers
14034 @cindex conversion specifiers, literal
14035
14036 @command{date} conversion specifiers that produce literal strings.
14037
14038 @table @samp
14039 @item %%
14040 a literal %
14041 @item %n
14042 a newline
14043 @item %t
14044 a horizontal tab
14045 @end table
14046
14047
14048 @node Padding and other flags
14049 @subsection Padding and other flags
14050
14051 @cindex numeric field padding
14052 @cindex padding of numeric fields
14053 @cindex fields, padding numeric
14054
14055 Unless otherwise specified, @command{date} normally pads numeric fields
14056 with zeros, so that, for
14057 example, numeric months are always output as two digits.
14058 Seconds since the epoch are not padded, though,
14059 since there is no natural width for them.
14060
14061 As a @acronym{GNU} extension, @command{date} recognizes any of the
14062 following optional flags after the @samp{%}:
14063
14064 @table @samp
14065 @item -
14066 (hyphen) Do not pad the field; useful if the output is intended for
14067 human consumption.
14068 @item _
14069 (underscore) Pad with spaces; useful if you need a fixed
14070 number of characters in the output, but zeros are too distracting.
14071 @item 0
14072 (zero) Pad with zeros even if the conversion specifier
14073 would normally pad with spaces.
14074 @item ^
14075 Use upper case characters if possible.
14076 @item #
14077 Use opposite case characters if possible.
14078 A field that is normally upper case becomes lower case, and vice versa.
14079 @end table
14080
14081 @noindent
14082 Here are some examples of padding:
14083
14084 @example
14085 date +%d/%m -d "Feb 1"
14086 @result{} 01/02
14087 date +%-d/%-m -d "Feb 1"
14088 @result{} 1/2
14089 date +%_d/%_m -d "Feb 1"
14090 @result{}  1/ 2
14091 @end example
14092
14093 As a @acronym{GNU} extension, you can specify the field width
14094 (after any flag, if present) as a decimal number.  If the natural size of the
14095 output of the field has less than the specified number of characters,
14096 the result is written right adjusted and padded to the given
14097 size.  For example, @samp{%9B} prints the right adjusted month name in
14098 a field of width 9.
14099
14100 An optional modifier can follow the optional flag and width
14101 specification.  The modifiers are:
14102
14103 @table @samp
14104 @item E
14105 Use the locale's alternate representation for date and time.  This
14106 modifier applies to the @samp{%c}, @samp{%C}, @samp{%x}, @samp{%X},
14107 @samp{%y} and @samp{%Y} conversion specifiers.  In a Japanese locale, for
14108 example, @samp{%Ex} might yield a date format based on the Japanese
14109 Emperors' reigns.
14110
14111 @item O
14112 Use the locale's alternate numeric symbols for numbers.  This modifier
14113 applies only to numeric conversion specifiers.
14114 @end table
14115
14116 If the format supports the modifier but no alternate representation
14117 is available, it is ignored.
14118
14119
14120 @node Setting the time
14121 @subsection Setting the time
14122
14123 @cindex setting the time
14124 @cindex time setting
14125 @cindex appropriate privileges
14126
14127 If given an argument that does not start with @samp{+}, @command{date} sets
14128 the system clock to the date and time specified by that argument (as
14129 described below).  You must have appropriate privileges to set the
14130 system clock.  The @option{--date} and @option{--set} options may not be
14131 used with such an argument.  The @option{--universal} option may be used
14132 with such an argument to indicate that the specified date and time are
14133 relative to Coordinated Universal Time rather than to the local time
14134 zone.
14135
14136 The argument must consist entirely of digits, which have the following
14137 meaning:
14138
14139 @table @samp
14140 @item MM
14141 month
14142 @item DD
14143 day within month
14144 @item hh
14145 hour
14146 @item mm
14147 minute
14148 @item CC
14149 first two digits of year (optional)
14150 @item YY
14151 last two digits of year (optional)
14152 @item ss
14153 second (optional)
14154 @end table
14155
14156 The @option{--set} option also sets the system clock; see the next section.
14157
14158
14159 @node Options for date
14160 @subsection Options for @command{date}
14161
14162 @cindex @command{date} options
14163 @cindex options for @command{date}
14164
14165 The program accepts the following options.  Also see @ref{Common options}.
14166
14167 @table @samp
14168
14169 @item -d @var{datestr}
14170 @itemx --date=@var{datestr}
14171 @opindex -d
14172 @opindex --date
14173 @cindex parsing date strings
14174 @cindex date strings, parsing
14175 @cindex arbitrary date strings, parsing
14176 @opindex yesterday
14177 @opindex tomorrow
14178 @opindex next @var{day}
14179 @opindex last @var{day}
14180 Display the date and time specified in @var{datestr} instead of the
14181 current date and time.  @var{datestr} can be in almost any common
14182 format.  It can contain month names, time zones, @samp{am} and @samp{pm},
14183 @samp{yesterday}, etc.  For example, @option{--date="2004-02-27
14184 14:19:13.489392193 +0530"} specifies the instant of time that is
14185 489,392,193 nanoseconds after February 27, 2004 at 2:19:13 PM in a
14186 time zone that is 5 hours and 30 minutes east of @acronym{UTC}.@*
14187 Note: input currently must be in locale independent format. E.g., the
14188 LC_TIME=C below is needed to print back the correct date in many locales:
14189 @example
14190 date -d "$(LC_TIME=C date)"
14191 @end example
14192 @xref{Date input formats}.
14193
14194 @item -f @var{datefile}
14195 @itemx --file=@var{datefile}
14196 @opindex -f
14197 @opindex --file
14198 Parse each line in @var{datefile} as with @option{-d} and display the
14199 resulting date and time.  If @var{datefile} is @samp{-}, use standard
14200 input.  This is useful when you have many dates to process, because the
14201 system overhead of starting up the @command{date} executable many times can
14202 be considerable.
14203
14204 @item -r @var{file}
14205 @itemx --reference=@var{file}
14206 @opindex -r
14207 @opindex --reference
14208 Display the date and time of the last modification of @var{file},
14209 instead of the current date and time.
14210
14211 @item -R
14212 @itemx --rfc-822
14213 @itemx --rfc-2822
14214 @opindex -R
14215 @opindex --rfc-822
14216 @opindex --rfc-2822
14217 Display the date and time using the format @samp{%a, %d %b %Y %H:%M:%S
14218 %z}, evaluated in the C locale so abbreviations are always in English.
14219 For example:
14220
14221 @example
14222 Fri, 09 Sep 2005 13:51:39 -0700
14223 @end example
14224
14225 This format conforms to
14226 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt, Internet
14227 @acronym{RFCs} 2822} and
14228 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc822.txt, 822}, the
14229 current and previous standards for Internet email.
14230
14231 @item --rfc-3339=@var{timespec}
14232 @opindex --rfc-3339=@var{timespec}
14233 Display the date using a format specified by
14234 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc3339.txt, Internet
14235 @acronym{RFC} 3339}.  This is a subset of the @acronym{ISO} 8601
14236 format, except that it also permits applications to use a space rather
14237 than a @samp{T} to separate dates from times.  Unlike the other
14238 standard formats, @acronym{RFC} 3339 format is always suitable as
14239 input for the @option{--date} (@option{-d}) and @option{--file}
14240 (@option{-f}) options, regardless of the current locale.
14241
14242 The argument @var{timespec} specifies how much of the time to include.
14243 It can be one of the following:
14244
14245 @table @samp
14246 @item date
14247 Print just the full-date, e.g., @samp{2005-09-14}.
14248 This is equivalent to the format @samp{%Y-%m-%d}.
14249
14250 @item seconds
14251 Print the full-date and full-time separated by a space, e.g.,
14252 @samp{2005-09-14 00:56:06+05:30}.  The output ends with a numeric
14253 time-offset; here the @samp{+05:30} means that local time is five
14254 hours and thirty minutes east of @acronym{UTC}.  This is equivalent to
14255 the format @samp{%Y-%m-%d %H:%M:%S%:z}.
14256
14257 @item ns
14258 Like @samp{seconds}, but also print nanoseconds, e.g.,
14259 @samp{2005-09-14 00:56:06.998458565+05:30}.
14260 This is equivalent to the format @samp{%Y-%m-%d %H:%M:%S.%N%:z}.
14261
14262 @end table
14263
14264 @item -s @var{datestr}
14265 @itemx --set=@var{datestr}
14266 @opindex -s
14267 @opindex --set
14268 Set the date and time to @var{datestr}.  See @option{-d} above.
14269
14270 @item -u
14271 @itemx --utc
14272 @itemx --universal
14273 @opindex -u
14274 @opindex --utc
14275 @opindex --universal
14276 @cindex Coordinated Universal Time
14277 @cindex UTC
14278 @cindex Greenwich Mean Time
14279 @cindex GMT
14280 @vindex TZ
14281 Use Coordinated Universal Time (@acronym{UTC}) by operating as if the
14282 @env{TZ} environment variable were set to the string @samp{UTC0}.
14283 Coordinated
14284 Universal Time is often called ``Greenwich Mean Time'' (@sc{gmt}) for
14285 historical reasons.
14286 @end table
14287
14288
14289 @node Examples of date
14290 @subsection Examples of @command{date}
14291
14292 @cindex examples of @command{date}
14293
14294 Here are a few examples.  Also see the documentation for the @option{-d}
14295 option in the previous section.
14296
14297 @itemize @bullet
14298
14299 @item
14300 To print the date of the day before yesterday:
14301
14302 @example
14303 date --date='2 days ago'
14304 @end example
14305
14306 @item
14307 To print the date of the day three months and one day hence:
14308
14309 @example
14310 date --date='3 months 1 day'
14311 @end example
14312
14313 @item
14314 To print the day of year of Christmas in the current year:
14315
14316 @example
14317 date --date='25 Dec' +%j
14318 @end example
14319
14320 @item
14321 To print the current full month name and the day of the month:
14322
14323 @example
14324 date '+%B %d'
14325 @end example
14326
14327 But this may not be what you want because for the first nine days of
14328 the month, the @samp{%d} expands to a zero-padded two-digit field,
14329 for example @samp{date -d 1may '+%B %d'} will print @samp{May 01}.
14330
14331 @item
14332 To print a date without the leading zero for one-digit days
14333 of the month, you can use the (@acronym{GNU} extension)
14334 @samp{-} flag to suppress
14335 the padding altogether:
14336
14337 @example
14338 date -d 1may '+%B %-d
14339 @end example
14340
14341 @item
14342 To print the current date and time in the format required by many
14343 non-@acronym{GNU} versions of @command{date} when setting the system clock:
14344
14345 @example
14346 date +%m%d%H%M%Y.%S
14347 @end example
14348
14349 @item
14350 To set the system clock forward by two minutes:
14351
14352 @example
14353 date --set='+2 minutes'
14354 @end example
14355
14356 @item
14357 To print the date in @acronym{RFC} 2822 format,
14358 use @samp{date --rfc-2822}.  Here is some example output:
14359
14360 @example
14361 Fri, 09 Sep 2005 13:51:39 -0700
14362 @end example
14363
14364 @anchor{%s-examples}
14365 @item
14366 To convert a date string to the number of seconds since the epoch
14367 (which is 1970-01-01 00:00:00 UTC), use the @option{--date} option with
14368 the @samp{%s} format.  That can be useful in sorting and/or graphing
14369 and/or comparing data by date.  The following command outputs the
14370 number of the seconds since the epoch for the time two minutes after the
14371 epoch:
14372
14373 @example
14374 date --date='1970-01-01 00:02:00 +0000' +%s
14375 120
14376 @end example
14377
14378 If you do not specify time zone information in the date string,
14379 @command{date} uses your computer's idea of the time zone when
14380 interpreting the string.  For example, if your computer's time zone is
14381 that of Cambridge, Massachusetts, which was then 5 hours (i.e., 18,000
14382 seconds) behind UTC:
14383
14384 @example
14385 # local time zone used
14386 date --date='1970-01-01 00:02:00' +%s
14387 18120
14388 @end example
14389
14390 @item
14391 If you're sorting or graphing dated data, your raw date values may be
14392 represented as seconds since the epoch.  But few people can look at
14393 the date @samp{946684800} and casually note ``Oh, that's the first second
14394 of the year 2000 in Greenwich, England.''
14395
14396 @example
14397 date --date='2000-01-01 UTC' +%s
14398 946684800
14399 @end example
14400
14401 An alternative is to use the @option{--utc} (@option{-u}) option.
14402 Then you may omit @samp{UTC} from the date string.  Although this
14403 produces the same result for @samp{%s} and many other format sequences,
14404 with a time zone offset different from zero, it would give a different
14405 result for zone-dependent formats like @samp{%z}.
14406
14407 @example
14408 date -u --date=2000-01-01 +%s
14409 946684800
14410 @end example
14411
14412 To convert such an unwieldy number of seconds back to
14413 a more readable form, use a command like this:
14414
14415 @smallexample
14416 # local time zone used
14417 date -d '1970-01-01 UTC 946684800 seconds' +"%Y-%m-%d %T %z"
14418 1999-12-31 19:00:00 -0500
14419 @end smallexample
14420
14421 Or if you do not mind depending on the @samp{@@} feature present since
14422 coreutils 5.3.0, you could shorten this to:
14423
14424 @smallexample
14425 date -d @@946684800 +"%F %T %z"
14426 1999-12-31 19:00:00 -0500
14427 @end smallexample
14428
14429 Often it is better to output UTC-relative date and time:
14430
14431 @smallexample
14432 date -u -d '1970-01-01 946684800 seconds' +"%Y-%m-%d %T %z"
14433 2000-01-01 00:00:00 +0000
14434 @end smallexample
14435
14436 @end itemize
14437
14438
14439 @node arch invocation
14440 @section @command{arch}: Print machine hardware name
14441
14442 @pindex arch
14443 @cindex print machine hardware name
14444 @cindex system information, printing
14445
14446 @command{arch} prints the machine hardware name,
14447 and is equivalent to @samp{uname -m}.
14448 Synopsis:
14449
14450 @example
14451 arch [@var{option}]
14452 @end example
14453
14454 The program accepts the @ref{Common options} only.
14455
14456 @exitstatus
14457
14458
14459 @node nproc invocation
14460 @section @command{nproc}: Print the number of available processors
14461
14462 @pindex nproc
14463 @cindex Print the number of processors
14464 @cindex system information, printing
14465
14466 Print the number of processing units available to the current process,
14467 which may be less than the number of online processors.
14468 If this information is not accessible, then print the number of
14469 processors installed.  If the @env{OMP_NUM_THREADS} environment variable is
14470 set, then it will determine the returned value.  The result is guaranteed to be
14471 greater than zero.  Synopsis:
14472
14473 @example
14474 nproc [@var{option}]
14475 @end example
14476
14477 The program accepts the following options.  Also see @ref{Common options}.
14478
14479 @table @samp
14480
14481 @item --all
14482 @opindex --all
14483 Print the number of installed processors on the system, which may
14484 be greater than the number online or available to the current process.
14485 The @env{OMP_NUM_THREADS} environment variable is not honored in this case.
14486
14487 @item --ignore=@var{number}
14488 @opindex --ignore
14489 If possible, exclude this @var{number} of processing units.
14490
14491 @end table
14492
14493 @exitstatus
14494
14495
14496 @node uname invocation
14497 @section @command{uname}: Print system information
14498
14499 @pindex uname
14500 @cindex print system information
14501 @cindex system information, printing
14502
14503 @command{uname} prints information about the machine and operating system
14504 it is run on.  If no options are given, @command{uname} acts as if the
14505 @option{-s} option were given.  Synopsis:
14506
14507 @example
14508 uname [@var{option}]@dots{}
14509 @end example
14510
14511 If multiple options or @option{-a} are given, the selected information is
14512 printed in this order:
14513
14514 @example
14515 @var{kernel-name} @var{nodename} @var{kernel-release} @var{kernel-version}
14516 @var{machine} @var{processor} @var{hardware-platform} @var{operating-system}
14517 @end example
14518
14519 The information may contain internal spaces, so such output cannot be
14520 parsed reliably.  In the following example, @var{release} is
14521 @samp{2.2.18ss.e820-bda652a #4 SMP Tue Jun 5 11:24:08 PDT 2001}:
14522
14523 @smallexample
14524 uname -a
14525 @result{} Linux dum 2.2.18 #4 SMP Tue Jun 5 11:24:08 PDT 2001 i686@c
14526  unknown unknown GNU/Linux
14527 @end smallexample
14528
14529
14530 The program accepts the following options.  Also see @ref{Common options}.
14531
14532 @table @samp
14533
14534 @item -a
14535 @itemx --all
14536 @opindex -a
14537 @opindex --all
14538 Print all of the below information, except omit the processor type
14539 and the hardware platform name if they are unknown.
14540
14541 @item -i
14542 @itemx --hardware-platform
14543 @opindex -i
14544 @opindex --hardware-platform
14545 @cindex implementation, hardware
14546 @cindex hardware platform
14547 @cindex platform, hardware
14548 Print the hardware platform name
14549 (sometimes called the hardware implementation).
14550 Print @samp{unknown} if the kernel does not make this information
14551 easily available, as is the case with Linux kernels.
14552
14553 @item -m
14554 @itemx --machine
14555 @opindex -m
14556 @opindex --machine
14557 @cindex machine type
14558 @cindex hardware class
14559 @cindex hardware type
14560 Print the machine hardware name (sometimes called the hardware class
14561 or hardware type).
14562
14563 @item -n
14564 @itemx --nodename
14565 @opindex -n
14566 @opindex --nodename
14567 @cindex hostname
14568 @cindex node name
14569 @cindex network node name
14570 Print the network node hostname.
14571
14572 @item -p
14573 @itemx --processor
14574 @opindex -p
14575 @opindex --processor
14576 @cindex host processor type
14577 Print the processor type (sometimes called the instruction set
14578 architecture or ISA).
14579 Print @samp{unknown} if the kernel does not make this information
14580 easily available, as is the case with Linux kernels.
14581
14582 @item -o
14583 @itemx --operating-system
14584 @opindex -o
14585 @opindex --operating-system
14586 @cindex operating system name
14587 Print the name of the operating system.
14588
14589 @item -r
14590 @itemx --kernel-release
14591 @opindex -r
14592 @opindex --kernel-release
14593 @cindex kernel release
14594 @cindex release of kernel
14595 Print the kernel release.
14596
14597 @item -s
14598 @itemx --kernel-name
14599 @opindex -s
14600 @opindex --kernel-name
14601 @cindex kernel name
14602 @cindex name of kernel
14603 Print the kernel name.
14604 @acronym{POSIX} 1003.1-2001 (@pxref{Standards conformance}) calls this
14605 ``the implementation of the operating system'', because the
14606 @acronym{POSIX} specification itself has no notion of ``kernel''.
14607 The kernel name might be the same as the operating system name printed
14608 by the @option{-o} or @option{--operating-system} option, but it might
14609 differ.  Some operating systems (e.g., FreeBSD, HP-UX) have the same
14610 name as their underlying kernels; others (e.g., GNU/Linux, Solaris)
14611 do not.
14612
14613 @item -v
14614 @itemx --kernel-version
14615 @opindex -v
14616 @opindex --kernel-version
14617 @cindex kernel version
14618 @cindex version of kernel
14619 Print the kernel version.
14620
14621 @end table
14622
14623 @exitstatus
14624
14625
14626 @node hostname invocation
14627 @section @command{hostname}: Print or set system name
14628
14629 @pindex hostname
14630 @cindex setting the hostname
14631 @cindex printing the hostname
14632 @cindex system name, printing
14633 @cindex appropriate privileges
14634
14635 With no arguments, @command{hostname} prints the name of the current host
14636 system.  With one argument, it sets the current host name to the
14637 specified string.  You must have appropriate privileges to set the host
14638 name.  Synopsis:
14639
14640 @example
14641 hostname [@var{name}]
14642 @end example
14643
14644 The only options are @option{--help} and @option{--version}.  @xref{Common
14645 options}.
14646
14647 @exitstatus
14648
14649
14650 @node hostid invocation
14651 @section @command{hostid}: Print numeric host identifier
14652
14653 @pindex hostid
14654 @cindex printing the host identifier
14655
14656 @command{hostid} prints the numeric identifier of the current host
14657 in hexadecimal.  This command accepts no arguments.
14658 The only options are @option{--help} and @option{--version}.
14659 @xref{Common options}.
14660
14661 For example, here's what it prints on one system I use:
14662
14663 @example
14664 $ hostid
14665 1bac013d
14666 @end example
14667
14668 On that system, the 32-bit quantity happens to be closely
14669 related to the system's Internet address, but that isn't always
14670 the case.
14671
14672 @exitstatus
14673
14674 @node uptime invocation
14675 @section @command{uptime}: Print system uptime and load
14676
14677 @pindex uptime
14678 @cindex printing the system uptime and load
14679
14680 @command{uptime} prints the current time, the system's uptime, the
14681 number of logged-in users and the current load average.
14682
14683 If an argument is specified, it is used as the file to be read
14684 to discover how many users are logged in.  If no argument is
14685 specified, a system default is used (@command{uptime --help} indicates
14686 the default setting).
14687
14688 The only options are @option{--help} and @option{--version}.
14689 @xref{Common options}.
14690
14691 For example, here's what it prints right now on one system I use:
14692
14693 @example
14694 $ uptime
14695  14:07  up   3:35,  3 users,  load average: 1.39, 1.15, 1.04
14696 @end example
14697
14698 The precise method of calculation of load average varies somewhat
14699 between systems.  Some systems calculate it as the average number of
14700 runnable processes over the last 1, 5 and 15 minutes, but some systems
14701 also include processes in the uninterruptible sleep state (that is,
14702 those processes which are waiting for disk I/O).  The Linux kernel
14703 includes uninterruptible processes.
14704
14705 @node SELinux context
14706 @chapter SELinux context
14707
14708 @cindex SELinux context
14709 @cindex SELinux, context
14710 @cindex commands for SELinux context
14711
14712 This section describes commands for operations with SELinux
14713 contexts.
14714
14715 @menu
14716 * chcon invocation::            Change SELinux context of file
14717 * runcon invocation::           Run a command in specified SELinux context
14718 @end menu
14719
14720 @node chcon invocation
14721 @section @command{chcon}: Change SELinux context of file
14722
14723 @pindex chcon
14724 @cindex changing security context
14725 @cindex change SELinux context
14726
14727 @command{chcon} changes the SELinux security context of the selected files.
14728 Synopses:
14729
14730 @smallexample
14731 chcon [@var{option}]@dots{} @var{context} @var{file}@dots{}
14732 chcon [@var{option}]@dots{} [-u @var{user}] [-r @var{role}] [-l @var{range}]@c
14733  [-t @var{type}] @var{file}@dots{}
14734 chcon [@var{option}]@dots{} --reference=@var{rfile} @var{file}@dots{}
14735 @end smallexample
14736
14737 Change the SELinux security context of each @var{file} to @var{context}.
14738 With @option{--reference}, change the security context of each @var{file}
14739 to that of @var{rfile}.
14740
14741 The program accepts the following options.  Also see @ref{Common options}.
14742
14743 @table @samp
14744
14745 @item -h
14746 @itemx --no-dereference
14747 @opindex -h
14748 @opindex --no-dereference
14749 @cindex no dereference
14750 Affect symbolic links instead of any referenced file.
14751
14752 @item --reference=@var{rfile}
14753 @opindex --reference
14754 @cindex reference file
14755 Use @var{rfile}'s security context rather than specifying a @var{context} value.
14756
14757 @item -R
14758 @itemx --recursive
14759 @opindex -R
14760 @opindex --recursive
14761 Operate on files and directories recursively.
14762
14763 @choptH
14764 @xref{Traversing symlinks}.
14765
14766 @choptL
14767 @xref{Traversing symlinks}.
14768
14769 @choptP
14770 @xref{Traversing symlinks}.
14771
14772 @item -v
14773 @itemx --verbose
14774 @opindex -v
14775 @opindex --verbose
14776 @cindex diagnostic
14777 Output a diagnostic for every file processed.
14778
14779 @item -u @var{user}
14780 @itemx --user=@var{user}
14781 @opindex -u
14782 @opindex --user
14783 Set user @var{user} in the target security context.
14784
14785 @item -r @var{role}
14786 @itemx --role=@var{role}
14787 @opindex -r
14788 @opindex --role
14789 Set role @var{role} in the target security context.
14790
14791 @item -t @var{type}
14792 @itemx --type=@var{type}
14793 @opindex -t
14794 @opindex --type
14795 Set type @var{type} in the target security context.
14796
14797 @item -l @var{range}
14798 @itemx --range=@var{range}
14799 @opindex -l
14800 @opindex --range
14801 Set range @var{range} in the target security context.
14802
14803 @end table
14804
14805 @exitstatus
14806
14807 @node runcon invocation
14808 @section @command{runcon}: Run a command in specified SELinux context
14809
14810 @pindex runcon
14811 @cindex run with security context
14812
14813
14814 @command{runcon} runs file in specified SELinux security context.
14815
14816 Synopses:
14817 @smallexample
14818 runcon @var{context} @var{command} [@var{args}]
14819 runcon [ -c ] [-u @var{user}] [-r @var{role}] [-t @var{type}]@c
14820  [-l @var{range}] @var{command} [@var{args}]
14821 @end smallexample
14822
14823 Run @var{command} with completely-specified @var{context}, or with
14824 current or transitioned security context modified by one or more of @var{level},
14825 @var{role}, @var{type} and @var{user}.
14826
14827 If none of @option{-c}, @option{-t}, @option{-u}, @option{-r}, or @option{-l}
14828 is specified, the first argument is used as the complete context.
14829 Any additional arguments after @var{command}
14830 are interpreted as arguments to the command.
14831
14832 With neither @var{context} nor @var{command}, print the current
14833 security context.
14834
14835 The program accepts the following options.  Also see @ref{Common options}.
14836
14837 @table @samp
14838
14839 @item -c
14840 @itemx --compute
14841 @opindex -c
14842 @opindex --compute
14843 Compute process transition context before modifying.
14844
14845 @item -u @var{user}
14846 @itemx --user=@var{user}
14847 @opindex -u
14848 @opindex --user
14849 Set user @var{user} in the target security context.
14850
14851 @item -r @var{role}
14852 @itemx --role=@var{role}
14853 @opindex -r
14854 @opindex --role
14855 Set role @var{role} in the target security context.
14856
14857 @item -t @var{type}
14858 @itemx --type=@var{type}
14859 @opindex -t
14860 @opindex --type
14861 Set type @var{type} in the target security context.
14862
14863 @item -l @var{range}
14864 @itemx --range=@var{range}
14865 @opindex -l
14866 @opindex --range
14867 Set range @var{range} in the target security context.
14868
14869 @end table
14870
14871 @cindex exit status of @command{runcon}
14872 Exit status:
14873
14874 @display
14875 126 if @var{command} is found but cannot be invoked
14876 127 if @command{runcon} itself fails or if @var{command} cannot be found
14877 the exit status of @var{command} otherwise
14878 @end display
14879
14880 @node Modified command invocation
14881 @chapter Modified command invocation
14882
14883 @cindex modified command invocation
14884 @cindex invocation of commands, modified
14885 @cindex commands for invoking other commands
14886
14887 This section describes commands that run other commands in some context
14888 different than the current one: a modified environment, as a different
14889 user, etc.
14890
14891 @menu
14892 * chroot invocation::           Modify the root directory.
14893 * env invocation::              Modify environment variables.
14894 * nice invocation::             Modify niceness.
14895 * nohup invocation::            Immunize to hangups.
14896 * stdbuf invocation::           Modify buffering of standard streams.
14897 * su invocation::               Modify user and group ID.
14898 * timeout invocation::          Run with time limit.
14899 @end menu
14900
14901
14902 @node chroot invocation
14903 @section @command{chroot}: Run a command with a different root directory
14904
14905 @pindex chroot
14906 @cindex running a program in a specified root directory
14907 @cindex root directory, running a program in a specified
14908
14909 @command{chroot} runs a command with a specified root directory.
14910 On many systems, only the super-user can do this.@footnote{However,
14911 some systems (e.g., FreeBSD) can be configured to allow certain regular
14912 users to use the @code{chroot} system call, and hence to run this program.
14913 Also, on Cygwin, anyone can run the @command{chroot} command, because the
14914 underlying function is non-privileged due to lack of support in MS-Windows.}
14915 Synopses:
14916
14917 @example
14918 chroot @var{option} @var{newroot} [@var{command} [@var{args}]@dots{}]
14919 chroot @var{option}
14920 @end example
14921
14922 Ordinarily, file names are looked up starting at the root of the
14923 directory structure, i.e., @file{/}.  @command{chroot} changes the root to
14924 the directory @var{newroot} (which must exist) and then runs
14925 @var{command} with optional @var{args}.  If @var{command} is not
14926 specified, the default is the value of the @env{SHELL} environment
14927 variable or @command{/bin/sh} if not set, invoked with the @option{-i} option.
14928 @var{command} must not be a special built-in utility
14929 (@pxref{Special built-in utilities}).
14930
14931 The program accepts the following options.  Also see @ref{Common options}.
14932 Options must precede operands.
14933
14934 @table @samp
14935
14936 @itemx --userspec=@var{user}[:@var{group}]
14937 @opindex --userspec
14938 By default, @var{command} is run with the same credentials
14939 as the invoking process.
14940 Use this option to run it as a different @var{user} and/or with a
14941 different primary @var{group}.
14942
14943 @itemx --groups=@var{groups}
14944 @opindex --groups
14945 Use this option to specify the supplementary @var{groups} to be
14946 used by the new process.
14947 The items in the list (names or numeric IDs) must be separated by commas.
14948
14949 @end table
14950
14951 Here are a few tips to help avoid common problems in using chroot.
14952 To start with a simple example, make @var{command} refer to a statically
14953 linked binary.  If you were to use a dynamically linked executable, then
14954 you'd have to arrange to have the shared libraries in the right place under
14955 your new root directory.
14956
14957 For example, if you create a statically linked @command{ls} executable,
14958 and put it in @file{/tmp/empty}, you can run this command as root:
14959
14960 @example
14961 $ chroot /tmp/empty /ls -Rl /
14962 @end example
14963
14964 Then you'll see output like this:
14965
14966 @example
14967 /:
14968 total 1023
14969 -rwxr-xr-x 1 0 0 1041745 Aug 16 11:17 ls
14970 @end example
14971
14972 If you want to use a dynamically linked executable, say @command{bash},
14973 then first run @samp{ldd bash} to see what shared objects it needs.
14974 Then, in addition to copying the actual binary, also copy the listed
14975 files to the required positions under your intended new root directory.
14976 Finally, if the executable requires any other files (e.g., data, state,
14977 device files), copy them into place, too.
14978
14979 @cindex exit status of @command{chroot}
14980 Exit status:
14981
14982 @display
14983 125 if @command{chroot} itself fails
14984 126 if @var{command} is found but cannot be invoked
14985 127 if @var{command} cannot be found
14986 the exit status of @var{command} otherwise
14987 @end display
14988
14989
14990 @node env invocation
14991 @section @command{env}: Run a command in a modified environment
14992
14993 @pindex env
14994 @cindex environment, running a program in a modified
14995 @cindex modified environment, running a program in a
14996 @cindex running a program in a modified environment
14997
14998 @command{env} runs a command with a modified environment.  Synopses:
14999
15000 @example
15001 env [@var{option}]@dots{} [@var{name}=@var{value}]@dots{} @c
15002 [@var{command} [@var{args}]@dots{}]
15003 env
15004 @end example
15005
15006 Operands of the form @samp{@var{variable}=@var{value}} set
15007 the environment variable @var{variable} to value @var{value}.
15008 @var{value} may be empty (@samp{@var{variable}=}).  Setting a variable
15009 to an empty value is different from unsetting it.
15010 These operands are evaluated left-to-right, so if two operands
15011 mention the same variable the earlier is ignored.
15012
15013 Environment variable names can be empty, and can contain any
15014 characters other than @samp{=} and @acronym{ASCII} @sc{nul}.
15015 However, it is wise to limit yourself to names that
15016 consist solely of underscores, digits, and @acronym{ASCII} letters,
15017 and that begin with a non-digit, as applications like the shell do not
15018 work well with other names.
15019
15020 @vindex PATH
15021 The first operand that does not contain the character @samp{=}
15022 specifies the program to invoke; it is
15023 searched for according to the @env{PATH} environment variable.  Any
15024 remaining arguments are passed as arguments to that program.
15025 The program should not be a special built-in utility
15026 (@pxref{Special built-in utilities}).
15027
15028 Modifications to @env{PATH} take effect prior to searching for
15029 @var{command}.  Use caution when reducing @env{PATH}; behavior is
15030 not portable when @env{PATH} is undefined or omits key directories
15031 such as @file{/bin}.
15032
15033 In the rare case that a utility contains a @samp{=} in the name, the
15034 only way to disambiguate it from a variable assignment is to use an
15035 intermediate command for @var{command}, and pass the problematic
15036 program name via @var{args}.  For example, if @file{./prog=} is an
15037 executable in the current @env{PATH}:
15038
15039 @example
15040 env prog= true # runs 'true', with prog= in environment
15041 env ./prog= true # runs 'true', with ./prog= in environment
15042 env -- prog= true # runs 'true', with prog= in environment
15043 env sh -c '\prog= true' # runs 'prog=' with argument 'true'
15044 env sh -c 'exec "$@@"' sh prog= true # also runs 'prog='
15045 @end example
15046
15047 @cindex environment, printing
15048
15049 If no command name is specified following the environment
15050 specifications, the resulting environment is printed.  This is like
15051 specifying the @command{printenv} program.
15052
15053 For some examples, suppose the environment passed to @command{env}
15054 contains @samp{LOGNAME=rms}, @samp{EDITOR=emacs}, and
15055 @samp{PATH=.:/gnubin:/hacks}:
15056
15057 @itemize @bullet
15058
15059 @item
15060 Output the current environment.
15061 @example
15062 $ env | LC_ALL=C sort
15063 EDITOR=emacs
15064 LOGNAME=rms
15065 PATH=.:/gnubin:/hacks
15066 @end example
15067
15068 @item
15069 Run @command{foo} with a reduced environment, preserving only the
15070 original @env{PATH} to avoid problems in locating @command{foo}.
15071 @example
15072 env - PATH="$PATH" foo
15073 @end example
15074
15075 @item
15076 Run @command{foo} with the environment containing @samp{LOGNAME=rms},
15077 @samp{EDITOR=emacs}, and @samp{PATH=.:/gnubin:/hacks}, and guarantees
15078 that @command{foo} was found in the file system rather than as a shell
15079 built-in.
15080 @example
15081 env foo
15082 @end example
15083
15084 @item
15085 Run @command{nemacs} with the environment containing @samp{LOGNAME=foo},
15086 @samp{EDITOR=emacs}, @samp{PATH=.:/gnubin:/hacks}, and
15087 @samp{DISPLAY=gnu:0}.
15088 @example
15089 env DISPLAY=gnu:0 LOGNAME=foo nemacs
15090 @end example
15091
15092 @item
15093 Attempt to run the program @command{/energy/--} (as that is the only
15094 possible path search result); if the command exists, the environment
15095 will contain @samp{LOGNAME=rms} and @samp{PATH=/energy}, and the
15096 arguments will be @samp{e=mc2}, @samp{bar}, and @samp{baz}.
15097 @example
15098 env -u EDITOR PATH=/energy -- e=mc2 bar baz
15099 @end example
15100
15101 @end itemize
15102
15103
15104 The program accepts the following options.  Also see @ref{Common options}.
15105 Options must precede operands.
15106
15107 @table @samp
15108
15109 @optNull{env}
15110
15111 @item -u @var{name}
15112 @itemx --unset=@var{name}
15113 @opindex -u
15114 @opindex --unset
15115 Remove variable @var{name} from the environment, if it was in the
15116 environment.
15117
15118 @item -
15119 @itemx -i
15120 @itemx --ignore-environment
15121 @opindex -
15122 @opindex -i
15123 @opindex --ignore-environment
15124 Start with an empty environment, ignoring the inherited environment.
15125
15126 @end table
15127
15128 @cindex exit status of @command{env}
15129 Exit status:
15130
15131 @display
15132 0   if no @var{command} is specified and the environment is output
15133 125 if @command{env} itself fails
15134 126 if @var{command} is found but cannot be invoked
15135 127 if @var{command} cannot be found
15136 the exit status of @var{command} otherwise
15137 @end display
15138
15139
15140 @node nice invocation
15141 @section @command{nice}: Run a command with modified niceness
15142
15143 @pindex nice
15144 @cindex niceness
15145 @cindex scheduling, affecting
15146 @cindex appropriate privileges
15147
15148 @command{nice} prints or modifies a process's @dfn{niceness},
15149 a parameter that affects whether the process is scheduled favorably.
15150 Synopsis:
15151
15152 @example
15153 nice [@var{option}]@dots{} [@var{command} [@var{arg}]@dots{}]
15154 @end example
15155
15156 If no arguments are given, @command{nice} prints the current niceness.
15157 Otherwise, @command{nice} runs the given @var{command} with its
15158 niceness adjusted.  By default, its niceness is incremented by 10.
15159
15160 Niceness values range at least from @minus{}20 (process has high priority
15161 and gets more resources, thus slowing down other processes) through 19
15162 (process has lower priority and runs slowly itself, but has less impact
15163 on the speed of other running processes).  Some systems
15164 may have a wider range of nicenesses; conversely, other systems may
15165 enforce more restrictive limits.  An attempt to set the niceness
15166 outside the supported range is treated as an attempt to use the
15167 minimum or maximum supported value.
15168
15169 A niceness should not be confused with a scheduling priority, which
15170 lets applications determine the order in which threads are scheduled
15171 to run.  Unlike a priority, a niceness is merely advice to the
15172 scheduler, which the scheduler is free to ignore.  Also, as a point of
15173 terminology, @acronym{POSIX} defines the behavior of @command{nice} in
15174 terms of a @dfn{nice value}, which is the nonnegative difference
15175 between a niceness and the minimum niceness.  Though @command{nice}
15176 conforms to @acronym{POSIX}, its documentation and diagnostics use the
15177 term ``niceness'' for compatibility with historical practice.
15178
15179 @var{command} must not be a special built-in utility (@pxref{Special
15180 built-in utilities}).
15181
15182 @mayConflictWithShellBuiltIn{nice}
15183
15184 The program accepts the following option.  Also see @ref{Common options}.
15185 Options must precede operands.
15186
15187 @table @samp
15188 @item -n @var{adjustment}
15189 @itemx --adjustment=@var{adjustment}
15190 @opindex -n
15191 @opindex --adjustment
15192 Add @var{adjustment} instead of 10 to the command's niceness.  If
15193 @var{adjustment} is negative and you lack appropriate privileges,
15194 @command{nice} issues a warning but otherwise acts as if you specified
15195 a zero adjustment.
15196
15197 For compatibility @command{nice} also supports an obsolete
15198 option syntax @option{-@var{adjustment}}.  New scripts should use
15199 @option{-n @var{adjustment}} instead.
15200
15201 @end table
15202
15203 @cindex exit status of @command{nice}
15204 Exit status:
15205
15206 @display
15207 0   if no @var{command} is specified and the niceness is output
15208 125 if @command{nice} itself fails
15209 126 if @var{command} is found but cannot be invoked
15210 127 if @var{command} cannot be found
15211 the exit status of @var{command} otherwise
15212 @end display
15213
15214 It is sometimes useful to run a non-interactive program with reduced niceness.
15215
15216 @example
15217 $ nice factor 4611686018427387903
15218 @end example
15219
15220 Since @command{nice} prints the current niceness,
15221 you can invoke it through itself to demonstrate how it works.
15222
15223 The default behavior is to increase the niceness by @samp{10}:
15224
15225 @example
15226 $ nice
15227 0
15228 $ nice nice
15229 10
15230 $ nice -n 10 nice
15231 10
15232 @end example
15233
15234 The @var{adjustment} is relative to the current niceness.  In the
15235 next example, the first @command{nice} invocation runs the second one
15236 with niceness 10, and it in turn runs the final one with a niceness
15237 that is 3 more:
15238
15239 @example
15240 $ nice nice -n 3 nice
15241 13
15242 @end example
15243
15244 Specifying a niceness larger than the supported range
15245 is the same as specifying the maximum supported value:
15246
15247 @example
15248 $ nice -n 10000000000 nice
15249 19
15250 @end example
15251
15252 Only a privileged user may run a process with lower niceness:
15253
15254 @example
15255 $ nice -n -1 nice
15256 nice: cannot set niceness: Permission denied
15257 0
15258 $ sudo nice -n -1 nice
15259 -1
15260 @end example
15261
15262
15263 @node nohup invocation
15264 @section @command{nohup}: Run a command immune to hangups
15265
15266 @pindex nohup
15267 @cindex hangups, immunity to
15268 @cindex immunity to hangups
15269 @cindex logging out and continuing to run
15270
15271 @flindex nohup.out
15272 @command{nohup} runs the given @var{command} with hangup signals ignored,
15273 so that the command can continue running in the background after you log
15274 out.  Synopsis:
15275
15276 @example
15277 nohup @var{command} [@var{arg}]@dots{}
15278 @end example
15279
15280 If standard input is a terminal, it is redirected from
15281 @file{/dev/null} so that terminal sessions do not mistakenly consider
15282 the terminal to be used by the command.  This is a @acronym{GNU}
15283 extension; programs intended to be portable to non-@acronym{GNU} hosts
15284 should use @samp{nohup @var{command} [@var{arg}]@dots{} </dev/null}
15285 instead.
15286
15287 @flindex nohup.out
15288 If standard output is a terminal, the command's standard output is appended
15289 to the file @file{nohup.out}; if that cannot be written to, it is appended
15290 to the file @file{$HOME/nohup.out}; and if that cannot be written to, the
15291 command is not run.
15292 Any @file{nohup.out} or @file{$HOME/nohup.out} file created by
15293 @command{nohup} is made readable and writable only to the user,
15294 regardless of the current umask settings.
15295
15296 If standard error is a terminal, it is normally redirected to the same file
15297 descriptor as the (possibly-redirected) standard output.
15298 However, if standard output is closed, standard error terminal output
15299 is instead appended to the file @file{nohup.out} or
15300 @file{$HOME/nohup.out} as above.
15301
15302 To capture the command's output to a file other than @file{nohup.out}
15303 you can redirect it.  For example, to capture the output of
15304 @command{make}:
15305
15306 @example
15307 nohup make > make.log
15308 @end example
15309
15310 @command{nohup} does not automatically put the command it runs in the
15311 background; you must do that explicitly, by ending the command line
15312 with an @samp{&}.  Also, @command{nohup} does not alter the
15313 niceness of @var{command}; use @command{nice} for that,
15314 e.g., @samp{nohup nice @var{command}}.
15315
15316 @var{command} must not be a special built-in utility (@pxref{Special
15317 built-in utilities}).
15318
15319 The only options are @option{--help} and @option{--version}.  @xref{Common
15320 options}.  Options must precede operands.
15321
15322 @cindex exit status of @command{nohup}
15323 Exit status:
15324
15325 @display
15326 125 if @command{nohup} itself fails, and @env{POSIXLY_CORRECT} is not set
15327 126 if @var{command} is found but cannot be invoked
15328 127 if @var{command} cannot be found
15329 the exit status of @var{command} otherwise
15330 @end display
15331
15332 If @env{POSIXLY_CORRECT} is set, internal failures give status 127
15333 instead of 125.
15334
15335
15336 @node stdbuf invocation
15337 @section @command{stdbuf}: Run a command with modified I/O stream buffering
15338
15339 @pindex stdbuf
15340 @cindex standard streams, buffering
15341 @cindex line buffered
15342
15343 @command{stdbuf} allows one to modify the buffering operations of the
15344 three standard I/O streams associated with a program.  Synopsis:
15345
15346 @example
15347 stdbuf @var{option}@dots{} @var{command}
15348 @end example
15349
15350 Any additional @var{arg}s are passed as additional arguments to the
15351 @var{command}.
15352
15353 The program accepts the following options.  Also see @ref{Common options}.
15354
15355 @table @samp
15356
15357 @item -i @var{mode}
15358 @itemx --input=@var{mode}
15359 @opindex -i
15360 @opindex --input
15361 Adjust the standard input stream buffering.
15362
15363 @item -o @var{mode}
15364 @itemx --output=@var{mode}
15365 @opindex -o
15366 @opindex --output
15367 Adjust the standard output stream buffering.
15368
15369 @item -e @var{mode}
15370 @itemx --error=@var{mode}
15371 @opindex -e
15372 @opindex --error
15373 Adjust the standard error stream buffering.
15374
15375 @end table
15376
15377 The @var{mode} can be specified as follows:
15378
15379 @table @samp
15380
15381 @item L
15382 Set the stream to line buffered mode.
15383 In this mode data is coalesced until a newline is output or
15384 input is read from any stream attached to a terminal device.
15385 This option is invalid with standard input.
15386
15387 @item 0
15388 Disable buffering of the selected stream.
15389 In this mode data is output immediately and only the
15390 amount of data requested is read from input.
15391
15392 @item @var{size}
15393 Specify the size of the buffer to use in fully buffered mode.
15394 @multiplierSuffixesNoBlocks{size}
15395
15396 @end table
15397
15398 NOTE: If @var{command} adjusts the buffering of its standard streams
15399 (@command{tee} does for e.g.) then that will override corresponding settings
15400 changed by @command{stdbuf}.  Also some filters (like @command{dd} and
15401 @command{cat} etc.) don't use streams for I/O, and are thus unaffected
15402 by @command{stdbuf} settings.
15403
15404 @cindex exit status of @command{stdbuf}
15405 Exit status:
15406
15407 @display
15408 125 if @command{stdbuf} itself fails
15409 126 if @var{command} is found but cannot be invoked
15410 127 if @var{command} cannot be found
15411 the exit status of @var{command} otherwise
15412 @end display
15413
15414
15415 @node su invocation
15416 @section @command{su}: Run a command with substitute user and group ID
15417
15418 @pindex su
15419 @cindex substitute user and group IDs
15420 @cindex user ID, switching
15421 @cindex super-user, becoming
15422 @cindex root, becoming
15423
15424 @command{su} allows one user to temporarily become another user.  It runs a
15425 command (often an interactive shell) with the real and effective user
15426 ID, group ID, and supplemental groups of a given @var{user}.  Synopsis:
15427
15428 @example
15429 su [@var{option}]@dots{} [@var{user} [@var{arg}]@dots{}]
15430 @end example
15431
15432 @cindex passwd entry, and @command{su} shell
15433 @flindex /bin/sh
15434 @flindex /etc/passwd
15435 If no @var{user} is given, the default is @code{root}, the super-user.
15436 The shell to use is taken from @var{user}'s @code{passwd} entry, or
15437 @file{/bin/sh} if none is specified there.  If @var{user} has a
15438 password, @command{su} prompts for the password unless run by a user with
15439 effective user ID of zero (the super-user).
15440
15441 @vindex HOME
15442 @vindex SHELL
15443 @vindex USER
15444 @vindex LOGNAME
15445 @cindex login shell
15446 By default, @command{su} does not change the current directory.
15447 It sets the environment variables @env{HOME} and @env{SHELL}
15448 from the password entry for @var{user}, and if @var{user} is not
15449 the super-user, sets @env{USER} and @env{LOGNAME} to @var{user}.
15450 By default, the shell is not a login shell.
15451
15452 Any additional @var{arg}s are passed as additional arguments to the
15453 shell.
15454
15455 @cindex @option{-su}
15456 GNU @command{su} does not treat @file{/bin/sh} or any other shells specially
15457 (e.g., by setting @code{argv[0]} to @option{-su}, passing @option{-c} only
15458 to certain shells, etc.).
15459
15460 @findex syslog
15461 @command{su} can optionally be compiled to use @code{syslog} to report
15462 failed, and optionally successful, @command{su} attempts.  (If the system
15463 supports @code{syslog}.)  However, GNU @command{su} does not check if the
15464 user is a member of the @code{wheel} group; see below.
15465
15466 The program accepts the following options.  Also see @ref{Common options}.
15467
15468 @table @samp
15469 @item -c @var{command}
15470 @itemx --command=@var{command}
15471 @opindex -c
15472 @opindex --command
15473 Pass @var{command}, a single command line to run, to the shell with
15474 a @option{-c} option instead of starting an interactive shell.
15475
15476 @item -f
15477 @itemx --fast
15478 @opindex -f
15479 @opindex --fast
15480 @flindex .cshrc
15481 @cindex file name pattern expansion, disabled
15482 @cindex globbing, disabled
15483 Pass the @option{-f} option to the shell.  This probably only makes sense
15484 if the shell run is @command{csh} or @command{tcsh}, for which the @option{-f}
15485 option prevents reading the startup file (@file{.cshrc}).  With
15486 Bourne-like shells, the @option{-f} option disables file name pattern
15487 expansion (globbing), which is not likely to be useful.
15488
15489 @item -
15490 @itemx -l
15491 @itemx --login
15492 @opindex -
15493 @opindex -l
15494 @opindex --login
15495 @c other variables already indexed above
15496 @vindex TERM
15497 @vindex PATH
15498 @cindex login shell, creating
15499 Make the shell a login shell.  This means the following.  Unset all
15500 environment variables except @env{TERM}, @env{HOME}, and @env{SHELL}
15501 (which are set as described above), and @env{USER} and @env{LOGNAME}
15502 (which are set, even for the super-user, as described above), and set
15503 @env{PATH} to a compiled-in default value.  Change to @var{user}'s home
15504 directory.  Prepend @samp{-} to the shell's name, intended to make it
15505 read its login startup file(s).
15506
15507 @item -m
15508 @itemx -p
15509 @itemx --preserve-environment
15510 @opindex -m
15511 @opindex -p
15512 @opindex --preserve-environment
15513 @cindex environment, preserving
15514 @flindex /etc/shells
15515 @cindex restricted shell
15516 Do not change the environment variables @env{HOME}, @env{USER},
15517 @env{LOGNAME}, or @env{SHELL}.  Run the shell given in the environment
15518 variable @env{SHELL} instead of the shell from @var{user}'s passwd
15519 entry, unless the user running @command{su} is not the super-user and
15520 @var{user}'s shell is restricted.  A @dfn{restricted shell} is one that
15521 is not listed in the file @file{/etc/shells}, or in a compiled-in list
15522 if that file does not exist.  Parts of what this option does can be
15523 overridden by @option{--login} and @option{--shell}.
15524
15525 @item -s @var{shell}
15526 @itemx --shell=@var{shell}
15527 @opindex -s
15528 @opindex --shell
15529 Run @var{shell} instead of the shell from @var{user}'s passwd entry,
15530 unless the user running @command{su} is not the super-user and @var{user}'s
15531 shell is restricted (see @option{-m} just above).
15532
15533 @end table
15534
15535 @cindex exit status of @command{su}
15536 Exit status:
15537
15538 @display
15539 125 if @command{su} itself fails
15540 126 if subshell is found but cannot be invoked
15541 127 if subshell cannot be found
15542 the exit status of the subshell otherwise
15543 @end display
15544
15545 @cindex wheel group, not supported
15546 @cindex group wheel, not supported
15547 @cindex fascism
15548 @subsection Why GNU @command{su} does not support the @samp{wheel} group
15549
15550 (This section is by Richard Stallman.)
15551
15552 @cindex Twenex
15553 @cindex MIT AI lab
15554 Sometimes a few of the users try to hold total power over all the
15555 rest.  For example, in 1984, a few users at the MIT AI lab decided to
15556 seize power by changing the operator password on the Twenex system and
15557 keeping it secret from everyone else.  (I was able to thwart this coup
15558 and give power back to the users by patching the kernel, but I
15559 wouldn't know how to do that in Unix.)
15560
15561 However, occasionally the rulers do tell someone.  Under the usual
15562 @command{su} mechanism, once someone learns the root password who
15563 sympathizes with the ordinary users, he or she can tell the rest.  The
15564 ``wheel group'' feature would make this impossible, and thus cement the
15565 power of the rulers.
15566
15567 I'm on the side of the masses, not that of the rulers.  If you are
15568 used to supporting the bosses and sysadmins in whatever they do, you
15569 might find this idea strange at first.
15570
15571
15572 @node timeout invocation
15573 @section @command{timeout}: Run a command with a time limit
15574
15575 @pindex timeout
15576 @cindex time limit
15577 @cindex run commands with bounded time
15578
15579 @command{timeout} runs the given @var{command} and kills it if it is
15580 still running after the specified time interval.  Synopsis:
15581
15582 @example
15583 timeout [@var{option}] @var{duration} @var{command} [@var{arg}]@dots{}
15584 @end example
15585
15586 @var{command} must not be a special built-in utility (@pxref{Special
15587 built-in utilities}).
15588
15589 The program accepts the following options.  Also see @ref{Common options}.
15590 Options must precede operands.
15591
15592 @table @samp
15593 @item -k @var{duration}
15594 @itemx --kill-after=@var{duration}
15595 @opindex -k
15596 @opindex --kill-after
15597 Ensure the monitored @var{command} is killed by also sending a @samp{KILL}
15598 signal, after the specified @var{duration}.  Without this option, if the
15599 selected signal proves not to be fatal, @command{timeout} does not kill
15600 the @var{command}.
15601
15602 @item -s @var{signal}
15603 @itemx --signal=@var{signal}
15604 @opindex -s
15605 @opindex --signal
15606 Send this @var{signal} to @var{command} on timeout, rather than the
15607 default @samp{TERM} signal. @var{signal} may be a name like @samp{HUP}
15608 or a number. Also see @xref{Signal specifications}.
15609 @end table
15610
15611 @cindex time units
15612 @var{duration} is an integer followed by an optional unit:
15613 @display
15614 @samp{s} for seconds (the default)
15615 @samp{m} for minutes
15616 @samp{h} for hours
15617 @samp{d} for days
15618 @end display
15619 A duration of 0 disables the associated timeout.
15620
15621 @cindex exit status of @command{timeout}
15622 Exit status:
15623
15624 @display
15625 124 if @var{command} times out
15626 125 if @command{timeout} itself fails
15627 126 if @var{command} is found but cannot be invoked
15628 127 if @var{command} cannot be found
15629 the exit status of @var{command} otherwise
15630 @end display
15631
15632
15633 @node Process control
15634 @chapter Process control
15635
15636 @cindex processes, commands for controlling
15637 @cindex commands for controlling processes
15638
15639 @menu
15640 * kill invocation::             Sending a signal to processes.
15641 @end menu
15642
15643
15644 @node kill invocation
15645 @section @command{kill}: Send a signal to processes
15646
15647 @pindex kill
15648 @cindex send a signal to processes
15649
15650 The @command{kill} command sends a signal to processes, causing them
15651 to terminate or otherwise act upon receiving the signal in some way.
15652 Alternatively, it lists information about signals.  Synopses:
15653
15654 @example
15655 kill [-s @var{signal} | --signal @var{signal} | -@var{signal}] @var{pid}@dots{}
15656 kill [-l | --list | -t | --table] [@var{signal}]@dots{}
15657 @end example
15658
15659 @mayConflictWithShellBuiltIn{kill}
15660
15661 The first form of the @command{kill} command sends a signal to all
15662 @var{pid} arguments.  The default signal to send if none is specified
15663 is @samp{TERM}.  The special signal number @samp{0} does not denote a
15664 valid signal, but can be used to test whether the @var{pid} arguments
15665 specify processes to which a signal could be sent.
15666
15667 If @var{pid} is positive, the signal is sent to the process with the
15668 process ID @var{pid}.  If @var{pid} is zero, the signal is sent to all
15669 processes in the process group of the current process.  If @var{pid}
15670 is @minus{}1, the signal is sent to all processes for which the user has
15671 permission to send a signal.  If @var{pid} is less than @minus{}1, the signal
15672 is sent to all processes in the process group that equals the absolute
15673 value of @var{pid}.
15674
15675 If @var{pid} is not positive, a system-dependent set of system
15676 processes is excluded from the list of processes to which the signal
15677 is sent.
15678
15679 If a negative @var{pid} argument is desired as the first one, it
15680 should be preceded by @option{--}.  However, as a common extension to
15681 @acronym{POSIX}, @option{--} is not required with @samp{kill
15682 -@var{signal} -@var{pid}}.  The following commands are equivalent:
15683
15684 @example
15685 kill -15 -1
15686 kill -TERM -1
15687 kill -s TERM -- -1
15688 kill -- -1
15689 @end example
15690
15691 The first form of the @command{kill} command succeeds if every @var{pid}
15692 argument specifies at least one process that the signal was sent to.
15693
15694 The second form of the @command{kill} command lists signal information.
15695 Either the @option{-l} or @option{--list} option, or the @option{-t}
15696 or @option{--table} option must be specified.  Without any
15697 @var{signal} argument, all supported signals are listed.  The output
15698 of @option{-l} or @option{--list} is a list of the signal names, one
15699 per line; if @var{signal} is already a name, the signal number is
15700 printed instead.  The output of @option{-t} or @option{--table} is a
15701 table of signal numbers, names, and descriptions.  This form of the
15702 @command{kill} command succeeds if all @var{signal} arguments are valid
15703 and if there is no output error.
15704
15705 The @command{kill} command also supports the @option{--help} and
15706 @option{--version} options.  @xref{Common options}.
15707
15708 A @var{signal} may be a signal name like @samp{HUP}, or a signal
15709 number like @samp{1}, or an exit status of a process terminated by the
15710 signal.  A signal name can be given in canonical form or prefixed by
15711 @samp{SIG}.  The case of the letters is ignored, except for the
15712 @option{-@var{signal}} option which must use upper case to avoid
15713 ambiguity with lower case option letters.  For a list of supported
15714 signal names and numbers see @xref{Signal specifications}.
15715
15716 @node Delaying
15717 @chapter Delaying
15718
15719 @cindex delaying commands
15720 @cindex commands for delaying
15721
15722 @c Perhaps @command{wait} or other commands should be described here also?
15723
15724 @menu
15725 * sleep invocation::            Delay for a specified time.
15726 @end menu
15727
15728
15729 @node sleep invocation
15730 @section @command{sleep}: Delay for a specified time
15731
15732 @pindex sleep
15733 @cindex delay for a specified time
15734
15735 @command{sleep} pauses for an amount of time specified by the sum of
15736 the values of the command line arguments.
15737 Synopsis:
15738
15739 @example
15740 sleep @var{number}[smhd]@dots{}
15741 @end example
15742
15743 @cindex time units
15744 Each argument is a number followed by an optional unit; the default
15745 is seconds.  The units are:
15746
15747 @table @samp
15748 @item s
15749 seconds
15750 @item m
15751 minutes
15752 @item h
15753 hours
15754 @item d
15755 days
15756 @end table
15757
15758 Historical implementations of @command{sleep} have required that
15759 @var{number} be an integer, and only accepted a single argument
15760 without a suffix.  However, GNU @command{sleep} accepts
15761 arbitrary floating point numbers.  @xref{Floating point}.
15762
15763 The only options are @option{--help} and @option{--version}.  @xref{Common
15764 options}.
15765
15766 @c sleep is a shell built-in at least with Solaris 11's /bin/sh
15767 @mayConflictWithShellBuiltIn{sleep}
15768
15769 @exitstatus
15770
15771
15772 @node Numeric operations
15773 @chapter Numeric operations
15774
15775 @cindex numeric operations
15776 These programs do numerically-related operations.
15777
15778 @menu
15779 * factor invocation::              Show factors of numbers.
15780 * seq invocation::                 Print sequences of numbers.
15781 @end menu
15782
15783
15784 @node factor invocation
15785 @section @command{factor}: Print prime factors
15786
15787 @pindex factor
15788 @cindex prime factors
15789
15790 @command{factor} prints prime factors.  Synopses:
15791
15792 @example
15793 factor [@var{number}]@dots{}
15794 factor @var{option}
15795 @end example
15796
15797 If no @var{number} is specified on the command line, @command{factor} reads
15798 numbers from standard input, delimited by newlines, tabs, or spaces.
15799
15800 The @command{factor} command supports only a small number of options:
15801
15802 @table @samp
15803 @item --help
15804 Print a short help on standard output, then exit without further
15805 processing.
15806
15807 @item --version
15808 Print the program version on standard output, then exit without further
15809 processing.
15810 @end table
15811
15812 Factoring the product of the eighth and ninth Mersenne primes
15813 takes about 30 milliseconds of CPU time on a 2.2 GHz Athlon.
15814
15815 @example
15816 M8=`echo 2^31-1|bc` ; M9=`echo 2^61-1|bc`
15817 /usr/bin/time -f '%U' factor $(echo "$M8 * $M9" | bc)
15818 4951760154835678088235319297: 2147483647 2305843009213693951
15819 0.03
15820 @end example
15821
15822 Similarly, factoring the eighth Fermat number @math{2^{256}+1} takes
15823 about 20 seconds on the same machine.
15824
15825 Factoring large numbers is, in general, hard.  The Pollard Rho
15826 algorithm used by @command{factor} is particularly effective for
15827 numbers with relatively small factors.  If you wish to factor large
15828 numbers which do not have small factors (for example, numbers which
15829 are the product of two large primes), other methods are far better.
15830
15831 If @command{factor} is built without using GNU MP, only
15832 single-precision arithmetic is available, and so large numbers
15833 (typically @math{2^{64}} and above) will not be supported.  The single-precision
15834 code uses an algorithm which is designed for factoring smaller
15835 numbers.
15836
15837 @exitstatus
15838
15839
15840 @node seq invocation
15841 @section @command{seq}: Print numeric sequences
15842
15843 @pindex seq
15844 @cindex numeric sequences
15845 @cindex sequence of numbers
15846
15847 @command{seq} prints a sequence of numbers to standard output.  Synopses:
15848
15849 @example
15850 seq [@var{option}]@dots{} @var{last}
15851 seq [@var{option}]@dots{} @var{first} @var{last}
15852 seq [@var{option}]@dots{} @var{first} @var{increment} @var{last}
15853 @end example
15854
15855 @command{seq} prints the numbers from @var{first} to @var{last} by
15856 @var{increment}.  By default, each number is printed on a separate line.
15857 When @var{increment} is not specified, it defaults to @samp{1},
15858 even when @var{first} is larger than @var{last}.
15859 @var{first} also defaults to @samp{1}.  So @code{seq 1} prints
15860 @samp{1}, but @code{seq 0} and @code{seq 10 5} produce no output.
15861 Floating-point numbers may be specified.  @xref{Floating point}.
15862
15863 The program accepts the following options.  Also see @ref{Common options}.
15864 Options must precede operands.
15865
15866 @table @samp
15867 @item -f @var{format}
15868 @itemx --format=@var{format}
15869 @opindex -f @var{format}
15870 @opindex --format=@var{format}
15871 @cindex formatting of numbers in @command{seq}
15872 Print all numbers using @var{format}.
15873 @var{format} must contain exactly one of the @samp{printf}-style
15874 floating point conversion specifications @samp{%a}, @samp{%e},
15875 @samp{%f}, @samp{%g}, @samp{%A}, @samp{%E}, @samp{%F}, @samp{%G}.
15876 The @samp{%} may be followed by zero or more flags taken from the set
15877 @samp{-+#0 '}, then an optional width containing one or more digits,
15878 then an optional precision consisting of a @samp{.} followed by zero
15879 or more digits.  @var{format} may also contain any number of @samp{%%}
15880 conversion specifications.  All conversion specifications have the
15881 same meaning as with @samp{printf}.
15882
15883 The default format is derived from @var{first}, @var{step}, and
15884 @var{last}.  If these all use a fixed point decimal representation,
15885 the default format is @samp{%.@var{p}f}, where @var{p} is the minimum
15886 precision that can represent the output numbers exactly.  Otherwise,
15887 the default format is @samp{%g}.
15888
15889 @item -s @var{string}
15890 @itemx --separator=@var{string}
15891 @cindex separator for numbers in @command{seq}
15892 Separate numbers with @var{string}; default is a newline.
15893 The output always terminates with a newline.
15894
15895 @item -w
15896 @itemx --equal-width
15897 Print all numbers with the same width, by padding with leading zeros.
15898 @var{first}, @var{step}, and @var{last} should all use a fixed point
15899 decimal representation.
15900 (To have other kinds of padding, use @option{--format}).
15901
15902 @end table
15903
15904 You can get finer-grained control over output with @option{-f}:
15905
15906 @example
15907 $ seq -f '(%9.2E)' -9e5 1.1e6 1.3e6
15908 (-9.00E+05)
15909 ( 2.00E+05)
15910 ( 1.30E+06)
15911 @end example
15912
15913 If you want hexadecimal integer output, you can use @command{printf}
15914 to perform the conversion:
15915
15916 @example
15917 $ printf '%x\n' `seq 1048575 1024 1050623`
15918 fffff
15919 1003ff
15920 1007ff
15921 @end example
15922
15923 For very long lists of numbers, use xargs to avoid
15924 system limitations on the length of an argument list:
15925
15926 @example
15927 $ seq 1000000 | xargs printf '%x\n' | tail -n 3
15928 f423e
15929 f423f
15930 f4240
15931 @end example
15932
15933 To generate octal output, use the printf @code{%o} format instead
15934 of @code{%x}.
15935
15936 On most systems, seq can produce whole-number output for values up to
15937 at least @math{2^{53}}.  Larger integers are approximated.  The details
15938 differ depending on your floating-point implementation.
15939 @xref{Floating point}.  A common
15940 case is that @command{seq} works with integers through @math{2^{64}},
15941 and larger integers may not be numerically correct:
15942
15943 @example
15944 $ seq 18446744073709551616 1 18446744073709551618
15945 18446744073709551616
15946 18446744073709551616
15947 18446744073709551618
15948 @end example
15949
15950 Be careful when using @command{seq} with outlandish values: otherwise
15951 you may see surprising results, as @command{seq} uses floating point
15952 internally.  For example, on the x86 platform, where the internal
15953 representation uses a 64-bit fraction, the command:
15954
15955 @example
15956 seq 1 0.0000000000000000001 1.0000000000000000009
15957 @end example
15958
15959 outputs 1.0000000000000000007 twice and skips 1.0000000000000000008.
15960
15961 @exitstatus
15962
15963
15964 @node File permissions
15965 @chapter File permissions
15966 @include perm.texi
15967
15968 @include parse-datetime.texi
15969
15970 @c              What's GNU?
15971 @c              Arnold Robbins
15972 @node Opening the software toolbox
15973 @chapter Opening the Software Toolbox
15974
15975 An earlier version of this chapter appeared in
15976 @uref{http://www.linuxjournal.com/article.php?sid=2762, the
15977 @cite{What's GNU?} column of @cite{Linux Journal}, 2 (June, 1994)}.
15978 It was written by Arnold Robbins.
15979
15980 @menu
15981 * Toolbox introduction::        Toolbox introduction
15982 * I/O redirection::             I/O redirection
15983 * The who command::             The @command{who} command
15984 * The cut command::             The @command{cut} command
15985 * The sort command::            The @command{sort} command
15986 * The uniq command::            The @command{uniq} command
15987 * Putting the tools together::  Putting the tools together
15988 @end menu
15989
15990
15991 @node Toolbox introduction
15992 @unnumberedsec Toolbox Introduction
15993
15994 This month's column is only peripherally related to the GNU Project, in
15995 that it describes a number of the GNU tools on your GNU/Linux system
15996 and how they
15997 might be used.  What it's really about is the ``Software Tools'' philosophy
15998 of program development and usage.
15999
16000 The software tools philosophy was an important and integral concept
16001 in the initial design and development of Unix (of which Linux and GNU are
16002 essentially clones).  Unfortunately, in the modern day press of
16003 Internetworking and flashy GUIs, it seems to have fallen by the
16004 wayside.  This is a shame, since it provides a powerful mental model
16005 for solving many kinds of problems.
16006
16007 Many people carry a Swiss Army knife around in their pants pockets (or
16008 purse).  A Swiss Army knife is a handy tool to have: it has several knife
16009 blades, a screwdriver, tweezers, toothpick, nail file, corkscrew, and perhaps
16010 a number of other things on it.  For the everyday, small miscellaneous jobs
16011 where you need a simple, general purpose tool, it's just the thing.
16012
16013 On the other hand, an experienced carpenter doesn't build a house using
16014 a Swiss Army knife.  Instead, he has a toolbox chock full of specialized
16015 tools---a saw, a hammer, a screwdriver, a plane, and so on.  And he knows
16016 exactly when and where to use each tool; you won't catch him hammering nails
16017 with the handle of his screwdriver.
16018
16019 The Unix developers at Bell Labs were all professional programmers and trained
16020 computer scientists.  They had found that while a one-size-fits-all program
16021 might appeal to a user because there's only one program to use, in practice
16022 such programs are
16023
16024 @enumerate a
16025 @item
16026 difficult to write,
16027
16028 @item
16029 difficult to maintain and
16030 debug, and
16031
16032 @item
16033 difficult to extend to meet new situations.
16034 @end enumerate
16035
16036 Instead, they felt that programs should be specialized tools.  In short, each
16037 program ``should do one thing well.''  No more and no less.  Such programs are
16038 simpler to design, write, and get right---they only do one thing.
16039
16040 Furthermore, they found that with the right machinery for hooking programs
16041 together, that the whole was greater than the sum of the parts.  By combining
16042 several special purpose programs, you could accomplish a specific task
16043 that none of the programs was designed for, and accomplish it much more
16044 quickly and easily than if you had to write a special purpose program.
16045 We will see some (classic) examples of this further on in the column.
16046 (An important additional point was that, if necessary, take a detour
16047 and build any software tools you may need first, if you don't already
16048 have something appropriate in the toolbox.)
16049
16050 @node I/O redirection
16051 @unnumberedsec I/O Redirection
16052
16053 Hopefully, you are familiar with the basics of I/O redirection in the
16054 shell, in particular the concepts of ``standard input,'' ``standard output,''
16055 and ``standard error''.  Briefly, ``standard input'' is a data source, where
16056 data comes from.  A program should not need to either know or care if the
16057 data source is a disk file, a keyboard, a magnetic tape, or even a punched
16058 card reader.  Similarly, ``standard output'' is a data sink, where data goes
16059 to.  The program should neither know nor care where this might be.
16060 Programs that only read their standard input, do something to the data,
16061 and then send it on, are called @dfn{filters}, by analogy to filters in a
16062 water pipeline.
16063
16064 With the Unix shell, it's very easy to set up data pipelines:
16065
16066 @smallexample
16067 program_to_create_data | filter1 | ... | filterN > final.pretty.data
16068 @end smallexample
16069
16070 We start out by creating the raw data; each filter applies some successive
16071 transformation to the data, until by the time it comes out of the pipeline,
16072 it is in the desired form.
16073
16074 This is fine and good for standard input and standard output.  Where does the
16075 standard error come in to play?  Well, think about @command{filter1} in
16076 the pipeline above.  What happens if it encounters an error in the data it
16077 sees?  If it writes an error message to standard output, it will just
16078 disappear down the pipeline into @command{filter2}'s input, and the
16079 user will probably never see it.  So programs need a place where they can send
16080 error messages so that the user will notice them.  This is standard error,
16081 and it is usually connected to your console or window, even if you have
16082 redirected standard output of your program away from your screen.
16083
16084 For filter programs to work together, the format of the data has to be
16085 agreed upon.  The most straightforward and easiest format to use is simply
16086 lines of text.  Unix data files are generally just streams of bytes, with
16087 lines delimited by the @acronym{ASCII} @sc{lf} (Line Feed) character,
16088 conventionally called a ``newline'' in the Unix literature.  (This is
16089 @code{'\n'} if you're a C programmer.)  This is the format used by all
16090 the traditional filtering programs.  (Many earlier operating systems
16091 had elaborate facilities and special purpose programs for managing
16092 binary data.  Unix has always shied away from such things, under the
16093 philosophy that it's easiest to simply be able to view and edit your
16094 data with a text editor.)
16095
16096 OK, enough introduction.  Let's take a look at some of the tools, and then
16097 we'll see how to hook them together in interesting ways.   In the following
16098 discussion, we will only present those command line options that interest
16099 us.  As you should always do, double check your system documentation
16100 for the full story.
16101
16102 @node The who command
16103 @unnumberedsec The @command{who} Command
16104
16105 The first program is the @command{who} command.  By itself, it generates a
16106 list of the users who are currently logged in.  Although I'm writing
16107 this on a single-user system, we'll pretend that several people are
16108 logged in:
16109
16110 @example
16111 $ who
16112 @print{} arnold   console Jan 22 19:57
16113 @print{} miriam   ttyp0   Jan 23 14:19(:0.0)
16114 @print{} bill     ttyp1   Jan 21 09:32(:0.0)
16115 @print{} arnold   ttyp2   Jan 23 20:48(:0.0)
16116 @end example
16117
16118 Here, the @samp{$} is the usual shell prompt, at which I typed @samp{who}.
16119 There are three people logged in, and I am logged in twice.  On traditional
16120 Unix systems, user names are never more than eight characters long.  This
16121 little bit of trivia will be useful later.  The output of @command{who} is nice,
16122 but the data is not all that exciting.
16123
16124 @node The cut command
16125 @unnumberedsec The @command{cut} Command
16126
16127 The next program we'll look at is the @command{cut} command.  This program
16128 cuts out columns or fields of input data.  For example, we can tell it
16129 to print just the login name and full name from the @file{/etc/passwd}
16130 file.  The @file{/etc/passwd} file has seven fields, separated by
16131 colons:
16132
16133 @example
16134 arnold:xyzzy:2076:10:Arnold D. Robbins:/home/arnold:/bin/bash
16135 @end example
16136
16137 To get the first and fifth fields, we would use @command{cut} like this:
16138
16139 @example
16140 $ cut -d: -f1,5 /etc/passwd
16141 @print{} root:Operator
16142 @dots{}
16143 @print{} arnold:Arnold D. Robbins
16144 @print{} miriam:Miriam A. Robbins
16145 @dots{}
16146 @end example
16147
16148 With the @option{-c} option, @command{cut} will cut out specific characters
16149 (i.e., columns) in the input lines.  This is useful for input data
16150 that has fixed width fields, and does not have a field separator.  For
16151 example, list the Monday dates for the current month:
16152
16153 @c Is using cal ok?  Looked at gcal, but I don't like it.
16154 @example
16155 $ cal | cut -c 3-5
16156 @print{}Mo
16157 @print{}
16158 @print{}  6
16159 @print{} 13
16160 @print{} 20
16161 @print{} 27
16162 @end example
16163
16164 @node The sort command
16165 @unnumberedsec The @command{sort} Command
16166
16167 Next we'll look at the @command{sort} command.  This is one of the most
16168 powerful commands on a Unix-style system; one that you will often find
16169 yourself using when setting up fancy data plumbing.
16170
16171 The @command{sort}
16172 command reads and sorts each file named on the command line.  It then
16173 merges the sorted data and writes it to standard output.  It will read
16174 standard input if no files are given on the command line (thus
16175 making it into a filter).  The sort is based on the character collating
16176 sequence or based on user-supplied ordering criteria.
16177
16178
16179 @node The uniq command
16180 @unnumberedsec The @command{uniq} Command
16181
16182 Finally (at least for now), we'll look at the @command{uniq} program.  When
16183 sorting data, you will often end up with duplicate lines, lines that
16184 are identical.  Usually, all you need is one instance of each line.
16185 This is where @command{uniq} comes in.  The @command{uniq} program reads its
16186 standard input.  It prints only one
16187 copy of each repeated line.  It does have several options.  Later on,
16188 we'll use the @option{-c} option, which prints each unique line, preceded
16189 by a count of the number of times that line occurred in the input.
16190
16191
16192 @node Putting the tools together
16193 @unnumberedsec Putting the Tools Together
16194
16195 Now, let's suppose this is a large ISP server system with dozens of users
16196 logged in.  The management wants the system administrator to write a
16197 program that will
16198 generate a sorted list of logged in users.  Furthermore, even if a user
16199 is logged in multiple times, his or her name should only show up in the
16200 output once.
16201
16202 The administrator could sit down with the system documentation and write a C
16203 program that did this.  It would take perhaps a couple of hundred lines
16204 of code and about two hours to write it, test it, and debug it.
16205 However, knowing the software toolbox, the administrator can instead start out
16206 by generating just a list of logged on users:
16207
16208 @example
16209 $ who | cut -c1-8
16210 @print{} arnold
16211 @print{} miriam
16212 @print{} bill
16213 @print{} arnold
16214 @end example
16215
16216 Next, sort the list:
16217
16218 @example
16219 $ who | cut -c1-8 | sort
16220 @print{} arnold
16221 @print{} arnold
16222 @print{} bill
16223 @print{} miriam
16224 @end example
16225
16226 Finally, run the sorted list through @command{uniq}, to weed out duplicates:
16227
16228 @example
16229 $ who | cut -c1-8 | sort | uniq
16230 @print{} arnold
16231 @print{} bill
16232 @print{} miriam
16233 @end example
16234
16235 The @command{sort} command actually has a @option{-u} option that does what
16236 @command{uniq} does.  However, @command{uniq} has other uses for which one
16237 cannot substitute @samp{sort -u}.
16238
16239 The administrator puts this pipeline into a shell script, and makes it
16240 available for
16241 all the users on the system (@samp{#} is the system administrator,
16242 or @code{root}, prompt):
16243
16244 @example
16245 # cat > /usr/local/bin/listusers
16246 who | cut -c1-8 | sort | uniq
16247 ^D
16248 # chmod +x /usr/local/bin/listusers
16249 @end example
16250
16251 There are four major points to note here.  First, with just four
16252 programs, on one command line, the administrator was able to save about two
16253 hours worth of work.  Furthermore, the shell pipeline is just about as
16254 efficient as the C program would be, and it is much more efficient in
16255 terms of programmer time.  People time is much more expensive than
16256 computer time, and in our modern ``there's never enough time to do
16257 everything'' society, saving two hours of programmer time is no mean
16258 feat.
16259
16260 Second, it is also important to emphasize that with the
16261 @emph{combination} of the tools, it is possible to do a special
16262 purpose job never imagined by the authors of the individual programs.
16263
16264 Third, it is also valuable to build up your pipeline in stages, as we did here.
16265 This allows you to view the data at each stage in the pipeline, which helps
16266 you acquire the confidence that you are indeed using these tools correctly.
16267
16268 Finally, by bundling the pipeline in a shell script, other users can use
16269 your command, without having to remember the fancy plumbing you set up for
16270 them.  In terms of how you run them, shell scripts and compiled programs are
16271 indistinguishable.
16272
16273 After the previous warm-up exercise, we'll look at two additional, more
16274 complicated pipelines.  For them, we need to introduce two more tools.
16275
16276 The first is the @command{tr} command, which stands for ``transliterate.''
16277 The @command{tr} command works on a character-by-character basis, changing
16278 characters.  Normally it is used for things like mapping upper case to
16279 lower case:
16280
16281 @example
16282 $ echo ThIs ExAmPlE HaS MIXED case! | tr '[:upper:]' '[:lower:]'
16283 @print{} this example has mixed case!
16284 @end example
16285
16286 There are several options of interest:
16287
16288 @table @code
16289 @item -c
16290 work on the complement of the listed characters, i.e.,
16291 operations apply to characters not in the given set
16292
16293 @item -d
16294 delete characters in the first set from the output
16295
16296 @item -s
16297 squeeze repeated characters in the output into just one character.
16298 @end table
16299
16300 We will be using all three options in a moment.
16301
16302 The other command we'll look at is @command{comm}.  The @command{comm}
16303 command takes two sorted input files as input data, and prints out the
16304 files' lines in three columns.  The output columns are the data lines
16305 unique to the first file, the data lines unique to the second file, and
16306 the data lines that are common to both.  The @option{-1}, @option{-2}, and
16307 @option{-3} command line options @emph{omit} the respective columns.  (This is
16308 non-intuitive and takes a little getting used to.)  For example:
16309
16310 @example
16311 $ cat f1
16312 @print{} 11111
16313 @print{} 22222
16314 @print{} 33333
16315 @print{} 44444
16316 $ cat f2
16317 @print{} 00000
16318 @print{} 22222
16319 @print{} 33333
16320 @print{} 55555
16321 $ comm f1 f2
16322 @print{}         00000
16323 @print{} 11111
16324 @print{}                 22222
16325 @print{}                 33333
16326 @print{} 44444
16327 @print{}         55555
16328 @end example
16329
16330 The file name @file{-} tells @command{comm} to read standard input
16331 instead of a regular file.
16332
16333 Now we're ready to build a fancy pipeline.  The first application is a word
16334 frequency counter.  This helps an author determine if he or she is over-using
16335 certain words.
16336
16337 The first step is to change the case of all the letters in our input file
16338 to one case.  ``The'' and ``the'' are the same word when doing counting.
16339
16340 @example
16341 $ tr '[:upper:]' '[:lower:]' < whats.gnu | ...
16342 @end example
16343
16344 The next step is to get rid of punctuation.  Quoted words and unquoted words
16345 should be treated identically; it's easiest to just get the punctuation out of
16346 the way.
16347
16348 @smallexample
16349 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' | ...
16350 @end smallexample
16351
16352 The second @command{tr} command operates on the complement of the listed
16353 characters, which are all the letters, the digits, the underscore, and
16354 the blank.  The @samp{\n} represents the newline character; it has to
16355 be left alone.  (The @acronym{ASCII} tab character should also be included for
16356 good measure in a production script.)
16357
16358 At this point, we have data consisting of words separated by blank space.
16359 The words only contain alphanumeric characters (and the underscore).  The
16360 next step is break the data apart so that we have one word per line.  This
16361 makes the counting operation much easier, as we will see shortly.
16362
16363 @smallexample
16364 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16365 > tr -s ' ' '\n' | ...
16366 @end smallexample
16367
16368 This command turns blanks into newlines.  The @option{-s} option squeezes
16369 multiple newline characters in the output into just one.  This helps us
16370 avoid blank lines.  (The @samp{>} is the shell's ``secondary prompt.''
16371 This is what the shell prints when it notices you haven't finished
16372 typing in all of a command.)
16373
16374 We now have data consisting of one word per line, no punctuation, all one
16375 case.  We're ready to count each word:
16376
16377 @smallexample
16378 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16379 > tr -s ' ' '\n' | sort | uniq -c | ...
16380 @end smallexample
16381
16382 At this point, the data might look something like this:
16383
16384 @example
16385      60 a
16386       2 able
16387       6 about
16388       1 above
16389       2 accomplish
16390       1 acquire
16391       1 actually
16392       2 additional
16393 @end example
16394
16395 The output is sorted by word, not by count!  What we want is the most
16396 frequently used words first.  Fortunately, this is easy to accomplish,
16397 with the help of two more @command{sort} options:
16398
16399 @table @code
16400 @item -n
16401 do a numeric sort, not a textual one
16402
16403 @item -r
16404 reverse the order of the sort
16405 @end table
16406
16407 The final pipeline looks like this:
16408
16409 @smallexample
16410 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16411 > tr -s ' ' '\n' | sort | uniq -c | sort -n -r
16412 @print{}    156 the
16413 @print{}     60 a
16414 @print{}     58 to
16415 @print{}     51 of
16416 @print{}     51 and
16417 @dots{}
16418 @end smallexample
16419
16420 Whew!  That's a lot to digest.  Yet, the same principles apply.  With six
16421 commands, on two lines (really one long one split for convenience), we've
16422 created a program that does something interesting and useful, in much
16423 less time than we could have written a C program to do the same thing.
16424
16425 A minor modification to the above pipeline can give us a simple spelling
16426 checker!  To determine if you've spelled a word correctly, all you have to
16427 do is look it up in a dictionary.  If it is not there, then chances are
16428 that your spelling is incorrect.  So, we need a dictionary.
16429 The conventional location for a dictionary is @file{/usr/dict/words}.
16430 On my GNU/Linux system,@footnote{Redhat Linux 6.1, for the November 2000
16431 revision of this article.}
16432 this is a sorted, 45,402 word dictionary.
16433
16434 Now, how to compare our file with the dictionary?  As before, we generate
16435 a sorted list of words, one per line:
16436
16437 @smallexample
16438 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16439 > tr -s ' ' '\n' | sort -u | ...
16440 @end smallexample
16441
16442 Now, all we need is a list of words that are @emph{not} in the
16443 dictionary.  Here is where the @command{comm} command comes in.
16444
16445 @smallexample
16446 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16447 > tr -s ' ' '\n' | sort -u |
16448 > comm -23 - /usr/dict/words
16449 @end smallexample
16450
16451 The @option{-2} and @option{-3} options eliminate lines that are only in the
16452 dictionary (the second file), and lines that are in both files.  Lines
16453 only in the first file (standard input, our stream of words), are
16454 words that are not in the dictionary.  These are likely candidates for
16455 spelling errors.  This pipeline was the first cut at a production
16456 spelling checker on Unix.
16457
16458 There are some other tools that deserve brief mention.
16459
16460 @table @command
16461 @item grep
16462 search files for text that matches a regular expression
16463
16464 @item wc
16465 count lines, words, characters
16466
16467 @item tee
16468 a T-fitting for data pipes, copies data to files and to standard output
16469
16470 @item sed
16471 the stream editor, an advanced tool
16472
16473 @item awk
16474 a data manipulation language, another advanced tool
16475 @end table
16476
16477 The software tools philosophy also espoused the following bit of
16478 advice: ``Let someone else do the hard part.''  This means, take
16479 something that gives you most of what you need, and then massage it the
16480 rest of the way until it's in the form that you want.
16481
16482 To summarize:
16483
16484 @enumerate 1
16485 @item
16486 Each program should do one thing well.  No more, no less.
16487
16488 @item
16489 Combining programs with appropriate plumbing leads to results where
16490 the whole is greater than the sum of the parts.  It also leads to novel
16491 uses of programs that the authors might never have imagined.
16492
16493 @item
16494 Programs should never print extraneous header or trailer data, since these
16495 could get sent on down a pipeline.  (A point we didn't mention earlier.)
16496
16497 @item
16498 Let someone else do the hard part.
16499
16500 @item
16501 Know your toolbox!  Use each program appropriately.  If you don't have an
16502 appropriate tool, build one.
16503 @end enumerate
16504
16505 As of this writing, all the programs we've discussed are available via
16506 anonymous @command{ftp} from: @*
16507 @uref{ftp://gnudist.gnu.org/textutils/textutils-1.22.tar.gz}.  (There may
16508 be more recent versions available now.)
16509
16510 None of what I have presented in this column is new.  The Software Tools
16511 philosophy was first introduced in the book @cite{Software Tools}, by
16512 Brian Kernighan and P.J. Plauger (Addison-Wesley, ISBN 0-201-03669-X).
16513 This book showed how to write and use software tools.  It was written in
16514 1976, using a preprocessor for FORTRAN named @command{ratfor} (RATional
16515 FORtran).  At the time, C was not as ubiquitous as it is now; FORTRAN
16516 was.  The last chapter presented a @command{ratfor} to FORTRAN
16517 processor, written in @command{ratfor}.  @command{ratfor} looks an awful
16518 lot like C; if you know C, you won't have any problem following the
16519 code.
16520
16521 In 1981, the book was updated and made available as @cite{Software Tools
16522 in Pascal} (Addison-Wesley, ISBN 0-201-10342-7).  Both books are
16523 still in print and are well worth
16524 reading if you're a programmer.  They certainly made a major change in
16525 how I view programming.
16526
16527 The programs in both books are available from
16528 @uref{http://cm.bell-labs.com/who/bwk, Brian Kernighan's home page}.
16529 For a number of years, there was an active
16530 Software Tools Users Group, whose members had ported the original
16531 @command{ratfor} programs to essentially every computer system with a
16532 FORTRAN compiler.  The popularity of the group waned in the middle 1980s
16533 as Unix began to spread beyond universities.
16534
16535 With the current proliferation of GNU code and other clones of Unix programs,
16536 these programs now receive little attention; modern C versions are
16537 much more efficient and do more than these programs do.  Nevertheless, as
16538 exposition of good programming style, and evangelism for a still-valuable
16539 philosophy, these books are unparalleled, and I recommend them highly.
16540
16541 Acknowledgment: I would like to express my gratitude to Brian Kernighan
16542 of Bell Labs, the original Software Toolsmith, for reviewing this column.
16543
16544 @node GNU Free Documentation License
16545 @appendix GNU Free Documentation License
16546
16547 @include fdl.texi
16548
16549 @node Concept index
16550 @unnumbered Index
16551
16552 @printindex cp
16553
16554 @bye
16555
16556 @c Local variables:
16557 @c texinfo-column-for-description: 32
16558 @c End: