$NetBSD: ls.1,v 1.14 1995/12/05 02:44:01 jtc Exp $
Copyright (c) 1980, 1990, 1991, 1993, 1994
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
the Institute of Electrical and Electronics Engineers, Inc.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the University of
California, Berkeley and its contributors.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@(#)ls.1 8.7 (Berkeley) 7/29/94
.Dd July 29, 1994 .Dt LS 1 .Os .Sh NAME .Nm ls .Nd list directory contents .Sh SYNOPSIS .Nm ls .Op Fl 1ACFLRSTWacdfgiklmnopqrstux .Op Ar file ... .Sh DESCRIPTION For each operand that names a .Ar file of a type other than directory, .Nm displays its name as well as any requested, associated information. For each named directory, .Nm displays the names of files contained within that directory, as well as any requested, associated information.
p If no operands are given, the contents of the current directory are displayed. If more than one operand is given, non-directory operands are displayed first; directory and non-directory operands are sorted separately and in lexicographical order.
p The options are as follows: l -tag -width Ds t Fl A List all entries except for .Dq . and .Dq .. . Always set for the superuser. t Fl C Force multi-column output; this is the default when output is to a terminal. t Fl F Display a slash
q Sq / immediately after each pathname that is a directory, an asterisk
q Sq * after each that is executable, an at sign
q Sq @ after each symbolic link, a percent sign
q Sq % after each whiteout, an equal sign
q Sq = after each socket, and a vertical bar
q Sq | after each that is a FIFO. t Fl L If argument is a symbolic link, list the file or directory the link references rather than the link itself. t Fl R Recursively list subdirectories encountered. t Fl S Sort by size, largest file first. t Fl T Display complete time information for the file, including month, day, hour, minute, second, and year. This option has no effect unless one of the long format
q Fl l , Fl n options is also specified. t Fl W Display whiteouts when scanning directories. t Fl a Include directory entries whose names begin with a dot
q Sq . . t Fl c Use time file's status was last changed instead of last modification time for sorting
q Fl t or printing
q Fl l , Fl n . t Fl d Directories are listed as plain files (not searched recursively) and symbolic links in the argument list are not indirected through. t Fl f Output is not sorted. t Fl g Does nothing; kept for compatibility with older versions of .Xr ls 1 . t Fl i For each file, print its inode number. t Fl k Modifies the .Fl s option, causing the sizes to be reported in kilobytes. Overrides any value specified by the .Ev BLOCKSIZE environment variable. t Fl l (The lowercase letter .Dq ell. Ns ) List in long format (see below). If the output is to a terminal, a total sum of all file sizes is output on a line before the long listing. t Fl m Stream output format; list files across the page, separated by commas. t Fl n List in long format as in .Fl l , but retain user and group IDs in a numeric format. t Fl o Include the file flags in a long format
q Fl l , Fl n output. t Fl p Display a slash
q Sq / immediately after each pathname that is a directory. t Fl q Force printing of non-graphic characters in file names as the character .Dq ? ; this is the default when output is to a terminal. t Fl r Reverse the order of the sort to get reverse lexicographical order or the smallest or oldest entries first. t Fl s Display the number of file system blocks actually used by each file, where partial units are rounded up to the next integer value. Blocks are 512 bytes unless overridden by the .Fl k flag or .Ev BLOCKSIZE environment variable. t Fl t Sort by time modified (most recently modified first) before sorting the operands in lexicographical order. t Fl u Use file's last access time instead of last modification time for sorting
q Fl t or printing
q Fl l , Fl n . t Fl x Multi-column output sorted across the page rather than down the page. t Fl 1 (The numeric digit .Dq one. Ns ) Force output to be one entry per line. This is the default when output is not to a terminal. .El
p The .Fl 1 , .Fl C , .Fl l , and .Fl n options all override each other; the last one specified determines the format used.
p The .Fl c and .Fl u options override each other; the last one specified determines the file time used. The .Fl f option overrides any occurrence of either.
p By default, .Nm lists one entry per line to standard output; the exceptions are to terminals or when the .Fl C or .Fl m options are specified.
p File information is displayed with one or more <blank>s separating the information associated with the .Fl i , .Fl s , .Fl l , and .Fl n options. .Ss The Long Format If the .Fl l or .Fl n options are given, the following information is displayed for each file: mode, number of links, owner, group, size in bytes, time of last modification
q Dq mmm dd HH:MM , and the pathname. In addition, for each directory whose contents are displayed, the first line displayed is the total number of blocks used by the files in the directory. Blocks are 512 bytes unless overridden by the .Fl k option or .Ev BLOCKSIZE environment variable.
p If the owner or group name is not a known user or group name, respectively, or the .Fl n option is given, the numeric ID is displayed.
p If the file is a character special or block special file, the major and minor device numbers for the file are displayed in the size field.
p If the .Fl T option is given, the time of last modification is displayed using the format .Dq mmm dd HH:MM:SS CCYY .
p If the file is a symbolic link, the pathname of the linked-to file is preceded by .Dq -> .
p The file mode printed under the .Fl l or .Fl n options consists of the entry type, owner permissions, and group permissions. The entry type character describes the type of file, as follows:
p l -tag -width 4n -offset indent -compact t Sy b block special file t Sy c character special file t Sy d directory t Sy l symbolic link t Sy s socket link t Sy p .Tn FIFO t Sy w whiteout t Sy - regular file .El
p The next three fields are three characters each: owner permissions, group permissions, and other permissions. Each field has three character positions:
p l -enum -offset indent -compact t If .Sy r , the file is readable; if .Sy - , it is not readable. t If .Sy w , the file is writable; if .Sy - , it is not writable. t The first of the following that applies: l -tag -width 4n -offset indent t Sy S If in the owner permissions, the file is not executable and set-user-ID mode is set. If in the group permissions, the file is not executable and set-group-ID mode is set. t Sy s If in the owner permissions, the file is executable and set-user-ID mode is set. If in the group permissions, the file is executable and setgroup-ID mode is set. t Sy x The file is executable or the directory is searchable. t Sy - The file is neither readable, writable, executable, nor set-user-ID, nor set-group-ID, nor sticky (see below). .El
p These next two apply only to the third character in the last group (other permissions): l -tag -width 4n -offset indent t Sy T The sticky bit is set (mode .Li 1000 ) , but neither executable nor searchable (see .Xr chmod 1 or .Xr sticky 8 ) . t Sy t The sticky bit is set (mode .Li 1000 ) , and is searchable or executable (see .Xr chmod 1 or .Xr sticky 8 ) . .El .El
p In addition, if the .Fl o option is specified, the file flags (see .Xr chflags 1 ) are displayed as comma-separated strings in front of the file size, abbreviated as follows:
p l -tag -width 8n -offset indent -compact t - no flags t uappnd user append-only t uchg user immutable t nodump do not dump t opaque opaque file t sappnd system append-only t arch archived t schg system immutable .El
p The .Nm utility exits 0 on success or >0 if an error occurred. .Sh EXAMPLES .Cm ls -l
p List the contents of the current working directory in long format.
p .Cm ls -lioF
p In addition to listing the contents of the current working directory in long format, show inode numbers, file flags (see .Xr chflags 1 ) , and suffix each filename with a symbol representing its file type.
p List the files in
a /var/log , sorting the output such that the mostly recently modified entries are printed first. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm ls : l -tag -width BLOCKSIZE t Ev BLOCKSIZE If the environment variable .Ev BLOCKSIZE is set, and the .Fl k option is not specified, the block counts (see .Fl s ) will be displayed in units of that size block. t COLUMNS If this variable contains a string representing a decimal integer, it is used as the column position width for displaying multiple-text-column output. The .Nm utility calculates how many pathname text columns to display based on the width provided (see .Fl C ) . t Ev TZ The timezone to use when displaying dates. See .Xr environ 7 for more information. .El .Sh COMPATIBILITY The group field is now automatically included in the long listing for files in order to be compatible with the .St -p1003.2 specification. .Sh SEE ALSO .Xr chflags 1 , .Xr chmod 1 , .Xr symlink 7 , .Xr sticky 8 .Sh HISTORY An .Nm utility appeared in .At v5 . .Sh STANDARDS The .Nm utility is expected to be a superset of the .St -p1003.2 specification.