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
37 .Nd list directory contents
40 .Op Fl ABCFGHILPRSTUWZabcdfghiklmnopqrstuvwxy1\&,
41 .Op Fl -color Ns = Ns Ar when
45 For each operand that names a
50 displays its name as well as any requested,
51 associated information.
52 For each operand that names a
56 displays the names of files contained
57 within that directory, as well as any requested, associated
60 If no operands are given, the contents of the current
61 directory are displayed.
62 If more than one operand is given,
63 non-directory operands are displayed first; directory
64 and non-directory operands are sorted separately and in
65 lexicographical order.
67 The following options are available:
68 .Bl -tag -width indent
70 Include directory entries whose names begin with a
77 Automatically set for the super-user unless
81 Force printing of non-printable characters (as defined by
83 and current locale settings) in file names as
87 is the numeric value of the character in octal.
88 This option is not defined in
91 Force multi-column output; this is the default when output is to a terminal.
93 When printing in the long
97 to format the date and time output.
102 Depending on the choice of format string, this may result in a
103 different number of columns in the output.
104 This option overrides the
107 This option is not defined in
112 immediately after each pathname that is a directory,
115 after each that is executable,
118 after each symbolic link,
130 Enable colorized output.
131 This option is equivalent to defining
135 in the environment and setting
136 .Fl -color Ns = Ns Ar auto .
138 This functionality can be compiled out by removing the definition of
140 This option is not defined in
143 Symbolic links on the command line are followed.
144 This option is assumed if
149 options are specified.
153 from being automatically set for the super-user.
154 This option is not defined in
157 If argument is a symbolic link, list the file or directory the link references
158 rather than the link itself.
159 This option cancels the
163 If argument is a symbolic link, list the link itself rather than the
164 object the link references.
165 This option cancels the
171 Recursively list subdirectories encountered.
173 Sort by size (largest file first) before sorting the operands in
174 lexicographical order.
176 When printing in the long
178 format, display complete time information for the file, including
179 month, day, hour, minute, second, and year.
182 option gives even more control over the output format.
183 This option is not defined in
186 Use time when file was created for sorting or printing.
187 This option is not defined in
190 Display whiteouts when scanning directories.
191 This option is not defined in
194 Display each file's MAC label; see
196 This option is not defined in
199 Include directory entries whose names begin with a
207 escape codes whenever possible.
208 This option is not defined in
211 Use time when file status was last changed for sorting or printing.
212 .It Fl -color Ns = Ns Ar when
213 Output colored escape sequences based on
215 which may be set to either
227 is unset or set to an invalid terminal, then
229 will fall back to explicit
231 escape sequences without the help of
236 is specified without an argument.
241 output escape sequences based on
245 is a tty and either the
247 flag is specified or the
249 environment variable is set and not empty.
252 will disable color regardless of environment variables.
254 is the default when neither
260 For compatibility with GNU coreutils,
280 Directories are listed as plain files (not searched recursively).
282 Output is not sorted.
285 It also negates the effect of the
293 this option has no effect on the
303 format output without the file owner's name or number.
307 option, use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte
308 and Petabyte in order to reduce the number of digits to four or fewer
309 using base 2 for sizes.
310 This option is not defined in
313 For each file, print the file's file serial number (inode number).
315 This has the same effect as setting environment variable
317 to 1024, except that it also nullifies any
321 (The lowercase letter
323 List files in the long format, as described in the
327 Stream output format; list files across the page, separated by commas.
329 Display user and group IDs numerically rather than converting to a user
330 or group name in a long
334 Include the file flags in a long
337 This option is incompatible with
341 for a list of file flags and their meanings.
345 after each filename if that file is a directory.
347 Force printing of non-graphic characters in file names as
350 this is the default when output is to a terminal.
352 Reverse the order of the sort.
354 Display the number of blocks used in the file system by each file.
355 Block sizes and directory totals are handled as described in
357 subsection below, except (if the long format is not also requested)
358 the directory totals are not output when the output is in a
359 single column, even if multi-column output is requested.
361 Sort by descending time modified (most recently modified first).
362 If two files have the same modification timestamp, sort their names
363 in ascending lexicographical order.
366 option reverses both of these sort orders.
368 Note that these sort orders are contradictory: the time sequence is in
369 descending order, the lexicographical sort is in ascending order.
370 This behavior is mandated by
372 This feature can cause problems listing files stored with sequential names on
373 FAT file systems, such as from digital cameras, where it is possible to have
374 more than one image with the same timestamp.
375 In such a case, the photos cannot be listed in the sequence in which
377 To ensure the same sort order for time and for lexicographical sorting, set the
385 to reverse the lexicographical sort order when sorting files with the
386 same modification timestamp.
388 Use time of last access,
389 instead of time of last modification
390 of the file for sorting
395 Sort following a natural ordering, using
399 as the comparison function.
400 E.g., files lexicographically ordered
401 "bloem1", "bloem10", and "bloem9" would instead be ordered
402 "bloem1", "bloem9", and "bloem10", as one would perhaps expect.
404 Force raw printing of non-printable characters.
406 when output is not to a terminal.
407 This option is not defined in
412 except that the multi-column output is produced with entries sorted
413 across, rather than down, the columns.
417 option is set, sort the alphabetical output in the same order as the time output.
418 This has the same effect as setting
420 See the description of the
422 option for more details.
423 This option is not defined in
430 This is the default when
431 output is not to a terminal.
435 option is set, print file sizes grouped and separated by thousands using the
436 non-monetary separator returned by
438 typically a comma or period.
439 If no locale is set, or the locale does not have a non-monetary separator, this
440 option has no effect.
441 This option is not defined in
449 options all override each other; the last one specified determines
456 options all override each other; the last one specified determines
463 options override each other; the last one specified determines
470 options all override each other; the last one specified determines
471 the format used for non-printable characters.
477 options all override each other (either partially or fully); they
478 are applied in the order specified.
482 lists one entry per line to standard
483 output; the exceptions are to terminals or when the
487 options are specified.
489 File information is displayed with one or more
491 separating the information associated with the
499 option is given, the following information
500 is displayed for each file:
502 number of links, owner name, group name,
504 number of bytes in the file, abbreviated
505 month, day-of-month file was last modified,
506 hour file last modified, minute file last
507 modified, and the pathname.
509 If the modification time of the file is more than 6 months
510 in the past or future, and the
515 then the year of the last modification
516 is displayed in place of the hour and minute fields.
518 If the owner or group names are not a known user or group name,
522 the numeric ID's are displayed.
524 If the file is a character special or block special file,
525 the device number for the file is displayed in the size field.
526 If the file is a symbolic link the pathname of the
527 linked-to file is preceded by
530 The listing of a directory's contents is preceded
531 by a labeled total number of blocks used in the file system by the files
532 which are listed as the directory's contents
533 (which may or may not include
537 and other files which start with a dot, depending on other options).
539 The default block size is 512 bytes.
540 The block size may be set with option
542 or environment variable
544 Numbers of blocks in the output will have been rounded up so the
545 numbers of bytes is at least as many as used by the corresponding
546 file system blocks (which might have a different size).
548 The file mode printed under the
550 option consists of the
551 entry type and the permissions.
552 The entry type character describes the type of file, as
555 .Bl -tag -width 4n -offset indent -compact
561 Character special file.
574 The next three fields
575 are three characters each:
577 group permissions, and
579 Each field has three character positions:
580 .Bl -enum -offset indent
584 the file is readable; if
590 the file is writable; if
594 The first of the following that applies:
595 .Bl -tag -width 4n -offset indent
597 If in the owner permissions, the file is not executable and
598 set-user-ID mode is set.
599 If in the group permissions, the file is not executable
600 and set-group-ID mode is set.
602 If in the owner permissions, the file is executable
603 and set-user-ID mode is set.
604 If in the group permissions, the file is executable
605 and setgroup-ID mode is set.
607 The file is executable or the directory is
610 The file is neither readable, writable, executable,
611 nor set-user-ID nor set-group-ID mode, nor sticky.
615 These next two apply only to the third character in the last group
617 .Bl -tag -width 4n -offset indent
619 The sticky bit is set
622 but not execute or search permission.
628 The sticky bit is set (mode
630 and is searchable or executable.
638 The next field contains a
641 character if the file has an ACL, or a
647 utility does not show the actual ACL;
652 The following environment variables affect the execution of
654 .Bl -tag -width ".Ev CLICOLOR_FORCE"
656 If this is set, its value, rounded up to 512 or down to a
657 multiple of 512, will be used as the block size in bytes by the
664 subsection for more information.
668 color sequences to distinguish file types.
672 In addition to the file types mentioned in the
674 option some extra attributes (setuid bit set, etc.) are also displayed.
675 The colorization is dependent on a terminal type with the proper
680 console has the proper capabilities,
681 but to display the colors in an
682 .Xr xterm 1 Pq Pa ports/x11/xterm ,
686 variable must be set to
688 Other terminal types may require similar adjustments.
690 is silently disabled if the output is not directed to a terminal
693 variable is defined or
697 .It Ev CLICOLOR_FORCE
698 Color sequences are normally disabled if the output is not directed to
700 This can be overridden by setting this variable.
703 variable still needs to reference a color capable terminal however
704 otherwise it is not possible to determine which color sequences to
711 If this variable contains a string representing a
712 decimal integer, it is used as the
713 column position width for displaying
714 multiple-text-column output.
717 utility calculates how
718 many pathname text columns to display
719 based on the width provided.
725 The locale to use when determining the order of day and month in the long
730 for more information.
732 The value of this variable describes what color to use for which
733 attribute when colors are enabled with
737 This string is a concatenation of pairs of the format
741 is the foreground color and
743 is the background color.
744 When the background color is capitalized, the text is underlined.
746 The color designators are as follows:
748 .Bl -tag -width 4n -offset indent -compact
766 bold or underlined black, usually shows up as dark grey
768 bold or underlined red
770 bold or underlined green
772 bold or underlined brown, usually shows up as yellow
774 bold or underlined blue
776 bold or underlined magenta
778 bold or underlined cyan
780 bold or underlined light grey; looks like bright white
782 default foreground or background
784 default foreground or background, with an underline or bold
787 Note that the above are standard
790 The actual display may differ
791 depending on the color capabilities of the terminal in use.
793 The order of the attributes are as follows:
795 .Bl -enum -offset indent -compact
811 executable with setuid bit set
813 executable with setgid bit set
815 directory writable to others, with sticky bit
817 directory writable to others, without sticky bit
821 .Qq "exfxcxdxbxegedabagacad" ,
822 i.e., blue foreground and
823 default background for regular directories, black foreground and red
824 background for setuid executables, etc.
826 If this variable is set, it is considered to be a
827 colon-delimited list of minimum column widths.
829 and insufficient widths are ignored (thus zero signifies
830 a dynamically sized column).
831 Not all columns have changeable widths.
833 in order: inode, block count, number of links, user name,
834 group name, flags, file size, file name.
836 If this variable is set, the
838 option sorts the names of files with the same modification timestamp in the same
839 sense as the time sort.
840 See the description of the
842 option for more details.
848 functionality depends on a terminal type with color capabilities.
850 The timezone to use when displaying dates.
853 for more information.
858 List the contents of the current working directory in long format:
862 In addition to listing the contents of the current working directory in
863 long format, show inode numbers, file flags (see
865 and suffix each filename with a symbol representing its file type:
871 sorting the output such that the mostly recently modified entries are
874 .Dl $ ls -lt /var/log
876 The group field is now automatically included in the long listing for
877 files in order to be compatible with the
885 .Xr xterm 1 Pq Pa ports/x11/xterm ,
897 With the exception of options
908 .Fl B , D , G , I , T , U , W , Z , b , h , v , w , y
911 are non-standard extensions.
913 The ACL support is compatible with
916 .Pq Dq Tn POSIX Ns .2c
930 To maintain backward compatibility, the relationships between the many
931 options are quite complex.
933 The exception mentioned in the
935 option description might be a feature that was
936 based on the fact that single-column output
937 usually goes to something other than a terminal.
938 It is debatable whether this is a design bug.
941 mandates opposite sort orders for files with the same timestamp when