BSD 3 development

[unix-history] / usr / man / man1 / ls.1

.TH LS 1 11/16/79
.UC
.SH NAME
ls \- list contents of directory
.SH SYNOPSIS
.B ls
[
.B \-ltasdruifgm1cqx
] name ...
.br
.B l
[ \fIls\fR options ] name ...
.SH DESCRIPTION
For each directory argument,
.I ls
lists the contents of the directory;
for each file argument,
.I ls
repeats its name and any other information requested.
The output is sorted alphabetically by default.
When no argument is given, the current directory is listed.
When several arguments are given,
the arguments are first sorted appropriately,
but file arguments appear
before directories and their contents.
.PP
There are three possible listing formats.
The format chosen depends on whether the output is going
to a teletype, and may also be controlled by option flags.
The default format for a teletype is to list the contents of directories
in multi-column format, with the entries sorted down the columns.
(See also the
.B \-x
option below.)
If the standard output is not a teletype, the default format is to
list one entry per line.
Finally, there is a stream output format in which files are listed
across the page, separated by `,' characters.
The
.B \-m
flag enables this format.
.PP
When invoked as
.I l
the default is
.B \-m .
.PP
.B "Note:"
Files which are not the contents of a directory being interpreted
are always sorted across the page rather than down the page in columns.
This is because the individual file names may be arbitrarily long.
There are several options:
.TP
.B  \-l
List in long format, giving mode, number of links, owner,
size in bytes, and time of last modification
for each file.
(See below.)
If the file is a special file the size field will instead contain
the major and minor device numbers.
.TP
.B  \-t
Sort by time modified (latest first) instead of
by name, as is normal.
.TP
.B  \-a
List all entries; usually
.RB ` . '
and
.RB ` .. '
are suppressed.
.TP
.B  \-s
Give size in blocks,
including indirect blocks, for each entry.
.TP
.B  \-d
If argument is a directory, list only its name, not
its contents (mostly used with
.B \-l
to get status
on directory).
.TP
.B  \-r
Reverse the order of sort to get reverse alphabetic
or oldest first as appropriate.
.TP
.B  \-u
Use time of last access instead of last
modification for sorting
.RB ( \-t )
or printing
.RB ( \-l ).
.TP
.B  \-i
Print i-number in first column
of the report for each file listed.
.TP
.B  \-f
Force each argument to be interpreted as a directory
and list the name found in each slot.
This option turns off
.B "\-l, \-t, \-s,"
and
.B \-r,
and
turns on
.B \-a;
the order is the order in which entries
appear in the directory.
.TP
.B  \-g
Give group ID instead of owner ID in long listing.
.TP
.B  \-m
force stream output format
.TP
.B  \-1
force one entry per line output format, e.g. to a teletype
.TP
.B  \-c
force multi-column output, e.g. to a file or a pipe
.TP
.B  \-q
force printing of non-graphic characters in file names as
the character `?'; this normally happens only if the output device is
a teletype
.TP
.B  \-x
force columnar printing to be sorted across rather than
down the page;
this is the default if the last character of the name the program is invoked
with is an `x'.
.PP
The mode printed under the
.B \-l
option contains 11 characters
which are interpreted
as follows:
the first character is
.TP 3
.B  d
if the entry is a directory;
.br
.ns
.TP 3
.B  b
if the entry is a block-type special file;
.br
.ns
.TP 3
.B  c
if the entry is a character-type special file;
.br
.ns
.TP 3
.B  \-
if the entry is a plain file.
.PP
The next 9 characters are interpreted
as three sets of three bits each.
The first set refers to owner permissions;
the next to permissions to others in the same user-group;
and the last to all others.
Within each set the three characters indicate
permission respectively to read, to write, or to
execute the file as a program.
For a directory, `execute' permission is interpreted
to mean permission to search the directory
for a specified file.
The permissions are indicated as follows:
.TP 3
.B  r
if the file is readable;
.br
.ns
.TP 3
.B  w
if the file is writable;
.br
.ns
.TP 3
.B  x
if the file is executable;
.br
.ns
.TP 3
.B  \-
if the indicated permission is not granted.
.PP
The group-execute permission character is given
as
.B s
if the file has set-group-ID mode;
likewise the user-execute permission character is given
as
.B s
if the file has set-user-ID mode.
.PP
The last character of the mode (normally `x' or `\-') is 
.B t
if the 1000 bit of the mode is on.
See
.IR  chmod (1)
for the meaning of this mode.
.PP
When the sizes of the files in a directory
are listed, a total count of blocks,
including indirect blocks is printed.
.SH FILES
/etc/passwd to get user ID's for
`ls \-l'.
.br
/etc/group to get group ID's for
`ls \-g'.
.SH BUGS
Newline and tab are considered printing characters in file names.
.PP
The output device is assumed to be 80 columns wide.
Columns are basically 15 characters wide, 20 characters wide if
.BR \-i " or " "\-s\fR is specified, 25 characters wide if both"
.BR \-i " and " "\-s\fR are specified."
In any case where
.BR \-l ""
or
.BR \-n ""
is specified, we assume
only one entry will fit per line.
.PP
The option setting based on whether the output is a teletype is
undesirable as:
.PP
.DT
	ls \-s | lpr
.PP
is much different than
.PP
	ls \-s
.PP
On the other hand, not doing this setting would make old shell scripts
which used
.I ls
almost certain losers,
and then one could no longer do, e.g.:
.PP
	ls \-s | sort \-nr
.PP
but would have to do
.PP
	ls \-s \-1 | sort \-nr
.PP
Column widths choices are poor for terminals which can tab.