1 .\" Copyright (c) 1980, 1990, 1991, 1993, 1994
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\" must display the following acknowledgment:
17 .\" This product includes software developed by the University of
18 .\" California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .\" @(#)ls.1 8.7 (Berkeley) 7/29/94
36 .\" $FreeBSD: src/bin/ls/ls.1,v 1.69 2002/08/21 17:32:34 trhodes Exp $
43 .Nd list directory contents
46 .Op Fl ABCFGHLPRTWZabcdfghiklmnopqrstuwx1
49 For each operand that names a
54 displays its name as well as any requested,
55 associated information.
56 For each operand that names a
60 displays the names of files contained
61 within that directory, as well as any requested, associated
64 If no operands are given, the contents of the current
65 directory are displayed.
66 If more than one operand is given,
67 non-directory operands are displayed first; directory
68 and non-directory operands are sorted separately and in
69 lexicographical order.
71 The following options are available:
72 .Bl -tag -width indent
74 List all entries except for
78 Always set for the super-user.
80 Force printing of non-printable characters (as defined by
82 and current locale settings) in file names as
86 is the numeric value of the character in octal.
88 Force multi-column output; this is the default when output is to a terminal.
92 immediately after each pathname that is a directory,
95 after each that is executable,
98 after each symbolic link,
110 Enable colorized output.
111 This option is equivalent to defining
116 Symbolic links on the command line are followed.
117 This option is assumed if
122 options are specified.
124 If argument is a symbolic link, list the file or directory the link references
125 rather than the link itself.
126 This option cancels the
130 If argument is a symbolic link, list the link itself rather than the
131 object the link references.
132 This option cancels the
138 Recursively list subdirectories encountered.
144 option, display complete time information for the file, including
145 month, day, hour, minute, second, and year.
147 Display whiteouts when scanning directories.
149 Include directory entries whose names begin with a
157 escape codes whenever possible.
159 Use time when file status was last changed for sorting or printing.
161 Directories are listed as plain files (not searched recursively).
163 Output is not sorted.
165 This option is deprecated and is only available for compatibility
168 it was used to display the group name in the long
174 option, use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte
175 and Petabyte in order to reduce the number of digits to three or less
176 using base 2 for sizes.
178 For each file, print the file's file serial number (inode number).
182 option is specified, print the file size allocation in kilobytes,
184 This option overrides the environment variable
187 (The lowercase letter
191 If the output is to a terminal, a total sum for all the file
192 sizes is output on a line before the long listing.
194 Stream output format; list files across the page, separated by commas.
196 Display user and group IDs numerically rather than converting to a user
197 or group name in a long
201 Include the file flags in a long
207 after each filename if that file is a directory.
209 Force printing of non-graphic characters in file names as
212 this is the default when output is to a terminal.
214 Reverse the order of the sort to get reverse
215 lexicographical order or the oldest entries first.
217 Display the number of file system blocks actually used by each file, in units
218 of 512 bytes, where partial units are rounded up to the next integer value.
219 If the output is to a terminal, a total sum for all the file
220 sizes is output on a line before the listing.
221 The environment variable
223 overrides the unit size of 512 bytes.
225 Sort by time modified (most recently modified
226 first) before sorting the operands by lexicographical
229 Use time of last access,
230 instead of last modification
231 of the file for sorting
236 Force raw printing of non-printable characters.
238 when output is not to a terminal.
242 except that the multi-column output is produced with entries sorted
243 across, rather than down, the columns.
245 Force unedited printing of non-graphic characters; this is the default when
246 output is not to a terminal.
252 This is the default when
253 output is not to a terminal.
260 options all override each other; the last one specified determines
267 options override each other; the last one specified determines
274 options all override each other; the last one specified determines
275 the format used for non-printable characters.
281 options all override each other (either partially or fully); they
282 are applied in the order specified.
286 lists one entry per line to standard
287 output; the exceptions are to terminals or when the
291 options are specified.
293 File information is displayed with one or more
295 separating the information associated with the
303 option is given, the following information
304 is displayed for each file:
306 number of links, owner name, group name,
307 number of bytes in the file, abbreviated
308 month, day-of-month file was last modified,
309 hour file last modified, minute file last
310 modified, and the pathname.
311 In addition, for each directory whose contents are displayed, the total
312 number of 512-byte blocks used by the files in the directory is displayed
313 on a line by itself immediately before the information for the files in the
316 If the modification time of the file is more than 6 months
317 in the past or future, then the year of the last modification
318 is displayed in place of the hour and minute fields.
320 If the owner or group names are not a known user or group name,
324 the numeric ID's are displayed.
326 If the file is a character special or block special file,
327 the major and minor device numbers for the file are displayed
329 If the file is a symbolic link the pathname of the
330 linked-to file is preceded by
333 The file mode printed under the
335 option consists of the
336 entry type, owner permissions, and group permissions.
337 The entry type character describes the type of file, as
340 .Bl -tag -width 4n -offset indent -compact
344 Character special file.
357 The next three fields
358 are three characters each:
360 group permissions, and
362 Each field has three character positions:
363 .Bl -enum -offset indent
367 the file is readable; if
373 the file is writable; if
377 The first of the following that applies:
378 .Bl -tag -width 4n -offset indent
380 If in the owner permissions, the file is not executable and
381 set-user-ID mode is set.
382 If in the group permissions, the file is not executable
383 and set-group-ID mode is set.
385 If in the owner permissions, the file is executable
386 and set-user-ID mode is set.
387 If in the group permissions, the file is executable
388 and setgroup-ID mode is set.
390 The file is executable or the directory is
393 The file is neither readable, writable, executable,
394 nor set-user-ID nor set-group-ID mode, nor sticky.
398 These next two apply only to the third character in the last group
400 .Bl -tag -width 4n -offset indent
402 The sticky bit is set
405 but not execute or search permission.
411 The sticky bit is set (mode
413 and is searchable or executable.
421 The following is how to do an
423 listing sorted by size (and shows why
425 does not need a separate option for this):
427 .Dl "ls -l | sort -n +4"
434 to get the results sorted from largest to smallest (a reverse sort).
438 The following environment variables affect the execution of
440 .Bl -tag -width ".Ev CLICOLOR_FORCE"
442 If the environment variable
444 is set, the block counts
447 will be displayed in units of that size block.
451 color sequences to distinguish file types.
455 In addition to the file types mentioned in the
457 option some extra attributes (setuid bit set, etc.) are also displayed.
458 The colorization is dependent on a terminal type with the proper
463 console has the proper capabilities,
464 but to display the colors in an
469 variable must be set to
471 Other terminal types may require similar adjustments.
473 is silently disabled if the output isn't directed to a terminal
477 .It Ev CLICOLOR_FORCE
478 Color sequences are normally disabled if the output isn't directed to
480 This can be overridden by setting this flag.
483 variable still needs to reference a color capable terminal however
484 otherwise it is not possible to determine which color sequences to
487 If this variable contains a string representing a
488 decimal integer, it is used as the
489 column position width for displaying
490 multiple-text-column output.
493 utility calculates how
494 many pathname text columns to display
495 based on the width provided.
501 The locale to use when determining the order of day and month in the long
506 for more information.
508 The value of this variable describes what color to use for which
509 attribute when colors are enabled with
511 This string is a concatenation of pairs of the format
515 is the foreground color and
517 is the background color.
519 The color designators are as follows:
521 .Bl -tag -width 4n -offset indent -compact
539 bold black, usually shows up as dark grey
545 bold brown, usually shows up as yellow
553 bold light grey; looks like bright white
555 default foreground or background
558 Note that the above are standard
561 The actual display may differ
562 depending on the color capabilities of the terminal in use.
564 The order of the attributes are as follows:
566 .Bl -enum -offset indent -compact
582 executable with setuid bit set
584 executable with setgid bit set
586 directory writable to others, with sticky bit
588 directory writable to others, without sticky bit
592 .Qq "exfxcxdxbxegedabagacad" ,
593 i.e. blue foreground and
594 default background for regular directories, black foreground and red
595 background for setuid executables, etc.
597 If this variable is set, it is considered to be a
598 colon-delimited list of minimum column widths.
600 and insufficient widths are ignored (thus zero signifies
601 a dynamically sized column).
602 Not all columns have changeable widths.
604 in order: inode, block count, number of links, user name,
605 group name, flags, file size, file name.
609 functionality depends on a terminal type with color capabilities.
611 The timezone to use when displaying dates.
614 for more information.
617 The group field is now automatically included in the long listing for
618 files in order to be compatible with the
640 To maintain backward compatibility, the relationships between the many
641 options are quite complex.