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. Neither the name of the University nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" @(#)ls.1 8.7 (Berkeley) 7/29/94
32 .\" $FreeBSD: src/bin/ls/ls.1,v 1.86 2005/02/13 22:25:09 ru Exp $
34 .Dd September 25, 2008
39 .Nd list directory contents
42 .Op Fl ABCFGHILPRTWabcdfghiklmnopqrstuwxy1
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 List all entries, including dot files, except for dot and dot-dot.
71 Always set for the super-user, but may be turned
75 Force printing of non-printable characters (as defined by
77 and current locale settings) in file names as
81 is the numeric value of the character in octal.
83 Force multi-column output; this is the default when output is to a terminal.
87 immediately after each pathname that is a directory,
90 after each that is executable,
93 after each symbolic link,
105 Enable colorized output.
106 This option is equivalent to defining
111 Symbolic links on the command line are followed.
112 This option is assumed if
117 options are specified.
119 This turns off the listing of dot files.
120 Dot files are listed by default when
127 options will override each other.
129 If argument is a symbolic link, list the file or directory the link references
130 rather than the link itself.
131 This option cancels the
135 If argument is a symbolic link, list the link itself rather than the
136 object the link references.
137 This option cancels the
143 Recursively list subdirectories encountered.
145 Use the size of a file for sorting
152 option, display complete time information for the file, including
153 month, day, hour, minute, second, and year.
155 Display whiteouts when scanning directories.
157 Include directory entries whose names begin with a
165 escape codes whenever possible.
167 Use time when file status was last changed for sorting or printing.
169 Directories are listed as plain files (not searched recursively).
171 Output is not sorted.
173 This option is deprecated and is only available for compatibility
176 it was used to display the group name in the long
182 option, use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte
183 and Petabyte in order to reduce the number of digits to four or fewer
184 using base 2 for sizes.
186 For each file, print the file's file serial number (inode number).
190 option is specified, print the file size allocation in kilobytes,
192 This option overrides the environment variable
196 is mutually exclusive to
203 (The lowercase letter
207 A total sum (in blocks, see the
209 option for the block size unit) for all the file
210 sizes is output on a line before the long listing.
212 Stream output format; list files across the page, separated by commas.
214 Display user and group IDs numerically rather than converting to a user
215 or group name in a long
219 Include the file flags in a long
225 after each filename if that file is a directory.
227 Force printing of non-graphic characters in file names as
230 this is the default when output is to a terminal.
232 Reverse the order of the sort to get reverse
233 lexicographical order or the oldest entries first.
235 Display the number of file system blocks actually used by each file, in units
236 of 512 bytes, where partial units are rounded up to the next integer value.
237 A total sum for all the file
238 sizes is output on a line before the listing.
239 The environment variable
241 overrides the unit size of 512 bytes.
243 Sort by time modified (most recently modified
244 first) before sorting the operands by lexicographical
247 Use time of last access,
248 instead of last modification
249 of the file for sorting
254 Force raw printing of non-printable characters.
256 when output is not to a terminal.
260 except that the multi-column output is produced with entries sorted
261 across, rather than down, the columns.
263 Include the FSMID field in a long
271 This is the default when
272 output is not to a terminal.
279 options all override each other; the last one specified determines
286 options override each other; the last one specified determines
293 options all override each other; the last one specified determines
294 the format used for non-printable characters.
300 options all override each other (either partially or fully); they
301 are applied in the order specified.
305 lists one entry per line to standard
306 output; the exceptions are to terminals or when the
310 options are specified.
312 File information is displayed with one or more
314 separating the information associated with the
322 option is given, the following information
323 is displayed for each file:
325 number of links, owner name, group name,
326 number of bytes in the file, abbreviated
327 month, day-of-month file was last modified,
328 hour file last modified, minute file last
329 modified, and the pathname.
330 In addition, for each directory whose contents are displayed, the total
331 number of 512-byte blocks used by the files in the directory is displayed
332 on a line by itself immediately before the information for the files in the
335 If the modification time of the file is more than 6 months
336 in the past or future, then the year of the last modification
337 is displayed in place of the hour and minute fields.
339 If the owner or group names are not a known user or group name,
343 the numeric ID's are displayed.
345 If the file is a character special or block special file,
346 the major and minor device numbers for the file are displayed
348 If the file is a symbolic link the pathname of the
349 linked-to file is preceded by
352 The file mode printed under the
354 option consists of the
355 entry type and the permissions.
356 The entry type character describes the type of file, as
359 .Bl -tag -width 4n -offset indent -compact
363 Character special file.
376 The next three fields
377 are three characters each:
379 group permissions, and
381 Each field has three character positions:
382 .Bl -enum -offset indent
386 the file is readable; if
392 the file is writable; if
396 The first of the following that applies:
397 .Bl -tag -width 4n -offset indent
399 If in the owner permissions, the file is not executable and
400 set-user-ID mode is set.
401 If in the group permissions, the file is not executable
402 and set-group-ID mode is set.
404 If in the owner permissions, the file is executable
405 and set-user-ID mode is set.
406 If in the group permissions, the file is executable
407 and setgroup-ID mode is set.
409 The file is executable or the directory is
412 The file is neither readable, writable, executable,
413 nor set-user-ID nor set-group-ID mode, nor sticky.
417 These next two apply only to the third character in the last group
419 .Bl -tag -width 4n -offset indent
421 The sticky bit is set
424 but not execute or search permission.
430 The sticky bit is set (mode
432 and is searchable or executable.
440 The following environment variables affect the execution of
442 .Bl -tag -width ".Ev CLICOLOR_FORCE"
444 If the environment variable
446 is set, the block counts
449 will be displayed in units of that size block.
453 color sequences to distinguish file types.
457 In addition to the file types mentioned in the
459 option some extra attributes (setuid bit set, etc.) are also displayed.
460 The colorization is dependent on a terminal type with the proper
465 console has the proper capabilities,
466 but to display the colors in an
471 variable must be set to
473 Other terminal types may require similar adjustments.
475 is silently disabled if the output is not directed to a terminal
479 .It Ev CLICOLOR_FORCE
480 Color sequences are normally disabled if the output is not directed to
482 This can be overridden by setting this flag.
485 variable still needs to reference a color capable terminal however
486 otherwise it is not possible to determine which color sequences to
489 If this variable contains a string representing a
490 decimal integer, it is used as the
491 column position width for displaying
492 multiple-text-column output.
495 utility calculates how
496 many pathname text columns to display
497 based on the width provided.
503 The locale to use when determining the order of day and month in the long
508 for more information.
510 The value of this variable describes what color to use for which
511 attribute when colors are enabled with
513 This string is a concatenation of pairs of the format
517 is the foreground color and
519 is the background color.
521 The color designators are as follows:
523 .Bl -tag -width 4n -offset indent -compact
541 bold black, usually shows up as dark grey
547 bold brown, usually shows up as yellow
555 bold light grey; looks like bright white
557 default foreground or background
560 Note that the above are standard
563 The actual display may differ
564 depending on the color capabilities of the terminal in use.
566 The order of the attributes are as follows:
568 .Bl -enum -offset indent -compact
584 executable with setuid bit set
586 executable with setgid bit set
588 directory writable to others, with sticky bit
590 directory writable to others, without sticky bit
594 .Qq "exfxcxdxbxegedabagacad" ,
595 i.e., blue foreground and
596 default background for regular directories, black foreground and red
597 background for setuid executables, etc.
599 If this variable is set, it is considered to be a
600 colon-delimited list of minimum column widths.
602 and insufficient widths are ignored (thus zero signifies
603 a dynamically sized column).
604 Not all columns have changeable widths.
606 in order: inode, block count, number of links, user name,
607 group name, flags, file size, file name.
611 functionality depends on a terminal type with color capabilities.
613 The timezone to use when displaying dates.
616 for more information.
619 The group field is now automatically included in the long listing for
620 files in order to be compatible with the
627 .Xr xterm 1 Pq Pa x11/xterm ,
632 With the exception of options
647 To maintain backward compatibility, the relationships between the many
648 options are quite complex.