path: root/man/dir.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.35.
.TH DIR "1" "March 2007" "GNU coreutils 6.9" "User Commands"
.SH NAME
dir \- list directory contents
.SH SYNOPSIS
.B dir
[\fIOPTION\fR]... [\fIFILE\fR]...
.SH DESCRIPTION
.\" Add any additional description here
.PP
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of \fB\-cftuvSUX\fR nor \fB\-\-sort\fR.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
\fB\-a\fR, \fB\-\-all\fR
do not ignore entries starting with .
.TP
\fB\-A\fR, \fB\-\-almost\-all\fR
do not list implied . and ..
.TP
\fB\-\-author\fR
with \fB\-l\fR, print the author of each file
.TP
\fB\-b\fR, \fB\-\-escape\fR
print octal escapes for nongraphic characters
.TP
\fB\-\-block\-size\fR=\fISIZE\fR
use SIZE\-byte blocks
.TP
\fB\-B\fR, \fB\-\-ignore\-backups\fR
do not list implied entries ending with ~
.TP
\fB\-c\fR
with \fB\-lt\fR: sort by, and show, ctime (time of last
modification of file status information)
with \fB\-l\fR: show ctime and sort by name
otherwise: sort by ctime
.TP
\fB\-C\fR
list entries by columns
.TP
\fB\-\-color\fR[=\fIWHEN\fR]
control whether color is used to distinguish file
types.  WHEN may be `never', `always', or `auto'
.TP
\fB\-d\fR, \fB\-\-directory\fR
list directory entries instead of contents,
and do not dereference symbolic links
.TP
\fB\-D\fR, \fB\-\-dired\fR
generate output designed for Emacs' dired mode
.TP
\fB\-f\fR
do not sort, enable \fB\-aU\fR, disable \fB\-ls\fR \fB\-\-color\fR
.TP
\fB\-F\fR, \fB\-\-classify\fR
append indicator (one of */=>@|) to entries
.TP
\fB\-\-file\-type\fR
likewise, except do not append `*'
.TP
\fB\-\-format\fR=\fIWORD\fR
across \fB\-x\fR, commas \fB\-m\fR, horizontal \fB\-x\fR, long \fB\-l\fR,
single\-column \fB\-1\fR, verbose \fB\-l\fR, vertical \fB\-C\fR
.TP
\fB\-\-full\-time\fR
like \fB\-l\fR \fB\-\-time\-style\fR=\fIfull\-iso\fR
.TP
\fB\-g\fR
like \fB\-l\fR, but do not list owner
.TP
\fB\-\-group\-directories\-first\fR
group directories before files
.TP
\fB\-G\fR, \fB\-\-no\-group\fR
in a long listing, don't print group names
.TP
\fB\-h\fR, \fB\-\-human\-readable\fR
with \fB\-l\fR, print sizes in human readable format
(e.g., 1K 234M 2G)
.TP
\fB\-\-si\fR
likewise, but use powers of 1000 not 1024
.TP
\fB\-H\fR, \fB\-\-dereference\-command\-line\fR
follow symbolic links listed on the command line
.TP
\fB\-\-dereference\-command\-line\-symlink\-to\-dir\fR
follow each command line symbolic link
that points to a directory
.TP
\fB\-\-hide\fR=\fIPATTERN\fR
do not list implied entries matching shell PATTERN
(overridden by \fB\-a\fR or \fB\-A\fR)
.TP
\fB\-\-indicator\-style\fR=\fIWORD\fR
append indicator with style WORD to entry names:
none (default), slash (\fB\-p\fR),
file\-type (\fB\-\-file\-type\fR), classify (\fB\-F\fR)
.TP
\fB\-i\fR, \fB\-\-inode\fR
print the index number of each file
.TP
\fB\-I\fR, \fB\-\-ignore\fR=\fIPATTERN\fR
do not list implied entries matching shell PATTERN
.TP
\fB\-k\fR
like \fB\-\-block\-size\fR=\fI1K\fR
.TP
\fB\-l\fR
use a long listing format
.TP
\fB\-L\fR, \fB\-\-dereference\fR
when showing file information for a symbolic
link, show information for the file the link
references rather than for the link itself
.TP
\fB\-m\fR
fill width with a comma separated list of entries
.TP
\fB\-n\fR, \fB\-\-numeric\-uid\-gid\fR
like \fB\-l\fR, but list numeric user and group IDs
.TP
\fB\-N\fR, \fB\-\-literal\fR
print raw entry names (don't treat e.g. control
characters specially)
.TP
\fB\-o\fR
like \fB\-l\fR, but do not list group information
.TP
\fB\-p\fR, \fB\-\-indicator\-style\fR=\fIslash\fR
append / indicator to directories
.TP
\fB\-q\fR, \fB\-\-hide\-control\-chars\fR
print ? instead of non graphic characters
.TP
\fB\-\-show\-control\-chars\fR
show non graphic characters as\-is (default
unless program is `ls' and output is a terminal)
.TP
\fB\-Q\fR, \fB\-\-quote\-name\fR
enclose entry names in double quotes
.TP
\fB\-\-quoting\-style\fR=\fIWORD\fR
use quoting style WORD for entry names:
literal, locale, shell, shell\-always, c, escape
.TP
\fB\-r\fR, \fB\-\-reverse\fR
reverse order while sorting
.TP
\fB\-R\fR, \fB\-\-recursive\fR
list subdirectories recursively
.TP
\fB\-s\fR, \fB\-\-size\fR
print the size of each file, in blocks
.TP
\fB\-S\fR
sort by file size
.TP
\fB\-\-sort\fR=\fIWORD\fR
sort by WORD instead of name: none \fB\-U\fR,
extension \fB\-X\fR, size \fB\-S\fR, time \fB\-t\fR, version \fB\-v\fR
.TP
\fB\-\-time\fR=\fIWORD\fR
with \fB\-l\fR, show time as WORD instead of modification
time: atime \fB\-u\fR, access \fB\-u\fR, use \fB\-u\fR, ctime \fB\-c\fR,
or status \fB\-c\fR; use specified time as sort key
if \fB\-\-sort\fR=\fItime\fR
.TP
\fB\-\-time\-style\fR=\fISTYLE\fR
with \fB\-l\fR, show times using style STYLE:
full\-iso, long\-iso, iso, locale, +FORMAT.
FORMAT is interpreted like `date'; if FORMAT is
FORMAT1<newline>FORMAT2, FORMAT1 applies to
non\-recent files and FORMAT2 to recent files;
if STYLE is prefixed with `posix\-', STYLE
takes effect only outside the POSIX locale
.TP
\fB\-t\fR
sort by modification time
.TP
\fB\-T\fR, \fB\-\-tabsize\fR=\fICOLS\fR
assume tab stops at each COLS instead of 8
.TP
\fB\-u\fR
with \fB\-lt\fR: sort by, and show, access time
with \fB\-l\fR: show access time and sort by name
otherwise: sort by access time
.TP
\fB\-U\fR
do not sort; list entries in directory order
.TP
\fB\-v\fR
sort by version
.TP
\fB\-w\fR, \fB\-\-width\fR=\fICOLS\fR
assume screen width instead of current value
.TP
\fB\-x\fR
list entries by lines instead of by columns
.TP
\fB\-X\fR
sort alphabetically by entry extension
.TP
\fB\-1\fR
list one file per line
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-version\fR
output version information and exit
.PP
SIZE may be (or may be an integer optionally followed by) one of following:
kB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.
.PP
By default, color is not used to distinguish types of files.  That is
equivalent to using \fB\-\-color\fR=\fInone\fR.  Using the \fB\-\-color\fR option without the
optional WHEN argument is equivalent to using \fB\-\-color\fR=\fIalways\fR.  With
\fB\-\-color\fR=\fIauto\fR, color codes are output only if standard output is connected
to a terminal (tty).  The environment variable LS_COLORS can influence the
colors, and can be set easily by the dircolors command.
.PP
Exit status is 0 if OK, 1 if minor problems, 2 if serious trouble.
.SH AUTHOR
Written by Richard Stallman and David MacKenzie.
.SH "REPORTING BUGS"
Report bugs to <bug\-coreutils@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2007 Free Software Foundation, Inc.
.br
This is free software.  You may redistribute copies of it under the terms of
the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B dir
is maintained as a Texinfo manual.  If the
.B info
and
.B dir
programs are properly installed at your site, the command
.IP
.B info dir
.PP
should give you access to the complete manual.