2 .\" Copyright (c) 1980, 1990, 1991, 1993, 1994
3 .\" The Regents of the University of California. All rights reserved.
5 .\" This code is derived from software contributed to Berkeley by
6 .\" the Institute of Electrical and Electronics Engineers, Inc.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)ls.1 8.7 (Berkeley) 7/29/94
40 .Nd list directory contents
43 .Op Fl ABCFGHILPRSTUWZabcdfghiklmnopqrstuvwxy1\&,
44 .Op Fl -color Ns = Ns Ar when
48 For each operand that names a
53 displays its name as well as any requested,
54 associated information.
55 For each operand that names a
59 displays the names of files contained
60 within that directory, as well as any requested, associated
63 If no operands are given, the contents of the current
64 directory are displayed.
65 If more than one operand is given,
66 non-directory operands are displayed first; directory
67 and non-directory operands are sorted separately and in
68 lexicographical order.
70 The following options are available:
71 .Bl -tag -width indent
73 Include directory entries whose names begin with a
80 Automatically set for the super-user unless
84 Force printing of non-printable characters (as defined by
86 and current locale settings) in file names as
90 is the numeric value of the character in octal.
91 This option is not defined in
94 Force multi-column output; this is the default when output is to a terminal.
96 When printing in the long
100 to format the date and time output.
105 Depending on the choice of format string, this may result in a
106 different number of columns in the output.
107 This option overrides the
110 This option is not defined in
115 immediately after each pathname that is a directory,
118 after each that is executable,
121 after each symbolic link,
133 Enable colorized output.
134 This option is equivalent to defining
138 in the environment and setting
139 .Fl -color Ns = Ns Ar auto .
141 This functionality can be compiled out by removing the definition of
143 This option is not defined in
146 Symbolic links on the command line are followed.
147 This option is assumed if
152 options are specified.
156 from being automatically set for the super-user.
157 This option is not defined in
160 If argument is a symbolic link, list the file or directory the link references
161 rather than the link itself.
162 This option cancels the
166 If argument is a symbolic link, list the link itself rather than the
167 object the link references.
168 This option cancels the
174 Recursively list subdirectories encountered.
176 Sort by size (largest file first) before sorting the operands in
177 lexicographical order.
179 When printing in the long
181 format, display complete time information for the file, including
182 month, day, hour, minute, second, and year.
185 option gives even more control over the output format.
186 This option is not defined in
189 Use time when file was created for sorting or printing.
190 This option is not defined in
193 Display whiteouts when scanning directories.
194 This option is not defined in
197 Display each file's MAC label; see
199 This option is not defined in
202 Include directory entries whose names begin with a
210 escape codes whenever possible.
211 This option is not defined in
214 Use time when file status was last changed for sorting or printing.
215 .It Fl -color Ns = Ns Ar when
216 Output colored escape sequences based on
218 which may be set to either
230 is unset or set to an invalid terminal, then
232 will fall back to explicit
234 escape sequences without the help of
239 is specified without an argument.
244 output escape sequences based on
248 is a tty and either the
250 flag is specified or the
252 environment variable is set and not empty.
255 will disable color regardless of environment variables.
257 is the default when neither
263 For compatibility with GNU coreutils,
283 Directories are listed as plain files (not searched recursively).
285 Output is not sorted.
288 It also negates the effect of the
296 this option has no effect on the
306 format output without the file owner's name or number.
310 option, use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte
311 and Petabyte in order to reduce the number of digits to four or fewer
312 using base 2 for sizes.
313 This option is not defined in
316 For each file, print the file's file serial number (inode number).
318 This has the same effect as setting environment variable
320 to 1024, except that it also nullifies any
324 (The lowercase letter
326 List files in the long format, as described in the
330 Stream output format; list files across the page, separated by commas.
332 Display user and group IDs numerically rather than converting to a user
333 or group name in a long
337 Include the file flags in a long
340 This option is incompatible with
344 for a list of file flags and their meanings.
348 after each filename if that file is a directory.
350 Force printing of non-graphic characters in file names as
353 this is the default when output is to a terminal.
355 Reverse the order of the sort.
357 Display the number of blocks used in the file system by each file.
358 Block sizes and directory totals are handled as described in
360 subsection below, except (if the long format is not also requested)
361 the directory totals are not output when the output is in a
362 single column, even if multi-column output is requested.
364 Sort by descending time modified (most recently modified first).
365 If two files have the same modification timestamp, sort their names
366 in ascending lexicographical order.
369 option reverses both of these sort orders.
371 Note that these sort orders are contradictory: the time sequence is in
372 descending order, the lexicographical sort is in ascending order.
373 This behavior is mandated by
375 This feature can cause problems listing files stored with sequential names on
376 FAT file systems, such as from digital cameras, where it is possible to have
377 more than one image with the same timestamp.
378 In such a case, the photos cannot be listed in the sequence in which
380 To ensure the same sort order for time and for lexicographical sorting, set the
388 to reverse the lexicographical sort order when sorting files with the
389 same modification timestamp.
391 Use time of last access,
392 instead of time of last modification
393 of the file for sorting
398 Sort following a natural ordering, using
402 as the comparison function.
403 E.g., files lexicographically ordered
404 "bloem1", "bloem10", and "bloem9" would instead be ordered
405 "bloem1", "bloem9", and "bloem10", as one would perhaps expect.
407 Force raw printing of non-printable characters.
409 when output is not to a terminal.
410 This option is not defined in
415 except that the multi-column output is produced with entries sorted
416 across, rather than down, the columns.
420 option is set, sort the alphabetical output in the same order as the time output.
421 This has the same effect as setting
423 See the description of the
425 option for more details.
426 This option is not defined in
433 This is the default when
434 output is not to a terminal.
438 option is set, print file sizes grouped and separated by thousands using the
439 non-monetary separator returned by
441 typically a comma or period.
442 If no locale is set, or the locale does not have a non-monetary separator, this
443 option has no effect.
444 This option is not defined in
452 options all override each other; the last one specified determines
459 options all override each other; the last one specified determines
466 options override each other; the last one specified determines
473 options all override each other; the last one specified determines
474 the format used for non-printable characters.
480 options all override each other (either partially or fully); they
481 are applied in the order specified.
485 lists one entry per line to standard
486 output; the exceptions are to terminals or when the
490 options are specified.
492 File information is displayed with one or more
494 separating the information associated with the
502 option is given, the following information
503 is displayed for each file:
505 number of links, owner name, group name,
507 number of bytes in the file, abbreviated
508 month, day-of-month file was last modified,
509 hour file last modified, minute file last
510 modified, and the pathname.
512 If the modification time of the file is more than 6 months
513 in the past or future, and the
518 then the year of the last modification
519 is displayed in place of the hour and minute fields.
521 If the owner or group names are not a known user or group name,
525 the numeric ID's are displayed.
527 If the file is a character special or block special file,
528 the device number for the file is displayed in the size field.
529 If the file is a symbolic link the pathname of the
530 linked-to file is preceded by
533 The listing of a directory's contents is preceded
534 by a labeled total number of blocks used in the file system by the files
535 which are listed as the directory's contents
536 (which may or may not include
540 and other files which start with a dot, depending on other options).
542 The default block size is 512 bytes.
543 The block size may be set with option
545 or environment variable
547 Numbers of blocks in the output will have been rounded up so the
548 numbers of bytes is at least as many as used by the corresponding
549 file system blocks (which might have a different size).
551 The file mode printed under the
553 option consists of the
554 entry type and the permissions.
555 The entry type character describes the type of file, as
558 .Bl -tag -width 4n -offset indent -compact
564 Character special file.
577 The next three fields
578 are three characters each:
580 group permissions, and
582 Each field has three character positions:
583 .Bl -enum -offset indent
587 the file is readable; if
593 the file is writable; if
597 The first of the following that applies:
598 .Bl -tag -width 4n -offset indent
600 If in the owner permissions, the file is not executable and
601 set-user-ID mode is set.
602 If in the group permissions, the file is not executable
603 and set-group-ID mode is set.
605 If in the owner permissions, the file is executable
606 and set-user-ID mode is set.
607 If in the group permissions, the file is executable
608 and setgroup-ID mode is set.
610 The file is executable or the directory is
613 The file is neither readable, writable, executable,
614 nor set-user-ID nor set-group-ID mode, nor sticky.
618 These next two apply only to the third character in the last group
620 .Bl -tag -width 4n -offset indent
622 The sticky bit is set
625 but not execute or search permission.
631 The sticky bit is set (mode
633 and is searchable or executable.
641 The next field contains a
644 character if the file has an ACL, or a
650 utility does not show the actual ACL;
655 The following environment variables affect the execution of
657 .Bl -tag -width ".Ev CLICOLOR_FORCE"
659 If this is set, its value, rounded up to 512 or down to a
660 multiple of 512, will be used as the block size in bytes by the
667 subsection for more information.
671 color sequences to distinguish file types.
675 In addition to the file types mentioned in the
677 option some extra attributes (setuid bit set, etc.) are also displayed.
678 The colorization is dependent on a terminal type with the proper
683 console has the proper capabilities,
684 but to display the colors in an
685 .Xr xterm 1 Pq Pa ports/x11/xterm ,
689 variable must be set to
691 Other terminal types may require similar adjustments.
693 is silently disabled if the output is not directed to a terminal
696 variable is defined or
700 .It Ev CLICOLOR_FORCE
701 Color sequences are normally disabled if the output is not directed to
703 This can be overridden by setting this variable.
706 variable still needs to reference a color capable terminal however
707 otherwise it is not possible to determine which color sequences to
714 If this variable contains a string representing a
715 decimal integer, it is used as the
716 column position width for displaying
717 multiple-text-column output.
720 utility calculates how
721 many pathname text columns to display
722 based on the width provided.
728 The locale to use when determining the order of day and month in the long
733 for more information.
735 The value of this variable describes what color to use for which
736 attribute when colors are enabled with
740 This string is a concatenation of pairs of the format
744 is the foreground color and
746 is the background color.
747 When the background color is capitalized, the text will underlined.
749 The color designators are as follows:
751 .Bl -tag -width 4n -offset indent -compact
769 bold or underlined black, usually shows up as dark grey
771 bold or underlined red
773 bold or underlined green
775 bold or underlined brown, usually shows up as yellow
777 bold or underlined blue
779 bold or underlined magenta
781 bold or underlined cyan
783 bold or underlined light grey; looks like bright white
785 default foreground or background
787 default foreground or background, with an underline or bold
790 Note that the above are standard
793 The actual display may differ
794 depending on the color capabilities of the terminal in use.
796 The order of the attributes are as follows:
798 .Bl -enum -offset indent -compact
814 executable with setuid bit set
816 executable with setgid bit set
818 directory writable to others, with sticky bit
820 directory writable to others, without sticky bit
824 .Qq "exfxcxdxbxegedabagacad" ,
825 i.e., blue foreground and
826 default background for regular directories, black foreground and red
827 background for setuid executables, etc.
829 If this variable is set, it is considered to be a
830 colon-delimited list of minimum column widths.
832 and insufficient widths are ignored (thus zero signifies
833 a dynamically sized column).
834 Not all columns have changeable widths.
836 in order: inode, block count, number of links, user name,
837 group name, flags, file size, file name.
839 If this variable is set, the
841 option sorts the names of files with the same modification timestamp in the same
842 sense as the time sort.
843 See the description of the
845 option for more details.
851 functionality depends on a terminal type with color capabilities.
853 The timezone to use when displaying dates.
856 for more information.
861 List the contents of the current working directory in long format:
865 In addition to listing the contents of the current working directory in
866 long format, show inode numbers, file flags (see
868 and suffix each filename with a symbol representing its file type:
874 sorting the output such that the mostly recently modified entries are
877 .Dl $ ls -lt /var/log
879 The group field is now automatically included in the long listing for
880 files in order to be compatible with the
888 .Xr xterm 1 Pq Pa ports/x11/xterm ,
900 With the exception of options
911 .Fl B , D , G , I , T , U , W , Z , b , h , v , w , y
914 are non-standard extensions.
916 The ACL support is compatible with
919 .Pq Dq Tn POSIX Ns .2c
933 To maintain backward compatibility, the relationships between the many
934 options are quite complex.
936 The exception mentioned in the
938 option description might be a feature that was
939 based on the fact that single-column output
940 usually goes to something other than a terminal.
941 It is debatable whether this is a design bug.
944 mandates opposite sort orders for files with the same timestamp when