maint: stop using @acronym{...} in texinfo sources
[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.
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 access permissions.
44 * chown: (coreutils)chown invocation.           Change file owners and 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 * realpath: (coreutils)readpath invocation.     Print resolved file names.
98 * rm: (coreutils)rm invocation.                 Remove files.
99 * rmdir: (coreutils)rmdir invocation.           Remove empty directories.
100 * runcon: (coreutils)runcon invocation.         Run in specified SELinux CTX.
101 * seq: (coreutils)seq invocation.               Print numeric sequences
102 * sha1sum: (coreutils)sha1sum invocation.       Print or check SHA-1 digests.
103 * sha2: (coreutils)sha2 utilities.              Print or check SHA-2 digests.
104 * shred: (coreutils)shred invocation.           Remove files more securely.
105 * shuf: (coreutils)shuf invocation.             Shuffling text files.
106 * sleep: (coreutils)sleep invocation.           Delay for a specified time.
107 * sort: (coreutils)sort invocation.             Sort text files.
108 * split: (coreutils)split invocation.           Split into pieces.
109 * stat: (coreutils)stat invocation.             Report file(system) status.
110 * stdbuf: (coreutils)stdbuf invocation.         Modify stdio buffering.
111 * stty: (coreutils)stty invocation.             Print/change terminal settings.
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-2012 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 realpath
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 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 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 * realpath invocation::          Print resolved file names
385
386 Working context
387
388 * pwd invocation::               Print working directory
389 * stty invocation::              Print or change terminal characteristics
390 * printenv invocation::          Print all or some environment variables
391 * tty invocation::               Print file name of terminal on standard input
392
393 @command{stty}: Print or change terminal characteristics
394
395 * Control::                      Control settings
396 * Input::                        Input settings
397 * Output::                       Output settings
398 * Local::                        Local settings
399 * Combination::                  Combination settings
400 * Characters::                   Special characters
401 * Special::                      Special settings
402
403 User information
404
405 * id invocation::                Print user identity
406 * logname invocation::           Print current login name
407 * whoami invocation::            Print effective user ID
408 * groups invocation::            Print group names a user is in
409 * users invocation::             Print login names of users currently logged in
410 * who invocation::               Print who is currently logged in
411
412 System context
413
414 * arch invocation::              Print machine hardware name
415 * date invocation::              Print or set system date and time
416 * nproc invocation::             Print the number of processors
417 * uname invocation::             Print system information
418 * hostname invocation::          Print or set system name
419 * hostid invocation::            Print numeric host identifier
420 * uptime invocation::            Print system uptime and load
421
422 @command{date}: Print or set system date and time
423
424 * Time conversion specifiers::   %[HIklMNpPrRsSTXzZ]
425 * Date conversion specifiers::   %[aAbBcCdDeFgGhjmuUVwWxyY]
426 * Literal conversion specifiers:: %[%nt]
427 * Padding and other flags::      Pad with zeros, spaces, etc.
428 * Setting the time::             Changing the system clock
429 * Options for date::             Instead of the current time
430 * Date input formats::           Specifying date strings
431 * Examples of date::             Examples
432
433 SELinux context
434
435 * chcon invocation::             Change SELinux context of file
436 * runcon invocation::            Run a command in specified SELinux context
437
438 Modified command invocation
439
440 * chroot invocation::            Run a command with a different root directory
441 * env invocation::               Run a command in a modified environment
442 * nice invocation::              Run a command with modified niceness
443 * nohup invocation::             Run a command immune to hangups
444 * stdbuf invocation::            Run a command with modified I/O buffering
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 POSIX
507 The @sc{gnu} utilities documented here are mostly compatible with the
508 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 (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 @item --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 @item @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 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 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{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.org/en/si/si_brochure/chapter3/prefixes.html, SI prefixes}
905 for decimal multiples and with the
906 @uref{http://physics.nist.gov/cuu/Units/binary.html, ISO/IEC 80000-13
907 (formerly IEC 60027-2) 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 ISO/IEC 80000-13 prefix is @samp{Ki}, but tradition and
950 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 @item YB
993 @cindex yottabyte, definition of
994 yottabyte: @math{10^{24} = 1,000,000,000,000,000,000,000,000}.
995 @item Y
996 @itemx YiB
997 @math{2^{80} = 1,208,925,819,614,629,174,706,176}.
998 @end table
999
1000 @opindex -k
1001 @opindex -h
1002 @opindex --block-size
1003 @opindex --human-readable
1004 @opindex --si
1005
1006 Block size defaults can be overridden by an explicit
1007 @option{--block-size=@var{size}} option.  The @option{-k}
1008 option is equivalent to @option{--block-size=1K}, which
1009 is the default unless the @env{POSIXLY_CORRECT} environment variable is
1010 set.  The @option{-h} or @option{--human-readable} option is equivalent to
1011 @option{--block-size=human-readable}.  The @option{--si} option is
1012 equivalent to @option{--block-size=si}.
1013
1014 @node Floating point
1015 @section Floating point numbers
1016 @cindex floating point
1017 @cindex IEEE floating point
1018
1019 Commands that accept or produce floating point numbers employ the
1020 floating point representation of the underlying system, and suffer
1021 from rounding error, overflow, and similar floating-point issues.
1022 Almost all modern systems use IEEE-754 floating point, and it is
1023 typically portable to assume IEEE-754 behavior these days.  IEEE-754
1024 has positive and negative infinity, distinguishes positive from
1025 negative zero, and uses special values called NaNs to represent
1026 invalid computations such as dividing zero by itself.  For more
1027 information, please see David Goldberg's paper
1028 @uref{http://@/www.validlab.com/@/goldberg/@/paper.pdf, What Every
1029 Computer Scientist Should Know About Floating-Point Arithmetic}.
1030
1031 @vindex LC_NUMERIC
1032 Commands that accept floating point numbers as options, operands or
1033 input use the standard C functions @code{strtod} and @code{strtold} to
1034 convert from text to floating point numbers.  These floating point
1035 numbers therefore can use scientific notation like @code{1.0e-34} and
1036 @code{-10e100}.  Modern C implementations also accept hexadecimal
1037 floating point numbers such as @code{-0x.ep-3}, which stands for
1038 @minus{}14/16 times @math{2^-3}, which equals @minus{}0.109375.  The
1039 @env{LC_NUMERIC} locale determines the decimal-point character.
1040 @xref{Parsing of Floats,,, libc, The GNU C Library Reference Manual}.
1041
1042 @node Signal specifications
1043 @section Signal specifications
1044 @cindex signals, specifying
1045
1046 A @var{signal} may be a signal name like @samp{HUP}, or a signal
1047 number like @samp{1}, or an exit status of a process terminated by the
1048 signal.  A signal name can be given in canonical form or prefixed by
1049 @samp{SIG}@.  The case of the letters is ignored.  The following signal names
1050 and numbers are supported on all POSIX compliant systems:
1051
1052 @table @samp
1053 @item HUP
1054 1.  Hangup.
1055 @item INT
1056 2.  Terminal interrupt.
1057 @item QUIT
1058 3.  Terminal quit.
1059 @item ABRT
1060 6.  Process abort.
1061 @item KILL
1062 9.  Kill (cannot be caught or ignored).
1063 @item ALRM
1064 14.  Alarm Clock.
1065 @item TERM
1066 15.  Termination.
1067 @end table
1068
1069 @noindent
1070 Other supported signal names have system-dependent corresponding
1071 numbers.  All systems conforming to POSIX 1003.1-2001 also
1072 support the following signals:
1073
1074 @table @samp
1075 @item BUS
1076 Access to an undefined portion of a memory object.
1077 @item CHLD
1078 Child process terminated, stopped, or continued.
1079 @item CONT
1080 Continue executing, if stopped.
1081 @item FPE
1082 Erroneous arithmetic operation.
1083 @item ILL
1084 Illegal Instruction.
1085 @item PIPE
1086 Write on a pipe with no one to read it.
1087 @item SEGV
1088 Invalid memory reference.
1089 @item STOP
1090 Stop executing (cannot be caught or ignored).
1091 @item TSTP
1092 Terminal stop.
1093 @item TTIN
1094 Background process attempting read.
1095 @item TTOU
1096 Background process attempting write.
1097 @item URG
1098 High bandwidth data is available at a socket.
1099 @item USR1
1100 User-defined signal 1.
1101 @item USR2
1102 User-defined signal 2.
1103 @end table
1104
1105 @noindent
1106 POSIX 1003.1-2001 systems that support the XSI extension
1107 also support the following signals:
1108
1109 @table @samp
1110 @item POLL
1111 Pollable event.
1112 @item PROF
1113 Profiling timer expired.
1114 @item SYS
1115 Bad system call.
1116 @item TRAP
1117 Trace/breakpoint trap.
1118 @item VTALRM
1119 Virtual timer expired.
1120 @item XCPU
1121 CPU time limit exceeded.
1122 @item XFSZ
1123 File size limit exceeded.
1124 @end table
1125
1126 @noindent
1127 POSIX 1003.1-2001 systems that support the XRT extension
1128 also support at least eight real-time signals called @samp{RTMIN},
1129 @samp{RTMIN+1}, @dots{}, @samp{RTMAX-1}, @samp{RTMAX}.
1130
1131 @node Disambiguating names and IDs
1132 @section chown and chgrp: Disambiguating user names and IDs
1133 @cindex user names, disambiguating
1134 @cindex user IDs, disambiguating
1135 @cindex group names, disambiguating
1136 @cindex group IDs, disambiguating
1137 @cindex disambiguating group names and IDs
1138
1139 Since the @var{owner} and @var{group} arguments to @command{chown} and
1140 @command{chgrp} may be specified as names or numeric IDs, there is an
1141 apparent ambiguity.
1142 What if a user or group @emph{name} is a string of digits?
1143 @footnote{Using a number as a user name is common in some environments.}
1144 Should the command interpret it as a user name or as an ID@?
1145 POSIX requires that @command{chown} and @command{chgrp}
1146 first attempt to resolve the specified string as a name, and
1147 only once that fails, then try to interpret it as an ID@.
1148 This is troublesome when you want to specify a numeric ID, say 42,
1149 and it must work even in a pathological situation where
1150 @samp{42} is a user name that maps to some other user ID, say 1000.
1151 Simply invoking @code{chown 42 F}, will set @file{F}s owner ID to
1152 1000---not what you intended.
1153
1154 GNU @command{chown} and @command{chgrp} provide a way to work around this,
1155 that at the same time may result in a significant performance improvement
1156 by eliminating a database look-up.
1157 Simply precede each numeric user ID and/or group ID with a @samp{+},
1158 in order to force its interpretation as an integer:
1159
1160 @example
1161 chown +42 F
1162 chgrp +$numeric_group_id another-file
1163 chown +0:+0 /
1164 @end example
1165
1166 GNU @command{chown} and @command{chgrp}
1167 skip the name look-up process for each @samp{+}-prefixed string,
1168 because a string containing @samp{+} is never a valid user or group name.
1169 This syntax is accepted on most common Unix systems, but not on Solaris 10.
1170
1171 @node Random sources
1172 @section Sources of random data
1173
1174 @cindex random sources
1175
1176 The @command{shuf}, @command{shred}, and @command{sort} commands
1177 sometimes need random data to do their work.  For example, @samp{sort
1178 -R} must choose a hash function at random, and it needs random data to
1179 make this selection.
1180
1181 By default these commands use an internal pseudorandom generator
1182 initialized by a small amount of entropy, but can be directed to use
1183 an external source with the @option{--random-source=@var{file}} option.
1184 An error is reported if @var{file} does not contain enough bytes.
1185
1186 For example, the device file @file{/dev/urandom} could be used as the
1187 source of random data.  Typically, this device gathers environmental
1188 noise from device drivers and other sources into an entropy pool, and
1189 uses the pool to generate random bits.  If the pool is short of data,
1190 the device reuses the internal pool to produce more bits, using a
1191 cryptographically secure pseudorandom number generator.  But be aware
1192 that this device is not designed for bulk random data generation
1193 and is relatively slow.
1194
1195 @file{/dev/urandom} suffices for most practical uses, but applications
1196 requiring high-value or long-term protection of private data may
1197 require an alternate data source like @file{/dev/random} or
1198 @file{/dev/arandom}.  The set of available sources depends on your
1199 operating system.
1200
1201 To reproduce the results of an earlier invocation of a command, you
1202 can save some random data into a file and then use that file as the
1203 random source in earlier and later invocations of the command.
1204
1205 @node Target directory
1206 @section Target directory
1207
1208 @cindex target directory
1209
1210 The @command{cp}, @command{install}, @command{ln}, and @command{mv}
1211 commands normally treat the last operand specially when it is a
1212 directory or a symbolic link to a directory.  For example, @samp{cp
1213 source dest} is equivalent to @samp{cp source dest/source} if
1214 @file{dest} is a directory.  Sometimes this behavior is not exactly
1215 what is wanted, so these commands support the following options to
1216 allow more fine-grained control:
1217
1218 @table @samp
1219
1220 @item -T
1221 @itemx --no-target-directory
1222 @opindex --no-target-directory
1223 @cindex target directory
1224 @cindex destination directory
1225 Do not treat the last operand specially when it is a directory or a
1226 symbolic link to a directory.  This can help avoid race conditions in
1227 programs that operate in a shared area.  For example, when the command
1228 @samp{mv /tmp/source /tmp/dest} succeeds, there is no guarantee that
1229 @file{/tmp/source} was renamed to @file{/tmp/dest}: it could have been
1230 renamed to @file{/tmp/dest/source} instead, if some other process
1231 created @file{/tmp/dest} as a directory.  However, if @file{mv
1232 -T /tmp/source /tmp/dest} succeeds, there is no
1233 question that @file{/tmp/source} was renamed to @file{/tmp/dest}.
1234
1235 In the opposite situation, where you want the last operand to be
1236 treated as a directory and want a diagnostic otherwise, you can use
1237 the @option{--target-directory} (@option{-t}) option.
1238
1239 @item -t @var{directory}
1240 @itemx @w{@kbd{--target-directory}=@var{directory}}
1241 @opindex --target-directory
1242 @cindex target directory
1243 @cindex destination directory
1244 Use @var{directory} as the directory component of each destination
1245 file name.
1246
1247 The interface for most programs is that after processing options and a
1248 finite (possibly zero) number of fixed-position arguments, the remaining
1249 argument list is either expected to be empty, or is a list of items
1250 (usually files) that will all be handled identically.  The @command{xargs}
1251 program is designed to work well with this convention.
1252
1253 The commands in the @command{mv}-family are unusual in that they take
1254 a variable number of arguments with a special case at the @emph{end}
1255 (namely, the target directory).  This makes it nontrivial to perform some
1256 operations, e.g., ``move all files from here to ../d/'', because
1257 @code{mv * ../d/} might exhaust the argument space, and @code{ls | xargs ...}
1258 doesn't have a clean way to specify an extra final argument for each
1259 invocation of the subject command.  (It can be done by going through a
1260 shell command, but that requires more human labor and brain power than
1261 it should.)
1262
1263 The @w{@kbd{--target-directory}} (@option{-t}) option allows the @command{cp},
1264 @command{install}, @command{ln}, and @command{mv} programs to be used
1265 conveniently with @command{xargs}.  For example, you can move the files
1266 from the current directory to a sibling directory, @code{d} like this:
1267
1268 @smallexample
1269 ls | xargs mv -t ../d --
1270 @end smallexample
1271
1272 However, this doesn't move files whose names begin with @samp{.}.
1273 If you use the @sc{gnu} @command{find} program, you can move those
1274 files too, with this command:
1275
1276 @example
1277 find . -mindepth 1 -maxdepth 1 \
1278   | xargs mv -t ../d
1279 @end example
1280
1281 But both of the above approaches fail if there are no files in the
1282 current directory, or if any file has a name containing a blank or
1283 some other special characters.
1284 The following example removes those limitations and requires both
1285 @sc{gnu} @command{find} and @sc{gnu} @command{xargs}:
1286
1287 @example
1288 find . -mindepth 1 -maxdepth 1 -print0 \
1289   | xargs --null --no-run-if-empty \
1290       mv -t ../d
1291 @end example
1292
1293 @end table
1294
1295 @noindent
1296 The @option{--target-directory} (@option{-t}) and
1297 @option{--no-target-directory} (@option{-T})
1298 options cannot be combined.
1299
1300 @node Trailing slashes
1301 @section Trailing slashes
1302
1303 @cindex trailing slashes
1304
1305 Some @sc{gnu} programs (at least @command{cp} and @command{mv}) allow you to
1306 remove any trailing slashes from each @var{source} argument before
1307 operating on it.  The @w{@kbd{--strip-trailing-slashes}} option enables
1308 this behavior.
1309
1310 This is useful when a @var{source} argument may have a trailing slash and
1311 @c FIXME: mv's behavior in this case is system-dependent
1312 specify a symbolic link to a directory.  This scenario is in fact rather
1313 common because some shells can automatically append a trailing slash when
1314 performing file name completion on such symbolic links.  Without this
1315 option, @command{mv}, for example, (via the system's rename function) must
1316 interpret a trailing slash as a request to dereference the symbolic link
1317 and so must rename the indirectly referenced @emph{directory} and not
1318 the symbolic link.  Although it may seem surprising that such behavior
1319 be the default, it is required by POSIX and is consistent with
1320 other parts of that standard.
1321
1322 @node Traversing symlinks
1323 @section Traversing symlinks
1324
1325 @cindex symbolic link to directory, controlling traversal of
1326
1327 The following options modify how @command{chown} and @command{chgrp}
1328 @c FIXME: note that 'du' has these options, too, but they have slightly
1329 @c different meaning.
1330 traverse a hierarchy when the @option{--recursive} (@option{-R})
1331 option is also specified.
1332 If more than one of the following options is specified, only the final
1333 one takes effect.
1334 These options specify whether processing a symbolic link to a directory
1335 entails operating on just the symbolic link or on all files in the
1336 hierarchy rooted at that directory.
1337
1338 These options are independent of @option{--dereference} and
1339 @option{--no-dereference} (@option{-h}), which control whether to modify
1340 a symlink or its referent.
1341
1342 @table @samp
1343
1344 @macro choptH
1345 @item -H
1346 @opindex -H
1347 @cindex symbolic link to directory, traverse if on the command line
1348 If @option{--recursive} (@option{-R}) is specified and
1349 a command line argument is a symbolic link to a directory, traverse it.
1350 @end macro
1351 @choptH
1352
1353 @macro choptL
1354 @item -L
1355 @opindex -L
1356 @cindex symbolic link to directory, traverse each that is encountered
1357 In a recursive traversal, traverse every symbolic link to a directory
1358 that is encountered.
1359 @end macro
1360 @choptL
1361
1362 @macro choptP
1363 @item -P
1364 @opindex -P
1365 @cindex symbolic link to directory, never traverse
1366 Do not traverse any symbolic links.
1367 This is the default if none of @option{-H}, @option{-L},
1368 or @option{-P} is specified.
1369 @end macro
1370 @choptP
1371
1372 @end table
1373
1374
1375 @node Treating / specially
1376 @section Treating @file{/} specially
1377
1378 Certain commands can operate destructively on entire hierarchies.
1379 For example, if a user with appropriate privileges mistakenly runs
1380 @samp{rm -rf / tmp/junk}, that may remove
1381 all files on the entire system.  Since there are so few
1382 legitimate uses for such a command,
1383 @sc{gnu} @command{rm} normally declines to operate on any directory
1384 that resolves to @file{/}.  If you really want to try to remove all
1385 the files on your system, you can use the @option{--no-preserve-root}
1386 option, but the default behavior, specified by the
1387 @option{--preserve-option}, is safer for most purposes.
1388
1389 The commands @command{chgrp}, @command{chmod} and @command{chown}
1390 can also operate destructively on entire hierarchies, so they too
1391 support these options.  Although, unlike @command{rm}, they don't
1392 actually unlink files, these commands are arguably more dangerous
1393 when operating recursively on @file{/}, since they often work much
1394 more quickly, and hence damage more files before an alert user can
1395 interrupt them.  Tradition and POSIX require these commands
1396 to operate recursively on @file{/}, so they default to
1397 @option{--no-preserve-root}, but using the @option{--preserve-root}
1398 option makes them safer for most purposes.  For convenience you can
1399 specify @option{--preserve-root} in an alias or in a shell function.
1400
1401 Note that the @option{--preserve-root} option also ensures
1402 that @command{chgrp} and @command{chown} do not modify @file{/}
1403 even when dereferencing a symlink pointing to @file{/}.
1404
1405 @node Special built-in utilities
1406 @section Special built-in utilities
1407
1408 Some programs like @command{nice} can invoke other programs; for
1409 example, the command @samp{nice cat file} invokes the program
1410 @command{cat} by executing the command @samp{cat file}.  However,
1411 @dfn{special built-in utilities} like @command{exit} cannot be invoked
1412 this way.  For example, the command @samp{nice exit} does not have a
1413 well-defined behavior: it may generate an error message instead of
1414 exiting.
1415
1416 Here is a list of the special built-in utilities that are standardized
1417 by POSIX 1003.1-2004.
1418
1419 @quotation
1420 @t{.@: : break continue eval exec exit export readonly
1421 return set shift times trap unset}
1422 @end quotation
1423
1424 For example, because @samp{.}, @samp{:}, and @samp{exec} are special,
1425 the commands @samp{nice . foo.sh}, @samp{nice :}, and @samp{nice exec
1426 pwd} do not work as you might expect.
1427
1428 Many shells extend this list.  For example, Bash has several extra
1429 special built-in utilities like @command{history}, and
1430 @command{suspend}, and with Bash the command @samp{nice suspend}
1431 generates an error message instead of suspending.
1432
1433 @node Standards conformance
1434 @section Standards conformance
1435
1436 @vindex POSIXLY_CORRECT
1437 In a few cases, the @sc{gnu} utilities' default behavior is
1438 incompatible with the POSIX standard.  To suppress these
1439 incompatibilities, define the @env{POSIXLY_CORRECT} environment
1440 variable.  Unless you are checking for POSIX conformance, you
1441 probably do not need to define @env{POSIXLY_CORRECT}.
1442
1443 Newer versions of POSIX are occasionally incompatible with older
1444 versions.  For example, older versions of POSIX required the
1445 command @samp{sort +1} to sort based on the second and succeeding
1446 fields in each input line, but starting with POSIX 1003.1-2001
1447 the same command is required to sort the file named @file{+1}, and you
1448 must instead use the command @samp{sort -k 2} to get the field-based
1449 sort.
1450
1451 @vindex _POSIX2_VERSION
1452 The @sc{gnu} utilities normally conform to the version of POSIX
1453 that is standard for your system.  To cause them to conform to a
1454 different version of POSIX, define the @env{_POSIX2_VERSION}
1455 environment variable to a value of the form @var{yyyymm} specifying
1456 the year and month the standard was adopted.  Three values are currently
1457 supported for @env{_POSIX2_VERSION}: @samp{199209} stands for
1458 POSIX 1003.2-1992, @samp{200112} stands for POSIX
1459 1003.1-2001, and @samp{200809} stands for POSIX 1003.1-2008.
1460 For example, if you have a newer system but are running software
1461 that assumes an older version of POSIX and uses @samp{sort +1}
1462 or @samp{tail +10}, you can work around any compatibility problems by setting
1463 @samp{_POSIX2_VERSION=199209} in your environment.
1464
1465 @node Output of entire files
1466 @chapter Output of entire files
1467
1468 @cindex output of entire files
1469 @cindex entire files, output of
1470
1471 These commands read and write entire files, possibly transforming them
1472 in some way.
1473
1474 @menu
1475 * cat invocation::              Concatenate and write files.
1476 * tac invocation::              Concatenate and write files in reverse.
1477 * nl invocation::               Number lines and write files.
1478 * od invocation::               Write files in octal or other formats.
1479 * base64 invocation::           Transform data into printable data.
1480 @end menu
1481
1482 @node cat invocation
1483 @section @command{cat}: Concatenate and write files
1484
1485 @pindex cat
1486 @cindex concatenate and write files
1487 @cindex copying files
1488
1489 @command{cat} copies each @var{file} (@samp{-} means standard input), or
1490 standard input if none are given, to standard output.  Synopsis:
1491
1492 @example
1493 cat [@var{option}] [@var{file}]@dots{}
1494 @end example
1495
1496 The program accepts the following options.  Also see @ref{Common options}.
1497
1498 @table @samp
1499
1500 @item -A
1501 @itemx --show-all
1502 @opindex -A
1503 @opindex --show-all
1504 Equivalent to @option{-vET}.
1505
1506 @item -b
1507 @itemx --number-nonblank
1508 @opindex -b
1509 @opindex --number-nonblank
1510 Number all nonempty output lines, starting with 1.
1511
1512 @item -e
1513 @opindex -e
1514 Equivalent to @option{-vE}.
1515
1516 @item -E
1517 @itemx --show-ends
1518 @opindex -E
1519 @opindex --show-ends
1520 Display a @samp{$} after the end of each line.
1521
1522 @item -n
1523 @itemx --number
1524 @opindex -n
1525 @opindex --number
1526 Number all output lines, starting with 1.  This option is ignored
1527 if @option{-b} is in effect.
1528
1529 @item -s
1530 @itemx --squeeze-blank
1531 @opindex -s
1532 @opindex --squeeze-blank
1533 @cindex squeezing empty lines
1534 Suppress repeated adjacent empty lines; output just one empty line
1535 instead of several.
1536
1537 @item -t
1538 @opindex -t
1539 Equivalent to @option{-vT}.
1540
1541 @item -T
1542 @itemx --show-tabs
1543 @opindex -T
1544 @opindex --show-tabs
1545 Display TAB characters as @samp{^I}.
1546
1547 @item -u
1548 @opindex -u
1549 Ignored; for POSIX compatibility.
1550
1551 @item -v
1552 @itemx --show-nonprinting
1553 @opindex -v
1554 @opindex --show-nonprinting
1555 Display control characters except for LFD and TAB using
1556 @samp{^} notation and precede characters that have the high bit set with
1557 @samp{M-}.
1558
1559 @end table
1560
1561 On systems like MS-DOS that distinguish between text and binary files,
1562 @command{cat} normally reads and writes in binary mode.  However,
1563 @command{cat} reads in text mode if one of the options
1564 @option{-bensAE} is used or if @command{cat} is reading from standard
1565 input and standard input is a terminal.  Similarly, @command{cat}
1566 writes in text mode if one of the options @option{-bensAE} is used or
1567 if standard output is a terminal.
1568
1569 @exitstatus
1570
1571 Examples:
1572
1573 @smallexample
1574 # Output f's contents, then standard input, then g's contents.
1575 cat f - g
1576
1577 # Copy standard input to standard output.
1578 cat
1579 @end smallexample
1580
1581
1582 @node tac invocation
1583 @section @command{tac}: Concatenate and write files in reverse
1584
1585 @pindex tac
1586 @cindex reversing files
1587
1588 @command{tac} copies each @var{file} (@samp{-} means standard input), or
1589 standard input if none are given, to standard output, reversing the
1590 records (lines by default) in each separately.  Synopsis:
1591
1592 @example
1593 tac [@var{option}]@dots{} [@var{file}]@dots{}
1594 @end example
1595
1596 @dfn{Records} are separated by instances of a string (newline by
1597 default).  By default, this separator string is attached to the end of
1598 the record that it follows in the file.
1599
1600 The program accepts the following options.  Also see @ref{Common options}.
1601
1602 @table @samp
1603
1604 @item -b
1605 @itemx --before
1606 @opindex -b
1607 @opindex --before
1608 The separator is attached to the beginning of the record that it
1609 precedes in the file.
1610
1611 @item -r
1612 @itemx --regex
1613 @opindex -r
1614 @opindex --regex
1615 Treat the separator string as a regular expression.  Users of @command{tac}
1616 on MS-DOS/MS-Windows should note that, since @command{tac} reads files in
1617 binary mode, each line of a text file might end with a CR/LF pair
1618 instead of the Unix-style LF.
1619
1620 @item -s @var{separator}
1621 @itemx --separator=@var{separator}
1622 @opindex -s
1623 @opindex --separator
1624 Use @var{separator} as the record separator, instead of newline.
1625
1626 @end table
1627
1628 @exitstatus
1629
1630
1631 @node nl invocation
1632 @section @command{nl}: Number lines and write files
1633
1634 @pindex nl
1635 @cindex numbering lines
1636 @cindex line numbering
1637
1638 @command{nl} writes each @var{file} (@samp{-} means standard input), or
1639 standard input if none are given, to standard output, with line numbers
1640 added to some or all of the lines.  Synopsis:
1641
1642 @example
1643 nl [@var{option}]@dots{} [@var{file}]@dots{}
1644 @end example
1645
1646 @cindex logical pages, numbering on
1647 @command{nl} decomposes its input into (logical) pages; by default, the
1648 line number is reset to 1 at the top of each logical page.  @command{nl}
1649 treats all of the input files as a single document; it does not reset
1650 line numbers or logical pages between files.
1651
1652 @cindex headers, numbering
1653 @cindex body, numbering
1654 @cindex footers, numbering
1655 A logical page consists of three sections: header, body, and footer.
1656 Any of the sections can be empty.  Each can be numbered in a different
1657 style from the others.
1658
1659 The beginnings of the sections of logical pages are indicated in the
1660 input file by a line containing exactly one of these delimiter strings:
1661
1662 @table @samp
1663 @item \:\:\:
1664 start of header;
1665 @item \:\:
1666 start of body;
1667 @item \:
1668 start of footer.
1669 @end table
1670
1671 The two characters from which these strings are made can be changed from
1672 @samp{\} and @samp{:} via options (see below), but the pattern and
1673 length of each string cannot be changed.
1674
1675 A section delimiter is replaced by an empty line on output.  Any text
1676 that comes before the first section delimiter string in the input file
1677 is considered to be part of a body section, so @command{nl} treats a
1678 file that contains no section delimiters as a single body section.
1679
1680 The program accepts the following options.  Also see @ref{Common options}.
1681
1682 @table @samp
1683
1684 @item -b @var{style}
1685 @itemx --body-numbering=@var{style}
1686 @opindex -b
1687 @opindex --body-numbering
1688 Select the numbering style for lines in the body section of each
1689 logical page.  When a line is not numbered, the current line number
1690 is not incremented, but the line number separator character is still
1691 prepended to the line.  The styles are:
1692
1693 @table @samp
1694 @item a
1695 number all lines,
1696 @item t
1697 number only nonempty lines (default for body),
1698 @item n
1699 do not number lines (default for header and footer),
1700 @item p@var{bre}
1701 number only lines that contain a match for the basic regular
1702 expression @var{bre}.
1703 @xref{Regular Expressions, , Regular Expressions, grep, The GNU Grep Manual}.
1704 @end table
1705
1706 @item -d @var{cd}
1707 @itemx --section-delimiter=@var{cd}
1708 @opindex -d
1709 @opindex --section-delimiter
1710 @cindex section delimiters of pages
1711 Set the section delimiter characters to @var{cd}; default is
1712 @samp{\:}.  If only @var{c} is given, the second remains @samp{:}.
1713 (Remember to protect @samp{\} or other metacharacters from shell
1714 expansion with quotes or extra backslashes.)
1715
1716 @item -f @var{style}
1717 @itemx --footer-numbering=@var{style}
1718 @opindex -f
1719 @opindex --footer-numbering
1720 Analogous to @option{--body-numbering}.
1721
1722 @item -h @var{style}
1723 @itemx --header-numbering=@var{style}
1724 @opindex -h
1725 @opindex --header-numbering
1726 Analogous to @option{--body-numbering}.
1727
1728 @item -i @var{number}
1729 @itemx --line-increment=@var{number}
1730 @opindex -i
1731 @opindex --line-increment
1732 Increment line numbers by @var{number} (default 1).
1733
1734 @item -l @var{number}
1735 @itemx --join-blank-lines=@var{number}
1736 @opindex -l
1737 @opindex --join-blank-lines
1738 @cindex empty lines, numbering
1739 @cindex blank lines, numbering
1740 Consider @var{number} (default 1) consecutive empty lines to be one
1741 logical line for numbering, and only number the last one.  Where fewer
1742 than @var{number} consecutive empty lines occur, do not number them.
1743 An empty line is one that contains no characters, not even spaces
1744 or tabs.
1745
1746 @item -n @var{format}
1747 @itemx --number-format=@var{format}
1748 @opindex -n
1749 @opindex --number-format
1750 Select the line numbering format (default is @code{rn}):
1751
1752 @table @samp
1753 @item ln
1754 @opindex ln @r{format for @command{nl}}
1755 left justified, no leading zeros;
1756 @item rn
1757 @opindex rn @r{format for @command{nl}}
1758 right justified, no leading zeros;
1759 @item rz
1760 @opindex rz @r{format for @command{nl}}
1761 right justified, leading zeros.
1762 @end table
1763
1764 @item -p
1765 @itemx --no-renumber
1766 @opindex -p
1767 @opindex --no-renumber
1768 Do not reset the line number at the start of a logical page.
1769
1770 @item -s @var{string}
1771 @itemx --number-separator=@var{string}
1772 @opindex -s
1773 @opindex --number-separator
1774 Separate the line number from the text line in the output with
1775 @var{string} (default is the TAB character).
1776
1777 @item -v @var{number}
1778 @itemx --starting-line-number=@var{number}
1779 @opindex -v
1780 @opindex --starting-line-number
1781 Set the initial line number on each logical page to @var{number} (default 1).
1782
1783 @item -w @var{number}
1784 @itemx --number-width=@var{number}
1785 @opindex -w
1786 @opindex --number-width
1787 Use @var{number} characters for line numbers (default 6).
1788
1789 @end table
1790
1791 @exitstatus
1792
1793
1794 @node od invocation
1795 @section @command{od}: Write files in octal or other formats
1796
1797 @pindex od
1798 @cindex octal dump of files
1799 @cindex hex dump of files
1800 @cindex ASCII dump of files
1801 @cindex file contents, dumping unambiguously
1802
1803 @command{od} writes an unambiguous representation of each @var{file}
1804 (@samp{-} means standard input), or standard input if none are given.
1805 Synopses:
1806
1807 @smallexample
1808 od [@var{option}]@dots{} [@var{file}]@dots{}
1809 od [-abcdfilosx]@dots{} [@var{file}] [[+]@var{offset}[.][b]]
1810 od [@var{option}]@dots{} --traditional [@var{file}]@c
1811  [[+]@var{offset}[.][b] [[+]@var{label}[.][b]]]
1812 @end smallexample
1813
1814 Each line of output consists of the offset in the input, followed by
1815 groups of data from the file.  By default, @command{od} prints the offset in
1816 octal, and each group of file data is a C @code{short int}'s worth of input
1817 printed as a single octal number.
1818
1819 If @var{offset} is given, it specifies how many input bytes to skip
1820 before formatting and writing.  By default, it is interpreted as an
1821 octal number, but the optional trailing decimal point causes it to be
1822 interpreted as decimal.  If no decimal is specified and the offset
1823 begins with @samp{0x} or @samp{0X} it is interpreted as a hexadecimal
1824 number.  If there is a trailing @samp{b}, the number of bytes skipped
1825 will be @var{offset} multiplied by 512.
1826
1827 If a command is of both the first and second forms, the second form is
1828 assumed if the last operand begins with @samp{+} or (if there are two
1829 operands) a digit.  For example, in @samp{od foo 10} and @samp{od +10}
1830 the @samp{10} is an offset, whereas in @samp{od 10} the @samp{10} is a
1831 file name.
1832
1833 The program accepts the following options.  Also see @ref{Common options}.
1834
1835 @table @samp
1836
1837 @item -A @var{radix}
1838 @itemx --address-radix=@var{radix}
1839 @opindex -A
1840 @opindex --address-radix
1841 @cindex radix for file offsets
1842 @cindex file offset radix
1843 Select the base in which file offsets are printed.  @var{radix} can
1844 be one of the following:
1845
1846 @table @samp
1847 @item d
1848 decimal;
1849 @item o
1850 octal;
1851 @item x
1852 hexadecimal;
1853 @item n
1854 none (do not print offsets).
1855 @end table
1856
1857 The default is octal.
1858
1859 @item -j @var{bytes}
1860 @itemx --skip-bytes=@var{bytes}
1861 @opindex -j
1862 @opindex --skip-bytes
1863 Skip @var{bytes} input bytes before formatting and writing.  If
1864 @var{bytes} begins with @samp{0x} or @samp{0X}, it is interpreted in
1865 hexadecimal; otherwise, if it begins with @samp{0}, in octal; otherwise,
1866 in decimal.
1867 @multiplierSuffixes{bytes}
1868
1869 @item -N @var{bytes}
1870 @itemx --read-bytes=@var{bytes}
1871 @opindex -N
1872 @opindex --read-bytes
1873 Output at most @var{bytes} bytes of the input.  Prefixes and suffixes on
1874 @code{bytes} are interpreted as for the @option{-j} option.
1875
1876 @item -S @var{bytes}
1877 @itemx --strings[=@var{bytes}]
1878 @opindex -S
1879 @opindex --strings
1880 @cindex string constants, outputting
1881 Instead of the normal output, output only @dfn{string constants}: at
1882 least @var{bytes} consecutive ASCII graphic characters,
1883 followed by a zero byte (ASCII @sc{nul}).
1884 Prefixes and suffixes on @var{bytes} are interpreted as for the
1885 @option{-j} option.
1886
1887 If @var{n} is omitted with @option{--strings}, the default is 3.
1888
1889 @item -t @var{type}
1890 @itemx --format=@var{type}
1891 @opindex -t
1892 @opindex --format
1893 Select the format in which to output the file data.  @var{type} is a
1894 string of one or more of the below type indicator characters.  If you
1895 include more than one type indicator character in a single @var{type}
1896 string, or use this option more than once, @command{od} writes one copy
1897 of each output line using each of the data types that you specified,
1898 in the order that you specified.
1899
1900 Adding a trailing ``z'' to any type specification appends a display
1901 of the ASCII character representation of the printable characters
1902 to the output line generated by the type specification.
1903
1904 @table @samp
1905 @item a
1906 named character, ignoring high-order bit
1907 @item c
1908 ASCII character or backslash escape,
1909 @item d
1910 signed decimal
1911 @item f
1912 floating point (@pxref{Floating point})
1913 @item o
1914 octal
1915 @item u
1916 unsigned decimal
1917 @item x
1918 hexadecimal
1919 @end table
1920
1921 The type @code{a} outputs things like @samp{sp} for space, @samp{nl} for
1922 newline, and @samp{nul} for a zero byte.  Only the least significant
1923 seven bits of each byte is used; the high-order bit is ignored.
1924 Type @code{c} outputs
1925 @samp{ }, @samp{\n}, and @code{\0}, respectively.
1926
1927 @cindex type size
1928 Except for types @samp{a} and @samp{c}, you can specify the number
1929 of bytes to use in interpreting each number in the given data type
1930 by following the type indicator character with a decimal integer.
1931 Alternately, you can specify the size of one of the C compiler's
1932 built-in data types by following the type indicator character with
1933 one of the following characters.  For integers (@samp{d}, @samp{o},
1934 @samp{u}, @samp{x}):
1935
1936 @table @samp
1937 @item C
1938 char
1939 @item S
1940 short
1941 @item I
1942 int
1943 @item L
1944 long
1945 @end table
1946
1947 For floating point (@code{f}):
1948
1949 @table @asis
1950 @item F
1951 float
1952 @item D
1953 double
1954 @item L
1955 long double
1956 @end table
1957
1958 @item -v
1959 @itemx --output-duplicates
1960 @opindex -v
1961 @opindex --output-duplicates
1962 Output consecutive lines that are identical.  By default, when two or
1963 more consecutive output lines would be identical, @command{od} outputs only
1964 the first line, and puts just an asterisk on the following line to
1965 indicate the elision.
1966
1967 @item -w[@var{n}]
1968 @itemx --width[=@var{n}]
1969 @opindex -w
1970 @opindex --width
1971 Dump @code{n} input bytes per output line.  This must be a multiple of
1972 the least common multiple of the sizes associated with the specified
1973 output types.
1974
1975 If this option is not given at all, the default is 16.  If @var{n} is
1976 omitted, the default is 32.
1977
1978 @end table
1979
1980 The next several options are shorthands for format specifications.
1981 @sc{gnu} @command{od} accepts any combination of shorthands and format
1982 specification options.  These options accumulate.
1983
1984 @table @samp
1985
1986 @item -a
1987 @opindex -a
1988 Output as named characters.  Equivalent to @samp{-t a}.
1989
1990 @item -b
1991 @opindex -b
1992 Output as octal bytes.  Equivalent to @samp{-t o1}.
1993
1994 @item -c
1995 @opindex -c
1996 Output as ASCII characters or backslash escapes.  Equivalent to
1997 @samp{-t c}.
1998
1999 @item -d
2000 @opindex -d
2001 Output as unsigned decimal two-byte units.  Equivalent to @samp{-t u2}.
2002
2003 @item -f
2004 @opindex -f
2005 Output as floats.  Equivalent to @samp{-t fF}.
2006
2007 @item -i
2008 @opindex -i
2009 Output as decimal ints.  Equivalent to @samp{-t dI}.
2010
2011 @item -l
2012 @opindex -l
2013 Output as decimal long ints.  Equivalent to @samp{-t dL}.
2014
2015 @item -o
2016 @opindex -o
2017 Output as octal two-byte units.  Equivalent to @option{-t o2}.
2018
2019 @item -s
2020 @opindex -s
2021 Output as decimal two-byte units.  Equivalent to @option{-t d2}.
2022
2023 @item -x
2024 @opindex -x
2025 Output as hexadecimal two-byte units.  Equivalent to @samp{-t x2}.
2026
2027 @item --traditional
2028 @opindex --traditional
2029 Recognize the non-option label argument that traditional @command{od}
2030 accepted.  The following syntax:
2031
2032 @smallexample
2033 od --traditional [@var{file}] [[+]@var{offset}[.][b] [[+]@var{label}[.][b]]]
2034 @end smallexample
2035
2036 @noindent
2037 can be used to specify at most one file and optional arguments
2038 specifying an offset and a pseudo-start address, @var{label}.
2039 The @var{label} argument is interpreted
2040 just like @var{offset}, but it specifies an initial pseudo-address.  The
2041 pseudo-addresses are displayed in parentheses following any normal
2042 address.
2043
2044 @end table
2045
2046 @exitstatus
2047
2048 @node base64 invocation
2049 @section @command{base64}: Transform data into printable data
2050
2051 @pindex base64
2052 @cindex base64 encoding
2053
2054 @command{base64} transforms data read from a file, or standard input,
2055 into (or from) base64 encoded form.  The base64 encoded form uses
2056 printable ASCII characters to represent binary data.
2057 Synopses:
2058
2059 @smallexample
2060 base64 [@var{option}]@dots{} [@var{file}]
2061 base64 --decode [@var{option}]@dots{} [@var{file}]
2062 @end smallexample
2063
2064 The base64 encoding expands data to roughly 133% of the original.
2065 The format conforms to
2066 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc4648.txt, RFC 4648}.
2067
2068 The program accepts the following options.  Also see @ref{Common options}.
2069
2070 @table @samp
2071
2072 @item -w @var{cols}
2073 @itemx --wrap=@var{cols}
2074 @opindex -w
2075 @opindex --wrap
2076 @cindex wrap data
2077 @cindex column to wrap data after
2078 During encoding, wrap lines after @var{cols} characters.  This must be
2079 a positive number.
2080
2081 The default is to wrap after 76 characters.  Use the value 0 to
2082 disable line wrapping altogether.
2083
2084 @item -d
2085 @itemx --decode
2086 @opindex -d
2087 @opindex --decode
2088 @cindex Decode base64 data
2089 @cindex Base64 decoding
2090 Change the mode of operation, from the default of encoding data, to
2091 decoding data.  Input is expected to be base64 encoded data, and the
2092 output will be the original data.
2093
2094 @item -i
2095 @itemx --ignore-garbage
2096 @opindex -i
2097 @opindex --ignore-garbage
2098 @cindex Ignore garbage in base64 stream
2099 When decoding, newlines are always accepted.
2100 During decoding, ignore unrecognized bytes,
2101 to permit distorted data to be decoded.
2102
2103 @end table
2104
2105 @exitstatus
2106
2107
2108 @node Formatting file contents
2109 @chapter Formatting file contents
2110
2111 @cindex formatting file contents
2112
2113 These commands reformat the contents of files.
2114
2115 @menu
2116 * fmt invocation::              Reformat paragraph text.
2117 * pr invocation::               Paginate or columnate files for printing.
2118 * fold invocation::             Wrap input lines to fit in specified width.
2119 @end menu
2120
2121
2122 @node fmt invocation
2123 @section @command{fmt}: Reformat paragraph text
2124
2125 @pindex fmt
2126 @cindex reformatting paragraph text
2127 @cindex paragraphs, reformatting
2128 @cindex text, reformatting
2129
2130 @command{fmt} fills and joins lines to produce output lines of (at most)
2131 a given number of characters (75 by default).  Synopsis:
2132
2133 @example
2134 fmt [@var{option}]@dots{} [@var{file}]@dots{}
2135 @end example
2136
2137 @command{fmt} reads from the specified @var{file} arguments (or standard
2138 input if none are given), and writes to standard output.
2139
2140 By default, blank lines, spaces between words, and indentation are
2141 preserved in the output; successive input lines with different
2142 indentation are not joined; tabs are expanded on input and introduced on
2143 output.
2144
2145 @cindex line-breaking
2146 @cindex sentences and line-breaking
2147 @cindex Knuth, Donald E.
2148 @cindex Plass, Michael F.
2149 @command{fmt} prefers breaking lines at the end of a sentence, and tries to
2150 avoid line breaks after the first word of a sentence or before the last
2151 word of a sentence.  A @dfn{sentence break} is defined as either the end
2152 of a paragraph or a word ending in any of @samp{.?!}, followed by two
2153 spaces or end of line, ignoring any intervening parentheses or quotes.
2154 Like @TeX{}, @command{fmt} reads entire ``paragraphs'' before choosing line
2155 breaks; the algorithm is a variant of that given by Donald E. Knuth
2156 and Michael F. Plass in ``Breaking Paragraphs Into Lines'',
2157 @cite{Software---Practice & Experience} @b{11}, 11 (November 1981),
2158 1119--1184.
2159
2160 The program accepts the following options.  Also see @ref{Common options}.
2161
2162 @table @samp
2163
2164 @item -c
2165 @itemx --crown-margin
2166 @opindex -c
2167 @opindex --crown-margin
2168 @cindex crown margin
2169 @dfn{Crown margin} mode: preserve the indentation of the first two
2170 lines within a paragraph, and align the left margin of each subsequent
2171 line with that of the second line.
2172
2173 @item -t
2174 @itemx --tagged-paragraph
2175 @opindex -t
2176 @opindex --tagged-paragraph
2177 @cindex tagged paragraphs
2178 @dfn{Tagged paragraph} mode: like crown margin mode, except that if
2179 indentation of the first line of a paragraph is the same as the
2180 indentation of the second, the first line is treated as a one-line
2181 paragraph.
2182
2183 @item -s
2184 @itemx --split-only
2185 @opindex -s
2186 @opindex --split-only
2187 Split lines only.  Do not join short lines to form longer ones.  This
2188 prevents sample lines of code, and other such ``formatted'' text from
2189 being unduly combined.
2190
2191 @item -u
2192 @itemx --uniform-spacing
2193 @opindex -u
2194 @opindex --uniform-spacing
2195 Uniform spacing.  Reduce spacing between words to one space, and spacing
2196 between sentences to two spaces.
2197
2198 @item -@var{width}
2199 @itemx -w @var{width}
2200 @itemx --width=@var{width}
2201 @opindex -@var{width}
2202 @opindex -w
2203 @opindex --width
2204 Fill output lines up to @var{width} characters (default 75 or @var{goal}
2205 plus 10, if @var{goal} is provided).
2206
2207 @item -g @var{goal}
2208 @itemx --goal=@var{goal}
2209 @opindex -g
2210 @opindex --goal
2211 @command{fmt} initially tries to make lines @var{goal} characters wide.
2212 By default, this is 7% shorter than @var{width}.
2213
2214 @item -p @var{prefix}
2215 @itemx --prefix=@var{prefix}
2216 Only lines beginning with @var{prefix} (possibly preceded by whitespace)
2217 are subject to formatting.  The prefix and any preceding whitespace are
2218 stripped for the formatting and then re-attached to each formatted output
2219 line.  One use is to format certain kinds of program comments, while
2220 leaving the code unchanged.
2221
2222 @end table
2223
2224 @exitstatus
2225
2226
2227 @node pr invocation
2228 @section @command{pr}: Paginate or columnate files for printing
2229
2230 @pindex pr
2231 @cindex printing, preparing files for
2232 @cindex multicolumn output, generating
2233 @cindex merging files in parallel
2234
2235 @command{pr} writes each @var{file} (@samp{-} means standard input), or
2236 standard input if none are given, to standard output, paginating and
2237 optionally outputting in multicolumn format; optionally merges all
2238 @var{file}s, printing all in parallel, one per column.  Synopsis:
2239
2240 @example
2241 pr [@var{option}]@dots{} [@var{file}]@dots{}
2242 @end example
2243
2244 @vindex LC_MESSAGES
2245 By default, a 5-line header is printed at each page: two blank lines;
2246 a line with the date, the file name, and the page count; and two more
2247 blank lines.  A footer of five blank lines is also printed.
2248 The default @var{page_length} is 66
2249 lines.  The default number of text lines is therefore 56.
2250 The text line of the header takes the form
2251 @samp{@var{date} @var{string} @var{page}}, with spaces inserted around
2252 @var{string} so that the line takes up the full @var{page_width}.  Here,
2253 @var{date} is the date (see the @option{-D} or @option{--date-format}
2254 option for details), @var{string} is the centered header string, and
2255 @var{page} identifies the page number.  The @env{LC_MESSAGES} locale
2256 category affects the spelling of @var{page}; in the default C locale, it
2257 is @samp{Page @var{number}} where @var{number} is the decimal page
2258 number.
2259
2260 Form feeds in the input cause page breaks in the output.  Multiple form
2261 feeds produce empty pages.
2262
2263 Columns are of equal width, separated by an optional string (default
2264 is @samp{space}).  For multicolumn output, lines will always be truncated to
2265 @var{page_width} (default 72), unless you use the @option{-J} option.
2266 For single
2267 column output no line truncation occurs by default.  Use @option{-W} option to
2268 truncate lines in that case.
2269
2270 The following changes were made in version 1.22i and apply to later
2271 versions of @command{pr}:
2272 @c FIXME: this whole section here sounds very awkward to me. I
2273 @c made a few small changes, but really it all needs to be redone. - Brian
2274 @c OK, I fixed another sentence or two, but some of it I just don't understand.
2275 @ - Brian
2276 @itemize @bullet
2277
2278 @item
2279 Some small @var{letter options} (@option{-s}, @option{-w}) have been
2280 redefined for better POSIX compliance.  The output of some further
2281 cases has been adapted to other Unix systems.  These changes are not
2282 compatible with earlier versions of the program.
2283
2284 @item
2285 Some @var{new capital letter} options (@option{-J}, @option{-S}, @option{-W})
2286 have been introduced to turn off unexpected interferences of small letter
2287 options.  The @option{-N} option and the second argument @var{last_page}
2288 of @samp{+FIRST_PAGE} offer more flexibility.  The detailed handling of
2289 form feeds set in the input files requires the @option{-T} option.
2290
2291 @item
2292 Capital letter options override small letter ones.
2293
2294 @item
2295 Some of the option-arguments (compare @option{-s}, @option{-e},
2296 @option{-i}, @option{-n}) cannot be specified as separate arguments from the
2297 preceding option letter (already stated in the POSIX specification).
2298 @end itemize
2299
2300 The program accepts the following options.  Also see @ref{Common options}.
2301
2302 @table @samp
2303
2304 @item +@var{first_page}[:@var{last_page}]
2305 @itemx --pages=@var{first_page}[:@var{last_page}]
2306 @c The two following @opindex lines evoke warnings because they contain ':'
2307 @c The 'info' spec does not permit that.  If we use those lines, we end
2308 @c up with truncated index entries that don't work.
2309 @c @opindex +@var{first_page}[:@var{last_page}]
2310 @c @opindex --pages=@var{first_page}[:@var{last_page}]
2311 @opindex +@var{page_range}
2312 @opindex --pages=@var{page_range}
2313 Begin printing with page @var{first_page} and stop with @var{last_page}.
2314 Missing @samp{:@var{last_page}} implies end of file.  While estimating
2315 the number of skipped pages each form feed in the input file results
2316 in a new page.  Page counting with and without @samp{+@var{first_page}}
2317 is identical.  By default, counting starts with the first page of input
2318 file (not first page printed).  Line numbering may be altered by @option{-N}
2319 option.
2320
2321 @item -@var{column}
2322 @itemx --columns=@var{column}
2323 @opindex -@var{column}
2324 @opindex --columns
2325 @cindex down columns
2326 With each single @var{file}, produce @var{column} columns of output
2327 (default is 1) and print columns down, unless @option{-a} is used.  The
2328 column width is automatically decreased as @var{column} increases; unless
2329 you use the @option{-W/-w} option to increase @var{page_width} as well.
2330 This option might well cause some lines to be truncated.  The number of
2331 lines in the columns on each page are balanced.  The options @option{-e}
2332 and @option{-i} are on for multiple text-column output.  Together with
2333 @option{-J} option column alignment and line truncation is turned off.
2334 Lines of full length are joined in a free field format and @option{-S}
2335 option may set field separators.  @option{-@var{column}} may not be used
2336 with @option{-m} option.
2337
2338 @item -a
2339 @itemx --across
2340 @opindex -a
2341 @opindex --across
2342 @cindex across columns
2343 With each single @var{file}, print columns across rather than down.  The
2344 @option{-@var{column}} option must be given with @var{column} greater than one.
2345 If a line is too long to fit in a column, it is truncated.
2346
2347 @item -c
2348 @itemx --show-control-chars
2349 @opindex -c
2350 @opindex --show-control-chars
2351 Print control characters using hat notation (e.g., @samp{^G}); print
2352 other nonprinting characters in octal backslash notation.  By default,
2353 nonprinting characters are not changed.
2354
2355 @item -d
2356 @itemx --double-space
2357 @opindex -d
2358 @opindex --double-space
2359 @cindex double spacing
2360 Double space the output.
2361
2362 @item -D @var{format}
2363 @itemx --date-format=@var{format}
2364 @cindex time formats
2365 @cindex formatting times
2366 Format header dates using @var{format}, using the same conventions as
2367 for the command @samp{date +@var{format}}.  @xref{date invocation}.
2368 Except for directives, which start with
2369 @samp{%}, characters in @var{format} are printed unchanged.  You can use
2370 this option to specify an arbitrary string in place of the header date,
2371 e.g., @option{--date-format="Monday morning"}.
2372
2373 @vindex POSIXLY_CORRECT
2374 @vindex LC_TIME
2375 The default date format is @samp{%Y-%m-%d %H:%M} (for example,
2376 @samp{2001-12-04 23:59});
2377 but if the @env{POSIXLY_CORRECT} environment variable is set
2378 and the @env{LC_TIME} locale category specifies the POSIX
2379 locale, the default is @samp{%b %e %H:%M %Y} (for example,
2380 @samp{Dec@ @ 4 23:59 2001}.
2381
2382 @vindex TZ
2383 Time stamps are listed according to the time zone rules specified by
2384 the @env{TZ} environment variable, or by the system default rules if
2385 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
2386 with @env{TZ}, libc, The GNU C Library Reference Manual}.
2387
2388 @item -e[@var{in-tabchar}[@var{in-tabwidth}]]
2389 @itemx --expand-tabs[=@var{in-tabchar}[@var{in-tabwidth}]]
2390 @opindex -e
2391 @opindex --expand-tabs
2392 @cindex input tabs
2393 Expand @var{tab}s to spaces on input.  Optional argument @var{in-tabchar} is
2394 the input tab character (default is the TAB character).  Second optional
2395 argument @var{in-tabwidth} is the input tab character's width (default
2396 is 8).
2397
2398 @item -f
2399 @itemx -F
2400 @itemx --form-feed
2401 @opindex -F
2402 @opindex -f
2403 @opindex --form-feed
2404 Use a form feed instead of newlines to separate output pages.  This does
2405 not alter the default page length of 66 lines.
2406
2407 @item -h @var{header}
2408 @itemx --header=@var{header}
2409 @opindex -h
2410 @opindex --header
2411 Replace the file name in the header with the centered string @var{header}.
2412 When using the shell, @var{header} should be quoted and should be
2413 separated from @option{-h} by a space.
2414
2415 @item -i[@var{out-tabchar}[@var{out-tabwidth}]]
2416 @itemx --output-tabs[=@var{out-tabchar}[@var{out-tabwidth}]]
2417 @opindex -i
2418 @opindex --output-tabs
2419 @cindex output tabs
2420 Replace spaces with @var{tab}s on output.  Optional argument @var{out-tabchar}
2421 is the output tab character (default is the TAB character).  Second optional
2422 argument @var{out-tabwidth} is the output tab character's width (default
2423 is 8).
2424
2425 @item -J
2426 @itemx --join-lines
2427 @opindex -J
2428 @opindex --join-lines
2429 Merge lines of full length.  Used together with the column options
2430 @option{-@var{column}}, @option{-a -@var{column}} or @option{-m}.  Turns off
2431 @option{-W/-w} line truncation;
2432 no column alignment used; may be used with
2433 @option{--sep-string[=@var{string}]}.  @option{-J} has been introduced
2434 (together with @option{-W} and @option{--sep-string})
2435 to disentangle the old (POSIX-compliant) options @option{-w} and
2436 @option{-s} along with the three column options.
2437
2438
2439 @item -l @var{page_length}
2440 @itemx --length=@var{page_length}
2441 @opindex -l
2442 @opindex --length
2443 Set the page length to @var{page_length} (default 66) lines, including
2444 the lines of the header [and the footer].  If @var{page_length} is less
2445 than or equal to 10, the header and footer are omitted, as if the
2446 @option{-t} option had been given.
2447
2448 @item -m
2449 @itemx --merge
2450 @opindex -m
2451 @opindex --merge
2452 Merge and print all @var{file}s in parallel, one in each column.  If a
2453 line is too long to fit in a column, it is truncated, unless the @option{-J}
2454 option is used.  @option{--sep-string[=@var{string}]} may be used.
2455 Empty pages in
2456 some @var{file}s (form feeds set) produce empty columns, still marked
2457 by @var{string}.  The result is a continuous line numbering and column
2458 marking throughout the whole merged file.  Completely empty merged pages
2459 show no separators or line numbers.  The default header becomes
2460 @samp{@var{date} @var{page}} with spaces inserted in the middle; this
2461 may be used with the @option{-h} or @option{--header} option to fill up
2462 the middle blank part.
2463
2464 @item -n[@var{number-separator}[@var{digits}]]
2465 @itemx --number-lines[=@var{number-separator}[@var{digits}]]
2466 @opindex -n
2467 @opindex --number-lines
2468 Provide @var{digits} digit line numbering (default for @var{digits} is
2469 5).  With multicolumn output the number occupies the first @var{digits}
2470 column positions of each text column or only each line of @option{-m}
2471 output.  With single column output the number precedes each line just as
2472 @option{-m} does.  Default counting of the line numbers starts with the
2473 first line of the input file (not the first line printed, compare the
2474 @option{--page} option and @option{-N} option).
2475 Optional argument @var{number-separator} is the character appended to
2476 the line number to separate it from the text followed.  The default
2477 separator is the TAB character.  In a strict sense a TAB is always
2478 printed with single column output only.  The TAB width varies
2479 with the TAB position, e.g., with the left @var{margin} specified
2480 by @option{-o} option.  With multicolumn output priority is given to
2481 @samp{equal width of output columns} (a POSIX specification).
2482 The TAB width is fixed to the value of the first column and does
2483 not change with different values of left @var{margin}.  That means a
2484 fixed number of spaces is always printed in the place of the
2485 @var{number-separator} TAB@.  The tabification depends upon the output
2486 position.
2487
2488 @item -N @var{line_number}
2489 @itemx --first-line-number=@var{line_number}
2490 @opindex -N
2491 @opindex --first-line-number
2492 Start line counting with the number @var{line_number} at first line of
2493 first page printed (in most cases not the first line of the input file).
2494
2495 @item -o @var{margin}
2496 @itemx --indent=@var{margin}
2497 @opindex -o
2498 @opindex --indent
2499 @cindex indenting lines
2500 @cindex left margin
2501 Indent each line with a margin @var{margin} spaces wide (default is zero).
2502 The total page width is the size of the margin plus the @var{page_width}
2503 set with the @option{-W/-w} option.  A limited overflow may occur with
2504 numbered single column output (compare @option{-n} option).
2505
2506 @item -r
2507 @itemx --no-file-warnings
2508 @opindex -r
2509 @opindex --no-file-warnings
2510 Do not print a warning message when an argument @var{file} cannot be
2511 opened.  (The exit status will still be nonzero, however.)
2512
2513 @item -s[@var{char}]
2514 @itemx --separator[=@var{char}]
2515 @opindex -s
2516 @opindex --separator
2517 Separate columns by a single character @var{char}.  The default for
2518 @var{char} is the TAB character without @option{-w} and @samp{no
2519 character} with @option{-w}.  Without @option{-s} the default separator
2520 @samp{space} is set.  @option{-s[char]} turns off line truncation of all
2521 three column options (@option{-COLUMN}|@option{-a -COLUMN}|@option{-m}) unless
2522 @option{-w} is set.  This is a POSIX-compliant formulation.
2523
2524
2525 @item -S[@var{string}]
2526 @itemx --sep-string[=@var{string}]
2527 @opindex -S
2528 @opindex --sep-string
2529 Use @var{string} to separate output columns.  The @option{-S} option doesn't
2530 affect the @option{-W/-w} option, unlike the @option{-s} option which does.  It
2531 does not affect line truncation or column alignment.
2532 Without @option{-S}, and with @option{-J}, @command{pr} uses the default output
2533 separator, TAB@.
2534 Without @option{-S} or @option{-J}, @command{pr} uses a @samp{space}
2535 (same as @option{-S"@w{ }"}).
2536 If no @samp{@var{string}} argument is specified, @samp{""} is assumed.
2537
2538 @item -t
2539 @itemx --omit-header
2540 @opindex -t
2541 @opindex --omit-header
2542 Do not print the usual header [and footer] on each page, and do not fill
2543 out the bottom of pages (with blank lines or a form feed).  No page
2544 structure is produced, but form feeds set in the input files are retained.
2545 The predefined pagination is not changed.  @option{-t} or @option{-T} may be
2546 useful together with other options; e.g.: @option{-t -e4}, expand TAB characters
2547 in the input file to 4 spaces but don't make any other changes.  Use of
2548 @option{-t} overrides @option{-h}.
2549
2550 @item -T
2551 @itemx --omit-pagination
2552 @opindex -T
2553 @opindex --omit-pagination
2554 Do not print header [and footer].  In addition eliminate all form feeds
2555 set in the input files.
2556
2557 @item -v
2558 @itemx --show-nonprinting
2559 @opindex -v
2560 @opindex --show-nonprinting
2561 Print nonprinting characters in octal backslash notation.
2562
2563 @item -w @var{page_width}
2564 @itemx --width=@var{page_width}
2565 @opindex -w
2566 @opindex --width
2567 Set page width to @var{page_width} characters for multiple text-column
2568 output only (default for @var{page_width} is 72).  @option{-s[CHAR]} turns
2569 off the default page width and any line truncation and column alignment.
2570 Lines of full length are merged, regardless of the column options
2571 set.  No @var{page_width} setting is possible with single column output.
2572 A POSIX-compliant formulation.
2573
2574 @item -W @var{page_width}
2575 @itemx --page_width=@var{page_width}
2576 @opindex -W
2577 @opindex --page_width
2578 Set the page width to @var{page_width} characters.  That's valid with and
2579 without a column option.  Text lines are truncated, unless @option{-J}
2580 is used.  Together with one of the three column options
2581 (@option{-@var{column}}, @option{-a -@var{column}} or @option{-m}) column
2582 alignment is always used.  The separator options @option{-S} or @option{-s}
2583 don't affect the @option{-W} option.  Default is 72 characters.  Without
2584 @option{-W @var{page_width}} and without any of the column options NO line
2585 truncation is used (defined to keep downward compatibility and to meet
2586 most frequent tasks).  That's equivalent to @option{-W 72 -J}@.  The header
2587 line is never truncated.
2588
2589 @end table
2590
2591 @exitstatus
2592
2593
2594 @node fold invocation
2595 @section @command{fold}: Wrap input lines to fit in specified width
2596
2597 @pindex fold
2598 @cindex wrapping long input lines
2599 @cindex folding long input lines
2600
2601 @command{fold} writes each @var{file} (@option{-} means standard input), or
2602 standard input if none are given, to standard output, breaking long
2603 lines.  Synopsis:
2604
2605 @example
2606 fold [@var{option}]@dots{} [@var{file}]@dots{}
2607 @end example
2608
2609 By default, @command{fold} breaks lines wider than 80 columns.  The output
2610 is split into as many lines as necessary.
2611
2612 @cindex screen columns
2613 @command{fold} counts screen columns by default; thus, a tab may count more
2614 than one column, backspace decreases the column count, and carriage
2615 return sets the column to zero.
2616
2617 The program accepts the following options.  Also see @ref{Common options}.
2618
2619 @table @samp
2620
2621 @item -b
2622 @itemx --bytes
2623 @opindex -b
2624 @opindex --bytes
2625 Count bytes rather than columns, so that tabs, backspaces, and carriage
2626 returns are each counted as taking up one column, just like other
2627 characters.
2628
2629 @item -s
2630 @itemx --spaces
2631 @opindex -s
2632 @opindex --spaces
2633 Break at word boundaries: the line is broken after the last blank before
2634 the maximum line length.  If the line contains no such blanks, the line
2635 is broken at the maximum line length as usual.
2636
2637 @item -w @var{width}
2638 @itemx --width=@var{width}
2639 @opindex -w
2640 @opindex --width
2641 Use a maximum line length of @var{width} columns instead of 80.
2642
2643 For compatibility @command{fold} supports an obsolete option syntax
2644 @option{-@var{width}}.  New scripts should use @option{-w @var{width}}
2645 instead.
2646
2647 @end table
2648
2649 @exitstatus
2650
2651
2652 @node Output of parts of files
2653 @chapter Output of parts of files
2654
2655 @cindex output of parts of files
2656 @cindex parts of files, output of
2657
2658 These commands output pieces of the input.
2659
2660 @menu
2661 * head invocation::             Output the first part of files.
2662 * tail invocation::             Output the last part of files.
2663 * split invocation::            Split a file into pieces.
2664 * csplit invocation::           Split a file into context-determined pieces.
2665 @end menu
2666
2667 @node head invocation
2668 @section @command{head}: Output the first part of files
2669
2670 @pindex head
2671 @cindex initial part of files, outputting
2672 @cindex first part of files, outputting
2673
2674 @command{head} prints the first part (10 lines by default) of each
2675 @var{file}; it reads from standard input if no files are given or
2676 when given a @var{file} of @option{-}.  Synopsis:
2677
2678 @example
2679 head [@var{option}]@dots{} [@var{file}]@dots{}
2680 @end example
2681
2682 If more than one @var{file} is specified, @command{head} prints a
2683 one-line header consisting of:
2684
2685 @example
2686 ==> @var{file name} <==
2687 @end example
2688
2689 @noindent
2690 before the output for each @var{file}.
2691
2692 The program accepts the following options.  Also see @ref{Common options}.
2693
2694 @table @samp
2695
2696 @item -c @var{k}
2697 @itemx --bytes=@var{k}
2698 @opindex -c
2699 @opindex --bytes
2700 Print the first @var{k} bytes, instead of initial lines.
2701 However, if @var{k} starts with a @samp{-},
2702 print all but the last @var{k} bytes of each file.
2703 @multiplierSuffixes{k}
2704
2705 @item -n @var{k}
2706 @itemx --lines=@var{k}
2707 @opindex -n
2708 @opindex --lines
2709 Output the first @var{k} lines.
2710 However, if @var{k} starts with a @samp{-},
2711 print all but the last @var{k} lines of each file.
2712 Size multiplier suffixes are the same as with the @option{-c} option.
2713
2714 @item -q
2715 @itemx --quiet
2716 @itemx --silent
2717 @opindex -q
2718 @opindex --quiet
2719 @opindex --silent
2720 Never print file name headers.
2721
2722 @item -v
2723 @itemx --verbose
2724 @opindex -v
2725 @opindex --verbose
2726 Always print file name headers.
2727
2728 @end table
2729
2730 For compatibility @command{head} also supports an obsolete option syntax
2731 @option{-@var{count}@var{options}}, which is recognized only if it is
2732 specified first.  @var{count} is a decimal number optionally followed
2733 by a size letter (@samp{b}, @samp{k}, @samp{m}) as in @option{-c}, or
2734 @samp{l} to mean count by lines, or other option letters (@samp{cqv}).
2735 Scripts intended for standard hosts should use @option{-c @var{count}}
2736 or @option{-n @var{count}} instead.  If your script must also run on
2737 hosts that support only the obsolete syntax, it is usually simpler to
2738 avoid @command{head}, e.g., by using @samp{sed 5q} instead of
2739 @samp{head -5}.
2740
2741 @exitstatus
2742
2743
2744 @node tail invocation
2745 @section @command{tail}: Output the last part of files
2746
2747 @pindex tail
2748 @cindex last part of files, outputting
2749
2750 @command{tail} prints the last part (10 lines by default) of each
2751 @var{file}; it reads from standard input if no files are given or
2752 when given a @var{file} of @samp{-}.  Synopsis:
2753
2754 @example
2755 tail [@var{option}]@dots{} [@var{file}]@dots{}
2756 @end example
2757
2758 If more than one @var{file} is specified, @command{tail} prints a
2759 one-line header consisting of:
2760
2761 @example
2762 ==> @var{file name} <==
2763 @end example
2764
2765 @noindent
2766 before the output for each @var{file}.
2767
2768 @cindex BSD @command{tail}
2769 @sc{gnu} @command{tail} can output any amount of data (some other versions of
2770 @command{tail} cannot).  It also has no @option{-r} option (print in
2771 reverse), since reversing a file is really a different job from printing
2772 the end of a file; BSD @command{tail} (which is the one with @option{-r}) can
2773 only reverse files that are at most as large as its buffer, which is
2774 typically 32 KiB@.  A more reliable and versatile way to reverse files is
2775 the @sc{gnu} @command{tac} command.
2776
2777 The program accepts the following options.  Also see @ref{Common options}.
2778
2779 @table @samp
2780
2781 @item -c @var{k}
2782 @itemx --bytes=@var{k}
2783 @opindex -c
2784 @opindex --bytes
2785 Output the last @var{k} bytes, instead of final lines.
2786 However, if @var{k} starts with a @samp{+}, start printing with the
2787 @var{k}th byte from the start of each file, instead of from the end.
2788 @multiplierSuffixes{k}
2789
2790 @item -f
2791 @itemx --follow[=@var{how}]
2792 @opindex -f
2793 @opindex --follow
2794 @cindex growing files
2795 @vindex name @r{follow option}
2796 @vindex descriptor @r{follow option}
2797 Loop forever trying to read more characters at the end of the file,
2798 presumably because the file is growing.
2799 If more than one file is given, @command{tail} prints a header whenever it
2800 gets output from a different file, to indicate which file that output is
2801 from.
2802
2803 There are two ways to specify how you'd like to track files with this option,
2804 but that difference is noticeable only when a followed file is removed or
2805 renamed.
2806 If you'd like to continue to track the end of a growing file even after
2807 it has been unlinked, use @option{--follow=descriptor}.  This is the default
2808 behavior, but it is not useful if you're tracking a log file that may be
2809 rotated (removed or renamed, then reopened).  In that case, use
2810 @option{--follow=name} to track the named file, perhaps by reopening it
2811 periodically to see if it has been removed and recreated by some other program.
2812 Note that the inotify-based implementation handles this case without
2813 the need for any periodic reopening.
2814
2815 No matter which method you use, if the tracked file is determined to have
2816 shrunk, @command{tail} prints a message saying the file has been truncated
2817 and resumes tracking the end of the file from the newly-determined endpoint.
2818
2819 When a file is removed, @command{tail}'s behavior depends on whether it is
2820 following the name or the descriptor.  When following by name, tail can
2821 detect that a file has been removed and gives a message to that effect,
2822 and if @option{--retry} has been specified it will continue checking
2823 periodically to see if the file reappears.
2824 When following a descriptor, tail does not detect that the file has
2825 been unlinked or renamed and issues no message;  even though the file
2826 may no longer be accessible via its original name, it may still be
2827 growing.
2828
2829 The option values @samp{descriptor} and @samp{name} may be specified only
2830 with the long form of the option, not with @option{-f}.
2831
2832 The @option{-f} option is ignored if
2833 no @var{file} operand is specified and standard input is a FIFO or a pipe.
2834 Likewise, the @option{-f} option has no effect for any
2835 operand specified as @samp{-}, when standard input is a FIFO or a pipe.
2836
2837 With kernel inotify support, output is triggered by file changes
2838 and is generally very prompt.
2839 Otherwise, @command{tail} sleeps for one second between checks---
2840 use @option{--sleep-interval=@var{n}} to change that default---which can
2841 make the output appear slightly less responsive or bursty.
2842 When using tail without inotify support, you can make it more responsive
2843 by using a sub-second sleep interval, e.g., via an alias like this:
2844
2845 @example
2846 alias tail='tail -s.1'
2847 @end example
2848
2849 @item -F
2850 @opindex -F
2851 This option is the same as @option{--follow=name --retry}.  That is, tail
2852 will attempt to reopen a file when it is removed.  Should this fail, tail
2853 will keep trying until it becomes accessible again.
2854
2855 @item --retry
2856 @opindex --retry
2857 This option is useful mainly when following by name (i.e., with
2858 @option{--follow=name}).
2859 Without this option, when tail encounters a file that doesn't
2860 exist or is otherwise inaccessible, it reports that fact and
2861 never checks it again.
2862
2863 @item --sleep-interval=@var{number}
2864 @opindex --sleep-interval
2865 Change the number of seconds to wait between iterations (the default is 1.0).
2866 During one iteration, every specified file is checked to see if it has
2867 changed size.
2868 Historical implementations of @command{tail} have required that
2869 @var{number} be an integer.  However, GNU @command{tail} accepts
2870 an arbitrary floating point number.  @xref{Floating point}.
2871 When @command{tail} uses inotify, this polling-related option
2872 is usually ignored.  However, if you also specify @option{--pid=@var{p}},
2873 @command{tail} checks whether process @var{p} is alive at least
2874 every @var{number} seconds.
2875
2876 @item --pid=@var{pid}
2877 @opindex --pid
2878 When following by name or by descriptor, you may specify the process ID,
2879 @var{pid}, of the sole writer of all @var{file} arguments.  Then, shortly
2880 after that process terminates, tail will also terminate.  This will
2881 work properly only if the writer and the tailing process are running on
2882 the same machine.  For example, to save the output of a build in a file
2883 and to watch the file grow, if you invoke @command{make} and @command{tail}
2884 like this then the tail process will stop when your build completes.
2885 Without this option, you would have had to kill the @code{tail -f}
2886 process yourself.
2887
2888 @example
2889 $ make >& makerr & tail --pid=$! -f makerr
2890 @end example
2891
2892 If you specify a @var{pid} that is not in use or that does not correspond
2893 to the process that is writing to the tailed files, then @command{tail}
2894 may terminate long before any @var{file}s stop growing or it may not
2895 terminate until long after the real writer has terminated.
2896 Note that @option{--pid} cannot be supported on some systems; @command{tail}
2897 will print a warning if this is the case.
2898
2899 @item --max-unchanged-stats=@var{n}
2900 @opindex --max-unchanged-stats
2901 When tailing a file by name, if there have been @var{n} (default
2902 n=@value{DEFAULT_MAX_N_UNCHANGED_STATS_BETWEEN_OPENS}) consecutive
2903 iterations for which the file has not changed, then
2904 @code{open}/@code{fstat} the file to determine if that file name is
2905 still associated with the same device/inode-number pair as before.
2906 When following a log file that is rotated, this is approximately the
2907 number of seconds between when tail prints the last pre-rotation lines
2908 and when it prints the lines that have accumulated in the new log file.
2909 This option is meaningful only when polling (i.e., without inotify)
2910 and when following by name.
2911
2912 @item -n @var{k}
2913 @itemx --lines=@var{k}
2914 @opindex -n
2915 @opindex --lines
2916 Output the last @var{k} lines.
2917 However, if @var{k} starts with a @samp{+}, start printing with the
2918 @var{k}th line from the start of each file, instead of from the end.
2919 Size multiplier suffixes are the same as with the @option{-c} option.
2920
2921 @item -q
2922 @itemx --quiet
2923 @itemx --silent
2924 @opindex -q
2925 @opindex --quiet
2926 @opindex --silent
2927 Never print file name headers.
2928
2929 @item -v
2930 @itemx --verbose
2931 @opindex -v
2932 @opindex --verbose
2933 Always print file name headers.
2934
2935 @end table
2936
2937 For compatibility @command{tail} also supports an obsolete usage
2938 @samp{tail -[@var{count}][bcl][f] [@var{file}]}, which is recognized
2939 only if it does not conflict with the usage described
2940 above.  This obsolete form uses exactly one option and at most one
2941 file.  In the option, @var{count} is an optional decimal number optionally
2942 followed by a size letter (@samp{b}, @samp{c}, @samp{l}) to mean count
2943 by 512-byte blocks, bytes, or lines, optionally followed by @samp{f}
2944 which has the same meaning as @option{-f}.
2945
2946 @vindex _POSIX2_VERSION
2947 On older systems, the leading @samp{-} can be replaced by @samp{+} in
2948 the obsolete option syntax with the same meaning as in counts, and
2949 obsolete usage overrides normal usage when the two conflict.
2950 This obsolete behavior can be enabled or disabled with the
2951 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
2952 conformance}).
2953
2954 Scripts intended for use on standard hosts should avoid obsolete
2955 syntax and should use @option{-c @var{count}[b]}, @option{-n
2956 @var{count}}, and/or @option{-f} instead.  If your script must also
2957 run on hosts that support only the obsolete syntax, you can often
2958 rewrite it to avoid problematic usages, e.g., by using @samp{sed -n
2959 '$p'} rather than @samp{tail -1}.  If that's not possible, the script
2960 can use a test like @samp{if tail -c +1 </dev/null >/dev/null 2>&1;
2961 then @dots{}} to decide which syntax to use.
2962
2963 Even if your script assumes the standard behavior, you should still
2964 beware usages whose behaviors differ depending on the POSIX
2965 version.  For example, avoid @samp{tail - main.c}, since it might be
2966 interpreted as either @samp{tail main.c} or as @samp{tail -- -
2967 main.c}; avoid @samp{tail -c 4}, since it might mean either @samp{tail
2968 -c4} or @samp{tail -c 10 4}; and avoid @samp{tail +4}, since it might
2969 mean either @samp{tail ./+4} or @samp{tail -n +4}.
2970
2971 @exitstatus
2972
2973
2974 @node split invocation
2975 @section @command{split}: Split a file into pieces.
2976
2977 @pindex split
2978 @cindex splitting a file into pieces
2979 @cindex pieces, splitting a file into
2980
2981 @command{split} creates output files containing consecutive or interleaved
2982 sections of @var{input}  (standard input if none is given or @var{input}
2983 is @samp{-}).  Synopsis:
2984
2985 @example
2986 split [@var{option}] [@var{input} [@var{prefix}]]
2987 @end example
2988
2989 By default, @command{split} puts 1000 lines of @var{input} (or whatever is
2990 left over for the last section), into each output file.
2991
2992 @cindex output file name prefix
2993 The output files' names consist of @var{prefix} (@samp{x} by default)
2994 followed by a group of characters (@samp{aa}, @samp{ab}, @dots{} by
2995 default), such that concatenating the output files in traditional
2996 sorted order by file name produces the original input file (except
2997 @option{-nr/@var{n}}).  By default split will initially create files
2998 with two generated suffix characters, and will increase this width by two
2999 when the next most significant position reaches the last character.
3000 (@samp{yz}, @samp{zaaa}, @samp{zaab}, @dots{}).  In this way an arbitrary
3001 number of output files are supported, which sort as described above,
3002 even in the presence of an @option{--additional-suffix} option.
3003 If the @option{-a} option is specified and the output file names are
3004 exhausted, @command{split} reports an error without deleting the
3005 output files that it did create.
3006
3007 The program accepts the following options.  Also see @ref{Common options}.
3008
3009 @table @samp
3010
3011 @item -l @var{lines}
3012 @itemx --lines=@var{lines}
3013 @opindex -l
3014 @opindex --lines
3015 Put @var{lines} lines of @var{input} into each output file.
3016
3017 For compatibility @command{split} also supports an obsolete
3018 option syntax @option{-@var{lines}}.  New scripts should use
3019 @option{-l @var{lines}} instead.
3020
3021 @item -b @var{size}
3022 @itemx --bytes=@var{size}
3023 @opindex -b
3024 @opindex --bytes
3025 Put @var{size} bytes of @var{input} into each output file.
3026 @multiplierSuffixes{size}
3027
3028 @item -C @var{size}
3029 @itemx --line-bytes=@var{size}
3030 @opindex -C
3031 @opindex --line-bytes
3032 Put into each output file as many complete lines of @var{input} as
3033 possible without exceeding @var{size} bytes.  Individual lines longer than
3034 @var{size} bytes are broken into multiple files.
3035 @var{size} has the same format as for the @option{--bytes} option.
3036
3037 @item --filter=@var{command}
3038 @opindex --filter
3039 With this option, rather than simply writing to each output file,
3040 write through a pipe to the specified shell @var{command} for each output file.
3041 @var{command} should use the $FILE environment variable, which is set
3042 to a different output file name for each invocation of the command.
3043 For example, imagine that you have a 1TiB compressed file
3044 that, if uncompressed, would be too large to reside on disk,
3045 yet you must split it into individually-compressed pieces
3046 of a more manageable size.
3047 To do that, you might run this command:
3048
3049 @example
3050 xz -dc BIG.xz | split -b200G --filter='xz > $FILE.xz' - big-
3051 @end example
3052
3053 Assuming a 10:1 compression ratio, that would create about fifty 20GiB files
3054 with names @file{big-aa.xz}, @file{big-ab.xz}, @file{big-ac.xz}, etc.
3055
3056 @item -n @var{chunks}
3057 @itemx --number=@var{chunks}
3058 @opindex -n
3059 @opindex --number
3060
3061 Split @var{input} to @var{chunks} output files where @var{chunks} may be:
3062
3063 @example
3064 @var{n}      generate @var{n} files based on current size of @var{input}
3065 @var{k}/@var{n}    only output @var{k}th of @var{n} to stdout
3066 l/@var{n}    generate @var{n} files without splitting lines
3067 l/@var{k}/@var{n}  likewise but only output @var{k}th of @var{n} to stdout
3068 r/@var{n}    like @samp{l} but use round robin distribution
3069 r/@var{k}/@var{n}  likewise but only output @var{k}th of @var{n} to stdout
3070 @end example
3071
3072 Any excess bytes remaining after dividing the @var{input}
3073 into @var{n} chunks, are assigned to the last chunk.
3074 Any excess bytes appearing after the initial calculation are discarded
3075 (except when using @samp{r} mode).
3076
3077 All @var{n} files are created even if there are fewer than @var{n} lines,
3078 or the @var{input} is truncated.
3079
3080 For @samp{l} mode, chunks are approximately @var{input} size / @var{n}.
3081 The @var{input} is partitioned into @var{n} equal sized portions, with
3082 the last assigned any excess.  If a line @emph{starts} within a partition
3083 it is written completely to the corresponding file.  Since lines
3084 are not split even if they overlap a partition, the files written
3085 can be larger or smaller than the partition size, and even empty
3086 if a line is so long as to completely overlap the partition.
3087
3088 For @samp{r} mode, the size of @var{input} is irrelevant,
3089 and so can be a pipe for example.
3090
3091 @item -a @var{length}
3092 @itemx --suffix-length=@var{length}
3093 @opindex -a
3094 @opindex --suffix-length
3095 Use suffixes of length @var{length}.  If a @var{length} of 0 is specified,
3096 this is the same as if (any previous) @option{-a} was not specified, and
3097 thus enables the default behavior, which starts the suffix length at 2,
3098 and unless @option{-n} or @option{--numeric-suffixes=@var{from}} is
3099 specified, will auto increase the length by 2 as required.
3100
3101 @item -d
3102 @itemx --numeric-suffixes[=@var{from}]
3103 @opindex -d
3104 @opindex --numeric-suffixes
3105 Use digits in suffixes rather than lower-case letters.  The numerical
3106 suffix counts from @var{from} if specified, 0 otherwise.
3107 Note specifying a @var{from} value also disables the default
3108 auto suffix length expansion described above, and so you may also
3109 want to specify @option{-a} to allow suffixes beyond @samp{99}.
3110
3111 @item --additional-suffix=@var{suffix}
3112 @opindex --additional-suffix
3113 Append an additional @var{suffix} to output file names.  @var{suffix}
3114 must not contain slash.
3115
3116 @item -e
3117 @itemx --elide-empty-files
3118 @opindex -e
3119 @opindex --elide-empty-files
3120 Suppress the generation of zero-length output files.  This can happen
3121 with the @option{--number} option if a file is (truncated to be) shorter
3122 than the number requested, or if a line is so long as to completely
3123 span a chunk.  The output file sequence numbers, always run consecutively
3124 even when this option is specified.
3125
3126 @item -u
3127 @itemx --unbuffered
3128 @opindex -u
3129 @opindex --unbuffered
3130 Immediately copy input to output in @option{--number r/...} mode,
3131 which is a much slower mode of operation.
3132
3133 @item --verbose
3134 @opindex --verbose
3135 Write a diagnostic just before each output file is opened.
3136
3137 @end table
3138
3139 @exitstatus
3140
3141 Here are a few examples to illustrate how the
3142 @option{--number} (@option{-n}) option works:
3143
3144 Notice how, by default, one line may be split onto two or more:
3145
3146 @example
3147 $ seq -w 6 10 > k; split -n3 k; head xa?
3148 ==> xaa <==
3149 06
3150 07
3151 ==> xab <==
3152
3153 08
3154 0
3155 ==> xac <==
3156 9
3157 10
3158 @end example
3159
3160 Use the "l/" modifier to suppress that:
3161
3162 @example
3163 $ seq -w 6 10 > k; split -nl/3 k; head xa?
3164 ==> xaa <==
3165 06
3166 07
3167
3168 ==> xab <==
3169 08
3170 09
3171
3172 ==> xac <==
3173 10
3174 @end example
3175
3176 Use the "r/" modifier to distribute lines in a round-robin fashion:
3177
3178 @example
3179 $ seq -w 6 10 > k; split -nr/3 k; head xa?
3180 ==> xaa <==
3181 06
3182 09
3183
3184 ==> xab <==
3185 07
3186 10
3187
3188 ==> xac <==
3189 08
3190 @end example
3191
3192 You can also extract just the Kth chunk.
3193 This extracts and prints just the 7th "chunk" of 33:
3194
3195 @example
3196 $ seq 100 > k; split -nl/7/33 k
3197 20
3198 21
3199 22
3200 @end example
3201
3202
3203 @node csplit invocation
3204 @section @command{csplit}: Split a file into context-determined pieces
3205
3206 @pindex csplit
3207 @cindex context splitting
3208 @cindex splitting a file into pieces by context
3209
3210 @command{csplit} creates zero or more output files containing sections of
3211 @var{input} (standard input if @var{input} is @samp{-}).  Synopsis:
3212
3213 @example
3214 csplit [@var{option}]@dots{} @var{input} @var{pattern}@dots{}
3215 @end example
3216
3217 The contents of the output files are determined by the @var{pattern}
3218 arguments, as detailed below.  An error occurs if a @var{pattern}
3219 argument refers to a nonexistent line of the input file (e.g., if no
3220 remaining line matches a given regular expression).  After every
3221 @var{pattern} has been matched, any remaining input is copied into one
3222 last output file.
3223
3224 By default, @command{csplit} prints the number of bytes written to each
3225 output file after it has been created.
3226
3227 The types of pattern arguments are:
3228
3229 @table @samp
3230
3231 @item @var{n}
3232 Create an output file containing the input up to but not including line
3233 @var{n} (a positive integer).  If followed by a repeat count, also
3234 create an output file containing the next @var{n} lines of the input
3235 file once for each repeat.
3236
3237 @item /@var{regexp}/[@var{offset}]
3238 Create an output file containing the current line up to (but not
3239 including) the next line of the input file that contains a match for
3240 @var{regexp}.  The optional @var{offset} is an integer.
3241 If it is given, the input up to (but not including) the
3242 matching line plus or minus @var{offset} is put into the output file,
3243 and the line after that begins the next section of input.
3244
3245 @item %@var{regexp}%[@var{offset}]
3246 Like the previous type, except that it does not create an output
3247 file, so that section of the input file is effectively ignored.
3248
3249 @item @{@var{repeat-count}@}
3250 Repeat the previous pattern @var{repeat-count} additional
3251 times.  The @var{repeat-count} can either be a positive integer or an
3252 asterisk, meaning repeat as many times as necessary until the input is
3253 exhausted.
3254
3255 @end table
3256
3257 The output files' names consist of a prefix (@samp{xx} by default)
3258 followed by a suffix.  By default, the suffix is an ascending sequence
3259 of two-digit decimal numbers from @samp{00} to @samp{99}.  In any case,
3260 concatenating the output files in sorted order by file name produces the
3261 original input file.
3262
3263 By default, if @command{csplit} encounters an error or receives a hangup,
3264 interrupt, quit, or terminate signal, it removes any output files
3265 that it has created so far before it exits.
3266
3267 The program accepts the following options.  Also see @ref{Common options}.
3268
3269 @table @samp
3270
3271 @item -f @var{prefix}
3272 @itemx --prefix=@var{prefix}
3273 @opindex -f
3274 @opindex --prefix
3275 @cindex output file name prefix
3276 Use @var{prefix} as the output file name prefix.
3277
3278 @item -b @var{suffix}
3279 @itemx --suffix=@var{suffix}
3280 @opindex -b
3281 @opindex --suffix
3282 @cindex output file name suffix
3283 Use @var{suffix} as the output file name suffix.  When this option is
3284 specified, the suffix string must include exactly one
3285 @code{printf(3)}-style conversion specification, possibly including
3286 format specification flags, a field width, a precision specifications,
3287 or all of these kinds of modifiers.  The format letter must convert a
3288 binary unsigned integer argument to readable form.  The format letters
3289 @samp{d} and @samp{i} are aliases for @samp{u}, and the
3290 @samp{u}, @samp{o}, @samp{x}, and @samp{X} conversions are allowed.  The
3291 entire @var{suffix} is given (with the current output file number) to
3292 @code{sprintf(3)} to form the file name suffixes for each of the
3293 individual output files in turn.  If this option is used, the
3294 @option{--digits} option is ignored.
3295
3296 @item -n @var{digits}
3297 @itemx --digits=@var{digits}
3298 @opindex -n
3299 @opindex --digits
3300 Use output file names containing numbers that are @var{digits} digits
3301 long instead of the default 2.
3302
3303 @item -k
3304 @itemx --keep-files
3305 @opindex -k
3306 @opindex --keep-files
3307 Do not remove output files when errors are encountered.
3308
3309 @item -z
3310 @itemx --elide-empty-files
3311 @opindex -z
3312 @opindex --elide-empty-files
3313 Suppress the generation of zero-length output files.  (In cases where
3314 the section delimiters of the input file are supposed to mark the first
3315 lines of each of the sections, the first output file will generally be a
3316 zero-length file unless you use this option.)  The output file sequence
3317 numbers always run consecutively starting from 0, even when this option
3318 is specified.
3319
3320 @item -s
3321 @itemx -q
3322 @itemx --silent
3323 @itemx --quiet
3324 @opindex -s
3325 @opindex -q
3326 @opindex --silent
3327 @opindex --quiet
3328 Do not print counts of output file sizes.
3329
3330 @end table
3331
3332 @exitstatus
3333
3334 Here is an example of its usage.
3335 First, create an empty directory for the exercise,
3336 and cd into it:
3337
3338 @example
3339 $ mkdir d && cd d
3340 @end example
3341
3342 Now, split the sequence of 1..14 on lines that end with 0 or 5:
3343
3344 @example
3345 $ seq 14 | csplit - '/[05]$/' '@{*@}'
3346 8
3347 10
3348 15
3349 @end example
3350
3351 Each number printed above is the size of an output
3352 file that csplit has just created.
3353 List the names of those output files:
3354
3355 @example
3356 $ ls
3357 xx00  xx01  xx02
3358 @end example
3359
3360 Use @command{head} to show their contents:
3361
3362 @example
3363 $ head xx*
3364 ==> xx00 <==
3365 1
3366 2
3367 3
3368 4
3369
3370 ==> xx01 <==
3371 5
3372 6
3373 7
3374 8
3375 9
3376
3377 ==> xx02 <==
3378 10
3379 11
3380 12
3381 13
3382 14
3383 @end example
3384
3385 @node Summarizing files
3386 @chapter Summarizing files
3387
3388 @cindex summarizing files
3389
3390 These commands generate just a few numbers representing entire
3391 contents of files.
3392
3393 @menu
3394 * wc invocation::               Print newline, word, and byte counts.
3395 * sum invocation::              Print checksum and block counts.
3396 * cksum invocation::            Print CRC checksum and byte counts.
3397 * md5sum invocation::           Print or check MD5 digests.
3398 * sha1sum invocation::          Print or check SHA-1 digests.
3399 * sha2 utilities::              Print or check SHA-2 digests.
3400 @end menu
3401
3402
3403 @node wc invocation
3404 @section @command{wc}: Print newline, word, and byte counts
3405
3406 @pindex wc
3407 @cindex byte count
3408 @cindex character count
3409 @cindex word count
3410 @cindex line count
3411
3412 @command{wc} counts the number of bytes, characters, whitespace-separated
3413 words, and newlines in each given @var{file}, or standard input if none
3414 are given or for a @var{file} of @samp{-}.  Synopsis:
3415
3416 @example
3417 wc [@var{option}]@dots{} [@var{file}]@dots{}
3418 @end example
3419
3420 @cindex total counts
3421 @command{wc} prints one line of counts for each file, and if the file was
3422 given as an argument, it prints the file name following the counts.  If
3423 more than one @var{file} is given, @command{wc} prints a final line
3424 containing the cumulative counts, with the file name @file{total}.  The
3425 counts are printed in this order: newlines, words, characters, bytes,
3426 maximum line length.
3427 Each count is printed right-justified in a field with at least one
3428 space between fields so that the numbers and file names normally line
3429 up nicely in columns.  The width of the count fields varies depending
3430 on the inputs, so you should not depend on a particular field width.
3431 However, as a GNU extension, if only one count is printed,
3432 it is guaranteed to be printed without leading spaces.
3433
3434 By default, @command{wc} prints three counts: the newline, words, and byte
3435 counts.  Options can specify that only certain counts be printed.
3436 Options do not undo others previously given, so
3437
3438 @example
3439 wc --bytes --words
3440 @end example
3441
3442 @noindent
3443 prints both the byte counts and the word counts.
3444
3445 With the @option{--max-line-length} option, @command{wc} prints the length
3446 of the longest line per file, and if there is more than one file it
3447 prints the maximum (not the sum) of those lengths.  The line lengths here
3448 are measured in screen columns, according to the current locale and
3449 assuming tab positions in every 8th column.
3450
3451 The program accepts the following options.  Also see @ref{Common options}.
3452
3453 @table @samp
3454
3455 @item -c
3456 @itemx --bytes
3457 @opindex -c
3458 @opindex --bytes
3459 Print only the byte counts.
3460
3461 @item -m
3462 @itemx --chars
3463 @opindex -m
3464 @opindex --chars
3465 Print only the character counts.
3466
3467 @item -w
3468 @itemx --words
3469 @opindex -w
3470 @opindex --words
3471 Print only the word counts.
3472
3473 @item -l
3474 @itemx --lines
3475 @opindex -l
3476 @opindex --lines
3477 Print only the newline counts.
3478
3479 @item -L
3480 @itemx --max-line-length
3481 @opindex -L
3482 @opindex --max-line-length
3483 Print only the maximum line lengths.
3484
3485 @macro filesZeroFromOption{cmd,withTotalOption,subListOutput}
3486 @item --files0-from=@var{file}
3487 @opindex --files0-from=@var{file}
3488 @c This is commented out to avoid a texi2dvi failure.
3489 @c texi2dvi (GNU Texinfo 4.11) 1.104
3490 @c @cindex including files from @command{\cmd\}
3491 Disallow processing files named on the command line, and instead process
3492 those named in file @var{file}; each name being terminated by a zero byte
3493 (ASCII @sc{nul}).
3494 This is useful \withTotalOption\
3495 when the list of file names is so long that it may exceed a command line
3496 length limitation.
3497 In such cases, running @command{\cmd\} via @command{xargs} is undesirable
3498 because it splits the list into pieces and makes @command{\cmd\} print
3499 \subListOutput\ for each sublist rather than for the entire list.
3500 One way to produce a list of ASCII @sc{nul} terminated file
3501 names is with @sc{gnu}
3502 @command{find}, using its @option{-print0} predicate.
3503 If @var{file} is @samp{-} then the ASCII @sc{nul} terminated
3504 file names are read from standard input.
3505 @end macro
3506 @filesZeroFromOption{wc,,a total}
3507
3508 For example, to find the length of the longest line in any @file{.c} or
3509 @file{.h} file in the current hierarchy, do this:
3510
3511 @example
3512 find . -name '*.[ch]' -print0 |
3513   wc -L --files0-from=- | tail -n1
3514 @end example
3515
3516 @end table
3517
3518 @exitstatus
3519
3520
3521 @node sum invocation
3522 @section @command{sum}: Print checksum and block counts
3523
3524 @pindex sum
3525 @cindex 16-bit checksum
3526 @cindex checksum, 16-bit
3527
3528 @command{sum} computes a 16-bit checksum for each given @var{file}, or
3529 standard input if none are given or for a @var{file} of @samp{-}.  Synopsis:
3530
3531 @example
3532 sum [@var{option}]@dots{} [@var{file}]@dots{}
3533 @end example
3534
3535 @command{sum} prints the checksum for each @var{file} followed by the
3536 number of blocks in the file (rounded up).  If more than one @var{file}
3537 is given, file names are also printed (by default).  (With the
3538 @option{--sysv} option, corresponding file names are printed when there is
3539 at least one file argument.)
3540
3541 By default, @sc{gnu} @command{sum} computes checksums using an algorithm
3542 compatible with BSD @command{sum} and prints file sizes in units of
3543 1024-byte blocks.
3544
3545 The program accepts the following options.  Also see @ref{Common options}.
3546
3547 @table @samp
3548
3549 @item -r
3550 @opindex -r
3551 @cindex BSD @command{sum}
3552 Use the default (BSD compatible) algorithm.  This option is included for
3553 compatibility with the System V @command{sum}.  Unless @option{-s} was also
3554 given, it has no effect.
3555
3556 @item -s
3557 @itemx --sysv
3558 @opindex -s
3559 @opindex --sysv
3560 @cindex System V @command{sum}
3561 Compute checksums using an algorithm compatible with System V
3562 @command{sum}'s default, and print file sizes in units of 512-byte blocks.
3563
3564 @end table
3565
3566 @command{sum} is provided for compatibility; the @command{cksum} program (see
3567 next section) is preferable in new applications.
3568
3569 @exitstatus
3570
3571
3572 @node cksum invocation
3573 @section @command{cksum}: Print CRC checksum and byte counts
3574
3575 @pindex cksum
3576 @cindex cyclic redundancy check
3577 @cindex CRC checksum
3578
3579 @command{cksum} computes a cyclic redundancy check (CRC) checksum for each
3580 given @var{file}, or standard input if none are given or for a
3581 @var{file} of @samp{-}.  Synopsis:
3582
3583 @example
3584 cksum [@var{option}]@dots{} [@var{file}]@dots{}
3585 @end example
3586
3587 @command{cksum} prints the CRC checksum for each file along with the number
3588 of bytes in the file, and the file name unless no arguments were given.
3589
3590 @command{cksum} is typically used to ensure that files
3591 transferred by unreliable means (e.g., netnews) have not been corrupted,
3592 by comparing the @command{cksum} output for the received files with the
3593 @command{cksum} output for the original files (typically given in the
3594 distribution).
3595
3596 The CRC algorithm is specified by the POSIX standard.  It is not
3597 compatible with the BSD or System V @command{sum} algorithms (see the
3598 previous section); it is more robust.
3599
3600 The only options are @option{--help} and @option{--version}.  @xref{Common
3601 options}.
3602
3603 @exitstatus
3604
3605
3606 @node md5sum invocation
3607 @section @command{md5sum}: Print or check MD5 digests
3608
3609 @pindex md5sum
3610 @cindex MD5
3611 @cindex 128-bit checksum
3612 @cindex checksum, 128-bit
3613 @cindex fingerprint, 128-bit
3614 @cindex message-digest, 128-bit
3615
3616 @command{md5sum} computes a 128-bit checksum (or @dfn{fingerprint} or
3617 @dfn{message-digest}) for each specified @var{file}.
3618
3619 Note: The MD5 digest is more reliable than a simple CRC (provided by
3620 the @command{cksum} command) for detecting accidental file corruption,
3621 as the chances of accidentally having two files with identical MD5
3622 are vanishingly small.  However, it should not be considered secure
3623 against malicious tampering: although finding a file with a given MD5
3624 fingerprint is considered infeasible at the moment, it is known how
3625 to modify certain files, including digital certificates, so that they
3626 appear valid when signed with an MD5 digest.
3627 For more secure hashes, consider using SHA-2.  @xref{sha2 utilities}.
3628
3629 If a @var{file} is specified as @samp{-} or if no files are given
3630 @command{md5sum} computes the checksum for the standard input.
3631 @command{md5sum} can also determine whether a file and checksum are
3632 consistent.  Synopsis:
3633
3634 @example
3635 md5sum [@var{option}]@dots{} [@var{file}]@dots{}
3636 @end example
3637
3638 For each @var{file}, @samp{md5sum} outputs the MD5 checksum, a flag
3639 indicating binary or text input mode, and the file name.
3640 If @var{file} contains a backslash or newline, the
3641 line is started with a backslash, and each problematic character in
3642 the file name is escaped with a backslash, making the output
3643 unambiguous even in the presence of arbitrary file names.
3644 If @var{file} is omitted or specified as @samp{-}, standard input is read.
3645
3646 The program accepts the following options.  Also see @ref{Common options}.
3647
3648 @table @samp
3649
3650 @item -b
3651 @itemx --binary
3652 @opindex -b
3653 @opindex --binary
3654 @cindex binary input files
3655 Treat each input file as binary, by reading it in binary mode and
3656 outputting a @samp{*} flag.  This is the inverse of @option{--text}.
3657 On systems like GNU that do not distinguish between binary
3658 and text files, this option merely flags each input mode as binary:
3659 the MD5 checksum is unaffected.  This option is the default on systems
3660 like MS-DOS that distinguish between binary and text files, except
3661 for reading standard input when standard input is a terminal.
3662
3663 @item -c
3664 @itemx --check
3665 Read file names and checksum information (not data) from each
3666 @var{file} (or from stdin if no @var{file} was specified) and report
3667 whether the checksums match the contents of the named files.
3668 The input to this mode of @command{md5sum} is usually the output of
3669 a prior, checksum-generating run of @samp{md5sum}.
3670 Each valid line of input consists of an MD5 checksum, a binary/text
3671 flag, and then a file name.
3672 Binary mode is indicated with @samp{*}, text with @samp{ } (space).
3673 For each such line, @command{md5sum} reads the named file and computes its
3674 MD5 checksum.  Then, if the computed message digest does not match the
3675 one on the line with the file name, the file is noted as having
3676 failed the test.  Otherwise, the file passes the test.
3677 By default, for each valid line, one line is written to standard
3678 output indicating whether the named file passed the test.
3679 After all checks have been performed, if there were any failures,
3680 a warning is issued to standard error.
3681 Use the @option{--status} option to inhibit that output.
3682 If any listed file cannot be opened or read, if any valid line has
3683 an MD5 checksum inconsistent with the associated file, or if no valid
3684 line is found, @command{md5sum} exits with nonzero status.  Otherwise,
3685 it exits successfully.
3686
3687 @item --quiet
3688 @opindex --quiet
3689 @cindex verifying MD5 checksums
3690 This option is useful only when verifying checksums.
3691 When verifying checksums, don't generate an 'OK' message per successfully
3692 checked file.  Files that fail the verification are reported in the
3693 default one-line-per-file format.  If there is any checksum mismatch,
3694 print a warning summarizing the failures to standard error.
3695
3696 @item --status
3697 @opindex --status
3698 @cindex verifying MD5 checksums
3699 This option is useful only when verifying checksums.
3700 When verifying checksums, don't generate the default one-line-per-file
3701 diagnostic and don't output the warning summarizing any failures.
3702 Failures to open or read a file still evoke individual diagnostics to
3703 standard error.
3704 If all listed files are readable and are consistent with the associated
3705 MD5 checksums, exit successfully.  Otherwise exit with a status code
3706 indicating there was a failure.
3707
3708 @item --tag
3709 @opindex --tag
3710 @cindex BSD output
3711 Output BSD style checksums, which indicate the checksum algorithm used.
3712 As a GNU extension, file names with problematic characters
3713 are escaped as described above, with the same escaping indicator of @samp{\}
3714 at the start of the line, being used.
3715 The @option{--tag} option implies binary mode, and is disallowed with
3716 @option{--text} mode as supporting that would unnecessarily complicate
3717 the output format, while providing little benefit.
3718
3719 @item -t
3720 @itemx --text
3721 @opindex -t
3722 @opindex --text
3723 @cindex text input files
3724 Treat each input file as text, by reading it in text mode and
3725 outputting a @samp{ } flag.  This is the inverse of @option{--binary}.
3726 This option is the default on systems like GNU that do not
3727 distinguish between binary and text files.  On other systems, it is
3728 the default for reading standard input when standard input is a
3729 terminal.  This mode is never defaulted to if @option{--tag} is used.
3730
3731 @item -w
3732 @itemx --warn
3733 @opindex -w
3734 @opindex --warn
3735 @cindex verifying MD5 checksums
3736 When verifying checksums, warn about improperly formatted MD5 checksum lines.
3737 This option is useful only if all but a few lines in the checked input
3738 are valid.
3739
3740 @item --strict
3741 @opindex --strict
3742 @cindex verifying MD5 checksums
3743 When verifying checksums,
3744 if one or more input line is invalid,
3745 exit nonzero after all warnings have been issued.
3746
3747 @end table
3748
3749 @exitstatus
3750
3751
3752 @node sha1sum invocation
3753 @section @command{sha1sum}: Print or check SHA-1 digests
3754
3755 @pindex sha1sum
3756 @cindex SHA-1
3757 @cindex 160-bit checksum
3758 @cindex checksum, 160-bit
3759 @cindex fingerprint, 160-bit
3760 @cindex message-digest, 160-bit
3761
3762 @command{sha1sum} computes a 160-bit checksum for each specified
3763 @var{file}.  The usage and options of this command are precisely the
3764 same as for @command{md5sum}.  @xref{md5sum invocation}.
3765
3766 Note: The SHA-1 digest is more secure than MD5, and no collisions of
3767 it are known (different files having the same fingerprint).  However,
3768 it is known that they can be produced with considerable, but not
3769 unreasonable, resources.  For this reason, it is generally considered
3770 that SHA-1 should be gradually phased out in favor of the more secure
3771 SHA-2 hash algorithms.  @xref{sha2 utilities}.
3772
3773
3774 @node sha2 utilities
3775 @section sha2 utilities: Print or check SHA-2 digests
3776
3777 @pindex sha224sum
3778 @pindex sha256sum
3779 @pindex sha384sum
3780 @pindex sha512sum
3781 @cindex SHA-2
3782 @cindex 224-bit checksum
3783 @cindex 256-bit checksum
3784 @cindex 384-bit checksum
3785 @cindex 512-bit checksum
3786 @cindex checksum, 224-bit
3787 @cindex checksum, 256-bit
3788 @cindex checksum, 384-bit
3789 @cindex checksum, 512-bit
3790 @cindex fingerprint, 224-bit
3791 @cindex fingerprint, 256-bit
3792 @cindex fingerprint, 384-bit
3793 @cindex fingerprint, 512-bit
3794 @cindex message-digest, 224-bit
3795 @cindex message-digest, 256-bit
3796 @cindex message-digest, 384-bit
3797 @cindex message-digest, 512-bit
3798
3799 The commands @command{sha224sum}, @command{sha256sum},
3800 @command{sha384sum} and @command{sha512sum} compute checksums of
3801 various lengths (respectively 224, 256, 384 and 512 bits),
3802 collectively known as the SHA-2 hashes.  The usage and options of
3803 these commands are precisely the same as for @command{md5sum}.
3804 @xref{md5sum invocation}.
3805
3806 Note: The SHA384 and SHA512 digests are considerably slower to
3807 compute, especially on 32-bit computers, than SHA224 or SHA256.
3808
3809
3810 @node Operating on sorted files
3811 @chapter Operating on sorted files
3812
3813 @cindex operating on sorted files
3814 @cindex sorted files, operations on
3815
3816 These commands work with (or produce) sorted files.
3817
3818 @menu
3819 * sort invocation::             Sort text files.
3820 * shuf invocation::             Shuffle text files.
3821 * uniq invocation::             Uniquify files.
3822 * comm invocation::             Compare two sorted files line by line.
3823 * ptx invocation::              Produce a permuted index of file contents.
3824 * tsort invocation::            Topological sort.
3825 @end menu
3826
3827
3828 @node sort invocation
3829 @section @command{sort}: Sort text files
3830
3831 @pindex sort
3832 @cindex sorting files
3833
3834 @command{sort} sorts, merges, or compares all the lines from the given
3835 files, or standard input if none are given or for a @var{file} of
3836 @samp{-}.  By default, @command{sort} writes the results to standard
3837 output.  Synopsis:
3838
3839 @example
3840 sort [@var{option}]@dots{} [@var{file}]@dots{}
3841 @end example
3842
3843 @command{sort} has three modes of operation: sort (the default), merge,
3844 and check for sortedness.  The following options change the operation
3845 mode:
3846
3847 @table @samp
3848
3849 @item -c
3850 @itemx --check
3851 @itemx --check=diagnose-first
3852 @opindex -c
3853 @opindex --check
3854 @cindex checking for sortedness
3855 Check whether the given file is already sorted: if it is not all
3856 sorted, print a diagnostic containing the first out-of-order line and
3857 exit with a status of 1.
3858 Otherwise, exit successfully.
3859 At most one input file can be given.
3860
3861 @item -C
3862 @itemx --check=quiet
3863 @itemx --check=silent
3864 @opindex -c
3865 @opindex --check
3866 @cindex checking for sortedness
3867 Exit successfully if the given file is already sorted, and
3868 exit with status 1 otherwise.
3869 At most one input file can be given.
3870 This is like @option{-c}, except it does not print a diagnostic.
3871
3872 @item -m
3873 @itemx --merge
3874 @opindex -m
3875 @opindex --merge
3876 @cindex merging sorted files
3877 Merge the given files by sorting them as a group.  Each input file must
3878 always be individually sorted.  It always works to sort instead of
3879 merge; merging is provided because it is faster, in the case where it
3880 works.
3881
3882 @end table
3883
3884 @cindex sort stability
3885 @cindex sort's last-resort comparison
3886 A pair of lines is compared as follows:
3887 @command{sort} compares each pair of fields, in the
3888 order specified on the command line, according to the associated
3889 ordering options, until a difference is found or no fields are left.
3890 If no key fields are specified, @command{sort} uses a default key of
3891 the entire line.  Finally, as a last resort when all keys compare
3892 equal, @command{sort} compares entire lines as if no ordering options
3893 other than @option{--reverse} (@option{-r}) were specified.  The
3894 @option{--stable} (@option{-s}) option disables this @dfn{last-resort
3895 comparison} so that lines in which all fields compare equal are left
3896 in their original relative order.  The @option{--unique}
3897 (@option{-u}) option also disables the last-resort comparison.
3898
3899 @vindex LC_ALL
3900 @vindex LC_COLLATE
3901 Unless otherwise specified, all comparisons use the character collating
3902 sequence specified by the @env{LC_COLLATE} locale.@footnote{If you
3903 use a non-POSIX locale (e.g., by setting @env{LC_ALL}
3904 to @samp{en_US}), then @command{sort} may produce output that is sorted
3905 differently than you're accustomed to.  In that case, set the @env{LC_ALL}
3906 environment variable to @samp{C}@.  Note that setting only @env{LC_COLLATE}
3907 has two problems.  First, it is ineffective if @env{LC_ALL} is also set.
3908 Second, it has undefined behavior if @env{LC_CTYPE} (or @env{LANG}, if
3909 @env{LC_CTYPE} is unset) is set to an incompatible value.  For example,
3910 you get undefined behavior if @env{LC_CTYPE} is @code{ja_JP.PCK} but
3911 @env{LC_COLLATE} is @code{en_US.UTF-8}.}
3912
3913 @sc{gnu} @command{sort} (as specified for all @sc{gnu} utilities) has no
3914 limit on input line length or restrictions on bytes allowed within lines.
3915 In addition, if the final byte of an input file is not a newline, @sc{gnu}
3916 @command{sort} silently supplies one.  A line's trailing newline is not
3917 part of the line for comparison purposes.
3918
3919 @cindex exit status of @command{sort}
3920 Exit status:
3921
3922 @display
3923 0 if no error occurred
3924 1 if invoked with @option{-c} or @option{-C} and the input is not sorted
3925 2 if an error occurred
3926 @end display
3927
3928 @vindex TMPDIR
3929 If the environment variable @env{TMPDIR} is set, @command{sort} uses its
3930 value as the directory for temporary files instead of @file{/tmp}.  The
3931 @option{--temporary-directory} (@option{-T}) option in turn overrides
3932 the environment variable.
3933
3934 The following options affect the ordering of output lines.  They may be
3935 specified globally or as part of a specific key field.  If no key
3936 fields are specified, global options apply to comparison of entire
3937 lines; otherwise the global options are inherited by key fields that do
3938 not specify any special options of their own.  In pre-POSIX
3939 versions of @command{sort}, global options affect only later key fields,
3940 so portable shell scripts should specify global options first.
3941
3942 @table @samp
3943
3944 @item -b
3945 @itemx --ignore-leading-blanks
3946 @opindex -b
3947 @opindex --ignore-leading-blanks
3948 @cindex blanks, ignoring leading
3949 @vindex LC_CTYPE
3950 Ignore leading blanks when finding sort keys in each line.
3951 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
3952 can change this.  Note blanks may be ignored by your locale's collating
3953 rules, but without this option they will be significant for character
3954 positions specified in keys with the @option{-k} option.
3955
3956 @item -d
3957 @itemx --dictionary-order
3958 @opindex -d
3959 @opindex --dictionary-order
3960 @cindex dictionary order
3961 @cindex phone directory order
3962 @cindex telephone directory order
3963 @vindex LC_CTYPE
3964 Sort in @dfn{phone directory} order: ignore all characters except
3965 letters, digits and blanks when sorting.
3966 By default letters and digits are those of ASCII and a blank
3967 is a space or a tab, but the @env{LC_CTYPE} locale can change this.
3968
3969 @item -f
3970 @itemx --ignore-case
3971 @opindex -f
3972 @opindex --ignore-case
3973 @cindex ignoring case
3974 @cindex case folding
3975 @vindex LC_CTYPE
3976 Fold lowercase characters into the equivalent uppercase characters when
3977 comparing so that, for example, @samp{b} and @samp{B} sort as equal.
3978 The @env{LC_CTYPE} locale determines character types.
3979 When used with @option{--unique} those lower case equivalent lines are
3980 thrown away.  (There is currently no way to throw away the upper case
3981 equivalent instead.  (Any @option{--reverse} given would only affect
3982 the final result, after the throwing away.))
3983
3984 @item -g
3985 @itemx --general-numeric-sort
3986 @itemx --sort=general-numeric
3987 @opindex -g
3988 @opindex --general-numeric-sort
3989 @opindex --sort
3990 @cindex general numeric sort
3991 @vindex LC_NUMERIC
3992 Sort numerically, converting a prefix of each line to a long
3993 double-precision floating point number.  @xref{Floating point}.
3994 Do not report overflow, underflow, or conversion errors.
3995 Use the following collating sequence:
3996
3997 @itemize @bullet
3998 @item
3999 Lines that do not start with numbers (all considered to be equal).
4000 @item
4001 NaNs (``Not a Number'' values, in IEEE floating point arithmetic)
4002 in a consistent but machine-dependent order.
4003 @item
4004 Minus infinity.
4005 @item
4006 Finite numbers in ascending numeric order (with @math{-0} and @math{+0} equal).
4007 @item
4008 Plus infinity.
4009 @end itemize
4010
4011 Use this option only if there is no alternative; it is much slower than
4012 @option{--numeric-sort} (@option{-n}) and it can lose information when
4013 converting to floating point.
4014
4015 @item -h
4016 @itemx --human-numeric-sort
4017 @itemx --sort=human-numeric
4018 @opindex -h
4019 @opindex --human-numeric-sort
4020 @opindex --sort
4021 @cindex human numeric sort
4022 @vindex LC_NUMERIC
4023 Sort numerically, first by numeric sign (negative, zero, or positive);
4024 then by SI suffix (either empty, or @samp{k} or @samp{K}, or
4025 one of @samp{MGTPEZY}, in that order; @pxref{Block size}); and finally
4026 by numeric value.  For example, @samp{1023M} sorts before @samp{1G}
4027 because @samp{M} (mega) precedes @samp{G} (giga) as an SI
4028 suffix.  This option sorts values that are consistently scaled to the
4029 nearest suffix, regardless of whether suffixes denote powers of 1000
4030 or 1024, and it therefore sorts the output of any single invocation of
4031 the @command{df}, @command{du}, or @command{ls} commands that are
4032 invoked with their @option{--human-readable} or @option{--si} options.
4033 The syntax for numbers is the same as for the @option{--numeric-sort}
4034 option; the SI suffix must immediately follow the number.
4035
4036 @item -i
4037 @itemx --ignore-nonprinting
4038 @opindex -i
4039 @opindex --ignore-nonprinting
4040 @cindex nonprinting characters, ignoring
4041 @cindex unprintable characters, ignoring
4042 @vindex LC_CTYPE
4043 Ignore nonprinting characters.
4044 The @env{LC_CTYPE} locale determines character types.
4045 This option has no effect if the stronger @option{--dictionary-order}
4046 (@option{-d}) option is also given.
4047
4048 @item -M
4049 @itemx --month-sort
4050 @itemx --sort=month
4051 @opindex -M
4052 @opindex --month-sort
4053 @opindex --sort
4054 @cindex months, sorting by
4055 @vindex LC_TIME
4056 An initial string, consisting of any amount of blanks, followed
4057 by a month name abbreviation, is folded to UPPER case and
4058 compared in the order @samp{JAN} < @samp{FEB} < @dots{} < @samp{DEC}@.
4059 Invalid names compare low to valid names.  The @env{LC_TIME} locale
4060 category determines the month spellings.
4061 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
4062 can change this.
4063
4064 @item -n
4065 @itemx --numeric-sort
4066 @itemx --sort=numeric
4067 @opindex -n
4068 @opindex --numeric-sort
4069 @opindex --sort
4070 @cindex numeric sort
4071 @vindex LC_NUMERIC
4072 Sort numerically.  The number begins each line and consists
4073 of optional blanks, an optional @samp{-} sign, and zero or more
4074 digits possibly separated by thousands separators, optionally followed
4075 by a decimal-point character and zero or more digits.  An empty
4076 number is treated as @samp{0}.  The @env{LC_NUMERIC}
4077 locale specifies the decimal-point character and thousands separator.
4078 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
4079 can change this.
4080
4081 Comparison is exact; there is no rounding error.
4082
4083 Neither a leading @samp{+} nor exponential notation is recognized.
4084 To compare such strings numerically, use the
4085 @option{--general-numeric-sort} (@option{-g}) option.
4086
4087 @item -V
4088 @itemx --version-sort
4089 @opindex -V
4090 @opindex --version-sort
4091 @cindex version number sort
4092 Sort by version name and number.  It behaves like a standard sort,
4093 except that each sequence of decimal digits is treated numerically
4094 as an index/version number.  (@xref{Details about version sort}.)
4095
4096 @item -r
4097 @itemx --reverse
4098 @opindex -r
4099 @opindex --reverse
4100 @cindex reverse sorting
4101 Reverse the result of comparison, so that lines with greater key values
4102 appear earlier in the output instead of later.
4103
4104 @item -R
4105 @itemx --random-sort
4106 @itemx --sort=random
4107 @opindex -R
4108 @opindex --random-sort
4109 @opindex --sort
4110 @cindex random sort
4111 Sort by hashing the input keys and then sorting the hash values.
4112 Choose the hash function at random, ensuring that it is free of
4113 collisions so that differing keys have differing hash values.  This is
4114 like a random permutation of the inputs (@pxref{shuf invocation}),
4115 except that keys with the same value sort together.
4116
4117 If multiple random sort fields are specified, the same random hash
4118 function is used for all fields.  To use different random hash
4119 functions for different fields, you can invoke @command{sort} more
4120 than once.
4121
4122 The choice of hash function is affected by the
4123 @option{--random-source} option.
4124
4125 @end table
4126
4127 Other options are:
4128
4129 @table @samp
4130
4131 @item --compress-program=@var{prog}
4132 Compress any temporary files with the program @var{prog}.
4133
4134 With no arguments, @var{prog} must compress standard input to standard
4135 output, and when given the @option{-d} option it must decompress
4136 standard input to standard output.
4137
4138 Terminate with an error if @var{prog} exits with nonzero status.
4139
4140 White space and the backslash character should not appear in
4141 @var{prog}; they are reserved for future use.
4142
4143 @filesZeroFromOption{sort,,sorted output}
4144
4145 @item -k @var{pos1}[,@var{pos2}]
4146 @itemx --key=@var{pos1}[,@var{pos2}]
4147 @opindex -k
4148 @opindex --key
4149 @cindex sort field
4150 Specify a sort field that consists of the part of the line between
4151 @var{pos1} and @var{pos2} (or the end of the line, if @var{pos2} is
4152 omitted), @emph{inclusive}.
4153
4154 Each @var{pos} has the form @samp{@var{f}[.@var{c}][@var{opts}]},
4155 where @var{f} is the number of the field to use, and @var{c} is the number
4156 of the first character from the beginning of the field.  Fields and character
4157 positions are numbered starting with 1; a character position of zero in
4158 @var{pos2} indicates the field's last character.  If @samp{.@var{c}} is
4159 omitted from @var{pos1}, it defaults to 1 (the beginning of the field);
4160 if omitted from @var{pos2}, it defaults to 0 (the end of the field).
4161 @var{opts} are ordering options, allowing individual keys to be sorted
4162 according to different rules; see below for details.  Keys can span
4163 multiple fields.
4164
4165 Example:  To sort on the second field, use @option{--key=2,2}
4166 (@option{-k 2,2}).  See below for more notes on keys and more examples.
4167 See also the @option{--debug} option to help determine the part
4168 of the line being used in the sort.
4169
4170 @item --debug
4171 Highlight the portion of each line used for sorting.
4172 Also issue warnings about questionable usage to stderr.
4173
4174 @item --batch-size=@var{nmerge}
4175 @opindex --batch-size
4176 @cindex number of inputs to merge, nmerge
4177 Merge at most @var{nmerge} inputs at once.
4178
4179 When @command{sort} has to merge more than @var{nmerge} inputs,
4180 it merges them in groups of @var{nmerge}, saving the result in
4181 a temporary file, which is then used as an input in a subsequent merge.
4182
4183 A large value of @var{nmerge} may improve merge performance and decrease
4184 temporary storage utilization at the expense of increased memory usage
4185 and I/O@.  Conversely a small value of @var{nmerge} may reduce memory
4186 requirements and I/O at the expense of temporary storage consumption and
4187 merge performance.
4188
4189 The value of @var{nmerge} must be at least 2.  The default value is
4190 currently 16, but this is implementation-dependent and may change in
4191 the future.
4192
4193 The value of @var{nmerge} may be bounded by a resource limit for open
4194 file descriptors.  The commands @samp{ulimit -n} or @samp{getconf
4195 OPEN_MAX} may display limits for your systems; these limits may be
4196 modified further if your program already has some files open, or if
4197 the operating system has other limits on the number of open files.  If
4198 the value of @var{nmerge} exceeds the resource limit, @command{sort}
4199 silently uses a smaller value.
4200
4201 @item -o @var{output-file}
4202 @itemx --output=@var{output-file}
4203 @opindex -o
4204 @opindex --output
4205 @cindex overwriting of input, allowed
4206 Write output to @var{output-file} instead of standard output.
4207 Normally, @command{sort} reads all input before opening
4208 @var{output-file}, so you can safely sort a file in place by using
4209 commands like @code{sort -o F F} and @code{cat F | sort -o F}@.
4210 However, @command{sort} with @option{--merge} (@option{-m}) can open
4211 the output file before reading all input, so a command like @code{cat
4212 F | sort -m -o F - G} is not safe as @command{sort} might start
4213 writing @file{F} before @command{cat} is done reading it.
4214
4215 @vindex POSIXLY_CORRECT
4216 On newer systems, @option{-o} cannot appear after an input file if
4217 @env{POSIXLY_CORRECT} is set, e.g., @samp{sort F -o F}@.  Portable
4218 scripts should specify @option{-o @var{output-file}} before any input
4219 files.
4220
4221 @item --random-source=@var{file}
4222 @opindex --random-source
4223 @cindex random source for sorting
4224 Use @var{file} as a source of random data used to determine which
4225 random hash function to use with the @option{-R} option.  @xref{Random
4226 sources}.
4227
4228 @item -s
4229 @itemx --stable
4230 @opindex -s
4231 @opindex --stable
4232 @cindex sort stability
4233 @cindex sort's last-resort comparison
4234
4235 Make @command{sort} stable by disabling its last-resort comparison.
4236 This option has no effect if no fields or global ordering options
4237 other than @option{--reverse} (@option{-r}) are specified.
4238
4239 @item -S @var{size}
4240 @itemx --buffer-size=@var{size}
4241 @opindex -S
4242 @opindex --buffer-size
4243 @cindex size for main memory sorting
4244 Use a main-memory sort buffer of the given @var{size}.  By default,
4245 @var{size} is in units of 1024 bytes.  Appending @samp{%} causes
4246 @var{size} to be interpreted as a percentage of physical memory.
4247 Appending @samp{K} multiplies @var{size} by 1024 (the default),
4248 @samp{M} by 1,048,576, @samp{G} by 1,073,741,824, and so on for
4249 @samp{T}, @samp{P}, @samp{E}, @samp{Z}, and @samp{Y}@.  Appending
4250 @samp{b} causes @var{size} to be interpreted as a byte count, with no
4251 multiplication.
4252
4253 This option can improve the performance of @command{sort} by causing it
4254 to start with a larger or smaller sort buffer than the default.
4255 However, this option affects only the initial buffer size.  The buffer
4256 grows beyond @var{size} if @command{sort} encounters input lines larger
4257 than @var{size}.
4258
4259 @item -t @var{separator}
4260 @itemx --field-separator=@var{separator}
4261 @opindex -t
4262 @opindex --field-separator
4263 @cindex field separator character
4264 Use character @var{separator} as the field separator when finding the
4265 sort keys in each line.  By default, fields are separated by the empty
4266 string between a non-blank character and a blank character.
4267 By default a blank is a space or a tab, but the @env{LC_CTYPE} locale
4268 can change this.
4269
4270 That is, given the input line @w{@samp{ foo bar}}, @command{sort} breaks it
4271 into fields @w{@samp{ foo}} and @w{@samp{ bar}}.  The field separator is
4272 not considered to be part of either the field preceding or the field
4273 following, so with @samp{sort @w{-t " "}} the same input line has
4274 three fields: an empty field, @samp{foo}, and @samp{bar}.
4275 However, fields that extend to the end of the line,
4276 as @option{-k 2}, or fields consisting of a range, as @option{-k 2,3},
4277 retain the field separators present between the endpoints of the range.
4278
4279 To specify ASCII @sc{nul} as the field separator,
4280 use the two-character string @samp{\0}, e.g., @samp{sort -t '\0'}.
4281
4282 @item -T @var{tempdir}
4283 @itemx --temporary-directory=@var{tempdir}
4284 @opindex -T
4285 @opindex --temporary-directory
4286 @cindex temporary directory
4287 @vindex TMPDIR
4288 Use directory @var{tempdir} to store temporary files, overriding the
4289 @env{TMPDIR} environment variable.  If this option is given more than
4290 once, temporary files are stored in all the directories given.  If you
4291 have a large sort or merge that is I/O-bound, you can often improve
4292 performance by using this option to specify directories on different
4293 disks and controllers.
4294
4295 @item --parallel=@var{n}
4296 @opindex --parallel
4297 @cindex multithreaded sort
4298 Set the number of sorts run in parallel to @var{n}. By default,
4299 @var{n} is set to the number of available processors, but limited
4300 to 8, as there are diminishing performance gains after that.
4301 Note also that using @var{n} threads increases the memory usage by
4302 a factor of log @var{n}.  Also see @ref{nproc invocation}.
4303
4304 @item -u
4305 @itemx --unique
4306 @opindex -u
4307 @opindex --unique
4308 @cindex uniquifying output
4309
4310 Normally, output only the first of a sequence of lines that compare
4311 equal.  For the @option{--check} (@option{-c} or @option{-C}) option,
4312 check that no pair of consecutive lines compares equal.
4313
4314 This option also disables the default last-resort comparison.
4315
4316 The commands @code{sort -u} and @code{sort | uniq} are equivalent, but
4317 this equivalence does not extend to arbitrary @command{sort} options.
4318 For example, @code{sort -n -u} inspects only the value of the initial
4319 numeric string when checking for uniqueness, whereas @code{sort -n |
4320 uniq} inspects the entire line.  @xref{uniq invocation}.
4321
4322 @macro zeroTerminatedOption
4323 @item -z
4324 @itemx --zero-terminated
4325 @opindex -z
4326 @opindex --zero-terminated
4327 @cindex process zero-terminated items
4328 Delimit items with a zero byte rather than a newline (ASCII @sc{lf}).
4329 I.e., treat input as items separated by ASCII @sc{nul}
4330 and terminate output items with ASCII @sc{nul}.
4331 This option can be useful in conjunction with @samp{perl -0} or
4332 @samp{find -print0} and @samp{xargs -0} which do the same in order to
4333 reliably handle arbitrary file names (even those containing blanks
4334 or other special characters).
4335 @end macro
4336 @zeroTerminatedOption
4337
4338 @end table
4339
4340 Historical (BSD and System V) implementations of @command{sort} have
4341 differed in their interpretation of some options, particularly
4342 @option{-b}, @option{-f}, and @option{-n}.
4343 @sc{gnu} sort follows the POSIX
4344 behavior, which is usually (but not always!) like the System V behavior.
4345 According to POSIX, @option{-n} no longer implies @option{-b}.  For
4346 consistency, @option{-M} has been changed in the same way.  This may
4347 affect the meaning of character positions in field specifications in
4348 obscure cases.  The only fix is to add an explicit @option{-b}.
4349
4350 A position in a sort field specified with @option{-k} may have any
4351 of the option letters @samp{MbdfghinRrV} appended to it, in which case no
4352 global ordering options are inherited by that particular field.  The
4353 @option{-b} option may be independently attached to either or both of
4354 the start and end positions of a field specification, and if it is
4355 inherited from the global options it will be attached to both.
4356 If input lines can contain leading or adjacent blanks and @option{-t}
4357 is not used, then @option{-k} is typically combined with @option{-b} or
4358 an option that implicitly ignores leading blanks (@samp{Mghn}) as otherwise
4359 the varying numbers of leading blanks in fields can cause confusing results.
4360
4361 If the start position in a sort field specifier falls after the end of
4362 the line or after the end field, the field is empty.  If the @option{-b}
4363 option was specified, the @samp{.@var{c}} part of a field specification
4364 is counted from the first nonblank character of the field.
4365
4366 @vindex _POSIX2_VERSION
4367 @vindex POSIXLY_CORRECT
4368 On older systems, @command{sort} supports an obsolete origin-zero
4369 syntax @samp{+@var{pos1} [-@var{pos2}]} for specifying sort keys.
4370 The obsolete sequence @samp{sort +@var{a}.@var{x} -@var{b}.@var{y}}
4371 is equivalent to @samp{sort -k @var{a+1}.@var{x+1},@var{b}} if @var{y}
4372 is @samp{0} or absent, otherwise it is equivalent to @samp{sort -k
4373 @var{a+1}.@var{x+1},@var{b+1}.@var{y}}.
4374
4375 This obsolete behavior can be enabled or disabled with the
4376 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
4377 conformance}); it can also be enabled when @env{POSIXLY_CORRECT} is
4378 not set by using the obsolete syntax with @samp{-@var{pos2}} present.
4379
4380 Scripts intended for use on standard hosts should avoid obsolete
4381 syntax and should use @option{-k} instead.  For example, avoid
4382 @samp{sort +2}, since it might be interpreted as either @samp{sort
4383 ./+2} or @samp{sort -k 3}.  If your script must also run on hosts that
4384 support only the obsolete syntax, it can use a test like @samp{if sort
4385 -k 1 </dev/null >/dev/null 2>&1; then @dots{}} to decide which syntax
4386 to use.
4387
4388 Here are some examples to illustrate various combinations of options.
4389
4390 @itemize @bullet
4391
4392 @item
4393 Sort in descending (reverse) numeric order.
4394
4395 @example
4396 sort -n -r
4397 @end example
4398
4399 @item
4400 Run no more than 4 sorts concurrently, using a buffer size of 10M.
4401
4402 @example
4403 sort --parallel=4 -S 10M
4404 @end example
4405
4406 @item
4407 Sort alphabetically, omitting the first and second fields
4408 and the blanks at the start of the third field.
4409 This uses a single key composed of the characters beginning
4410 at the start of the first nonblank character in field three
4411 and extending to the end of each line.
4412
4413 @example
4414 sort -k 3b
4415 @end example
4416
4417 @item
4418 Sort numerically on the second field and resolve ties by sorting
4419 alphabetically on the third and fourth characters of field five.
4420 Use @samp{:} as the field delimiter.
4421
4422 @example
4423 sort -t : -k 2,2n -k 5.3,5.4
4424 @end example
4425
4426 Note that if you had written @option{-k 2n} instead of @option{-k 2,2n}
4427 @command{sort} would have used all characters beginning in the second field
4428 and extending to the end of the line as the primary @emph{numeric}
4429 key.  For the large majority of applications, treating keys spanning
4430 more than one field as numeric will not do what you expect.
4431
4432 Also note that the @samp{n} modifier was applied to the field-end
4433 specifier for the first key.  It would have been equivalent to
4434 specify @option{-k 2n,2} or @option{-k 2n,2n}.  All modifiers except
4435 @samp{b} apply to the associated @emph{field}, regardless of whether
4436 the modifier character is attached to the field-start and/or the
4437 field-end part of the key specifier.
4438
4439 @item
4440 Sort the password file on the fifth field and ignore any
4441 leading blanks.  Sort lines with equal values in field five
4442 on the numeric user ID in field three.  Fields are separated
4443 by @samp{:}.
4444
4445 @example
4446 sort -t : -k 5b,5 -k 3,3n /etc/passwd
4447 sort -t : -n -k 5b,5 -k 3,3 /etc/passwd
4448 sort -t : -b -k 5,5 -k 3,3n /etc/passwd
4449 @end example
4450
4451 These three commands have equivalent effect.  The first specifies that
4452 the first key's start position ignores leading blanks and the second
4453 key is sorted numerically.  The other two commands rely on global
4454 options being inherited by sort keys that lack modifiers.  The inheritance
4455 works in this case because @option{-k 5b,5b} and @option{-k 5b,5} are
4456 equivalent, as the location of a field-end lacking a @samp{.@var{c}}
4457 character position is not affected by whether initial blanks are
4458 skipped.
4459
4460 @item
4461 Sort a set of log files, primarily by IPv4 address and secondarily by
4462 time stamp.  If two lines' primary and secondary keys are identical,
4463 output the lines in the same order that they were input.  The log
4464 files contain lines that look like this:
4465
4466 @example
4467 4.150.156.3 - - [01/Apr/2004:06:31:51 +0000] message 1
4468 211.24.3.231 - - [24/Apr/2004:20:17:39 +0000] message 2
4469 @end example
4470
4471 Fields are separated by exactly one space.  Sort IPv4 addresses
4472 lexicographically, e.g., 212.61.52.2 sorts before 212.129.233.201
4473 because 61 is less than 129.
4474
4475 @example
4476 sort -s -t ' ' -k 4.9n -k 4.5M -k 4.2n -k 4.14,4.21 file*.log |
4477 sort -s -t '.' -k 1,1n -k 2,2n -k 3,3n -k 4,4n
4478 @end example
4479
4480 This example cannot be done with a single @command{sort} invocation,
4481 since IPv4 address components are separated by @samp{.} while dates
4482 come just after a space.  So it is broken down into two invocations of
4483 @command{sort}: the first sorts by time stamp and the second by IPv4
4484 address.  The time stamp is sorted by year, then month, then day, and
4485 finally by hour-minute-second field, using @option{-k} to isolate each
4486 field.  Except for hour-minute-second there's no need to specify the
4487 end of each key field, since the @samp{n} and @samp{M} modifiers sort
4488 based on leading prefixes that cannot cross field boundaries.  The
4489 IPv4 addresses are sorted lexicographically.  The second sort uses
4490 @samp{-s} so that ties in the primary key are broken by the secondary
4491 key; the first sort uses @samp{-s} so that the combination of the two
4492 sorts is stable.
4493
4494 @item
4495 Generate a tags file in case-insensitive sorted order.
4496
4497 @smallexample
4498 find src -type f -print0 | sort -z -f | xargs -0 etags --append
4499 @end smallexample
4500
4501 The use of @option{-print0}, @option{-z}, and @option{-0} in this case means
4502 that file names that contain blanks or other special characters are
4503 not broken up
4504 by the sort operation.
4505
4506 @c This example is a bit contrived and needs more explanation.
4507 @c @item
4508 @c Sort records separated by an arbitrary string by using a pipe to convert
4509 @c each record delimiter string to @samp{\0}, then using sort's -z option,
4510 @c and converting each @samp{\0} back to the original record delimiter.
4511 @c
4512 @c @example
4513 @c printf 'c\n\nb\n\na\n' |
4514 @c perl -0pe 's/\n\n/\n\0/g' |
4515 @c sort -z |
4516 @c perl -0pe 's/\0/\n/g'
4517 @c @end example
4518
4519 @item
4520 Use the common DSU, Decorate Sort Undecorate idiom to
4521 sort lines according to their length.
4522
4523 @example
4524 awk '@{print length, $0@}' /etc/passwd | sort -n | cut -f2- -d' '
4525 @end example
4526
4527 In general this technique can be used to sort data that the @command{sort}
4528 command does not support, or is inefficient at, sorting directly.
4529
4530 @item
4531 Shuffle a list of directories, but preserve the order of files within
4532 each directory.  For instance, one could use this to generate a music
4533 playlist in which albums are shuffled but the songs of each album are
4534 played in order.
4535
4536 @example
4537 ls */* | sort -t / -k 1,1R -k 2,2
4538 @end example
4539
4540 @end itemize
4541
4542
4543 @node shuf invocation
4544 @section @command{shuf}: Shuffling text
4545
4546 @pindex shuf
4547 @cindex shuffling files
4548
4549 @command{shuf} shuffles its input by outputting a random permutation
4550 of its input lines.  Each output permutation is equally likely.
4551 Synopses:
4552
4553 @example
4554 shuf [@var{option}]@dots{} [@var{file}]
4555 shuf -e [@var{option}]@dots{} [@var{arg}]@dots{}
4556 shuf -i @var{lo}-@var{hi} [@var{option}]@dots{}
4557 @end example
4558
4559 @command{shuf} has three modes of operation that affect where it
4560 obtains its input lines.  By default, it reads lines from standard
4561 input.  The following options change the operation mode:
4562
4563 @table @samp
4564
4565 @item -e
4566 @itemx --echo
4567 @opindex -c
4568 @opindex --echo
4569 @cindex command-line operands to shuffle
4570 Treat each command-line operand as an input line.
4571
4572 @item -i @var{lo}-@var{hi}
4573 @itemx --input-range=@var{lo}-@var{hi}
4574 @opindex -i
4575 @opindex --input-range
4576 @cindex input range to shuffle
4577 Act as if input came from a file containing the range of unsigned
4578 decimal integers @var{lo}@dots{}@var{hi}, one per line.
4579
4580 @end table
4581
4582 @command{shuf}'s other options can affect its behavior in all
4583 operation modes:
4584
4585 @table @samp
4586
4587 @item -n @var{lines}
4588 @itemx --head-count=@var{count}
4589 @opindex -n
4590 @opindex --head-count
4591 @cindex head of output
4592 Output at most @var{count} lines.  By default, all input lines are
4593 output.
4594
4595 @item -o @var{output-file}
4596 @itemx --output=@var{output-file}
4597 @opindex -o
4598 @opindex --output
4599 @cindex overwriting of input, allowed
4600 Write output to @var{output-file} instead of standard output.
4601 @command{shuf} reads all input before opening
4602 @var{output-file}, so you can safely shuffle a file in place by using
4603 commands like @code{shuf -o F <F} and @code{cat F | shuf -o F}.
4604
4605 @item --random-source=@var{file}
4606 @opindex --random-source
4607 @cindex random source for shuffling
4608 Use @var{file} as a source of random data used to determine which
4609 permutation to generate.  @xref{Random sources}.
4610
4611 @zeroTerminatedOption
4612
4613 @end table
4614
4615 For example:
4616
4617 @example
4618 shuf <<EOF
4619 A man,
4620 a plan,
4621 a canal:
4622 Panama!
4623 EOF
4624 @end example
4625
4626 @noindent
4627 might produce the output
4628
4629 @example
4630 Panama!
4631 A man,
4632 a canal:
4633 a plan,
4634 @end example
4635
4636 @noindent
4637 Similarly, the command:
4638
4639 @example
4640 shuf -e clubs hearts diamonds spades
4641 @end example
4642
4643 @noindent
4644 might output:
4645
4646 @example
4647 clubs
4648 diamonds
4649 spades
4650 hearts
4651 @end example
4652
4653 @noindent
4654 and the command @samp{shuf -i 1-4} might output:
4655
4656 @example
4657 4
4658 2
4659 1
4660 3
4661 @end example
4662
4663 @noindent
4664 These examples all have four input lines, so @command{shuf} might
4665 produce any of the twenty-four possible permutations of the input.  In
4666 general, if there are @var{n} input lines, there are @var{n}! (i.e.,
4667 @var{n} factorial, or @var{n} * (@var{n} - 1) * @dots{} * 1) possible
4668 output permutations.
4669
4670 @exitstatus
4671
4672
4673 @node uniq invocation
4674 @section @command{uniq}: Uniquify files
4675
4676 @pindex uniq
4677 @cindex uniquify files
4678
4679 @command{uniq} writes the unique lines in the given @file{input}, or
4680 standard input if nothing is given or for an @var{input} name of
4681 @samp{-}.  Synopsis:
4682
4683 @example
4684 uniq [@var{option}]@dots{} [@var{input} [@var{output}]]
4685 @end example
4686
4687 By default, @command{uniq} prints its input lines, except that
4688 it discards all but the first of adjacent repeated lines, so that
4689 no output lines are repeated.  Optionally, it can instead discard
4690 lines that are not repeated, or all repeated lines.
4691
4692 The input need not be sorted, but repeated input lines are detected
4693 only if they are adjacent.  If you want to discard non-adjacent
4694 duplicate lines, perhaps you want to use @code{sort -u}.
4695 @xref{sort invocation}.
4696
4697 @vindex LC_COLLATE
4698 Comparisons honor the rules specified by the @env{LC_COLLATE}
4699 locale category.
4700
4701 If no @var{output} file is specified, @command{uniq} writes to standard
4702 output.
4703
4704 The program accepts the following options.  Also see @ref{Common options}.
4705
4706 @table @samp
4707
4708 @item -f @var{n}
4709 @itemx --skip-fields=@var{n}
4710 @opindex -f
4711 @opindex --skip-fields
4712 Skip @var{n} fields on each line before checking for uniqueness.  Use
4713 a null string for comparison if a line has fewer than @var{n} fields.  Fields
4714 are sequences of non-space non-tab characters that are separated from
4715 each other by at least one space or tab.
4716
4717 For compatibility @command{uniq} supports an obsolete option syntax
4718 @option{-@var{n}}.  New scripts should use @option{-f @var{n}} instead.
4719
4720 @item -s @var{n}
4721 @itemx --skip-chars=@var{n}
4722 @opindex -s
4723 @opindex --skip-chars
4724 Skip @var{n} characters before checking for uniqueness.  Use a null string
4725 for comparison if a line has fewer than @var{n} characters.  If you use both
4726 the field and character skipping options, fields are skipped over first.
4727
4728 @vindex _POSIX2_VERSION
4729 On older systems, @command{uniq} supports an obsolete option syntax
4730 @option{+@var{n}}.
4731 This obsolete behavior can be enabled or disabled with the
4732 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
4733 conformance}), but portable scripts should avoid commands whose
4734 behavior depends on this variable.
4735 For example, use @samp{uniq ./+10} or @samp{uniq -s 10} rather than
4736 the ambiguous @samp{uniq +10}.
4737
4738 @item -c
4739 @itemx --count
4740 @opindex -c
4741 @opindex --count
4742 Print the number of times each line occurred along with the line.
4743
4744 @item -i
4745 @itemx --ignore-case
4746 @opindex -i
4747 @opindex --ignore-case
4748 Ignore differences in case when comparing lines.
4749
4750 @item -d
4751 @itemx --repeated
4752 @opindex -d
4753 @opindex --repeated
4754 @cindex repeated lines, outputting
4755 Discard lines that are not repeated.  When used by itself, this option
4756 causes @command{uniq} to print the first copy of each repeated line,
4757 and nothing else.
4758
4759 @item -D
4760 @itemx --all-repeated[=@var{delimit-method}]
4761 @opindex -D
4762 @opindex --all-repeated
4763 @cindex all repeated lines, outputting
4764 Do not discard the second and subsequent repeated input lines,
4765 but discard lines that are not repeated.
4766 This option is useful mainly in conjunction with other options e.g.,
4767 to ignore case or to compare only selected fields.
4768 The optional @var{delimit-method} tells how to delimit
4769 groups of repeated lines, and must be one of the following:
4770
4771 @table @samp
4772
4773 @item none
4774 Do not delimit groups of repeated lines.
4775 This is equivalent to @option{--all-repeated} (@option{-D}).
4776
4777 @item prepend
4778 Output a newline before each group of repeated lines.
4779 With @option{--zero-terminated} (@option{-z}), use a zero
4780 byte (ASCII @sc{nul}) instead of a newline.
4781
4782 @item separate
4783 Separate groups of repeated lines with a single newline.
4784 With @option{--zero-terminated} (@option{-z}), use a zero
4785 byte (ASCII @sc{nul}) instead of a newline.
4786 This is the same as using @samp{prepend}, except that
4787 no delimiter is inserted before the first group, and hence
4788 may be better suited for output direct to users.
4789 @end table
4790
4791 Note that when groups are delimited and the input stream contains
4792 two or more consecutive blank lines, then the output is ambiguous.
4793 To avoid that, filter the input through @samp{tr -s '\n'} to replace
4794 each sequence of consecutive newlines with a single newline.
4795
4796 This is a @sc{gnu} extension.
4797 @c FIXME: give an example showing *how* it's useful
4798
4799 @item -u
4800 @itemx --unique
4801 @opindex -u
4802 @opindex --unique
4803 @cindex unique lines, outputting
4804 Discard the first repeated line.  When used by itself, this option
4805 causes @command{uniq} to print unique lines, and nothing else.
4806
4807 @item -w @var{n}
4808 @itemx --check-chars=@var{n}
4809 @opindex -w
4810 @opindex --check-chars
4811 Compare at most @var{n} characters on each line (after skipping any specified
4812 fields and characters).  By default the entire rest of the lines are
4813 compared.
4814
4815 @zeroTerminatedOption
4816
4817 @end table
4818
4819 @exitstatus
4820
4821
4822 @node comm invocation
4823 @section @command{comm}: Compare two sorted files line by line
4824
4825 @pindex comm
4826 @cindex line-by-line comparison
4827 @cindex comparing sorted files
4828
4829 @command{comm} writes to standard output lines that are common, and lines
4830 that are unique, to two input files; a file name of @samp{-} means
4831 standard input.  Synopsis:
4832
4833 @example
4834 comm [@var{option}]@dots{} @var{file1} @var{file2}
4835 @end example
4836
4837 @vindex LC_COLLATE
4838 Before @command{comm} can be used, the input files must be sorted using the
4839 collating sequence specified by the @env{LC_COLLATE} locale.
4840 If an input file ends in a non-newline
4841 character, a newline is silently appended.  The @command{sort} command with
4842 no options always outputs a file that is suitable input to @command{comm}.
4843
4844 @cindex differing lines
4845 @cindex common lines
4846 With no options, @command{comm} produces three-column output.  Column one
4847 contains lines unique to @var{file1}, column two contains lines unique
4848 to @var{file2}, and column three contains lines common to both files.
4849 Columns are separated by a single TAB character.
4850 @c FIXME: when there's an option to supply an alternative separator
4851 @c string, append "by default" to the above sentence.
4852
4853 @opindex -1
4854 @opindex -2
4855 @opindex -3
4856 The options @option{-1}, @option{-2}, and @option{-3} suppress printing of
4857 the corresponding columns (and separators).  Also see @ref{Common options}.
4858
4859 Unlike some other comparison utilities, @command{comm} has an exit
4860 status that does not depend on the result of the comparison.
4861 Upon normal completion @command{comm} produces an exit code of zero.
4862 If there is an error it exits with nonzero status.
4863
4864 @macro checkOrderOption{cmd}
4865 If the @option{--check-order} option is given, unsorted inputs will
4866 cause a fatal error message.  If the option @option{--nocheck-order}
4867 is given, unsorted inputs will never cause an error message.  If neither
4868 of these options is given, wrongly sorted inputs are diagnosed
4869 only if an input file is found to contain unpairable
4870 @ifset JOIN_COMMAND
4871 lines, and when both input files are non empty.
4872 @end ifset
4873 @ifclear JOIN_COMMAND
4874 lines.
4875 @end ifclear
4876 If an input file is diagnosed as being unsorted, the @command{\cmd\}
4877 command will exit with a nonzero status (and the output should not be used).
4878
4879 Forcing @command{\cmd\} to process wrongly sorted input files
4880 containing unpairable lines by specifying @option{--nocheck-order} is
4881 not guaranteed to produce any particular output.  The output will
4882 probably not correspond with whatever you hoped it would be.
4883 @end macro
4884 @checkOrderOption{comm}
4885
4886 @table @samp
4887
4888 @item --check-order
4889 Fail with an error message if either input file is wrongly ordered.
4890
4891 @item --nocheck-order
4892 Do not check that both input files are in sorted order.
4893
4894 Other options are:
4895
4896 @item --output-delimiter=@var{str}
4897 Print @var{str} between adjacent output columns,
4898 rather than the default of a single TAB character.
4899
4900 The delimiter @var{str} may not be empty.
4901
4902 @end table
4903
4904 @node ptx invocation
4905 @section @command{ptx}: Produce permuted indexes
4906
4907 @pindex ptx
4908
4909 @command{ptx} reads a text file and essentially produces a permuted index, with
4910 each keyword in its context.  The calling sketch is either one of:
4911
4912 @example
4913 ptx [@var{option} @dots{}] [@var{file} @dots{}]
4914 ptx -G [@var{option} @dots{}] [@var{input} [@var{output}]]
4915 @end example
4916
4917 The @option{-G} (or its equivalent: @option{--traditional}) option disables
4918 all @sc{gnu} extensions and reverts to traditional mode, thus introducing some
4919 limitations and changing several of the program's default option values.
4920 When @option{-G} is not specified, @sc{gnu} extensions are always enabled.
4921 @sc{gnu} extensions to @command{ptx} are documented wherever appropriate in this
4922 document.  @xref{Compatibility in ptx}, for the full list.
4923
4924 Individual options are explained in the following sections.
4925
4926 When @sc{gnu} extensions are enabled, there may be zero, one or several
4927 @var{file}s after the options.  If there is no @var{file}, the program
4928 reads the standard input.  If there is one or several @var{file}s, they
4929 give the name of input files which are all read in turn, as if all the
4930 input files were concatenated.  However, there is a full contextual
4931 break between each file and, when automatic referencing is requested,
4932 file names and line numbers refer to individual text input files.  In
4933 all cases, the program outputs the permuted index to the standard
4934 output.
4935
4936 When @sc{gnu} extensions are @emph{not} enabled, that is, when the program
4937 operates in traditional mode, there may be zero, one or two parameters
4938 besides the options.  If there are no parameters, the program reads the
4939 standard input and outputs the permuted index to the standard output.
4940 If there is only one parameter, it names the text @var{input} to be read
4941 instead of the standard input.  If two parameters are given, they give
4942 respectively the name of the @var{input} file to read and the name of
4943 the @var{output} file to produce.  @emph{Be very careful} to note that,
4944 in this case, the contents of file given by the second parameter is
4945 destroyed.  This behavior is dictated by System V @command{ptx}
4946 compatibility; @sc{gnu} Standards normally discourage output parameters not
4947 introduced by an option.
4948
4949 Note that for @emph{any} file named as the value of an option or as an
4950 input text file, a single dash @kbd{-} may be used, in which case
4951 standard input is assumed.  However, it would not make sense to use this
4952 convention more than once per program invocation.
4953
4954 @menu
4955 * General options in ptx::      Options which affect general program behavior.
4956 * Charset selection in ptx::    Underlying character set considerations.
4957 * Input processing in ptx::     Input fields, contexts, and keyword selection.
4958 * Output formatting in ptx::    Types of output format, and sizing the fields.
4959 * Compatibility in ptx::
4960 @end menu
4961
4962
4963 @node General options in ptx
4964 @subsection General options
4965
4966 @table @samp
4967
4968 @item -G
4969 @itemx --traditional
4970 As already explained, this option disables all @sc{gnu} extensions to
4971 @command{ptx} and switches to traditional mode.
4972
4973 @item --help
4974 Print a short help on standard output, then exit without further
4975 processing.
4976
4977 @item --version
4978 Print the program version on standard output, then exit without further
4979 processing.
4980
4981 @end table
4982
4983 @exitstatus
4984
4985
4986 @node Charset selection in ptx
4987 @subsection Charset selection
4988
4989 @c FIXME:  People don't necessarily know what an IBM-PC was these days.
4990 As it is set up now, the program assumes that the input file is coded
4991 using 8-bit ISO 8859-1 code, also known as Latin-1 character set,
4992 @emph{unless} it is compiled for MS-DOS, in which case it uses the
4993 character set of the IBM-PC@.  (@sc{gnu} @command{ptx} is not known to work on
4994 smaller MS-DOS machines anymore.)  Compared to 7-bit ASCII, the set
4995 of characters which are letters is different; this alters the behavior
4996 of regular expression matching.  Thus, the default regular expression
4997 for a keyword allows foreign or diacriticized letters.  Keyword sorting,
4998 however, is still crude; it obeys the underlying character set ordering
4999 quite blindly.
5000
5001 @table @samp
5002
5003 @item -f
5004 @itemx --ignore-case
5005 Fold lower case letters to upper case for sorting.
5006
5007 @end table
5008
5009
5010 @node Input processing in ptx
5011 @subsection Word selection and input processing
5012
5013 @table @samp
5014
5015 @item -b @var{file}
5016 @itemx --break-file=@var{file}
5017
5018 This option provides an alternative (to @option{-W}) method of describing
5019 which characters make up words.  It introduces the name of a
5020 file which contains a list of characters which can@emph{not} be part of
5021 one word; this file is called the @dfn{Break file}.  Any character which
5022 is not part of the Break file is a word constituent.  If both options
5023 @option{-b} and @option{-W} are specified, then @option{-W} has precedence and
5024 @option{-b} is ignored.
5025
5026 When @sc{gnu} extensions are enabled, the only way to avoid newline as a
5027 break character is to write all the break characters in the file with no
5028 newline at all, not even at the end of the file.  When @sc{gnu} extensions
5029 are disabled, spaces, tabs and newlines are always considered as break
5030 characters even if not included in the Break file.
5031
5032 @item -i @var{file}
5033 @itemx --ignore-file=@var{file}
5034
5035 The file associated with this option contains a list of words which will
5036 never be taken as keywords in concordance output.  It is called the
5037 @dfn{Ignore file}.  The file contains exactly one word in each line; the
5038 end of line separation of words is not subject to the value of the
5039 @option{-S} option.
5040
5041 @item -o @var{file}
5042 @itemx --only-file=@var{file}
5043
5044 The file associated with this option contains a list of words which will
5045 be retained in concordance output; any word not mentioned in this file
5046 is ignored.  The file is called the @dfn{Only file}.  The file contains
5047 exactly one word in each line; the end of line separation of words is
5048 not subject to the value of the @option{-S} option.
5049
5050 There is no default for the Only file.  When both an Only file and an
5051 Ignore file are specified, a word is considered a keyword only
5052 if it is listed in the Only file and not in the Ignore file.
5053
5054 @item -r
5055 @itemx --references
5056
5057 On each input line, the leading sequence of non-white space characters will be
5058 taken to be a reference that has the purpose of identifying this input
5059 line in the resulting permuted index.
5060 @xref{Output formatting in ptx},
5061 for more information about reference production.
5062 Using this option changes the default value for option @option{-S}.
5063
5064 Using this option, the program does not try very hard to remove
5065 references from contexts in output, but it succeeds in doing so
5066 @emph{when} the context ends exactly at the newline.  If option
5067 @option{-r} is used with @option{-S} default value, or when @sc{gnu} extensions
5068 are disabled, this condition is always met and references are completely
5069 excluded from the output contexts.
5070
5071 @item -S @var{regexp}
5072 @itemx --sentence-regexp=@var{regexp}
5073
5074 This option selects which regular expression will describe the end of a
5075 line or the end of a sentence.  In fact, this regular expression is not
5076 the only distinction between end of lines or end of sentences, and input
5077 line boundaries have no special significance outside this option.  By
5078 default, when @sc{gnu} extensions are enabled and if @option{-r} option is not
5079 used, end of sentences are used.  In this case, this @var{regex} is
5080 imported from @sc{gnu} Emacs:
5081
5082 @example
5083 [.?!][]\"')@}]*\\($\\|\t\\|  \\)[ \t\n]*
5084 @end example
5085
5086 Whenever @sc{gnu} extensions are disabled or if @option{-r} option is used, end
5087 of lines are used; in this case, the default @var{regexp} is just:
5088
5089 @example
5090 \n
5091 @end example
5092
5093 Using an empty @var{regexp} is equivalent to completely disabling end of
5094 line or end of sentence recognition.  In this case, the whole file is
5095 considered to be a single big line or sentence.  The user might want to
5096 disallow all truncation flag generation as well, through option @option{-F
5097 ""}.  @xref{Regexps, , Syntax of Regular Expressions, emacs, The GNU Emacs
5098 Manual}.
5099
5100 When the keywords happen to be near the beginning of the input line or
5101 sentence, this often creates an unused area at the beginning of the
5102 output context line; when the keywords happen to be near the end of the
5103 input line or sentence, this often creates an unused area at the end of
5104 the output context line.  The program tries to fill those unused areas
5105 by wrapping around context in them; the tail of the input line or
5106 sentence is used to fill the unused area on the left of the output line;
5107 the head of the input line or sentence is used to fill the unused area
5108 on the right of the output line.
5109
5110 As a matter of convenience to the user, many usual backslashed escape
5111 sequences from the C language are recognized and converted to the
5112 corresponding characters by @command{ptx} itself.
5113
5114 @item -W @var{regexp}
5115 @itemx --word-regexp=@var{regexp}
5116
5117 This option selects which regular expression will describe each keyword.
5118 By default, if @sc{gnu} extensions are enabled, a word is a sequence of
5119 letters; the @var{regexp} used is @samp{\w+}.  When @sc{gnu} extensions are
5120 disabled, a word is by default anything which ends with a space, a tab
5121 or a newline; the @var{regexp} used is @samp{[^ \t\n]+}.
5122
5123 An empty @var{regexp} is equivalent to not using this option.
5124 @xref{Regexps, , Syntax of Regular Expressions, emacs, The GNU Emacs
5125 Manual}.
5126
5127 As a matter of convenience to the user, many usual backslashed escape
5128 sequences, as found in the C language, are recognized and converted to
5129 the corresponding characters by @command{ptx} itself.
5130
5131 @end table
5132
5133
5134 @node Output formatting in ptx
5135 @subsection Output formatting
5136
5137 Output format is mainly controlled by the @option{-O} and @option{-T} options
5138 described in the table below.  When neither @option{-O} nor @option{-T} are
5139 selected, and if @sc{gnu} extensions are enabled, the program chooses an
5140 output format suitable for a dumb terminal.  Each keyword occurrence is
5141 output to the center of one line, surrounded by its left and right
5142 contexts.  Each field is properly justified, so the concordance output
5143 can be readily observed.  As a special feature, if automatic
5144 references are selected by option @option{-A} and are output before the
5145 left context, that is, if option @option{-R} is @emph{not} selected, then
5146 a colon is added after the reference; this nicely interfaces with @sc{gnu}
5147 Emacs @code{next-error} processing.  In this default output format, each
5148 white space character, like newline and tab, is merely changed to
5149 exactly one space, with no special attempt to compress consecutive
5150 spaces.  This might change in the future.  Except for those white space
5151 characters, every other character of the underlying set of 256
5152 characters is transmitted verbatim.
5153
5154 Output format is further controlled by the following options.
5155
5156 @table @samp
5157
5158 @item -g @var{number}
5159 @itemx --gap-size=@var{number}
5160
5161 Select the size of the minimum white space gap between the fields on the
5162 output line.
5163
5164 @item -w @var{number}
5165 @itemx --width=@var{number}
5166
5167 Select the maximum output width of each final line.  If references are
5168 used, they are included or excluded from the maximum output width
5169 depending on the value of option @option{-R}@.  If this option is not
5170 selected, that is, when references are output before the left context,
5171 the maximum output width takes into account the maximum length of all
5172 references.  If this option is selected, that is, when references are
5173 output after the right context, the maximum output width does not take
5174 into account the space taken by references, nor the gap that precedes
5175 them.
5176
5177 @item -A
5178 @itemx --auto-reference
5179
5180 Select automatic references.  Each input line will have an automatic
5181 reference made up of the file name and the line ordinal, with a single
5182 colon between them.  However, the file name will be empty when standard
5183 input is being read.  If both @option{-A} and @option{-r} are selected, then
5184 the input reference is still read and skipped, but the automatic
5185 reference is used at output time, overriding the input reference.
5186
5187 @item -R
5188 @itemx --right-side-refs
5189
5190 In the default output format, when option @option{-R} is not used, any
5191 references produced by the effect of options @option{-r} or @option{-A} are
5192 placed to the far right of output lines, after the right context.  With
5193 default output format, when the @option{-R} option is specified, references
5194 are rather placed at the beginning of each output line, before the left
5195 context.  For any other output format, option @option{-R} is
5196 ignored, with one exception:  with @option{-R} the width of references
5197 is @emph{not} taken into account in total output width given by @option{-w}.
5198
5199 This option is automatically selected whenever @sc{gnu} extensions are
5200 disabled.
5201
5202 @item -F @var{string}
5203 @itemx --flac-truncation=@var{string}
5204
5205 This option will request that any truncation in the output be reported
5206 using the string @var{string}.  Most output fields theoretically extend
5207 towards the beginning or the end of the current line, or current
5208 sentence, as selected with option @option{-S}@.  But there is a maximum
5209 allowed output line width, changeable through option @option{-w}, which is
5210 further divided into space for various output fields.  When a field has
5211 to be truncated because it cannot extend beyond the beginning or the end of
5212 the current line to fit in, then a truncation occurs.  By default,
5213 the string used is a single slash, as in @option{-F /}.
5214
5215 @var{string} may have more than one character, as in @option{-F ...}.
5216 Also, in the particular case when @var{string} is empty (@option{-F ""}),
5217 truncation flagging is disabled, and no truncation marks are appended in
5218 this case.
5219
5220 As a matter of convenience to the user, many usual backslashed escape
5221 sequences, as found in the C language, are recognized and converted to
5222 the corresponding characters by @command{ptx} itself.
5223
5224 @item -M @var{string}
5225 @itemx --macro-name=@var{string}
5226
5227 Select another @var{string} to be used instead of @samp{xx}, while
5228 generating output suitable for @command{nroff}, @command{troff} or @TeX{}.
5229
5230 @item -O
5231 @itemx --format=roff
5232
5233 Choose an output format suitable for @command{nroff} or @command{troff}
5234 processing.  Each output line will look like:
5235
5236 @smallexample
5237 .xx "@var{tail}" "@var{before}" "@var{keyword_and_after}"@c
5238  "@var{head}" "@var{ref}"
5239 @end smallexample
5240
5241 so it will be possible to write a @samp{.xx} roff macro to take care of
5242 the output typesetting.  This is the default output format when @sc{gnu}
5243 extensions are disabled.  Option @option{-M} can be used to change
5244 @samp{xx} to another macro name.
5245
5246 In this output format, each non-graphical character, like newline and
5247 tab, is merely changed to exactly one space, with no special attempt to
5248 compress consecutive spaces.  Each quote character: @kbd{"} is doubled
5249 so it will be correctly processed by @command{nroff} or @command{troff}.
5250
5251 @item -T
5252 @itemx --format=tex
5253
5254 Choose an output format suitable for @TeX{} processing.  Each output
5255 line will look like:
5256
5257 @smallexample
5258 \xx @{@var{tail}@}@{@var{before}@}@{@var{keyword}@}@c
5259 @{@var{after}@}@{@var{head}@}@{@var{ref}@}
5260 @end smallexample
5261
5262 @noindent
5263 so it will be possible to write a @code{\xx} definition to take care of
5264 the output typesetting.  Note that when references are not being
5265 produced, that is, neither option @option{-A} nor option @option{-r} is
5266 selected, the last parameter of each @code{\xx} call is inhibited.
5267 Option @option{-M} can be used to change @samp{xx} to another macro
5268 name.
5269
5270 In this output format, some special characters, like @kbd{$}, @kbd{%},
5271 @kbd{&}, @kbd{#} and @kbd{_} are automatically protected with a
5272 backslash.  Curly brackets @kbd{@{}, @kbd{@}} are protected with a
5273 backslash and a pair of dollar signs (to force mathematical mode).  The
5274 backslash itself produces the sequence @code{\backslash@{@}}.
5275 Circumflex and tilde diacritical marks produce the sequence @code{^\@{ @}} and
5276 @code{~\@{ @}} respectively.  Other diacriticized characters of the
5277 underlying character set produce an appropriate @TeX{} sequence as far
5278 as possible.  The other non-graphical characters, like newline and tab,
5279 and all other characters which are not part of ASCII, are merely
5280 changed to exactly one space, with no special attempt to compress
5281 consecutive spaces.  Let me know how to improve this special character
5282 processing for @TeX{}.
5283
5284 @end table
5285
5286
5287 @node Compatibility in ptx
5288 @subsection The @sc{gnu} extensions to @command{ptx}
5289
5290 This version of @command{ptx} contains a few features which do not exist in
5291 System V @command{ptx}.  These extra features are suppressed by using the
5292 @option{-G} command line option, unless overridden by other command line
5293 options.  Some @sc{gnu} extensions cannot be recovered by overriding, so the
5294 simple rule is to avoid @option{-G} if you care about @sc{gnu} extensions.
5295 Here are the differences between this program and System V @command{ptx}.
5296
5297 @itemize @bullet
5298
5299 @item
5300 This program can read many input files at once, it always writes the
5301 resulting concordance on standard output.  On the other hand, System V
5302 @command{ptx} reads only one file and sends the result to standard output
5303 or, if a second @var{file} parameter is given on the command, to that
5304 @var{file}.
5305
5306 Having output parameters not introduced by options is a dangerous
5307 practice which @sc{gnu} avoids as far as possible.  So, for using @command{ptx}
5308 portably between @sc{gnu} and System V, you should always use it with a
5309 single input file, and always expect the result on standard output.  You
5310 might also want to automatically configure in a @option{-G} option to
5311 @command{ptx} calls in products using @command{ptx}, if the configurator finds
5312 that the installed @command{ptx} accepts @option{-G}.
5313
5314 @item
5315 The only options available in System V @command{ptx} are options @option{-b},
5316 @option{-f}, @option{-g}, @option{-i}, @option{-o}, @option{-r}, @option{-t} and
5317 @option{-w}.  All other options are @sc{gnu} extensions and are not repeated in
5318 this enumeration.  Moreover, some options have a slightly different
5319 meaning when @sc{gnu} extensions are enabled, as explained below.
5320
5321 @item
5322 By default, concordance output is not formatted for @command{troff} or
5323 @command{nroff}.  It is rather formatted for a dumb terminal.  @command{troff}
5324 or @command{nroff} output may still be selected through option @option{-O}.
5325
5326 @item
5327 Unless @option{-R} option is used, the maximum reference width is
5328 subtracted from the total output line width.  With @sc{gnu} extensions
5329 disabled, width of references is not taken into account in the output
5330 line width computations.
5331
5332 @item
5333 All 256 bytes, even ASCII @sc{nul} bytes, are always read and
5334 processed from input file with no adverse effect, even if @sc{gnu} extensions
5335 are disabled.  However, System V @command{ptx} does not accept 8-bit
5336 characters, a few control characters are rejected, and the tilde
5337 @kbd{~} is also rejected.
5338
5339 @item
5340 Input line length is only limited by available memory, even if @sc{gnu}
5341 extensions are disabled.  However, System V @command{ptx} processes only
5342 the first 200 characters in each line.
5343
5344 @item
5345 The break (non-word) characters default to be every character except all
5346 letters of the underlying character set, diacriticized or not.  When @sc{gnu}
5347 extensions are disabled, the break characters default to space, tab and
5348 newline only.
5349
5350 @item
5351 The program makes better use of output line width.  If @sc{gnu} extensions
5352 are disabled, the program rather tries to imitate System V @command{ptx},
5353 but still, there are some slight disposition glitches this program does
5354 not completely reproduce.
5355
5356 @item
5357 The user can specify both an Ignore file and an Only file.  This is not
5358 allowed with System V @command{ptx}.
5359
5360 @end itemize
5361
5362
5363 @node tsort invocation
5364 @section @command{tsort}: Topological sort
5365
5366 @pindex tsort
5367 @cindex topological sort
5368
5369 @command{tsort} performs a topological sort on the given @var{file}, or
5370 standard input if no input file is given or for a @var{file} of
5371 @samp{-}.  For more details and some history, see @ref{tsort background}.
5372 Synopsis:
5373
5374 @example
5375 tsort [@var{option}] [@var{file}]
5376 @end example
5377
5378 @command{tsort} reads its input as pairs of strings, separated by blanks,
5379 indicating a partial ordering.  The output is a total ordering that
5380 corresponds to the given partial ordering.
5381
5382 For example
5383
5384 @example
5385 tsort <<EOF
5386 a b c
5387 d
5388 e f
5389 b c d e
5390 EOF
5391 @end example
5392
5393 @noindent
5394 will produce the output
5395
5396 @example
5397 a
5398 b
5399 c
5400 d
5401 e
5402 f
5403 @end example
5404
5405 Consider a more realistic example.
5406 You have a large set of functions all in one file, and they may all be
5407 declared static except one.  Currently that one (say @code{main}) is the
5408 first function defined in the file, and the ones it calls directly follow
5409 it, followed by those they call, etc.  Let's say that you are determined
5410 to take advantage of prototypes, so you have to choose between declaring
5411 all of those functions (which means duplicating a lot of information from
5412 the definitions) and rearranging the functions so that as many as possible
5413 are defined before they are used.  One way to automate the latter process
5414 is to get a list for each function of the functions it calls directly.
5415 Many programs can generate such lists.  They describe a call graph.
5416 Consider the following list, in which a given line indicates that the
5417 function on the left calls the one on the right directly.
5418
5419 @example
5420 main parse_options
5421 main tail_file
5422 main tail_forever
5423 tail_file pretty_name
5424 tail_file write_header
5425 tail_file tail
5426 tail_forever recheck
5427 tail_forever pretty_name
5428 tail_forever write_header
5429 tail_forever dump_remainder
5430 tail tail_lines
5431 tail tail_bytes
5432 tail_lines start_lines
5433 tail_lines dump_remainder
5434 tail_lines file_lines
5435 tail_lines pipe_lines
5436 tail_bytes xlseek
5437 tail_bytes start_bytes
5438 tail_bytes dump_remainder
5439 tail_bytes pipe_bytes
5440 file_lines dump_remainder
5441 recheck pretty_name
5442 @end example
5443
5444 then you can use @command{tsort} to produce an ordering of those
5445 functions that satisfies your requirement.
5446
5447 @example
5448 example$ tsort call-graph | tac
5449 dump_remainder
5450 start_lines
5451 file_lines
5452 pipe_lines
5453 xlseek
5454 start_bytes
5455 pipe_bytes
5456 tail_lines
5457 tail_bytes
5458 pretty_name
5459 write_header
5460 tail
5461 recheck
5462 parse_options
5463 tail_file
5464 tail_forever
5465 main
5466 @end example
5467
5468 @command{tsort} detects any cycles in the input and writes the first cycle
5469 encountered to standard error.
5470
5471 Note that for a given partial ordering, generally there is no unique
5472 total ordering.  In the context of the call graph above, the function
5473 @code{parse_options} may be placed anywhere in the list as long as it
5474 precedes @code{main}.
5475
5476 The only options are @option{--help} and @option{--version}.  @xref{Common
5477 options}.
5478
5479 @exitstatus
5480
5481 @menu
5482 * tsort background::            Where tsort came from.
5483 @end menu
5484
5485 @node tsort background
5486 @subsection @command{tsort}: Background
5487
5488 @command{tsort} exists because very early versions of the Unix linker processed
5489 an archive file exactly once, and in order.  As @command{ld} read each object
5490 in the archive, it decided whether it was needed in the program based on
5491 whether it defined any symbols which were undefined at that point in
5492 the link.
5493
5494 This meant that dependencies within the archive had to be handled
5495 specially.  For example, @code{scanf} probably calls @code{read}.  That means
5496 that in a single pass through an archive, it was important for @code{scanf.o}
5497 to appear before read.o, because otherwise a program which calls
5498 @code{scanf} but not @code{read} might end up with an unexpected unresolved
5499 reference to @code{read}.
5500
5501 The way to address this problem was to first generate a set of
5502 dependencies of one object file on another.  This was done by a shell
5503 script called @command{lorder}.  The GNU tools don't provide a version of
5504 lorder, as far as I know, but you can still find it in BSD
5505 distributions.
5506
5507 Then you ran @command{tsort} over the @command{lorder} output, and you used the
5508 resulting sort to define the order in which you added objects to the archive.
5509
5510 This whole procedure has been obsolete since about 1980, because
5511 Unix archives now contain a symbol table (traditionally built by
5512 @command{ranlib}, now generally built by @command{ar} itself), and the Unix
5513 linker uses the symbol table to effectively make multiple passes over
5514 an archive file.
5515
5516 Anyhow, that's where tsort came from.  To solve an old problem with
5517 the way the linker handled archive files, which has since been solved
5518 in different ways.
5519
5520
5521 @node Operating on fields
5522 @chapter Operating on fields
5523
5524 @menu
5525 * cut invocation::              Print selected parts of lines.
5526 * paste invocation::            Merge lines of files.
5527 * join invocation::             Join lines on a common field.
5528 @end menu
5529
5530
5531 @node cut invocation
5532 @section @command{cut}: Print selected parts of lines
5533
5534 @pindex cut
5535 @command{cut} writes to standard output selected parts of each line of each
5536 input file, or standard input if no files are given or for a file name of
5537 @samp{-}.  Synopsis:
5538
5539 @example
5540 cut @var{option}@dots{} [@var{file}]@dots{}
5541 @end example
5542
5543 In the table which follows, the @var{byte-list}, @var{character-list},
5544 and @var{field-list} are one or more numbers or ranges (two numbers
5545 separated by a dash) separated by commas.  Bytes, characters, and
5546 fields are numbered starting at 1.  Incomplete ranges may be
5547 given: @option{-@var{m}} means @samp{1-@var{m}}; @samp{@var{n}-} means
5548 @samp{@var{n}} through end of line or last field.  The list elements
5549 can be repeated, can overlap, and can be specified in any order; but
5550 the selected input is written in the same order that it is read, and
5551 is written exactly once.
5552
5553 The program accepts the following options.  Also see @ref{Common
5554 options}.
5555
5556 @table @samp
5557
5558 @item -b @var{byte-list}
5559 @itemx --bytes=@var{byte-list}
5560 @opindex -b
5561 @opindex --bytes
5562 Select for printing only the bytes in positions listed in
5563 @var{byte-list}.  Tabs and backspaces are treated like any other
5564 character; they take up 1 byte.  If an output delimiter is specified,
5565 (see the description of @option{--output-delimiter}), then output that
5566 string between ranges of selected bytes.
5567
5568 @item -c @var{character-list}
5569 @itemx --characters=@var{character-list}
5570 @opindex -c
5571 @opindex --characters
5572 Select for printing only the characters in positions listed in
5573 @var{character-list}.  The same as @option{-b} for now, but
5574 internationalization will change that.  Tabs and backspaces are
5575 treated like any other character; they take up 1 character.  If an
5576 output delimiter is specified, (see the description of
5577 @option{--output-delimiter}), then output that string between ranges
5578 of selected bytes.
5579
5580 @item -f @var{field-list}
5581 @itemx --fields=@var{field-list}
5582 @opindex -f
5583 @opindex --fields
5584 Select for printing only the fields listed in @var{field-list}.
5585 Fields are separated by a TAB character by default.  Also print any
5586 line that contains no delimiter character, unless the
5587 @option{--only-delimited} (@option{-s}) option is specified.
5588
5589 Note @command{awk} supports more sophisticated field processing,
5590 and by default will use (and discard) runs of blank characters to
5591 separate fields, and ignore leading and trailing blanks.
5592 @example
5593 @verbatim
5594 awk '{print $2}'    # print the second field
5595 awk '{print $NF-1}' # print the penultimate field
5596 awk '{print $2,$1}' # reorder the first two fields
5597 @end verbatim
5598 @end example
5599
5600 In the unlikely event that @command{awk} is unavailable,
5601 one can use the @command{join} command, to process blank
5602 characters as @command{awk} does above.
5603 @example
5604 @verbatim
5605 join -a1 -o 1.2     - /dev/null # print the second field
5606 join -a1 -o 1.2,1.1 - /dev/null # reorder the first two fields
5607 @end verbatim
5608 @end example
5609
5610 @item -d @var{input_delim_byte}
5611 @itemx --delimiter=@var{input_delim_byte}
5612 @opindex -d
5613 @opindex --delimiter
5614 With @option{-f}, use the first byte of @var{input_delim_byte} as
5615 the input fields separator (default is TAB).
5616
5617 @item -n
5618 @opindex -n
5619 Do not split multi-byte characters (no-op for now).
5620
5621 @item -s
5622 @itemx --only-delimited
5623 @opindex -s
5624 @opindex --only-delimited
5625 For @option{-f}, do not print lines that do not contain the field separator
5626 character.  Normally, any line without a field separator is printed verbatim.
5627
5628 @item --output-delimiter=@var{output_delim_string}
5629 @opindex --output-delimiter
5630 With @option{-f}, output fields are separated by @var{output_delim_string}.
5631 The default with @option{-f} is to use the input delimiter.
5632 When using @option{-b} or @option{-c} to select ranges of byte or
5633 character offsets (as opposed to ranges of fields),
5634 output @var{output_delim_string} between non-overlapping
5635 ranges of selected bytes.
5636
5637 @item --complement
5638 @opindex --complement
5639 This option is a GNU extension.
5640 Select for printing the complement of the bytes, characters or fields
5641 selected with the @option{-b}, @option{-c} or @option{-f} options.
5642 In other words, do @emph{not} print the bytes, characters or fields
5643 specified via those options.  This option is useful when you have
5644 many fields and want to print all but a few of them.
5645
5646 @end table
5647
5648 @exitstatus
5649
5650
5651 @node paste invocation
5652 @section @command{paste}: Merge lines of files
5653
5654 @pindex paste
5655 @cindex merging files
5656
5657 @command{paste} writes to standard output lines consisting of sequentially
5658 corresponding lines of each given file, separated by a TAB character.
5659 Standard input is used for a file name of @samp{-} or if no input files
5660 are given.
5661
5662 For example:
5663
5664 @example
5665 $ cat num2
5666 1
5667 2
5668 $ cat let3
5669 a
5670 b
5671 c
5672 $ paste num2 let3
5673 1       a
5674 2       b
5675        @ c
5676 @end example
5677
5678 Synopsis:
5679
5680 @example
5681 paste [@var{option}]@dots{} [@var{file}]@dots{}
5682 @end example
5683
5684 The program accepts the following options.  Also see @ref{Common options}.
5685
5686 @table @samp
5687
5688 @item -s
5689 @itemx --serial
5690 @opindex -s
5691 @opindex --serial
5692 Paste the lines of one file at a time rather than one line from each
5693 file.  Using the above example data:
5694
5695 @example
5696 $ paste -s num2 let3
5697 1       2
5698 a       b       c
5699 @end example
5700
5701 @item -d @var{delim-list}
5702 @itemx --delimiters=@var{delim-list}
5703 @opindex -d
5704 @opindex --delimiters
5705 Consecutively use the characters in @var{delim-list} instead of
5706 TAB to separate merged lines.  When @var{delim-list} is
5707 exhausted, start again at its beginning.  Using the above example data:
5708
5709 @example
5710 $ paste -d '%_' num2 let3 num2
5711 1%a_1
5712 2%b_2
5713 %c_
5714 @end example
5715
5716 @end table
5717
5718 @exitstatus
5719
5720
5721 @node join invocation
5722 @section @command{join}: Join lines on a common field
5723
5724 @pindex join
5725 @cindex common field, joining on
5726
5727 @command{join} writes to standard output a line for each pair of input
5728 lines that have identical join fields.  Synopsis:
5729
5730 @example
5731 join [@var{option}]@dots{} @var{file1} @var{file2}
5732 @end example
5733
5734 Either @var{file1} or @var{file2} (but not both) can be @samp{-},
5735 meaning standard input.  @var{file1} and @var{file2} should be
5736 sorted on the join fields.
5737
5738 @vindex LC_COLLATE
5739 Normally, the sort order is that of the
5740 collating sequence specified by the @env{LC_COLLATE} locale.  Unless
5741 the @option{-t} option is given, the sort comparison ignores blanks at
5742 the start of the join field, as in @code{sort -b}.  If the
5743 @option{--ignore-case} option is given, the sort comparison ignores
5744 the case of characters in the join field, as in @code{sort -f}.
5745
5746 The @command{sort} and @command{join} commands should use consistent
5747 locales and options if the output of @command{sort} is fed to
5748 @command{join}.  You can use a command like @samp{sort -k 1b,1} to
5749 sort a file on its default join field, but if you select a non-default
5750 locale, join field, separator, or comparison options, then you should
5751 do so consistently between @command{join} and @command{sort}.
5752 If @samp{join -t ''} is specified then the whole line is considered which
5753 matches the default operation of sort.
5754
5755 If the input has no unpairable lines, a GNU extension is
5756 available; the sort order can be any order that considers two fields
5757 to be equal if and only if the sort comparison described above
5758 considers them to be equal.  For example:
5759
5760 @example
5761 $ cat file1
5762 a a1
5763 c c1
5764 b b1
5765 $ cat file2
5766 a a2
5767 c c2
5768 b b2
5769 $ join file1 file2
5770 a a1 a2
5771 c c1 c2
5772 b b1 b2
5773 @end example
5774
5775 @set JOIN_COMMAND
5776 @checkOrderOption{join}
5777 @clear JOIN_COMMAND
5778
5779 The defaults are:
5780 @itemize
5781 @item the join field is the first field in each line;
5782 @item fields in the input are separated by one or more blanks, with leading
5783 blanks on the line ignored;
5784 @item fields in the output are separated by a space;
5785 @item each output line consists of the join field, the remaining
5786 fields from @var{file1}, then the remaining fields from @var{file2}.
5787 @end itemize
5788
5789 The program accepts the following options.  Also see @ref{Common options}.
5790
5791 @table @samp
5792
5793 @item -a @var{file-number}
5794 @opindex -a
5795 Print a line for each unpairable line in file @var{file-number} (either
5796 @samp{1} or @samp{2}), in addition to the normal output.
5797
5798 @item --check-order
5799 Fail with an error message if either input file is wrongly ordered.
5800
5801 @item --nocheck-order
5802 Do not check that both input files are in sorted order.  This is the default.
5803
5804 @item -e @var{string}
5805 @opindex -e
5806 Replace those output fields that are missing in the input with @var{string}.
5807 I.e., missing fields specified with the @option{-12jo} options.
5808
5809 @item --header
5810 @opindex --header
5811 Treat the first line of each input file as a header line.  The header lines
5812 will be joined and printed as the first output line.  If @option{-o} is used to
5813 specify output format, the header line will be printed according to the
5814 specified format.  The header lines will not be checked for ordering even if
5815 @option{--check-order} is specified.  Also if the header lines from each file
5816 do not match, the heading fields from the first file will be used.
5817
5818 @item -i
5819 @itemx --ignore-case
5820 @opindex -i
5821 @opindex --ignore-case
5822 Ignore differences in case when comparing keys.
5823 With this option, the lines of the input files must be ordered in the same way.
5824 Use @samp{sort -f} to produce this ordering.
5825
5826 @item -1 @var{field}
5827 @opindex -1
5828 Join on field @var{field} (a positive integer) of file 1.
5829
5830 @item -2 @var{field}
5831 @opindex -2
5832 Join on field @var{field} (a positive integer) of file 2.
5833
5834 @item -j @var{field}
5835 Equivalent to @option{-1 @var{field} -2 @var{field}}.
5836
5837 @item -o @var{field-list}
5838 @itemx -o auto
5839 If the keyword @samp{auto} is specified, infer the output format from
5840 the first line in each file.  This is the same as the default output format
5841 but also ensures the same number of fields are output for each line.
5842 Missing fields are replaced with the @option{-e} option and extra fields
5843 are discarded.
5844
5845 Otherwise, construct each output line according to the format in
5846 @var{field-list}.  Each element in @var{field-list} is either the single
5847 character @samp{0} or has the form @var{m.n} where the file number, @var{m},
5848 is @samp{1} or @samp{2} and @var{n} is a positive field number.
5849
5850 A field specification of @samp{0} denotes the join field.
5851 In most cases, the functionality of the @samp{0} field spec
5852 may be reproduced using the explicit @var{m.n} that corresponds
5853 to the join field.  However, when printing unpairable lines
5854 (using either of the @option{-a} or @option{-v} options), there is no way
5855 to specify the join field using @var{m.n} in @var{field-list}
5856 if there are unpairable lines in both files.
5857 To give @command{join} that functionality, POSIX invented the @samp{0}
5858 field specification notation.
5859
5860 The elements in @var{field-list}
5861 are separated by commas or blanks.
5862 Blank separators typically need to be quoted for the shell.  For
5863 example, the commands @samp{join -o 1.2,2.2} and @samp{join -o '1.2
5864 2.2'} are equivalent.
5865
5866 All output lines---including those printed because of any -a or -v
5867 option---are subject to the specified @var{field-list}.
5868
5869 @item -t @var{char}
5870 Use character @var{char} as the input and output field separator.
5871 Treat as significant each occurrence of @var{char} in the input file.
5872 Use @samp{sort -t @var{char}}, without the @option{-b} option of
5873 @samp{sort}, to produce this ordering.  If @samp{join -t ''} is specified,
5874 the whole line is considered, matching the default operation of sort.
5875 If @samp{-t '\0'} is specified then the ASCII @sc{nul}
5876 character is used to delimit the fields.
5877
5878 @item -v @var{file-number}
5879 Print a line for each unpairable line in file @var{file-number}
5880 (either @samp{1} or @samp{2}), instead of the normal output.
5881
5882 @end table
5883
5884 @exitstatus
5885
5886
5887 @node Operating on characters
5888 @chapter Operating on characters
5889
5890 @cindex operating on characters
5891
5892 This commands operate on individual characters.
5893
5894 @menu
5895 * tr invocation::               Translate, squeeze, and/or delete characters.
5896 * expand invocation::           Convert tabs to spaces.
5897 * unexpand invocation::         Convert spaces to tabs.
5898 @end menu
5899
5900
5901 @node tr invocation
5902 @section @command{tr}: Translate, squeeze, and/or delete characters
5903
5904 @pindex tr
5905
5906 Synopsis:
5907
5908 @example
5909 tr [@var{option}]@dots{} @var{set1} [@var{set2}]
5910 @end example
5911
5912 @command{tr} copies standard input to standard output, performing
5913 one of the following operations:
5914
5915 @itemize @bullet
5916 @item
5917 translate, and optionally squeeze repeated characters in the result,
5918 @item
5919 squeeze repeated characters,
5920 @item
5921 delete characters,
5922 @item
5923 delete characters, then squeeze repeated characters from the result.
5924 @end itemize
5925
5926 The @var{set1} and (if given) @var{set2} arguments define ordered
5927 sets of characters, referred to below as @var{set1} and @var{set2}.  These
5928 sets are the characters of the input that @command{tr} operates on.
5929 The @option{--complement} (@option{-c}, @option{-C}) option replaces
5930 @var{set1} with its
5931 complement (all of the characters that are not in @var{set1}).
5932
5933 Currently @command{tr} fully supports only single-byte characters.
5934 Eventually it will support multibyte characters; when it does, the
5935 @option{-C} option will cause it to complement the set of characters,
5936 whereas @option{-c} will cause it to complement the set of values.
5937 This distinction will matter only when some values are not characters,
5938 and this is possible only in locales using multibyte encodings when
5939 the input contains encoding errors.
5940
5941 The program accepts the @option{--help} and @option{--version}
5942 options.  @xref{Common options}.  Options must precede operands.
5943
5944 @exitstatus
5945
5946 @menu
5947 * Character sets::              Specifying sets of characters.
5948 * Translating::                 Changing one set of characters to another.
5949 * Squeezing::                   Squeezing repeats and deleting.
5950 @end menu
5951
5952
5953 @node Character sets
5954 @subsection Specifying sets of characters
5955
5956 @cindex specifying sets of characters
5957
5958 The format of the @var{set1} and @var{set2} arguments resembles
5959 the format of regular expressions; however, they are not regular
5960 expressions, only lists of characters.  Most characters simply
5961 represent themselves in these strings, but the strings can contain
5962 the shorthands listed below, for convenience.  Some of them can be
5963 used only in @var{set1} or @var{set2}, as noted below.
5964
5965 @table @asis
5966
5967 @item Backslash escapes
5968 @cindex backslash escapes
5969
5970 The following backslash escape sequences are recognized:
5971
5972 @table @samp
5973 @item \a
5974 Control-G.
5975 @item \b
5976 Control-H.
5977 @item \f
5978 Control-L.
5979 @item \n
5980 Control-J.
5981 @item \r
5982 Control-M.
5983 @item \t
5984 Control-I.
5985 @item \v
5986 Control-K.
5987 @item \@var{ooo}
5988 The 8-bit character with the value given by @var{ooo}, which is 1 to 3
5989 octal digits.  Note that @samp{\400} is interpreted as the two-byte
5990 sequence, @samp{\040} @samp{0}.
5991 @item \\
5992 A backslash.
5993 @end table
5994
5995 While a backslash followed by a character not listed above is
5996 interpreted as that character, the backslash also effectively
5997 removes any special significance, so it is useful to escape
5998 @samp{[}, @samp{]}, @samp{*}, and @samp{-}.
5999
6000 @item Ranges
6001 @cindex ranges
6002
6003 The notation @samp{@var{m}-@var{n}} expands to all of the characters
6004 from @var{m} through @var{n}, in ascending order.  @var{m} should
6005 collate before @var{n}; if it doesn't, an error results.  As an example,
6006 @samp{0-9} is the same as @samp{0123456789}.
6007
6008 @sc{gnu} @command{tr} does not support the System V syntax that uses square
6009 brackets to enclose ranges.  Translations specified in that format
6010 sometimes work as expected, since the brackets are often transliterated
6011 to themselves.  However, they should be avoided because they sometimes
6012 behave unexpectedly.  For example, @samp{tr -d '[0-9]'} deletes brackets
6013 as well as digits.
6014
6015 Many historically common and even accepted uses of ranges are not
6016 portable.  For example, on EBCDIC hosts using the @samp{A-Z}
6017 range will not do what most would expect because @samp{A} through @samp{Z}
6018 are not contiguous as they are in ASCII@.
6019 If you can rely on a POSIX compliant version of @command{tr}, then
6020 the best way to work around this is to use character classes (see below).
6021 Otherwise, it is most portable (and most ugly) to enumerate the members
6022 of the ranges.
6023
6024 @item Repeated characters
6025 @cindex repeated characters
6026
6027 The notation @samp{[@var{c}*@var{n}]} in @var{set2} expands to @var{n}
6028 copies of character @var{c}.  Thus, @samp{[y*6]} is the same as
6029 @samp{yyyyyy}.  The notation @samp{[@var{c}*]} in @var{string2} expands
6030 to as many copies of @var{c} as are needed to make @var{set2} as long as
6031 @var{set1}.  If @var{n} begins with @samp{0}, it is interpreted in
6032 octal, otherwise in decimal.
6033
6034 @item Character classes
6035 @cindex character classes
6036
6037 The notation @samp{[:@var{class}:]} expands to all of the characters in
6038 the (predefined) class @var{class}.  The characters expand in no
6039 particular order, except for the @code{upper} and @code{lower} classes,
6040 which expand in ascending order.  When the @option{--delete} (@option{-d})
6041 and @option{--squeeze-repeats} (@option{-s}) options are both given, any
6042 character class can be used in @var{set2}.  Otherwise, only the
6043 character classes @code{lower} and @code{upper} are accepted in
6044 @var{set2}, and then only if the corresponding character class
6045 (@code{upper} and @code{lower}, respectively) is specified in the same
6046 relative position in @var{set1}.  Doing this specifies case conversion.
6047 The class names are given below; an error results when an invalid class
6048 name is given.
6049
6050 @table @code
6051 @item alnum
6052 @opindex alnum
6053 Letters and digits.
6054 @item alpha
6055 @opindex alpha
6056 Letters.
6057 @item blank
6058 @opindex blank
6059 Horizontal whitespace.
6060 @item cntrl
6061 @opindex cntrl
6062 Control characters.
6063 @item digit
6064 @opindex digit
6065 Digits.
6066 @item graph
6067 @opindex graph
6068 Printable characters, not including space.
6069 @item lower
6070 @opindex lower
6071 Lowercase letters.
6072 @item print
6073 @opindex print
6074 Printable characters, including space.
6075 @item punct
6076 @opindex punct
6077 Punctuation characters.
6078 @item space
6079 @opindex space
6080 Horizontal or vertical whitespace.
6081 @item upper
6082 @opindex upper
6083 Uppercase letters.
6084 @item xdigit
6085 @opindex xdigit
6086 Hexadecimal digits.
6087 @end table
6088
6089 @item Equivalence classes
6090 @cindex equivalence classes
6091
6092 The syntax @samp{[=@var{c}=]} expands to all of the characters that are
6093 equivalent to @var{c}, in no particular order.  Equivalence classes are
6094 a relatively recent invention intended to support non-English alphabets.
6095 But there seems to be no standard way to define them or determine their
6096 contents.  Therefore, they are not fully implemented in @sc{gnu} @command{tr};
6097 each character's equivalence class consists only of that character,
6098 which is of no particular use.
6099
6100 @end table
6101
6102
6103 @node Translating
6104 @subsection Translating
6105
6106 @cindex translating characters
6107
6108 @command{tr} performs translation when @var{set1} and @var{set2} are
6109 both given and the @option{--delete} (@option{-d}) option is not given.
6110 @command{tr} translates each character of its input that is in @var{set1}
6111 to the corresponding character in @var{set2}.  Characters not in
6112 @var{set1} are passed through unchanged.  When a character appears more
6113 than once in @var{set1} and the corresponding characters in @var{set2}
6114 are not all the same, only the final one is used.  For example, these
6115 two commands are equivalent:
6116
6117 @example
6118 tr aaa xyz
6119 tr a z
6120 @end example
6121
6122 A common use of @command{tr} is to convert lowercase characters to
6123 uppercase.  This can be done in many ways.  Here are three of them:
6124
6125 @example
6126 tr abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ
6127 tr a-z A-Z
6128 tr '[:lower:]' '[:upper:]'
6129 @end example
6130
6131 @noindent
6132 But note that using ranges like @code{a-z} above is not portable.
6133
6134 When @command{tr} is performing translation, @var{set1} and @var{set2}
6135 typically have the same length.  If @var{set1} is shorter than
6136 @var{set2}, the extra characters at the end of @var{set2} are ignored.
6137
6138 On the other hand, making @var{set1} longer than @var{set2} is not
6139 portable; POSIX says that the result is undefined.  In this situation,
6140 BSD @command{tr} pads @var{set2} to the length of @var{set1} by repeating
6141 the last character of @var{set2} as many times as necessary.  System V
6142 @command{tr} truncates @var{set1} to the length of @var{set2}.
6143
6144 By default, @sc{gnu} @command{tr} handles this case like BSD @command{tr}.
6145 When the @option{--truncate-set1} (@option{-t}) option is given,
6146 @sc{gnu} @command{tr} handles this case like the System V @command{tr}
6147 instead.  This option is ignored for operations other than translation.
6148
6149 Acting like System V @command{tr} in this case breaks the relatively common
6150 BSD idiom:
6151
6152 @example
6153 tr -cs A-Za-z0-9 '\012'
6154 @end example
6155
6156 @noindent
6157 because it converts only zero bytes (the first element in the
6158 complement of @var{set1}), rather than all non-alphanumerics, to
6159 newlines.
6160
6161 @noindent
6162 By the way, the above idiom is not portable because it uses ranges, and
6163 it assumes that the octal code for newline is 012.
6164 Assuming a POSIX compliant @command{tr}, here is a better
6165 way to write it:
6166
6167 @example
6168 tr -cs '[:alnum:]' '[\n*]'
6169 @end example
6170
6171
6172 @node Squeezing
6173 @subsection Squeezing repeats and deleting
6174
6175 @cindex squeezing repeat characters
6176 @cindex deleting characters
6177
6178 When given just the @option{--delete} (@option{-d}) option, @command{tr}
6179 removes any input characters that are in @var{set1}.
6180
6181 When given just the @option{--squeeze-repeats} (@option{-s}) option,
6182 @command{tr} replaces each input sequence of a repeated character that
6183 is in @var{set1} with a single occurrence of that character.
6184
6185 When given both @option{--delete} and @option{--squeeze-repeats}, @command{tr}
6186 first performs any deletions using @var{set1}, then squeezes repeats
6187 from any remaining characters using @var{set2}.
6188
6189 The @option{--squeeze-repeats} option may also be used when translating,
6190 in which case @command{tr} first performs translation, then squeezes
6191 repeats from any remaining characters using @var{set2}.
6192
6193 Here are some examples to illustrate various combinations of options:
6194
6195 @itemize @bullet
6196
6197 @item
6198 Remove all zero bytes:
6199
6200 @example
6201 tr -d '\0'
6202 @end example
6203
6204 @item
6205 Put all words on lines by themselves.  This converts all
6206 non-alphanumeric characters to newlines, then squeezes each string
6207 of repeated newlines into a single newline:
6208
6209 @example
6210 tr -cs '[:alnum:]' '[\n*]'
6211 @end example
6212
6213 @item
6214 Convert each sequence of repeated newlines to a single newline:
6215
6216 @example
6217 tr -s '\n'
6218 @end example
6219
6220 @item
6221 Find doubled occurrences of words in a document.
6222 @c Separate the following two "the"s, so typo checkers don't complain.
6223 For example, people often write ``the @w{}the'' with the repeated words
6224 separated by a newline.  The Bourne shell script below works first
6225 by converting each sequence of punctuation and blank characters to a
6226 single newline.  That puts each ``word'' on a line by itself.
6227 Next it maps all uppercase characters to lower case, and finally it
6228 runs @command{uniq} with the @option{-d} option to print out only the words
6229 that were repeated.
6230
6231 @example
6232 #!/bin/sh
6233 cat -- "$@@" \
6234   | tr -s '[:punct:][:blank:]' '[\n*]' \
6235   | tr '[:upper:]' '[:lower:]' \
6236   | uniq -d
6237 @end example
6238
6239 @item
6240 Deleting a small set of characters is usually straightforward.  For example,
6241 to remove all @samp{a}s, @samp{x}s, and @samp{M}s you would do this:
6242
6243 @example
6244 tr -d axM
6245 @end example
6246
6247 However, when @samp{-} is one of those characters, it can be tricky because
6248 @samp{-} has special meanings.  Performing the same task as above but also
6249 removing all @samp{-} characters, we might try @code{tr -d -axM}, but
6250 that would fail because @command{tr} would try to interpret @option{-a} as
6251 a command-line option.  Alternatively, we could try putting the hyphen
6252 inside the string, @code{tr -d a-xM}, but that wouldn't work either because
6253 it would make @command{tr} interpret @code{a-x} as the range of characters
6254 @samp{a}@dots{}@samp{x} rather than the three.
6255 One way to solve the problem is to put the hyphen at the end of the list
6256 of characters:
6257
6258 @example
6259 tr -d axM-
6260 @end example
6261
6262 Or you can use @samp{--} to terminate option processing:
6263
6264 @example
6265 tr -d -- -axM
6266 @end example
6267
6268 More generally, use the character class notation @code{[=c=]}
6269 with @samp{-} (or any other character) in place of the @samp{c}:
6270
6271 @example
6272 tr -d '[=-=]axM'
6273 @end example
6274
6275 Note how single quotes are used in the above example to protect the
6276 square brackets from interpretation by a shell.
6277
6278 @end itemize
6279
6280
6281 @node expand invocation
6282 @section @command{expand}: Convert tabs to spaces
6283
6284 @pindex expand
6285 @cindex tabs to spaces, converting
6286 @cindex converting tabs to spaces
6287
6288 @command{expand} writes the contents of each given @var{file}, or standard
6289 input if none are given or for a @var{file} of @samp{-}, to standard
6290 output, with tab characters converted to the appropriate number of
6291 spaces.  Synopsis:
6292
6293 @example
6294 expand [@var{option}]@dots{} [@var{file}]@dots{}
6295 @end example
6296
6297 By default, @command{expand} converts all tabs to spaces.  It preserves
6298 backspace characters in the output; they decrement the column count for
6299 tab calculations.  The default action is equivalent to @option{-t 8} (set
6300 tabs every 8 columns).
6301
6302 The program accepts the following options.  Also see @ref{Common options}.
6303
6304 @table @samp
6305
6306 @item -t @var{tab1}[,@var{tab2}]@dots{}
6307 @itemx --tabs=@var{tab1}[,@var{tab2}]@dots{}
6308 @opindex -t
6309 @opindex --tabs
6310 @cindex tab stops, setting
6311 If only one tab stop is given, set the tabs @var{tab1} spaces apart
6312 (default is 8).  Otherwise, set the tabs at columns @var{tab1},
6313 @var{tab2}, @dots{} (numbered from 0), and replace any tabs beyond the
6314 last tab stop given with single spaces.  Tab stops can be separated by
6315 blanks as well as by commas.
6316
6317 For compatibility, GNU @command{expand} also accepts the obsolete
6318 option syntax, @option{-@var{t1}[,@var{t2}]@dots{}}.  New scripts
6319 should use @option{-t @var{t1}[,@var{t2}]@dots{}} instead.
6320
6321 @item -i
6322 @itemx --initial
6323 @opindex -i
6324 @opindex --initial
6325 @cindex initial tabs, converting
6326 Only convert initial tabs (those that precede all non-space or non-tab
6327 characters) on each line to spaces.
6328
6329 @end table
6330
6331 @exitstatus
6332
6333
6334 @node unexpand invocation
6335 @section @command{unexpand}: Convert spaces to tabs
6336
6337 @pindex unexpand
6338
6339 @command{unexpand} writes the contents of each given @var{file}, or
6340 standard input if none are given or for a @var{file} of @samp{-}, to
6341 standard output, converting blanks at the beginning of each line into
6342 as many tab characters as needed.  In the default POSIX
6343 locale, a @dfn{blank} is a space or a tab; other locales may specify
6344 additional blank characters.  Synopsis:
6345
6346 @example
6347 unexpand [@var{option}]@dots{} [@var{file}]@dots{}
6348 @end example
6349
6350 By default, @command{unexpand} converts only initial blanks (those
6351 that precede all non-blank characters) on each line.  It
6352 preserves backspace characters in the output; they decrement the column
6353 count for tab calculations.  By default, tabs are set at every 8th
6354 column.
6355
6356 The program accepts the following options.  Also see @ref{Common options}.
6357
6358 @table @samp
6359
6360 @item -t @var{tab1}[,@var{tab2}]@dots{}
6361 @itemx --tabs=@var{tab1}[,@var{tab2}]@dots{}
6362 @opindex -t
6363 @opindex --tabs
6364 If only one tab stop is given, set the tabs @var{tab1} columns apart
6365 instead of the default 8.  Otherwise, set the tabs at columns
6366 @var{tab1}, @var{tab2}, @dots{} (numbered from 0), and leave blanks
6367 beyond the tab stops given unchanged.  Tab stops can be separated by
6368 blanks as well as by commas.  This option implies the @option{-a} option.
6369
6370 For compatibility, GNU @command{unexpand} supports the obsolete option syntax,
6371 @option{-@var{tab1}[,@var{tab2}]@dots{}}, where tab stops must be
6372 separated by commas.  (Unlike @option{-t}, this obsolete option does
6373 not imply @option{-a}.)  New scripts should use @option{--first-only -t
6374 @var{tab1}[,@var{tab2}]@dots{}} instead.
6375
6376 @item -a
6377 @itemx --all
6378 @opindex -a
6379 @opindex --all
6380 Also convert all sequences of two or more blanks just before a tab stop,
6381 even if they occur after non-blank characters in a line.
6382
6383 @end table
6384
6385 @exitstatus
6386
6387
6388 @node Directory listing
6389 @chapter Directory listing
6390
6391 This chapter describes the @command{ls} command and its variants @command{dir}
6392 and @command{vdir}, which list information about files.
6393
6394 @menu
6395 * ls invocation::               List directory contents.
6396 * dir invocation::              Briefly ls.
6397 * vdir invocation::             Verbosely ls.
6398 * dircolors invocation::        Color setup for ls, etc.
6399 @end menu
6400
6401
6402 @node ls invocation
6403 @section @command{ls}: List directory contents
6404
6405 @pindex ls
6406 @cindex directory listing
6407
6408 The @command{ls} program lists information about files (of any type,
6409 including directories).  Options and file arguments can be intermixed
6410 arbitrarily, as usual.
6411
6412 For non-option command-line arguments that are directories, by default
6413 @command{ls} lists the contents of directories, not recursively, and
6414 omitting files with names beginning with @samp{.}.  For other non-option
6415 arguments, by default @command{ls} lists just the file name.  If no
6416 non-option argument is specified, @command{ls} operates on the current
6417 directory, acting as if it had been invoked with a single argument of @samp{.}.
6418
6419 @vindex LC_ALL
6420 By default, the output is sorted alphabetically, according to the locale
6421 settings in effect.@footnote{If you use a non-POSIX
6422 locale (e.g., by setting @env{LC_ALL} to @samp{en_US}), then @command{ls} may
6423 produce output that is sorted differently than you're accustomed to.
6424 In that case, set the @env{LC_ALL} environment variable to @samp{C}.}
6425 If standard output is
6426 a terminal, the output is in columns (sorted vertically) and control
6427 characters are output as question marks; otherwise, the output is listed
6428 one per line and control characters are output as-is.
6429
6430 Because @command{ls} is such a fundamental program, it has accumulated many
6431 options over the years.  They are described in the subsections below;
6432 within each section, options are listed alphabetically (ignoring case).
6433 The division of options into the subsections is not absolute, since some
6434 options affect more than one aspect of @command{ls}'s operation.
6435
6436 @cindex exit status of @command{ls}
6437 Exit status:
6438
6439 @display
6440 0 success
6441 1 minor problems  (e.g., failure to access a file or directory not
6442   specified as a command line argument.  This happens when listing a
6443   directory in which entries are actively being removed or renamed.)
6444 2 serious trouble (e.g., memory exhausted, invalid option, failure
6445   to access a file or directory specified as a command line argument
6446   or a directory loop)
6447 @end display
6448
6449 Also see @ref{Common options}.
6450
6451 @menu
6452 * Which files are listed::
6453 * What information is listed::
6454 * Sorting the output::
6455 * Details about version sort::
6456 * General output formatting::
6457 * Formatting file timestamps::
6458 * Formatting the file names::
6459 @end menu
6460
6461
6462 @node Which files are listed
6463 @subsection Which files are listed
6464
6465 These options determine which files @command{ls} lists information for.
6466 By default, @command{ls} lists files and the contents of any
6467 directories on the command line, except that in directories it ignores
6468 files whose names start with @samp{.}.
6469
6470 @table @samp
6471
6472 @item -a
6473 @itemx --all
6474 @opindex -a
6475 @opindex --all
6476 In directories, do not ignore file names that start with @samp{.}.
6477
6478 @item -A
6479 @itemx --almost-all
6480 @opindex -A
6481 @opindex --almost-all
6482 In directories, do not ignore all file names that start with @samp{.};
6483 ignore only @file{.} and @file{..}.  The @option{--all} (@option{-a})
6484 option overrides this option.
6485
6486 @item -B
6487 @itemx --ignore-backups
6488 @opindex -B
6489 @opindex --ignore-backups
6490 @cindex backup files, ignoring
6491 In directories, ignore files that end with @samp{~}.  This option is
6492 equivalent to @samp{--ignore='*~' --ignore='.*~'}.
6493
6494 @item -d
6495 @itemx --directory
6496 @opindex -d
6497 @opindex --directory
6498 List just the names of directories, as with other types of files, rather
6499 than listing their contents.
6500 @c The following sentence is the same as the one for -F.
6501 Do not follow symbolic links listed on the
6502 command line unless the @option{--dereference-command-line} (@option{-H}),
6503 @option{--dereference} (@option{-L}), or
6504 @option{--dereference-command-line-symlink-to-dir} options are specified.
6505
6506 @item -H
6507 @itemx --dereference-command-line
6508 @opindex -H
6509 @opindex --dereference-command-line
6510 @cindex symbolic links, dereferencing
6511 If a command line argument specifies a symbolic link, show information
6512 for the file the link references rather than for the link itself.
6513
6514 @item --dereference-command-line-symlink-to-dir
6515 @opindex --dereference-command-line-symlink-to-dir
6516 @cindex symbolic links, dereferencing
6517 Do not dereference symbolic links, with one exception:
6518 if a command line argument specifies a symbolic link that refers to
6519 a directory, show information for that directory rather than for the
6520 link itself.
6521 This is the default behavior when no other dereferencing-related
6522 option has been specified (@option{--classify} (@option{-F}),
6523 @option{--directory} (@option{-d}),
6524 (@option{-l}),
6525 @option{--dereference} (@option{-L}), or
6526 @option{--dereference-command-line} (@option{-H})).
6527
6528 @item --group-directories-first
6529 @opindex --group-directories-first
6530 Group all the directories before the files and then sort the
6531 directories and the files separately using the selected sort key
6532 (see --sort option).
6533 That is, this option specifies a primary sort key,
6534 and the --sort option specifies a secondary key.
6535 However, any use of @option{--sort=none}
6536 (@option{-U}) disables this option altogether.
6537
6538 @item --hide=PATTERN
6539 @opindex --hide=@var{pattern}
6540 In directories, ignore files whose names match the shell pattern
6541 @var{pattern}, unless the @option{--all} (@option{-a}) or
6542 @option{--almost-all} (@option{-A}) is also given.  This
6543 option acts like @option{--ignore=@var{pattern}} except that it has no
6544 effect if @option{--all} (@option{-a}) or @option{--almost-all}
6545 (@option{-A}) is also given.
6546
6547 This option can be useful in shell aliases.  For example, if
6548 @command{lx} is an alias for @samp{ls --hide='*~'} and @command{ly} is
6549 an alias for @samp{ls --ignore='*~'}, then the command @samp{lx -A}
6550 lists the file @file{README~} even though @samp{ly -A} would not.
6551
6552 @item -I @var{pattern}
6553 @itemx --ignore=@var{pattern}
6554 @opindex -I
6555 @opindex --ignore=@var{pattern}
6556 In directories, ignore files whose names match the shell pattern
6557 (not regular expression) @var{pattern}.  As
6558 in the shell, an initial @samp{.} in a file name does not match a
6559 wildcard at the start of @var{pattern}.  Sometimes it is useful
6560 to give this option several times.  For example,
6561
6562 @smallexample
6563 $ ls --ignore='.??*' --ignore='.[^.]' --ignore='#*'
6564 @end smallexample
6565
6566 The first option ignores names of length 3 or more that start with @samp{.},
6567 the second ignores all two-character names that start with @samp{.}
6568 except @samp{..}, and the third ignores names that start with @samp{#}.
6569
6570 @item -L
6571 @itemx --dereference
6572 @opindex -L
6573 @opindex --dereference
6574 @cindex symbolic links, dereferencing
6575 When showing file information for a symbolic link, show information
6576 for the file the link references rather than the link itself.
6577 However, even with this option, @command{ls} still prints the name
6578 of the link itself, not the name of the file that the link points to.
6579
6580 @item -R
6581 @itemx --recursive
6582 @opindex -R
6583 @opindex --recursive
6584 @cindex recursive directory listing
6585 @cindex directory listing, recursive
6586 List the contents of all directories recursively.
6587
6588 @end table
6589
6590
6591 @node What information is listed
6592 @subsection What information is listed
6593
6594 These options affect the information that @command{ls} displays.  By
6595 default, only file names are shown.
6596
6597 @table @samp
6598
6599 @item --author
6600 @opindex --author
6601 @cindex hurd, author, printing
6602 List each file's author when producing long format directory listings.
6603 In GNU/Hurd, file authors can differ from their owners, but in other
6604 operating systems the two are the same.
6605
6606 @item -D
6607 @itemx --dired
6608 @opindex -D
6609 @opindex --dired
6610 @cindex dired Emacs mode support
6611 With the long listing (@option{-l}) format, print an additional line after
6612 the main output:
6613
6614 @example
6615 //DIRED// @var{beg1} @var{end1} @var{beg2} @var{end2} @dots{}
6616 @end example
6617
6618 @noindent
6619 The @var{begn} and @var{endn} are unsigned integers that record the
6620 byte position of the beginning and end of each file name in the output.
6621 This makes it easy for Emacs to find the names, even when they contain
6622 unusual characters such as space or newline, without fancy searching.
6623
6624 If directories are being listed recursively (@option{-R}), output a similar
6625 line with offsets for each subdirectory name:
6626
6627 @example
6628 //SUBDIRED// @var{beg1} @var{end1} @dots{}
6629 @end example
6630
6631 Finally, output a line of the form:
6632
6633 @example
6634 //DIRED-OPTIONS// --quoting-style=@var{word}
6635 @end example
6636
6637 @noindent
6638 where @var{word} is the quoting style (@pxref{Formatting the file names}).
6639
6640 Here is an actual example:
6641
6642 @example
6643 $ mkdir -p a/sub/deeper a/sub2
6644 $ touch a/f1 a/f2
6645 $ touch a/sub/deeper/file
6646 $ ls -gloRF --dired a
6647   a:
6648   total 8
6649   -rw-r--r-- 1    0 Jun 10 12:27 f1
6650   -rw-r--r-- 1    0 Jun 10 12:27 f2
6651   drwxr-xr-x 3 4096 Jun 10 12:27 sub/
6652   drwxr-xr-x 2 4096 Jun 10 12:27 sub2/
6653
6654   a/sub:
6655   total 4
6656   drwxr-xr-x 2 4096 Jun 10 12:27 deeper/
6657
6658   a/sub/deeper:
6659   total 0
6660   -rw-r--r-- 1 0 Jun 10 12:27 file
6661
6662   a/sub2:
6663   total 0
6664 //DIRED// 48 50 84 86 120 123 158 162 217 223 282 286
6665 //SUBDIRED// 2 3 167 172 228 240 290 296
6666 //DIRED-OPTIONS// --quoting-style=literal
6667 @end example
6668
6669 Note that the pairs of offsets on the @samp{//DIRED//} line above delimit
6670 these names: @file{f1}, @file{f2}, @file{sub}, @file{sub2}, @file{deeper},
6671 @file{file}.
6672 The offsets on the @samp{//SUBDIRED//} line delimit the following
6673 directory names: @file{a}, @file{a/sub}, @file{a/sub/deeper}, @file{a/sub2}.
6674
6675 Here is an example of how to extract the fifth entry name, @samp{deeper},
6676 corresponding to the pair of offsets, 222 and 228:
6677
6678 @example
6679 $ ls -gloRF --dired a > out
6680 $ dd bs=1 skip=222 count=6 < out 2>/dev/null; echo
6681 deeper
6682 @end example
6683
6684 Note that although the listing above includes a trailing slash
6685 for the @samp{deeper} entry, the offsets select the name without
6686 the trailing slash.  However, if you invoke @command{ls} with @option{--dired}
6687 along with an option like @option{--escape} (aka @option{-b}) and operate
6688 on a file whose name contains special characters, notice that the backslash
6689 @emph{is} included:
6690
6691 @example
6692 $ touch 'a b'
6693 $ ls -blog --dired 'a b'
6694   -rw-r--r-- 1 0 Jun 10 12:28 a\ b
6695 //DIRED// 30 34
6696 //DIRED-OPTIONS// --quoting-style=escape
6697 @end example
6698
6699 If you use a quoting style that adds quote marks
6700 (e.g., @option{--quoting-style=c}), then the offsets include the quote marks.
6701 So beware that the user may select the quoting style via the environment
6702 variable @env{QUOTING_STYLE}@.  Hence, applications using @option{--dired}
6703 should either specify an explicit @option{--quoting-style=literal} option
6704 (aka @option{-N} or @option{--literal}) on the command line, or else be
6705 prepared to parse the escaped names.
6706
6707 @item --full-time
6708 @opindex --full-time
6709 Produce long format directory listings, and list times in full.  It is
6710 equivalent to using @option{--format=long} with
6711 @option{--time-style=full-iso} (@pxref{Formatting file timestamps}).
6712
6713 @item -g
6714 @opindex -g
6715 Produce long format directory listings, but don't display owner information.
6716
6717 @item -G
6718 @itemx --no-group
6719 @opindex -G
6720 @opindex --no-group
6721 Inhibit display of group information in a long format directory listing.
6722 (This is the default in some non-@sc{gnu} versions of @command{ls}, so we
6723 provide this option for compatibility.)
6724
6725 @optHumanReadable
6726
6727 @item -i
6728 @itemx --inode
6729 @opindex -i
6730 @opindex --inode
6731 @cindex inode number, printing
6732 Print the inode number (also called the file serial number and index
6733 number) of each file to the left of the file name.  (This number
6734 uniquely identifies each file within a particular file system.)
6735
6736 @item -l
6737 @itemx --format=long
6738 @itemx --format=verbose
6739 @opindex -l
6740 @opindex --format
6741 @opindex long ls @r{format}
6742 @opindex verbose ls @r{format}
6743 In addition to the name of each file, print the file type, file mode bits,
6744 number of hard links, owner name, group name, size, and
6745 timestamp (@pxref{Formatting file timestamps}), normally
6746 the modification time.  Print question marks for information that
6747 cannot be determined.
6748
6749 Normally the size is printed as a byte count without punctuation, but
6750 this can be overridden (@pxref{Block size}).  For example, @option{-h}
6751 prints an abbreviated, human-readable count, and
6752 @samp{--block-size="'1"} prints a byte count with the thousands
6753 separator of the current locale.
6754
6755 For each directory that is listed, preface the files with a line
6756 @samp{total @var{blocks}}, where @var{blocks} is the total disk allocation
6757 for all files in that directory.  The block size currently defaults to 1024
6758 bytes, but this can be overridden (@pxref{Block size}).
6759 The @var{blocks} computed counts each hard link separately;
6760 this is arguably a deficiency.
6761
6762 The file type is one of the following characters:
6763
6764 @c The commented-out entries are ones we're not sure about.
6765
6766 @table @samp
6767 @item -
6768 regular file
6769 @item b
6770 block special file
6771 @item c
6772 character special file
6773 @item C
6774 high performance (``contiguous data'') file
6775 @item d
6776 directory
6777 @item D
6778 door (Solaris 2.5 and up)
6779 @c @item F
6780 @c semaphore, if this is a distinct file type
6781 @item l
6782 symbolic link
6783 @c @item m
6784 @c multiplexed file (7th edition Unix; obsolete)
6785 @item M
6786 off-line (``migrated'') file (Cray DMF)
6787 @item n
6788 network special file (HP-UX)
6789 @item p
6790 FIFO (named pipe)
6791 @item P
6792 port (Solaris 10 and up)
6793 @c @item Q
6794 @c message queue, if this is a distinct file type
6795 @item s
6796 socket
6797 @c @item S
6798 @c shared memory object, if this is a distinct file type
6799 @c @item T
6800 @c typed memory object, if this is a distinct file type
6801 @c @item w
6802 @c whiteout (4.4BSD; not implemented)
6803 @item ?
6804 some other file type
6805 @end table
6806
6807 @cindex permissions, output by @command{ls}
6808 The file mode bits listed are similar to symbolic mode specifications
6809 (@pxref{Symbolic Modes}).  But @command{ls} combines multiple bits into the
6810 third character of each set of permissions as follows:
6811
6812 @table @samp
6813 @item s
6814 If the set-user-ID or set-group-ID bit and the corresponding executable bit
6815 are both set.
6816
6817 @item S
6818 If the set-user-ID or set-group-ID bit is set but the corresponding
6819 executable bit is not set.
6820
6821 @item t
6822 If the restricted deletion flag or sticky bit, and the
6823 other-executable bit, are both set.  The restricted deletion flag is
6824 another name for the sticky bit.  @xref{Mode Structure}.
6825
6826 @item T
6827 If the restricted deletion flag or sticky bit is set but the
6828 other-executable bit is not set.
6829
6830 @item x
6831 If the executable bit is set and none of the above apply.
6832
6833 @item -
6834 Otherwise.
6835 @end table
6836
6837 Following the file mode bits is a single character that specifies
6838 whether an alternate access method such as an access control list
6839 applies to the file.  When the character following the file mode bits is a
6840 space, there is no alternate access method.  When it is a printing
6841 character, then there is such a method.
6842
6843 GNU @command{ls} uses a @samp{.} character to indicate a file
6844 with an SELinux security context, but no other alternate access method.
6845
6846 A file with any other combination of alternate access methods
6847 is marked with a @samp{+} character.
6848
6849 @item -n
6850 @itemx --numeric-uid-gid
6851 @opindex -n
6852 @opindex --numeric-uid-gid
6853 @cindex numeric uid and gid
6854 @cindex numeric user and group IDs
6855 Produce long format directory listings, but
6856 display numeric user and group IDs instead of the owner and group names.
6857
6858 @item -o
6859 @opindex -o
6860 Produce long format directory listings, but don't display group information.
6861 It is equivalent to using @option{--format=long} with @option{--no-group} .
6862
6863 @item -s
6864 @itemx --size
6865 @opindex -s
6866 @opindex --size
6867 @cindex disk allocation
6868 @cindex size of files, reporting
6869 Print the disk allocation of each file to the left of the file name.
6870 This is the amount of disk space used by the file, which is usually a
6871 bit more than the file's size, but it can be less if the file has holes.
6872
6873 Normally the disk allocation is printed in units of
6874 1024 bytes, but this can be overridden (@pxref{Block size}).
6875
6876 @cindex NFS mounts from BSD to HP-UX
6877 For files that are NFS-mounted from an HP-UX system to a BSD system,
6878 this option reports sizes that are half the correct values.  On HP-UX
6879 systems, it reports sizes that are twice the correct values for files
6880 that are NFS-mounted from BSD systems.  This is due to a flaw in HP-UX;
6881 it also affects the HP-UX @command{ls} program.
6882
6883 @optSi
6884
6885 @item -Z
6886 @itemx --context
6887 @opindex -Z
6888 @opindex --context
6889 @cindex SELinux
6890 @cindex security context
6891 Display the SELinux security context or @samp{?} if none is found.
6892 When used with the @option{-l} option, print the security context
6893 to the left of the size column.
6894
6895 @end table
6896
6897
6898 @node Sorting the output
6899 @subsection Sorting the output
6900
6901 @cindex sorting @command{ls} output
6902 These options change the order in which @command{ls} sorts the information
6903 it outputs.  By default, sorting is done by character code
6904 (e.g., ASCII order).
6905
6906 @table @samp
6907
6908 @item -c
6909 @itemx --time=ctime
6910 @itemx --time=status
6911 @opindex -c
6912 @opindex --time
6913 @opindex ctime@r{, printing or sorting by}
6914 @opindex status time@r{, printing or sorting by}
6915 @opindex use time@r{, printing or sorting files by}
6916 If the long listing format (e.g., @option{-l}, @option{-o}) is being used,
6917 print the status change time (the @samp{ctime} in the inode) instead of
6918 the modification time.
6919 When explicitly sorting by time (@option{--sort=time} or @option{-t})
6920 or when not using a long listing format,
6921 sort according to the status change time.
6922
6923 @item -f
6924 @opindex -f
6925 @cindex unsorted directory listing
6926 @cindex directory order, listing by
6927 Primarily, like @option{-U}---do not sort; list the files in whatever
6928 order they are stored in the directory.  But also enable @option{-a} (list
6929 all files) and disable @option{-l}, @option{--color}, and @option{-s} (if they
6930 were specified before the @option{-f}).
6931
6932 @item -r
6933 @itemx --reverse
6934 @opindex -r
6935 @opindex --reverse
6936 @cindex reverse sorting
6937 Reverse whatever the sorting method is---e.g., list files in reverse
6938 alphabetical order, youngest first, smallest first, or whatever.
6939
6940 @item -S
6941 @itemx --sort=size
6942 @opindex -S
6943 @opindex --sort
6944 @opindex size of files@r{, sorting files by}
6945 Sort by file size, largest first.
6946
6947 @item -t
6948 @itemx --sort=time
6949 @opindex -t
6950 @opindex --sort
6951 @opindex modification time@r{, sorting files by}
6952 Sort by modification time (the @samp{mtime} in the inode), newest first.
6953
6954 @item -u
6955 @itemx --time=atime
6956 @itemx --time=access
6957 @itemx --time=use
6958 @opindex -u
6959 @opindex --time
6960 @opindex use time@r{, printing or sorting files by}
6961 @opindex atime@r{, printing or sorting files by}
6962 @opindex access time@r{, printing or sorting files by}
6963 If the long listing format (e.g., @option{--format=long}) is being used,
6964 print the last access time (the @samp{atime} in the inode).
6965 When explicitly sorting by time (@option{--sort=time} or @option{-t})
6966 or when not using a long listing format, sort according to the access time.
6967
6968 @item -U
6969 @itemx --sort=none
6970 @opindex -U
6971 @opindex --sort
6972 @opindex none@r{, sorting option for @command{ls}}
6973 Do not sort; list the files in whatever order they are
6974 stored in the directory.  (Do not do any of the other unrelated things
6975 that @option{-f} does.)  This is especially useful when listing very large
6976 directories, since not doing any sorting can be noticeably faster.
6977
6978 @item -v
6979 @itemx --sort=version
6980 @opindex -v
6981 @opindex --sort
6982 @opindex version@r{, sorting option for @command{ls}}
6983 Sort by version name and number, lowest first.  It behaves like a default
6984 sort, except that each sequence of decimal digits is treated numerically
6985 as an index/version number.  (@xref{Details about version sort}.)
6986
6987 @item -X
6988 @itemx --sort=extension
6989 @opindex -X
6990 @opindex --sort
6991 @opindex extension@r{, sorting files by}
6992 Sort directory contents alphabetically by file extension (characters
6993 after the last @samp{.}); files with no extension are sorted first.
6994
6995 @end table
6996
6997
6998 @node Details about version sort
6999 @subsection Details about version sort
7000
7001 Version sorting handles the fact that file names frequently include indices or
7002 version numbers.  Standard sorting usually does not produce the order that one
7003 expects because comparisons are made on a character-by-character basis.
7004 Version sorting is especially useful when browsing directories that contain
7005 many files with indices/version numbers in their names:
7006
7007 @example
7008 $ ls -1            $ ls -1v
7009 abc.zml-1.gz       abc.zml-1.gz
7010 abc.zml-12.gz      abc.zml-2.gz
7011 abc.zml-2.gz       abc.zml-12.gz
7012 @end example
7013
7014 Version-sorted strings are compared such that if @var{ver1} and @var{ver2}
7015 are version numbers and @var{prefix} and @var{suffix} (@var{suffix} matching
7016 the regular expression @samp{(\.[A-Za-z~][A-Za-z0-9~]*)*}) are strings then
7017 @var{ver1} < @var{ver2} implies that the name composed of
7018 ``@var{prefix} @var{ver1} @var{suffix}'' sorts before
7019 ``@var{prefix} @var{ver2} @var{suffix}''.
7020
7021 Note also that leading zeros of numeric parts are ignored:
7022
7023 @example
7024 $ ls -1            $ ls -1v
7025 abc-1.007.tgz      abc-1.01a.tgz
7026 abc-1.012b.tgz     abc-1.007.tgz
7027 abc-1.01a.tgz      abc-1.012b.tgz
7028 @end example
7029
7030 This functionality is implemented using gnulib's @code{filevercmp} function,
7031 which has some caveats worth noting.
7032
7033 @itemize @bullet
7034 @item @env{LC_COLLATE} is ignored, which means @samp{ls -v} and @samp{sort -V}
7035 will sort non-numeric prefixes as if the @env{LC_COLLATE} locale category
7036 was set to @samp{C}@.
7037 @item Some suffixes will not be matched by the regular
7038 expression mentioned above.  Consequently these examples may
7039 not sort as you expect:
7040
7041 @example
7042 abc-1.2.3.4.7z
7043 abc-1.2.3.7z
7044 @end example
7045
7046 @example
7047 abc-1.2.3.4.x86_64.rpm
7048 abc-1.2.3.x86_64.rpm
7049 @end example
7050 @end itemize
7051
7052 @node General output formatting
7053 @subsection General output formatting
7054
7055 These options affect the appearance of the overall output.
7056
7057 @table @samp
7058
7059 @item -1
7060 @itemx --format=single-column
7061 @opindex -1
7062 @opindex --format
7063 @opindex single-column @r{output of files}
7064 List one file per line.  This is the default for @command{ls} when standard
7065 output is not a terminal.
7066
7067 @item -C
7068 @itemx --format=vertical
7069 @opindex -C
7070 @opindex --format
7071 @opindex vertical @r{sorted files in columns}
7072 List files in columns, sorted vertically.  This is the default for
7073 @command{ls} if standard output is a terminal.  It is always the default
7074 for the @command{dir} program.
7075 @sc{gnu} @command{ls} uses variable width columns to display as many files as
7076 possible in the fewest lines.
7077
7078 @item --color [=@var{when}]
7079 @opindex --color
7080 @cindex color, distinguishing file types with
7081 Specify whether to use color for distinguishing file types.  @var{when}
7082 may be omitted, or one of:
7083 @itemize @bullet
7084 @item none
7085 @vindex none @r{color option}
7086 - Do not use color at all.  This is the default.
7087 @item auto
7088 @vindex auto @r{color option}
7089 @cindex terminal, using color iff
7090 - Only use color if standard output is a terminal.
7091 @item always
7092 @vindex always @r{color option}
7093 - Always use color.
7094 @end itemize
7095 Specifying @option{--color} and no @var{when} is equivalent to
7096 @option{--color=always}.
7097 Piping a colorized listing through a pager like @command{more} or
7098 @command{less} usually produces unreadable results.  However, using
7099 @code{more -f} does seem to work.
7100
7101 @vindex LS_COLORS
7102 @vindex SHELL @r{environment variable, and color}
7103 Note that using the @option{--color} option may incur a noticeable
7104 performance penalty when run in a directory with very many entries,
7105 because the default settings require that @command{ls} @code{stat} every
7106 single file it lists.
7107 However, if you would like most of the file-type coloring
7108 but can live without the other coloring options (e.g.,
7109 executable, orphan, sticky, other-writable, capability), use
7110 @command{dircolors} to set the @env{LS_COLORS} environment variable like this,
7111 @example
7112 eval $(dircolors -p | perl -pe \
7113   's/^((CAP|S[ET]|O[TR]|M|E)\w+).*/$1 00/' | dircolors -)
7114 @end example
7115 and on a @code{dirent.d_type}-capable file system, @command{ls}
7116 will perform only one @code{stat} call per command line argument.
7117
7118 @item -F
7119 @itemx --classify
7120 @itemx --indicator-style=classify
7121 @opindex -F
7122 @opindex --classify
7123 @opindex --indicator-style
7124 @cindex file type and executables, marking
7125 @cindex executables and file type, marking
7126 Append a character to each file name indicating the file type.  Also,
7127 for regular files that are executable, append @samp{*}.  The file type
7128 indicators are @samp{/} for directories, @samp{@@} for symbolic links,
7129 @samp{|} for FIFOs, @samp{=} for sockets, @samp{>} for doors,
7130 and nothing for regular files.
7131 @c The following sentence is the same as the one for -d.
7132 Do not follow symbolic links listed on the
7133 command line unless the @option{--dereference-command-line} (@option{-H}),
7134 @option{--dereference} (@option{-L}), or
7135 @option{--dereference-command-line-symlink-to-dir} options are specified.
7136
7137 @item --file-type
7138 @itemx --indicator-style=file-type
7139 @opindex --file-type
7140 @opindex --indicator-style
7141 @cindex file type, marking
7142 Append a character to each file name indicating the file type.  This is
7143 like @option{-F}, except that executables are not marked.
7144
7145 @item --indicator-style=@var{word}
7146 @opindex --indicator-style
7147 Append a character indicator with style @var{word} to entry names,
7148 as follows:
7149
7150 @table @samp
7151 @item none
7152 Do not append any character indicator; this is the default.
7153 @item slash
7154 Append @samp{/} for directories.  This is the same as the @option{-p}
7155 option.
7156 @item file-type
7157 Append @samp{/} for directories, @samp{@@} for symbolic links, @samp{|}
7158 for FIFOs, @samp{=} for sockets, and nothing for regular files.  This is
7159 the same as the @option{--file-type} option.
7160 @item classify
7161 Append @samp{*} for executable regular files, otherwise behave as for
7162 @samp{file-type}.  This is the same as the @option{-F} or
7163 @option{--classify} option.
7164 @end table
7165
7166 @item -k
7167 @itemx --kibibytes
7168 @opindex -k
7169 @opindex --kibibytes
7170 Set the default block size to its normal value of 1024 bytes,
7171 overriding any contrary specification in environment variables
7172 (@pxref{Block size}).  This option is in turn overridden by the
7173 @option{--block-size}, @option{-h} or @option{--human-readable}, and
7174 @option{--si} options.
7175
7176 The @option{-k} or @option{--kibibytes} option affects the
7177 per-directory block count written by the @option{-l} and similar
7178 options, and the size written by the @option{-s} or @option{--size}
7179 option.  It does not affect the file size written by @option{-l}.
7180
7181 @item -m
7182 @itemx --format=commas
7183 @opindex -m
7184 @opindex --format
7185 @opindex commas@r{, outputting between files}
7186 List files horizontally, with as many as will fit on each line,
7187 separated by @samp{, } (a comma and a space).
7188
7189 @item -p
7190 @itemx --indicator-style=slash
7191 @opindex -p
7192 @opindex --indicator-style
7193 @cindex file type, marking
7194 Append a @samp{/} to directory names.
7195
7196 @item -x
7197 @itemx --format=across
7198 @itemx --format=horizontal
7199 @opindex -x
7200 @opindex --format
7201 @opindex across@r{, listing files}
7202 @opindex horizontal@r{, listing files}
7203 List the files in columns, sorted horizontally.
7204
7205 @item -T @var{cols}
7206 @itemx --tabsize=@var{cols}
7207 @opindex -T
7208 @opindex --tabsize
7209 Assume that each tab stop is @var{cols} columns wide.  The default is 8.
7210 @command{ls} uses tabs where possible in the output, for efficiency.  If
7211 @var{cols} is zero, do not use tabs at all.
7212
7213 @c FIXME: remove in 2009, if Apple Terminal has been fixed for long enough.
7214 Some terminal emulators (at least Apple Terminal 1.5 (133) from Mac OS X 10.4.8)
7215 do not properly align columns to the right of a TAB following a
7216 non-ASCII byte.  If you use such a terminal emulator, use the
7217 @option{-T0} option or put @code{TABSIZE=0} in your environment to tell
7218 @command{ls} to align using spaces, not tabs.
7219
7220 @item -w
7221 @itemx --width=@var{cols}
7222 @opindex -w
7223 @opindex --width
7224 @vindex COLUMNS
7225 Assume the screen is @var{cols} columns wide.  The default is taken
7226 from the terminal settings if possible; otherwise the environment
7227 variable @env{COLUMNS} is used if it is set; otherwise the default
7228 is 80.
7229
7230 @end table
7231
7232
7233 @node Formatting file timestamps
7234 @subsection Formatting file timestamps
7235
7236 By default, file timestamps are listed in abbreviated form, using
7237 a date like @samp{Mar 30@ @ 2002} for non-recent timestamps, and a
7238 date-without-year and time like @samp{Mar 30 23:45} for recent timestamps.
7239 This format can change depending on the current locale as detailed below.
7240
7241 @cindex clock skew
7242 A timestamp is considered to be @dfn{recent} if it is less than six
7243 months old, and is not dated in the future.  If a timestamp dated
7244 today is not listed in recent form, the timestamp is in the future,
7245 which means you probably have clock skew problems which may break
7246 programs like @command{make} that rely on file timestamps.
7247
7248 @vindex TZ
7249 Time stamps are listed according to the time zone rules specified by
7250 the @env{TZ} environment variable, or by the system default rules if
7251 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
7252 with @env{TZ}, libc, The GNU C Library Reference Manual}.
7253
7254 The following option changes how file timestamps are printed.
7255
7256 @table @samp
7257 @item --time-style=@var{style}
7258 @opindex --time-style
7259 @cindex time style
7260 List timestamps in style @var{style}.  The @var{style} should
7261 be one of the following:
7262
7263 @table @samp
7264 @item +@var{format}
7265 @vindex LC_TIME
7266 List timestamps using @var{format}, where @var{format} is interpreted
7267 like the format argument of @command{date} (@pxref{date invocation}).
7268 For example, @option{--time-style="+%Y-%m-%d %H:%M:%S"} causes
7269 @command{ls} to list timestamps like @samp{2002-03-30 23:45:56}.  As
7270 with @command{date}, @var{format}'s interpretation is affected by the
7271 @env{LC_TIME} locale category.
7272
7273 If @var{format} contains two format strings separated by a newline,
7274 the former is used for non-recent files and the latter for recent
7275 files; if you want output columns to line up, you may need to insert
7276 spaces in one of the two formats.
7277
7278 @item full-iso
7279 List timestamps in full using ISO 8601 date, time, and time zone
7280 format with nanosecond precision, e.g., @samp{2002-03-30
7281 23:45:56.477817180 -0700}.  This style is equivalent to
7282 @samp{+%Y-%m-%d %H:%M:%S.%N %z}.
7283
7284 This is useful because the time output includes all the information that
7285 is available from the operating system.  For example, this can help
7286 explain @command{make}'s behavior, since GNU @command{make}
7287 uses the full timestamp to determine whether a file is out of date.
7288
7289 @item long-iso
7290 List ISO 8601 date and time in minutes, e.g.,
7291 @samp{2002-03-30 23:45}.  These timestamps are shorter than
7292 @samp{full-iso} timestamps, and are usually good enough for everyday
7293 work.  This style is equivalent to @samp{+%Y-%m-%d %H:%M}.
7294
7295 @item iso
7296 List ISO 8601 dates for non-recent timestamps (e.g.,
7297 @samp{2002-03-30@ }), and ISO 8601 month, day, hour, and
7298 minute for recent timestamps (e.g., @samp{03-30 23:45}).  These
7299 timestamps are uglier than @samp{long-iso} timestamps, but they carry
7300 nearly the same information in a smaller space and their brevity helps
7301 @command{ls} output fit within traditional 80-column output lines.
7302 The following two @command{ls} invocations are equivalent:
7303
7304 @example
7305 newline='
7306 '
7307 ls -l --time-style="+%Y-%m-%d $newline%m-%d %H:%M"
7308 ls -l --time-style="iso"
7309 @end example
7310
7311 @item locale
7312 @vindex LC_TIME
7313 List timestamps in a locale-dependent form.  For example, a Finnish
7314 locale might list non-recent timestamps like @samp{maalis 30@ @ 2002}
7315 and recent timestamps like @samp{maalis 30 23:45}.  Locale-dependent
7316 timestamps typically consume more space than @samp{iso} timestamps and
7317 are harder for programs to parse because locale conventions vary so
7318 widely, but they are easier for many people to read.
7319
7320 The @env{LC_TIME} locale category specifies the timestamp format.  The
7321 default POSIX locale uses timestamps like @samp{Mar 30@
7322 @ 2002} and @samp{Mar 30 23:45}; in this locale, the following two
7323 @command{ls} invocations are equivalent:
7324
7325 @example
7326 newline='
7327 '
7328 ls -l --time-style="+%b %e  %Y$newline%b %e %H:%M"
7329 ls -l --time-style="locale"
7330 @end example
7331
7332 Other locales behave differently.  For example, in a German locale,
7333 @option{--time-style="locale"} might be equivalent to
7334 @option{--time-style="+%e. %b %Y $newline%e. %b %H:%M"}
7335 and might generate timestamps like @samp{30. M@"ar 2002@ } and
7336 @samp{30. M@"ar 23:45}.
7337
7338 @item posix-@var{style}
7339 @vindex LC_TIME
7340 List POSIX-locale timestamps if the @env{LC_TIME} locale
7341 category is POSIX, @var{style} timestamps otherwise.  For
7342 example, the @samp{posix-long-iso} style lists
7343 timestamps like @samp{Mar 30@ @ 2002} and @samp{Mar 30 23:45} when in
7344 the POSIX locale, and like @samp{2002-03-30 23:45} otherwise.
7345 @end table
7346 @end table
7347
7348 @vindex TIME_STYLE
7349 You can specify the default value of the @option{--time-style} option
7350 with the environment variable @env{TIME_STYLE}; if @env{TIME_STYLE} is not set
7351 the default style is @samp{locale}.  GNU Emacs 21.3 and
7352 later use the @option{--dired} option and therefore can parse any date
7353 format, but if you are using Emacs 21.1 or 21.2 and specify a
7354 non-POSIX locale you may need to set
7355 @samp{TIME_STYLE="posix-long-iso"}.
7356
7357 To avoid certain denial-of-service attacks, timestamps that would be
7358 longer than 1000 bytes may be treated as errors.
7359
7360
7361 @node Formatting the file names
7362 @subsection Formatting the file names
7363
7364 These options change how file names themselves are printed.
7365
7366 @table @samp
7367
7368 @item -b
7369 @itemx --escape
7370 @itemx --quoting-style=escape
7371 @opindex -b
7372 @opindex --escape
7373 @opindex --quoting-style
7374 @cindex backslash sequences for file names
7375 Quote nongraphic characters in file names using alphabetic and octal
7376 backslash sequences like those used in C.
7377
7378 @item -N
7379 @itemx --literal
7380 @itemx --quoting-style=literal
7381 @opindex -N
7382 @opindex --literal
7383 @opindex --quoting-style
7384 Do not quote file names.  However, with @command{ls} nongraphic
7385 characters are still printed as question marks if the output is a
7386 terminal and you do not specify the @option{--show-control-chars}
7387 option.
7388
7389 @item -q
7390 @itemx --hide-control-chars
7391 @opindex -q
7392 @opindex --hide-control-chars
7393 Print question marks instead of nongraphic characters in file names.
7394 This is the default if the output is a terminal and the program is
7395 @command{ls}.
7396
7397 @item -Q
7398 @itemx --quote-name
7399 @itemx --quoting-style=c
7400 @opindex -Q
7401 @opindex --quote-name
7402 @opindex --quoting-style
7403 Enclose file names in double quotes and quote nongraphic characters as
7404 in C.
7405
7406 @item --quoting-style=@var{word}
7407 @opindex --quoting-style
7408 @cindex quoting style
7409 Use style @var{word} to quote file names and other strings that may
7410 contain arbitrary characters.  The @var{word} should
7411 be one of the following:
7412
7413 @table @samp
7414 @item literal
7415 Output strings as-is; this is the same as the @option{-N} or
7416 @option{--literal} option.
7417 @item shell
7418 Quote strings for the shell if they contain shell metacharacters or would
7419 cause ambiguous output.
7420 The quoting is suitable for POSIX-compatible shells like
7421 @command{bash}, but it does not always work for incompatible shells
7422 like @command{csh}.
7423 @item shell-always
7424 Quote strings for the shell, even if they would normally not require quoting.
7425 @item c
7426 Quote strings as for C character string literals, including the
7427 surrounding double-quote characters; this is the same as the
7428 @option{-Q} or @option{--quote-name} option.
7429 @item escape
7430 Quote strings as for C character string literals, except omit the
7431 surrounding double-quote
7432 characters; this is the same as the @option{-b} or @option{--escape} option.
7433 @item clocale
7434 Quote strings as for C character string literals, except use
7435 surrounding quotation marks appropriate for the
7436 locale.
7437 @item locale
7438 @c Use @t instead of @samp to avoid duplicate quoting in some output styles.
7439 Quote strings as for C character string literals, except use
7440 surrounding quotation marks appropriate for the locale, and quote
7441 @t{'like this'} instead of @t{"like
7442 this"} in the default C locale.  This looks nicer on many displays.
7443 @end table
7444
7445 You can specify the default value of the @option{--quoting-style} option
7446 with the environment variable @env{QUOTING_STYLE}@.  If that environment
7447 variable is not set, the default value is @samp{literal}, but this
7448 default may change to @samp{shell} in a future version of this package.
7449
7450 @item --show-control-chars
7451 @opindex --show-control-chars
7452 Print nongraphic characters as-is in file names.
7453 This is the default unless the output is a terminal and the program is
7454 @command{ls}.
7455
7456 @end table
7457
7458
7459 @node dir invocation
7460 @section @command{dir}: Briefly list directory contents
7461
7462 @pindex dir
7463 @cindex directory listing, brief
7464
7465 @command{dir} is equivalent to @code{ls -C
7466 -b}; that is, by default files are listed in columns, sorted vertically,
7467 and special characters are represented by backslash escape sequences.
7468
7469 @xref{ls invocation, @command{ls}}.
7470
7471
7472 @node vdir invocation
7473 @section @command{vdir}: Verbosely list directory contents
7474
7475 @pindex vdir
7476 @cindex directory listing, verbose
7477
7478 @command{vdir} is equivalent to @code{ls -l
7479 -b}; that is, by default files are listed in long format and special
7480 characters are represented by backslash escape sequences.
7481
7482 @node dircolors invocation
7483 @section @command{dircolors}: Color setup for @command{ls}
7484
7485 @pindex dircolors
7486 @cindex color setup
7487 @cindex setup for color
7488
7489 @command{dircolors} outputs a sequence of shell commands to set up the
7490 terminal for color output from @command{ls} (and @command{dir}, etc.).
7491 Typical usage:
7492
7493 @example
7494 eval "$(dircolors [@var{option}]@dots{} [@var{file}])"
7495 @end example
7496
7497 If @var{file} is specified, @command{dircolors} reads it to determine which
7498 colors to use for which file types and extensions.  Otherwise, a
7499 precompiled database is used.  For details on the format of these files,
7500 run @samp{dircolors --print-database}.
7501
7502 To make @command{dircolors} read a @file{~/.dircolors} file if it
7503 exists, you can put the following lines in your @file{~/.bashrc} (or
7504 adapt them to your favorite shell):
7505
7506 @example
7507 d=.dircolors
7508 test -r $d && eval "$(dircolors $d)"
7509 @end example
7510
7511 @vindex LS_COLORS
7512 @vindex SHELL @r{environment variable, and color}
7513 The output is a shell command to set the @env{LS_COLORS} environment
7514 variable.  You can specify the shell syntax to use on the command line,
7515 or @command{dircolors} will guess it from the value of the @env{SHELL}
7516 environment variable.
7517
7518 The program accepts the following options.  Also see @ref{Common options}.
7519
7520 @table @samp
7521 @item -b
7522 @itemx --sh
7523 @itemx --bourne-shell
7524 @opindex -b
7525 @opindex --sh
7526 @opindex --bourne-shell
7527 @cindex Bourne shell syntax for color setup
7528 @cindex @command{sh} syntax for color setup
7529 Output Bourne shell commands.  This is the default if the @env{SHELL}
7530 environment variable is set and does not end with @samp{csh} or
7531 @samp{tcsh}.
7532
7533 @item -c
7534 @itemx --csh
7535 @itemx --c-shell
7536 @opindex -c
7537 @opindex --csh
7538 @opindex --c-shell
7539 @cindex C shell syntax for color setup
7540 @cindex @command{csh} syntax for color setup
7541 Output C shell commands.  This is the default if @code{SHELL} ends with
7542 @command{csh} or @command{tcsh}.
7543
7544 @item -p
7545 @itemx --print-database
7546 @opindex -p
7547 @opindex --print-database
7548 @cindex color database, printing
7549 @cindex database for color setup, printing
7550 @cindex printing color database
7551 Print the (compiled-in) default color configuration database.  This
7552 output is itself a valid configuration file, and is fairly descriptive
7553 of the possibilities.
7554
7555 @end table
7556
7557 @exitstatus
7558
7559
7560 @node Basic operations
7561 @chapter Basic operations
7562
7563 @cindex manipulating files
7564
7565 This chapter describes the commands for basic file manipulation:
7566 copying, moving (renaming), and deleting (removing).
7567
7568 @menu
7569 * cp invocation::               Copy files.
7570 * dd invocation::               Convert and copy a file.
7571 * install invocation::          Copy files and set attributes.
7572 * mv invocation::               Move (rename) files.
7573 * rm invocation::               Remove files or directories.
7574 * shred invocation::            Remove files more securely.
7575 @end menu
7576
7577
7578 @node cp invocation
7579 @section @command{cp}: Copy files and directories
7580
7581 @pindex cp
7582 @cindex copying files and directories
7583 @cindex files, copying
7584 @cindex directories, copying
7585
7586 @command{cp} copies files (or, optionally, directories).  The copy is
7587 completely independent of the original.  You can either copy one file to
7588 another, or copy arbitrarily many files to a destination directory.
7589 Synopses:
7590
7591 @example
7592 cp [@var{option}]@dots{} [-T] @var{source} @var{dest}
7593 cp [@var{option}]@dots{} @var{source}@dots{} @var{directory}
7594 cp [@var{option}]@dots{} -t @var{directory} @var{source}@dots{}
7595 @end example
7596
7597 @itemize @bullet
7598 @item
7599 If two file names are given, @command{cp} copies the first file to the
7600 second.
7601
7602 @item
7603 If the @option{--target-directory} (@option{-t}) option is given, or
7604 failing that if the last file is a directory and the
7605 @option{--no-target-directory} (@option{-T}) option is not given,
7606 @command{cp} copies each @var{source} file to the specified directory,
7607 using the @var{source}s' names.
7608 @end itemize
7609
7610 Generally, files are written just as they are read.  For exceptions,
7611 see the @option{--sparse} option below.
7612
7613 By default, @command{cp} does not copy directories.  However, the
7614 @option{-R}, @option{-a}, and @option{-r} options cause @command{cp} to
7615 copy recursively by descending into source directories and copying files
7616 to corresponding destination directories.
7617
7618 When copying from a symbolic link, @command{cp} normally follows the
7619 link only when not copying
7620 recursively.  This default can be overridden with the
7621 @option{--archive} (@option{-a}), @option{-d}, @option{--dereference}
7622 (@option{-L}), @option{--no-dereference} (@option{-P}), and
7623 @option{-H} options.  If more than one of these options is specified,
7624 the last one silently overrides the others.
7625
7626 When copying to a symbolic link, @command{cp} follows the
7627 link only when it refers to an existing regular file.
7628 However, when copying to a dangling symbolic link, @command{cp}
7629 refuses by default, and fails with a diagnostic, since the operation
7630 is inherently dangerous.  This behavior is contrary to historical
7631 practice and to POSIX@.
7632 Set @env{POSIXLY_CORRECT} to make @command{cp} attempt to create
7633 the target of a dangling destination symlink, in spite of the possible risk.
7634 Also, when an option like
7635 @option{--backup} or @option{--link} acts to rename or remove the
7636 destination before copying, @command{cp} renames or removes the
7637 symbolic link rather than the file it points to.
7638
7639 By default, @command{cp} copies the contents of special files only
7640 when not copying recursively.  This default can be overridden with the
7641 @option{--copy-contents} option.
7642
7643 @cindex self-backups
7644 @cindex backups, making only
7645 @command{cp} generally refuses to copy a file onto itself, with the
7646 following exception: if @option{--force --backup} is specified with
7647 @var{source} and @var{dest} identical, and referring to a regular file,
7648 @command{cp} will make a backup file, either regular or numbered, as
7649 specified in the usual ways (@pxref{Backup options}).  This is useful when
7650 you simply want to make a backup of an existing file before changing it.
7651
7652 The program accepts the following options.  Also see @ref{Common options}.
7653
7654 @table @samp
7655 @item -a
7656 @itemx --archive
7657 @opindex -a
7658 @opindex --archive
7659 Preserve as much as possible of the structure and attributes of the
7660 original files in the copy (but do not attempt to preserve internal
7661 directory structure; i.e., @samp{ls -U} may list the entries in a copied
7662 directory in a different order).
7663 Try to preserve SELinux security context and extended attributes (xattr),
7664 but ignore any failure to do that and print no corresponding diagnostic.
7665 Equivalent to @option{-dR --preserve=all} with the reduced diagnostics.
7666
7667 @item --attributes-only
7668 @opindex --attributes-only
7669 Copy only the specified attributes of the source file to the destination.
7670 If the destination already exists, do not alter its contents.
7671 See the @option{--preserve} option for controlling which attributes to copy.
7672
7673 @item -b
7674 @itemx @w{@kbd{--backup}[=@var{method}]}
7675 @opindex -b
7676 @opindex --backup
7677 @vindex VERSION_CONTROL
7678 @cindex backups, making
7679 @xref{Backup options}.
7680 Make a backup of each file that would otherwise be overwritten or removed.
7681 As a special case, @command{cp} makes a backup of @var{source} when the force
7682 and backup options are given and @var{source} and @var{dest} are the same
7683 name for an existing, regular file.  One useful application of this
7684 combination of options is this tiny Bourne shell script:
7685
7686 @example
7687 #!/bin/sh
7688 # Usage: backup FILE...
7689 # Create a @sc{gnu}-style backup of each listed FILE.
7690 fail=0
7691 for i; do
7692   cp --backup --force --preserve=all -- "$i" "$i" || fail=1
7693 done
7694 exit $fail
7695 @end example
7696
7697 @item --copy-contents
7698 @cindex directories, copying recursively
7699 @cindex copying directories recursively
7700 @cindex recursively copying directories
7701 @cindex non-directories, copying as special files
7702 If copying recursively, copy the contents of any special files (e.g.,
7703 FIFOs and device files) as if they were regular files.  This means
7704 trying to read the data in each source file and writing it to the
7705 destination.  It is usually a mistake to use this option, as it
7706 normally has undesirable effects on special files like FIFOs and the
7707 ones typically found in the @file{/dev} directory.  In most cases,
7708 @code{cp -R --copy-contents} will hang indefinitely trying to read
7709 from FIFOs and special files like @file{/dev/console}, and it will
7710 fill up your destination disk if you use it to copy @file{/dev/zero}.
7711 This option has no effect unless copying recursively, and it does not
7712 affect the copying of symbolic links.
7713
7714 @item -d
7715 @opindex -d
7716 @cindex symbolic links, copying
7717 @cindex hard links, preserving
7718 Copy symbolic links as symbolic links rather than copying the files that
7719 they point to, and preserve hard links between source files in the copies.
7720 Equivalent to @option{--no-dereference --preserve=links}.
7721
7722 @item -f
7723 @itemx --force
7724 @opindex -f
7725 @opindex --force
7726 When copying without this option and an existing destination file cannot
7727 be opened for writing, the copy fails.  However, with @option{--force}),
7728 when a destination file cannot be opened, @command{cp} then removes it and
7729 tries to open it again.  Contrast this behavior with that enabled by
7730 @option{--link} and @option{--symbolic-link}, whereby the destination file
7731 is never opened but rather is removed unconditionally.  Also see the
7732 description of @option{--remove-destination}.
7733
7734 This option is independent of the @option{--interactive} or
7735 @option{-i} option: neither cancels the effect of the other.
7736
7737 This option is redundant if the @option{--no-clobber} or @option{-n} option is
7738 used.
7739
7740 @item -H
7741 @opindex -H
7742 If a command line argument specifies a symbolic link, then copy the
7743 file it points to rather than the symbolic link itself.  However,
7744 copy (preserving its nature) any symbolic link that is encountered
7745 via recursive traversal.
7746
7747 @item -i
7748 @itemx --interactive
7749 @opindex -i
7750 @opindex --interactive
7751 When copying a file other than a directory, prompt whether to
7752 overwrite an existing destination file.  The @option{-i} option overrides
7753 a previous @option{-n} option.
7754
7755 @item -l
7756 @itemx --link
7757 @opindex -l
7758 @opindex --link
7759 Make hard links instead of copies of non-directories.
7760
7761 @item -L
7762 @itemx --dereference
7763 @opindex -L
7764 @opindex --dereference
7765 Follow symbolic links when copying from them.
7766 With this option, @command{cp} cannot create a symbolic link.
7767 For example, a symlink (to regular file) in the source tree will be copied to
7768 a regular file in the destination tree.
7769
7770 @item -n
7771 @itemx --no-clobber
7772 @opindex -n
7773 @opindex --no-clobber
7774 Do not overwrite an existing file.  The @option{-n} option overrides a previous
7775 @option{-i} option.  This option is mutually exclusive with @option{-b} or
7776 @option{--backup} option.
7777
7778 @item -P
7779 @itemx --no-dereference
7780 @opindex -P
7781 @opindex --no-dereference
7782 @cindex symbolic links, copying
7783 Copy symbolic links as symbolic links rather than copying the files that
7784 they point to.  This option affects only symbolic links in the source;
7785 symbolic links in the destination are always followed if possible.
7786
7787 @item -p
7788 @itemx @w{@kbd{--preserve}[=@var{attribute_list}]}
7789 @opindex -p
7790 @opindex --preserve
7791 @cindex file information, preserving, extended attributes, xattr
7792 Preserve the specified attributes of the original files.
7793 If specified, the @var{attribute_list} must be a comma-separated list
7794 of one or more of the following strings:
7795
7796 @table @samp
7797 @item mode
7798 Preserve the file mode bits and access control lists.
7799 @item ownership
7800 Preserve the owner and group.  On most modern systems,
7801 only users with appropriate privileges may change the owner of a file,
7802 and ordinary users
7803 may preserve the group ownership of a file only if they happen to be
7804 a member of the desired group.
7805 @item timestamps
7806 Preserve the times of last access and last modification, when possible.
7807 On older systems, it is not possible to preserve these attributes
7808 when the affected file is a symbolic link.
7809 However, many systems now provide the @code{utimensat} function,
7810 which makes it possible even for symbolic links.
7811 @item links
7812 Preserve in the destination files
7813 any links between corresponding source files.
7814 Note that with @option{-L} or @option{-H}, this option can convert
7815 symbolic links to hard links.  For example,
7816 @example
7817 $ mkdir c; : > a; ln -s a b; cp -aH a b c; ls -i1 c
7818 74161745 a
7819 74161745 b
7820 @end example
7821 @noindent
7822 Note the inputs: @file{b} is a symlink to regular file @file{a},
7823 yet the files in destination directory, @file{c/}, are hard-linked.
7824 Since @option{-a} implies @option{--preserve=links}, and since @option{-H}
7825 tells @command{cp} to dereference command line arguments, it sees two files
7826 with the same inode number, and preserves the perceived hard link.
7827
7828 Here is a similar example that exercises @command{cp}'s @option{-L} option:
7829 @smallexample
7830 $ mkdir b c; (cd b; : > a; ln -s a b); cp -aL b c; ls -i1 c/b
7831 74163295 a
7832 74163295 b
7833 @end smallexample
7834
7835 @item context
7836 Preserve SELinux security context of the file, or fail with full diagnostics.
7837 @item xattr
7838 Preserve extended attributes of the file, or fail with full diagnostics.
7839 If @command{cp} is built without xattr support, ignore this option.
7840 If SELinux context, ACLs or Capabilities are implemented using xattrs,
7841 they are preserved by this option as well.
7842 @item all
7843 Preserve all file attributes.
7844 Equivalent to specifying all of the above, but with the difference
7845 that failure to preserve SELinux security context or extended attributes
7846 does not change @command{cp}'s exit status.  In contrast to @option{-a},
7847 all but @samp{Operation not supported} warnings are output.
7848 @end table
7849
7850 Using @option{--preserve} with no @var{attribute_list} is equivalent
7851 to @option{--preserve=mode,ownership,timestamps}.
7852
7853 In the absence of this option, each destination file is created with the
7854 mode bits of the corresponding source file, minus the bits set in the
7855 umask and minus the set-user-ID and set-group-ID bits.
7856 @xref{File permissions}.
7857
7858 @item @w{@kbd{--no-preserve}=@var{attribute_list}}
7859 @cindex file information, preserving
7860 Do not preserve the specified attributes.  The @var{attribute_list}
7861 has the same form as for @option{--preserve}.
7862
7863 @item --parents
7864 @opindex --parents
7865 @cindex parent directories and @command{cp}
7866 Form the name of each destination file by appending to the target
7867 directory a slash and the specified name of the source file.  The last
7868 argument given to @command{cp} must be the name of an existing directory.
7869 For example, the command:
7870
7871 @example
7872 cp --parents a/b/c existing_dir
7873 @end example
7874
7875 @noindent
7876 copies the file @file{a/b/c} to @file{existing_dir/a/b/c}, creating
7877 any missing intermediate directories.
7878
7879 @item -R
7880 @itemx -r
7881 @itemx --recursive
7882 @opindex -R
7883 @opindex -r
7884 @opindex --recursive
7885 @cindex directories, copying recursively
7886 @cindex copying directories recursively
7887 @cindex recursively copying directories
7888 @cindex non-directories, copying as special files
7889 Copy directories recursively.  By default, do not follow symbolic
7890 links in the source; see the @option{--archive} (@option{-a}), @option{-d},
7891 @option{--dereference} (@option{-L}), @option{--no-dereference}
7892 (@option{-P}), and @option{-H} options.  Special files are copied by
7893 creating a destination file of the same type as the source; see the
7894 @option{--copy-contents} option.  It is not portable to use
7895 @option{-r} to copy symbolic links or special files.  On some
7896 non-@sc{gnu} systems, @option{-r} implies the equivalent of
7897 @option{-L} and @option{--copy-contents} for historical reasons.
7898 Also, it is not portable to use @option{-R} to copy symbolic links
7899 unless you also specify @option{-P}, as POSIX allows
7900 implementations that dereference symbolic links by default.
7901
7902 @item --reflink[=@var{when}]
7903 @opindex --reflink[=@var{when}]
7904 @cindex COW
7905 @cindex clone
7906 @cindex copy on write
7907 Perform a lightweight, copy-on-write (COW) copy, if supported by the
7908 file system.  Once it has succeeded, beware that the source and destination
7909 files share the same disk data blocks as long as they remain unmodified.
7910 Thus, if a disk I/O error affects data blocks of one of the files,
7911 the other suffers the same fate.
7912
7913 The @var{when} value can be one of the following:
7914
7915 @table @samp
7916 @item always
7917 The default behavior: if the copy-on-write operation is not supported
7918 then report the failure for each file and exit with a failure status.
7919
7920 @item auto
7921 If the copy-on-write operation is not supported then fall back
7922 to the standard copy behaviour.
7923 @end table
7924
7925 This option is overridden by the @option{--link}, @option{--symbolic-link}
7926 and @option{--attributes-only} options, thus allowing it to be used
7927 to configure the default data copying behavior for @command{cp}.
7928 For example, with the following alias, @command{cp} will use the
7929 minimum amount of space supported by the file system.
7930
7931 @example
7932 alias cp='cp --reflink=auto --sparse=always'
7933 @end example
7934
7935 @item --remove-destination
7936 @opindex --remove-destination
7937 Remove each existing destination file before attempting to open it
7938 (contrast with @option{-f} above).
7939
7940 @item --sparse=@var{when}
7941 @opindex --sparse=@var{when}
7942 @cindex sparse files, copying
7943 @cindex holes, copying files with
7944 @findex read @r{system call, and holes}
7945 A @dfn{sparse file} contains @dfn{holes}---a sequence of zero bytes that
7946 does not occupy any physical disk blocks; the @samp{read} system call
7947 reads these as zeros.  This can both save considerable disk space and
7948 increase speed, since many binary files contain lots of consecutive zero
7949 bytes.  By default, @command{cp} detects holes in input source files via a crude
7950 heuristic and makes the corresponding output file sparse as well.
7951 Only regular files may be sparse.
7952
7953 The @var{when} value can be one of the following:
7954
7955 @table @samp
7956 @item auto
7957 The default behavior: if the input file is sparse, attempt to make
7958 the output file sparse, too.  However, if an output file exists but
7959 refers to a non-regular file, then do not attempt to make it sparse.
7960
7961 @item always
7962 For each sufficiently long sequence of zero bytes in the input file,
7963 attempt to create a corresponding hole in the output file, even if the
7964 input file does not appear to be sparse.
7965 This is useful when the input file resides on a file system
7966 that does not support sparse files
7967 (for example,  @samp{efs} file systems in SGI IRIX 5.3 and earlier),
7968 but the output file is on a type of file system that does support them.
7969 Holes may be created only in regular files, so if the destination file
7970 is of some other type, @command{cp} does not even try to make it sparse.
7971
7972 @item never
7973 Never make the output file sparse.
7974 This is useful in creating a file for use with the @command{mkswap} command,
7975 since such a file must not have any holes.
7976 @end table
7977
7978 @optStripTrailingSlashes
7979
7980 @item -s
7981 @itemx --symbolic-link
7982 @opindex -s
7983 @opindex --symbolic-link
7984 @cindex symbolic links, copying with
7985 Make symbolic links instead of copies of non-directories.  All source
7986 file names must be absolute (starting with @samp{/}) unless the
7987 destination files are in the current directory.  This option merely
7988 results in an error message on systems that do not support symbolic links.
7989
7990 @optBackupSuffix
7991
7992 @optTargetDirectory
7993
7994 @optNoTargetDirectory
7995
7996 @item -u
7997 @itemx --update
7998 @opindex -u
7999 @opindex --update
8000 @cindex newer files, copying only
8001 Do not copy a non-directory that has an existing destination with the
8002 same or newer modification time.  If time stamps are being preserved,
8003 the comparison is to the source time stamp truncated to the
8004 resolutions of the destination file system and of the system calls
8005 used to update time stamps; this avoids duplicate work if several
8006 @samp{cp -pu} commands are executed with the same source and destination.
8007 If @option{--preserve=links} is also specified (like with @samp{cp -au}
8008 for example), that will take precedence.  Consequently, depending on the
8009 order that files are processed from the source, newer files in the destination
8010 may be replaced, to mirror hard links in the source.
8011
8012 @item -v
8013 @itemx --verbose
8014 @opindex -v
8015 @opindex --verbose
8016 Print the name of each file before copying it.
8017
8018 @item -x
8019 @itemx --one-file-system
8020 @opindex -x
8021 @opindex --one-file-system
8022 @cindex file systems, omitting copying to different
8023 Skip subdirectories that are on different file systems from the one that
8024 the copy started on.
8025 However, mount point directories @emph{are} copied.
8026
8027 @end table
8028
8029 @exitstatus
8030
8031
8032 @node dd invocation
8033 @section @command{dd}: Convert and copy a file
8034
8035 @pindex dd
8036 @cindex converting while copying a file
8037
8038 @command{dd} copies a file (from standard input to standard output, by
8039 default) with a changeable I/O block size, while optionally performing
8040 conversions on it.  Synopses:
8041
8042 @example
8043 dd [@var{operand}]@dots{}
8044 dd @var{option}
8045 @end example
8046
8047 The only options are @option{--help} and @option{--version}.
8048 @xref{Common options}.  @command{dd} accepts the following operands.
8049
8050 @table @samp
8051
8052 @item if=@var{file}
8053 @opindex if
8054 Read from @var{file} instead of standard input.
8055
8056 @item of=@var{file}
8057 @opindex of
8058 Write to @var{file} instead of standard output.  Unless
8059 @samp{conv=notrunc} is given, @command{dd} truncates @var{file} to zero
8060 bytes (or the size specified with @samp{seek=}).
8061
8062 @item ibs=@var{bytes}
8063 @opindex ibs
8064 @cindex block size of input
8065 @cindex input block size
8066 Set the input block size to @var{bytes}.
8067 This makes @command{dd} read @var{bytes} per block.
8068 The default is 512 bytes.
8069
8070 @item obs=@var{bytes}
8071 @opindex obs
8072 @cindex block size of output
8073 @cindex output block size
8074 Set the output block size to @var{bytes}.
8075 This makes @command{dd} write @var{bytes} per block.
8076 The default is 512 bytes.
8077
8078 @item bs=@var{bytes}
8079 @opindex bs
8080 @cindex block size
8081 Set both input and output block sizes to @var{bytes}.
8082 This makes @command{dd} read and write @var{bytes} per block,
8083 overriding any @samp{ibs} and @samp{obs} settings.
8084 In addition, if no data-transforming @option{conv} option is specified,
8085 input is copied to the output as soon as it's read,
8086 even if it is smaller than the block size.
8087
8088 @item cbs=@var{bytes}
8089 @opindex cbs
8090 @cindex block size of conversion
8091 @cindex conversion block size
8092 @cindex fixed-length records, converting to variable-length
8093 @cindex variable-length records, converting to fixed-length
8094 Set the conversion block size to @var{bytes}.
8095 When converting variable-length records to fixed-length ones
8096 (@option{conv=block}) or the reverse (@option{conv=unblock}),
8097 use @var{bytes} as the fixed record length.
8098
8099 @item skip=@var{n}
8100 @opindex skip
8101 Skip @var{n} @samp{ibs}-byte blocks in the input file before copying.
8102 If @samp{iflag=skip_bytes} is specified, @var{n} is interpreted
8103 as a byte count rather than a block count.
8104
8105 @item seek=@var{n}
8106 @opindex seek
8107 Skip @var{n} @samp{obs}-byte blocks in the output file before copying.
8108 if @samp{oflag=seek_bytes} is specified, @var{n} is interpreted
8109 as a byte count rather than a block count.
8110
8111 @item count=@var{n}
8112 @opindex count
8113 Copy @var{n} @samp{ibs}-byte blocks from the input file, instead
8114 of everything until the end of the file.
8115 if @samp{iflag=count_bytes} is specified, @var{n} is interpreted
8116 as a byte count rather than a block count.
8117
8118 @item status=noxfer
8119 @opindex status
8120 Do not print the overall transfer rate and volume statistics
8121 that normally make up the third status line when @command{dd} exits.
8122
8123 @item conv=@var{conversion}[,@var{conversion}]@dots{}
8124 @opindex conv
8125 Convert the file as specified by the @var{conversion} argument(s).
8126 (No spaces around any comma(s).)
8127
8128 Conversions:
8129
8130 @table @samp
8131
8132 @item ascii
8133 @opindex ascii@r{, converting to}
8134 Convert EBCDIC to ASCII,
8135 using the conversion table specified by POSIX@.
8136 This provides a 1:1 translation for all 256 bytes.
8137
8138 @item ebcdic
8139 @opindex ebcdic@r{, converting to}
8140 Convert ASCII to EBCDIC@.
8141 This is the inverse of the @samp{ascii} conversion.
8142
8143 @item ibm
8144 @opindex alternate ebcdic@r{, converting to}
8145 Convert ASCII to alternate EBCDIC,
8146 using the alternate conversion table specified by POSIX@.
8147 This is not a 1:1 translation, but reflects common historical practice
8148 for @samp{~}, @samp{[}, and @samp{]}.
8149
8150 The @samp{ascii}, @samp{ebcdic}, and @samp{ibm} conversions are
8151 mutually exclusive.
8152
8153 @item block
8154 @opindex block @r{(space-padding)}
8155 For each line in the input, output @samp{cbs} bytes, replacing the
8156 input newline with a space and padding with spaces as necessary.
8157
8158 @item unblock
8159 @opindex unblock
8160 Remove any trailing spaces in each @samp{cbs}-sized input block,
8161 and append a newline.
8162
8163 The @samp{block} and @samp{unblock} conversions are mutually exclusive.
8164
8165 @item lcase
8166 @opindex lcase@r{, converting to}
8167 Change uppercase letters to lowercase.
8168
8169 @item ucase
8170 @opindex ucase@r{, converting to}
8171 Change lowercase letters to uppercase.
8172
8173 The @samp{lcase} and @samp{ucase} conversions are mutually exclusive.
8174
8175 @item sparse
8176 @opindex sparse
8177 Try to seek rather than write @sc{nul} output blocks.
8178 On a file system that supports sparse files, this will create
8179 sparse output when extending the output file.
8180 Be careful when using this option in conjunction with
8181 @samp{conv=notrunc} or @samp{oflag=append}.
8182 With @samp{conv=notrunc}, existing data in the output file
8183 corresponding to @sc{nul} blocks from the input, will be untouched.
8184 With @samp{oflag=append} the seeks performed will be ineffective.
8185 Similarly, when the output is a device rather than a file,
8186 @sc{nul} input blocks are not copied, and therefore this option
8187 is most useful with virtual or pre zeroed devices.
8188
8189 @item swab
8190 @opindex swab @r{(byte-swapping)}
8191 @cindex byte-swapping
8192 Swap every pair of input bytes.  @sc{gnu} @command{dd}, unlike others, works
8193 when an odd number of bytes are read---the last byte is simply copied
8194 (since there is nothing to swap it with).
8195
8196 @item sync
8197 @opindex sync @r{(padding with ASCII @sc{nul}s)}
8198 Pad every input block to size of @samp{ibs} with trailing zero bytes.
8199 When used with @samp{block} or @samp{unblock}, pad with spaces instead of
8200 zero bytes.
8201
8202 @end table
8203
8204 The following ``conversions'' are really file flags
8205 and don't affect internal processing:
8206
8207 @table @samp
8208 @item excl
8209 @opindex excl
8210 @cindex creating output file, requiring
8211 Fail if the output file already exists; @command{dd} must create the
8212 output file itself.
8213
8214 @item nocreat
8215 @opindex nocreat
8216 @cindex creating output file, avoiding
8217 Do not create the output file; the output file must already exist.
8218
8219 The @samp{excl} and @samp{nocreat} conversions are mutually exclusive.
8220
8221 @item notrunc
8222 @opindex notrunc
8223 @cindex truncating output file, avoiding
8224 Do not truncate the output file.
8225
8226 @item noerror
8227 @opindex noerror
8228 @cindex read errors, ignoring
8229 Continue after read errors.
8230
8231 @item fdatasync
8232 @opindex fdatasync
8233 @cindex synchronized data writes, before finishing
8234 Synchronize output data just before finishing.  This forces a physical
8235 write of output data.
8236
8237 @item fsync
8238 @opindex fsync
8239 @cindex synchronized data and metadata writes, before finishing
8240 Synchronize output data and metadata just before finishing.  This
8241 forces a physical write of output data and metadata.
8242
8243 @end table
8244
8245 @item iflag=@var{flag}[,@var{flag}]@dots{}
8246 @opindex iflag
8247 Access the input file using the flags specified by the @var{flag}
8248 argument(s).  (No spaces around any comma(s).)
8249
8250 @item oflag=@var{flag}[,@var{flag}]@dots{}
8251 @opindex oflag
8252 Access the output file using the flags specified by the @var{flag}
8253 argument(s).  (No spaces around any comma(s).)
8254
8255 Here are the flags.  Not every flag is supported on every operating
8256 system.
8257
8258 @table @samp
8259
8260 @item append
8261 @opindex append
8262 @cindex appending to the output file
8263 Write in append mode, so that even if some other process is writing to
8264 this file, every @command{dd} write will append to the current
8265 contents of the file.  This flag makes sense only for output.
8266 If you combine this flag with the @samp{of=@var{file}} operand,
8267 you should also specify @samp{conv=notrunc} unless you want the
8268 output file to be truncated before being appended to.
8269
8270 @item cio
8271 @opindex cio
8272 @cindex concurrent I/O
8273 Use concurrent I/O mode for data.  This mode performs direct I/O
8274 and drops the POSIX requirement to serialize all I/O to the same file.
8275 A file cannot be opened in CIO mode and with a standard open at the
8276 same time.
8277
8278 @item direct
8279 @opindex direct
8280 @cindex direct I/O
8281 Use direct I/O for data, avoiding the buffer cache.
8282 Note that the kernel may impose restrictions on read or write buffer sizes.
8283 For example, with an ext4 destination file system and a linux-based kernel,
8284 using @samp{oflag=direct} will cause writes to fail with @code{EINVAL} if the
8285 output buffer size is not a multiple of 512.
8286
8287 @item directory
8288 @opindex directory
8289 @cindex directory I/O
8290
8291 Fail unless the file is a directory.  Most operating systems do not
8292 allow I/O to a directory, so this flag has limited utility.
8293
8294 @item dsync
8295 @opindex dsync
8296 @cindex synchronized data reads
8297 Use synchronized I/O for data.  For the output file, this forces a
8298 physical write of output data on each write.  For the input file,
8299 this flag can matter when reading from a remote file that has been
8300 written to synchronously by some other process.  Metadata (e.g.,
8301 last-access and last-modified time) is not necessarily synchronized.
8302
8303 @item sync
8304 @opindex sync
8305 @cindex synchronized data and metadata I/O
8306 Use synchronized I/O for both data and metadata.
8307
8308 @item nocache
8309 @opindex nocache
8310 @cindex discarding file cache
8311 Discard the data cache for a file.
8312 When count=0 all cache is discarded,
8313 otherwise the cache is dropped for the processed
8314 portion of the file.  Also when count=0
8315 failure to discard the cache is diagnosed
8316 and reflected in the exit status.
8317 Here as some usage examples:
8318
8319 @example
8320 # Advise to drop cache for whole file
8321 dd if=ifile iflag=nocache count=0
8322
8323 # Ensure drop cache for the whole file
8324 dd of=ofile oflag=nocache conv=notrunc,fdatasync count=0
8325
8326 # Drop cache for part of file
8327 dd if=ifile iflag=nocache skip=10 count=10 of=/dev/null
8328
8329 # Stream data using just the read-ahead cache
8330 dd if=ifile of=ofile iflag=nocache oflag=nocache
8331 @end example
8332
8333 @item nonblock
8334 @opindex nonblock
8335 @cindex nonblocking I/O
8336 Use non-blocking I/O.
8337
8338 @item noatime
8339 @opindex noatime
8340 @cindex access time
8341 Do not update the file's access time.
8342 Some older file systems silently ignore this flag, so it is a good
8343 idea to test it on your files before relying on it.
8344
8345 @item noctty
8346 @opindex noctty
8347 @cindex controlling terminal
8348 Do not assign the file to be a controlling terminal for @command{dd}.
8349 This has no effect when the file is not a terminal.
8350 On many hosts (e.g., GNU/Linux hosts), this option has no effect
8351 at all.
8352
8353 @item nofollow
8354 @opindex nofollow
8355 @cindex symbolic links, following
8356 Do not follow symbolic links.
8357
8358 @item nolinks
8359 @opindex nolinks
8360 @cindex hard links
8361 Fail if the file has multiple hard links.
8362
8363 @item binary
8364 @opindex binary
8365 @cindex binary I/O
8366 Use binary I/O@.  This option has an effect only on nonstandard
8367 platforms that distinguish binary from text I/O.
8368
8369 @item text
8370 @opindex text
8371 @cindex text I/O
8372 Use text I/O@.  Like @samp{binary}, this option has no effect on
8373 standard platforms.
8374
8375 @item fullblock
8376 @opindex fullblock
8377 Accumulate full blocks from input.  The @code{read} system call
8378 may return early if a full block is not available.
8379 When that happens, continue calling @code{read} to fill the remainder
8380 of the block.
8381 This flag can be used only with @code{iflag}.
8382
8383 @item count_bytes
8384 @opindex count_bytes
8385 Interpret the @samp{count=} operand as a byte count,
8386 rather than a block count, which allows specifying
8387 a length that is not a multiple of the I/O block size.
8388 This flag can be used only with @code{iflag}.
8389
8390 @item skip_bytes
8391 @opindex skip_bytes
8392 Interpret the @samp{skip=} operand as a byte count,
8393 rather than a block count, which allows specifying
8394 an offset that is not a multiple of the I/O block size.
8395 This flag can be used only with @code{iflag}.
8396
8397 @item seek_bytes
8398 @opindex seek_bytes
8399 Interpret the @samp{seek=} operand as a byte count,
8400 rather than a block count, which allows specifying
8401 an offset that is not a multiple of the I/O block size.
8402 This flag can be used only with @code{oflag}.
8403
8404 @end table
8405
8406 These flags are not supported on all systems, and @samp{dd} rejects
8407 attempts to use them when they are not supported.  When reading from
8408 standard input or writing to standard output, the @samp{nofollow} and
8409 @samp{noctty} flags should not be specified, and the other flags
8410 (e.g., @samp{nonblock}) can affect how other processes behave with the
8411 affected file descriptors, even after @command{dd} exits.
8412
8413 @end table
8414
8415 @cindex multipliers after numbers
8416 The numeric-valued strings above (@var{n}, @var{bytes} and @var{blocks})
8417 can be followed by a multiplier: @samp{b}=512, @samp{c}=1,
8418 @samp{w}=2, @samp{x@var{m}}=@var{m}, or any of the
8419 standard block size suffixes like @samp{k}=1024 (@pxref{Block size}).
8420
8421 Any block size you specify via @samp{bs=}, @samp{ibs=}, @samp{obs=}, @samp{cbs=}
8422 should not be too large---values larger than a few megabytes
8423 are generally wasteful or (as in the gigabyte..exabyte case) downright
8424 counterproductive or error-inducing.
8425
8426 To process data that is at an offset or size that is not a
8427 multiple of the I/O@ block size, you can use the @samp{skip_bytes},
8428 @samp{seek_bytes} and @samp{count_bytes} flags.  Alternatively
8429 the traditional method of separate @command{dd} invocations can be used.
8430 For example, the following shell commands copy data
8431 in 512 KiB blocks between a disk and a tape, but do not save
8432 or restore a 4 KiB label at the start of the disk:
8433
8434 @example
8435 disk=/dev/rdsk/c0t1d0s2
8436 tape=/dev/rmt/0
8437
8438 # Copy all but the label from disk to tape.
8439 (dd bs=4k skip=1 count=0 && dd bs=512k) <$disk >$tape
8440
8441 # Copy from tape back to disk, but leave the disk label alone.
8442 (dd bs=4k seek=1 count=0 && dd bs=512k) <$tape >$disk
8443 @end example
8444
8445 Sending an @samp{INFO} signal to a running @command{dd}
8446 process makes it print I/O statistics to standard error
8447 and then resume copying.  In the example below,
8448 @command{dd} is run in the background to copy 10 million blocks.
8449 The @command{kill} command makes it output intermediate I/O statistics,
8450 and when @command{dd} completes normally or is killed by the
8451 @code{SIGINT} signal, it outputs the final statistics.
8452
8453 @example
8454 $ dd if=/dev/zero of=/dev/null count=10MB & pid=$!
8455 $ kill -s INFO $pid; wait $pid
8456 3385223+0 records in
8457 3385223+0 records out
8458 1733234176 bytes (1.7 GB) copied, 6.42173 seconds, 270 MB/s
8459 10000000+0 records in
8460 10000000+0 records out
8461 5120000000 bytes (5.1 GB) copied, 18.913 seconds, 271 MB/s
8462 @end example
8463
8464 @vindex POSIXLY_CORRECT
8465 On systems lacking the @samp{INFO} signal @command{dd} responds to the
8466 @samp{USR1} signal instead, unless the @env{POSIXLY_CORRECT}
8467 environment variable is set.
8468
8469 @exitstatus
8470
8471
8472 @node install invocation
8473 @section @command{install}: Copy files and set attributes
8474
8475 @pindex install
8476 @cindex copying files and setting attributes
8477
8478 @command{install} copies files while setting their file mode bits and, if
8479 possible, their owner and group.  Synopses:
8480
8481 @example
8482 install [@var{option}]@dots{} [-T] @var{source} @var{dest}
8483 install [@var{option}]@dots{} @var{source}@dots{} @var{directory}
8484 install [@var{option}]@dots{} -t @var{directory} @var{source}@dots{}
8485 install [@var{option}]@dots{} -d @var{directory}@dots{}
8486 @end example
8487
8488 @itemize @bullet
8489 @item
8490 If two file names are given, @command{install} copies the first file to the
8491 second.
8492
8493 @item
8494 If the @option{--target-directory} (@option{-t}) option is given, or
8495 failing that if the last file is a directory and the
8496 @option{--no-target-directory} (@option{-T}) option is not given,
8497 @command{install} copies each @var{source} file to the specified
8498 directory, using the @var{source}s' names.
8499
8500 @item
8501 If the @option{--directory} (@option{-d}) option is given,
8502 @command{install} creates each @var{directory} and any missing parent
8503 directories.  Parent directories are created with mode
8504 @samp{u=rwx,go=rx} (755), regardless of the @option{-m} option or the
8505 current umask.  @xref{Directory Setuid and Setgid}, for how the
8506 set-user-ID and set-group-ID bits of parent directories are inherited.
8507 @end itemize
8508
8509 @cindex Makefiles, installing programs in
8510 @command{install} is similar to @command{cp}, but allows you to control the
8511 attributes of destination files.  It is typically used in Makefiles to
8512 copy programs into their destination directories.  It refuses to copy
8513 files onto themselves.
8514
8515 @cindex extended attributes, xattr
8516 @command{install} never preserves extended attributes (xattr).
8517
8518 The program accepts the following options.  Also see @ref{Common options}.
8519
8520 @table @samp
8521
8522 @optBackup
8523
8524 @item -C
8525 @itemx --compare
8526 @opindex -C
8527 @opindex --compare
8528 Compare each pair of source and destination files, and if the destination has
8529 identical content and any specified owner, group, permissions, and possibly
8530 SELinux context, then do not modify the destination at all.
8531
8532 @item -c
8533 @opindex -c
8534 Ignored; for compatibility with old Unix versions of @command{install}.
8535
8536 @item -D
8537 @opindex -D
8538 Create any missing parent directories of @var{dest},
8539 then copy @var{source} to @var{dest}.
8540 This option is ignored if a destination directory is specified
8541 via @option{--target-directory=DIR}.
8542
8543 @item -d
8544 @itemx --directory
8545 @opindex -d
8546 @opindex --directory
8547 @cindex directories, creating with given attributes
8548 @cindex parent directories, creating missing
8549 @cindex leading directories, creating missing
8550 Create any missing parent directories, giving them the default
8551 attributes.  Then create each given directory, setting their owner,
8552 group and mode as given on the command line or to the defaults.
8553
8554 @item -g @var{group}
8555 @itemx --group=@var{group}
8556 @opindex -g
8557 @opindex --group
8558 @cindex group ownership of installed files, setting
8559 Set the group ownership of installed files or directories to
8560 @var{group}.  The default is the process's current group.  @var{group}
8561 may be either a group name or a numeric group ID.
8562
8563 @item -m @var{mode}
8564 @itemx --mode=@var{mode}
8565 @opindex -m
8566 @opindex --mode
8567 @cindex permissions of installed files, setting
8568 Set the file mode bits for the installed file or directory to @var{mode},
8569 which can be either an octal number, or a symbolic mode as in
8570 @command{chmod}, with @samp{a=} (no access allowed to anyone) as the
8571 point of departure (@pxref{File permissions}).
8572 The default mode is @samp{u=rwx,go=rx,a-s}---read, write, and
8573 execute for the owner, read and execute for group and other, and with
8574 set-user-ID and set-group-ID disabled.
8575 This default is not quite the same as @samp{755}, since it disables
8576 instead of preserving set-user-ID and set-group-ID on directories.
8577 @xref{Directory Setuid and Setgid}.
8578
8579 @item -o @var{owner}
8580 @itemx --owner=@var{owner}
8581 @opindex -o
8582 @opindex --owner
8583 @cindex ownership of installed files, setting
8584 @cindex appropriate privileges
8585 @vindex root @r{as default owner}
8586 If @command{install} has appropriate privileges (is run as root), set the
8587 ownership of installed files or directories to @var{owner}.  The default
8588 is @code{root}.  @var{owner} may be either a user name or a numeric user
8589 ID.
8590
8591 @item --preserve-context
8592 @opindex --preserve-context
8593 @cindex SELinux
8594 @cindex security context
8595 Preserve the SELinux security context of files and directories.
8596 Failure to preserve the context in all of the files or directories
8597 will result in an exit status of 1.  If SELinux is disabled then
8598 print a warning and ignore the option.
8599
8600 @item -p
8601 @itemx --preserve-timestamps
8602 @opindex -p
8603 @opindex --preserve-timestamps
8604 @cindex timestamps of installed files, preserving
8605 Set the time of last access and the time of last modification of each
8606 installed file to match those of each corresponding original file.
8607 When a file is installed without this option, its last access and
8608 last modification times are both set to the time of installation.
8609 This option is useful if you want to use the last modification times
8610 of installed files to keep track of when they were last built as opposed
8611 to when they were last installed.
8612
8613 @item -s
8614 @itemx --strip
8615 @opindex -s
8616 @opindex --strip
8617 @cindex symbol table information, stripping
8618 @cindex stripping symbol table information
8619 Strip the symbol tables from installed binary executables.
8620
8621 @item --strip-program=@var{program}
8622 @opindex --strip-program
8623 @cindex symbol table information, stripping, program
8624 Program used to strip binaries.
8625
8626 @optBackupSuffix
8627
8628 @optTargetDirectory
8629
8630 @optNoTargetDirectory
8631
8632 @item -v
8633 @itemx --verbose
8634 @opindex -v
8635 @opindex --verbose
8636 Print the name of each file before copying it.
8637
8638 @item -Z @var{context}
8639 @itemx --context=@var{context}
8640 @opindex -Z
8641 @opindex --context
8642 @cindex SELinux
8643 @cindex security context
8644 Set the default SELinux security context to be used for any
8645 created files and directories.  If SELinux is disabled then
8646 print a warning and ignore the option.
8647
8648 @end table
8649
8650 @exitstatus
8651
8652
8653 @node mv invocation
8654 @section @command{mv}: Move (rename) files
8655
8656 @pindex mv
8657
8658 @command{mv} moves or renames files (or directories).  Synopses:
8659
8660 @example
8661 mv [@var{option}]@dots{} [-T] @var{source} @var{dest}
8662 mv [@var{option}]@dots{} @var{source}@dots{} @var{directory}
8663 mv [@var{option}]@dots{} -t @var{directory} @var{source}@dots{}
8664 @end example
8665
8666 @itemize @bullet
8667 @item
8668 If two file names are given, @command{mv} moves the first file to the
8669 second.
8670
8671 @item
8672 If the @option{--target-directory} (@option{-t}) option is given, or
8673 failing that if the last file is a directory and the
8674 @option{--no-target-directory} (@option{-T}) option is not given,
8675 @command{mv} moves each @var{source} file to the specified
8676 directory, using the @var{source}s' names.
8677 @end itemize
8678
8679 @command{mv} can move any type of file from one file system to another.
8680 Prior to version @code{4.0} of the fileutils,
8681 @command{mv} could move only regular files between file systems.
8682 For example, now @command{mv} can move an entire directory hierarchy
8683 including special device files from one partition to another.  It first
8684 uses some of the same code that's used by @code{cp -a} to copy the
8685 requested directories and files, then (assuming the copy succeeded)
8686 it removes the originals.  If the copy fails, then the part that was
8687 copied to the destination partition is removed.  If you were to copy
8688 three directories from one partition to another and the copy of the first
8689 directory succeeded, but the second didn't, the first would be left on
8690 the destination partition and the second and third would be left on the
8691 original partition.
8692
8693 @cindex extended attributes, xattr
8694 @command{mv} always tries to copy extended attributes (xattr), which may
8695 include SELinux context, ACLs or Capabilities.
8696 Upon failure all but @samp{Operation not supported} warnings are output.
8697
8698 @cindex prompting, and @command{mv}
8699 If a destination file exists but is normally unwritable, standard input
8700 is a terminal, and the @option{-f} or @option{--force} option is not given,
8701 @command{mv} prompts the user for whether to replace the file.  (You might
8702 own the file, or have write permission on its directory.)  If the
8703 response is not affirmative, the file is skipped.
8704
8705 @emph{Warning}: Avoid specifying a source name with a trailing slash,
8706 when it might be a symlink to a directory.
8707 Otherwise, @command{mv} may do something very surprising, since
8708 its behavior depends on the underlying rename system call.
8709 On a system with a modern Linux-based kernel, it fails with
8710 @code{errno=ENOTDIR}@.
8711 However, on other systems (at least FreeBSD 6.1 and Solaris 10) it silently
8712 renames not the symlink but rather the directory referenced by the symlink.
8713 @xref{Trailing slashes}.
8714
8715 The program accepts the following options.  Also see @ref{Common options}.
8716
8717 @table @samp
8718
8719 @optBackup
8720
8721 @item -f
8722 @itemx --force
8723 @opindex -f
8724 @opindex --force
8725 @cindex prompts, omitting
8726 Do not prompt the user before removing a destination file.
8727 @macro mvOptsIfn
8728 If you specify more than one of the @option{-i}, @option{-f}, @option{-n}
8729 options, only the final one takes effect.
8730 @end macro
8731 @mvOptsIfn
8732
8733 @item -i
8734 @itemx --interactive
8735 @opindex -i
8736 @opindex --interactive
8737 @cindex prompts, forcing
8738 Prompt whether to overwrite each existing destination file, regardless
8739 of its permissions.
8740 If the response is not affirmative, the file is skipped.
8741 @mvOptsIfn
8742
8743 @item -n
8744 @itemx --no-clobber
8745 @opindex -n
8746 @opindex --no-clobber
8747 @cindex prompts, omitting
8748 Do not overwrite an existing file.
8749 @mvOptsIfn
8750 This option is mutually exclusive with @option{-b} or @option{--backup} option.
8751
8752 @item -u
8753 @itemx --update
8754 @opindex -u
8755 @opindex --update
8756 @cindex newer files, moving only
8757 Do not move a non-directory that has an existing destination with the
8758 same or newer modification time.
8759 If the move is across file system boundaries, the comparison is to the
8760 source time stamp truncated to the resolutions of the destination file
8761 system and of the system calls used to update time stamps; this avoids
8762 duplicate work if several @samp{mv -u} commands are executed with the
8763 same source and destination.
8764
8765 @item -v
8766 @itemx --verbose
8767 @opindex -v
8768 @opindex --verbose
8769 Print the name of each file before moving it.
8770
8771 @optStripTrailingSlashes
8772
8773 @optBackupSuffix
8774
8775 @optTargetDirectory
8776
8777 @optNoTargetDirectory
8778
8779 @end table
8780
8781 @exitstatus
8782
8783
8784 @node rm invocation
8785 @section @command{rm}: Remove files or directories
8786
8787 @pindex rm
8788 @cindex removing files or directories
8789
8790 @command{rm} removes each given @var{file}.  By default, it does not remove
8791 directories.  Synopsis:
8792
8793 @example
8794 rm [@var{option}]@dots{} [@var{file}]@dots{}
8795 @end example
8796
8797 @cindex prompting, and @command{rm}
8798 If the @option{-I} or @option{--interactive=once} option is given,
8799 and there are more than three files or the @option{-r}, @option{-R},
8800 or @option{--recursive} are given, then @command{rm} prompts the user
8801 for whether to proceed with the entire operation.  If the response is
8802 not affirmative, the entire command is aborted.
8803
8804 Otherwise, if a file is unwritable, standard input is a terminal, and
8805 the @option{-f} or @option{--force} option is not given, or the
8806 @option{-i} or @option{--interactive=always} option @emph{is} given,
8807 @command{rm} prompts the user for whether to remove the file.
8808 If the response is not affirmative, the file is skipped.
8809
8810 Any attempt to remove a file whose last file name component is
8811 @file{.} or @file{..} is rejected without any prompting.
8812
8813 @emph{Warning}: If you use @command{rm} to remove a file, it is usually
8814 possible to recover the contents of that file.  If you want more assurance
8815 that the contents are truly unrecoverable, consider using @command{shred}.
8816
8817 The program accepts the following options.  Also see @ref{Common options}.
8818
8819 @table @samp
8820
8821 @item -d
8822 @itemx --dir
8823 @opindex -d
8824 @opindex --dir
8825 @cindex directories, removing
8826 Remove the listed directories if they are empty.
8827
8828 @item -f
8829 @itemx --force
8830 @opindex -f
8831 @opindex --force
8832 Ignore nonexistent files and missing operands, and never prompt the user.
8833 Ignore any previous @option{--interactive} (@option{-i}) option.
8834
8835 @item -i
8836 @opindex -i
8837 Prompt whether to remove each file.
8838 If the response is not affirmative, the file is skipped.
8839 Ignore any previous @option{--force} (@option{-f}) option.
8840 Equivalent to @option{--interactive=always}.
8841
8842 @item -I
8843 @opindex -I
8844 Prompt once whether to proceed with the command, if more than three
8845 files are named or if a recursive removal is requested.  Ignore any
8846 previous @option{--force} (@option{-f}) option.  Equivalent to
8847 @option{--interactive=once}.
8848
8849 @item --interactive [=@var{when}]
8850 @opindex --interactive
8851 Specify when to issue an interactive prompt.  @var{when} may be
8852 omitted, or one of:
8853 @itemize @bullet
8854 @item never
8855 @vindex never @r{interactive option}
8856 - Do not prompt at all.
8857 @item once
8858 @vindex once @r{interactive option}
8859 - Prompt once if more than three files are named or if a recursive
8860 removal is requested.  Equivalent to @option{-I}.
8861 @item always
8862 @vindex always @r{interactive option}
8863 - Prompt for every file being removed.  Equivalent to @option{-i}.
8864 @end itemize
8865 @option{--interactive} with no @var{when} is equivalent to
8866 @option{--interactive=always}.
8867
8868 @item --one-file-system
8869 @opindex --one-file-system
8870 @cindex one file system, restricting @command{rm} to
8871 When removing a hierarchy recursively, skip any directory that is on a
8872 file system different from that of the corresponding command line argument.
8873
8874 @cindex bind mount
8875 This option is useful when removing a build ``chroot'' hierarchy,
8876 which normally contains no valuable data.  However, it is not uncommon
8877 to bind-mount @file{/home} into such a hierarchy, to make it easier to
8878 use one's start-up file.  The catch is that it's easy to forget to
8879 unmount @file{/home}.  Then, when you use @command{rm -rf} to remove
8880 your normally throw-away chroot, that command will remove everything
8881 under @file{/home}, too.
8882 Use the @option{--one-file-system} option, and it will
8883 warn about and skip directories on other file systems.
8884 Of course, this will not save your @file{/home} if it and your
8885 chroot happen to be on the same file system.
8886
8887 @item --preserve-root
8888 @opindex --preserve-root
8889 @cindex root directory, disallow recursive destruction
8890 Fail upon any attempt to remove the root directory, @file{/},
8891 when used with the @option{--recursive} option.
8892 This is the default behavior.
8893 @xref{Treating / specially}.
8894
8895 @item --no-preserve-root
8896 @opindex --no-preserve-root
8897 @cindex root directory, allow recursive destruction
8898 Do not treat @file{/} specially when removing recursively.
8899 This option is not recommended unless you really want to
8900 remove all the files on your computer.
8901 @xref{Treating / specially}.
8902
8903 @item -r
8904 @itemx -R
8905 @itemx --recursive
8906 @opindex -r
8907 @opindex -R
8908 @opindex --recursive
8909 @cindex directories, removing (recursively)
8910 Remove the listed directories and their contents recursively.
8911
8912 @item -v
8913 @itemx --verbose
8914 @opindex -v
8915 @opindex --verbose
8916 Print the name of each file before removing it.
8917
8918 @end table
8919
8920 @cindex files beginning with @samp{-}, removing
8921 @cindex @samp{-}, removing files beginning with
8922 One common question is how to remove files whose names begin with a
8923 @samp{-}.  @sc{gnu} @command{rm}, like every program that uses the @code{getopt}
8924 function to parse its arguments, lets you use the @samp{--} option to
8925 indicate that all following arguments are non-options.  To remove a file
8926 called @file{-f} in the current directory, you could type either:
8927
8928 @example
8929 rm -- -f
8930 @end example
8931
8932 @noindent
8933 or:
8934
8935 @example
8936 rm ./-f
8937 @end example
8938
8939 @opindex - @r{and Unix @command{rm}}
8940 The Unix @command{rm} program's use of a single @samp{-} for this purpose
8941 predates the development of the getopt standard syntax.
8942
8943 @exitstatus
8944
8945
8946 @node shred invocation
8947 @section @command{shred}: Remove files more securely
8948
8949 @pindex shred
8950 @cindex data, erasing
8951 @cindex erasing data
8952
8953 @command{shred} overwrites devices or files, to help prevent even
8954 very expensive hardware from recovering the data.
8955
8956 Ordinarily when you remove a file (@pxref{rm invocation}), the data is
8957 not actually destroyed.  Only the index listing where the file is
8958 stored is destroyed, and the storage is made available for reuse.
8959 There are undelete utilities that will attempt to reconstruct the index
8960 and can bring the file back if the parts were not reused.
8961
8962 On a busy system with a nearly-full drive, space can get reused in a few
8963 seconds.  But there is no way to know for sure.  If you have sensitive
8964 data, you may want to be sure that recovery is not possible by actually
8965 overwriting the file with non-sensitive data.
8966
8967 However, even after doing that, it is possible to take the disk back
8968 to a laboratory and use a lot of sensitive (and expensive) equipment
8969 to look for the faint ``echoes'' of the original data underneath the
8970 overwritten data.  If the data has only been overwritten once, it's not
8971 even that hard.
8972
8973 The best way to remove something irretrievably is to destroy the media
8974 it's on with acid, melt it down, or the like.  For cheap removable media
8975 like floppy disks, this is the preferred method.  However, hard drives
8976 are expensive and hard to melt, so the @command{shred} utility tries
8977 to achieve a similar effect non-destructively.
8978
8979 This uses many overwrite passes, with the data patterns chosen to
8980 maximize the damage they do to the old data.  While this will work on
8981 floppies, the patterns are designed for best effect on hard drives.
8982 For more details, see the source code and Peter Gutmann's paper
8983 @uref{http://www.cs.auckland.ac.nz/~pgut001/pubs/secure_del.html,
8984 @cite{Secure Deletion of Data from Magnetic and Solid-State Memory}},
8985 from the proceedings of the Sixth USENIX Security Symposium (San Jose,
8986 California, July 22--25, 1996).
8987
8988 @strong{Please note} that @command{shred} relies on a very important assumption:
8989 that the file system overwrites data in place.  This is the traditional
8990 way to do things, but many modern file system designs do not satisfy this
8991 assumption.  Exceptions include:
8992
8993 @itemize @bullet
8994
8995 @item
8996 Log-structured or journaled file systems, such as those supplied with
8997 AIX and Solaris, and JFS, ReiserFS, XFS, Ext3 (in @code{data=journal} mode),
8998 BFS, NTFS, etc., when they are configured to journal @emph{data}.
8999
9000 @item
9001 File systems that write redundant data and carry on even if some writes
9002 fail, such as RAID-based file systems.
9003
9004 @item
9005 File systems that make snapshots, such as Network Appliance's NFS server.
9006
9007 @item
9008 File systems that cache in temporary locations, such as NFS version 3
9009 clients.
9010
9011 @item
9012 Compressed file systems.
9013 @end itemize
9014
9015 In the particular case of ext3 file systems, the above disclaimer applies (and
9016 @command{shred} is thus of limited effectiveness) only in @code{data=journal}
9017 mode, which journals file data in addition to just metadata.  In both
9018 the @code{data=ordered} (default) and @code{data=writeback} modes,
9019 @command{shred} works as usual.  Ext3 journaling modes can be changed
9020 by adding the @code{data=something} option to the mount options for a
9021 particular file system in the @file{/etc/fstab} file, as documented in
9022 the mount man page (man mount).
9023
9024 If you are not sure how your file system operates, then you should assume
9025 that it does not overwrite data in place, which means that shred cannot
9026 reliably operate on regular files in your file system.
9027
9028 Generally speaking, it is more reliable to shred a device than a file,
9029 since this bypasses the problem of file system design mentioned above.
9030 However, even shredding devices is not always completely reliable.  For
9031 example, most disks map out bad sectors invisibly to the application; if
9032 the bad sectors contain sensitive data, @command{shred} won't be able to
9033 destroy it.
9034
9035 @command{shred} makes no attempt to detect or report this problem, just as
9036 it makes no attempt to do anything about backups.  However, since it is
9037 more reliable to shred devices than files, @command{shred} by default does
9038 not truncate or remove the output file.  This default is more suitable
9039 for devices, which typically cannot be truncated and should not be
9040 removed.
9041
9042 Finally, consider the risk of backups and mirrors.
9043 File system backups and remote mirrors may contain copies of the
9044 file that cannot be removed, and that will allow a shredded file
9045 to be recovered later.  So if you keep any data you may later want
9046 to destroy using @command{shred}, be sure that it is not backed up or mirrored.
9047
9048 @example
9049 shred [@var{option}]@dots{} @var{file}[@dots{}]
9050 @end example
9051
9052 The program accepts the following options.  Also see @ref{Common options}.
9053
9054 @table @samp
9055
9056 @item -f
9057 @itemx --force
9058 @opindex -f
9059 @opindex --force
9060 @cindex force deletion
9061 Override file permissions if necessary to allow overwriting.
9062
9063 @item -@var{number}
9064 @itemx -n @var{number}
9065 @itemx --iterations=@var{number}
9066 @opindex -n @var{number}
9067 @opindex --iterations=@var{number}
9068 @cindex iterations, selecting the number of
9069 By default, @command{shred} uses @value{SHRED_DEFAULT_PASSES} passes of
9070 overwrite.  You can reduce this to save time, or increase it if you think it's
9071 appropriate.  After 25 passes all of the internal overwrite patterns will have
9072 been used at least once.
9073
9074 @item --random-source=@var{file}
9075 @opindex --random-source
9076 @cindex random source for shredding
9077 Use @var{file} as a source of random data used to overwrite and to
9078 choose pass ordering.  @xref{Random sources}.
9079
9080 @item -s @var{bytes}
9081 @itemx --size=@var{bytes}
9082 @opindex -s @var{bytes}
9083 @opindex --size=@var{bytes}
9084 @cindex size of file to shred
9085 Shred the first @var{bytes} bytes of the file.  The default is to shred
9086 the whole file.  @var{bytes} can be followed by a size specification like
9087 @samp{K}, @samp{M}, or @samp{G} to specify a multiple.  @xref{Block size}.
9088
9089 @item -u
9090 @itemx --remove
9091 @opindex -u
9092 @opindex --remove
9093 @cindex removing files after shredding
9094 After shredding a file, truncate it (if possible) and then remove it.
9095 If a file has multiple links, only the named links will be removed.
9096
9097 @item -v
9098 @itemx --verbose
9099 @opindex -v
9100 @opindex --verbose
9101 Display to standard error all status updates as sterilization proceeds.
9102
9103 @item -x
9104 @itemx --exact
9105 @opindex -x
9106 @opindex --exact
9107 By default, @command{shred} rounds the size of a regular file up to the next
9108 multiple of the file system block size to fully erase the last block
9109 of the file.
9110 Use @option{--exact} to suppress that behavior.
9111 Thus, by default if you shred a 10-byte regular file on a system with 512-byte
9112 blocks, the resulting file will be 512 bytes long.  With this option,
9113 shred does not increase the apparent size of the file.
9114
9115 @item -z
9116 @itemx --zero
9117 @opindex -z
9118 @opindex --zero
9119 Normally, the last pass that @command{shred} writes is made up of
9120 random data.  If this would be conspicuous on your hard drive (for
9121 example, because it looks like encrypted data), or you just think
9122 it's tidier, the @option{--zero} option adds an additional overwrite pass with
9123 all zero bits.  This is in addition to the number of passes specified
9124 by the @option{--iterations} option.
9125
9126 @end table
9127
9128 You might use the following command to erase all trace of the
9129 file system you'd created on the floppy disk in your first drive.
9130 That command takes about 20 minutes to erase a ``1.44MB'' (actually
9131 1440 KiB) floppy.
9132
9133 @example
9134 shred --verbose /dev/fd0
9135 @end example
9136
9137 Similarly, to erase all data on a selected partition of
9138 your hard disk, you could give a command like this:
9139
9140 @example
9141 shred --verbose /dev/sda5
9142 @end example
9143
9144 On modern disks, a single pass should be adequate,
9145 and it will take one third the time of the default three-pass approach.
9146
9147 @example
9148 # 1 pass, write pseudo-random data; 3x faster than the default
9149 shred --verbose -n1 /dev/sda5
9150 @end example
9151
9152 To be on the safe side, use at least one pass that overwrites using
9153 pseudo-random data.  I.e., don't be tempted to use @samp{-n0 --zero},
9154 in case some disk controller optimizes the process of writing blocks
9155 of all zeros, and thereby does not clear all bytes in a block.
9156 Some SSDs may do just that.
9157
9158 A @var{file} of @samp{-} denotes standard output.
9159 The intended use of this is to shred a removed temporary file.
9160 For example:
9161
9162 @example
9163 i=$(mktemp)
9164 exec 3<>"$i"
9165 rm -- "$i"
9166 echo "Hello, world" >&3
9167 shred - >&3
9168 exec 3>-
9169 @end example
9170
9171 However, the command @samp{shred - >file} does not shred the contents
9172 of @var{file}, since the shell truncates @var{file} before invoking
9173 @command{shred}.  Use the command @samp{shred file} or (if using a
9174 Bourne-compatible shell) the command @samp{shred - 1<>file} instead.
9175
9176 @exitstatus
9177
9178
9179 @node Special file types
9180 @chapter Special file types
9181
9182 @cindex special file types
9183 @cindex file types, special
9184
9185 This chapter describes commands which create special types of files (and
9186 @command{rmdir}, which removes directories, one special file type).
9187
9188 @cindex special file types
9189 @cindex file types
9190 Although Unix-like operating systems have markedly fewer special file
9191 types than others, not @emph{everything} can be treated only as the
9192 undifferentiated byte stream of @dfn{normal files}.  For example, when a
9193 file is created or removed, the system must record this information,
9194 which it does in a @dfn{directory}---a special type of file.  Although
9195 you can read directories as normal files, if you're curious, in order
9196 for the system to do its job it must impose a structure, a certain
9197 order, on the bytes of the file.  Thus it is a ``special'' type of file.
9198
9199 Besides directories, other special file types include named pipes
9200 (FIFOs), symbolic links, sockets, and so-called @dfn{special files}.
9201
9202 @menu
9203 * link invocation::             Make a hard link via the link syscall
9204 * ln invocation::               Make links between files.
9205 * mkdir invocation::            Make directories.
9206 * mkfifo invocation::           Make FIFOs (named pipes).
9207 * mknod invocation::            Make block or character special files.
9208 * readlink invocation::         Print value of a symlink or canonical file name.
9209 * rmdir invocation::            Remove empty directories.
9210 * unlink invocation::           Remove files via the unlink syscall
9211 @end menu
9212
9213
9214 @node link invocation
9215 @section @command{link}: Make a hard link via the link syscall
9216
9217 @pindex link
9218 @cindex links, creating
9219 @cindex hard links, creating
9220 @cindex creating links (hard only)
9221
9222 @command{link} creates a single hard link at a time.
9223 It is a minimalist interface to the system-provided
9224 @code{link} function.  @xref{Hard Links, , , libc,
9225 The GNU C Library Reference Manual}.
9226 It avoids the bells and whistles of the more commonly-used
9227 @command{ln} command (@pxref{ln invocation}).
9228 Synopsis:
9229
9230 @example
9231 link @var{filename} @var{linkname}
9232 @end example
9233
9234 @var{filename} must specify an existing file, and @var{linkname}
9235 must specify a nonexistent entry in an existing directory.
9236 @command{link} simply calls @code{link (@var{filename}, @var{linkname})}
9237 to create the link.
9238
9239 On a GNU system, this command acts like @samp{ln --directory
9240 --no-target-directory @var{filename} @var{linkname}}.  However, the
9241 @option{--directory} and @option{--no-target-directory} options are
9242 not specified by POSIX, and the @command{link} command is
9243 more portable in practice.
9244
9245 If @var{filename} is a symbolic link, it is unspecified whether
9246 @var{linkname} will be a hard link to the symbolic link or to the
9247 target of the symbolic link.  Use @command{ln -P} or @command{ln -L}
9248 to specify which behavior is desired.
9249
9250 @exitstatus
9251
9252
9253 @node ln invocation
9254 @section @command{ln}: Make links between files
9255
9256 @pindex ln
9257 @cindex links, creating
9258 @cindex hard links, creating
9259 @cindex symbolic (soft) links, creating
9260 @cindex creating links (hard or soft)
9261
9262 @cindex file systems and hard links
9263 @command{ln} makes links between files.  By default, it makes hard links;
9264 with the @option{-s} option, it makes symbolic (or @dfn{soft}) links.
9265 Synopses:
9266
9267 @example
9268 ln [@var{option}]@dots{} [-T] @var{target} @var{linkname}
9269 ln [@var{option}]@dots{} @var{target}
9270 ln [@var{option}]@dots{} @var{target}@dots{} @var{directory}
9271 ln [@var{option}]@dots{} -t @var{directory} @var{target}@dots{}
9272 @end example
9273
9274 @itemize @bullet
9275
9276 @item
9277 If two file names are given, @command{ln} creates a link to the first
9278 file from the second.
9279
9280 @item
9281 If one @var{target} is given, @command{ln} creates a link to that file
9282 in the current directory.
9283
9284 @item
9285 If the @option{--target-directory} (@option{-t}) option is given, or
9286 failing that if the last file is a directory and the
9287 @option{--no-target-directory} (@option{-T}) option is not given,
9288 @command{ln} creates a link to each @var{target} file in the specified
9289 directory, using the @var{target}s' names.
9290
9291 @end itemize
9292
9293 Normally @command{ln} does not remove existing files.  Use the
9294 @option{--force} (@option{-f}) option to remove them unconditionally,
9295 the @option{--interactive} (@option{-i}) option to remove them
9296 conditionally, and the @option{--backup} (@option{-b}) option to
9297 rename them.
9298
9299 @cindex hard link, defined
9300 @cindex inode, and hard links
9301 A @dfn{hard link} is another name for an existing file; the link and the
9302 original are indistinguishable.  Technically speaking, they share the
9303 same inode, and the inode contains all the information about a
9304 file---indeed, it is not incorrect to say that the inode @emph{is} the
9305 file.  Most systems prohibit making a hard link to
9306 a directory; on those where it is allowed, only the super-user can do
9307 so (and with caution, since creating a cycle will cause problems to many
9308 other utilities).  Hard links cannot cross file system boundaries.  (These
9309 restrictions are not mandated by POSIX, however.)
9310
9311 @cindex dereferencing symbolic links
9312 @cindex symbolic link, defined
9313 @dfn{Symbolic links} (@dfn{symlinks} for short), on the other hand, are
9314 a special file type (which not all kernels support: System V release 3
9315 (and older) systems lack symlinks) in which the link file actually
9316 refers to a different file, by name.  When most operations (opening,
9317 reading, writing, and so on) are passed the symbolic link file, the
9318 kernel automatically @dfn{dereferences} the link and operates on the
9319 target of the link.  But some operations (e.g., removing) work on the
9320 link file itself, rather than on its target.  The owner and group of a
9321 symlink are not significant to file access performed through
9322 the link, but do have implications on deleting a symbolic link from a
9323 directory with the restricted deletion bit set.  On the GNU system,
9324 the mode of a symlink has no significance and cannot be changed, but
9325 on some BSD systems, the mode can be changed and will affect whether
9326 the symlink will be traversed in file name resolution.  @xref{Symbolic Links,,,
9327 libc, The GNU C Library Reference Manual}.
9328
9329 Symbolic links can contain arbitrary strings; a @dfn{dangling symlink}
9330 occurs when the string in the symlink does not resolve to a file.
9331 There are no restrictions against creating dangling symbolic links.
9332 There are trade-offs to using absolute or relative symlinks.  An
9333 absolute symlink always points to the same file, even if the directory
9334 containing the link is moved.  However, if the symlink is visible from
9335 more than one machine (such as on a networked file system), the file
9336 pointed to might not always be the same.  A relative symbolic link is
9337 resolved in relation to the directory that contains the link, and is
9338 often useful in referring to files on the same device without regards
9339 to what name that device is mounted on when accessed via networked
9340 machines.
9341
9342 When creating a relative symlink in a different location than the
9343 current directory, the resolution of the symlink will be different
9344 than the resolution of the same string from the current directory.
9345 Therefore, many users prefer to first change directories to the
9346 location where the relative symlink will be created, so that
9347 tab-completion or other file resolution will find the same target as
9348 what will be placed in the symlink.
9349
9350 The program accepts the following options.  Also see @ref{Common options}.
9351
9352 @table @samp
9353
9354 @optBackup
9355
9356 @item -d
9357 @itemx -F
9358 @itemx --directory
9359 @opindex -d
9360 @opindex -F
9361 @opindex --directory
9362 @cindex hard links to directories
9363 Allow users with appropriate privileges to attempt to make hard links
9364 to directories.
9365 However, note that this will probably fail due to
9366 system restrictions, even for the super-user.
9367
9368 @item -f
9369 @itemx --force
9370 @opindex -f
9371 @opindex --force
9372 Remove existing destination files.
9373
9374 @item -i
9375 @itemx --interactive
9376 @opindex -i
9377 @opindex --interactive
9378 @cindex prompting, and @command{ln}
9379 Prompt whether to remove existing destination files.
9380
9381 @item -L
9382 @itemx --logical
9383 @opindex -L
9384 @opindex --logical
9385 If @option{-s} is not in effect, and the source file is a symbolic
9386 link, create the hard link to the file referred to by the symbolic
9387 link, rather than the symbolic link itself.
9388
9389 @item -n
9390 @itemx --no-dereference
9391 @opindex -n
9392 @opindex --no-dereference
9393 Do not treat the last operand specially when it is a symbolic link to
9394 a directory.  Instead, treat it as if it were a normal file.
9395
9396 When the destination is an actual directory (not a symlink to one),
9397 there is no ambiguity.  The link is created in that directory.
9398 But when the specified destination is a symlink to a directory,
9399 there are two ways to treat the user's request.  @command{ln} can
9400 treat the destination just as it would a normal directory and create
9401 the link in it.  On the other hand, the destination can be viewed as a
9402 non-directory---as the symlink itself.  In that case, @command{ln}
9403 must delete or backup that symlink before creating the new link.
9404 The default is to treat a destination that is a symlink to a directory
9405 just like a directory.
9406
9407 This option is weaker than the @option{--no-target-directory}
9408 (@option{-T}) option, so it has no effect if both options are given.
9409
9410 @item -P
9411 @itemx --physical
9412 @opindex -P
9413 @opindex --physical
9414 If @option{-s} is not in effect, and the source file is a symbolic
9415 link, create the hard link to the symbolic link itself.  On platforms
9416 where this is not supported by the kernel, this option creates a
9417 symbolic link with identical contents; since symbolic link contents
9418 cannot be edited, any file name resolution performed through either
9419 link will be the same as if a hard link had been created.
9420
9421 @item -r
9422 @itemx --relative
9423 @opindex -r
9424 @opindex --relative
9425 Make symbolic links relative to the link location.
9426
9427 Example:
9428
9429 @smallexample
9430 ln -srv /a/file /tmp
9431 '/tmp/file' -> '../a/file'
9432 @end smallexample
9433
9434 @xref{realpath invocation}, which gives greater control
9435 over relative file name generation.
9436
9437 @item -s
9438 @itemx --symbolic
9439 @opindex -s
9440 @opindex --symbolic
9441 Make symbolic links instead of hard links.  This option merely produces
9442 an error message on systems that do not support symbolic links.
9443
9444 @optBackupSuffix
9445
9446 @optTargetDirectory
9447
9448 @optNoTargetDirectory
9449
9450 @item -v
9451 @itemx --verbose
9452 @opindex -v
9453 @opindex --verbose
9454 Print the name of each file after linking it successfully.
9455
9456 @end table
9457
9458 @cindex hard links to symbolic links
9459 @cindex symbolic links and @command{ln}
9460 If @option{-L} and @option{-P} are both given, the last one takes
9461 precedence.  If @option{-s} is also given, @option{-L} and @option{-P}
9462 are silently ignored.  If neither option is given, then this
9463 implementation defaults to @option{-P} if the system @code{link} supports
9464 hard links to symbolic links (such as the GNU system), and @option{-L}
9465 if @code{link} follows symbolic links (such as on BSD).
9466
9467 @exitstatus
9468
9469 Examples:
9470
9471 @smallexample
9472 Bad Example:
9473
9474 # Create link ../a pointing to a in that directory.
9475 # Not really useful because it points to itself.
9476 ln -s a ..
9477
9478 Better Example:
9479
9480 # Change to the target before creating symlinks to avoid being confused.
9481 cd ..
9482 ln -s adir/a .
9483
9484 Bad Example:
9485
9486 # Hard coded file names don't move well.
9487 ln -s $(pwd)/a /some/dir/
9488
9489 Better Example:
9490
9491 # Relative file names survive directory moves and also
9492 # work across networked file systems.
9493 ln -s afile anotherfile
9494 ln -s ../adir/afile yetanotherfile
9495 @end smallexample
9496
9497
9498 @node mkdir invocation
9499 @section @command{mkdir}: Make directories
9500
9501 @pindex mkdir
9502 @cindex directories, creating
9503 @cindex creating directories
9504
9505 @command{mkdir} creates directories with the specified names.  Synopsis:
9506
9507 @example
9508 mkdir [@var{option}]@dots{} @var{name}@dots{}
9509 @end example
9510
9511 @command{mkdir} creates each directory @var{name} in the order given.
9512 It reports an error if @var{name} already exists, unless the
9513 @option{-p} option is given and @var{name} is a directory.
9514
9515 The program accepts the following options.  Also see @ref{Common options}.
9516
9517 @table @samp
9518
9519 @item -m @var{mode}
9520 @itemx --mode=@var{mode}
9521 @opindex -m
9522 @opindex --mode
9523 @cindex modes of created directories, setting
9524 Set the file permission bits of created directories to @var{mode},
9525 which uses the same syntax as
9526 in @command{chmod} and uses @samp{a=rwx} (read, write and execute allowed for
9527 everyone) for the point of the departure.  @xref{File permissions}.
9528
9529 Normally the directory has the desired file mode bits at the moment it
9530 is created.  As a GNU extension, @var{mode} may also mention
9531 special mode bits, but in this case there may be a temporary window
9532 during which the directory exists but its special mode bits are
9533 incorrect.  @xref{Directory Setuid and Setgid}, for how the
9534 set-user-ID and set-group-ID bits of directories are inherited unless
9535 overridden in this way.
9536
9537 @item -p
9538 @itemx --parents
9539 @opindex -p
9540 @opindex --parents
9541 @cindex parent directories, creating
9542 Make any missing parent directories for each argument, setting their
9543 file permission bits to the umask modified by @samp{u+wx}.  Ignore
9544 existing parent directories, and do not change their file permission
9545 bits.
9546
9547 To set the file permission bits of any newly-created parent
9548 directories to a value that includes @samp{u+wx}, you can set the
9549 umask before invoking @command{mkdir}.  For example, if the shell
9550 command @samp{(umask u=rwx,go=rx; mkdir -p P/Q)} creates the parent
9551 @file{P} it sets the parent's permission bits to @samp{u=rwx,go=rx}.
9552 To set a parent's special mode bits as well, you can invoke
9553 @command{chmod} after @command{mkdir}.  @xref{Directory Setuid and
9554 Setgid}, for how the set-user-ID and set-group-ID bits of
9555 newly-created parent directories are inherited.
9556
9557 @item -v
9558 @itemx --verbose
9559 @opindex -v
9560 @opindex --verbose
9561 Print a message for each created directory.  This is most useful with
9562 @option{--parents}.
9563
9564 @item -Z @var{context}
9565 @itemx --context=@var{context}
9566 @opindex -Z
9567 @opindex --context
9568 @cindex SELinux
9569 @cindex security context
9570 Set the default SELinux security context to be used for created directories.
9571
9572 @end table
9573
9574 @exitstatus
9575
9576
9577 @node mkfifo invocation
9578 @section @command{mkfifo}: Make FIFOs (named pipes)
9579
9580 @pindex mkfifo
9581 @cindex FIFOs, creating
9582 @cindex named pipes, creating
9583 @cindex creating FIFOs (named pipes)
9584
9585 @command{mkfifo} creates FIFOs (also called @dfn{named pipes}) with the
9586 specified names.  Synopsis:
9587
9588 @example
9589 mkfifo [@var{option}] @var{name}@dots{}
9590 @end example
9591
9592 A @dfn{FIFO} is a special file type that permits independent processes
9593 to communicate.  One process opens the FIFO file for writing, and
9594 another for reading, after which data can flow as with the usual
9595 anonymous pipe in shells or elsewhere.
9596
9597 The program accepts the following option.  Also see @ref{Common options}.
9598
9599 @table @samp
9600
9601 @item -m @var{mode}
9602 @itemx --mode=@var{mode}
9603 @opindex -m
9604 @opindex --mode
9605 @cindex modes of created FIFOs, setting
9606 Set the mode of created FIFOs to @var{mode}, which is symbolic as in
9607 @command{chmod} and uses @samp{a=rw} (read and write allowed for everyone)
9608 for the point of departure.  @var{mode} should specify only file
9609 permission bits.  @xref{File permissions}.
9610
9611 @item -Z @var{context}
9612 @itemx --context=@var{context}
9613 @opindex -Z
9614 @opindex --context
9615 @cindex SELinux
9616 @cindex security context
9617 Set the default SELinux security context to be used for created FIFOs.
9618
9619 @end table
9620
9621 @exitstatus
9622
9623
9624 @node mknod invocation
9625 @section @command{mknod}: Make block or character special files
9626
9627 @pindex mknod
9628 @cindex block special files, creating
9629 @cindex character special files, creating
9630
9631 @command{mknod} creates a FIFO, character special file, or block special
9632 file with the specified name.  Synopsis:
9633
9634 @example
9635 mknod [@var{option}]@dots{} @var{name} @var{type} [@var{major} @var{minor}]
9636 @end example
9637
9638 @cindex special files
9639 @cindex block special files
9640 @cindex character special files
9641 Unlike the phrase ``special file type'' above, the term @dfn{special
9642 file} has a technical meaning on Unix: something that can generate or
9643 receive data.  Usually this corresponds to a physical piece of hardware,
9644 e.g., a printer or a disk.  (These files are typically created at
9645 system-configuration time.)  The @command{mknod} command is what creates
9646 files of this type.  Such devices can be read either a character at a
9647 time or a ``block'' (many characters) at a time, hence we say there are
9648 @dfn{block special} files and @dfn{character special} files.
9649
9650 @c mknod is a shell built-in at least with OpenBSD's /bin/sh
9651 @mayConflictWithShellBuiltIn{mknod}
9652
9653 The arguments after @var{name} specify the type of file to make:
9654
9655 @table @samp
9656
9657 @item p
9658 @opindex p @r{for FIFO file}
9659 for a FIFO
9660
9661 @item b
9662 @opindex b @r{for block special file}
9663 for a block special file
9664
9665 @item c
9666 @c Don't document the 'u' option -- it's just a synonym for 'c'.
9667 @c Do *any* versions of mknod still use it?
9668 @c @itemx u
9669 @opindex c @r{for character special file}
9670 @c @opindex u @r{for character special file}
9671 for a character special file
9672
9673 @end table
9674
9675 When making a block or character special file, the major and minor
9676 device numbers must be given after the file type.
9677 If a major or minor device number begins with @samp{0x} or @samp{0X},
9678 it is interpreted as hexadecimal; otherwise, if it begins with @samp{0},
9679 as octal; otherwise, as decimal.
9680
9681 The program accepts the following option.  Also see @ref{Common options}.
9682
9683 @table @samp
9684
9685 @item -m @var{mode}
9686 @itemx --mode=@var{mode}
9687 @opindex -m
9688 @opindex --mode
9689 Set the mode of created files to @var{mode}, which is symbolic as in
9690 @command{chmod} and uses @samp{a=rw} as the point of departure.
9691 @var{mode} should specify only file permission bits.
9692 @xref{File permissions}.
9693
9694 @item -Z @var{context}
9695 @itemx --context=@var{context}
9696 @opindex -Z
9697 @opindex --context
9698 @cindex SELinux
9699 @cindex security context
9700 Set the default SELinux security context to be used for created files.
9701
9702 @end table
9703
9704 @exitstatus
9705
9706
9707 @node readlink invocation
9708 @section @command{readlink}: Print value of a symlink or canonical file name
9709
9710 @pindex readlink
9711 @cindex displaying value of a symbolic link
9712 @cindex canonical file name
9713 @cindex canonicalize a file name
9714 @findex realpath
9715
9716 @command{readlink} may work in one of two supported modes:
9717
9718 @table @samp
9719
9720 @item Readlink mode
9721
9722 @command{readlink} outputs the value of the given symbolic link.
9723 If @command{readlink} is invoked with an argument other than the name
9724 of a symbolic link, it produces no output and exits with a nonzero exit code.
9725
9726 @item Canonicalize mode
9727
9728 @command{readlink} outputs the absolute name of the given file which contains
9729 no @file{.}, @file{..} components nor any repeated separators
9730 (@file{/}) or symbolic links.
9731
9732 @end table
9733
9734 @example
9735 readlink [@var{option}] @var{file}
9736 @end example
9737
9738 By default, @command{readlink} operates in readlink mode.
9739
9740 The program accepts the following options.  Also see @ref{Common options}.
9741
9742 @table @samp
9743
9744 @item -f
9745 @itemx --canonicalize
9746 @opindex -f
9747 @opindex --canonicalize
9748 Activate canonicalize mode.
9749 If any component of the file name except the last one is missing or unavailable,
9750 @command{readlink} produces no output and exits with a nonzero exit
9751 code.  A trailing slash is ignored.
9752
9753 @item -e
9754 @itemx --canonicalize-existing
9755 @opindex -e
9756 @opindex --canonicalize-existing
9757 Activate canonicalize mode.
9758 If any component is missing or unavailable, @command{readlink} produces
9759 no output and exits with a nonzero exit code.  A trailing slash
9760 requires that the name resolve to a directory.
9761
9762 @item -m
9763 @itemx --canonicalize-missing
9764 @opindex -m
9765 @opindex --canonicalize-missing
9766 Activate canonicalize mode.
9767 If any component is missing or unavailable, @command{readlink} treats it
9768 as a directory.
9769
9770 @item -n
9771 @itemx --no-newline
9772 @opindex -n
9773 @opindex --no-newline
9774 Do not output the trailing newline.
9775
9776 @item -s
9777 @itemx -q
9778 @itemx --silent
9779 @itemx --quiet
9780 @opindex -s
9781 @opindex -q
9782 @opindex --silent
9783 @opindex --quiet
9784 Suppress most error messages.
9785
9786 @item -v
9787 @itemx --verbose
9788 @opindex -v
9789 @opindex --verbose
9790 Report error messages.
9791
9792 @end table
9793
9794 The @command{readlink} utility first appeared in OpenBSD 2.1.
9795
9796 The @command{realpath} command without options, operates like
9797 @command{readlink} in canonicalize mode.
9798
9799 @exitstatus
9800
9801
9802 @node rmdir invocation
9803 @section @command{rmdir}: Remove empty directories
9804
9805 @pindex rmdir
9806 @cindex removing empty directories
9807 @cindex directories, removing empty
9808
9809 @command{rmdir} removes empty directories.  Synopsis:
9810
9811 @example
9812 rmdir [@var{option}]@dots{} @var{directory}@dots{}
9813 @end example
9814
9815 If any @var{directory} argument does not refer to an existing empty
9816 directory, it is an error.
9817
9818 The program accepts the following options.  Also see @ref{Common options}.
9819
9820 @table @samp
9821
9822 @item --ignore-fail-on-non-empty
9823 @opindex --ignore-fail-on-non-empty
9824 @cindex directory deletion, ignoring failures
9825 Ignore each failure to remove a directory that is solely because
9826 the directory is non-empty.
9827
9828 @item -p
9829 @itemx --parents
9830 @opindex -p
9831 @opindex --parents
9832 @cindex parent directories, removing
9833 Remove @var{directory}, then try to remove each component of @var{directory}.
9834 So, for example, @samp{rmdir -p a/b/c} is similar to @samp{rmdir a/b/c a/b a}.
9835 As such, it fails if any of those directories turns out not to be empty.
9836 Use the @option{--ignore-fail-on-non-empty} option to make it so such
9837 a failure does not evoke a diagnostic and does not cause @command{rmdir} to
9838 exit unsuccessfully.
9839
9840 @item -v
9841 @itemx --verbose
9842 @opindex -v
9843 @opindex --verbose
9844 @cindex directory deletion, reporting
9845 Give a diagnostic for each successful removal.
9846 @var{directory} is removed.
9847
9848 @end table
9849
9850 @xref{rm invocation}, for how to remove non-empty directories (recursively).
9851
9852 @exitstatus
9853
9854
9855 @node unlink invocation
9856 @section @command{unlink}: Remove files via the unlink syscall
9857
9858 @pindex unlink
9859 @cindex removing files or directories (via the unlink syscall)
9860
9861 @command{unlink} deletes a single specified file name.
9862 It is a minimalist interface to the system-provided
9863 @code{unlink} function.  @xref{Deleting Files, , , libc,
9864 The GNU C Library Reference Manual}.  Synopsis:
9865 It avoids the bells and whistles of the more commonly-used
9866 @command{rm} command (@pxref{rm invocation}).
9867
9868 @example
9869 unlink @var{filename}
9870 @end example
9871
9872 On some systems @code{unlink} can be used to delete the name of a
9873 directory.  On others, it can be used that way only by a privileged user.
9874 In the GNU system @code{unlink} can never delete the name of a directory.
9875
9876 The @command{unlink} command honors the @option{--help} and
9877 @option{--version} options.  To remove a file whose name begins with
9878 @samp{-}, prefix the name with @samp{./}, e.g., @samp{unlink ./--help}.
9879
9880 @exitstatus
9881
9882
9883 @node Changing file attributes
9884 @chapter Changing file attributes
9885
9886 @cindex changing file attributes
9887 @cindex file attributes, changing
9888 @cindex attributes, file
9889
9890 A file is not merely its contents, a name, and a file type
9891 (@pxref{Special file types}).  A file also has an owner (a user ID), a
9892 group (a group ID), permissions (what the owner can do with the file,
9893 what people in the group can do, and what everyone else can do), various
9894 timestamps, and other information.  Collectively, we call these a file's
9895 @dfn{attributes}.
9896
9897 These commands change file attributes.
9898
9899 @menu
9900 * chown invocation::            Change file owners and groups.
9901 * chgrp invocation::            Change file groups.
9902 * chmod invocation::            Change access permissions.
9903 * touch invocation::            Change file timestamps.
9904 @end menu
9905
9906
9907 @node chown invocation
9908 @section @command{chown}: Change file owner and group
9909
9910 @pindex chown
9911 @cindex file ownership, changing
9912 @cindex group ownership, changing
9913 @cindex changing file ownership
9914 @cindex changing group ownership
9915
9916 @command{chown} changes the user and/or group ownership of each given @var{file}
9917 to @var{new-owner} or to the user and group of an existing reference file.
9918 Synopsis:
9919
9920 @example
9921 chown [@var{option}]@dots{} @{@var{new-owner} | --reference=@var{ref_file}@}@c
9922  @var{file}@dots{}
9923 @end example
9924
9925 If used, @var{new-owner} specifies the new owner and/or group as follows
9926 (with no embedded white space):
9927
9928 @example
9929 [@var{owner}] [ : [@var{group}] ]
9930 @end example
9931
9932 Specifically:
9933
9934 @table @var
9935 @item owner
9936 If only an @var{owner} (a user name or numeric user ID) is given, that
9937 user is made the owner of each given file, and the files' group is not
9938 changed.
9939
9940 @item owner@samp{:}group
9941 If the @var{owner} is followed by a colon and a @var{group} (a
9942 group name or numeric group ID), with no spaces between them, the group
9943 ownership of the files is changed as well (to @var{group}).
9944
9945 @item owner@samp{:}
9946 If a colon but no group name follows @var{owner}, that user is
9947 made the owner of the files and the group of the files is changed to
9948 @var{owner}'s login group.
9949
9950 @item @samp{:}group
9951 If the colon and following @var{group} are given, but the owner
9952 is omitted, only the group of the files is changed; in this case,
9953 @command{chown} performs the same function as @command{chgrp}.
9954
9955 @item @samp{:}
9956 If only a colon is given, or if @var{new-owner} is empty, neither the
9957 owner nor the group is changed.
9958
9959 @end table
9960
9961 If @var{owner} or @var{group} is intended to represent a numeric user
9962 or group ID, then you may specify it with a leading @samp{+}.
9963 @xref{Disambiguating names and IDs}.
9964
9965 Some older scripts may still use @samp{.} in place of the @samp{:} separator.
9966 POSIX 1003.1-2001 (@pxref{Standards conformance}) does not
9967 require support for that, but for backward compatibility GNU
9968 @command{chown} supports @samp{.} so long as no ambiguity results.
9969 New scripts should avoid the use of @samp{.} because it is not
9970 portable, and because it has undesirable results if the entire
9971 @var{owner@samp{.}group} happens to identify a user whose name
9972 contains @samp{.}.
9973
9974 The @command{chown} command sometimes clears the set-user-ID or
9975 set-group-ID permission bits.  This behavior depends on the policy and
9976 functionality of the underlying @code{chown} system call, which may
9977 make system-dependent file mode modifications outside the control of
9978 the @command{chown} command.  For example, the @command{chown} command
9979 might not affect those bits when invoked by a user with appropriate
9980 privileges, or when the
9981 bits signify some function other than executable permission (e.g.,
9982 mandatory locking).
9983 When in doubt, check the underlying system behavior.
9984
9985 The program accepts the following options.  Also see @ref{Common options}.
9986
9987 @table @samp
9988
9989 @item -c
9990 @itemx --changes
9991 @opindex -c
9992 @opindex --changes
9993 @cindex changed owners, verbosely describing
9994 Verbosely describe the action for each @var{file} whose ownership
9995 actually changes.
9996
9997 @item -f
9998 @itemx --silent
9999 @itemx --quiet
10000 @opindex -f
10001 @opindex --silent
10002 @opindex --quiet
10003 @cindex error messages, omitting
10004 Do not print error messages about files whose ownership cannot be
10005 changed.
10006
10007 @item @w{@kbd{--from}=@var{old-owner}}
10008 @opindex --from
10009 @cindex symbolic links, changing owner
10010 Change a @var{file}'s ownership only if it has current attributes specified
10011 by @var{old-owner}.  @var{old-owner} has the same form as @var{new-owner}
10012 described above.
10013 This option is useful primarily from a security standpoint in that
10014 it narrows considerably the window of potential abuse.
10015 For example, to reflect a user ID numbering change for one user's files
10016 without an option like this, @code{root} might run
10017
10018 @smallexample
10019 find / -owner OLDUSER -print0 | xargs -0 chown -h NEWUSER
10020 @end smallexample
10021
10022 But that is dangerous because the interval between when the @command{find}
10023 tests the existing file's owner and when the @command{chown} is actually run
10024 may be quite large.
10025 One way to narrow the gap would be to invoke chown for each file
10026 as it is found:
10027
10028 @example
10029 find / -owner OLDUSER -exec chown -h NEWUSER @{@} \;
10030 @end example
10031
10032 But that is very slow if there are many affected files.
10033 With this option, it is safer (the gap is narrower still)
10034 though still not perfect:
10035
10036 @example
10037 chown -h -R --from=OLDUSER NEWUSER /
10038 @end example
10039
10040 @item --dereference
10041 @opindex --dereference
10042 @cindex symbolic links, changing owner
10043 @findex lchown
10044 Do not act on symbolic links themselves but rather on what they point to.
10045 This is the default.
10046
10047 @item -h
10048 @itemx --no-dereference
10049 @opindex -h
10050 @opindex --no-dereference
10051 @cindex symbolic links, changing owner
10052 @findex lchown
10053 Act on symbolic links themselves instead of what they point to.
10054 This mode relies on the @code{lchown} system call.
10055 On systems that do not provide the @code{lchown} system call,
10056 @command{chown} fails when a file specified on the command line
10057 is a symbolic link.
10058 By default, no diagnostic is issued for symbolic links encountered
10059 during a recursive traversal, but see @option{--verbose}.
10060
10061 @item --preserve-root
10062 @opindex --preserve-root
10063 @cindex root directory, disallow recursive modification
10064 Fail upon any attempt to recursively change the root directory, @file{/}.
10065 Without @option{--recursive}, this option has no effect.
10066 @xref{Treating / specially}.
10067
10068 @item --no-preserve-root
10069 @opindex --no-preserve-root
10070 @cindex root directory, allow recursive modification
10071 Cancel the effect of any preceding @option{--preserve-root} option.
10072 @xref{Treating / specially}.
10073
10074 @item --reference=@var{ref_file}
10075 @opindex --reference
10076 Change the user and group of each @var{file} to be the same as those of
10077 @var{ref_file}.  If @var{ref_file} is a symbolic link, do not use the
10078 user and group of the symbolic link, but rather those of the file it
10079 refers to.
10080
10081 @item -v
10082 @itemx --verbose
10083 @opindex -v
10084 @opindex --verbose
10085 Output a diagnostic for every file processed.
10086 If a symbolic link is encountered during a recursive traversal
10087 on a system without the @code{lchown} system call, and @option{--no-dereference}
10088 is in effect, then issue a diagnostic saying neither the symbolic link nor
10089 its referent is being changed.
10090
10091 @item -R
10092 @itemx --recursive
10093 @opindex -R
10094 @opindex --recursive
10095 @cindex recursively changing file ownership
10096 Recursively change ownership of directories and their contents.
10097
10098 @choptH
10099 @xref{Traversing symlinks}.
10100
10101 @choptL
10102 @xref{Traversing symlinks}.
10103
10104 @choptP
10105 @xref{Traversing symlinks}.
10106
10107 @end table
10108
10109 @exitstatus
10110
10111 Examples:
10112
10113 @smallexample
10114 # Change the owner of /u to "root".
10115 chown root /u
10116
10117 # Likewise, but also change its group to "staff".
10118 chown root:staff /u
10119
10120 # Change the owner of /u and subfiles to "root".
10121 chown -hR root /u
10122 @end smallexample
10123
10124
10125 @node chgrp invocation
10126 @section @command{chgrp}: Change group ownership
10127
10128 @pindex chgrp
10129 @cindex group ownership, changing
10130 @cindex changing group ownership
10131
10132 @command{chgrp} changes the group ownership of each given @var{file}
10133 to @var{group} (which can be either a group name or a numeric group ID)
10134 or to the group of an existing reference file.  Synopsis:
10135
10136 @example
10137 chgrp [@var{option}]@dots{} @{@var{group} | --reference=@var{ref_file}@}@c
10138  @var{file}@dots{}
10139 @end example
10140
10141 If @var{group} is intended to represent a
10142 numeric group ID, then you may specify it with a leading @samp{+}.
10143 @xref{Disambiguating names and IDs}.
10144
10145 The program accepts the following options.  Also see @ref{Common options}.
10146
10147 @table @samp
10148
10149 @item -c
10150 @itemx --changes
10151 @opindex -c
10152 @opindex --changes
10153 @cindex changed files, verbosely describing
10154 Verbosely describe the action for each @var{file} whose group actually
10155 changes.
10156
10157 @item -f
10158 @itemx --silent
10159 @itemx --quiet
10160 @opindex -f
10161 @opindex --silent
10162 @opindex --quiet
10163 @cindex error messages, omitting
10164 Do not print error messages about files whose group cannot be
10165 changed.
10166
10167 @item --dereference
10168 @opindex --dereference
10169 @cindex symbolic links, changing owner
10170 @findex lchown
10171 Do not act on symbolic links themselves but rather on what they point to.
10172 This is the default.
10173
10174 @item -h
10175 @itemx --no-dereference
10176 @opindex -h
10177 @opindex --no-dereference
10178 @cindex symbolic links, changing group
10179 @findex lchown
10180 Act on symbolic links themselves instead of what they point to.
10181 This mode relies on the @code{lchown} system call.
10182 On systems that do not provide the @code{lchown} system call,
10183 @command{chgrp} fails when a file specified on the command line
10184 is a symbolic link.
10185 By default, no diagnostic is issued for symbolic links encountered
10186 during a recursive traversal, but see @option{--verbose}.
10187
10188 @item --preserve-root
10189 @opindex --preserve-root
10190 @cindex root directory, disallow recursive modification
10191 Fail upon any attempt to recursively change the root directory, @file{/}.
10192 Without @option{--recursive}, this option has no effect.
10193 @xref{Treating / specially}.
10194
10195 @item --no-preserve-root
10196 @opindex --no-preserve-root
10197 @cindex root directory, allow recursive modification
10198 Cancel the effect of any preceding @option{--preserve-root} option.
10199 @xref{Treating / specially}.
10200
10201 @item --reference=@var{ref_file}
10202 @opindex --reference
10203 Change the group of each @var{file} to be the same as that of
10204 @var{ref_file}.  If @var{ref_file} is a symbolic link, do not use the
10205 group of the symbolic link, but rather that of the file it refers to.
10206
10207 @item -v
10208 @itemx --verbose
10209 @opindex -v
10210 @opindex --verbose
10211 Output a diagnostic for every file processed.
10212 If a symbolic link is encountered during a recursive traversal
10213 on a system without the @code{lchown} system call, and @option{--no-dereference}
10214 is in effect, then issue a diagnostic saying neither the symbolic link nor
10215 its referent is being changed.
10216
10217 @item -R
10218 @itemx --recursive
10219 @opindex -R
10220 @opindex --recursive
10221 @cindex recursively changing group ownership
10222 Recursively change the group ownership of directories and their contents.
10223
10224 @choptH
10225 @xref{Traversing symlinks}.
10226
10227 @choptL
10228 @xref{Traversing symlinks}.
10229
10230 @choptP
10231 @xref{Traversing symlinks}.
10232
10233 @end table
10234
10235 @exitstatus
10236
10237 Examples:
10238
10239 @smallexample
10240 # Change the group of /u to "staff".
10241 chgrp staff /u
10242
10243 # Change the group of /u and subfiles to "staff".
10244 chgrp -hR staff /u
10245 @end smallexample
10246
10247
10248 @node chmod invocation
10249 @section @command{chmod}: Change access permissions
10250
10251 @pindex chmod
10252 @cindex changing access permissions
10253 @cindex access permissions, changing
10254 @cindex permissions, changing access
10255
10256 @command{chmod} changes the access permissions of the named files.  Synopsis:
10257
10258 @example
10259 chmod [@var{option}]@dots{} @{@var{mode} | --reference=@var{ref_file}@}@c
10260  @var{file}@dots{}
10261 @end example
10262
10263 @cindex symbolic links, permissions of
10264 @command{chmod} never changes the permissions of symbolic links, since
10265 the @command{chmod} system call cannot change their permissions.
10266 This is not a problem since the permissions of symbolic links are
10267 never used.  However, for each symbolic link listed on the command
10268 line, @command{chmod} changes the permissions of the pointed-to file.
10269 In contrast, @command{chmod} ignores symbolic links encountered during
10270 recursive directory traversals.
10271
10272 A successful use of @command{chmod} clears the set-group-ID bit of a
10273 regular file if the file's group ID does not match the user's
10274 effective group ID or one of the user's supplementary group IDs,
10275 unless the user has appropriate privileges.  Additional restrictions
10276 may cause the set-user-ID and set-group-ID bits of @var{mode} or
10277 @var{ref_file} to be ignored.  This behavior depends on the policy and
10278 functionality of the underlying @code{chmod} system call.  When in
10279 doubt, check the underlying system behavior.
10280
10281 If used, @var{mode} specifies the new file mode bits.
10282 For details, see the section on @ref{File permissions}.
10283 If you really want @var{mode} to have a leading @samp{-}, you should
10284 use @option{--} first, e.g., @samp{chmod -- -w file}.  Typically,
10285 though, @samp{chmod a-w file} is preferable, and @command{chmod -w
10286 file} (without the @option{--}) complains if it behaves differently
10287 from what @samp{chmod a-w file} would do.
10288
10289 The program accepts the following options.  Also see @ref{Common options}.
10290
10291 @table @samp
10292
10293 @item -c
10294 @itemx --changes
10295 @opindex -c
10296 @opindex --changes
10297 Verbosely describe the action for each @var{file} whose permissions
10298 actually changes.
10299
10300 @item -f
10301 @itemx --silent
10302 @itemx --quiet
10303 @opindex -f
10304 @opindex --silent
10305 @opindex --quiet
10306 @cindex error messages, omitting
10307 Do not print error messages about files whose permissions cannot be
10308 changed.
10309
10310 @item --preserve-root
10311 @opindex --preserve-root
10312 @cindex root directory, disallow recursive modification
10313 Fail upon any attempt to recursively change the root directory, @file{/}.
10314 Without @option{--recursive}, this option has no effect.
10315 @xref{Treating / specially}.
10316
10317 @item --no-preserve-root
10318 @opindex --no-preserve-root
10319 @cindex root directory, allow recursive modification
10320 Cancel the effect of any preceding @option{--preserve-root} option.
10321 @xref{Treating / specially}.
10322
10323 @item -v
10324 @itemx --verbose
10325 @opindex -v
10326 @opindex --verbose
10327 Verbosely describe the action or non-action taken for every @var{file}.
10328
10329 @item --reference=@var{ref_file}
10330 @opindex --reference
10331 Change the mode of each @var{file} to be the same as that of @var{ref_file}.
10332 @xref{File permissions}.
10333 If @var{ref_file} is a symbolic link, do not use the mode
10334 of the symbolic link, but rather that of the file it refers to.
10335
10336 @item -R
10337 @itemx --recursive
10338 @opindex -R
10339 @opindex --recursive
10340 @cindex recursively changing access permissions
10341 Recursively change permissions of directories and their contents.
10342
10343 @end table
10344
10345 @exitstatus
10346
10347
10348 @node touch invocation
10349 @section @command{touch}: Change file timestamps
10350
10351 @pindex touch
10352 @cindex changing file timestamps
10353 @cindex file timestamps, changing
10354 @cindex timestamps, changing file
10355
10356 @command{touch} changes the access and/or modification times of the
10357 specified files.  Synopsis:
10358
10359 @example
10360 touch [@var{option}]@dots{} @var{file}@dots{}
10361 @end example
10362
10363 @cindex empty files, creating
10364 Any @var{file} argument that does not exist is created empty, unless
10365 option @option{--no-create} (@option{-c}) or @option{--no-dereference}
10366 (@option{-h}) was in effect.
10367
10368 A @var{file} argument string of @samp{-} is handled specially and
10369 causes @command{touch} to change the times of the file associated with
10370 standard output.
10371
10372 @cindex clock skew
10373 By default, @command{touch} sets file timestamps to the current time.
10374 Because @command{touch} acts on its operands left to right, the
10375 resulting timestamps of earlier and later operands may disagree.
10376 Also, the determination of what time is ``current'' depends on the
10377 platform.  Platforms with network file systems often use different
10378 clocks for the operating system and for file systems; because
10379 @command{touch} typically uses file systems' clocks by default, clock
10380 skew can cause the resulting file timestamps to appear to be in a
10381 program's ``future'' or ``past''.
10382
10383 @cindex file timestamp resolution
10384 The @command{touch} command sets the file's timestamp to the greatest
10385 representable value that is not greater than the requested time.  This
10386 can differ from the requested time for several reasons.  First, the
10387 requested time may have a higher resolution than supported.  Second, a
10388 file system may use different resolutions for different types of
10389 times.  Third, file timestamps may use a different resolution than
10390 operating system timestamps.  Fourth, the operating system primitives
10391 used to update timestamps may employ yet a different resolution.  For
10392 example, in theory a file system might use 10-microsecond resolution
10393 for access time and 100-nanosecond resolution for modification time,
10394 and the operating system might use nanosecond resolution for the
10395 current time and microsecond resolution for the primitive that
10396 @command{touch} uses to set a file's timestamp to an arbitrary value.
10397
10398 @cindex permissions, for changing file timestamps
10399 When setting file timestamps to the current time, @command{touch} can
10400 change the timestamps for files that the user does not own but has
10401 write permission for.  Otherwise, the user must own the files.  Some
10402 older systems have a further restriction: the user must own the files
10403 unless both the access and modification times are being set to the
10404 current time.
10405
10406 Although @command{touch} provides options for changing two of the times---the
10407 times of last access and modification---of a file, there is actually
10408 a standard third one as well: the inode change time.  This is often
10409 referred to as a file's @code{ctime}.
10410 The inode change time represents the time when the file's meta-information
10411 last changed.  One common example of this is when the permissions of a
10412 file change.  Changing the permissions doesn't access the file, so
10413 the atime doesn't change, nor does it modify the file, so the mtime
10414 doesn't change.  Yet, something about the file itself has changed,
10415 and this must be noted somewhere.  This is the job of the ctime field.
10416 This is necessary, so that, for example, a backup program can make a
10417 fresh copy of the file, including the new permissions value.
10418 Another operation that modifies a file's ctime without affecting
10419 the others is renaming.  In any case, it is not possible, in normal
10420 operations, for a user to change the ctime field to a user-specified value.
10421 Some operating systems and file systems support a fourth time: the
10422 birth time, when the file was first created; by definition, this
10423 timestamp never changes.
10424
10425 @vindex TZ
10426 Time stamps assume the time zone rules specified by the @env{TZ}
10427 environment variable, or by the system default rules if @env{TZ} is
10428 not set.  @xref{TZ Variable,, Specifying the Time Zone with @env{TZ},
10429 libc, The GNU C Library Reference Manual}.
10430 You can avoid ambiguities during
10431 daylight saving transitions by using @sc{utc} time stamps.
10432
10433 The program accepts the following options.  Also see @ref{Common options}.
10434
10435 @table @samp
10436
10437 @item -a
10438 @itemx --time=atime
10439 @itemx --time=access
10440 @itemx --time=use
10441 @opindex -a
10442 @opindex --time
10443 @opindex atime@r{, changing}
10444 @opindex access @r{time, changing}
10445 @opindex use @r{time, changing}
10446 Change the access time only.
10447
10448 @item -c
10449 @itemx --no-create
10450 @opindex -c
10451 @opindex --no-create
10452 Do not warn about or create files that do not exist.
10453
10454 @item -d
10455 @itemx --date=@var{time}
10456 @opindex -d
10457 @opindex --date
10458 @opindex time
10459 Use @var{time} instead of the current time.  It can contain month names,
10460 time zones, @samp{am} and @samp{pm}, @samp{yesterday}, etc.  For
10461 example, @option{--date="2004-02-27 14:19:13.489392193 +0530"}
10462 specifies the instant of time that is 489,392,193 nanoseconds after
10463 February 27, 2004 at 2:19:13 PM in a time zone that is 5 hours and 30
10464 minutes east of UTC@.  @xref{Date input formats}.
10465 File systems that do not support high-resolution time stamps
10466 silently ignore any excess precision here.
10467
10468 @item -f
10469 @opindex -f
10470 @cindex BSD @command{touch} compatibility
10471 Ignored; for compatibility with BSD versions of @command{touch}.
10472
10473 @item -h
10474 @itemx --no-dereference
10475 @opindex -h
10476 @opindex --no-dereference
10477 @cindex symbolic links, changing time
10478 @findex lutimes
10479 Attempt to change the timestamps of a symbolic link, rather than what
10480 the link refers to.  When using this option, empty files are not
10481 created, but option @option{-c} must also be used to avoid warning
10482 about files that do not exist.  Not all systems support changing the
10483 timestamps of symlinks, since underlying system support for this
10484 action was not required until POSIX 2008.  Also, on some
10485 systems, the mere act of examining a symbolic link changes the access
10486 time, such that only changes to the modification time will persist
10487 long enough to be observable.  When coupled with option @option{-r}, a
10488 reference timestamp is taken from a symbolic link rather than the file
10489 it refers to.
10490
10491 @item -m
10492 @itemx --time=mtime
10493 @itemx --time=modify
10494 @opindex -m
10495 @opindex --time
10496 @opindex mtime@r{, changing}
10497 @opindex modify @r{time, changing}
10498 Change the modification time only.
10499
10500 @item -r @var{file}
10501 @itemx --reference=@var{file}
10502 @opindex -r
10503 @opindex --reference
10504 Use the times of the reference @var{file} instead of the current time.
10505 If this option is combined with the @option{--date=@var{time}}
10506 (@option{-d @var{time}}) option, the reference @var{file}'s time is
10507 the origin for any relative @var{time}s given, but is otherwise ignored.
10508 For example, @samp{-r foo -d '-5 seconds'} specifies a time stamp
10509 equal to five seconds before the corresponding time stamp for @file{foo}.
10510 If @var{file} is a symbolic link, the reference timestamp is taken
10511 from the target of the symlink, unless @option{-h} was also in effect.
10512
10513 @item -t [[@var{cc}]@var{yy}]@var{mmddhhmm}[.@var{ss}]
10514 @cindex leap seconds
10515 Use the argument (optional four-digit or two-digit years, months,
10516 days, hours, minutes, optional seconds) instead of the current time.
10517 If the year is specified with only two digits, then @var{cc}
10518 is 20 for years in the range 0 @dots{} 68, and 19 for years in
10519 69 @dots{} 99.  If no digits of the year are specified,
10520 the argument is interpreted as a date in the current year.
10521 On the atypical systems that support leap seconds, @var{ss} may be
10522 @samp{60}.
10523
10524 @end table
10525
10526 @vindex _POSIX2_VERSION
10527 On older systems, @command{touch} supports an obsolete syntax, as follows.
10528 If no timestamp is given with any of the @option{-d}, @option{-r}, or
10529 @option{-t} options, and if there are two or more @var{file}s and the
10530 first @var{file} is of the form @samp{@var{mmddhhmm}[@var{yy}]} and this
10531 would be a valid argument to the @option{-t} option (if the @var{yy}, if
10532 any, were moved to the front), and if the represented year
10533 is in the range 1969--1999, that argument is interpreted as the time
10534 for the other files instead of as a file name.
10535 This obsolete behavior can be enabled or disabled with the
10536 @env{_POSIX2_VERSION} environment variable (@pxref{Standards
10537 conformance}), but portable scripts should avoid commands whose
10538 behavior depends on this variable.
10539 For example, use @samp{touch ./12312359 main.c} or @samp{touch -t
10540 12312359 main.c} rather than the ambiguous @samp{touch 12312359 main.c}.
10541
10542 @exitstatus
10543
10544
10545 @node Disk usage
10546 @chapter Disk usage
10547
10548 @cindex disk usage
10549
10550 No disk can hold an infinite amount of data.  These commands report
10551 how much disk storage is in use or available, report other file and
10552 file status information, and write buffers to disk.
10553
10554 @menu
10555 * df invocation::               Report file system disk space usage.
10556 * du invocation::               Estimate file space usage.
10557 * stat invocation::             Report file or file system status.
10558 * sync invocation::             Synchronize memory and disk.
10559 * truncate invocation::         Shrink or extend the size of a file.
10560 @end menu
10561
10562
10563 @node df invocation
10564 @section @command{df}: Report file system disk space usage
10565
10566 @pindex df
10567 @cindex file system disk usage
10568 @cindex disk usage by file system
10569
10570 @command{df} reports the amount of disk space used and available on
10571 file systems.  Synopsis:
10572
10573 @example
10574 df [@var{option}]@dots{} [@var{file}]@dots{}
10575 @end example
10576
10577 With no arguments, @command{df} reports the space used and available on all
10578 currently mounted file systems (of all types).  Otherwise, @command{df}
10579 reports on the file system containing each argument @var{file}.
10580
10581 Normally the disk space is printed in units of
10582 1024 bytes, but this can be overridden (@pxref{Block size}).
10583 Non-integer quantities are rounded up to the next higher unit.
10584
10585 @cindex disk device file
10586 @cindex device file, disk
10587 If an argument @var{file} is a disk device file containing a mounted
10588 file system, @command{df} shows the space available on that file system
10589 rather than on the file system containing the device node (i.e., the root
10590 file system).  @sc{gnu} @command{df} does not attempt to determine the
10591 disk usage
10592 on unmounted file systems, because on most kinds of systems doing so
10593 requires extremely nonportable intimate knowledge of file system
10594 structures.
10595
10596 The program accepts the following options.  Also see @ref{Common options}.
10597
10598 @table @samp
10599
10600 @item -a
10601 @itemx --all
10602 @opindex -a
10603 @opindex --all
10604 @cindex automounter file systems
10605 @cindex ignore file systems
10606 Include in the listing dummy file systems, which
10607 are omitted by default.  Such file systems are typically special-purpose
10608 pseudo-file-systems, such as automounter entries.
10609
10610 @item -B @var{size}
10611 @itemx --block-size=@var{size}
10612 @opindex -B
10613 @opindex --block-size
10614 @cindex file system sizes
10615 Scale sizes by @var{size} before printing them (@pxref{Block size}).
10616 For example, @option{-BG} prints sizes in units of 1,073,741,824 bytes.
10617
10618 @item --total
10619 @opindex --total
10620 @cindex grand total of disk size, usage and available space
10621 Print a grand total of all arguments after all arguments have
10622 been processed.  This can be used to find out the total disk size, usage
10623 and available space of all listed devices.
10624
10625 @optHumanReadable
10626
10627 @item -H
10628 @opindex -H
10629 Equivalent to @option{--si}.
10630
10631 @item -i
10632 @itemx --inodes
10633 @opindex -i
10634 @opindex --inodes
10635 @cindex inode usage
10636 List inode usage information instead of block usage.  An inode (short
10637 for index node) contains information about a file such as its owner,
10638 permissions, timestamps, and location on the disk.
10639
10640 @item -k
10641 @opindex -k
10642 @cindex kibibytes for file system sizes
10643 Print sizes in 1024-byte blocks, overriding the default block size
10644 (@pxref{Block size}).
10645 This option is equivalent to @option{--block-size=1K}.
10646
10647 @item -l
10648 @itemx --local
10649 @opindex -l
10650 @opindex --local
10651 @cindex file system types, limiting output to certain
10652 Limit the listing to local file systems.  By default, remote file systems
10653 are also listed.
10654
10655 @item --no-sync
10656 @opindex --no-sync
10657 @cindex file system space, retrieving old data more quickly
10658 Do not invoke the @code{sync} system call before getting any usage data.
10659 This may make @command{df} run significantly faster on systems with many
10660 disks, but on some systems (notably SunOS) the results may be slightly
10661 out of date.  This is the default.
10662
10663 @item -P
10664 @itemx --portability
10665 @opindex -P
10666 @opindex --portability
10667 @cindex one-line output format
10668 @cindex POSIX output format
10669 @cindex portable output format
10670 @cindex output format, portable
10671 Use the POSIX output format.  This is like the default format except
10672 for the following:
10673
10674 @enumerate
10675 @item
10676 The information about each file system is always printed on exactly
10677 one line; a mount device is never put on a line by itself.  This means
10678 that if the mount device name is more than 20 characters long (e.g., for
10679 some network mounts), the columns are misaligned.
10680
10681 @item
10682 The labels in the header output line are changed to conform to POSIX.
10683
10684 @item
10685 The default block size and output format are unaffected by the
10686 @env{DF_BLOCK_SIZE}, @env{BLOCK_SIZE} and @env{BLOCKSIZE} environment
10687 variables.  However, the default block size is still affected by
10688 @env{POSIXLY_CORRECT}: it is 512 if @env{POSIXLY_CORRECT} is set, 1024
10689 otherwise.  @xref{Block size}.
10690 @end enumerate
10691
10692 @optSi
10693
10694 @item --sync
10695 @opindex --sync
10696 @cindex file system space, retrieving current data more slowly
10697 Invoke the @code{sync} system call before getting any usage data.  On
10698 some systems (notably SunOS), doing this yields more up to date results,
10699 but in general this option makes @command{df} much slower, especially when
10700 there are many or very busy file systems.
10701
10702 @item -t @var{fstype}
10703 @itemx --type=@var{fstype}
10704 @opindex -t
10705 @opindex --type
10706 @cindex file system types, limiting output to certain
10707 Limit the listing to file systems of type @var{fstype}.  Multiple
10708 file system types can be specified by giving multiple @option{-t} options.
10709 By default, nothing is omitted.
10710
10711 @item -T
10712 @itemx --print-type
10713 @opindex -T
10714 @opindex --print-type
10715 @cindex file system types, printing
10716 Print each file system's type.  The types printed here are the same ones
10717 you can include or exclude with @option{-t} and @option{-x}.  The particular
10718 types printed are whatever is supported by the system.  Here are some of
10719 the common names (this list is certainly not exhaustive):
10720
10721 @table @samp
10722
10723 @item nfs
10724 @cindex NFS file system type
10725 An NFS file system, i.e., one mounted over a network from another
10726 machine.  This is the one type name which seems to be used uniformly by
10727 all systems.
10728
10729 @item 4.2@r{, }ufs@r{, }efs@dots{}
10730 @cindex Linux file system types
10731 @cindex local file system types
10732 @opindex 4.2 @r{file system type}
10733 @opindex ufs @r{file system type}
10734 @opindex efs @r{file system type}
10735 A file system on a locally-mounted hard disk.  (The system might even
10736 support more than one type here; Linux does.)
10737
10738 @item hsfs@r{, }cdfs
10739 @cindex CD-ROM file system type
10740 @cindex High Sierra file system
10741 @opindex hsfs @r{file system type}
10742 @opindex cdfs @r{file system type}
10743 A file system on a CD-ROM drive.  HP-UX uses @samp{cdfs}, most other
10744 systems use @samp{hsfs} (@samp{hs} for ``High Sierra'').
10745
10746 @item pcfs
10747 @cindex PC file system
10748 @cindex DOS file system
10749 @cindex MS-DOS file system
10750 @cindex diskette file system
10751 @opindex pcfs
10752 An MS-DOS file system, usually on a diskette.
10753
10754 @end table
10755
10756 @item -x @var{fstype}
10757 @itemx --exclude-type=@var{fstype}
10758 @opindex -x
10759 @opindex --exclude-type
10760 Limit the listing to file systems not of type @var{fstype}.
10761 Multiple file system types can be eliminated by giving multiple
10762 @option{-x} options.  By default, no file system types are omitted.
10763
10764 @item -v
10765 Ignored; for compatibility with System V versions of @command{df}.
10766
10767 @end table
10768
10769 @exitstatus
10770 Failure includes the case where no output is generated, so you can
10771 inspect the exit status of a command like @samp{df -t ext3 -t reiserfs
10772 @var{dir}} to test whether @var{dir} is on a file system of type
10773 @samp{ext3} or @samp{reiserfs}.
10774
10775 Since the list of file systems (@var{mtab}) is needed to determine the
10776 file system type, failure includes the cases when that list cannot
10777 be read and one or more of the options @option{-a}, @option{-l}, @option{-t}
10778 or @option{-x} is used together with a file name argument.
10779
10780
10781 @node du invocation
10782 @section @command{du}: Estimate file space usage
10783
10784 @pindex du
10785 @cindex file space usage
10786 @cindex disk usage for files
10787
10788 @command{du} reports the amount of disk space used by the specified files
10789 and for each subdirectory (of directory arguments).  Synopsis:
10790
10791 @example
10792 du [@var{option}]@dots{} [@var{file}]@dots{}
10793 @end example
10794
10795 With no arguments, @command{du} reports the disk space for the current
10796 directory.  Normally the disk space is printed in units of
10797 1024 bytes, but this can be overridden (@pxref{Block size}).
10798 Non-integer quantities are rounded up to the next higher unit.
10799
10800 If two or more hard links point to the same file, only one of the hard
10801 links is counted.  The @var{file} argument order affects which links
10802 are counted, and changing the argument order may change the numbers
10803 that @command{du} outputs.
10804
10805 The program accepts the following options.  Also see @ref{Common options}.
10806
10807 @table @samp
10808
10809 @item -a
10810 @itemx --all
10811 @opindex -a
10812 @opindex --all
10813 Show counts for all files, not just directories.
10814
10815 @item --apparent-size
10816 @opindex --apparent-size
10817 Print apparent sizes, rather than disk usage.  The apparent size of a
10818 file is the number of bytes reported by @code{wc -c} on regular files,
10819 or more generally, @code{ls -l --block-size=1} or @code{stat --format=%s}.
10820 For example, a file containing the word @samp{zoo} with no newline would,
10821 of course, have an apparent size of 3.  Such a small file may require
10822 anywhere from 0 to 16 KiB or more of disk space, depending on
10823 the type and configuration of the file system on which the file resides.
10824 However, a sparse file created with this command:
10825
10826 @example
10827 dd bs=1 seek=2GiB if=/dev/null of=big
10828 @end example
10829
10830 @noindent
10831 has an apparent size of 2 GiB, yet on most modern
10832 systems, it actually uses almost no disk space.
10833
10834 @item -b
10835 @itemx --bytes
10836 @opindex -b
10837 @opindex --bytes
10838 Equivalent to @code{--apparent-size --block-size=1}.
10839
10840 @item -B @var{size}
10841 @itemx --block-size=@var{size}
10842 @opindex -B
10843 @opindex --block-size
10844 @cindex file sizes
10845 Scale sizes by @var{size} before printing them (@pxref{Block size}).
10846 For example, @option{-BG} prints sizes in units of 1,073,741,824 bytes.
10847
10848 @item -c
10849 @itemx --total
10850 @opindex -c
10851 @opindex --total
10852 @cindex grand total of disk space
10853 Print a grand total of all arguments after all arguments have
10854 been processed.  This can be used to find out the total disk usage of
10855 a given set of files or directories.
10856
10857 @item -D
10858 @itemx --dereference-args
10859 @opindex -D
10860 @opindex --dereference-args
10861 Dereference symbolic links that are command line arguments.
10862 Does not affect other symbolic links.  This is helpful for finding
10863 out the disk usage of directories, such as @file{/usr/tmp}, which
10864 are often symbolic links.
10865
10866 @c --files0-from=FILE
10867 @filesZeroFromOption{du,, with the @option{--total} (@option{-c}) option}
10868
10869 @optHumanReadable
10870
10871 @item -H
10872 @opindex -H
10873 Equivalent to @option{--dereference-args} (@option{-D}).
10874
10875 @item -k
10876 @opindex -k
10877 @cindex kibibytes for file sizes
10878 Print sizes in 1024-byte blocks, overriding the default block size
10879 (@pxref{Block size}).
10880 This option is equivalent to @option{--block-size=1K}.
10881
10882 @item -l
10883 @itemx --count-links
10884 @opindex -l
10885 @opindex --count-links
10886 @cindex hard links, counting in @command{du}
10887 Count the size of all files, even if they have appeared already (as a
10888 hard link).
10889
10890 @item -L
10891 @itemx --dereference
10892 @opindex -L
10893 @opindex --dereference
10894 @cindex symbolic links, dereferencing in @command{du}
10895 Dereference symbolic links (show the disk space used by the file
10896 or directory that the link points to instead of the space used by
10897 the link).
10898
10899 @item -m
10900 @opindex -m
10901 @cindex mebibytes for file sizes
10902 Print sizes in 1,048,576-byte blocks, overriding the default block size
10903 (@pxref{Block size}).
10904 This option is equivalent to @option{--block-size=1M}.
10905
10906 @item -P
10907 @itemx --no-dereference
10908 @opindex -P
10909 @opindex --no-dereference
10910 @cindex symbolic links, dereferencing in @command{du}
10911 For each symbolic links encountered by @command{du},
10912 consider the disk space used by the symbolic link.
10913
10914 @item -d @var{depth}
10915 @item --max-depth=@var{depth}
10916 @opindex -d @var{depth}
10917 @opindex --max-depth=@var{depth}
10918 @cindex limiting output of @command{du}
10919 Show the total for each directory (and file if --all) that is at
10920 most MAX_DEPTH levels down from the root of the hierarchy.  The root
10921 is at level 0, so @code{du --max-depth=0} is equivalent to @code{du -s}.
10922
10923 @optNull{du}
10924
10925 @optSi
10926
10927 @item -s
10928 @itemx --summarize
10929 @opindex -s
10930 @opindex --summarize
10931 Display only a total for each argument.
10932
10933 @item -S
10934 @itemx --separate-dirs
10935 @opindex -S
10936 @opindex --separate-dirs
10937 Normally, in the output of @command{du} (when not using @option{--summarize}),
10938 the size listed next to a directory name, @var{d}, represents the sum
10939 of sizes of all entries beneath @var{d} as well as the size of @var{d} itself.
10940 With @option{--separate-dirs}, the size reported for a directory name,
10941 @var{d}, is merely the @code{stat.st_size}-derived size of the directory
10942 entry, @var{d}.
10943
10944 @item --time
10945 @opindex --time
10946 @cindex last modified dates, displaying in @command{du}
10947 Show time of the most recent modification of any file in the directory,
10948 or any of its subdirectories.
10949
10950 @item --time=ctime
10951 @itemx --time=status
10952 @itemx --time=use
10953 @opindex --time
10954 @opindex ctime@r{, show the most recent}
10955 @opindex status time@r{, show the most recent}
10956 @opindex use time@r{, show the most recent}
10957 Show the most recent status change time (the @samp{ctime} in the inode) of
10958 any file in the directory, instead of the modification time.
10959
10960 @item --time=atime
10961 @itemx --time=access
10962 @opindex --time
10963 @opindex atime@r{, show the most recent}
10964 @opindex access time@r{, show the most recent}
10965 Show the most recent access time (the @samp{atime} in the inode) of
10966 any file in the directory, instead of the modification time.
10967
10968 @item --time-style=@var{style}
10969 @opindex --time-style
10970 @cindex time style
10971 List timestamps in style @var{style}.  This option has an effect only if
10972 the @option{--time} option is also specified.  The @var{style} should
10973 be one of the following:
10974
10975 @table @samp
10976 @item +@var{format}
10977 @vindex LC_TIME
10978 List timestamps using @var{format}, where @var{format} is interpreted
10979 like the format argument of @command{date} (@pxref{date invocation}).
10980 For example, @option{--time-style="+%Y-%m-%d %H:%M:%S"} causes
10981 @command{du} to list timestamps like @samp{2002-03-30 23:45:56}.  As
10982 with @command{date}, @var{format}'s interpretation is affected by the
10983 @env{LC_TIME} locale category.
10984
10985 @item full-iso
10986 List timestamps in full using ISO 8601 date, time, and time zone
10987 format with nanosecond precision, e.g., @samp{2002-03-30
10988 23:45:56.477817180 -0700}.  This style is equivalent to
10989 @samp{+%Y-%m-%d %H:%M:%S.%N %z}.
10990
10991 @item long-iso
10992 List ISO 8601 date and time in minutes, e.g.,
10993 @samp{2002-03-30 23:45}.  These timestamps are shorter than
10994 @samp{full-iso} timestamps, and are usually good enough for everyday
10995 work.  This style is equivalent to @samp{+%Y-%m-%d %H:%M}.
10996
10997 @item iso
10998 List ISO 8601 dates for timestamps, e.g., @samp{2002-03-30}.
10999 This style is equivalent to @samp{+%Y-%m-%d}.
11000 @end table
11001
11002 @vindex TIME_STYLE
11003 You can specify the default value of the @option{--time-style} option
11004 with the environment variable @env{TIME_STYLE}; if @env{TIME_STYLE} is not set
11005 the default style is @samp{long-iso}.  For compatibility with @command{ls},
11006 if @env{TIME_STYLE} begins with @samp{+} and contains a newline,
11007 the newline and any later characters are ignored; if @env{TIME_STYLE}
11008 begins with @samp{posix-} the @samp{posix-} is ignored; and if
11009 @env{TIME_STYLE} is @samp{locale} it is ignored.
11010
11011 @item -x
11012 @itemx --one-file-system
11013 @opindex -x
11014 @opindex --one-file-system
11015 @cindex one file system, restricting @command{du} to
11016 Skip directories that are on different file systems from the one that
11017 the argument being processed is on.
11018
11019 @item --exclude=@var{pattern}
11020 @opindex --exclude=@var{pattern}
11021 @cindex excluding files from @command{du}
11022 When recursing, skip subdirectories or files matching @var{pattern}.
11023 For example, @code{du --exclude='*.o'} excludes files whose names
11024 end in @samp{.o}.
11025
11026 @item -X @var{file}
11027 @itemx --exclude-from=@var{file}
11028 @opindex -X @var{file}
11029 @opindex --exclude-from=@var{file}
11030 @cindex excluding files from @command{du}
11031 Like @option{--exclude}, except take the patterns to exclude from @var{file},
11032 one per line.  If @var{file} is @samp{-}, take the patterns from standard
11033 input.
11034
11035 @end table
11036
11037 @cindex NFS mounts from BSD to HP-UX
11038 On BSD systems, @command{du} reports sizes that are half the correct
11039 values for files that are NFS-mounted from HP-UX systems.  On HP-UX
11040 systems, it reports sizes that are twice the correct values for
11041 files that are NFS-mounted from BSD systems.  This is due to a flaw
11042 in HP-UX; it also affects the HP-UX @command{du} program.
11043
11044 @exitstatus
11045
11046
11047 @node stat invocation
11048 @section @command{stat}: Report file or file system status
11049
11050 @pindex stat
11051 @cindex file status
11052 @cindex file system status
11053
11054 @command{stat} displays information about the specified file(s).  Synopsis:
11055
11056 @example
11057 stat [@var{option}]@dots{} [@var{file}]@dots{}
11058 @end example
11059
11060 With no option, @command{stat} reports all information about the given files.
11061 But it also can be used to report the information of the file systems the
11062 given files are located on.  If the files are links, @command{stat} can
11063 also give information about the files the links point to.
11064
11065 @mayConflictWithShellBuiltIn{stat}
11066
11067 @table @samp
11068
11069 @item -L
11070 @itemx --dereference
11071 @opindex -L
11072 @opindex --dereference
11073 @cindex symbolic links, dereferencing in @command{stat}
11074 Change how @command{stat} treats symbolic links.
11075 With this option, @command{stat} acts on the file referenced
11076 by each symbolic link argument.
11077 Without it, @command{stat} acts on any symbolic link argument directly.
11078
11079 @item -f
11080 @itemx --file-system
11081 @opindex -f
11082 @opindex --file-system
11083 @cindex file systems
11084 Report information about the file systems where the given files are located
11085 instead of information about the files themselves.
11086 This option implies the @option{-L} option.
11087
11088 @item -c
11089 @itemx --format=@var{format}
11090 @opindex -c
11091 @opindex --format=@var{format}
11092 @cindex output format
11093 Use @var{format} rather than the default format.
11094 @var{format} is automatically newline-terminated, so
11095 running a command like the following with two or more @var{file}
11096 operands produces a line of output for each operand:
11097 @example
11098 $ stat --format=%d:%i / /usr
11099 2050:2
11100 2057:2
11101 @end example
11102
11103 @item --printf=@var{format}
11104 @opindex --printf=@var{format}
11105 @cindex output format
11106 Use @var{format} rather than the default format.
11107 Like @option{--format}, but interpret backslash escapes,
11108 and do not output a mandatory trailing newline.
11109 If you want a newline, include @samp{\n} in the @var{format}.
11110 Here's how you would use @option{--printf} to print the device
11111 and inode numbers of @file{/} and @file{/usr}:
11112 @example
11113 $ stat --printf='%d:%i\n' / /usr
11114 2050:2
11115 2057:2
11116 @end example
11117
11118 @item -t
11119 @itemx --terse
11120 @opindex -t
11121 @opindex --terse
11122 @cindex terse output
11123 Print the information in terse form, suitable for parsing by other programs.
11124
11125 @end table
11126
11127 The valid @var{format} directives for files with @option{--format} and
11128 @option{--printf} are:
11129
11130 @itemize @bullet
11131 @item %a - Access rights in octal
11132 @item %A - Access rights in human readable form
11133 @item %b - Number of blocks allocated (see @samp{%B})
11134 @item %B - The size in bytes of each block reported by @samp{%b}
11135 @item %C - The SELinux security context of a file, if available
11136 @item %d - Device number in decimal
11137 @item %D - Device number in hex
11138 @item %f - Raw mode in hex
11139 @item %F - File type
11140 @item %g - Group ID of owner
11141 @item %G - Group name of owner
11142 @item %h - Number of hard links
11143 @item %i - Inode number
11144 @item %m - Mount point (See note below)
11145 @item %n - File name
11146 @item %N - Quoted file name with dereference if symbolic link
11147 @item %o - Optimal I/O transfer size hint
11148 @item %s - Total size, in bytes
11149 @item %t - Major device type in hex
11150 @item %T - Minor device type in hex
11151 @item %u - User ID of owner
11152 @item %U - User name of owner
11153 @item %w - Time of file birth, or @samp{-} if unknown
11154 @item %W - Time of file birth as seconds since Epoch, or @samp{0}
11155 @item %x - Time of last access
11156 @item %X - Time of last access as seconds since Epoch
11157 @item %y - Time of last modification
11158 @item %Y - Time of last modification as seconds since Epoch
11159 @item %z - Time of last change
11160 @item %Z - Time of last change as seconds since Epoch
11161 @end itemize
11162
11163 The @samp{%W}, @samp{%X}, @samp{%Y}, and @samp{%Z} formats accept a
11164 precision preceded by a period to specify the number of digits to
11165 print after the decimal point.  For example, @samp{%.3X} outputs the
11166 last access time to millisecond precision.  If a period is given but no
11167 precision, @command{stat} uses 9 digits, so @samp{%.X} is equivalent to
11168 @samp{%.9X}@.  When discarding excess precision, time stamps are truncated
11169 toward minus infinity.
11170
11171 @example
11172 zero pad:
11173   $ stat -c '[%015Y]' /usr
11174   [000001288929712]
11175 space align:
11176   $ stat -c '[%15Y]' /usr
11177   [     1288929712]
11178   $ stat -c '[%-15Y]' /usr
11179   [1288929712     ]
11180 precision:
11181   $ stat -c '[%.3Y]' /usr
11182   [1288929712.114]
11183   $ stat -c '[%.Y]' /usr
11184   [1288929712.114951834]
11185 @end example
11186
11187 The mount point printed by @samp{%m} is similar to that output
11188 by @command{df}, except that:
11189 @itemize @bullet
11190 @item
11191 stat does not dereference symlinks by default
11192 (unless @option{-L} is specified)
11193 @item
11194 stat does not search for specified device nodes in the
11195 file system list, instead operating on them directly
11196 @item
11197 @cindex bind mount
11198 stat outputs the alias for a bind mounted file, rather than
11199 the initial mount point of its backing device.
11200 One can recursively call stat until there is no change in output,
11201 to get the current base mount point
11202 @end itemize
11203
11204 When listing file system information (@option{--file-system} (@option{-f})),
11205 you must use a different set of @var{format} directives:
11206
11207 @itemize @bullet
11208 @item %a - Free blocks available to non-super-user
11209 @item %b - Total data blocks in file system
11210 @item %c - Total file nodes in file system
11211 @item %d - Free file nodes in file system
11212 @item %f - Free blocks in file system
11213 @item %i - File System ID in hex
11214 @item %l - Maximum length of file names
11215 @item %n - File name
11216 @item %s - Block size (for faster transfers)
11217 @item %S - Fundamental block size (for block counts)
11218 @item %t - Type in hex
11219 @item %T - Type in human readable form
11220 @end itemize
11221
11222 @vindex TZ
11223 Time stamps are listed according to the time zone rules specified by
11224 the @env{TZ} environment variable, or by the system default rules if
11225 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
11226 with @env{TZ}, libc, The GNU C Library Reference Manual}.
11227
11228 @exitstatus
11229
11230
11231 @node sync invocation
11232 @section @command{sync}: Synchronize data on disk with memory
11233
11234 @pindex sync
11235 @cindex synchronize disk and memory
11236
11237 @cindex superblock, writing
11238 @cindex inodes, written buffered
11239 @command{sync} writes any data buffered in memory out to disk.  This can
11240 include (but is not limited to) modified superblocks, modified inodes,
11241 and delayed reads and writes.  This must be implemented by the kernel;
11242 The @command{sync} program does nothing but exercise the @code{sync} system
11243 call.
11244
11245 @cindex crashes and corruption
11246 The kernel keeps data in memory to avoid doing (relatively slow) disk
11247 reads and writes.  This improves performance, but if the computer
11248 crashes, data may be lost or the file system corrupted as a
11249 result.  The @command{sync} command ensures everything in memory
11250 is written to disk.
11251
11252 Any arguments are ignored, except for a lone @option{--help} or
11253 @option{--version} (@pxref{Common options}).
11254
11255 @exitstatus
11256
11257
11258 @node truncate invocation
11259 @section @command{truncate}: Shrink or extend the size of a file
11260
11261 @pindex truncate
11262 @cindex truncating, file sizes
11263
11264 @command{truncate} shrinks or extends the size of each @var{file} to the
11265 specified size.  Synopsis:
11266
11267 @example
11268 truncate @var{option}@dots{} @var{file}@dots{}
11269 @end example
11270
11271 @cindex files, creating
11272 Any @var{file} that does not exist is created.
11273
11274 @cindex sparse files, creating
11275 @cindex holes, creating files with
11276 If a @var{file} is larger than the specified size, the extra data is lost.
11277 If a @var{file} is shorter, it is extended and the extended part (or hole)
11278 reads as zero bytes.
11279
11280 The program accepts the following options.  Also see @ref{Common options}.
11281
11282 @table @samp
11283
11284 @item -c
11285 @itemx --no-create
11286 @opindex -c
11287 @opindex --no-create
11288 Do not create files that do not exist.
11289
11290 @item -o
11291 @itemx --io-blocks
11292 @opindex -o
11293 @opindex --io-blocks
11294 Treat @var{size} as number of I/O blocks of the @var{file} rather than bytes.
11295
11296 @item -r @var{rfile}
11297 @itemx --reference=@var{rfile}
11298 @opindex -r
11299 @opindex --reference
11300 Base the size of each @var{file} on the size of @var{rfile}.
11301
11302 @item -s @var{size}
11303 @itemx --size=@var{size}
11304 @opindex -s
11305 @opindex --size
11306 Set or adjust the size of each @var{file} according to @var{size}.
11307 @multiplierSuffixesNoBlocks{size}
11308
11309 @var{size} may also be prefixed by one of the following to adjust
11310 the size of each @var{file} based on their current size:
11311 @example
11312 @samp{+}  => extend by
11313 @samp{-}  => reduce by
11314 @samp{<}  => at most
11315 @samp{>}  => at least
11316 @samp{/}  => round down to multiple of
11317 @samp{%}  => round up to multiple of
11318 @end example
11319
11320 @end table
11321
11322 @exitstatus
11323
11324
11325 @node Printing text
11326 @chapter Printing text
11327
11328 @cindex printing text, commands for
11329 @cindex commands for printing text
11330
11331 This section describes commands that display text strings.
11332
11333 @menu
11334 * echo invocation::             Print a line of text.
11335 * printf invocation::           Format and print data.
11336 * yes invocation::              Print a string until interrupted.
11337 @end menu
11338
11339
11340 @node echo invocation
11341 @section @command{echo}: Print a line of text
11342
11343 @pindex echo
11344 @cindex displaying text
11345 @cindex printing text
11346 @cindex text, displaying
11347 @cindex arbitrary text, displaying
11348
11349 @command{echo} writes each given @var{string} to standard output, with a
11350 space between each and a newline after the last one.  Synopsis:
11351
11352 @example
11353 echo [@var{option}]@dots{} [@var{string}]@dots{}
11354 @end example
11355
11356 @mayConflictWithShellBuiltIn{echo}
11357
11358 The program accepts the following options.  Also see @ref{Common options}.
11359 Options must precede operands, and the normally-special argument
11360 @samp{--} has no special meaning and is treated like any other
11361 @var{string}.
11362
11363 @table @samp
11364 @item -n
11365 @opindex -n
11366 Do not output the trailing newline.
11367
11368 @item -e
11369 @opindex -e
11370 @cindex backslash escapes
11371 Enable interpretation of the following backslash-escaped characters in
11372 each @var{string}:
11373
11374 @table @samp
11375 @item \a
11376 alert (bell)
11377 @item \b
11378 backspace
11379 @item \c
11380 produce no further output
11381 @item \e
11382 escape
11383 @item \f
11384 form feed
11385 @item \n
11386 newline
11387 @item \r
11388 carriage return
11389 @item \t
11390 horizontal tab
11391 @item \v
11392 vertical tab
11393 @item \\
11394 backslash
11395 @item \0@var{nnn}
11396 the eight-bit value that is the octal number @var{nnn}
11397 (zero to three octal digits), if @var{nnn} is
11398 a nine-bit value, the ninth bit is ignored
11399 @item \@var{nnn}
11400 the eight-bit value that is the octal number @var{nnn}
11401 (one to three octal digits), if @var{nnn} is
11402 a nine-bit value, the ninth bit is ignored
11403 @item \x@var{hh}
11404 the eight-bit value that is the hexadecimal number @var{hh}
11405 (one or two hexadecimal digits)
11406 @end table
11407
11408 @item -E
11409 @opindex -E
11410 @cindex backslash escapes
11411 Disable interpretation of backslash escapes in each @var{string}.
11412 This is the default.  If @option{-e} and @option{-E} are both
11413 specified, the last one given takes effect.
11414
11415 @end table
11416
11417 @vindex POSIXLY_CORRECT
11418 If the @env{POSIXLY_CORRECT} environment variable is set, then when
11419 @command{echo}'s first argument is not @option{-n} it outputs
11420 option-like arguments instead of treating them as options.  For
11421 example, @code{echo -ne hello} outputs @samp{-ne hello} instead of
11422 plain @samp{hello}.
11423
11424 POSIX does not require support for any options, and says
11425 that the behavior of @command{echo} is implementation-defined if any
11426 @var{string} contains a backslash or if the first argument is
11427 @option{-n}.  Portable programs can use the @command{printf} command
11428 if they need to omit trailing newlines or output control characters or
11429 backslashes.  @xref{printf invocation}.
11430
11431 @exitstatus
11432
11433
11434 @node printf invocation
11435 @section @command{printf}: Format and print data
11436
11437 @pindex printf
11438 @command{printf} does formatted printing of text.  Synopsis:
11439
11440 @example
11441 printf @var{format} [@var{argument}]@dots{}
11442 @end example
11443
11444 @command{printf} prints the @var{format} string, interpreting @samp{%}
11445 directives and @samp{\} escapes to format numeric and string arguments
11446 in a way that is mostly similar to the C @samp{printf} function.
11447 @xref{Output Conversion Syntax,, @command{printf} format directives,
11448 libc, The GNU C Library Reference Manual}, for details.
11449 The differences are listed below.
11450
11451 @mayConflictWithShellBuiltIn{printf}
11452
11453 @itemize @bullet
11454
11455 @item
11456 The @var{format} argument is reused as necessary to convert all the
11457 given @var{argument}s.  For example, the command @samp{printf %s a b}
11458 outputs @samp{ab}.
11459
11460 @item
11461 Missing @var{argument}s are treated as null strings or as zeros,
11462 depending on whether the context expects a string or a number.  For
11463 example, the command @samp{printf %sx%d} prints @samp{x0}.
11464
11465 @item
11466 @kindex \c
11467 An additional escape, @samp{\c}, causes @command{printf} to produce no
11468 further output.  For example, the command @samp{printf 'A%sC\cD%sF' B
11469 E} prints @samp{ABC}.
11470
11471 @item
11472 The hexadecimal escape sequence @samp{\x@var{hh}} has at most two
11473 digits, as opposed to C where it can have an unlimited number of
11474 digits.  For example, the command @samp{printf '\x07e'} prints two
11475 bytes, whereas the C statement @samp{printf ("\x07e")} prints just
11476 one.
11477
11478 @item
11479 @kindex %b
11480 @command{printf} has an additional directive, @samp{%b}, which prints its
11481 argument string with @samp{\} escapes interpreted in the same way as in
11482 the @var{format} string, except that octal escapes are of the form
11483 @samp{\0@var{ooo}} where @var{ooo} is 0 to 3 octal digits.  If
11484 @samp{\@var{ooo}} is nine-bit value, ignore the ninth bit.
11485 If a precision is also given, it limits the number of bytes printed
11486 from the converted string.
11487
11488 @item
11489 Numeric arguments must be single C constants, possibly with leading
11490 @samp{+} or @samp{-}.  For example, @samp{printf %.4d -3} outputs
11491 @samp{-0003}.
11492
11493 @item
11494 @vindex POSIXLY_CORRECT
11495 If the leading character of a numeric argument is @samp{"} or @samp{'}
11496 then its value is the numeric value of the immediately following
11497 character.  Any remaining characters are silently ignored if the
11498 @env{POSIXLY_CORRECT} environment variable is set; otherwise, a
11499 warning is printed.  For example, @samp{printf "%d" "'a"} outputs
11500 @samp{97} on hosts that use the ASCII character set, since
11501 @samp{a} has the numeric value 97 in ASCII.
11502
11503 @end itemize
11504
11505 @vindex LC_NUMERIC
11506 A floating-point argument must use a period before any fractional
11507 digits, but is printed according to the @env{LC_NUMERIC} category of the
11508 current locale.  For example, in a locale whose radix character is a
11509 comma, the command @samp{printf %g 3.14} outputs @samp{3,14} whereas
11510 the command @samp{printf %g 3,14} is an error.
11511 @xref{Floating point}.
11512
11513 @kindex \@var{ooo}
11514 @kindex \x@var{hh}
11515 @command{printf} interprets @samp{\@var{ooo}} in @var{format} as an octal number
11516 (if @var{ooo} is 1 to 3 octal digits) specifying a byte to print,
11517 and @samp{\x@var{hh}} as a hexadecimal number (if @var{hh} is 1 to 2 hex
11518 digits) specifying a character to print.
11519 Note however that when @samp{\@var{ooo}} specifies a number larger than 255,
11520 @command{printf} ignores the ninth bit.
11521 For example, @samp{printf '\400'} is equivalent to @samp{printf '\0'}.
11522
11523 @kindex \uhhhh
11524 @kindex \Uhhhhhhhh
11525 @cindex Unicode
11526 @cindex ISO/IEC 10646
11527 @vindex LC_CTYPE
11528 @command{printf} interprets two character syntaxes introduced in
11529 ISO C 99:
11530 @samp{\u} for 16-bit Unicode (ISO/IEC 10646)
11531 characters, specified as
11532 four hexadecimal digits @var{hhhh}, and @samp{\U} for 32-bit Unicode
11533 characters, specified as eight hexadecimal digits @var{hhhhhhhh}.
11534 @command{printf} outputs the Unicode characters
11535 according to the @env{LC_CTYPE} locale.  Unicode characters in the ranges
11536 U+0000...U+009F, U+D800...U+DFFF cannot be specified by this syntax, except
11537 for U+0024 ($), U+0040 (@@), and U+0060 (@`).
11538
11539 The processing of @samp{\u} and @samp{\U} requires a full-featured
11540 @code{iconv} facility.  It is activated on systems with glibc 2.2 (or newer),
11541 or when @code{libiconv} is installed prior to this package.  Otherwise
11542 @samp{\u} and @samp{\U} will print as-is.
11543
11544 The only options are a lone @option{--help} or
11545 @option{--version}.  @xref{Common options}.
11546 Options must precede operands.
11547
11548 The Unicode character syntaxes are useful for writing strings in a locale
11549 independent way.  For example, a string containing the Euro currency symbol
11550
11551 @example
11552 $ env printf '\u20AC 14.95'
11553 @end example
11554
11555 @noindent
11556 will be output correctly in all locales supporting the Euro symbol
11557 (ISO-8859-15, UTF-8, and others).  Similarly, a Chinese string
11558
11559 @example
11560 $ env printf '\u4e2d\u6587'
11561 @end example
11562
11563 @noindent
11564 will be output correctly in all Chinese locales (GB2312, BIG5, UTF-8, etc).
11565
11566 Note that in these examples, the @command{printf} command has been
11567 invoked via @command{env} to ensure that we run the program found via
11568 your shell's search path, and not a shell alias or a built-in function.
11569
11570 For larger strings, you don't need to look up the hexadecimal code
11571 values of each character one by one.  ASCII characters mixed with \u
11572 escape sequences is also known as the JAVA source file encoding.  You can
11573 use GNU recode 3.5c (or newer) to convert strings to this encoding.  Here
11574 is how to convert a piece of text into a shell script which will output
11575 this text in a locale-independent way:
11576
11577 @smallexample
11578 $ LC_CTYPE=zh_CN.big5 /usr/local/bin/printf \
11579     '\u4e2d\u6587\n' > sample.txt
11580 $ recode BIG5..JAVA < sample.txt \
11581     | sed -e "s|^|/usr/local/bin/printf '|" -e "s|$|\\\\n'|" \
11582     > sample.sh
11583 @end smallexample
11584
11585 @exitstatus
11586
11587
11588 @node yes invocation
11589 @section @command{yes}: Print a string until interrupted
11590
11591 @pindex yes
11592 @cindex repeated output of a string
11593
11594 @command{yes} prints the command line arguments, separated by spaces and
11595 followed by a newline, forever until it is killed.  If no arguments are
11596 given, it prints @samp{y} followed by a newline forever until killed.
11597
11598 Upon a write error, @command{yes} exits with status @samp{1}.
11599
11600 The only options are a lone @option{--help} or @option{--version}.
11601 To output an argument that begins with
11602 @samp{-}, precede it with @option{--}, e.g., @samp{yes -- --help}.
11603 @xref{Common options}.
11604
11605
11606 @node Conditions
11607 @chapter Conditions
11608
11609 @cindex conditions
11610 @cindex commands for exit status
11611 @cindex exit status commands
11612
11613 This section describes commands that are primarily useful for their exit
11614 status, rather than their output.  Thus, they are often used as the
11615 condition of shell @code{if} statements, or as the last command in a
11616 pipeline.
11617
11618 @menu
11619 * false invocation::            Do nothing, unsuccessfully.
11620 * true invocation::             Do nothing, successfully.
11621 * test invocation::             Check file types and compare values.
11622 * expr invocation::             Evaluate expressions.
11623 @end menu
11624
11625
11626 @node false invocation
11627 @section @command{false}: Do nothing, unsuccessfully
11628
11629 @pindex false
11630 @cindex do nothing, unsuccessfully
11631 @cindex failure exit status
11632 @cindex exit status of @command{false}
11633
11634 @command{false} does nothing except return an exit status of 1, meaning
11635 @dfn{failure}.  It can be used as a place holder in shell scripts
11636 where an unsuccessful command is needed.
11637 In most modern shells, @command{false} is a built-in command, so when
11638 you use @samp{false} in a script, you're probably using the built-in
11639 command, not the one documented here.
11640
11641 @command{false} honors the @option{--help} and @option{--version} options.
11642
11643 This version of @command{false} is implemented as a C program, and is thus
11644 more secure and faster than a shell script implementation, and may safely
11645 be used as a dummy shell for the purpose of disabling accounts.
11646
11647 Note that @command{false} (unlike all other programs documented herein)
11648 exits unsuccessfully, even when invoked with
11649 @option{--help} or @option{--version}.
11650
11651 Portable programs should not assume that the exit status of
11652 @command{false} is 1, as it is greater than 1 on some
11653 non-GNU hosts.
11654
11655
11656 @node true invocation
11657 @section @command{true}: Do nothing, successfully
11658
11659 @pindex true
11660 @cindex do nothing, successfully
11661 @cindex no-op
11662 @cindex successful exit
11663 @cindex exit status of @command{true}
11664
11665 @command{true} does nothing except return an exit status of 0, meaning
11666 @dfn{success}.  It can be used as a place holder in shell scripts
11667 where a successful command is needed, although the shell built-in
11668 command @code{:} (colon) may do the same thing faster.
11669 In most modern shells, @command{true} is a built-in command, so when
11670 you use @samp{true} in a script, you're probably using the built-in
11671 command, not the one documented here.
11672
11673 @command{true} honors the @option{--help} and @option{--version} options.
11674
11675 Note, however, that it is possible to cause @command{true}
11676 to exit with nonzero status: with the @option{--help} or @option{--version}
11677 option, and with standard
11678 output already closed or redirected to a file that evokes an I/O error.
11679 For example, using a Bourne-compatible shell:
11680
11681 @example
11682 $ ./true --version >&-
11683 ./true: write error: Bad file number
11684 $ ./true --version > /dev/full
11685 ./true: write error: No space left on device
11686 @end example
11687
11688 This version of @command{true} is implemented as a C program, and is thus
11689 more secure and faster than a shell script implementation, and may safely
11690 be used as a dummy shell for the purpose of disabling accounts.
11691
11692 @node test invocation
11693 @section @command{test}: Check file types and compare values
11694
11695 @pindex test
11696 @cindex check file types
11697 @cindex compare values
11698 @cindex expression evaluation
11699
11700 @command{test} returns a status of 0 (true) or 1 (false) depending on the
11701 evaluation of the conditional expression @var{expr}.  Each part of the
11702 expression must be a separate argument.
11703
11704 @command{test} has file status checks, string operators, and numeric
11705 comparison operators.
11706
11707 @command{test} has an alternate form that uses opening and closing
11708 square brackets instead a leading @samp{test}.  For example, instead
11709 of @samp{test -d /}, you can write @samp{[ -d / ]}.  The square
11710 brackets must be separate arguments; for example, @samp{[-d /]} does
11711 not have the desired effect.  Since @samp{test @var{expr}} and @samp{[
11712 @var{expr} ]} have the same meaning, only the former form is discussed
11713 below.
11714
11715 Synopses:
11716
11717 @example
11718 test @var{expression}
11719 test
11720 [ @var{expression} ]
11721 [ ]
11722 [ @var{option}
11723 @end example
11724
11725 @mayConflictWithShellBuiltIn{test}
11726
11727 If @var{expression} is omitted, @command{test} returns false.
11728 If @var{expression} is a single argument,
11729 @command{test} returns false if the argument is null and true
11730 otherwise.  The argument
11731 can be any string, including strings like @samp{-d}, @samp{-1},
11732 @samp{--}, @samp{--help}, and @samp{--version} that most other
11733 programs would treat as options.  To get help and version information,
11734 invoke the commands @samp{[ --help} and @samp{[ --version}, without
11735 the usual closing brackets.  @xref{Common options}.
11736
11737 @cindex exit status of @command{test}
11738 Exit status:
11739
11740 @display
11741 0 if the expression is true,
11742 1 if the expression is false,
11743 2 if an error occurred.
11744 @end display
11745
11746 @menu
11747 * File type tests::             -[bcdfhLpSt]
11748 * Access permission tests::     -[gkruwxOG]
11749 * File characteristic tests::   -e -s -nt -ot -ef
11750 * String tests::                -z -n = == !=
11751 * Numeric tests::               -eq -ne -lt -le -gt -ge
11752 * Connectives for test::        ! -a -o
11753 @end menu
11754
11755
11756 @node File type tests
11757 @subsection File type tests
11758
11759 @cindex file type tests
11760
11761 These options test for particular types of files.  (Everything's a file,
11762 but not all files are the same!)
11763
11764 @table @samp
11765
11766 @item -b @var{file}
11767 @opindex -b
11768 @cindex block special check
11769 True if @var{file} exists and is a block special device.
11770
11771 @item -c @var{file}
11772 @opindex -c
11773 @cindex character special check
11774 True if @var{file} exists and is a character special device.
11775
11776 @item -d @var{file}
11777 @opindex -d
11778 @cindex directory check
11779 True if @var{file} exists and is a directory.
11780
11781 @item -f @var{file}
11782 @opindex -f
11783 @cindex regular file check
11784 True if @var{file} exists and is a regular file.
11785
11786 @item -h @var{file}
11787 @itemx -L @var{file}
11788 @opindex -L
11789 @opindex -h
11790 @cindex symbolic link check
11791 True if @var{file} exists and is a symbolic link.
11792 Unlike all other file-related tests, this test does not dereference
11793 @var{file} if it is a symbolic link.
11794
11795 @item -p @var{file}
11796 @opindex -p
11797 @cindex named pipe check
11798 True if @var{file} exists and is a named pipe.
11799
11800 @item -S @var{file}
11801 @opindex -S
11802 @cindex socket check
11803 True if @var{file} exists and is a socket.
11804
11805 @item -t @var{fd}
11806 @opindex -t
11807 @cindex terminal check
11808 True if @var{fd} is a file descriptor that is associated with a
11809 terminal.
11810
11811 @end table
11812
11813
11814 @node Access permission tests
11815 @subsection Access permission tests
11816
11817 @cindex access permission tests
11818 @cindex permission tests
11819
11820 These options test for particular access permissions.
11821
11822 @table @samp
11823
11824 @item -g @var{file}
11825 @opindex -g
11826 @cindex set-group-ID check
11827 True if @var{file} exists and has its set-group-ID bit set.
11828
11829 @item -k @var{file}
11830 @opindex -k
11831 @cindex sticky bit check
11832 True if @var{file} exists and has its @dfn{sticky} bit set.
11833
11834 @item -r @var{file}
11835 @opindex -r
11836 @cindex readable file check
11837 True if @var{file} exists and read permission is granted.
11838
11839 @item -u @var{file}
11840 @opindex -u
11841 @cindex set-user-ID check
11842 True if @var{file} exists and has its set-user-ID bit set.
11843
11844 @item -w @var{file}
11845 @opindex -w
11846 @cindex writable file check
11847 True if @var{file} exists and write permission is granted.
11848
11849 @item -x @var{file}
11850 @opindex -x
11851 @cindex executable file check
11852 True if @var{file} exists and execute permission is granted
11853 (or search permission, if it is a directory).
11854
11855 @item -O @var{file}
11856 @opindex -O
11857 @cindex owned by effective user ID check
11858 True if @var{file} exists and is owned by the current effective user ID.
11859
11860 @item -G @var{file}
11861 @opindex -G
11862 @cindex owned by effective group ID check
11863 True if @var{file} exists and is owned by the current effective group ID.
11864
11865 @end table
11866
11867 @node File characteristic tests
11868 @subsection File characteristic tests
11869
11870 @cindex file characteristic tests
11871
11872 These options test other file characteristics.
11873
11874 @table @samp
11875
11876 @item -e @var{file}
11877 @opindex -e
11878 @cindex existence-of-file check
11879 True if @var{file} exists.
11880
11881 @item -s @var{file}
11882 @opindex -s
11883 @cindex nonempty file check
11884 True if @var{file} exists and has a size greater than zero.
11885
11886 @item @var{file1} -nt @var{file2}
11887 @opindex -nt
11888 @cindex newer-than file check
11889 True if @var{file1} is newer (according to modification date) than
11890 @var{file2}, or if @var{file1} exists and @var{file2} does not.
11891
11892 @item @var{file1} -ot @var{file2}
11893 @opindex -ot
11894 @cindex older-than file check
11895 True if @var{file1} is older (according to modification date) than
11896 @var{file2}, or if @var{file2} exists and @var{file1} does not.
11897
11898 @item @var{file1} -ef @var{file2}
11899 @opindex -ef
11900 @cindex same file check
11901 @cindex hard link check
11902 True if @var{file1} and @var{file2} have the same device and inode
11903 numbers, i.e., if they are hard links to each other.
11904
11905 @end table
11906
11907
11908 @node String tests
11909 @subsection String tests
11910
11911 @cindex string tests
11912
11913 These options test string characteristics.  You may need to quote
11914 @var{string} arguments for the shell.  For example:
11915
11916 @example
11917 test -n "$V"
11918 @end example
11919
11920 The quotes here prevent the wrong arguments from being passed to
11921 @command{test} if @samp{$V} is empty or contains special characters.
11922
11923 @table @samp
11924
11925 @item -z @var{string}
11926 @opindex -z
11927 @cindex zero-length string check
11928 True if the length of @var{string} is zero.
11929
11930 @item -n @var{string}
11931 @itemx @var{string}
11932 @opindex -n
11933 @cindex nonzero-length string check
11934 True if the length of @var{string} is nonzero.
11935
11936 @item @var{string1} = @var{string2}
11937 @opindex =
11938 @cindex equal string check
11939 True if the strings are equal.
11940
11941 @item @var{string1} == @var{string2}
11942 @opindex ==
11943 @cindex equal string check
11944 True if the strings are equal (synonym for =).
11945
11946 @item @var{string1} != @var{string2}
11947 @opindex !=
11948 @cindex not-equal string check
11949 True if the strings are not equal.
11950
11951 @end table
11952
11953
11954 @node Numeric tests
11955 @subsection Numeric tests
11956
11957 @cindex numeric tests
11958 @cindex arithmetic tests
11959
11960 Numeric relational operators.  The arguments must be entirely numeric
11961 (possibly negative), or the special expression @w{@code{-l @var{string}}},
11962 which evaluates to the length of @var{string}.
11963
11964 @table @samp
11965
11966 @item @var{arg1} -eq @var{arg2}
11967 @itemx @var{arg1} -ne @var{arg2}
11968 @itemx @var{arg1} -lt @var{arg2}
11969 @itemx @var{arg1} -le @var{arg2}
11970 @itemx @var{arg1} -gt @var{arg2}
11971 @itemx @var{arg1} -ge @var{arg2}
11972 @opindex -eq
11973 @opindex -ne
11974 @opindex -lt
11975 @opindex -le
11976 @opindex -gt
11977 @opindex -ge
11978 These arithmetic binary operators return true if @var{arg1} is equal,
11979 not-equal, less-than, less-than-or-equal, greater-than, or
11980 greater-than-or-equal than @var{arg2}, respectively.
11981
11982 @end table
11983
11984 For example:
11985
11986 @example
11987 test -1 -gt -2 && echo yes
11988 @result{} yes
11989 test -l abc -gt 1 && echo yes
11990 @result{} yes
11991 test 0x100 -eq 1
11992 @error{} test: integer expression expected before -eq
11993 @end example
11994
11995
11996 @node Connectives for test
11997 @subsection Connectives for @command{test}
11998
11999 @cindex logical connectives
12000 @cindex connectives, logical
12001
12002 The usual logical connectives.
12003
12004 @table @samp
12005
12006 @item ! @var{expr}
12007 @opindex !
12008 True if @var{expr} is false.
12009
12010 @item @var{expr1} -a @var{expr2}
12011 @opindex -a
12012 @cindex logical and operator
12013 @cindex and operator
12014 True if both @var{expr1} and @var{expr2} are true.
12015
12016 @item @var{expr1} -o @var{expr2}
12017 @opindex -o
12018 @cindex logical or operator
12019 @cindex or operator
12020 True if either @var{expr1} or @var{expr2} is true.
12021
12022 @end table
12023
12024
12025 @node expr invocation
12026 @section @command{expr}: Evaluate expressions
12027
12028 @pindex expr
12029 @cindex expression evaluation
12030 @cindex evaluation of expressions
12031
12032 @command{expr} evaluates an expression and writes the result on standard
12033 output.  Each token of the expression must be a separate argument.
12034
12035 Operands are either integers or strings.  Integers consist of one or
12036 more decimal digits, with an optional leading @samp{-}.
12037 @command{expr} converts
12038 anything appearing in an operand position to an integer or a string
12039 depending on the operation being applied to it.
12040
12041 Strings are not quoted for @command{expr} itself, though you may need to
12042 quote them to protect characters with special meaning to the shell,
12043 e.g., spaces.  However, regardless of whether it is quoted, a string
12044 operand should not be a parenthesis or any of @command{expr}'s
12045 operators like @code{+}, so you cannot safely pass an arbitrary string
12046 @code{$str} to expr merely by quoting it to the shell.  One way to
12047 work around this is to use the @sc{gnu} extension @code{+},
12048 (e.g., @code{+ "$str" = foo}); a more portable way is to use
12049 @code{@w{" $str"}} and to adjust the rest of the expression to take
12050 the leading space into account (e.g., @code{@w{" $str" = " foo"}}).
12051
12052 You should not pass a negative integer or a string with leading
12053 @samp{-} as @command{expr}'s first argument, as it might be
12054 misinterpreted as an option; this can be avoided by parenthesization.
12055 Also, portable scripts should not use a string operand that happens to
12056 take the form of an integer; this can be worked around by inserting
12057 leading spaces as mentioned above.
12058
12059 @cindex parentheses for grouping
12060 Operators may be given as infix symbols or prefix keywords.  Parentheses
12061 may be used for grouping in the usual manner.  You must quote
12062 parentheses and many operators to avoid the shell evaluating them,
12063 however.
12064
12065 When built with support for the GNU MP library, @command{expr} uses
12066 arbitrary-precision arithmetic; otherwise, it uses native arithmetic
12067 types and may fail due to arithmetic overflow.
12068
12069 The only options are @option{--help} and @option{--version}.  @xref{Common
12070 options}.  Options must precede operands.
12071
12072 @cindex exit status of @command{expr}
12073 Exit status:
12074
12075 @display
12076 0 if the expression is neither null nor 0,
12077 1 if the expression is null or 0,
12078 2 if the expression is invalid,
12079 3 if an internal error occurred (e.g., arithmetic overflow).
12080 @end display
12081
12082 @menu
12083 * String expressions::          + : match substr index length
12084 * Numeric expressions::         + - * / %
12085 * Relations for expr::          | & < <= = == != >= >
12086 * Examples of expr::            Examples.
12087 @end menu
12088
12089
12090 @node String expressions
12091 @subsection String expressions
12092
12093 @cindex string expressions
12094 @cindex expressions, string
12095
12096 @command{expr} supports pattern matching and other string operators.  These
12097 have higher precedence than both the numeric and relational operators (in
12098 the next sections).
12099
12100 @table @samp
12101
12102 @item @var{string} : @var{regex}
12103 @cindex pattern matching
12104 @cindex regular expression matching
12105 @cindex matching patterns
12106 Perform pattern matching.  The arguments are converted to strings and the
12107 second is considered to be a (basic, a la GNU @code{grep}) regular
12108 expression, with a @code{^} implicitly prepended.  The first argument is
12109 then matched against this regular expression.
12110
12111 If the match succeeds and @var{regex} uses @samp{\(} and @samp{\)}, the
12112 @code{:} expression returns the part of @var{string} that matched the
12113 subexpression; otherwise, it returns the number of characters matched.
12114
12115 If the match fails, the @code{:} operator returns the null string if
12116 @samp{\(} and @samp{\)} are used in @var{regex}, otherwise 0.
12117
12118 @kindex \( @r{regexp operator}
12119 Only the first @samp{\( @dots{} \)} pair is relevant to the return
12120 value; additional pairs are meaningful only for grouping the regular
12121 expression operators.
12122
12123 @kindex \+ @r{regexp operator}
12124 @kindex \? @r{regexp operator}
12125 @kindex \| @r{regexp operator}
12126 In the regular expression, @code{\+}, @code{\?}, and @code{\|} are
12127 operators which respectively match one or more, zero or one, or separate
12128 alternatives.  SunOS and other @command{expr}'s treat these as regular
12129 characters.  (POSIX allows either behavior.)
12130 @xref{Top, , Regular Expression Library, regex, Regex}, for details of
12131 regular expression syntax.  Some examples are in @ref{Examples of expr}.
12132
12133 @item match @var{string} @var{regex}
12134 @findex match
12135 An alternative way to do pattern matching.  This is the same as
12136 @w{@samp{@var{string} : @var{regex}}}.
12137
12138 @item substr @var{string} @var{position} @var{length}
12139 @findex substr
12140 Returns the substring of @var{string} beginning at @var{position}
12141 with length at most @var{length}.  If either @var{position} or
12142 @var{length} is negative, zero, or non-numeric, returns the null string.
12143
12144 @item index @var{string} @var{charset}
12145 @findex index
12146 Returns the first position in @var{string} where the first character in
12147 @var{charset} was found.  If no character in @var{charset} is found in
12148 @var{string}, return 0.
12149
12150 @item length @var{string}
12151 @findex length
12152 Returns the length of @var{string}.
12153
12154 @item + @var{token}
12155 @kindex +
12156 Interpret @var{token} as a string, even if it is a keyword like @var{match}
12157 or an operator like @code{/}.
12158 This makes it possible to test @code{expr length + "$x"} or
12159 @code{expr + "$x" : '.*/\(.\)'} and have it do the right thing even if
12160 the value of @var{$x} happens to be (for example) @code{/} or @code{index}.
12161 This operator is a GNU extension.  Portable shell scripts should use
12162 @code{@w{" $token"} : @w{' \(.*\)'}} instead of @code{+ "$token"}.
12163
12164 @end table
12165
12166 To make @command{expr} interpret keywords as strings, you must use the
12167 @code{quote} operator.
12168
12169
12170 @node Numeric expressions
12171 @subsection Numeric expressions
12172
12173 @cindex numeric expressions
12174 @cindex expressions, numeric
12175
12176 @command{expr} supports the usual numeric operators, in order of increasing
12177 precedence.  These numeric operators have lower precedence than the
12178 string operators described in the previous section, and higher precedence
12179 than the connectives (next section).
12180
12181 @table @samp
12182
12183 @item + -
12184 @kindex +
12185 @kindex -
12186 @cindex addition
12187 @cindex subtraction
12188 Addition and subtraction.  Both arguments are converted to integers;
12189 an error occurs if this cannot be done.
12190
12191 @item * / %
12192 @kindex *
12193 @kindex /
12194 @kindex %
12195 @cindex multiplication
12196 @cindex division
12197 @cindex remainder
12198 Multiplication, division, remainder.  Both arguments are converted to
12199 integers; an error occurs if this cannot be done.
12200
12201 @end table
12202
12203
12204 @node Relations for expr
12205 @subsection Relations for @command{expr}
12206
12207 @cindex connectives, logical
12208 @cindex logical connectives
12209 @cindex relations, numeric or string
12210
12211 @command{expr} supports the usual logical connectives and relations.  These
12212 have lower precedence than the string and numeric operators
12213 (previous sections).  Here is the list, lowest-precedence operator first.
12214
12215 @table @samp
12216
12217 @item |
12218 @kindex |
12219 @cindex logical or operator
12220 @cindex or operator
12221 Returns its first argument if that is neither null nor zero, otherwise
12222 its second argument if it is neither null nor zero, otherwise 0.  It
12223 does not evaluate its second argument if its first argument is neither
12224 null nor zero.
12225
12226 @item &
12227 @kindex &
12228 @cindex logical and operator
12229 @cindex and operator
12230 Return its first argument if neither argument is null or zero, otherwise
12231 0.  It does not evaluate its second argument if its first argument is
12232 null or zero.
12233
12234 @item < <= = == != >= >
12235 @kindex <
12236 @kindex <=
12237 @kindex =
12238 @kindex ==
12239 @kindex >
12240 @kindex >=
12241 @cindex comparison operators
12242 @vindex LC_COLLATE
12243 Compare the arguments and return 1 if the relation is true, 0 otherwise.
12244 @code{==} is a synonym for @code{=}.  @command{expr} first tries to convert
12245 both arguments to integers and do a numeric comparison; if either
12246 conversion fails, it does a lexicographic comparison using the character
12247 collating sequence specified by the @env{LC_COLLATE} locale.
12248
12249 @end table
12250
12251
12252 @node Examples of expr
12253 @subsection Examples of using @command{expr}
12254
12255 @cindex examples of @command{expr}
12256 Here are a few examples, including quoting for shell metacharacters.
12257
12258 To add 1 to the shell variable @code{foo}, in Bourne-compatible shells:
12259
12260 @example
12261 foo=$(expr $foo + 1)
12262 @end example
12263
12264 To print the non-directory part of the file name stored in
12265 @code{$fname}, which need not contain a @code{/}:
12266
12267 @example
12268 expr $fname : '.*/\(.*\)' '|' $fname
12269 @end example
12270
12271 An example showing that @code{\+} is an operator:
12272
12273 @example
12274 expr aaa : 'a\+'
12275 @result{} 3
12276 @end example
12277
12278 @example
12279 expr abc : 'a\(.\)c'
12280 @result{} b
12281 expr index abcdef cz
12282 @result{} 3
12283 expr index index a
12284 @error{} expr: syntax error
12285 expr index + index a
12286 @result{} 0
12287 @end example
12288
12289
12290 @node Redirection
12291 @chapter Redirection
12292
12293 @cindex redirection
12294 @cindex commands for redirection
12295
12296 Unix shells commonly provide several forms of @dfn{redirection}---ways
12297 to change the input source or output destination of a command.  But one
12298 useful redirection is performed by a separate command, not by the shell;
12299 it's described here.
12300
12301 @menu
12302 * tee invocation::              Redirect output to multiple files or processes.
12303 @end menu
12304
12305
12306 @node tee invocation
12307 @section @command{tee}: Redirect output to multiple files or processes
12308
12309 @pindex tee
12310 @cindex pipe fitting
12311 @cindex destinations, multiple output
12312 @cindex read from stdin and write to stdout and files
12313
12314 The @command{tee} command copies standard input to standard output and also
12315 to any files given as arguments.  This is useful when you want not only
12316 to send some data down a pipe, but also to save a copy.  Synopsis:
12317
12318 @example
12319 tee [@var{option}]@dots{} [@var{file}]@dots{}
12320 @end example
12321
12322 If a file being written to does not already exist, it is created.  If a
12323 file being written to already exists, the data it previously contained
12324 is overwritten unless the @option{-a} option is used.
12325
12326 A @var{file} of @samp{-} causes @command{tee} to send another copy of
12327 input to standard output, but this is typically not that useful as the
12328 copies are interleaved.
12329
12330 The program accepts the following options.  Also see @ref{Common options}.
12331
12332 @table @samp
12333 @item -a
12334 @itemx --append
12335 @opindex -a
12336 @opindex --append
12337 Append standard input to the given files rather than overwriting
12338 them.
12339
12340 @item -i
12341 @itemx --ignore-interrupts
12342 @opindex -i
12343 @opindex --ignore-interrupts
12344 Ignore interrupt signals.
12345
12346 @end table
12347
12348 The @command{tee} command is useful when you happen to be transferring a large
12349 amount of data and also want to summarize that data without reading
12350 it a second time.  For example, when you are downloading a DVD image,
12351 you often want to verify its signature or checksum right away.
12352 The inefficient way to do it is simply:
12353
12354 @example
12355 wget http://example.com/some.iso && sha1sum some.iso
12356 @end example
12357
12358 One problem with the above is that it makes you wait for the
12359 download to complete before starting the time-consuming SHA1 computation.
12360 Perhaps even more importantly, the above requires reading
12361 the DVD image a second time (the first was from the network).
12362
12363 The efficient way to do it is to interleave the download
12364 and SHA1 computation.  Then, you'll get the checksum for
12365 free, because the entire process parallelizes so well:
12366
12367 @example
12368 # slightly contrived, to demonstrate process substitution
12369 wget -O - http://example.com/dvd.iso \
12370   | tee >(sha1sum > dvd.sha1) > dvd.iso
12371 @end example
12372
12373 That makes @command{tee} write not just to the expected output file,
12374 but also to a pipe running @command{sha1sum} and saving the final
12375 checksum in a file named @file{dvd.sha1}.
12376
12377 Note, however, that this example relies on a feature of modern shells
12378 called @dfn{process substitution}
12379 (the @samp{>(command)} syntax, above;
12380 @xref{Process Substitution,,Process Substitution, bashref,
12381 The Bash Reference Manual}.),
12382 so it works with @command{zsh}, @command{bash}, and @command{ksh},
12383 but not with @command{/bin/sh}.  So if you write code like this
12384 in a shell script, be sure to start the script with @samp{#!/bin/bash}.
12385
12386 Since the above example writes to one file and one process,
12387 a more conventional and portable use of @command{tee} is even better:
12388
12389 @example
12390 wget -O - http://example.com/dvd.iso \
12391   | tee dvd.iso | sha1sum > dvd.sha1
12392 @end example
12393
12394 You can extend this example to make @command{tee} write to two processes,
12395 computing MD5 and SHA1 checksums in parallel.  In this case,
12396 process substitution is required:
12397
12398 @example
12399 wget -O - http://example.com/dvd.iso \
12400   | tee >(sha1sum > dvd.sha1) \
12401         >(md5sum > dvd.md5) \
12402   > dvd.iso
12403 @end example
12404
12405 This technique is also useful when you want to make a @emph{compressed}
12406 copy of the contents of a pipe.
12407 Consider a tool to graphically summarize disk usage data from @samp{du -ak}.
12408 For a large hierarchy, @samp{du -ak} can run for a long time,
12409 and can easily produce terabytes of data, so you won't want to
12410 rerun the command unnecessarily.  Nor will you want to save
12411 the uncompressed output.
12412
12413 Doing it the inefficient way, you can't even start the GUI
12414 until after you've compressed all of the @command{du} output:
12415
12416 @example
12417 du -ak | gzip -9 > /tmp/du.gz
12418 gzip -d /tmp/du.gz | xdiskusage -a
12419 @end example
12420
12421 With @command{tee} and process substitution, you start the GUI
12422 right away and eliminate the decompression completely:
12423
12424 @example
12425 du -ak | tee >(gzip -9 > /tmp/du.gz) | xdiskusage -a
12426 @end example
12427
12428 Finally, if you regularly create more than one type of
12429 compressed tarball at once, for example when @code{make dist} creates
12430 both @command{gzip}-compressed and @command{bzip2}-compressed tarballs,
12431 there may be a better way.
12432 Typical @command{automake}-generated @file{Makefile} rules create
12433 the two compressed tar archives with commands in sequence, like this
12434 (slightly simplified):
12435
12436 @example
12437 tardir=your-pkg-M.N
12438 tar chof - "$tardir" | gzip  -9 -c > your-pkg-M.N.tar.gz
12439 tar chof - "$tardir" | bzip2 -9 -c > your-pkg-M.N.tar.bz2
12440 @end example
12441
12442 However, if the hierarchy you are archiving and compressing is larger
12443 than a couple megabytes, and especially if you are using a multi-processor
12444 system with plenty of memory, then you can do much better by reading the
12445 directory contents only once and running the compression programs in parallel:
12446
12447 @example
12448 tardir=your-pkg-M.N
12449 tar chof - "$tardir" \
12450   | tee >(gzip -9 -c > your-pkg-M.N.tar.gz) \
12451   | bzip2 -9 -c > your-pkg-M.N.tar.bz2
12452 @end example
12453
12454 @exitstatus
12455
12456
12457 @node File name manipulation
12458 @chapter File name manipulation
12459
12460 @cindex file name manipulation
12461 @cindex manipulation of file names
12462 @cindex commands for file name manipulation
12463
12464 This section describes commands that manipulate file names.
12465
12466 @menu
12467 * basename invocation::         Strip directory and suffix from a file name.
12468 * dirname invocation::          Strip last file name component.
12469 * pathchk invocation::          Check file name validity and portability.
12470 * mktemp invocation::           Create temporary file or directory.
12471 * realpath invocation::         Print resolved file names.
12472 @end menu
12473
12474
12475 @node basename invocation
12476 @section @command{basename}: Strip directory and suffix from a file name
12477
12478 @pindex basename
12479 @cindex strip directory and suffix from file names
12480 @cindex directory, stripping from file names
12481 @cindex suffix, stripping from file names
12482 @cindex file names, stripping directory and suffix
12483 @cindex leading directory components, stripping
12484
12485 @command{basename} removes any leading directory components from
12486 @var{name}.  Synopsis:
12487
12488 @example
12489 basename @var{name} [@var{suffix}]
12490 basename @var{option}... @var{name}...
12491 @end example
12492
12493 If @var{suffix} is specified and is identical to the end of @var{name},
12494 it is removed from @var{name} as well.  Note that since trailing slashes
12495 are removed prior to suffix matching, @var{suffix} will do nothing if it
12496 contains slashes.  @command{basename} prints the result on standard
12497 output.
12498
12499 @c This test is used both here and in the section on dirname.
12500 @macro basenameAndDirname
12501 Together, @command{basename} and @command{dirname} are designed such
12502 that if @samp{ls "$name"} succeeds, then the command sequence @samp{cd
12503 "$(dirname "$name")"; ls "$(basename "$name")"} will, too.  This works
12504 for everything except file names containing a trailing newline.
12505 @end macro
12506 @basenameAndDirname
12507
12508 POSIX allows the implementation to define the results if
12509 @var{name} is empty or @samp{//}.  In the former case, GNU
12510 @command{basename} returns the empty string.  In the latter case, the
12511 result is @samp{//} on platforms where @var{//} is distinct from
12512 @var{/}, and @samp{/} on platforms where there is no difference.
12513
12514 The program accepts the following options.  Also see @ref{Common options}.
12515 Options must precede operands.
12516
12517 @table @samp
12518
12519 @item -a
12520 @itemx --multiple
12521 @opindex -a
12522 @opindex --multiple
12523 Support more than one argument.  Treat every argument as a @var{name}.
12524 With this, an optional @var{suffix} must be specified using the
12525 @option{-s} option.
12526
12527 @item -s @var{suffix}
12528 @itemx --suffix=@var{suffix}
12529 @opindex -s
12530 @opindex --suffix
12531 Remove a trailing @var{suffix}.
12532 This option implies the @option{-a} option.
12533
12534 @item -z
12535 @itemx --zero
12536 @opindex -z
12537 @opindex --zero
12538 Separate output items with @sc{nul} characters.
12539
12540 @end table
12541
12542 @exitstatus
12543
12544 Examples:
12545
12546 @smallexample
12547 # Output "sort".
12548 basename /usr/bin/sort
12549
12550 # Output "stdio".
12551 basename include/stdio.h .h
12552
12553 # Output "stdio".
12554 basename -s .h include/stdio.h
12555
12556 # Output "stdio" followed by "stdlib"
12557 basename -a -s .h include/stdio.h include/stdlib.h
12558 @end smallexample
12559
12560
12561 @node dirname invocation
12562 @section @command{dirname}: Strip last file name component
12563
12564 @pindex dirname
12565 @cindex directory components, printing
12566 @cindex stripping non-directory suffix
12567 @cindex non-directory suffix, stripping
12568
12569 @command{dirname} prints all but the final slash-delimited component
12570 of each @var{name}.  Slashes on either side of the final component are
12571 also removed.  If the string contains no slash, @command{dirname}
12572 prints @samp{.} (meaning the current directory).  Synopsis:
12573
12574 @example
12575 dirname [@var{option}] @var{name}...
12576 @end example
12577
12578 @var{name} need not be a file name, but if it is, this operation
12579 effectively lists the directory that contains the final component,
12580 including the case when the final component is itself a directory.
12581
12582 @basenameAndDirname
12583
12584 POSIX allows the implementation to define the results if
12585 @var{name} is @samp{//}.  With GNU @command{dirname}, the
12586 result is @samp{//} on platforms where @var{//} is distinct from
12587 @var{/}, and @samp{/} on platforms where there is no difference.
12588
12589 The program accepts the following option.  Also see @ref{Common options}.
12590
12591 @table @samp
12592
12593 @item -z
12594 @itemx --zero
12595 @opindex -z
12596 @opindex --zero
12597 Separate output items with @sc{nul} characters.
12598
12599 @end table
12600
12601 @exitstatus
12602
12603 Examples:
12604
12605 @smallexample
12606 # Output "/usr/bin".
12607 dirname /usr/bin/sort
12608 dirname /usr/bin//.//
12609
12610 # Output "dir1" followed by "dir2"
12611 dirname dir1/str dir2/str
12612
12613 # Output ".".
12614 dirname stdio.h
12615 @end smallexample
12616
12617
12618 @node pathchk invocation
12619 @section @command{pathchk}: Check file name validity and portability
12620
12621 @pindex pathchk
12622 @cindex file names, checking validity and portability
12623 @cindex valid file names, checking for
12624 @cindex portable file names, checking for
12625
12626 @command{pathchk} checks validity and portability of file names.  Synopsis:
12627
12628 @example
12629 pathchk [@var{option}]@dots{} @var{name}@dots{}
12630 @end example
12631
12632 For each @var{name}, @command{pathchk} prints an error message if any of
12633 these conditions is true:
12634
12635 @enumerate
12636 @item
12637 One of the existing directories in @var{name} does not have search
12638 (execute) permission,
12639 @item
12640 The length of @var{name} is larger than the maximum supported by the
12641 operating system.
12642 @item
12643 The length of one component of @var{name} is longer than
12644 its file system's maximum.
12645 @end enumerate
12646
12647 A nonexistent @var{name} is not an error, so long a file with that
12648 name could be created under the above conditions.
12649
12650 The program accepts the following options.  Also see @ref{Common options}.
12651 Options must precede operands.
12652
12653 @table @samp
12654
12655 @item -p
12656 @opindex -p
12657 Instead of performing checks based on the underlying file system,
12658 print an error message if any of these conditions is true:
12659
12660 @enumerate
12661 @item
12662 A file name is empty.
12663
12664 @item
12665 A file name contains a character outside the POSIX portable file
12666 name character set, namely, the ASCII letters and digits, @samp{.},
12667 @samp{_}, @samp{-}, and @samp{/}.
12668
12669 @item
12670 The length of a file name or one of its components exceeds the
12671 POSIX minimum limits for portability.
12672 @end enumerate
12673
12674 @item -P
12675 @opindex -P
12676 Print an error message if a file name is empty, or if it contains a component
12677 that begins with @samp{-}.
12678
12679 @item --portability
12680 @opindex --portability
12681 Print an error message if a file name is not portable to all POSIX
12682 hosts.  This option is equivalent to @samp{-p -P}.
12683
12684 @end table
12685
12686 @cindex exit status of @command{pathchk}
12687 Exit status:
12688
12689 @display
12690 0 if all specified file names passed all checks,
12691 1 otherwise.
12692 @end display
12693
12694 @node mktemp invocation
12695 @section @command{mktemp}: Create temporary file or directory
12696
12697 @pindex mktemp
12698 @cindex file names, creating temporary
12699 @cindex directory, creating temporary
12700 @cindex temporary files and directories
12701
12702 @command{mktemp} manages the creation of temporary files and
12703 directories.  Synopsis:
12704
12705 @example
12706 mktemp [@var{option}]@dots{} [@var{template}]
12707 @end example
12708
12709 Safely create a temporary file or directory based on @var{template},
12710 and print its name.  If given, @var{template} must include at least
12711 three consecutive @samp{X}s in the last component.  If omitted, the template
12712 @samp{tmp.XXXXXXXXXX} is used, and option @option{--tmpdir} is
12713 implied.  The final run of @samp{X}s in the @var{template} will be replaced
12714 by alpha-numeric characters; thus, on a case-sensitive file system,
12715 and with a @var{template} including a run of @var{n} instances of @samp{X},
12716 there are @samp{62**@var{n}} potential file names.
12717
12718 Older scripts used to create temporary files by simply joining the
12719 name of the program with the process id (@samp{$$}) as a suffix.
12720 However, that naming scheme is easily predictable, and suffers from a
12721 race condition where the attacker can create an appropriately named
12722 symbolic link, such that when the script then opens a handle to what
12723 it thought was an unused file, it is instead modifying an existing
12724 file.  Using the same scheme to create a directory is slightly safer,
12725 since the @command{mkdir} will fail if the target already exists, but
12726 it is still inferior because it allows for denial of service attacks.
12727 Therefore, modern scripts should use the @command{mktemp} command to
12728 guarantee that the generated name will be unpredictable, and that
12729 knowledge of the temporary file name implies that the file was created
12730 by the current script and cannot be modified by other users.
12731
12732 When creating a file, the resulting file has read and write
12733 permissions for the current user, but no permissions for the group or
12734 others; these permissions are reduced if the current umask is more
12735 restrictive.
12736
12737 Here are some examples (although note that if you repeat them, you
12738 will most likely get different file names):
12739
12740 @itemize @bullet
12741
12742 @item
12743 Create a temporary file in the current directory.
12744 @example
12745 $ mktemp file.XXXX
12746 file.H47c
12747 @end example
12748
12749 @item
12750 Create a temporary file with a known suffix.
12751 @example
12752 $ mktemp --suffix=.txt file-XXXX
12753 file-H08W.txt
12754 $ mktemp file-XXXX-XXXX.txt
12755 file-XXXX-eI9L.txt
12756 @end example
12757
12758 @item
12759 Create a secure fifo relative to the user's choice of @env{TMPDIR},
12760 but falling back to the current directory rather than @file{/tmp}.
12761 Note that @command{mktemp} does not create fifos, but can create a
12762 secure directory in which the fifo can live.  Exit the shell if the
12763 directory or fifo could not be created.
12764 @example
12765 $ dir=$(mktemp -p "$@{TMPDIR:-.@}" -d dir-XXXX) || exit 1
12766 $ fifo=$dir/fifo
12767 $ mkfifo "$fifo" || @{ rmdir "$dir"; exit 1; @}
12768 @end example
12769
12770 @item
12771 Create and use a temporary file if possible, but ignore failure.  The
12772 file will reside in the directory named by @env{TMPDIR}, if specified,
12773 or else in @file{/tmp}.
12774 @example
12775 $ file=$(mktemp -q) && @{
12776 >   # Safe to use $file only within this block.  Use quotes,
12777 >   # since $TMPDIR, and thus $file, may contain whitespace.
12778 >   echo ... > "$file"
12779 >   rm "$file"
12780 > @}
12781 @end example
12782
12783 @item
12784 Act as a semi-random character generator (it is not fully random,
12785 since it is impacted by the contents of the current directory).  To
12786 avoid security holes, do not use the resulting names to create a file.
12787 @example
12788 $ mktemp -u XXX
12789 Gb9
12790 $ mktemp -u XXX
12791 nzC
12792 @end example
12793
12794 @end itemize
12795
12796 The program accepts the following options.  Also see @ref{Common options}.
12797
12798 @table @samp
12799
12800 @item -d
12801 @itemx --directory
12802 @opindex -d
12803 @opindex --directory
12804 Create a directory rather than a file.  The directory will have read,
12805 write, and search permissions for the current user, but no permissions
12806 for the group or others; these permissions are reduced if the current
12807 umask is more restrictive.
12808
12809 @item -q
12810 @itemx --quiet
12811 @opindex -q
12812 @opindex --quiet
12813 Suppress diagnostics about failure to create a file or directory.  The
12814 exit status will still reflect whether a file was created.
12815
12816 @item -u
12817 @itemx --dry-run
12818 @opindex -u
12819 @opindex --dry-run
12820 Generate a temporary name that does not name an existing file, without
12821 changing the file system contents.  Using the output of this command
12822 to create a new file is inherently unsafe, as there is a window of
12823 time between generating the name and using it where another process
12824 can create an object by the same name.
12825
12826 @item -p @var{dir}
12827 @itemx --tmpdir[=@var{dir}]
12828 @opindex -p
12829 @opindex --tmpdir
12830 Treat @var{template} relative to the directory @var{dir}.  If
12831 @var{dir} is not specified (only possible with the long option
12832 @option{--tmpdir}) or is the empty string, use the value of
12833 @env{TMPDIR} if available, otherwise use @samp{/tmp}.  If this is
12834 specified, @var{template} must not be absolute.  However,
12835 @var{template} can still contain slashes, although intermediate
12836 directories must already exist.
12837
12838 @item --suffix=@var{suffix}
12839 @opindex --suffix
12840 Append @var{suffix} to the @var{template}.  @var{suffix} must not
12841 contain slash.  If @option{--suffix} is specified, @var{template} must
12842 end in @samp{X}; if it is not specified, then an appropriate
12843 @option{--suffix} is inferred by finding the last @samp{X} in
12844 @var{template}.  This option exists for use with the default
12845 @var{template} and for the creation of a @var{suffix} that starts with
12846 @samp{X}.
12847
12848 @item -t
12849 @opindex -t
12850 Treat @var{template} as a single file relative to the value of
12851 @env{TMPDIR} if available, or to the directory specified by
12852 @option{-p}, otherwise to @samp{/tmp}.  @var{template} must not
12853 contain slashes.  This option is deprecated; the use of @option{-p}
12854 without @option{-t} offers better defaults (by favoring the command
12855 line over @env{TMPDIR}) and more flexibility (by allowing intermediate
12856 directories).
12857
12858 @end table
12859
12860 @cindex exit status of @command{mktemp}
12861 Exit status:
12862
12863 @display
12864 0 if the file was created,
12865 1 otherwise.
12866 @end display
12867
12868
12869 @node realpath invocation
12870 @section @command{realpath}: Print the resolved file name.
12871
12872 @pindex realpath
12873 @cindex file names, canonicalization
12874 @cindex symlinks, resolution
12875 @cindex canonical file name
12876 @cindex canonicalize a file name
12877 @pindex realpath
12878 @findex realpath
12879
12880 @command{realpath} expands all symbolic links and resolves references to
12881 @samp{/./}, @samp{/../} and extra @samp{/} characters.  By default,
12882 all but the last component of the specified files must exist.  Synopsis:
12883
12884 @example
12885 realpath [@var{option}]@dots{} @var{file}@dots{}
12886 @end example
12887
12888 The program accepts the following options.  Also see @ref{Common options}.
12889
12890 @table @samp
12891
12892 @item -e
12893 @itemx --canonicalize-existing
12894 @opindex -e
12895 @opindex --canonicalize-existing
12896 Ensure that all components of the specified file names exist.
12897 If any component is missing or unavailable, @command{realpath} will output
12898 a diagnostic unless the @option{-q} option is specified, and exit with a
12899 nonzero exit code.  A trailing slash requires that the name resolve to a
12900 directory.
12901
12902 @item -m
12903 @itemx --canonicalize-missing
12904 @opindex -m
12905 @opindex --canonicalize-missing
12906 If any component of a specified file name is missing or unavailable,
12907 treat it as a directory.
12908
12909 @item -L
12910 @itemx --logical
12911 @opindex -L
12912 @opindex --logical
12913 Symbolic links are resolved in the specified file names,
12914 but they are resolved after any subsequent @samp{..} components are processed.
12915
12916 @item -P
12917 @itemx --physical
12918 @opindex -P
12919 @opindex --physical
12920 Symbolic links are resolved in the specified file names,
12921 and they are resolved before any subsequent @samp{..} components are processed.
12922 This is the default mode of operation.
12923
12924 @item -q
12925 @itemx --quiet
12926 @opindex -q
12927 @opindex --quiet
12928 Suppress diagnostic messages for specified file names.
12929
12930 @item -s
12931 @itemx --strip
12932 @itemx --no-symlinks
12933 @opindex -s
12934 @opindex --strip
12935 @opindex --no-symlinks
12936 Do not resolve symbolic links.  Only resolve references to
12937 @samp{/./}, @samp{/../} and remove extra @samp{/} characters.
12938 When combined with the @option{-m} option, realpath operates
12939 only on the file name, and does not touch any actual file.
12940
12941 @item -z
12942 @itemx --zero
12943 @opindex -z
12944 @opindex --zero
12945 Separate output items with @sc{nul} characters.
12946
12947 @item --relative-to=@var{file}
12948 @opindex --relative-to
12949 @cindex relpath
12950 Print the resolved file names relative to the specified file.
12951 Note this option honors the @option{-m} and @option{-e} options
12952 pertaining to file existence.
12953
12954 @item --relative-base=@var{base}
12955 @opindex --relative-base
12956 This option is valid when used with @option{--relative-to}, and will restrict
12957 the output of @option{--relative-to} so that relative names are output,
12958 only when @var{file}s are descendants of @var{base}.  Otherwise output the
12959 absolute file name.  If @option{--relative-to} was not specified, then
12960 the descendants of @var{base} are printed relative to @var{base}.  If
12961 @option{--relative-to} is specified, then that directory must be a
12962 descendant of @var{base} for this option to have an effect.
12963 Note: this option honors the @option{-m} and @option{-e}
12964 options pertaining to file existence.  For example:
12965
12966 @example
12967 realpath --relative-to=/usr /tmp /usr/bin
12968 @result{} ../tmp
12969 @result{} bin
12970 realpath --relative-base=/usr /tmp /usr/bin
12971 @result{} /tmp
12972 @result{} bin
12973 @end example
12974
12975 @end table
12976
12977 @cindex exit status of @command{realpath}
12978 Exit status:
12979
12980 @display
12981 0 if all file names were printed without issue.
12982 1 otherwise.
12983 @end display
12984
12985
12986 @node Working context
12987 @chapter Working context
12988
12989 @cindex working context
12990 @cindex commands for printing the working context
12991
12992 This section describes commands that display or alter the context in
12993 which you are working: the current directory, the terminal settings, and
12994 so forth.  See also the user-related commands in the next section.
12995
12996 @menu
12997 * pwd invocation::              Print working directory.
12998 * stty invocation::             Print or change terminal characteristics.
12999 * printenv invocation::         Print environment variables.
13000 * tty invocation::              Print file name of terminal on standard input.
13001 @end menu
13002
13003
13004 @node pwd invocation
13005 @section @command{pwd}: Print working directory
13006
13007 @pindex pwd
13008 @cindex print name of current directory
13009 @cindex current working directory, printing
13010 @cindex working directory, printing
13011
13012
13013 @command{pwd} prints the name of the current directory.  Synopsis:
13014
13015 @example
13016 pwd [@var{option}]@dots{}
13017 @end example
13018
13019 The program accepts the following options.  Also see @ref{Common options}.
13020
13021 @table @samp
13022 @item -L
13023 @itemx --logical
13024 @opindex -L
13025 @opindex --logical
13026 If the contents of the environment variable @env{PWD} provide an
13027 absolute name of the current directory with no @samp{.} or @samp{..}
13028 components, but possibly with symbolic links, then output those
13029 contents.  Otherwise, fall back to default @option{-P} handling.
13030
13031 @item -P
13032 @itemx --physical
13033 @opindex -P
13034 @opindex --physical
13035 Print a fully resolved name for the current directory.  That is, all
13036 components of the printed name will be actual directory names---none
13037 will be symbolic links.
13038 @end table
13039
13040 @cindex symbolic links and @command{pwd}
13041 If @option{-L} and @option{-P} are both given, the last one takes
13042 precedence.  If neither option is given, then this implementation uses
13043 @option{-P} as the default unless the @env{POSIXLY_CORRECT}
13044 environment variable is set.
13045
13046 @mayConflictWithShellBuiltIn{pwd}
13047
13048 @exitstatus
13049
13050
13051 @node stty invocation
13052 @section @command{stty}: Print or change terminal characteristics
13053
13054 @pindex stty
13055 @cindex change or print terminal settings
13056 @cindex terminal settings
13057 @cindex line settings of terminal
13058
13059 @command{stty} prints or changes terminal characteristics, such as baud rate.
13060 Synopses:
13061
13062 @example
13063 stty [@var{option}] [@var{setting}]@dots{}
13064 stty [@var{option}]
13065 @end example
13066
13067 If given no line settings, @command{stty} prints the baud rate, line
13068 discipline number (on systems that support it), and line settings
13069 that have been changed from the values set by @samp{stty sane}.
13070 By default, mode reading and setting are performed on the tty line
13071 connected to standard input, although this can be modified by the
13072 @option{--file} option.
13073
13074 @command{stty} accepts many non-option arguments that change aspects of
13075 the terminal line operation, as described below.
13076
13077 The program accepts the following options.  Also see @ref{Common options}.
13078
13079 @table @samp
13080 @item -a
13081 @itemx --all
13082 @opindex -a
13083 @opindex --all
13084 Print all current settings in human-readable form.  This option may not
13085 be used in combination with any line settings.
13086
13087 @item -F @var{device}
13088 @itemx --file=@var{device}
13089 @opindex -F
13090 @opindex --file
13091 Set the line opened by the file name specified in @var{device} instead of
13092 the tty line connected to standard input.  This option is necessary
13093 because opening a POSIX tty requires use of the
13094 @code{O_NONDELAY} flag to prevent a POSIX tty from blocking
13095 until the carrier detect line is high if
13096 the @code{clocal} flag is not set.  Hence, it is not always possible
13097 to allow the shell to open the device in the traditional manner.
13098
13099 @item -g
13100 @itemx --save
13101 @opindex -g
13102 @opindex --save
13103 @cindex machine-readable @command{stty} output
13104 Print all current settings in a form that can be used as an argument to
13105 another @command{stty} command to restore the current settings.  This option
13106 may not be used in combination with any line settings.
13107
13108 @end table
13109
13110 Many settings can be turned off by preceding them with a @samp{-}.
13111 Such arguments are marked below with ``May be negated'' in their
13112 description.  The descriptions themselves refer to the positive
13113 case, that is, when @emph{not} negated (unless stated otherwise,
13114 of course).
13115
13116 Some settings are not available on all POSIX systems, since they use
13117 extensions.  Such arguments are marked below with
13118 ``Non-POSIX'' in their description.  On non-POSIX
13119 systems, those or other settings also may not
13120 be available, but it's not feasible to document all the variations: just
13121 try it and see.
13122
13123 @exitstatus
13124
13125 @menu
13126 * Control::                     Control settings
13127 * Input::                       Input settings
13128 * Output::                      Output settings
13129 * Local::                       Local settings
13130 * Combination::                 Combination settings
13131 * Characters::                  Special characters
13132 * Special::                     Special settings
13133 @end menu
13134
13135
13136 @node Control
13137 @subsection Control settings
13138
13139 @cindex control settings
13140 Control settings:
13141
13142 @table @samp
13143 @item parenb
13144 @opindex parenb
13145 @cindex two-way parity
13146 Generate parity bit in output and expect parity bit in input.
13147 May be negated.
13148
13149 @item parodd
13150 @opindex parodd
13151 @cindex odd parity
13152 @cindex even parity
13153 Set odd parity (even if negated).  May be negated.
13154
13155 @item cs5
13156 @itemx cs6
13157 @itemx cs7
13158 @itemx cs8
13159 @opindex cs@var{n}
13160 @cindex character size
13161 @cindex eight-bit characters
13162 Set character size to 5, 6, 7, or 8 bits.
13163
13164 @item hup
13165 @itemx hupcl
13166 @opindex hup[cl]
13167 Send a hangup signal when the last process closes the tty.  May be
13168 negated.
13169
13170 @item cstopb
13171 @opindex cstopb
13172 @cindex stop bits
13173 Use two stop bits per character (one if negated).  May be negated.
13174
13175 @item cread
13176 @opindex cread
13177 Allow input to be received.  May be negated.
13178
13179 @item clocal
13180 @opindex clocal
13181 @cindex modem control
13182 Disable modem control signals.  May be negated.
13183
13184 @item crtscts
13185 @opindex crtscts
13186 @cindex hardware flow control
13187 @cindex flow control, hardware
13188 @cindex RTS/CTS flow control
13189 Enable RTS/CTS flow control.  Non-POSIX@.  May be negated.
13190 @end table
13191
13192
13193 @node Input
13194 @subsection Input settings
13195
13196 @cindex input settings
13197 These settings control operations on data received from the terminal.
13198
13199 @table @samp
13200 @item ignbrk
13201 @opindex ignbrk
13202 @cindex breaks, ignoring
13203 Ignore break characters.  May be negated.
13204
13205 @item brkint
13206 @opindex brkint
13207 @cindex breaks, cause interrupts
13208 Make breaks cause an interrupt signal.  May be negated.
13209
13210 @item ignpar
13211 @opindex ignpar
13212 @cindex parity, ignoring
13213 Ignore characters with parity errors.  May be negated.
13214
13215 @item parmrk
13216 @opindex parmrk
13217 @cindex parity errors, marking
13218 Mark parity errors (with a 255-0-character sequence).  May be negated.
13219
13220 @item inpck
13221 @opindex inpck
13222 Enable input parity checking.  May be negated.
13223
13224 @item istrip
13225 @opindex istrip
13226 @cindex eight-bit input
13227 Clear high (8th) bit of input characters.  May be negated.
13228
13229 @item inlcr
13230 @opindex inlcr
13231 @cindex newline, translating to return
13232 Translate newline to carriage return.  May be negated.
13233
13234 @item igncr
13235 @opindex igncr
13236 @cindex return, ignoring
13237 Ignore carriage return.  May be negated.
13238
13239 @item icrnl
13240 @opindex icrnl
13241 @cindex return, translating to newline
13242 Translate carriage return to newline.  May be negated.
13243
13244 @item iutf8
13245 @opindex iutf8
13246 @cindex input encoding, UTF-8
13247 Assume input characters are UTF-8 encoded.  May be negated.
13248
13249 @item ixon
13250 @opindex ixon
13251 @kindex C-s/C-q flow control
13252 @cindex XON/XOFF flow control
13253 Enable XON/XOFF flow control (that is, @kbd{CTRL-S}/@kbd{CTRL-Q}).  May
13254 be negated.
13255
13256 @item ixoff
13257 @itemx tandem
13258 @opindex ixoff
13259 @opindex tandem
13260 @cindex software flow control
13261 @cindex flow control, software
13262 Enable sending of @code{stop} character when the system input buffer
13263 is almost full, and @code{start} character when it becomes almost
13264 empty again.  May be negated.
13265
13266 @item iuclc
13267 @opindex iuclc
13268 @cindex uppercase, translating to lowercase
13269 Translate uppercase characters to lowercase.  Non-POSIX@.  May be
13270 negated.  Note ilcuc is not implemented, as one would not be able to issue
13271 almost any (lowercase) Unix command, after invoking it.
13272
13273 @item ixany
13274 @opindex ixany
13275 Allow any character to restart output (only the start character
13276 if negated).  Non-POSIX@.  May be negated.
13277
13278 @item imaxbel
13279 @opindex imaxbel
13280 @cindex beeping at input buffer full
13281 Enable beeping and not flushing input buffer if a character arrives
13282 when the input buffer is full.  Non-POSIX@.  May be negated.
13283 @end table
13284
13285
13286 @node Output
13287 @subsection Output settings
13288
13289 @cindex output settings
13290 These settings control operations on data sent to the terminal.
13291
13292 @table @samp
13293 @item opost
13294 @opindex opost
13295 Postprocess output.  May be negated.
13296
13297 @item olcuc
13298 @opindex olcuc
13299 @cindex lowercase, translating to output
13300 Translate lowercase characters to uppercase.  Non-POSIX@.  May be
13301 negated.  (Note ouclc is not currently implemented.)
13302
13303 @item ocrnl
13304 @opindex ocrnl
13305 @cindex return, translating to newline
13306 Translate carriage return to newline.  Non-POSIX@.  May be negated.
13307
13308 @item onlcr
13309 @opindex onlcr
13310 @cindex newline, translating to crlf
13311 Translate newline to carriage return-newline.  Non-POSIX@.  May be
13312 negated.
13313
13314 @item onocr
13315 @opindex onocr
13316 Do not print carriage returns in the first column.  Non-POSIX@.
13317 May be negated.
13318
13319 @item onlret
13320 @opindex onlret
13321 Newline performs a carriage return.  Non-POSIX@.  May be negated.
13322
13323 @item ofill
13324 @opindex ofill
13325 @cindex pad instead of timing for delaying
13326 Use fill (padding) characters instead of timing for delays.
13327 Non-POSIX@.
13328 May be negated.
13329
13330 @item ofdel
13331 @opindex ofdel
13332 @cindex pad character
13333 Use ASCII @sc{del} characters for fill instead of
13334 ASCII @sc{nul} characters.  Non-POSIX@.
13335 May be negated.
13336
13337 @item nl1
13338 @itemx nl0
13339 @opindex nl@var{n}
13340 Newline delay style.  Non-POSIX.
13341
13342 @item cr3
13343 @itemx cr2
13344 @itemx cr1
13345 @itemx cr0
13346 @opindex cr@var{n}
13347 Carriage return delay style.  Non-POSIX.
13348
13349 @item tab3
13350 @itemx tab2
13351 @itemx tab1
13352 @itemx tab0
13353 @opindex tab@var{n}
13354 Horizontal tab delay style.  Non-POSIX.
13355
13356 @item bs1
13357 @itemx bs0
13358 @opindex bs@var{n}
13359 Backspace delay style.  Non-POSIX.
13360
13361 @item vt1
13362 @itemx vt0
13363 @opindex vt@var{n}
13364 Vertical tab delay style.  Non-POSIX.
13365
13366 @item ff1
13367 @itemx ff0
13368 @opindex ff@var{n}
13369 Form feed delay style.  Non-POSIX.
13370 @end table
13371
13372
13373 @node Local
13374 @subsection Local settings
13375
13376 @cindex local settings
13377
13378 @table @samp
13379 @item isig
13380 @opindex isig
13381 Enable @code{interrupt}, @code{quit}, and @code{suspend} special
13382 characters.  May be negated.
13383
13384 @item icanon
13385 @opindex icanon
13386 Enable @code{erase}, @code{kill}, @code{werase}, and @code{rprnt}
13387 special characters.  May be negated.
13388
13389 @item iexten
13390 @opindex iexten
13391 Enable non-POSIX special characters.  May be negated.
13392
13393 @item echo
13394 @opindex echo
13395 Echo input characters.  May be negated.
13396
13397 @item echoe
13398 @itemx crterase
13399 @opindex echoe
13400 @opindex crterase
13401 Echo @code{erase} characters as backspace-space-backspace.  May be
13402 negated.
13403
13404 @item echok
13405 @opindex echok
13406 @cindex newline echoing after @code{kill}
13407 Echo a newline after a @code{kill} character.  May be negated.
13408
13409 @item echonl
13410 @opindex echonl
13411 @cindex newline, echoing
13412 Echo newline even if not echoing other characters.  May be negated.
13413
13414 @item noflsh
13415 @opindex noflsh
13416 @cindex flushing, disabling
13417 Disable flushing after @code{interrupt} and @code{quit} special
13418 characters.  May be negated.
13419
13420 @item xcase
13421 @opindex xcase
13422 @cindex case translation
13423 Enable input and output of uppercase characters by preceding their
13424 lowercase equivalents with @samp{\}, when @code{icanon} is set.
13425 Non-POSIX@.  May be negated.
13426
13427 @item tostop
13428 @opindex tostop
13429 @cindex background jobs, stopping at terminal write
13430 Stop background jobs that try to write to the terminal.  Non-POSIX@.
13431 May be negated.
13432
13433 @item echoprt
13434 @itemx prterase
13435 @opindex echoprt
13436 @opindex prterase
13437 Echo erased characters backward, between @samp{\} and @samp{/}.
13438 Non-POSIX@.  May be negated.
13439
13440 @item echoctl
13441 @itemx ctlecho
13442 @opindex echoctl
13443 @opindex ctlecho
13444 @cindex control characters, using @samp{^@var{c}}
13445 @cindex hat notation for control characters
13446 Echo control characters in hat notation (@samp{^@var{c}}) instead
13447 of literally.  Non-POSIX@.  May be negated.
13448
13449 @item echoke
13450 @itemx crtkill
13451 @opindex echoke
13452 @opindex crtkill
13453 Echo the @code{kill} special character by erasing each character on
13454 the line as indicated by the @code{echoprt} and @code{echoe} settings,
13455 instead of by the @code{echoctl} and @code{echok} settings.
13456 Non-POSIX@.
13457 May be negated.
13458 @end table
13459
13460
13461 @node Combination
13462 @subsection Combination settings
13463
13464 @cindex combination settings
13465 Combination settings:
13466
13467 @table @samp
13468 @item evenp
13469 @opindex evenp
13470 @itemx parity
13471 @opindex parity
13472 Same as @code{parenb -parodd cs7}.  May be negated.  If negated, same
13473 as @code{-parenb cs8}.
13474
13475 @item oddp
13476 @opindex oddp
13477 Same as @code{parenb parodd cs7}.  May be negated.  If negated, same
13478 as @code{-parenb cs8}.
13479
13480 @item nl
13481 @opindex nl
13482 Same as @code{-icrnl -onlcr}.  May be negated.  If negated, same as
13483 @code{icrnl -inlcr -igncr onlcr -ocrnl -onlret}.
13484
13485 @item ek
13486 @opindex ek
13487 Reset the @code{erase} and @code{kill} special characters to their default
13488 values.
13489
13490 @item sane
13491 @opindex sane
13492 Same as:
13493
13494 @c This is too long to write inline.
13495 @example
13496 cread -ignbrk brkint -inlcr -igncr icrnl -ixoff
13497 -iuclc -ixany imaxbel opost -olcuc -ocrnl onlcr
13498 -onocr -onlret -ofill -ofdel nl0 cr0 tab0 bs0 vt0
13499 ff0 isig icanon iexten echo echoe echok -echonl
13500 -noflsh -xcase -tostop -echoprt echoctl echoke
13501 @end example
13502
13503 @noindent
13504 and also sets all special characters to their default values.
13505
13506 @item cooked
13507 @opindex cooked
13508 Same as @code{brkint ignpar istrip icrnl ixon opost isig icanon}, plus
13509 sets the @code{eof} and @code{eol} characters to their default values
13510 if they are the same as the @code{min} and @code{time} characters.
13511 May be negated.  If negated, same as @code{raw}.
13512
13513 @item raw
13514 @opindex raw
13515 Same as:
13516
13517 @example
13518 -ignbrk -brkint -ignpar -parmrk -inpck -istrip
13519 -inlcr -igncr -icrnl -ixon -ixoff -iuclc -ixany
13520 -imaxbel -opost -isig -icanon -xcase min 1 time 0
13521 @end example
13522
13523 @noindent
13524 May be negated.  If negated, same as @code{cooked}.
13525
13526 @item cbreak
13527 @opindex cbreak
13528 Same as @option{-icanon}.  May be negated.  If negated, same as
13529 @code{icanon}.
13530
13531 @item pass8
13532 @opindex pass8
13533 @cindex eight-bit characters
13534 Same as @code{-parenb -istrip cs8}.  May be negated.  If negated,
13535 same as @code{parenb istrip cs7}.
13536
13537 @item litout
13538 @opindex litout
13539 Same as @option{-parenb -istrip -opost cs8}.  May be negated.
13540 If negated, same as @code{parenb istrip opost cs7}.
13541
13542 @item decctlq
13543 @opindex decctlq
13544 Same as @option{-ixany}.  Non-POSIX@.  May be negated.
13545
13546 @item tabs
13547 @opindex tabs
13548 Same as @code{tab0}.  Non-POSIX@.  May be negated.  If negated, same
13549 as @code{tab3}.
13550
13551 @item lcase
13552 @itemx LCASE
13553 @opindex lcase
13554 @opindex LCASE
13555 Same as @code{xcase iuclc olcuc}.  Non-POSIX@.  May be negated.
13556 (Used for terminals with uppercase characters only.)
13557
13558 @item crt
13559 @opindex crt
13560 Same as @code{echoe echoctl echoke}.
13561
13562 @item dec
13563 @opindex dec
13564 Same as @code{echoe echoctl echoke -ixany intr ^C erase ^? kill C-u}.
13565 @end table
13566
13567
13568 @node Characters
13569 @subsection Special characters
13570
13571 @cindex special characters
13572 @cindex characters, special
13573
13574 The special characters' default values vary from system to system.
13575 They are set with the syntax @samp{name value}, where the names are
13576 listed below and the value can be given either literally, in hat
13577 notation (@samp{^@var{c}}), or as an integer which may start with
13578 @samp{0x} to indicate hexadecimal, @samp{0} to indicate octal, or
13579 any other digit to indicate decimal.
13580
13581 @cindex disabling special characters
13582 @kindex u@r{, and disabling special characters}
13583 For GNU stty, giving a value of @code{^-} or @code{undef} disables that
13584 special character.  (This is incompatible with Ultrix @command{stty},
13585 which uses  a value of @samp{u} to disable a special character.  GNU
13586 @command{stty} treats a value @samp{u} like any other, namely to set that
13587 special character to @key{U}.)
13588
13589 @table @samp
13590
13591 @item intr
13592 @opindex intr
13593 Send an interrupt signal.
13594
13595 @item quit
13596 @opindex quit
13597 Send a quit signal.
13598
13599 @item erase
13600 @opindex erase
13601 Erase the last character typed.
13602
13603 @item kill
13604 @opindex kill
13605 Erase the current line.
13606
13607 @item eof
13608 @opindex eof
13609 Send an end of file (terminate the input).
13610
13611 @item eol
13612 @opindex eol
13613 End the line.
13614
13615 @item eol2
13616 @opindex eol2
13617 Alternate character to end the line.  Non-POSIX.
13618
13619 @item swtch
13620 @opindex swtch
13621 Switch to a different shell layer.  Non-POSIX.
13622
13623 @item start
13624 @opindex start
13625 Restart the output after stopping it.
13626
13627 @item stop
13628 @opindex stop
13629 Stop the output.
13630
13631 @item susp
13632 @opindex susp
13633 Send a terminal stop signal.
13634
13635 @item dsusp
13636 @opindex dsusp
13637 Send a terminal stop signal after flushing the input.  Non-POSIX.
13638
13639 @item rprnt
13640 @opindex rprnt
13641 Redraw the current line.  Non-POSIX.
13642
13643 @item werase
13644 @opindex werase
13645 Erase the last word typed.  Non-POSIX.
13646
13647 @item lnext
13648 @opindex lnext
13649 Enter the next character typed literally, even if it is a special
13650 character.  Non-POSIX.
13651 @end table
13652
13653
13654 @node Special
13655 @subsection Special settings
13656
13657 @cindex special settings
13658
13659 @table @samp
13660 @item min @var{n}
13661 @opindex min
13662 Set the minimum number of characters that will satisfy a read until
13663 the time value has expired, when @option{-icanon} is set.
13664
13665 @item time @var{n}
13666 @opindex time
13667 Set the number of tenths of a second before reads time out if the minimum
13668 number of characters have not been read, when @option{-icanon} is set.
13669
13670 @item ispeed @var{n}
13671 @opindex ispeed
13672 Set the input speed to @var{n}.
13673
13674 @item ospeed @var{n}
13675 @opindex ospeed
13676 Set the output speed to @var{n}.
13677
13678 @item rows @var{n}
13679 @opindex rows
13680 Tell the tty kernel driver that the terminal has @var{n} rows.
13681 Non-POSIX.
13682
13683 @item cols @var{n}
13684 @itemx columns @var{n}
13685 @opindex cols
13686 @opindex columns
13687 Tell the kernel that the terminal has @var{n} columns.  Non-POSIX.
13688
13689 @item size
13690 @opindex size
13691 @vindex LINES
13692 @vindex COLUMNS
13693 Print the number of rows and columns that the kernel thinks the
13694 terminal has.  (Systems that don't support rows and columns in the kernel
13695 typically use the environment variables @env{LINES} and @env{COLUMNS}
13696 instead; however, GNU @command{stty} does not know anything about them.)
13697 Non-POSIX.
13698
13699 @item line @var{n}
13700 @opindex line
13701 Use line discipline @var{n}.  Non-POSIX.
13702
13703 @item speed
13704 @opindex speed
13705 Print the terminal speed.
13706
13707 @item @var{n}
13708 @cindex baud rate, setting
13709 Set the input and output speeds to @var{n}.  @var{n} can be one of: 0
13710 50 75 110 134 134.5 150 200 300 600 1200 1800 2400 4800 9600 19200
13711 38400 @code{exta} @code{extb}.  @code{exta} is the same as 19200;
13712 @code{extb} is the same as 38400.  Many systems, including GNU/Linux,
13713 support higher speeds.  The @command{stty} command includes support
13714 for speeds of
13715 57600,
13716 115200,
13717 230400,
13718 460800,
13719 500000,
13720 576000,
13721 921600,
13722 1000000,
13723 1152000,
13724 1500000,
13725 2000000,
13726 2500000,
13727 3000000,
13728 3500000,
13729 or
13730 4000000 where the system supports these.
13731 0 hangs up the line if @option{-clocal} is set.
13732 @end table
13733
13734
13735 @node printenv invocation
13736 @section @command{printenv}: Print all or some environment variables
13737
13738 @pindex printenv
13739 @cindex printing all or some environment variables
13740 @cindex environment variables, printing
13741
13742 @command{printenv} prints environment variable values.  Synopsis:
13743
13744 @example
13745 printenv [@var{option}] [@var{variable}]@dots{}
13746 @end example
13747
13748 If no @var{variable}s are specified, @command{printenv} prints the value of
13749 every environment variable.  Otherwise, it prints the value of each
13750 @var{variable} that is set, and nothing for those that are not set.
13751
13752 The program accepts the following option.  Also see @ref{Common options}.
13753
13754 @table @samp
13755
13756 @optNull{printenv}
13757
13758 @end table
13759
13760 @cindex exit status of @command{printenv}
13761 Exit status:
13762
13763 @display
13764 0 if all variables specified were found
13765 1 if at least one specified variable was not found
13766 2 if a write error occurred
13767 @end display
13768
13769
13770 @node tty invocation
13771 @section @command{tty}: Print file name of terminal on standard input
13772
13773 @pindex tty
13774 @cindex print terminal file name
13775 @cindex terminal file name, printing
13776
13777 @command{tty} prints the file name of the terminal connected to its standard
13778 input.  It prints @samp{not a tty} if standard input is not a terminal.
13779 Synopsis:
13780
13781 @example
13782 tty [@var{option}]@dots{}
13783 @end example
13784
13785 The program accepts the following option.  Also see @ref{Common options}.
13786
13787 @table @samp
13788
13789 @item -s
13790 @itemx --silent
13791 @itemx --quiet
13792 @opindex -s
13793 @opindex --silent
13794 @opindex --quiet
13795 Print nothing; only return an exit status.
13796
13797 @end table
13798
13799 @cindex exit status of @command{tty}
13800 Exit status:
13801
13802 @display
13803 0 if standard input is a terminal
13804 1 if standard input is not a terminal
13805 2 if given incorrect arguments
13806 3 if a write error occurs
13807 @end display
13808
13809
13810 @node User information
13811 @chapter User information
13812
13813 @cindex user information, commands for
13814 @cindex commands for printing user information
13815
13816 This section describes commands that print user-related information:
13817 logins, groups, and so forth.
13818
13819 @menu
13820 * id invocation::               Print user identity.
13821 * logname invocation::          Print current login name.
13822 * whoami invocation::           Print effective user ID.
13823 * groups invocation::           Print group names a user is in.
13824 * users invocation::            Print login names of users currently logged in.
13825 * who invocation::              Print who is currently logged in.
13826 @end menu
13827
13828
13829 @node id invocation
13830 @section @command{id}: Print user identity
13831
13832 @pindex id
13833 @cindex real user and group IDs, printing
13834 @cindex effective user and group IDs, printing
13835 @cindex printing real and effective user and group IDs
13836
13837 @command{id} prints information about the given user, or the process
13838 running it if no user is specified.  Synopsis:
13839
13840 @example
13841 id [@var{option}]@dots{} [@var{username}]
13842 @end example
13843
13844 @vindex POSIXLY_CORRECT
13845 By default, it prints the real user ID, real group ID, effective user ID
13846 if different from the real user ID, effective group ID if different from
13847 the real group ID, and supplemental group IDs.
13848 In addition, if SELinux
13849 is enabled and the @env{POSIXLY_CORRECT} environment variable is not set,
13850 then print @samp{context=@var{c}}, where @var{c} is the security context.
13851
13852 Each of these numeric values is preceded by an identifying string and
13853 followed by the corresponding user or group name in parentheses.
13854
13855 The options cause @command{id} to print only part of the above information.
13856 Also see @ref{Common options}.
13857
13858 @table @samp
13859 @item -g
13860 @itemx --group
13861 @opindex -g
13862 @opindex --group
13863 Print only the group ID.
13864
13865 @item -G
13866 @itemx --groups
13867 @opindex -G
13868 @opindex --groups
13869 Print only the group ID and the supplementary groups.
13870
13871 @item -n
13872 @itemx --name
13873 @opindex -n
13874 @opindex --name
13875 Print the user or group name instead of the ID number.  Requires
13876 @option{-u}, @option{-g}, or @option{-G}.
13877
13878 @item -r
13879 @itemx --real
13880 @opindex -r
13881 @opindex --real
13882 Print the real, instead of effective, user or group ID@.  Requires
13883 @option{-u}, @option{-g}, or @option{-G}.
13884
13885 @item -u
13886 @itemx --user
13887 @opindex -u
13888 @opindex --user
13889 Print only the user ID.
13890
13891 @item -Z
13892 @itemx --context
13893 @opindex -Z
13894 @opindex --context
13895 @cindex SELinux
13896 @cindex security context
13897 Print only the security context of the current user.
13898 If SELinux is disabled then print a warning and
13899 set the exit status to 1.
13900
13901 @end table
13902
13903 @exitstatus
13904
13905 @macro primaryAndSupplementaryGroups{cmd,arg}
13906 Primary and supplementary groups for a process are normally inherited
13907 from its parent and are usually unchanged since login.  This means
13908 that if you change the group database after logging in, @command{\cmd\}
13909 will not reflect your changes within your existing login session.
13910 Running @command{\cmd\} with a \arg\ causes the user and group
13911 database to be consulted afresh, and so will give a different result.
13912 @end macro
13913 @primaryAndSupplementaryGroups{id,user argument}
13914
13915 @node logname invocation
13916 @section @command{logname}: Print current login name
13917
13918 @pindex logname
13919 @cindex printing user's login name
13920 @cindex login name, printing
13921 @cindex user name, printing
13922
13923 @flindex utmp
13924 @command{logname} prints the calling user's name, as found in a
13925 system-maintained file (often @file{/var/run/utmp} or
13926 @file{/etc/utmp}), and exits with a status of 0.  If there is no entry
13927 for the calling process, @command{logname} prints
13928 an error message and exits with a status of 1.
13929
13930 The only options are @option{--help} and @option{--version}.  @xref{Common
13931 options}.
13932
13933 @exitstatus
13934
13935
13936 @node whoami invocation
13937 @section @command{whoami}: Print effective user ID
13938
13939 @pindex whoami
13940 @cindex effective user ID, printing
13941 @cindex printing the effective user ID
13942
13943 @command{whoami} prints the user name associated with the current
13944 effective user ID@.  It is equivalent to the command @samp{id -un}.
13945
13946 The only options are @option{--help} and @option{--version}.  @xref{Common
13947 options}.
13948
13949 @exitstatus
13950
13951
13952 @node groups invocation
13953 @section @command{groups}: Print group names a user is in
13954
13955 @pindex groups
13956 @cindex printing groups a user is in
13957 @cindex supplementary groups, printing
13958
13959 @command{groups} prints the names of the primary and any supplementary
13960 groups for each given @var{username}, or the current process if no names
13961 are given.  If more than one name is given, the name of each user is
13962 printed before
13963 the list of that user's groups and the user name is separated from the
13964 group list by a colon.  Synopsis:
13965
13966 @example
13967 groups [@var{username}]@dots{}
13968 @end example
13969
13970 The group lists are equivalent to the output of the command @samp{id -Gn}.
13971
13972 @primaryAndSupplementaryGroups{groups,list of users}
13973
13974 The only options are @option{--help} and @option{--version}.  @xref{Common
13975 options}.
13976
13977 @exitstatus
13978
13979
13980 @node users invocation
13981 @section @command{users}: Print login names of users currently logged in
13982
13983 @pindex users
13984 @cindex printing current usernames
13985 @cindex usernames, printing current
13986
13987 @cindex login sessions, printing users with
13988 @command{users} prints on a single line a blank-separated list of user
13989 names of users currently logged in to the current host.  Each user name
13990 corresponds to a login session, so if a user has more than one login
13991 session, that user's name will appear the same number of times in the
13992 output.  Synopsis:
13993
13994 @example
13995 users [@var{file}]
13996 @end example
13997
13998 @flindex utmp
13999 @flindex wtmp
14000 With no @var{file} argument, @command{users} extracts its information from
14001 a system-maintained file (often @file{/var/run/utmp} or
14002 @file{/etc/utmp}).  If a file argument is given, @command{users} uses
14003 that file instead.  A common choice is @file{/var/log/wtmp}.
14004
14005 The only options are @option{--help} and @option{--version}.  @xref{Common
14006 options}.
14007
14008 @exitstatus
14009
14010
14011 @node who invocation
14012 @section @command{who}: Print who is currently logged in
14013
14014 @pindex who
14015 @cindex printing current user information
14016 @cindex information, about current users
14017
14018 @command{who} prints information about users who are currently logged on.
14019 Synopsis:
14020
14021 @example
14022 @command{who} [@var{option}] [@var{file}] [am i]
14023 @end example
14024
14025 @cindex terminal lines, currently used
14026 @cindex login time
14027 @cindex remote hostname
14028 If given no non-option arguments, @command{who} prints the following
14029 information for each user currently logged on: login name, terminal
14030 line, login time, and remote hostname or X display.
14031
14032 @flindex utmp
14033 @flindex wtmp
14034 If given one non-option argument, @command{who} uses that instead of
14035 a default system-maintained file (often @file{/var/run/utmp} or
14036 @file{/etc/utmp}) as the name of the file containing the record of
14037 users logged on.  @file{/var/log/wtmp} is commonly given as an argument
14038 to @command{who} to look at who has previously logged on.
14039
14040 @opindex am i
14041 @opindex who am i
14042 If given two non-option arguments, @command{who} prints only the entry
14043 for the user running it (determined from its standard input), preceded
14044 by the hostname.  Traditionally, the two arguments given are @samp{am
14045 i}, as in @samp{who am i}.
14046
14047 @vindex TZ
14048 Time stamps are listed according to the time zone rules specified by
14049 the @env{TZ} environment variable, or by the system default rules if
14050 @env{TZ} is not set.  @xref{TZ Variable,, Specifying the Time Zone
14051 with @env{TZ}, libc, The GNU C Library Reference Manual}.
14052
14053 The program accepts the following options.  Also see @ref{Common options}.
14054
14055 @table @samp
14056
14057 @item -a
14058 @itemx --all
14059 @opindex -a
14060 @opindex --all
14061 Same as @samp{-b -d --login -p -r -t -T -u}.
14062
14063 @item -b
14064 @itemx --boot
14065 @opindex -b
14066 @opindex --boot
14067 Print the date and time of last system boot.
14068
14069 @item -d
14070 @itemx --dead
14071 @opindex -d
14072 @opindex --dead
14073 Print information corresponding to dead processes.
14074
14075 @item -H
14076 @itemx --heading
14077 @opindex -H
14078 @opindex --heading
14079 Print a line of column headings.
14080
14081 @item -l
14082 @itemx --login
14083 @opindex -l
14084 @opindex --login
14085 List only the entries that correspond to processes via which the
14086 system is waiting for a user to login.  The user name is always @samp{LOGIN}.
14087
14088 @item --lookup
14089 @opindex --lookup
14090 Attempt to canonicalize hostnames found in utmp through a DNS lookup.  This
14091 is not the default because it can cause significant delays on systems with
14092 automatic dial-up internet access.
14093
14094 @item -m
14095 @opindex -m
14096 Same as @samp{who am i}.
14097
14098 @item -p
14099 @itemx --process
14100 @opindex -p
14101 @opindex --process
14102 List active processes spawned by init.
14103
14104 @item -q
14105 @itemx --count
14106 @opindex -q
14107 @opindex --count
14108 Print only the login names and the number of users logged on.
14109 Overrides all other options.
14110
14111 @item -r
14112 @itemx --runlevel
14113 @opindex -r
14114 @opindex --runlevel
14115 Print the current (and maybe previous) run-level of the init process.
14116
14117 @item -s
14118 @opindex -s
14119 Ignored; for compatibility with other versions of @command{who}.
14120
14121 @item -t
14122 @itemx --time
14123 @opindex -t
14124 @opindex --time
14125 Print last system clock change.
14126
14127 @item -u
14128 @opindex -u
14129 @cindex idle time
14130 After the login time, print the number of hours and minutes that the
14131 user has been idle.  @samp{.} means the user was active in the last minute.
14132 @samp{old} means the user has been idle for more than 24 hours.
14133
14134 @item -w
14135 @itemx -T
14136 @itemx --mesg
14137 @itemx --message
14138 @itemx --writable
14139 @opindex -w
14140 @opindex -T
14141 @opindex --mesg
14142 @opindex --message
14143 @opindex --writable
14144 @cindex message status
14145 @pindex write@r{, allowed}
14146 After each login name print a character indicating the user's message status:
14147
14148 @display
14149 @samp{+} allowing @code{write} messages
14150 @samp{-} disallowing @code{write} messages
14151 @samp{?} cannot find terminal device
14152 @end display
14153
14154 @end table
14155
14156 @exitstatus
14157
14158
14159 @node System context
14160 @chapter System context
14161
14162 @cindex system context
14163 @cindex context, system
14164 @cindex commands for system context
14165
14166 This section describes commands that print or change system-wide
14167 information.
14168
14169 @menu
14170 * date invocation::             Print or set system date and time.
14171 * arch invocation::             Print machine hardware name.
14172 * nproc invocation::            Print the number of processors.
14173 * uname invocation::            Print system information.
14174 * hostname invocation::         Print or set system name.
14175 * hostid invocation::           Print numeric host identifier.
14176 * uptime invocation::           Print system uptime and load.
14177 @end menu
14178
14179 @node date invocation
14180 @section @command{date}: Print or set system date and time
14181
14182 @pindex date
14183 @cindex time, printing or setting
14184 @cindex printing the current time
14185
14186 Synopses:
14187
14188 @example
14189 date [@var{option}]@dots{} [+@var{format}]
14190 date [-u|--utc|--universal] @c this avoids a newline in the output
14191 [ MMDDhhmm[[CC]YY][.ss] ]
14192 @end example
14193
14194 @vindex LC_TIME
14195 Invoking @command{date} with no @var{format} argument is equivalent to invoking
14196 it with a default format that depends on the @env{LC_TIME} locale category.
14197 In the default C locale, this format is @samp{'+%a %b %e %H:%M:%S %Z %Y'},
14198 so the output looks like @samp{Thu Mar @ 3 13:47:51 PST 2005}.
14199
14200 @vindex TZ
14201 Normally, @command{date} uses the time zone rules indicated by the
14202 @env{TZ} environment variable, or the system default rules if @env{TZ}
14203 is not set.  @xref{TZ Variable,, Specifying the Time Zone with
14204 @env{TZ}, libc, The GNU C Library Reference Manual}.
14205
14206 @findex strftime @r{and @command{date}}
14207 @cindex time formats
14208 @cindex formatting times
14209 If given an argument that starts with a @samp{+}, @command{date} prints the
14210 current date and time (or the date and time specified by the
14211 @option{--date} option, see below) in the format defined by that argument,
14212 which is similar to that of the @code{strftime} function.  Except for
14213 conversion specifiers, which start with @samp{%}, characters in the
14214 format string are printed unchanged.  The conversion specifiers are
14215 described below.
14216
14217 @exitstatus
14218
14219 @menu
14220 * Time conversion specifiers::     %[HIklMNpPrRsSTXzZ]
14221 * Date conversion specifiers::     %[aAbBcCdDeFgGhjmuUVwWxyY]
14222 * Literal conversion specifiers::  %[%nt]
14223 * Padding and other flags::        Pad with zeros, spaces, etc.
14224 * Setting the time::               Changing the system clock.
14225 * Options for date::               Instead of the current time.
14226 @detailmenu
14227 * Date input formats::             Specifying date strings.
14228 @end detailmenu
14229 * Examples of date::               Examples.
14230 @end menu
14231
14232 @node Time conversion specifiers
14233 @subsection Time conversion specifiers
14234
14235 @cindex time conversion specifiers
14236 @cindex conversion specifiers, time
14237
14238 @command{date} conversion specifiers related to times.
14239
14240 @table @samp
14241 @item %H
14242 hour (@samp{00}@dots{}@samp{23})
14243 @item %I
14244 hour (@samp{01}@dots{}@samp{12})
14245 @item %k
14246 hour, space padded (@samp{ 0}@dots{}@samp{23}); equivalent to @samp{%_H}@.
14247 This is a GNU extension.
14248 @item %l
14249 hour, space padded (@samp{ 1}@dots{}@samp{12}); equivalent to @samp{%_I}@.
14250 This is a GNU extension.
14251 @item %M
14252 minute (@samp{00}@dots{}@samp{59})
14253 @item %N
14254 nanoseconds (@samp{000000000}@dots{}@samp{999999999}).
14255 This is a GNU extension.
14256 @item %p
14257 locale's equivalent of either @samp{AM} or @samp{PM};
14258 blank in many locales.
14259 Noon is treated as @samp{PM} and midnight as @samp{AM}.
14260 @item %P
14261 like @samp{%p}, except lower case.
14262 This is a GNU extension.
14263 @item %r
14264 locale's 12-hour clock time (e.g., @samp{11:11:04 PM})
14265 @item %R
14266 24-hour hour and minute.  Same as @samp{%H:%M}.
14267 @item %s
14268 @cindex epoch, seconds since
14269 @cindex seconds since the epoch
14270 @cindex beginning of time
14271 @cindex leap seconds
14272 seconds since the epoch, i.e., since 1970-01-01 00:00:00 UTC@.
14273 Leap seconds are not counted unless leap second support is available.
14274 @xref{%s-examples}, for examples.
14275 This is a GNU extension.
14276 @item %S
14277 @cindex leap seconds
14278 second (@samp{00}@dots{}@samp{60}).
14279 This may be @samp{60} if leap seconds are supported.
14280 @item %T
14281 24-hour hour, minute, and second.  Same as @samp{%H:%M:%S}.
14282 @item %X
14283 locale's time representation (e.g., @samp{23:13:48})
14284 @item %z
14285 @w{RFC 2822/ISO 8601} style numeric time zone
14286 (e.g., @samp{-0600} or @samp{+0530}), or nothing if no
14287 time zone is determinable.  This value reflects the numeric time zone
14288 appropriate for the current time, using the time zone rules specified
14289 by the @env{TZ} environment variable.
14290 The time (and optionally, the time zone rules) can be overridden
14291 by the @option{--date} option.
14292 @item %:z
14293 @w{RFC 3339/ISO 8601} style numeric time zone with
14294 @samp{:} (e.g., @samp{-06:00} or @samp{+05:30}), or nothing if no time
14295 zone is determinable.
14296 This is a GNU extension.
14297 @item %::z
14298 Numeric time zone to the nearest second with @samp{:} (e.g.,
14299 @samp{-06:00:00} or @samp{+05:30:00}), or nothing if no time zone is
14300 determinable.
14301 This is a GNU extension.
14302 @item %:::z
14303 Numeric time zone with @samp{:} using the minimum necessary precision
14304 (e.g., @samp{-06}, @samp{+05:30}, or @samp{-04:56:02}), or nothing if
14305 no time zone is determinable.
14306 This is a GNU extension.
14307 @item %Z
14308 alphabetic time zone abbreviation (e.g., @samp{EDT}), or nothing if no
14309 time zone is determinable.  See @samp{%z} for how it is determined.
14310 @end table
14311
14312
14313 @node Date conversion specifiers
14314 @subsection Date conversion specifiers
14315
14316 @cindex date conversion specifiers
14317 @cindex conversion specifiers, date
14318
14319 @command{date} conversion specifiers related to dates.
14320
14321 @table @samp
14322 @item %a
14323 locale's abbreviated weekday name (e.g., @samp{Sun})
14324 @item %A
14325 locale's full weekday name, variable length (e.g., @samp{Sunday})
14326 @item %b
14327 locale's abbreviated month name (e.g., @samp{Jan})
14328 @item %B
14329 locale's full month name, variable length (e.g., @samp{January})
14330 @item %c
14331 locale's date and time (e.g., @samp{Thu Mar @ 3 23:05:25 2005})
14332 @item %C
14333 century.  This is like @samp{%Y}, except the last two digits are omitted.
14334 For example, it is @samp{20} if @samp{%Y} is @samp{2000},
14335 and is @samp{-0} if @samp{%Y} is @samp{-001}.
14336 It is normally at least two characters, but it may be more.
14337 @item %d
14338 day of month (e.g., @samp{01})
14339 @item %D
14340 date; same as @samp{%m/%d/%y}
14341 @item %e
14342 day of month, space padded; same as @samp{%_d}
14343 @item %F
14344 full date in ISO 8601 format; same as @samp{%Y-%m-%d}.
14345 This is a good choice for a date format, as it is standard and
14346 is easy to sort in the usual case where years are in the range
14347 0000@dots{}9999.
14348 @item %g
14349 year corresponding to the ISO week number, but without the century
14350 (range @samp{00} through @samp{99}).  This has the same format and value
14351 as @samp{%y}, except that if the ISO week number (see
14352 @samp{%V}) belongs
14353 to the previous or next year, that year is used instead.
14354 @item %G
14355 year corresponding to the ISO week number.  This has the
14356 same format and value as @samp{%Y}, except that if the ISO
14357 week number (see
14358 @samp{%V}) belongs to the previous or next year, that year is used
14359 instead.
14360 It is normally useful only if @samp{%V} is also used;
14361 for example, the format @samp{%G-%m-%d} is probably a mistake,
14362 since it combines the ISO week number year with the conventional month and day.
14363 @item %h
14364 same as @samp{%b}
14365 @item %j
14366 day of year (@samp{001}@dots{}@samp{366})
14367 @item %m
14368 month (@samp{01}@dots{}@samp{12})
14369 @item %u
14370 day of week (@samp{1}@dots{}@samp{7}) with @samp{1} corresponding to Monday
14371 @item %U
14372 week number of year, with Sunday as the first day of the week
14373 (@samp{00}@dots{}@samp{53}).
14374 Days in a new year preceding the first Sunday are in week zero.
14375 @item %V
14376 ISO week number, that is, the
14377 week number of year, with Monday as the first day of the week
14378 (@samp{01}@dots{}@samp{53}).
14379 If the week containing January 1 has four or more days in
14380 the new year, then it is considered week 1; otherwise, it is week 53 of
14381 the previous year, and the next week is week 1.  (See the ISO 8601
14382 standard.)
14383 @item %w
14384 day of week (@samp{0}@dots{}@samp{6}) with 0 corresponding to Sunday
14385 @item %W
14386 week number of year, with Monday as first day of week
14387 (@samp{00}@dots{}@samp{53}).
14388 Days in a new year preceding the first Monday are in week zero.
14389 @item %x
14390 locale's date representation (e.g., @samp{12/31/99})
14391 @item %y
14392 last two digits of year (@samp{00}@dots{}@samp{99})
14393 @item %Y
14394 year.  This is normally at least four characters, but it may be more.
14395 Year @samp{0000} precedes year @samp{0001}, and year @samp{-001}
14396 precedes year @samp{0000}.
14397 @end table
14398
14399
14400 @node Literal conversion specifiers
14401 @subsection Literal conversion specifiers
14402
14403 @cindex literal conversion specifiers
14404 @cindex conversion specifiers, literal
14405
14406 @command{date} conversion specifiers that produce literal strings.
14407
14408 @table @samp
14409 @item %%
14410 a literal %
14411 @item %n
14412 a newline
14413 @item %t
14414 a horizontal tab
14415 @end table
14416
14417
14418 @node Padding and other flags
14419 @subsection Padding and other flags
14420
14421 @cindex numeric field padding
14422 @cindex padding of numeric fields
14423 @cindex fields, padding numeric
14424
14425 Unless otherwise specified, @command{date} normally pads numeric fields
14426 with zeros, so that, for
14427 example, numeric months are always output as two digits.
14428 Seconds since the epoch are not padded, though,
14429 since there is no natural width for them.
14430
14431 As a GNU extension, @command{date} recognizes any of the
14432 following optional flags after the @samp{%}:
14433
14434 @table @samp
14435 @item -
14436 (hyphen) Do not pad the field; useful if the output is intended for
14437 human consumption.
14438 @item _
14439 (underscore) Pad with spaces; useful if you need a fixed
14440 number of characters in the output, but zeros are too distracting.
14441 @item 0
14442 (zero) Pad with zeros even if the conversion specifier
14443 would normally pad with spaces.
14444 @item ^
14445 Use upper case characters if possible.
14446 @item #
14447 Use opposite case characters if possible.
14448 A field that is normally upper case becomes lower case, and vice versa.
14449 @end table
14450
14451 @noindent
14452 Here are some examples of padding:
14453
14454 @example
14455 date +%d/%m -d "Feb 1"
14456 @result{} 01/02
14457 date +%-d/%-m -d "Feb 1"
14458 @result{} 1/2
14459 date +%_d/%_m -d "Feb 1"
14460 @result{}  1/ 2
14461 @end example
14462
14463 As a GNU extension, you can specify the field width
14464 (after any flag, if present) as a decimal number.  If the natural size of the
14465 output of the field has less than the specified number of characters,
14466 the result is written right adjusted and padded to the given
14467 size.  For example, @samp{%9B} prints the right adjusted month name in
14468 a field of width 9.
14469
14470 An optional modifier can follow the optional flag and width
14471 specification.  The modifiers are:
14472
14473 @table @samp
14474 @item E
14475 Use the locale's alternate representation for date and time.  This
14476 modifier applies to the @samp{%c}, @samp{%C}, @samp{%x}, @samp{%X},
14477 @samp{%y} and @samp{%Y} conversion specifiers.  In a Japanese locale, for
14478 example, @samp{%Ex} might yield a date format based on the Japanese
14479 Emperors' reigns.
14480
14481 @item O
14482 Use the locale's alternate numeric symbols for numbers.  This modifier
14483 applies only to numeric conversion specifiers.
14484 @end table
14485
14486 If the format supports the modifier but no alternate representation
14487 is available, it is ignored.
14488
14489
14490 @node Setting the time
14491 @subsection Setting the time
14492
14493 @cindex setting the time
14494 @cindex time setting
14495 @cindex appropriate privileges
14496
14497 If given an argument that does not start with @samp{+}, @command{date} sets
14498 the system clock to the date and time specified by that argument (as
14499 described below).  You must have appropriate privileges to set the
14500 system clock.  Note for changes to persist across a reboot, the
14501 hardware clock may need to be updated from the system clock, which
14502 might not happen automatically on your system.
14503
14504 The argument must consist entirely of digits, which have the following
14505 meaning:
14506
14507 @table @samp
14508 @item MM
14509 month
14510 @item DD
14511 day within month
14512 @item hh
14513 hour
14514 @item mm
14515 minute
14516 @item CC
14517 first two digits of year (optional)
14518 @item YY
14519 last two digits of year (optional)
14520 @item ss
14521 second (optional)
14522 @end table
14523
14524 Note, the @option{--date} and @option{--set} options may not be used with an
14525 argument in the above format.  The @option{--universal} option may be used
14526 with such an argument to indicate that the specified date and time are
14527 relative to Coordinated Universal Time rather than to the local time zone.
14528
14529
14530 @node Options for date
14531 @subsection Options for @command{date}
14532
14533 @cindex @command{date} options
14534 @cindex options for @command{date}
14535
14536 The program accepts the following options.  Also see @ref{Common options}.
14537
14538 @table @samp
14539
14540 @item -d @var{datestr}
14541 @itemx --date=@var{datestr}
14542 @opindex -d
14543 @opindex --date
14544 @cindex parsing date strings
14545 @cindex date strings, parsing
14546 @cindex arbitrary date strings, parsing
14547 @opindex yesterday
14548 @opindex tomorrow
14549 @opindex next @var{day}
14550 @opindex last @var{day}
14551 Display the date and time specified in @var{datestr} instead of the
14552 current date and time.  @var{datestr} can be in almost any common
14553 format.  It can contain month names, time zones, @samp{am} and @samp{pm},
14554 @samp{yesterday}, etc.  For example, @option{--date="2004-02-27
14555 14:19:13.489392193 +0530"} specifies the instant of time that is
14556 489,392,193 nanoseconds after February 27, 2004 at 2:19:13 PM in a
14557 time zone that is 5 hours and 30 minutes east of UTC.@*
14558 Note: input currently must be in locale independent format.  E.g., the
14559 LC_TIME=C below is needed to print back the correct date in many locales:
14560 @example
14561 date -d "$(LC_TIME=C date)"
14562 @end example
14563 @xref{Date input formats}.
14564
14565 @item -f @var{datefile}
14566 @itemx --file=@var{datefile}
14567 @opindex -f
14568 @opindex --file
14569 Parse each line in @var{datefile} as with @option{-d} and display the
14570 resulting date and time.  If @var{datefile} is @samp{-}, use standard
14571 input.  This is useful when you have many dates to process, because the
14572 system overhead of starting up the @command{date} executable many times can
14573 be considerable.
14574
14575 @item -I[@var{timespec}]
14576 @itemx --iso-8601[=@var{timespec}]
14577 @opindex -I[@var{timespec}]
14578 @opindex --iso-8601[=@var{timespec}]
14579 Display the date using the ISO 8601 format, @samp{%Y-%m-%d}.
14580
14581 The argument @var{timespec} specifies the number of additional
14582 terms of the time to include.  It can be one of the following:
14583 @table @samp
14584 @item auto
14585 Print just the date.  This is the default if @var{timespec} is omitted.
14586
14587 @item hours
14588 Append the hour of the day to the date.
14589
14590 @item minutes
14591 Append the hours and minutes.
14592
14593 @item seconds
14594 Append the hours, minutes and seconds.
14595
14596 @item ns
14597 Append the hours, minutes, seconds and nanoseconds.
14598 @end table
14599
14600 If showing any time terms, then include the time zone using the format
14601 @samp{%z}.
14602
14603 @item -r @var{file}
14604 @itemx --reference=@var{file}
14605 @opindex -r
14606 @opindex --reference
14607 Display the date and time of the last modification of @var{file},
14608 instead of the current date and time.
14609
14610 @item -R
14611 @itemx --rfc-822
14612 @itemx --rfc-2822
14613 @opindex -R
14614 @opindex --rfc-822
14615 @opindex --rfc-2822
14616 Display the date and time using the format @samp{%a, %d %b %Y %H:%M:%S
14617 %z}, evaluated in the C locale so abbreviations are always in English.
14618 For example:
14619
14620 @example
14621 Fri, 09 Sep 2005 13:51:39 -0700
14622 @end example
14623
14624 This format conforms to
14625 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt, Internet
14626 RFCs 2822} and
14627 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc822.txt, 822}, the
14628 current and previous standards for Internet email.
14629
14630 @item --rfc-3339=@var{timespec}
14631 @opindex --rfc-3339=@var{timespec}
14632 Display the date using a format specified by
14633 @uref{ftp://ftp.rfc-editor.org/in-notes/rfc3339.txt, Internet
14634 RFC 3339}.  This is a subset of the ISO 8601
14635 format, except that it also permits applications to use a space rather
14636 than a @samp{T} to separate dates from times.  Unlike the other
14637 standard formats, RFC 3339 format is always suitable as
14638 input for the @option{--date} (@option{-d}) and @option{--file}
14639 (@option{-f}) options, regardless of the current locale.
14640
14641 The argument @var{timespec} specifies how much of the time to include.
14642 It can be one of the following:
14643
14644 @table @samp
14645 @item date
14646 Print just the full-date, e.g., @samp{2005-09-14}.
14647 This is equivalent to the format @samp{%Y-%m-%d}.
14648
14649 @item seconds
14650 Print the full-date and full-time separated by a space, e.g.,
14651 @samp{2005-09-14 00:56:06+05:30}.  The output ends with a numeric
14652 time-offset; here the @samp{+05:30} means that local time is five
14653 hours and thirty minutes east of UTC@.  This is equivalent to
14654 the format @samp{%Y-%m-%d %H:%M:%S%:z}.
14655
14656 @item ns
14657 Like @samp{seconds}, but also print nanoseconds, e.g.,
14658 @samp{2005-09-14 00:56:06.998458565+05:30}.
14659 This is equivalent to the format @samp{%Y-%m-%d %H:%M:%S.%N%:z}.
14660
14661 @end table
14662
14663 @item -s @var{datestr}
14664 @itemx --set=@var{datestr}
14665 @opindex -s
14666 @opindex --set
14667 Set the date and time to @var{datestr}.  See @option{-d} above.
14668 See also @ref{Setting the time}.
14669
14670 @item -u
14671 @itemx --utc
14672 @itemx --universal
14673 @opindex -u
14674 @opindex --utc
14675 @opindex --universal
14676 @cindex Coordinated Universal Time
14677 @cindex UTC
14678 @cindex Greenwich Mean Time
14679 @cindex GMT
14680 @cindex leap seconds
14681 @vindex TZ
14682 Use Coordinated Universal Time (UTC) by operating as if the
14683 @env{TZ} environment variable were set to the string @samp{UTC0}.
14684 Coordinated
14685 Universal Time is often called ``Greenwich Mean Time'' (@sc{gmt}) for
14686 historical reasons.
14687 Typically, systems ignore leap seconds and thus implement an
14688 approximation to UTC rather than true UTC.
14689 @end table
14690
14691
14692 @node Examples of date
14693 @subsection Examples of @command{date}
14694
14695 @cindex examples of @command{date}
14696
14697 Here are a few examples.  Also see the documentation for the @option{-d}
14698 option in the previous section.
14699
14700 @itemize @bullet
14701
14702 @item
14703 To print the date of the day before yesterday:
14704
14705 @example
14706 date --date='2 days ago'
14707 @end example
14708
14709 @item
14710 To print the date of the day three months and one day hence:
14711
14712 @example
14713 date --date='3 months 1 day'
14714 @end example
14715
14716 @item
14717 To print the day of year of Christmas in the current year:
14718
14719 @example
14720 date --date='25 Dec' +%j
14721 @end example
14722
14723 @item
14724 To print the current full month name and the day of the month:
14725
14726 @example
14727 date '+%B %d'
14728 @end example
14729
14730 But this may not be what you want because for the first nine days of
14731 the month, the @samp{%d} expands to a zero-padded two-digit field,
14732 for example @samp{date -d 1may '+%B %d'} will print @samp{May 01}.
14733
14734 @item
14735 To print a date without the leading zero for one-digit days
14736 of the month, you can use the (GNU extension)
14737 @samp{-} flag to suppress
14738 the padding altogether:
14739
14740 @example
14741 date -d 1may '+%B %-d
14742 @end example
14743
14744 @item
14745 To print the current date and time in the format required by many
14746 non-GNU versions of @command{date} when setting the system clock:
14747
14748 @example
14749 date +%m%d%H%M%Y.%S
14750 @end example
14751
14752 @item
14753 To set the system clock forward by two minutes:
14754
14755 @example
14756 date --set='+2 minutes'
14757 @end example
14758
14759 @item
14760 To print the date in RFC 2822 format,
14761 use @samp{date --rfc-2822}.  Here is some example output:
14762
14763 @example
14764 Fri, 09 Sep 2005 13:51:39 -0700
14765 @end example
14766
14767 @anchor{%s-examples}
14768 @item
14769 To convert a date string to the number of seconds since the epoch
14770 (which is 1970-01-01 00:00:00 UTC), use the @option{--date} option with
14771 the @samp{%s} format.  That can be useful in sorting and/or graphing
14772 and/or comparing data by date.  The following command outputs the
14773 number of the seconds since the epoch for the time two minutes after the
14774 epoch:
14775
14776 @example
14777 date --date='1970-01-01 00:02:00 +0000' +%s
14778 120
14779 @end example
14780
14781 If you do not specify time zone information in the date string,
14782 @command{date} uses your computer's idea of the time zone when
14783 interpreting the string.  For example, if your computer's time zone is
14784 that of Cambridge, Massachusetts, which was then 5 hours (i.e., 18,000
14785 seconds) behind UTC:
14786
14787 @example
14788 # local time zone used
14789 date --date='1970-01-01 00:02:00' +%s
14790 18120
14791 @end example
14792
14793 @item
14794 If you're sorting or graphing dated data, your raw date values may be
14795 represented as seconds since the epoch.  But few people can look at
14796 the date @samp{946684800} and casually note ``Oh, that's the first second
14797 of the year 2000 in Greenwich, England.''
14798
14799 @example
14800 date --date='2000-01-01 UTC' +%s
14801 946684800
14802 @end example
14803
14804 An alternative is to use the @option{--utc} (@option{-u}) option.
14805 Then you may omit @samp{UTC} from the date string.  Although this
14806 produces the same result for @samp{%s} and many other format sequences,
14807 with a time zone offset different from zero, it would give a different
14808 result for zone-dependent formats like @samp{%z}.
14809
14810 @example
14811 date -u --date=2000-01-01 +%s
14812 946684800
14813 @end example
14814
14815 To convert such an unwieldy number of seconds back to
14816 a more readable form, use a command like this:
14817
14818 @smallexample
14819 # local time zone used
14820 date -d '1970-01-01 UTC 946684800 seconds' +"%Y-%m-%d %T %z"
14821 1999-12-31 19:00:00 -0500
14822 @end smallexample
14823
14824 Or if you do not mind depending on the @samp{@@} feature present since
14825 coreutils 5.3.0, you could shorten this to:
14826
14827 @smallexample
14828 date -d @@946684800 +"%F %T %z"
14829 1999-12-31 19:00:00 -0500
14830 @end smallexample
14831
14832 Often it is better to output UTC-relative date and time:
14833
14834 @smallexample
14835 date -u -d '1970-01-01 946684800 seconds' +"%Y-%m-%d %T %z"
14836 2000-01-01 00:00:00 +0000
14837 @end smallexample
14838
14839 @item
14840 @cindex leap seconds
14841 Typically the seconds count omits leap seconds, but some systems are
14842 exceptions.  Because leap seconds are not predictable, the mapping
14843 between the seconds count and a future timestamp is not reliable on
14844 the atypical systems that include leap seconds in their counts.
14845
14846 Here is how the two kinds of systems handle the leap second at
14847 2012-06-30 23:59:60 UTC:
14848
14849 @example
14850 # Typical systems ignore leap seconds:
14851 date --date='2012-06-30 23:59:59 +0000' +%s
14852 1341100799
14853 date --date='2012-06-30 23:59:60 +0000' +%s
14854 date: invalid date '2012-06-30 23:59:60 +0000'
14855 date --date='2012-07-01 00:00:00 +0000' +%s
14856 1341100800
14857 @end example
14858
14859 @example
14860 # Atypical systems count leap seconds:
14861 date --date='2012-06-30 23:59:59 +0000' +%s
14862 1341100823
14863 date --date='2012-06-30 23:59:60 +0000' +%s
14864 1341100824
14865 date --date='2012-07-01 00:00:00 +0000' +%s
14866 1341100825
14867 @end example
14868
14869 @end itemize
14870
14871
14872 @node arch invocation
14873 @section @command{arch}: Print machine hardware name
14874
14875 @pindex arch
14876 @cindex print machine hardware name
14877 @cindex system information, printing
14878
14879 @command{arch} prints the machine hardware name,
14880 and is equivalent to @samp{uname -m}.
14881 Synopsis:
14882
14883 @example
14884 arch [@var{option}]
14885 @end example
14886
14887 The program accepts the @ref{Common options} only.
14888
14889 @exitstatus
14890
14891
14892 @node nproc invocation
14893 @section @command{nproc}: Print the number of available processors
14894
14895 @pindex nproc
14896 @cindex Print the number of processors
14897 @cindex system information, printing
14898
14899 Print the number of processing units available to the current process,
14900 which may be less than the number of online processors.
14901 If this information is not accessible, then print the number of
14902 processors installed.  If the @env{OMP_NUM_THREADS} environment variable is
14903 set, then it will determine the returned value.  The result is guaranteed to be
14904 greater than zero.  Synopsis:
14905
14906 @example
14907 nproc [@var{option}]
14908 @end example
14909
14910 The program accepts the following options.  Also see @ref{Common options}.
14911
14912 @table @samp
14913
14914 @item --all
14915 @opindex --all
14916 Print the number of installed processors on the system, which may
14917 be greater than the number online or available to the current process.
14918 The @env{OMP_NUM_THREADS} environment variable is not honored in this case.
14919
14920 @item --ignore=@var{number}
14921 @opindex --ignore
14922 If possible, exclude this @var{number} of processing units.
14923
14924 @end table
14925
14926 @exitstatus
14927
14928
14929 @node uname invocation
14930 @section @command{uname}: Print system information
14931
14932 @pindex uname
14933 @cindex print system information
14934 @cindex system information, printing
14935
14936 @command{uname} prints information about the machine and operating system
14937 it is run on.  If no options are given, @command{uname} acts as if the
14938 @option{-s} option were given.  Synopsis:
14939
14940 @example
14941 uname [@var{option}]@dots{}
14942 @end example
14943
14944 If multiple options or @option{-a} are given, the selected information is
14945 printed in this order:
14946
14947 @example
14948 @var{kernel-name} @var{nodename} @var{kernel-release} @var{kernel-version}
14949 @var{machine} @var{processor} @var{hardware-platform} @var{operating-system}
14950 @end example
14951
14952 The information may contain internal spaces, so such output cannot be
14953 parsed reliably.  In the following example, @var{release} is
14954 @samp{2.2.18ss.e820-bda652a #4 SMP Tue Jun 5 11:24:08 PDT 2001}:
14955
14956 @smallexample
14957 uname -a
14958 @result{} Linux dumdum 2.2.18 #4 SMP Tue Jun 5 11:24:08 PDT 2001 i686@c
14959  unknown unknown GNU/Linux
14960 @end smallexample
14961
14962
14963 The program accepts the following options.  Also see @ref{Common options}.
14964
14965 @table @samp
14966
14967 @item -a
14968 @itemx --all
14969 @opindex -a
14970 @opindex --all
14971 Print all of the below information, except omit the processor type
14972 and the hardware platform name if they are unknown.
14973
14974 @item -i
14975 @itemx --hardware-platform
14976 @opindex -i
14977 @opindex --hardware-platform
14978 @cindex implementation, hardware
14979 @cindex hardware platform
14980 @cindex platform, hardware
14981 Print the hardware platform name
14982 (sometimes called the hardware implementation).
14983 Print @samp{unknown} if the kernel does not make this information
14984 easily available, as is the case with Linux kernels.
14985
14986 @item -m
14987 @itemx --machine
14988 @opindex -m
14989 @opindex --machine
14990 @cindex machine type
14991 @cindex hardware class
14992 @cindex hardware type
14993 Print the machine hardware name (sometimes called the hardware class
14994 or hardware type).
14995
14996 @item -n
14997 @itemx --nodename
14998 @opindex -n
14999 @opindex --nodename
15000 @cindex hostname
15001 @cindex node name
15002 @cindex network node name
15003 Print the network node hostname.
15004
15005 @item -p
15006 @itemx --processor
15007 @opindex -p
15008 @opindex --processor
15009 @cindex host processor type
15010 Print the processor type (sometimes called the instruction set
15011 architecture or ISA).
15012 Print @samp{unknown} if the kernel does not make this information
15013 easily available, as is the case with Linux kernels.
15014
15015 @item -o
15016 @itemx --operating-system
15017 @opindex -o
15018 @opindex --operating-system
15019 @cindex operating system name
15020 Print the name of the operating system.
15021
15022 @item -r
15023 @itemx --kernel-release
15024 @opindex -r
15025 @opindex --kernel-release
15026 @cindex kernel release
15027 @cindex release of kernel
15028 Print the kernel release.
15029
15030 @item -s
15031 @itemx --kernel-name
15032 @opindex -s
15033 @opindex --kernel-name
15034 @cindex kernel name
15035 @cindex name of kernel
15036 Print the kernel name.
15037 POSIX 1003.1-2001 (@pxref{Standards conformance}) calls this
15038 ``the implementation of the operating system'', because the
15039 POSIX specification itself has no notion of ``kernel''.
15040 The kernel name might be the same as the operating system name printed
15041 by the @option{-o} or @option{--operating-system} option, but it might
15042 differ.  Some operating systems (e.g., FreeBSD, HP-UX) have the same
15043 name as their underlying kernels; others (e.g., GNU/Linux, Solaris)
15044 do not.
15045
15046 @item -v
15047 @itemx --kernel-version
15048 @opindex -v
15049 @opindex --kernel-version
15050 @cindex kernel version
15051 @cindex version of kernel
15052 Print the kernel version.
15053
15054 @end table
15055
15056 @exitstatus
15057
15058
15059 @node hostname invocation
15060 @section @command{hostname}: Print or set system name
15061
15062 @pindex hostname
15063 @cindex setting the hostname
15064 @cindex printing the hostname
15065 @cindex system name, printing
15066 @cindex appropriate privileges
15067
15068 With no arguments, @command{hostname} prints the name of the current host
15069 system.  With one argument, it sets the current host name to the
15070 specified string.  You must have appropriate privileges to set the host
15071 name.  Synopsis:
15072
15073 @example
15074 hostname [@var{name}]
15075 @end example
15076
15077 The only options are @option{--help} and @option{--version}.  @xref{Common
15078 options}.
15079
15080 @exitstatus
15081
15082
15083 @node hostid invocation
15084 @section @command{hostid}: Print numeric host identifier
15085
15086 @pindex hostid
15087 @cindex printing the host identifier
15088
15089 @command{hostid} prints the numeric identifier of the current host
15090 in hexadecimal.  This command accepts no arguments.
15091 The only options are @option{--help} and @option{--version}.
15092 @xref{Common options}.
15093
15094 For example, here's what it prints on one system I use:
15095
15096 @example
15097 $ hostid
15098 1bac013d
15099 @end example
15100
15101 On that system, the 32-bit quantity happens to be closely
15102 related to the system's Internet address, but that isn't always
15103 the case.
15104
15105 @exitstatus
15106
15107 @node uptime invocation
15108 @section @command{uptime}: Print system uptime and load
15109
15110 @pindex uptime
15111 @cindex printing the system uptime and load
15112
15113 @command{uptime} prints the current time, the system's uptime, the
15114 number of logged-in users and the current load average.
15115
15116 If an argument is specified, it is used as the file to be read
15117 to discover how many users are logged in.  If no argument is
15118 specified, a system default is used (@command{uptime --help} indicates
15119 the default setting).
15120
15121 The only options are @option{--help} and @option{--version}.
15122 @xref{Common options}.
15123
15124 For example, here's what it prints right now on one system I use:
15125
15126 @example
15127 $ uptime
15128  14:07  up   3:35,  3 users,  load average: 1.39, 1.15, 1.04
15129 @end example
15130
15131 The precise method of calculation of load average varies somewhat
15132 between systems.  Some systems calculate it as the average number of
15133 runnable processes over the last 1, 5 and 15 minutes, but some systems
15134 also include processes in the uninterruptible sleep state (that is,
15135 those processes which are waiting for disk I/O).  The Linux kernel
15136 includes uninterruptible processes.
15137
15138 @node SELinux context
15139 @chapter SELinux context
15140
15141 @cindex SELinux context
15142 @cindex SELinux, context
15143 @cindex commands for SELinux context
15144
15145 This section describes commands for operations with SELinux
15146 contexts.
15147
15148 @menu
15149 * chcon invocation::            Change SELinux context of file
15150 * runcon invocation::           Run a command in specified SELinux context
15151 @end menu
15152
15153 @node chcon invocation
15154 @section @command{chcon}: Change SELinux context of file
15155
15156 @pindex chcon
15157 @cindex changing security context
15158 @cindex change SELinux context
15159
15160 @command{chcon} changes the SELinux security context of the selected files.
15161 Synopses:
15162
15163 @smallexample
15164 chcon [@var{option}]@dots{} @var{context} @var{file}@dots{}
15165 chcon [@var{option}]@dots{} [-u @var{user}] [-r @var{role}] [-l @var{range}]@c
15166  [-t @var{type}] @var{file}@dots{}
15167 chcon [@var{option}]@dots{} --reference=@var{rfile} @var{file}@dots{}
15168 @end smallexample
15169
15170 Change the SELinux security context of each @var{file} to @var{context}.
15171 With @option{--reference}, change the security context of each @var{file}
15172 to that of @var{rfile}.
15173
15174 The program accepts the following options.  Also see @ref{Common options}.
15175
15176 @table @samp
15177
15178 @item -h
15179 @itemx --no-dereference
15180 @opindex -h
15181 @opindex --no-dereference
15182 @cindex no dereference
15183 Affect symbolic links instead of any referenced file.
15184
15185 @item --reference=@var{rfile}
15186 @opindex --reference
15187 @cindex reference file
15188 Use @var{rfile}'s security context rather than specifying a @var{context} value.
15189
15190 @item -R
15191 @itemx --recursive
15192 @opindex -R
15193 @opindex --recursive
15194 Operate on files and directories recursively.
15195
15196 @choptH
15197 @xref{Traversing symlinks}.
15198
15199 @choptL
15200 @xref{Traversing symlinks}.
15201
15202 @choptP
15203 @xref{Traversing symlinks}.
15204
15205 @item -v
15206 @itemx --verbose
15207 @opindex -v
15208 @opindex --verbose
15209 @cindex diagnostic
15210 Output a diagnostic for every file processed.
15211
15212 @item -u @var{user}
15213 @itemx --user=@var{user}
15214 @opindex -u
15215 @opindex --user
15216 Set user @var{user} in the target security context.
15217
15218 @item -r @var{role}
15219 @itemx --role=@var{role}
15220 @opindex -r
15221 @opindex --role
15222 Set role @var{role} in the target security context.
15223
15224 @item -t @var{type}
15225 @itemx --type=@var{type}
15226 @opindex -t
15227 @opindex --type
15228 Set type @var{type} in the target security context.
15229
15230 @item -l @var{range}
15231 @itemx --range=@var{range}
15232 @opindex -l
15233 @opindex --range
15234 Set range @var{range} in the target security context.
15235
15236 @end table
15237
15238 @exitstatus
15239
15240 @node runcon invocation
15241 @section @command{runcon}: Run a command in specified SELinux context
15242
15243 @pindex runcon
15244 @cindex run with security context
15245
15246
15247 @command{runcon} runs file in specified SELinux security context.
15248
15249 Synopses:
15250 @smallexample
15251 runcon @var{context} @var{command} [@var{args}]
15252 runcon [ -c ] [-u @var{user}] [-r @var{role}] [-t @var{type}]@c
15253  [-l @var{range}] @var{command} [@var{args}]
15254 @end smallexample
15255
15256 Run @var{command} with completely-specified @var{context}, or with
15257 current or transitioned security context modified by one or more of @var{level},
15258 @var{role}, @var{type} and @var{user}.
15259
15260 If none of @option{-c}, @option{-t}, @option{-u}, @option{-r}, or @option{-l}
15261 is specified, the first argument is used as the complete context.
15262 Any additional arguments after @var{command}
15263 are interpreted as arguments to the command.
15264
15265 With neither @var{context} nor @var{command}, print the current
15266 security context.
15267
15268 The program accepts the following options.  Also see @ref{Common options}.
15269
15270 @table @samp
15271
15272 @item -c
15273 @itemx --compute
15274 @opindex -c
15275 @opindex --compute
15276 Compute process transition context before modifying.
15277
15278 @item -u @var{user}
15279 @itemx --user=@var{user}
15280 @opindex -u
15281 @opindex --user
15282 Set user @var{user} in the target security context.
15283
15284 @item -r @var{role}
15285 @itemx --role=@var{role}
15286 @opindex -r
15287 @opindex --role
15288 Set role @var{role} in the target security context.
15289
15290 @item -t @var{type}
15291 @itemx --type=@var{type}
15292 @opindex -t
15293 @opindex --type
15294 Set type @var{type} in the target security context.
15295
15296 @item -l @var{range}
15297 @itemx --range=@var{range}
15298 @opindex -l
15299 @opindex --range
15300 Set range @var{range} in the target security context.
15301
15302 @end table
15303
15304 @cindex exit status of @command{runcon}
15305 Exit status:
15306
15307 @display
15308 126 if @var{command} is found but cannot be invoked
15309 127 if @command{runcon} itself fails or if @var{command} cannot be found
15310 the exit status of @var{command} otherwise
15311 @end display
15312
15313 @node Modified command invocation
15314 @chapter Modified command invocation
15315
15316 @cindex modified command invocation
15317 @cindex invocation of commands, modified
15318 @cindex commands for invoking other commands
15319
15320 This section describes commands that run other commands in some context
15321 different than the current one: a modified environment, as a different
15322 user, etc.
15323
15324 @menu
15325 * chroot invocation::           Modify the root directory.
15326 * env invocation::              Modify environment variables.
15327 * nice invocation::             Modify niceness.
15328 * nohup invocation::            Immunize to hangups.
15329 * stdbuf invocation::           Modify buffering of standard streams.
15330 * timeout invocation::          Run with time limit.
15331 @end menu
15332
15333
15334 @node chroot invocation
15335 @section @command{chroot}: Run a command with a different root directory
15336
15337 @pindex chroot
15338 @cindex running a program in a specified root directory
15339 @cindex root directory, running a program in a specified
15340
15341 @command{chroot} runs a command with a specified root directory.
15342 On many systems, only the super-user can do this.@footnote{However,
15343 some systems (e.g., FreeBSD) can be configured to allow certain regular
15344 users to use the @code{chroot} system call, and hence to run this program.
15345 Also, on Cygwin, anyone can run the @command{chroot} command, because the
15346 underlying function is non-privileged due to lack of support in MS-Windows.}
15347 Synopses:
15348
15349 @example
15350 chroot @var{option} @var{newroot} [@var{command} [@var{args}]@dots{}]
15351 chroot @var{option}
15352 @end example
15353
15354 Ordinarily, file names are looked up starting at the root of the
15355 directory structure, i.e., @file{/}.  @command{chroot} changes the root to
15356 the directory @var{newroot} (which must exist) and then runs
15357 @var{command} with optional @var{args}.  If @var{command} is not
15358 specified, the default is the value of the @env{SHELL} environment
15359 variable or @command{/bin/sh} if not set, invoked with the @option{-i} option.
15360 @var{command} must not be a special built-in utility
15361 (@pxref{Special built-in utilities}).
15362
15363 The program accepts the following options.  Also see @ref{Common options}.
15364 Options must precede operands.
15365
15366 @table @samp
15367
15368 @item --userspec=@var{user}[:@var{group}]
15369 @opindex --userspec
15370 By default, @var{command} is run with the same credentials
15371 as the invoking process.
15372 Use this option to run it as a different @var{user} and/or with a
15373 different primary @var{group}.
15374
15375 @item --groups=@var{groups}
15376 @opindex --groups
15377 Use this option to specify the supplementary @var{groups} to be
15378 used by the new process.
15379 The items in the list (names or numeric IDs) must be separated by commas.
15380
15381 @end table
15382
15383 Here are a few tips to help avoid common problems in using chroot.
15384 To start with a simple example, make @var{command} refer to a statically
15385 linked binary.  If you were to use a dynamically linked executable, then
15386 you'd have to arrange to have the shared libraries in the right place under
15387 your new root directory.
15388
15389 For example, if you create a statically linked @command{ls} executable,
15390 and put it in @file{/tmp/empty}, you can run this command as root:
15391
15392 @example
15393 $ chroot /tmp/empty /ls -Rl /
15394 @end example
15395
15396 Then you'll see output like this:
15397
15398 @example
15399 /:
15400 total 1023
15401 -rwxr-xr-x 1 0 0 1041745 Aug 16 11:17 ls
15402 @end example
15403
15404 If you want to use a dynamically linked executable, say @command{bash},
15405 then first run @samp{ldd bash} to see what shared objects it needs.
15406 Then, in addition to copying the actual binary, also copy the listed
15407 files to the required positions under your intended new root directory.
15408 Finally, if the executable requires any other files (e.g., data, state,
15409 device files), copy them into place, too.
15410
15411 @cindex exit status of @command{chroot}
15412 Exit status:
15413
15414 @display
15415 125 if @command{chroot} itself fails
15416 126 if @var{command} is found but cannot be invoked
15417 127 if @var{command} cannot be found
15418 the exit status of @var{command} otherwise
15419 @end display
15420
15421
15422 @node env invocation
15423 @section @command{env}: Run a command in a modified environment
15424
15425 @pindex env
15426 @cindex environment, running a program in a modified
15427 @cindex modified environment, running a program in a
15428 @cindex running a program in a modified environment
15429
15430 @command{env} runs a command with a modified environment.  Synopses:
15431
15432 @example
15433 env [@var{option}]@dots{} [@var{name}=@var{value}]@dots{} @c
15434 [@var{command} [@var{args}]@dots{}]
15435 env
15436 @end example
15437
15438 Operands of the form @samp{@var{variable}=@var{value}} set
15439 the environment variable @var{variable} to value @var{value}.
15440 @var{value} may be empty (@samp{@var{variable}=}).  Setting a variable
15441 to an empty value is different from unsetting it.
15442 These operands are evaluated left-to-right, so if two operands
15443 mention the same variable the earlier is ignored.
15444
15445 Environment variable names can be empty, and can contain any
15446 characters other than @samp{=} and ASCII @sc{nul}.
15447 However, it is wise to limit yourself to names that
15448 consist solely of underscores, digits, and ASCII letters,
15449 and that begin with a non-digit, as applications like the shell do not
15450 work well with other names.
15451
15452 @vindex PATH
15453 The first operand that does not contain the character @samp{=}
15454 specifies the program to invoke; it is
15455 searched for according to the @env{PATH} environment variable.  Any
15456 remaining arguments are passed as arguments to that program.
15457 The program should not be a special built-in utility
15458 (@pxref{Special built-in utilities}).
15459
15460 Modifications to @env{PATH} take effect prior to searching for
15461 @var{command}.  Use caution when reducing @env{PATH}; behavior is
15462 not portable when @env{PATH} is undefined or omits key directories
15463 such as @file{/bin}.
15464
15465 In the rare case that a utility contains a @samp{=} in the name, the
15466 only way to disambiguate it from a variable assignment is to use an
15467 intermediate command for @var{command}, and pass the problematic
15468 program name via @var{args}.  For example, if @file{./prog=} is an
15469 executable in the current @env{PATH}:
15470
15471 @example
15472 env prog= true # runs 'true', with prog= in environment
15473 env ./prog= true # runs 'true', with ./prog= in environment
15474 env -- prog= true # runs 'true', with prog= in environment
15475 env sh -c '\prog= true' # runs 'prog=' with argument 'true'
15476 env sh -c 'exec "$@@"' sh prog= true # also runs 'prog='
15477 @end example
15478
15479 @cindex environment, printing
15480
15481 If no command name is specified following the environment
15482 specifications, the resulting environment is printed.  This is like
15483 specifying the @command{printenv} program.
15484
15485 For some examples, suppose the environment passed to @command{env}
15486 contains @samp{LOGNAME=rms}, @samp{EDITOR=emacs}, and
15487 @samp{PATH=.:/gnubin:/hacks}:
15488
15489 @itemize @bullet
15490
15491 @item
15492 Output the current environment.
15493 @example
15494 $ env | LC_ALL=C sort
15495 EDITOR=emacs
15496 LOGNAME=rms
15497 PATH=.:/gnubin:/hacks
15498 @end example
15499
15500 @item
15501 Run @command{foo} with a reduced environment, preserving only the
15502 original @env{PATH} to avoid problems in locating @command{foo}.
15503 @example
15504 env - PATH="$PATH" foo
15505 @end example
15506
15507 @item
15508 Run @command{foo} with the environment containing @samp{LOGNAME=rms},
15509 @samp{EDITOR=emacs}, and @samp{PATH=.:/gnubin:/hacks}, and guarantees
15510 that @command{foo} was found in the file system rather than as a shell
15511 built-in.
15512 @example
15513 env foo
15514 @end example
15515
15516 @item
15517 Run @command{nemacs} with the environment containing @samp{LOGNAME=foo},
15518 @samp{EDITOR=emacs}, @samp{PATH=.:/gnubin:/hacks}, and
15519 @samp{DISPLAY=gnu:0}.
15520 @example
15521 env DISPLAY=gnu:0 LOGNAME=foo nemacs
15522 @end example
15523
15524 @item
15525 Attempt to run the program @command{/energy/--} (as that is the only
15526 possible path search result); if the command exists, the environment
15527 will contain @samp{LOGNAME=rms} and @samp{PATH=/energy}, and the
15528 arguments will be @samp{e=mc2}, @samp{bar}, and @samp{baz}.
15529 @example
15530 env -u EDITOR PATH=/energy -- e=mc2 bar baz
15531 @end example
15532
15533 @end itemize
15534
15535
15536 The program accepts the following options.  Also see @ref{Common options}.
15537 Options must precede operands.
15538
15539 @table @samp
15540
15541 @optNull{env}
15542
15543 @item -u @var{name}
15544 @itemx --unset=@var{name}
15545 @opindex -u
15546 @opindex --unset
15547 Remove variable @var{name} from the environment, if it was in the
15548 environment.
15549
15550 @item -
15551 @itemx -i
15552 @itemx --ignore-environment
15553 @opindex -
15554 @opindex -i
15555 @opindex --ignore-environment
15556 Start with an empty environment, ignoring the inherited environment.
15557
15558 @end table
15559
15560 @cindex exit status of @command{env}
15561 Exit status:
15562
15563 @display
15564 0   if no @var{command} is specified and the environment is output
15565 125 if @command{env} itself fails
15566 126 if @var{command} is found but cannot be invoked
15567 127 if @var{command} cannot be found
15568 the exit status of @var{command} otherwise
15569 @end display
15570
15571
15572 @node nice invocation
15573 @section @command{nice}: Run a command with modified niceness
15574
15575 @pindex nice
15576 @cindex niceness
15577 @cindex scheduling, affecting
15578 @cindex appropriate privileges
15579
15580 @command{nice} prints or modifies a process's @dfn{niceness},
15581 a parameter that affects whether the process is scheduled favorably.
15582 Synopsis:
15583
15584 @example
15585 nice [@var{option}]@dots{} [@var{command} [@var{arg}]@dots{}]
15586 @end example
15587
15588 If no arguments are given, @command{nice} prints the current niceness.
15589 Otherwise, @command{nice} runs the given @var{command} with its
15590 niceness adjusted.  By default, its niceness is incremented by 10.
15591
15592 Niceness values range at least from @minus{}20 (process has high priority
15593 and gets more resources, thus slowing down other processes) through 19
15594 (process has lower priority and runs slowly itself, but has less impact
15595 on the speed of other running processes).  Some systems
15596 may have a wider range of nicenesses; conversely, other systems may
15597 enforce more restrictive limits.  An attempt to set the niceness
15598 outside the supported range is treated as an attempt to use the
15599 minimum or maximum supported value.
15600
15601 A niceness should not be confused with a scheduling priority, which
15602 lets applications determine the order in which threads are scheduled
15603 to run.  Unlike a priority, a niceness is merely advice to the
15604 scheduler, which the scheduler is free to ignore.  Also, as a point of
15605 terminology, POSIX defines the behavior of @command{nice} in
15606 terms of a @dfn{nice value}, which is the nonnegative difference
15607 between a niceness and the minimum niceness.  Though @command{nice}
15608 conforms to POSIX, its documentation and diagnostics use the
15609 term ``niceness'' for compatibility with historical practice.
15610
15611 @var{command} must not be a special built-in utility (@pxref{Special
15612 built-in utilities}).
15613
15614 @mayConflictWithShellBuiltIn{nice}
15615
15616 The program accepts the following option.  Also see @ref{Common options}.
15617 Options must precede operands.
15618
15619 @table @samp
15620 @item -n @var{adjustment}
15621 @itemx --adjustment=@var{adjustment}
15622 @opindex -n
15623 @opindex --adjustment
15624 Add @var{adjustment} instead of 10 to the command's niceness.  If
15625 @var{adjustment} is negative and you lack appropriate privileges,
15626 @command{nice} issues a warning but otherwise acts as if you specified
15627 a zero adjustment.
15628
15629 For compatibility @command{nice} also supports an obsolete
15630 option syntax @option{-@var{adjustment}}.  New scripts should use
15631 @option{-n @var{adjustment}} instead.
15632
15633 @end table
15634
15635 @cindex exit status of @command{nice}
15636 Exit status:
15637
15638 @display
15639 0   if no @var{command} is specified and the niceness is output
15640 125 if @command{nice} itself fails
15641 126 if @var{command} is found but cannot be invoked
15642 127 if @var{command} cannot be found
15643 the exit status of @var{command} otherwise
15644 @end display
15645
15646 It is sometimes useful to run a non-interactive program with reduced niceness.
15647
15648 @example
15649 $ nice factor 4611686018427387903
15650 @end example
15651
15652 Since @command{nice} prints the current niceness,
15653 you can invoke it through itself to demonstrate how it works.
15654
15655 The default behavior is to increase the niceness by @samp{10}:
15656
15657 @example
15658 $ nice
15659 0
15660 $ nice nice
15661 10
15662 $ nice -n 10 nice
15663 10
15664 @end example
15665
15666 The @var{adjustment} is relative to the current niceness.  In the
15667 next example, the first @command{nice} invocation runs the second one
15668 with niceness 10, and it in turn runs the final one with a niceness
15669 that is 3 more:
15670
15671 @example
15672 $ nice nice -n 3 nice
15673 13
15674 @end example
15675
15676 Specifying a niceness larger than the supported range
15677 is the same as specifying the maximum supported value:
15678
15679 @example
15680 $ nice -n 10000000000 nice
15681 19
15682 @end example
15683
15684 Only a privileged user may run a process with lower niceness:
15685
15686 @example
15687 $ nice -n -1 nice
15688 nice: cannot set niceness: Permission denied
15689 0
15690 $ sudo nice -n -1 nice
15691 -1
15692 @end example
15693
15694
15695 @node nohup invocation
15696 @section @command{nohup}: Run a command immune to hangups
15697
15698 @pindex nohup
15699 @cindex hangups, immunity to
15700 @cindex immunity to hangups
15701 @cindex logging out and continuing to run
15702
15703 @flindex nohup.out
15704 @command{nohup} runs the given @var{command} with hangup signals ignored,
15705 so that the command can continue running in the background after you log
15706 out.  Synopsis:
15707
15708 @example
15709 nohup @var{command} [@var{arg}]@dots{}
15710 @end example
15711
15712 If standard input is a terminal, it is redirected from
15713 @file{/dev/null} so that terminal sessions do not mistakenly consider
15714 the terminal to be used by the command.  This is a GNU
15715 extension; programs intended to be portable to non-GNU hosts
15716 should use @samp{nohup @var{command} [@var{arg}]@dots{} </dev/null}
15717 instead.
15718
15719 @flindex nohup.out
15720 If standard output is a terminal, the command's standard output is appended
15721 to the file @file{nohup.out}; if that cannot be written to, it is appended
15722 to the file @file{$HOME/nohup.out}; and if that cannot be written to, the
15723 command is not run.
15724 Any @file{nohup.out} or @file{$HOME/nohup.out} file created by
15725 @command{nohup} is made readable and writable only to the user,
15726 regardless of the current umask settings.
15727
15728 If standard error is a terminal, it is normally redirected to the same file
15729 descriptor as the (possibly-redirected) standard output.
15730 However, if standard output is closed, standard error terminal output
15731 is instead appended to the file @file{nohup.out} or
15732 @file{$HOME/nohup.out} as above.
15733
15734 To capture the command's output to a file other than @file{nohup.out}
15735 you can redirect it.  For example, to capture the output of
15736 @command{make}:
15737
15738 @example
15739 nohup make > make.log
15740 @end example
15741
15742 @command{nohup} does not automatically put the command it runs in the
15743 background; you must do that explicitly, by ending the command line
15744 with an @samp{&}.  Also, @command{nohup} does not alter the
15745 niceness of @var{command}; use @command{nice} for that,
15746 e.g., @samp{nohup nice @var{command}}.
15747
15748 @var{command} must not be a special built-in utility (@pxref{Special
15749 built-in utilities}).
15750
15751 The only options are @option{--help} and @option{--version}.  @xref{Common
15752 options}.  Options must precede operands.
15753
15754 @cindex exit status of @command{nohup}
15755 Exit status:
15756
15757 @display
15758 125 if @command{nohup} itself fails, and @env{POSIXLY_CORRECT} is not set
15759 126 if @var{command} is found but cannot be invoked
15760 127 if @var{command} cannot be found
15761 the exit status of @var{command} otherwise
15762 @end display
15763
15764 If @env{POSIXLY_CORRECT} is set, internal failures give status 127
15765 instead of 125.
15766
15767
15768 @node stdbuf invocation
15769 @section @command{stdbuf}: Run a command with modified I/O stream buffering
15770
15771 @pindex stdbuf
15772 @cindex standard streams, buffering
15773 @cindex line buffered
15774
15775 @command{stdbuf} allows one to modify the buffering operations of the
15776 three standard I/O streams associated with a program.  Synopsis:
15777
15778 @example
15779 stdbuf @var{option}@dots{} @var{command}
15780 @end example
15781
15782 @var{command} must start with the name of a program that
15783 @enumerate
15784 @item
15785 uses the ISO C @code{FILE} streams for input/output (note the
15786 programs @command{dd} and @command{cat} don't do that),
15787
15788 @item
15789 does not adjust the buffering of its standard streams (note the
15790 program @command{tee} is not in this category).
15791 @end enumerate
15792
15793 Any additional @var{arg}s are passed as additional arguments to the
15794 @var{command}.
15795
15796 The program accepts the following options.  Also see @ref{Common options}.
15797
15798 @table @samp
15799
15800 @item -i @var{mode}
15801 @itemx --input=@var{mode}
15802 @opindex -i
15803 @opindex --input
15804 Adjust the standard input stream buffering.
15805
15806 @item -o @var{mode}
15807 @itemx --output=@var{mode}
15808 @opindex -o
15809 @opindex --output
15810 Adjust the standard output stream buffering.
15811
15812 @item -e @var{mode}
15813 @itemx --error=@var{mode}
15814 @opindex -e
15815 @opindex --error
15816 Adjust the standard error stream buffering.
15817
15818 @end table
15819
15820 The @var{mode} can be specified as follows:
15821
15822 @table @samp
15823
15824 @item L
15825 Set the stream to line buffered mode.
15826 In this mode data is coalesced until a newline is output or
15827 input is read from any stream attached to a terminal device.
15828 This option is invalid with standard input.
15829
15830 @item 0
15831 Disable buffering of the selected stream.
15832 In this mode, data is output immediately and only the
15833 amount of data requested is read from input.
15834 Note the difference in function for input and output.
15835 Disabling buffering for input will not influence the responsiveness
15836 or blocking behavior of the stream input functions.
15837 For example @code{fread} will still block until @code{EOF} or error,
15838 even if the underlying @code{read} returns less data than requested.
15839
15840 @item @var{size}
15841 Specify the size of the buffer to use in fully buffered mode.
15842 @multiplierSuffixesNoBlocks{size}
15843
15844 @end table
15845
15846 @cindex exit status of @command{stdbuf}
15847 Exit status:
15848
15849 @display
15850 125 if @command{stdbuf} itself fails
15851 126 if @var{command} is found but cannot be invoked
15852 127 if @var{command} cannot be found
15853 the exit status of @var{command} otherwise
15854 @end display
15855
15856
15857 @node timeout invocation
15858 @section @command{timeout}: Run a command with a time limit
15859
15860 @pindex timeout
15861 @cindex time limit
15862 @cindex run commands with bounded time
15863
15864 @command{timeout} runs the given @var{command} and kills it if it is
15865 still running after the specified time interval.  Synopsis:
15866
15867 @example
15868 timeout [@var{option}] @var{duration} @var{command} [@var{arg}]@dots{}
15869 @end example
15870
15871 @var{command} must not be a special built-in utility (@pxref{Special
15872 built-in utilities}).
15873
15874 The program accepts the following options.  Also see @ref{Common options}.
15875 Options must precede operands.
15876
15877 @table @samp
15878 @item --foreground
15879 @opindex --foreground
15880 Don't create a separate background program group, so that
15881 the managed @var{command} can use the foreground TTY normally.
15882 This is needed to support timing out commands not started
15883 directly from an interactive shell, in two situations.
15884 @enumerate
15885 @item
15886 @var{command} is interactive and needs to read from the terminal for example
15887 @item
15888 the user wants to support sending signals directly to @var{command}
15889 from the terminal (like Ctrl-C for example)
15890 @end enumerate
15891
15892 Note in this mode of operation, any children of @var{command}
15893 will not be timed out.
15894
15895 @item -k @var{duration}
15896 @itemx --kill-after=@var{duration}
15897 @opindex -k
15898 @opindex --kill-after
15899 Ensure the monitored @var{command} is killed by also sending a @samp{KILL}
15900 signal, after the specified @var{duration}.  Without this option, if the
15901 selected signal proves not to be fatal, @command{timeout} does not kill
15902 the @var{command}.
15903
15904 @item -s @var{signal}
15905 @itemx --signal=@var{signal}
15906 @opindex -s
15907 @opindex --signal
15908 Send this @var{signal} to @var{command} on timeout, rather than the
15909 default @samp{TERM} signal.  @var{signal} may be a name like @samp{HUP}
15910 or a number.  @xref{Signal specifications}.
15911 @end table
15912
15913 @cindex time units
15914 @var{duration} is a floating point number followed by an optional unit:
15915 @display
15916 @samp{s} for seconds (the default)
15917 @samp{m} for minutes
15918 @samp{h} for hours
15919 @samp{d} for days
15920 @end display
15921 A duration of 0 disables the associated timeout.
15922 Note that the actual timeout duration is dependent on system conditions,
15923 which should be especially considered when specifying sub-second timeouts.
15924
15925 @cindex exit status of @command{timeout}
15926 Exit status:
15927
15928 @display
15929 124 if @var{command} times out
15930 125 if @command{timeout} itself fails
15931 126 if @var{command} is found but cannot be invoked
15932 127 if @var{command} cannot be found
15933 137 if @var{command} is sent the KILL(9) signal (128+9)
15934 the exit status of @var{command} otherwise
15935 @end display
15936
15937
15938 @node Process control
15939 @chapter Process control
15940
15941 @cindex processes, commands for controlling
15942 @cindex commands for controlling processes
15943
15944 @menu
15945 * kill invocation::             Sending a signal to processes.
15946 @end menu
15947
15948
15949 @node kill invocation
15950 @section @command{kill}: Send a signal to processes
15951
15952 @pindex kill
15953 @cindex send a signal to processes
15954
15955 The @command{kill} command sends a signal to processes, causing them
15956 to terminate or otherwise act upon receiving the signal in some way.
15957 Alternatively, it lists information about signals.  Synopses:
15958
15959 @example
15960 kill [-s @var{signal} | --signal @var{signal} | -@var{signal}] @var{pid}@dots{}
15961 kill [-l | --list | -t | --table] [@var{signal}]@dots{}
15962 @end example
15963
15964 @mayConflictWithShellBuiltIn{kill}
15965
15966 The first form of the @command{kill} command sends a signal to all
15967 @var{pid} arguments.  The default signal to send if none is specified
15968 is @samp{TERM}@.  The special signal number @samp{0} does not denote a
15969 valid signal, but can be used to test whether the @var{pid} arguments
15970 specify processes to which a signal could be sent.
15971
15972 If @var{pid} is positive, the signal is sent to the process with the
15973 process ID @var{pid}.  If @var{pid} is zero, the signal is sent to all
15974 processes in the process group of the current process.  If @var{pid}
15975 is @minus{}1, the signal is sent to all processes for which the user has
15976 permission to send a signal.  If @var{pid} is less than @minus{}1, the signal
15977 is sent to all processes in the process group that equals the absolute
15978 value of @var{pid}.
15979
15980 If @var{pid} is not positive, a system-dependent set of system
15981 processes is excluded from the list of processes to which the signal
15982 is sent.
15983
15984 If a negative @var{pid} argument is desired as the first one, it
15985 should be preceded by @option{--}.  However, as a common extension to
15986 POSIX, @option{--} is not required with @samp{kill
15987 -@var{signal} -@var{pid}}.  The following commands are equivalent:
15988
15989 @example
15990 kill -15 -1
15991 kill -TERM -1
15992 kill -s TERM -- -1
15993 kill -- -1
15994 @end example
15995
15996 The first form of the @command{kill} command succeeds if every @var{pid}
15997 argument specifies at least one process that the signal was sent to.
15998
15999 The second form of the @command{kill} command lists signal information.
16000 Either the @option{-l} or @option{--list} option, or the @option{-t}
16001 or @option{--table} option must be specified.  Without any
16002 @var{signal} argument, all supported signals are listed.  The output
16003 of @option{-l} or @option{--list} is a list of the signal names, one
16004 per line; if @var{signal} is already a name, the signal number is
16005 printed instead.  The output of @option{-t} or @option{--table} is a
16006 table of signal numbers, names, and descriptions.  This form of the
16007 @command{kill} command succeeds if all @var{signal} arguments are valid
16008 and if there is no output error.
16009
16010 The @command{kill} command also supports the @option{--help} and
16011 @option{--version} options.  @xref{Common options}.
16012
16013 A @var{signal} may be a signal name like @samp{HUP}, or a signal
16014 number like @samp{1}, or an exit status of a process terminated by the
16015 signal.  A signal name can be given in canonical form or prefixed by
16016 @samp{SIG}@.  The case of the letters is ignored, except for the
16017 @option{-@var{signal}} option which must use upper case to avoid
16018 ambiguity with lower case option letters.
16019 @xref{Signal specifications}, for a list of supported
16020 signal names and numbers.
16021
16022 @node Delaying
16023 @chapter Delaying
16024
16025 @cindex delaying commands
16026 @cindex commands for delaying
16027
16028 @c Perhaps @command{wait} or other commands should be described here also?
16029
16030 @menu
16031 * sleep invocation::            Delay for a specified time.
16032 @end menu
16033
16034
16035 @node sleep invocation
16036 @section @command{sleep}: Delay for a specified time
16037
16038 @pindex sleep
16039 @cindex delay for a specified time
16040
16041 @command{sleep} pauses for an amount of time specified by the sum of
16042 the values of the command line arguments.
16043 Synopsis:
16044
16045 @example
16046 sleep @var{number}[smhd]@dots{}
16047 @end example
16048
16049 @cindex time units
16050 Each argument is a number followed by an optional unit; the default
16051 is seconds.  The units are:
16052
16053 @table @samp
16054 @item s
16055 seconds
16056 @item m
16057 minutes
16058 @item h
16059 hours
16060 @item d
16061 days
16062 @end table
16063
16064 Historical implementations of @command{sleep} have required that
16065 @var{number} be an integer, and only accepted a single argument
16066 without a suffix.  However, GNU @command{sleep} accepts
16067 arbitrary floating point numbers.  @xref{Floating point}.
16068
16069 The only options are @option{--help} and @option{--version}.  @xref{Common
16070 options}.
16071
16072 @c sleep is a shell built-in at least with Solaris 11's /bin/sh
16073 @mayConflictWithShellBuiltIn{sleep}
16074
16075 @exitstatus
16076
16077
16078 @node Numeric operations
16079 @chapter Numeric operations
16080
16081 @cindex numeric operations
16082 These programs do numerically-related operations.
16083
16084 @menu
16085 * factor invocation::              Show factors of numbers.
16086 * seq invocation::                 Print sequences of numbers.
16087 @end menu
16088
16089
16090 @node factor invocation
16091 @section @command{factor}: Print prime factors
16092
16093 @pindex factor
16094 @cindex prime factors
16095
16096 @command{factor} prints prime factors.  Synopses:
16097
16098 @example
16099 factor [@var{number}]@dots{}
16100 factor @var{option}
16101 @end example
16102
16103 If no @var{number} is specified on the command line, @command{factor} reads
16104 numbers from standard input, delimited by newlines, tabs, or spaces.
16105
16106 The @command{factor} command supports only a small number of options:
16107
16108 @table @samp
16109 @item --help
16110 Print a short help on standard output, then exit without further
16111 processing.
16112
16113 @item --version
16114 Print the program version on standard output, then exit without further
16115 processing.
16116 @end table
16117
16118 Factoring the product of the eighth and ninth Mersenne primes
16119 takes about 30 milliseconds of CPU time on a 2.2 GHz Athlon.
16120
16121 @example
16122 M8=$(echo 2^31-1|bc)
16123 M9=$(echo 2^61-1|bc)
16124 n=$(echo "$M8 * $M9" | bc)
16125 /usr/bin/time -f %U factor $n
16126 4951760154835678088235319297: 2147483647 2305843009213693951
16127 0.03
16128 @end example
16129
16130 Similarly, factoring the eighth Fermat number @math{2^{256}+1} takes
16131 about 20 seconds on the same machine.
16132
16133 Factoring large numbers is, in general, hard.  The Pollard Rho
16134 algorithm used by @command{factor} is particularly effective for
16135 numbers with relatively small factors.  If you wish to factor large
16136 numbers which do not have small factors (for example, numbers which
16137 are the product of two large primes), other methods are far better.
16138
16139 If @command{factor} is built without using GNU MP, only
16140 single-precision arithmetic is available, and so large numbers
16141 (typically @math{2^{64}} and above) will not be supported.  The single-precision
16142 code uses an algorithm which is designed for factoring smaller
16143 numbers.
16144
16145 @exitstatus
16146
16147
16148 @node seq invocation
16149 @section @command{seq}: Print numeric sequences
16150
16151 @pindex seq
16152 @cindex numeric sequences
16153 @cindex sequence of numbers
16154
16155 @command{seq} prints a sequence of numbers to standard output.  Synopses:
16156
16157 @example
16158 seq [@var{option}]@dots{} @var{last}
16159 seq [@var{option}]@dots{} @var{first} @var{last}
16160 seq [@var{option}]@dots{} @var{first} @var{increment} @var{last}
16161 @end example
16162
16163 @command{seq} prints the numbers from @var{first} to @var{last} by
16164 @var{increment}.  By default, each number is printed on a separate line.
16165 When @var{increment} is not specified, it defaults to @samp{1},
16166 even when @var{first} is larger than @var{last}.
16167 @var{first} also defaults to @samp{1}.  So @code{seq 1} prints
16168 @samp{1}, but @code{seq 0} and @code{seq 10 5} produce no output.
16169 Floating-point numbers may be specified.  @xref{Floating point}.
16170
16171 The program accepts the following options.  Also see @ref{Common options}.
16172 Options must precede operands.
16173
16174 @table @samp
16175 @item -f @var{format}
16176 @itemx --format=@var{format}
16177 @opindex -f @var{format}
16178 @opindex --format=@var{format}
16179 @cindex formatting of numbers in @command{seq}
16180 Print all numbers using @var{format}.
16181 @var{format} must contain exactly one of the @samp{printf}-style
16182 floating point conversion specifications @samp{%a}, @samp{%e},
16183 @samp{%f}, @samp{%g}, @samp{%A}, @samp{%E}, @samp{%F}, @samp{%G}@.
16184 The @samp{%} may be followed by zero or more flags taken from the set
16185 @samp{-+#0 '}, then an optional width containing one or more digits,
16186 then an optional precision consisting of a @samp{.} followed by zero
16187 or more digits.  @var{format} may also contain any number of @samp{%%}
16188 conversion specifications.  All conversion specifications have the
16189 same meaning as with @samp{printf}.
16190
16191 The default format is derived from @var{first}, @var{step}, and
16192 @var{last}.  If these all use a fixed point decimal representation,
16193 the default format is @samp{%.@var{p}f}, where @var{p} is the minimum
16194 precision that can represent the output numbers exactly.  Otherwise,
16195 the default format is @samp{%g}.
16196
16197 @item -s @var{string}
16198 @itemx --separator=@var{string}
16199 @cindex separator for numbers in @command{seq}
16200 Separate numbers with @var{string}; default is a newline.
16201 The output always terminates with a newline.
16202
16203 @item -w
16204 @itemx --equal-width
16205 Print all numbers with the same width, by padding with leading zeros.
16206 @var{first}, @var{step}, and @var{last} should all use a fixed point
16207 decimal representation.
16208 (To have other kinds of padding, use @option{--format}).
16209
16210 @end table
16211
16212 You can get finer-grained control over output with @option{-f}:
16213
16214 @example
16215 $ seq -f '(%9.2E)' -9e5 1.1e6 1.3e6
16216 (-9.00E+05)
16217 ( 2.00E+05)
16218 ( 1.30E+06)
16219 @end example
16220
16221 If you want hexadecimal integer output, you can use @command{printf}
16222 to perform the conversion:
16223
16224 @example
16225 $ printf '%x\n' $(seq 1048575 1024 1050623)
16226 fffff
16227 1003ff
16228 1007ff
16229 @end example
16230
16231 For very long lists of numbers, use xargs to avoid
16232 system limitations on the length of an argument list:
16233
16234 @example
16235 $ seq 1000000 | xargs printf '%x\n' | tail -n 3
16236 f423e
16237 f423f
16238 f4240
16239 @end example
16240
16241 To generate octal output, use the printf @code{%o} format instead
16242 of @code{%x}.
16243
16244 On most systems, seq can produce whole-number output for values up to
16245 at least @math{2^{53}}.  Larger integers are approximated.  The details
16246 differ depending on your floating-point implementation.
16247 @xref{Floating point}.  A common
16248 case is that @command{seq} works with integers through @math{2^{64}},
16249 and larger integers may not be numerically correct:
16250
16251 @example
16252 $ seq 18446744073709551616 1 18446744073709551618
16253 18446744073709551616
16254 18446744073709551616
16255 18446744073709551618
16256 @end example
16257
16258 Be careful when using @command{seq} with outlandish values: otherwise
16259 you may see surprising results, as @command{seq} uses floating point
16260 internally.  For example, on the x86 platform, where the internal
16261 representation uses a 64-bit fraction, the command:
16262
16263 @example
16264 seq 1 0.0000000000000000001 1.0000000000000000009
16265 @end example
16266
16267 outputs 1.0000000000000000007 twice and skips 1.0000000000000000008.
16268
16269 @exitstatus
16270
16271
16272 @node File permissions
16273 @chapter File permissions
16274 @include perm.texi
16275
16276 @include parse-datetime.texi
16277
16278 @c              What's GNU?
16279 @c              Arnold Robbins
16280 @node Opening the software toolbox
16281 @chapter Opening the Software Toolbox
16282
16283 An earlier version of this chapter appeared in
16284 @uref{http://www.linuxjournal.com/article.php?sid=2762, the
16285 @cite{What's GNU@?} column of the June 1994 @cite{Linux Journal}}.
16286 It was written by Arnold Robbins.
16287
16288 @menu
16289 * Toolbox introduction::        Toolbox introduction
16290 * I/O redirection::             I/O redirection
16291 * The who command::             The @command{who} command
16292 * The cut command::             The @command{cut} command
16293 * The sort command::            The @command{sort} command
16294 * The uniq command::            The @command{uniq} command
16295 * Putting the tools together::  Putting the tools together
16296 @end menu
16297
16298
16299 @node Toolbox introduction
16300 @unnumberedsec Toolbox Introduction
16301
16302 This month's column is only peripherally related to the GNU Project, in
16303 that it describes a number of the GNU tools on your GNU/Linux system
16304 and how they
16305 might be used.  What it's really about is the ``Software Tools'' philosophy
16306 of program development and usage.
16307
16308 The software tools philosophy was an important and integral concept
16309 in the initial design and development of Unix (of which Linux and GNU are
16310 essentially clones).  Unfortunately, in the modern day press of
16311 Internetworking and flashy GUIs, it seems to have fallen by the
16312 wayside.  This is a shame, since it provides a powerful mental model
16313 for solving many kinds of problems.
16314
16315 Many people carry a Swiss Army knife around in their pants pockets (or
16316 purse).  A Swiss Army knife is a handy tool to have: it has several knife
16317 blades, a screwdriver, tweezers, toothpick, nail file, corkscrew, and perhaps
16318 a number of other things on it.  For the everyday, small miscellaneous jobs
16319 where you need a simple, general purpose tool, it's just the thing.
16320
16321 On the other hand, an experienced carpenter doesn't build a house using
16322 a Swiss Army knife.  Instead, he has a toolbox chock full of specialized
16323 tools---a saw, a hammer, a screwdriver, a plane, and so on.  And he knows
16324 exactly when and where to use each tool; you won't catch him hammering nails
16325 with the handle of his screwdriver.
16326
16327 The Unix developers at Bell Labs were all professional programmers and trained
16328 computer scientists.  They had found that while a one-size-fits-all program
16329 might appeal to a user because there's only one program to use, in practice
16330 such programs are
16331
16332 @enumerate a
16333 @item
16334 difficult to write,
16335
16336 @item
16337 difficult to maintain and
16338 debug, and
16339
16340 @item
16341 difficult to extend to meet new situations.
16342 @end enumerate
16343
16344 Instead, they felt that programs should be specialized tools.  In short, each
16345 program ``should do one thing well.''  No more and no less.  Such programs are
16346 simpler to design, write, and get right---they only do one thing.
16347
16348 Furthermore, they found that with the right machinery for hooking programs
16349 together, that the whole was greater than the sum of the parts.  By combining
16350 several special purpose programs, you could accomplish a specific task
16351 that none of the programs was designed for, and accomplish it much more
16352 quickly and easily than if you had to write a special purpose program.
16353 We will see some (classic) examples of this further on in the column.
16354 (An important additional point was that, if necessary, take a detour
16355 and build any software tools you may need first, if you don't already
16356 have something appropriate in the toolbox.)
16357
16358 @node I/O redirection
16359 @unnumberedsec I/O Redirection
16360
16361 Hopefully, you are familiar with the basics of I/O redirection in the
16362 shell, in particular the concepts of ``standard input,'' ``standard output,''
16363 and ``standard error''.  Briefly, ``standard input'' is a data source, where
16364 data comes from.  A program should not need to either know or care if the
16365 data source is a disk file, a keyboard, a magnetic tape, or even a punched
16366 card reader.  Similarly, ``standard output'' is a data sink, where data goes
16367 to.  The program should neither know nor care where this might be.
16368 Programs that only read their standard input, do something to the data,
16369 and then send it on, are called @dfn{filters}, by analogy to filters in a
16370 water pipeline.
16371
16372 With the Unix shell, it's very easy to set up data pipelines:
16373
16374 @smallexample
16375 program_to_create_data | filter1 | ... | filterN > final.pretty.data
16376 @end smallexample
16377
16378 We start out by creating the raw data; each filter applies some successive
16379 transformation to the data, until by the time it comes out of the pipeline,
16380 it is in the desired form.
16381
16382 This is fine and good for standard input and standard output.  Where does the
16383 standard error come in to play?  Well, think about @command{filter1} in
16384 the pipeline above.  What happens if it encounters an error in the data it
16385 sees?  If it writes an error message to standard output, it will just
16386 disappear down the pipeline into @command{filter2}'s input, and the
16387 user will probably never see it.  So programs need a place where they can send
16388 error messages so that the user will notice them.  This is standard error,
16389 and it is usually connected to your console or window, even if you have
16390 redirected standard output of your program away from your screen.
16391
16392 For filter programs to work together, the format of the data has to be
16393 agreed upon.  The most straightforward and easiest format to use is simply
16394 lines of text.  Unix data files are generally just streams of bytes, with
16395 lines delimited by the ASCII @sc{lf} (Line Feed) character,
16396 conventionally called a ``newline'' in the Unix literature.  (This is
16397 @code{'\n'} if you're a C programmer.)  This is the format used by all
16398 the traditional filtering programs.  (Many earlier operating systems
16399 had elaborate facilities and special purpose programs for managing
16400 binary data.  Unix has always shied away from such things, under the
16401 philosophy that it's easiest to simply be able to view and edit your
16402 data with a text editor.)
16403
16404 OK, enough introduction.  Let's take a look at some of the tools, and then
16405 we'll see how to hook them together in interesting ways.   In the following
16406 discussion, we will only present those command line options that interest
16407 us.  As you should always do, double check your system documentation
16408 for the full story.
16409
16410 @node The who command
16411 @unnumberedsec The @command{who} Command
16412
16413 The first program is the @command{who} command.  By itself, it generates a
16414 list of the users who are currently logged in.  Although I'm writing
16415 this on a single-user system, we'll pretend that several people are
16416 logged in:
16417
16418 @example
16419 $ who
16420 @print{} arnold   console Jan 22 19:57
16421 @print{} miriam   ttyp0   Jan 23 14:19(:0.0)
16422 @print{} bill     ttyp1   Jan 21 09:32(:0.0)
16423 @print{} arnold   ttyp2   Jan 23 20:48(:0.0)
16424 @end example
16425
16426 Here, the @samp{$} is the usual shell prompt, at which I typed @samp{who}.
16427 There are three people logged in, and I am logged in twice.  On traditional
16428 Unix systems, user names are never more than eight characters long.  This
16429 little bit of trivia will be useful later.  The output of @command{who} is nice,
16430 but the data is not all that exciting.
16431
16432 @node The cut command
16433 @unnumberedsec The @command{cut} Command
16434
16435 The next program we'll look at is the @command{cut} command.  This program
16436 cuts out columns or fields of input data.  For example, we can tell it
16437 to print just the login name and full name from the @file{/etc/passwd}
16438 file.  The @file{/etc/passwd} file has seven fields, separated by
16439 colons:
16440
16441 @example
16442 arnold:xyzzy:2076:10:Arnold D. Robbins:/home/arnold:/bin/bash
16443 @end example
16444
16445 To get the first and fifth fields, we would use @command{cut} like this:
16446
16447 @example
16448 $ cut -d: -f1,5 /etc/passwd
16449 @print{} root:Operator
16450 @dots{}
16451 @print{} arnold:Arnold D. Robbins
16452 @print{} miriam:Miriam A. Robbins
16453 @dots{}
16454 @end example
16455
16456 With the @option{-c} option, @command{cut} will cut out specific characters
16457 (i.e., columns) in the input lines.  This is useful for input data
16458 that has fixed width fields, and does not have a field separator.  For
16459 example, list the Monday dates for the current month:
16460
16461 @c Is using cal ok?  Looked at gcal, but I don't like it.
16462 @example
16463 $ cal | cut -c 3-5
16464 @print{}Mo
16465 @print{}
16466 @print{}  6
16467 @print{} 13
16468 @print{} 20
16469 @print{} 27
16470 @end example
16471
16472 @node The sort command
16473 @unnumberedsec The @command{sort} Command
16474
16475 Next we'll look at the @command{sort} command.  This is one of the most
16476 powerful commands on a Unix-style system; one that you will often find
16477 yourself using when setting up fancy data plumbing.
16478
16479 The @command{sort}
16480 command reads and sorts each file named on the command line.  It then
16481 merges the sorted data and writes it to standard output.  It will read
16482 standard input if no files are given on the command line (thus
16483 making it into a filter).  The sort is based on the character collating
16484 sequence or based on user-supplied ordering criteria.
16485
16486
16487 @node The uniq command
16488 @unnumberedsec The @command{uniq} Command
16489
16490 Finally (at least for now), we'll look at the @command{uniq} program.  When
16491 sorting data, you will often end up with duplicate lines, lines that
16492 are identical.  Usually, all you need is one instance of each line.
16493 This is where @command{uniq} comes in.  The @command{uniq} program reads its
16494 standard input.  It prints only one
16495 copy of each repeated line.  It does have several options.  Later on,
16496 we'll use the @option{-c} option, which prints each unique line, preceded
16497 by a count of the number of times that line occurred in the input.
16498
16499
16500 @node Putting the tools together
16501 @unnumberedsec Putting the Tools Together
16502
16503 Now, let's suppose this is a large ISP server system with dozens of users
16504 logged in.  The management wants the system administrator to write a
16505 program that will
16506 generate a sorted list of logged in users.  Furthermore, even if a user
16507 is logged in multiple times, his or her name should only show up in the
16508 output once.
16509
16510 The administrator could sit down with the system documentation and write a C
16511 program that did this.  It would take perhaps a couple of hundred lines
16512 of code and about two hours to write it, test it, and debug it.
16513 However, knowing the software toolbox, the administrator can instead start out
16514 by generating just a list of logged on users:
16515
16516 @example
16517 $ who | cut -c1-8
16518 @print{} arnold
16519 @print{} miriam
16520 @print{} bill
16521 @print{} arnold
16522 @end example
16523
16524 Next, sort the list:
16525
16526 @example
16527 $ who | cut -c1-8 | sort
16528 @print{} arnold
16529 @print{} arnold
16530 @print{} bill
16531 @print{} miriam
16532 @end example
16533
16534 Finally, run the sorted list through @command{uniq}, to weed out duplicates:
16535
16536 @example
16537 $ who | cut -c1-8 | sort | uniq
16538 @print{} arnold
16539 @print{} bill
16540 @print{} miriam
16541 @end example
16542
16543 The @command{sort} command actually has a @option{-u} option that does what
16544 @command{uniq} does.  However, @command{uniq} has other uses for which one
16545 cannot substitute @samp{sort -u}.
16546
16547 The administrator puts this pipeline into a shell script, and makes it
16548 available for
16549 all the users on the system (@samp{#} is the system administrator,
16550 or @code{root}, prompt):
16551
16552 @example
16553 # cat > /usr/local/bin/listusers
16554 who | cut -c1-8 | sort | uniq
16555 ^D
16556 # chmod +x /usr/local/bin/listusers
16557 @end example
16558
16559 There are four major points to note here.  First, with just four
16560 programs, on one command line, the administrator was able to save about two
16561 hours worth of work.  Furthermore, the shell pipeline is just about as
16562 efficient as the C program would be, and it is much more efficient in
16563 terms of programmer time.  People time is much more expensive than
16564 computer time, and in our modern ``there's never enough time to do
16565 everything'' society, saving two hours of programmer time is no mean
16566 feat.
16567
16568 Second, it is also important to emphasize that with the
16569 @emph{combination} of the tools, it is possible to do a special
16570 purpose job never imagined by the authors of the individual programs.
16571
16572 Third, it is also valuable to build up your pipeline in stages, as we did here.
16573 This allows you to view the data at each stage in the pipeline, which helps
16574 you acquire the confidence that you are indeed using these tools correctly.
16575
16576 Finally, by bundling the pipeline in a shell script, other users can use
16577 your command, without having to remember the fancy plumbing you set up for
16578 them.  In terms of how you run them, shell scripts and compiled programs are
16579 indistinguishable.
16580
16581 After the previous warm-up exercise, we'll look at two additional, more
16582 complicated pipelines.  For them, we need to introduce two more tools.
16583
16584 The first is the @command{tr} command, which stands for ``transliterate.''
16585 The @command{tr} command works on a character-by-character basis, changing
16586 characters.  Normally it is used for things like mapping upper case to
16587 lower case:
16588
16589 @example
16590 $ echo ThIs ExAmPlE HaS MIXED case! | tr '[:upper:]' '[:lower:]'
16591 @print{} this example has mixed case!
16592 @end example
16593
16594 There are several options of interest:
16595
16596 @table @code
16597 @item -c
16598 work on the complement of the listed characters, i.e.,
16599 operations apply to characters not in the given set
16600
16601 @item -d
16602 delete characters in the first set from the output
16603
16604 @item -s
16605 squeeze repeated characters in the output into just one character.
16606 @end table
16607
16608 We will be using all three options in a moment.
16609
16610 The other command we'll look at is @command{comm}.  The @command{comm}
16611 command takes two sorted input files as input data, and prints out the
16612 files' lines in three columns.  The output columns are the data lines
16613 unique to the first file, the data lines unique to the second file, and
16614 the data lines that are common to both.  The @option{-1}, @option{-2}, and
16615 @option{-3} command line options @emph{omit} the respective columns.  (This is
16616 non-intuitive and takes a little getting used to.)  For example:
16617
16618 @example
16619 $ cat f1
16620 @print{} 11111
16621 @print{} 22222
16622 @print{} 33333
16623 @print{} 44444
16624 $ cat f2
16625 @print{} 00000
16626 @print{} 22222
16627 @print{} 33333
16628 @print{} 55555
16629 $ comm f1 f2
16630 @print{}         00000
16631 @print{} 11111
16632 @print{}                 22222
16633 @print{}                 33333
16634 @print{} 44444
16635 @print{}         55555
16636 @end example
16637
16638 The file name @file{-} tells @command{comm} to read standard input
16639 instead of a regular file.
16640
16641 Now we're ready to build a fancy pipeline.  The first application is a word
16642 frequency counter.  This helps an author determine if he or she is over-using
16643 certain words.
16644
16645 The first step is to change the case of all the letters in our input file
16646 to one case.  ``The'' and ``the'' are the same word when doing counting.
16647
16648 @example
16649 $ tr '[:upper:]' '[:lower:]' < whats.gnu | ...
16650 @end example
16651
16652 The next step is to get rid of punctuation.  Quoted words and unquoted words
16653 should be treated identically; it's easiest to just get the punctuation out of
16654 the way.
16655
16656 @smallexample
16657 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' | ...
16658 @end smallexample
16659
16660 The second @command{tr} command operates on the complement of the listed
16661 characters, which are all the letters, the digits, the underscore, and
16662 the blank.  The @samp{\n} represents the newline character; it has to
16663 be left alone.  (The ASCII tab character should also be included for
16664 good measure in a production script.)
16665
16666 At this point, we have data consisting of words separated by blank space.
16667 The words only contain alphanumeric characters (and the underscore).  The
16668 next step is break the data apart so that we have one word per line.  This
16669 makes the counting operation much easier, as we will see shortly.
16670
16671 @smallexample
16672 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16673 > tr -s ' ' '\n' | ...
16674 @end smallexample
16675
16676 This command turns blanks into newlines.  The @option{-s} option squeezes
16677 multiple newline characters in the output into just one.  This helps us
16678 avoid blank lines.  (The @samp{>} is the shell's ``secondary prompt.''
16679 This is what the shell prints when it notices you haven't finished
16680 typing in all of a command.)
16681
16682 We now have data consisting of one word per line, no punctuation, all one
16683 case.  We're ready to count each word:
16684
16685 @smallexample
16686 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16687 > tr -s ' ' '\n' | sort | uniq -c | ...
16688 @end smallexample
16689
16690 At this point, the data might look something like this:
16691
16692 @example
16693      60 a
16694       2 able
16695       6 about
16696       1 above
16697       2 accomplish
16698       1 acquire
16699       1 actually
16700       2 additional
16701 @end example
16702
16703 The output is sorted by word, not by count!  What we want is the most
16704 frequently used words first.  Fortunately, this is easy to accomplish,
16705 with the help of two more @command{sort} options:
16706
16707 @table @code
16708 @item -n
16709 do a numeric sort, not a textual one
16710
16711 @item -r
16712 reverse the order of the sort
16713 @end table
16714
16715 The final pipeline looks like this:
16716
16717 @smallexample
16718 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16719 > tr -s ' ' '\n' | sort | uniq -c | sort -n -r
16720 @print{}    156 the
16721 @print{}     60 a
16722 @print{}     58 to
16723 @print{}     51 of
16724 @print{}     51 and
16725 @dots{}
16726 @end smallexample
16727
16728 Whew!  That's a lot to digest.  Yet, the same principles apply.  With six
16729 commands, on two lines (really one long one split for convenience), we've
16730 created a program that does something interesting and useful, in much
16731 less time than we could have written a C program to do the same thing.
16732
16733 A minor modification to the above pipeline can give us a simple spelling
16734 checker!  To determine if you've spelled a word correctly, all you have to
16735 do is look it up in a dictionary.  If it is not there, then chances are
16736 that your spelling is incorrect.  So, we need a dictionary.
16737 The conventional location for a dictionary is @file{/usr/dict/words}.
16738 On my GNU/Linux system,@footnote{Redhat Linux 6.1, for the November 2000
16739 revision of this article.}
16740 this is a sorted, 45,402 word dictionary.
16741
16742 Now, how to compare our file with the dictionary?  As before, we generate
16743 a sorted list of words, one per line:
16744
16745 @smallexample
16746 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16747 > tr -s ' ' '\n' | sort -u | ...
16748 @end smallexample
16749
16750 Now, all we need is a list of words that are @emph{not} in the
16751 dictionary.  Here is where the @command{comm} command comes in.
16752
16753 @smallexample
16754 $ tr '[:upper:]' '[:lower:]' < whats.gnu | tr -cd '[:alnum:]_ \n' |
16755 > tr -s ' ' '\n' | sort -u |
16756 > comm -23 - /usr/dict/words
16757 @end smallexample
16758
16759 The @option{-2} and @option{-3} options eliminate lines that are only in the
16760 dictionary (the second file), and lines that are in both files.  Lines
16761 only in the first file (standard input, our stream of words), are
16762 words that are not in the dictionary.  These are likely candidates for
16763 spelling errors.  This pipeline was the first cut at a production
16764 spelling checker on Unix.
16765
16766 There are some other tools that deserve brief mention.
16767
16768 @table @command
16769 @item grep
16770 search files for text that matches a regular expression
16771
16772 @item wc
16773 count lines, words, characters
16774
16775 @item tee
16776 a T-fitting for data pipes, copies data to files and to standard output
16777
16778 @item sed
16779 the stream editor, an advanced tool
16780
16781 @item awk
16782 a data manipulation language, another advanced tool
16783 @end table
16784
16785 The software tools philosophy also espoused the following bit of
16786 advice: ``Let someone else do the hard part.''  This means, take
16787 something that gives you most of what you need, and then massage it the
16788 rest of the way until it's in the form that you want.
16789
16790 To summarize:
16791
16792 @enumerate 1
16793 @item
16794 Each program should do one thing well.  No more, no less.
16795
16796 @item
16797 Combining programs with appropriate plumbing leads to results where
16798 the whole is greater than the sum of the parts.  It also leads to novel
16799 uses of programs that the authors might never have imagined.
16800
16801 @item
16802 Programs should never print extraneous header or trailer data, since these
16803 could get sent on down a pipeline.  (A point we didn't mention earlier.)
16804
16805 @item
16806 Let someone else do the hard part.
16807
16808 @item
16809 Know your toolbox!  Use each program appropriately.  If you don't have an
16810 appropriate tool, build one.
16811 @end enumerate
16812
16813 As of this writing, all the programs we've discussed are available via
16814 anonymous @command{ftp} from: @*
16815 @uref{ftp://gnudist.gnu.org/textutils/textutils-1.22.tar.gz}.  (There may
16816 be more recent versions available now.)
16817
16818 None of what I have presented in this column is new.  The Software Tools
16819 philosophy was first introduced in the book @cite{Software Tools}, by
16820 Brian Kernighan and P.J. Plauger (Addison-Wesley, ISBN 0-201-03669-X).
16821 This book showed how to write and use software tools.  It was written in
16822 1976, using a preprocessor for FORTRAN named @command{ratfor} (RATional
16823 FORtran).  At the time, C was not as ubiquitous as it is now; FORTRAN
16824 was.  The last chapter presented a @command{ratfor} to FORTRAN
16825 processor, written in @command{ratfor}.  @command{ratfor} looks an awful
16826 lot like C; if you know C, you won't have any problem following the
16827 code.
16828
16829 In 1981, the book was updated and made available as @cite{Software Tools
16830 in Pascal} (Addison-Wesley, ISBN 0-201-10342-7).  Both books are
16831 still in print and are well worth
16832 reading if you're a programmer.  They certainly made a major change in
16833 how I view programming.
16834
16835 The programs in both books are available from
16836 @uref{http://cm.bell-labs.com/who/bwk, Brian Kernighan's home page}.
16837 For a number of years, there was an active
16838 Software Tools Users Group, whose members had ported the original
16839 @command{ratfor} programs to essentially every computer system with a
16840 FORTRAN compiler.  The popularity of the group waned in the middle 1980s
16841 as Unix began to spread beyond universities.
16842
16843 With the current proliferation of GNU code and other clones of Unix programs,
16844 these programs now receive little attention; modern C versions are
16845 much more efficient and do more than these programs do.  Nevertheless, as
16846 exposition of good programming style, and evangelism for a still-valuable
16847 philosophy, these books are unparalleled, and I recommend them highly.
16848
16849 Acknowledgment: I would like to express my gratitude to Brian Kernighan
16850 of Bell Labs, the original Software Toolsmith, for reviewing this column.
16851
16852 @node GNU Free Documentation License
16853 @appendix GNU Free Documentation License
16854
16855 @include fdl.texi
16856
16857 @node Concept index
16858 @unnumbered Index
16859
16860 @printindex cp
16861
16862 @bye
16863
16864 @c Local variables:
16865 @c texinfo-column-for-description: 32
16866 @c End: