doc: clarify the operation of wc -L
[coreutils.git] / src / ls.c
blob01404e25cd8c4fca12d0adb1b26e379698b2fe59
1 /* 'dir', 'vdir' and 'ls' directory listing programs for GNU.
2 Copyright (C) 1985-2015 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* If ls_mode is LS_MULTI_COL,
18 the multi-column format is the default regardless
19 of the type of output device.
20 This is for the 'dir' program.
22 If ls_mode is LS_LONG_FORMAT,
23 the long format is the default regardless of the
24 type of output device.
25 This is for the 'vdir' program.
27 If ls_mode is LS_LS,
28 the output format depends on whether the output
29 device is a terminal.
30 This is for the 'ls' program. */
32 /* Written by Richard Stallman and David MacKenzie. */
34 /* Color support by Peter Anvin <Peter.Anvin@linux.org> and Dennis
35 Flaherty <dennisf@denix.elk.miles.com> based on original patches by
36 Greg Lee <lee@uhunix.uhcc.hawaii.edu>. */
38 #include <config.h>
39 #include <sys/types.h>
41 #include <termios.h>
42 #if HAVE_STROPTS_H
43 # include <stropts.h>
44 #endif
45 #include <sys/ioctl.h>
47 #ifdef WINSIZE_IN_PTEM
48 # include <sys/stream.h>
49 # include <sys/ptem.h>
50 #endif
52 #include <stdio.h>
53 #include <assert.h>
54 #include <setjmp.h>
55 #include <pwd.h>
56 #include <getopt.h>
57 #include <signal.h>
58 #include <selinux/selinux.h>
59 #include <wchar.h>
61 #if HAVE_LANGINFO_CODESET
62 # include <langinfo.h>
63 #endif
65 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
66 present. */
67 #ifndef SA_NOCLDSTOP
68 # define SA_NOCLDSTOP 0
69 # define sigprocmask(How, Set, Oset) /* empty */
70 # define sigset_t int
71 # if ! HAVE_SIGINTERRUPT
72 # define siginterrupt(sig, flag) /* empty */
73 # endif
74 #endif
76 /* NonStop circa 2011 lacks both SA_RESTART and siginterrupt, so don't
77 restart syscalls after a signal handler fires. This may cause
78 colors to get messed up on the screen if 'ls' is interrupted, but
79 that's the best we can do on such a platform. */
80 #ifndef SA_RESTART
81 # define SA_RESTART 0
82 #endif
84 #include "system.h"
85 #include <fnmatch.h>
87 #include "acl.h"
88 #include "argmatch.h"
89 #include "dev-ino.h"
90 #include "error.h"
91 #include "filenamecat.h"
92 #include "hard-locale.h"
93 #include "hash.h"
94 #include "human.h"
95 #include "filemode.h"
96 #include "filevercmp.h"
97 #include "idcache.h"
98 #include "ls.h"
99 #include "mbswidth.h"
100 #include "mpsort.h"
101 #include "obstack.h"
102 #include "quote.h"
103 #include "quotearg.h"
104 #include "smack.h"
105 #include "stat-size.h"
106 #include "stat-time.h"
107 #include "strftime.h"
108 #include "xdectoint.h"
109 #include "xstrtol.h"
110 #include "areadlink.h"
111 #include "mbsalign.h"
112 #include "dircolors.h"
114 /* Include <sys/capability.h> last to avoid a clash of <sys/types.h>
115 include guards with some premature versions of libcap.
116 For more details, see <http://bugzilla.redhat.com/483548>. */
117 #ifdef HAVE_CAP
118 # include <sys/capability.h>
119 #endif
121 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
122 : (ls_mode == LS_MULTI_COL \
123 ? "dir" : "vdir"))
125 #define AUTHORS \
126 proper_name ("Richard M. Stallman"), \
127 proper_name ("David MacKenzie")
129 #define obstack_chunk_alloc malloc
130 #define obstack_chunk_free free
132 /* Return an int indicating the result of comparing two integers.
133 Subtracting doesn't always work, due to overflow. */
134 #define longdiff(a, b) ((a) < (b) ? -1 : (a) > (b))
136 /* Unix-based readdir implementations have historically returned a dirent.d_ino
137 value that is sometimes not equal to the stat-obtained st_ino value for
138 that same entry. This error occurs for a readdir entry that refers
139 to a mount point. readdir's error is to return the inode number of
140 the underlying directory -- one that typically cannot be stat'ed, as
141 long as a file system is mounted on that directory. RELIABLE_D_INO
142 encapsulates whether we can use the more efficient approach of relying
143 on readdir-supplied d_ino values, or whether we must incur the cost of
144 calling stat or lstat to obtain each guaranteed-valid inode number. */
146 #ifndef READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
147 # define READDIR_LIES_ABOUT_MOUNTPOINT_D_INO 1
148 #endif
150 #if READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
151 # define RELIABLE_D_INO(dp) NOT_AN_INODE_NUMBER
152 #else
153 # define RELIABLE_D_INO(dp) D_INO (dp)
154 #endif
156 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
157 # define st_author st_uid
158 #endif
160 enum filetype
162 unknown,
163 fifo,
164 chardev,
165 directory,
166 blockdev,
167 normal,
168 symbolic_link,
169 sock,
170 whiteout,
171 arg_directory
174 /* Display letters and indicators for each filetype.
175 Keep these in sync with enum filetype. */
176 static char const filetype_letter[] = "?pcdb-lswd";
178 /* Ensure that filetype and filetype_letter have the same
179 number of elements. */
180 verify (sizeof filetype_letter - 1 == arg_directory + 1);
182 #define FILETYPE_INDICATORS \
184 C_ORPHAN, C_FIFO, C_CHR, C_DIR, C_BLK, C_FILE, \
185 C_LINK, C_SOCK, C_FILE, C_DIR \
188 enum acl_type
190 ACL_T_NONE,
191 ACL_T_LSM_CONTEXT_ONLY,
192 ACL_T_YES
195 struct fileinfo
197 /* The file name. */
198 char *name;
200 /* For symbolic link, name of the file linked to, otherwise zero. */
201 char *linkname;
203 struct stat stat;
205 enum filetype filetype;
207 /* For symbolic link and long listing, st_mode of file linked to, otherwise
208 zero. */
209 mode_t linkmode;
211 /* security context. */
212 char *scontext;
214 bool stat_ok;
216 /* For symbolic link and color printing, true if linked-to file
217 exists, otherwise false. */
218 bool linkok;
220 /* For long listings, true if the file has an access control list,
221 or a security context. */
222 enum acl_type acl_type;
224 /* For color listings, true if a regular file has capability info. */
225 bool has_capability;
228 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
230 /* Null is a valid character in a color indicator (think about Epson
231 printers, for example) so we have to use a length/buffer string
232 type. */
234 struct bin_str
236 size_t len; /* Number of bytes */
237 const char *string; /* Pointer to the same */
240 #if ! HAVE_TCGETPGRP
241 # define tcgetpgrp(Fd) 0
242 #endif
244 static size_t quote_name (FILE *out, const char *name,
245 struct quoting_options const *options,
246 size_t *width);
247 static char *make_link_name (char const *name, char const *linkname);
248 static int decode_switches (int argc, char **argv);
249 static bool file_ignored (char const *name);
250 static uintmax_t gobble_file (char const *name, enum filetype type,
251 ino_t inode, bool command_line_arg,
252 char const *dirname);
253 static bool print_color_indicator (const struct fileinfo *f,
254 bool symlink_target);
255 static void put_indicator (const struct bin_str *ind);
256 static void add_ignore_pattern (const char *pattern);
257 static void attach (char *dest, const char *dirname, const char *name);
258 static void clear_files (void);
259 static void extract_dirs_from_files (char const *dirname,
260 bool command_line_arg);
261 static void get_link_name (char const *filename, struct fileinfo *f,
262 bool command_line_arg);
263 static void indent (size_t from, size_t to);
264 static size_t calculate_columns (bool by_columns);
265 static void print_current_files (void);
266 static void print_dir (char const *name, char const *realname,
267 bool command_line_arg);
268 static size_t print_file_name_and_frills (const struct fileinfo *f,
269 size_t start_col);
270 static void print_horizontal (void);
271 static int format_user_width (uid_t u);
272 static int format_group_width (gid_t g);
273 static void print_long_format (const struct fileinfo *f);
274 static void print_many_per_line (void);
275 static size_t print_name_with_quoting (const struct fileinfo *f,
276 bool symlink_target,
277 struct obstack *stack,
278 size_t start_col);
279 static void prep_non_filename_text (void);
280 static bool print_type_indicator (bool stat_ok, mode_t mode,
281 enum filetype type);
282 static void print_with_commas (void);
283 static void queue_directory (char const *name, char const *realname,
284 bool command_line_arg);
285 static void sort_files (void);
286 static void parse_ls_color (void);
288 static void getenv_quoting_style (void);
290 /* Initial size of hash table.
291 Most hierarchies are likely to be shallower than this. */
292 #define INITIAL_TABLE_SIZE 30
294 /* The set of 'active' directories, from the current command-line argument
295 to the level in the hierarchy at which files are being listed.
296 A directory is represented by its device and inode numbers (struct dev_ino).
297 A directory is added to this set when ls begins listing it or its
298 entries, and it is removed from the set just after ls has finished
299 processing it. This set is used solely to detect loops, e.g., with
300 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
301 static Hash_table *active_dir_set;
303 #define LOOP_DETECT (!!active_dir_set)
305 /* The table of files in the current directory:
307 'cwd_file' points to a vector of 'struct fileinfo', one per file.
308 'cwd_n_alloc' is the number of elements space has been allocated for.
309 'cwd_n_used' is the number actually in use. */
311 /* Address of block containing the files that are described. */
312 static struct fileinfo *cwd_file;
314 /* Length of block that 'cwd_file' points to, measured in files. */
315 static size_t cwd_n_alloc;
317 /* Index of first unused slot in 'cwd_file'. */
318 static size_t cwd_n_used;
320 /* Vector of pointers to files, in proper sorted order, and the number
321 of entries allocated for it. */
322 static void **sorted_file;
323 static size_t sorted_file_alloc;
325 /* When true, in a color listing, color each symlink name according to the
326 type of file it points to. Otherwise, color them according to the 'ln'
327 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
328 regardless. This is set when 'ln=target' appears in LS_COLORS. */
330 static bool color_symlink_as_referent;
332 /* mode of appropriate file for colorization */
333 #define FILE_OR_LINK_MODE(File) \
334 ((color_symlink_as_referent && (File)->linkok) \
335 ? (File)->linkmode : (File)->stat.st_mode)
338 /* Record of one pending directory waiting to be listed. */
340 struct pending
342 char *name;
343 /* If the directory is actually the file pointed to by a symbolic link we
344 were told to list, 'realname' will contain the name of the symbolic
345 link, otherwise zero. */
346 char *realname;
347 bool command_line_arg;
348 struct pending *next;
351 static struct pending *pending_dirs;
353 /* Current time in seconds and nanoseconds since 1970, updated as
354 needed when deciding whether a file is recent. */
356 static struct timespec current_time;
358 static bool print_scontext;
359 static char UNKNOWN_SECURITY_CONTEXT[] = "?";
361 /* Whether any of the files has an ACL. This affects the width of the
362 mode column. */
364 static bool any_has_acl;
366 /* The number of columns to use for columns containing inode numbers,
367 block sizes, link counts, owners, groups, authors, major device
368 numbers, minor device numbers, and file sizes, respectively. */
370 static int inode_number_width;
371 static int block_size_width;
372 static int nlink_width;
373 static int scontext_width;
374 static int owner_width;
375 static int group_width;
376 static int author_width;
377 static int major_device_number_width;
378 static int minor_device_number_width;
379 static int file_size_width;
381 /* Option flags */
383 /* long_format for lots of info, one per line.
384 one_per_line for just names, one per line.
385 many_per_line for just names, many per line, sorted vertically.
386 horizontal for just names, many per line, sorted horizontally.
387 with_commas for just names, many per line, separated by commas.
389 -l (and other options that imply -l), -1, -C, -x and -m control
390 this parameter. */
392 enum format
394 long_format, /* -l and other options that imply -l */
395 one_per_line, /* -1 */
396 many_per_line, /* -C */
397 horizontal, /* -x */
398 with_commas /* -m */
401 static enum format format;
403 /* 'full-iso' uses full ISO-style dates and times. 'long-iso' uses longer
404 ISO-style time stamps, though shorter than 'full-iso'. 'iso' uses shorter
405 ISO-style time stamps. 'locale' uses locale-dependent time stamps. */
406 enum time_style
408 full_iso_time_style, /* --time-style=full-iso */
409 long_iso_time_style, /* --time-style=long-iso */
410 iso_time_style, /* --time-style=iso */
411 locale_time_style /* --time-style=locale */
414 static char const *const time_style_args[] =
416 "full-iso", "long-iso", "iso", "locale", NULL
418 static enum time_style const time_style_types[] =
420 full_iso_time_style, long_iso_time_style, iso_time_style,
421 locale_time_style
423 ARGMATCH_VERIFY (time_style_args, time_style_types);
425 /* Type of time to print or sort by. Controlled by -c and -u.
426 The values of each item of this enum are important since they are
427 used as indices in the sort functions array (see sort_files()). */
429 enum time_type
431 time_mtime, /* default */
432 time_ctime, /* -c */
433 time_atime, /* -u */
434 time_numtypes /* the number of elements of this enum */
437 static enum time_type time_type;
439 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
440 The values of each item of this enum are important since they are
441 used as indices in the sort functions array (see sort_files()). */
443 enum sort_type
445 sort_none = -1, /* -U */
446 sort_name, /* default */
447 sort_extension, /* -X */
448 sort_size, /* -S */
449 sort_version, /* -v */
450 sort_time, /* -t */
451 sort_numtypes /* the number of elements of this enum */
454 static enum sort_type sort_type;
456 /* Direction of sort.
457 false means highest first if numeric,
458 lowest first if alphabetic;
459 these are the defaults.
460 true means the opposite order in each case. -r */
462 static bool sort_reverse;
464 /* True means to display owner information. -g turns this off. */
466 static bool print_owner = true;
468 /* True means to display author information. */
470 static bool print_author;
472 /* True means to display group information. -G and -o turn this off. */
474 static bool print_group = true;
476 /* True means print the user and group id's as numbers rather
477 than as names. -n */
479 static bool numeric_ids;
481 /* True means mention the size in blocks of each file. -s */
483 static bool print_block_size;
485 /* Human-readable options for output, when printing block counts. */
486 static int human_output_opts;
488 /* The units to use when printing block counts. */
489 static uintmax_t output_block_size;
491 /* Likewise, but for file sizes. */
492 static int file_human_output_opts;
493 static uintmax_t file_output_block_size = 1;
495 /* Follow the output with a special string. Using this format,
496 Emacs' dired mode starts up twice as fast, and can handle all
497 strange characters in file names. */
498 static bool dired;
500 /* 'none' means don't mention the type of files.
501 'slash' means mention directories only, with a '/'.
502 'file_type' means mention file types.
503 'classify' means mention file types and mark executables.
505 Controlled by -F, -p, and --indicator-style. */
507 enum indicator_style
509 none, /* --indicator-style=none */
510 slash, /* -p, --indicator-style=slash */
511 file_type, /* --indicator-style=file-type */
512 classify /* -F, --indicator-style=classify */
515 static enum indicator_style indicator_style;
517 /* Names of indicator styles. */
518 static char const *const indicator_style_args[] =
520 "none", "slash", "file-type", "classify", NULL
522 static enum indicator_style const indicator_style_types[] =
524 none, slash, file_type, classify
526 ARGMATCH_VERIFY (indicator_style_args, indicator_style_types);
528 /* True means use colors to mark types. Also define the different
529 colors as well as the stuff for the LS_COLORS environment variable.
530 The LS_COLORS variable is now in a termcap-like format. */
532 static bool print_with_color;
534 /* Whether we used any colors in the output so far. If so, we will
535 need to restore the default color later. If not, we will need to
536 call prep_non_filename_text before using color for the first time. */
538 static bool used_color = false;
540 enum color_type
542 color_never, /* 0: default or --color=never */
543 color_always, /* 1: --color=always */
544 color_if_tty /* 2: --color=tty */
547 enum Dereference_symlink
549 DEREF_UNDEFINED = 1,
550 DEREF_NEVER,
551 DEREF_COMMAND_LINE_ARGUMENTS, /* -H */
552 DEREF_COMMAND_LINE_SYMLINK_TO_DIR, /* the default, in certain cases */
553 DEREF_ALWAYS /* -L */
556 enum indicator_no
558 C_LEFT, C_RIGHT, C_END, C_RESET, C_NORM, C_FILE, C_DIR, C_LINK,
559 C_FIFO, C_SOCK,
560 C_BLK, C_CHR, C_MISSING, C_ORPHAN, C_EXEC, C_DOOR, C_SETUID, C_SETGID,
561 C_STICKY, C_OTHER_WRITABLE, C_STICKY_OTHER_WRITABLE, C_CAP, C_MULTIHARDLINK,
562 C_CLR_TO_EOL
565 static const char *const indicator_name[]=
567 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
568 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
569 "ow", "tw", "ca", "mh", "cl", NULL
572 struct color_ext_type
574 struct bin_str ext; /* The extension we're looking for */
575 struct bin_str seq; /* The sequence to output when we do */
576 struct color_ext_type *next; /* Next in list */
579 static struct bin_str color_indicator[] =
581 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
582 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
583 { 0, NULL }, /* ec: End color (replaces lc+rs+rc) */
584 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
585 { 0, NULL }, /* no: Normal */
586 { 0, NULL }, /* fi: File: default */
587 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
588 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
589 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
590 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
591 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
592 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
593 { 0, NULL }, /* mi: Missing file: undefined */
594 { 0, NULL }, /* or: Orphaned symlink: undefined */
595 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
596 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
597 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
598 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
599 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
600 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
601 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
602 { LEN_STR_PAIR ("30;41") }, /* ca: black on red */
603 { 0, NULL }, /* mh: disabled by default */
604 { LEN_STR_PAIR ("\033[K") }, /* cl: clear to end of line */
607 /* FIXME: comment */
608 static struct color_ext_type *color_ext_list = NULL;
610 /* Buffer for color sequences */
611 static char *color_buf;
613 /* True means to check for orphaned symbolic link, for displaying
614 colors. */
616 static bool check_symlink_color;
618 /* True means mention the inode number of each file. -i */
620 static bool print_inode;
622 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
623 other options that imply -l), and -L. */
625 static enum Dereference_symlink dereference;
627 /* True means when a directory is found, display info on its
628 contents. -R */
630 static bool recursive;
632 /* True means when an argument is a directory name, display info
633 on it itself. -d */
635 static bool immediate_dirs;
637 /* True means that directories are grouped before files. */
639 static bool directories_first;
641 /* Which files to ignore. */
643 static enum
645 /* Ignore files whose names start with '.', and files specified by
646 --hide and --ignore. */
647 IGNORE_DEFAULT,
649 /* Ignore '.', '..', and files specified by --ignore. */
650 IGNORE_DOT_AND_DOTDOT,
652 /* Ignore only files specified by --ignore. */
653 IGNORE_MINIMAL
654 } ignore_mode;
656 /* A linked list of shell-style globbing patterns. If a non-argument
657 file name matches any of these patterns, it is ignored.
658 Controlled by -I. Multiple -I options accumulate.
659 The -B option adds '*~' and '.*~' to this list. */
661 struct ignore_pattern
663 const char *pattern;
664 struct ignore_pattern *next;
667 static struct ignore_pattern *ignore_patterns;
669 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
670 variable itself to be ignored. */
671 static struct ignore_pattern *hide_patterns;
673 /* True means output nongraphic chars in file names as '?'.
674 (-q, --hide-control-chars)
675 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
676 independent. The algorithm is: first, obey the quoting style to get a
677 string representing the file name; then, if qmark_funny_chars is set,
678 replace all nonprintable chars in that string with '?'. It's necessary
679 to replace nonprintable chars even in quoted strings, because we don't
680 want to mess up the terminal if control chars get sent to it, and some
681 quoting methods pass through control chars as-is. */
682 static bool qmark_funny_chars;
684 /* Quoting options for file and dir name output. */
686 static struct quoting_options *filename_quoting_options;
687 static struct quoting_options *dirname_quoting_options;
689 /* The number of chars per hardware tab stop. Setting this to zero
690 inhibits the use of TAB characters for separating columns. -T */
691 static size_t tabsize;
693 /* True means print each directory name before listing it. */
695 static bool print_dir_name;
697 /* The line length to use for breaking lines in many-per-line format.
698 Can be set with -w. */
700 static size_t line_length;
702 /* If true, the file listing format requires that stat be called on
703 each file. */
705 static bool format_needs_stat;
707 /* Similar to 'format_needs_stat', but set if only the file type is
708 needed. */
710 static bool format_needs_type;
712 /* An arbitrary limit on the number of bytes in a printed time stamp.
713 This is set to a relatively small value to avoid the need to worry
714 about denial-of-service attacks on servers that run "ls" on behalf
715 of remote clients. 1000 bytes should be enough for any practical
716 time stamp format. */
718 enum { TIME_STAMP_LEN_MAXIMUM = MAX (1000, INT_STRLEN_BOUND (time_t)) };
720 /* strftime formats for non-recent and recent files, respectively, in
721 -l output. */
723 static char const *long_time_format[2] =
725 /* strftime format for non-recent files (older than 6 months), in
726 -l output. This should contain the year, month and day (at
727 least), in an order that is understood by people in your
728 locale's territory. Please try to keep the number of used
729 screen columns small, because many people work in windows with
730 only 80 columns. But make this as wide as the other string
731 below, for recent files. */
732 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
733 so be wary of using variable width fields from the locale.
734 Note %b is handled specially by ls and aligned correctly.
735 Note also that specifying a width as in %5b is erroneous as strftime
736 will count bytes rather than characters in multibyte locales. */
737 N_("%b %e %Y"),
738 /* strftime format for recent files (younger than 6 months), in -l
739 output. This should contain the month, day and time (at
740 least), in an order that is understood by people in your
741 locale's territory. Please try to keep the number of used
742 screen columns small, because many people work in windows with
743 only 80 columns. But make this as wide as the other string
744 above, for non-recent files. */
745 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
746 so be wary of using variable width fields from the locale.
747 Note %b is handled specially by ls and aligned correctly.
748 Note also that specifying a width as in %5b is erroneous as strftime
749 will count bytes rather than characters in multibyte locales. */
750 N_("%b %e %H:%M")
753 /* The set of signals that are caught. */
755 static sigset_t caught_signals;
757 /* If nonzero, the value of the pending fatal signal. */
759 static sig_atomic_t volatile interrupt_signal;
761 /* A count of the number of pending stop signals that have been received. */
763 static sig_atomic_t volatile stop_signal_count;
765 /* Desired exit status. */
767 static int exit_status;
769 /* Exit statuses. */
770 enum
772 /* "ls" had a minor problem. E.g., while processing a directory,
773 ls obtained the name of an entry via readdir, yet was later
774 unable to stat that name. This happens when listing a directory
775 in which entries are actively being removed or renamed. */
776 LS_MINOR_PROBLEM = 1,
778 /* "ls" had more serious trouble (e.g., memory exhausted, invalid
779 option or failure to stat a command line argument. */
780 LS_FAILURE = 2
783 /* For long options that have no equivalent short option, use a
784 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
785 enum
787 AUTHOR_OPTION = CHAR_MAX + 1,
788 BLOCK_SIZE_OPTION,
789 COLOR_OPTION,
790 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION,
791 FILE_TYPE_INDICATOR_OPTION,
792 FORMAT_OPTION,
793 FULL_TIME_OPTION,
794 GROUP_DIRECTORIES_FIRST_OPTION,
795 HIDE_OPTION,
796 INDICATOR_STYLE_OPTION,
797 QUOTING_STYLE_OPTION,
798 SHOW_CONTROL_CHARS_OPTION,
799 SI_OPTION,
800 SORT_OPTION,
801 TIME_OPTION,
802 TIME_STYLE_OPTION
805 static struct option const long_options[] =
807 {"all", no_argument, NULL, 'a'},
808 {"escape", no_argument, NULL, 'b'},
809 {"directory", no_argument, NULL, 'd'},
810 {"dired", no_argument, NULL, 'D'},
811 {"full-time", no_argument, NULL, FULL_TIME_OPTION},
812 {"group-directories-first", no_argument, NULL,
813 GROUP_DIRECTORIES_FIRST_OPTION},
814 {"human-readable", no_argument, NULL, 'h'},
815 {"inode", no_argument, NULL, 'i'},
816 {"kibibytes", no_argument, NULL, 'k'},
817 {"numeric-uid-gid", no_argument, NULL, 'n'},
818 {"no-group", no_argument, NULL, 'G'},
819 {"hide-control-chars", no_argument, NULL, 'q'},
820 {"reverse", no_argument, NULL, 'r'},
821 {"size", no_argument, NULL, 's'},
822 {"width", required_argument, NULL, 'w'},
823 {"almost-all", no_argument, NULL, 'A'},
824 {"ignore-backups", no_argument, NULL, 'B'},
825 {"classify", no_argument, NULL, 'F'},
826 {"file-type", no_argument, NULL, FILE_TYPE_INDICATOR_OPTION},
827 {"si", no_argument, NULL, SI_OPTION},
828 {"dereference-command-line", no_argument, NULL, 'H'},
829 {"dereference-command-line-symlink-to-dir", no_argument, NULL,
830 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION},
831 {"hide", required_argument, NULL, HIDE_OPTION},
832 {"ignore", required_argument, NULL, 'I'},
833 {"indicator-style", required_argument, NULL, INDICATOR_STYLE_OPTION},
834 {"dereference", no_argument, NULL, 'L'},
835 {"literal", no_argument, NULL, 'N'},
836 {"quote-name", no_argument, NULL, 'Q'},
837 {"quoting-style", required_argument, NULL, QUOTING_STYLE_OPTION},
838 {"recursive", no_argument, NULL, 'R'},
839 {"format", required_argument, NULL, FORMAT_OPTION},
840 {"show-control-chars", no_argument, NULL, SHOW_CONTROL_CHARS_OPTION},
841 {"sort", required_argument, NULL, SORT_OPTION},
842 {"tabsize", required_argument, NULL, 'T'},
843 {"time", required_argument, NULL, TIME_OPTION},
844 {"time-style", required_argument, NULL, TIME_STYLE_OPTION},
845 {"color", optional_argument, NULL, COLOR_OPTION},
846 {"block-size", required_argument, NULL, BLOCK_SIZE_OPTION},
847 {"context", no_argument, 0, 'Z'},
848 {"author", no_argument, NULL, AUTHOR_OPTION},
849 {GETOPT_HELP_OPTION_DECL},
850 {GETOPT_VERSION_OPTION_DECL},
851 {NULL, 0, NULL, 0}
854 static char const *const format_args[] =
856 "verbose", "long", "commas", "horizontal", "across",
857 "vertical", "single-column", NULL
859 static enum format const format_types[] =
861 long_format, long_format, with_commas, horizontal, horizontal,
862 many_per_line, one_per_line
864 ARGMATCH_VERIFY (format_args, format_types);
866 static char const *const sort_args[] =
868 "none", "time", "size", "extension", "version", NULL
870 static enum sort_type const sort_types[] =
872 sort_none, sort_time, sort_size, sort_extension, sort_version
874 ARGMATCH_VERIFY (sort_args, sort_types);
876 static char const *const time_args[] =
878 "atime", "access", "use", "ctime", "status", NULL
880 static enum time_type const time_types[] =
882 time_atime, time_atime, time_atime, time_ctime, time_ctime
884 ARGMATCH_VERIFY (time_args, time_types);
886 static char const *const color_args[] =
888 /* force and none are for compatibility with another color-ls version */
889 "always", "yes", "force",
890 "never", "no", "none",
891 "auto", "tty", "if-tty", NULL
893 static enum color_type const color_types[] =
895 color_always, color_always, color_always,
896 color_never, color_never, color_never,
897 color_if_tty, color_if_tty, color_if_tty
899 ARGMATCH_VERIFY (color_args, color_types);
901 /* Information about filling a column. */
902 struct column_info
904 bool valid_len;
905 size_t line_len;
906 size_t *col_arr;
909 /* Array with information about column filledness. */
910 static struct column_info *column_info;
912 /* Maximum number of columns ever possible for this display. */
913 static size_t max_idx;
915 /* The minimum width of a column is 3: 1 character for the name and 2
916 for the separating white space. */
917 #define MIN_COLUMN_WIDTH 3
920 /* This zero-based index is used solely with the --dired option.
921 When that option is in effect, this counter is incremented for each
922 byte of output generated by this program so that the beginning
923 and ending indices (in that output) of every file name can be recorded
924 and later output themselves. */
925 static size_t dired_pos;
927 #define DIRED_PUTCHAR(c) do {putchar ((c)); ++dired_pos;} while (0)
929 /* Write S to STREAM and increment DIRED_POS by S_LEN. */
930 #define DIRED_FPUTS(s, stream, s_len) \
931 do {fputs (s, stream); dired_pos += s_len;} while (0)
933 /* Like DIRED_FPUTS, but for use when S is a literal string. */
934 #define DIRED_FPUTS_LITERAL(s, stream) \
935 do {fputs (s, stream); dired_pos += sizeof (s) - 1;} while (0)
937 #define DIRED_INDENT() \
938 do \
940 if (dired) \
941 DIRED_FPUTS_LITERAL (" ", stdout); \
943 while (0)
945 /* With --dired, store pairs of beginning and ending indices of filenames. */
946 static struct obstack dired_obstack;
948 /* With --dired, store pairs of beginning and ending indices of any
949 directory names that appear as headers (just before 'total' line)
950 for lists of directory entries. Such directory names are seen when
951 listing hierarchies using -R and when a directory is listed with at
952 least one other command line argument. */
953 static struct obstack subdired_obstack;
955 /* Save the current index on the specified obstack, OBS. */
956 #define PUSH_CURRENT_DIRED_POS(obs) \
957 do \
959 if (dired) \
960 obstack_grow (obs, &dired_pos, sizeof (dired_pos)); \
962 while (0)
964 /* With -R, this stack is used to help detect directory cycles.
965 The device/inode pairs on this stack mirror the pairs in the
966 active_dir_set hash table. */
967 static struct obstack dev_ino_obstack;
969 /* Push a pair onto the device/inode stack. */
970 static void
971 dev_ino_push (dev_t dev, ino_t ino)
973 void *vdi;
974 struct dev_ino *di;
975 int dev_ino_size = sizeof *di;
976 obstack_blank (&dev_ino_obstack, dev_ino_size);
977 vdi = obstack_next_free (&dev_ino_obstack);
978 di = vdi;
979 di--;
980 di->st_dev = dev;
981 di->st_ino = ino;
984 /* Pop a dev/ino struct off the global dev_ino_obstack
985 and return that struct. */
986 static struct dev_ino
987 dev_ino_pop (void)
989 void *vdi;
990 struct dev_ino *di;
991 int dev_ino_size = sizeof *di;
992 assert (dev_ino_size <= obstack_object_size (&dev_ino_obstack));
993 obstack_blank_fast (&dev_ino_obstack, -dev_ino_size);
994 vdi = obstack_next_free (&dev_ino_obstack);
995 di = vdi;
996 return *di;
999 /* Note the use commented out below:
1000 #define ASSERT_MATCHING_DEV_INO(Name, Di) \
1001 do \
1003 struct stat sb; \
1004 assert (Name); \
1005 assert (0 <= stat (Name, &sb)); \
1006 assert (sb.st_dev == Di.st_dev); \
1007 assert (sb.st_ino == Di.st_ino); \
1009 while (0)
1012 /* Write to standard output PREFIX, followed by the quoting style and
1013 a space-separated list of the integers stored in OS all on one line. */
1015 static void
1016 dired_dump_obstack (const char *prefix, struct obstack *os)
1018 size_t n_pos;
1020 n_pos = obstack_object_size (os) / sizeof (dired_pos);
1021 if (n_pos > 0)
1023 size_t i;
1024 size_t *pos;
1026 pos = (size_t *) obstack_finish (os);
1027 fputs (prefix, stdout);
1028 for (i = 0; i < n_pos; i++)
1029 printf (" %lu", (unsigned long int) pos[i]);
1030 putchar ('\n');
1034 /* Read the abbreviated month names from the locale, to align them
1035 and to determine the max width of the field and to truncate names
1036 greater than our max allowed.
1037 Note even though this handles multibyte locales correctly
1038 it's not restricted to them as single byte locales can have
1039 variable width abbreviated months and also precomputing/caching
1040 the names was seen to increase the performance of ls significantly. */
1042 /* max number of display cells to use */
1043 enum { MAX_MON_WIDTH = 5 };
1044 /* In the unlikely event that the abmon[] storage is not big enough
1045 an error message will be displayed, and we revert to using
1046 unmodified abbreviated month names from the locale database. */
1047 static char abmon[12][MAX_MON_WIDTH * 2 * MB_LEN_MAX + 1];
1048 /* minimum width needed to align %b, 0 => don't use precomputed values. */
1049 static size_t required_mon_width;
1051 static size_t
1052 abmon_init (void)
1054 #ifdef HAVE_NL_LANGINFO
1055 required_mon_width = MAX_MON_WIDTH;
1056 size_t curr_max_width;
1059 curr_max_width = required_mon_width;
1060 required_mon_width = 0;
1061 for (int i = 0; i < 12; i++)
1063 size_t width = curr_max_width;
1065 size_t req = mbsalign (nl_langinfo (ABMON_1 + i),
1066 abmon[i], sizeof (abmon[i]),
1067 &width, MBS_ALIGN_LEFT, 0);
1069 if (req == (size_t) -1 || req >= sizeof (abmon[i]))
1071 required_mon_width = 0; /* ignore precomputed strings. */
1072 return required_mon_width;
1075 required_mon_width = MAX (required_mon_width, width);
1078 while (curr_max_width > required_mon_width);
1079 #endif
1081 return required_mon_width;
1084 static size_t
1085 dev_ino_hash (void const *x, size_t table_size)
1087 struct dev_ino const *p = x;
1088 return (uintmax_t) p->st_ino % table_size;
1091 static bool
1092 dev_ino_compare (void const *x, void const *y)
1094 struct dev_ino const *a = x;
1095 struct dev_ino const *b = y;
1096 return SAME_INODE (*a, *b) ? true : false;
1099 static void
1100 dev_ino_free (void *x)
1102 free (x);
1105 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1106 active directories. Return true if there is already a matching
1107 entry in the table. */
1109 static bool
1110 visit_dir (dev_t dev, ino_t ino)
1112 struct dev_ino *ent;
1113 struct dev_ino *ent_from_table;
1114 bool found_match;
1116 ent = xmalloc (sizeof *ent);
1117 ent->st_ino = ino;
1118 ent->st_dev = dev;
1120 /* Attempt to insert this entry into the table. */
1121 ent_from_table = hash_insert (active_dir_set, ent);
1123 if (ent_from_table == NULL)
1125 /* Insertion failed due to lack of memory. */
1126 xalloc_die ();
1129 found_match = (ent_from_table != ent);
1131 if (found_match)
1133 /* ent was not inserted, so free it. */
1134 free (ent);
1137 return found_match;
1140 static void
1141 free_pending_ent (struct pending *p)
1143 free (p->name);
1144 free (p->realname);
1145 free (p);
1148 static bool
1149 is_colored (enum indicator_no type)
1151 size_t len = color_indicator[type].len;
1152 char const *s = color_indicator[type].string;
1153 return ! (len == 0
1154 || (len == 1 && STRNCMP_LIT (s, "0") == 0)
1155 || (len == 2 && STRNCMP_LIT (s, "00") == 0));
1158 static void
1159 restore_default_color (void)
1161 put_indicator (&color_indicator[C_LEFT]);
1162 put_indicator (&color_indicator[C_RIGHT]);
1165 static void
1166 set_normal_color (void)
1168 if (print_with_color && is_colored (C_NORM))
1170 put_indicator (&color_indicator[C_LEFT]);
1171 put_indicator (&color_indicator[C_NORM]);
1172 put_indicator (&color_indicator[C_RIGHT]);
1176 /* An ordinary signal was received; arrange for the program to exit. */
1178 static void
1179 sighandler (int sig)
1181 if (! SA_NOCLDSTOP)
1182 signal (sig, SIG_IGN);
1183 if (! interrupt_signal)
1184 interrupt_signal = sig;
1187 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1189 static void
1190 stophandler (int sig)
1192 if (! SA_NOCLDSTOP)
1193 signal (sig, stophandler);
1194 if (! interrupt_signal)
1195 stop_signal_count++;
1198 /* Process any pending signals. If signals are caught, this function
1199 should be called periodically. Ideally there should never be an
1200 unbounded amount of time when signals are not being processed.
1201 Signal handling can restore the default colors, so callers must
1202 immediately change colors after invoking this function. */
1204 static void
1205 process_signals (void)
1207 while (interrupt_signal || stop_signal_count)
1209 int sig;
1210 int stops;
1211 sigset_t oldset;
1213 if (used_color)
1214 restore_default_color ();
1215 fflush (stdout);
1217 sigprocmask (SIG_BLOCK, &caught_signals, &oldset);
1219 /* Reload interrupt_signal and stop_signal_count, in case a new
1220 signal was handled before sigprocmask took effect. */
1221 sig = interrupt_signal;
1222 stops = stop_signal_count;
1224 /* SIGTSTP is special, since the application can receive that signal
1225 more than once. In this case, don't set the signal handler to the
1226 default. Instead, just raise the uncatchable SIGSTOP. */
1227 if (stops)
1229 stop_signal_count = stops - 1;
1230 sig = SIGSTOP;
1232 else
1233 signal (sig, SIG_DFL);
1235 /* Exit or suspend the program. */
1236 raise (sig);
1237 sigprocmask (SIG_SETMASK, &oldset, NULL);
1239 /* If execution reaches here, then the program has been
1240 continued (after being suspended). */
1245 main (int argc, char **argv)
1247 int i;
1248 struct pending *thispend;
1249 int n_files;
1251 /* The signals that are trapped, and the number of such signals. */
1252 static int const sig[] =
1254 /* This one is handled specially. */
1255 SIGTSTP,
1257 /* The usual suspects. */
1258 SIGALRM, SIGHUP, SIGINT, SIGPIPE, SIGQUIT, SIGTERM,
1259 #ifdef SIGPOLL
1260 SIGPOLL,
1261 #endif
1262 #ifdef SIGPROF
1263 SIGPROF,
1264 #endif
1265 #ifdef SIGVTALRM
1266 SIGVTALRM,
1267 #endif
1268 #ifdef SIGXCPU
1269 SIGXCPU,
1270 #endif
1271 #ifdef SIGXFSZ
1272 SIGXFSZ,
1273 #endif
1275 enum { nsigs = ARRAY_CARDINALITY (sig) };
1277 #if ! SA_NOCLDSTOP
1278 bool caught_sig[nsigs];
1279 #endif
1281 initialize_main (&argc, &argv);
1282 set_program_name (argv[0]);
1283 setlocale (LC_ALL, "");
1284 bindtextdomain (PACKAGE, LOCALEDIR);
1285 textdomain (PACKAGE);
1287 initialize_exit_failure (LS_FAILURE);
1288 atexit (close_stdout);
1290 assert (ARRAY_CARDINALITY (color_indicator) + 1
1291 == ARRAY_CARDINALITY (indicator_name));
1293 exit_status = EXIT_SUCCESS;
1294 print_dir_name = true;
1295 pending_dirs = NULL;
1297 current_time.tv_sec = TYPE_MINIMUM (time_t);
1298 current_time.tv_nsec = -1;
1300 i = decode_switches (argc, argv);
1302 if (print_with_color)
1303 parse_ls_color ();
1305 /* Test print_with_color again, because the call to parse_ls_color
1306 may have just reset it -- e.g., if LS_COLORS is invalid. */
1307 if (print_with_color)
1309 /* Avoid following symbolic links when possible. */
1310 if (is_colored (C_ORPHAN)
1311 || (is_colored (C_EXEC) && color_symlink_as_referent)
1312 || (is_colored (C_MISSING) && format == long_format))
1313 check_symlink_color = true;
1315 /* If the standard output is a controlling terminal, watch out
1316 for signals, so that the colors can be restored to the
1317 default state if "ls" is suspended or interrupted. */
1319 if (0 <= tcgetpgrp (STDOUT_FILENO))
1321 int j;
1322 #if SA_NOCLDSTOP
1323 struct sigaction act;
1325 sigemptyset (&caught_signals);
1326 for (j = 0; j < nsigs; j++)
1328 sigaction (sig[j], NULL, &act);
1329 if (act.sa_handler != SIG_IGN)
1330 sigaddset (&caught_signals, sig[j]);
1333 act.sa_mask = caught_signals;
1334 act.sa_flags = SA_RESTART;
1336 for (j = 0; j < nsigs; j++)
1337 if (sigismember (&caught_signals, sig[j]))
1339 act.sa_handler = sig[j] == SIGTSTP ? stophandler : sighandler;
1340 sigaction (sig[j], &act, NULL);
1342 #else
1343 for (j = 0; j < nsigs; j++)
1345 caught_sig[j] = (signal (sig[j], SIG_IGN) != SIG_IGN);
1346 if (caught_sig[j])
1348 signal (sig[j], sig[j] == SIGTSTP ? stophandler : sighandler);
1349 siginterrupt (sig[j], 0);
1352 #endif
1356 if (dereference == DEREF_UNDEFINED)
1357 dereference = ((immediate_dirs
1358 || indicator_style == classify
1359 || format == long_format)
1360 ? DEREF_NEVER
1361 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR);
1363 /* When using -R, initialize a data structure we'll use to
1364 detect any directory cycles. */
1365 if (recursive)
1367 active_dir_set = hash_initialize (INITIAL_TABLE_SIZE, NULL,
1368 dev_ino_hash,
1369 dev_ino_compare,
1370 dev_ino_free);
1371 if (active_dir_set == NULL)
1372 xalloc_die ();
1374 obstack_init (&dev_ino_obstack);
1377 format_needs_stat = sort_type == sort_time || sort_type == sort_size
1378 || format == long_format
1379 || print_scontext
1380 || print_block_size;
1381 format_needs_type = (! format_needs_stat
1382 && (recursive
1383 || print_with_color
1384 || indicator_style != none
1385 || directories_first));
1387 if (dired)
1389 obstack_init (&dired_obstack);
1390 obstack_init (&subdired_obstack);
1393 cwd_n_alloc = 100;
1394 cwd_file = xnmalloc (cwd_n_alloc, sizeof *cwd_file);
1395 cwd_n_used = 0;
1397 clear_files ();
1399 n_files = argc - i;
1401 if (n_files <= 0)
1403 if (immediate_dirs)
1404 gobble_file (".", directory, NOT_AN_INODE_NUMBER, true, "");
1405 else
1406 queue_directory (".", NULL, true);
1408 else
1410 gobble_file (argv[i++], unknown, NOT_AN_INODE_NUMBER, true, "");
1411 while (i < argc);
1413 if (cwd_n_used)
1415 sort_files ();
1416 if (!immediate_dirs)
1417 extract_dirs_from_files (NULL, true);
1418 /* 'cwd_n_used' might be zero now. */
1421 /* In the following if/else blocks, it is sufficient to test 'pending_dirs'
1422 (and not pending_dirs->name) because there may be no markers in the queue
1423 at this point. A marker may be enqueued when extract_dirs_from_files is
1424 called with a non-empty string or via print_dir. */
1425 if (cwd_n_used)
1427 print_current_files ();
1428 if (pending_dirs)
1429 DIRED_PUTCHAR ('\n');
1431 else if (n_files <= 1 && pending_dirs && pending_dirs->next == 0)
1432 print_dir_name = false;
1434 while (pending_dirs)
1436 thispend = pending_dirs;
1437 pending_dirs = pending_dirs->next;
1439 if (LOOP_DETECT)
1441 if (thispend->name == NULL)
1443 /* thispend->name == NULL means this is a marker entry
1444 indicating we've finished processing the directory.
1445 Use its dev/ino numbers to remove the corresponding
1446 entry from the active_dir_set hash table. */
1447 struct dev_ino di = dev_ino_pop ();
1448 struct dev_ino *found = hash_delete (active_dir_set, &di);
1449 /* ASSERT_MATCHING_DEV_INO (thispend->realname, di); */
1450 assert (found);
1451 dev_ino_free (found);
1452 free_pending_ent (thispend);
1453 continue;
1457 print_dir (thispend->name, thispend->realname,
1458 thispend->command_line_arg);
1460 free_pending_ent (thispend);
1461 print_dir_name = true;
1464 if (print_with_color)
1466 int j;
1468 if (used_color)
1470 /* Skip the restore when it would be a no-op, i.e.,
1471 when left is "\033[" and right is "m". */
1472 if (!(color_indicator[C_LEFT].len == 2
1473 && memcmp (color_indicator[C_LEFT].string, "\033[", 2) == 0
1474 && color_indicator[C_RIGHT].len == 1
1475 && color_indicator[C_RIGHT].string[0] == 'm'))
1476 restore_default_color ();
1478 fflush (stdout);
1480 /* Restore the default signal handling. */
1481 #if SA_NOCLDSTOP
1482 for (j = 0; j < nsigs; j++)
1483 if (sigismember (&caught_signals, sig[j]))
1484 signal (sig[j], SIG_DFL);
1485 #else
1486 for (j = 0; j < nsigs; j++)
1487 if (caught_sig[j])
1488 signal (sig[j], SIG_DFL);
1489 #endif
1491 /* Act on any signals that arrived before the default was restored.
1492 This can process signals out of order, but there doesn't seem to
1493 be an easy way to do them in order, and the order isn't that
1494 important anyway. */
1495 for (j = stop_signal_count; j; j--)
1496 raise (SIGSTOP);
1497 j = interrupt_signal;
1498 if (j)
1499 raise (j);
1502 if (dired)
1504 /* No need to free these since we're about to exit. */
1505 dired_dump_obstack ("//DIRED//", &dired_obstack);
1506 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack);
1507 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1508 quoting_style_args[get_quoting_style (filename_quoting_options)]);
1511 if (LOOP_DETECT)
1513 assert (hash_get_n_entries (active_dir_set) == 0);
1514 hash_free (active_dir_set);
1517 return exit_status;
1520 /* Set all the option flags according to the switches specified.
1521 Return the index of the first non-option argument. */
1523 static int
1524 decode_switches (int argc, char **argv)
1526 char *time_style_option = NULL;
1528 bool sort_type_specified = false;
1529 bool kibibytes_specified = false;
1531 qmark_funny_chars = false;
1533 /* initialize all switches to default settings */
1535 switch (ls_mode)
1537 case LS_MULTI_COL:
1538 /* This is for the 'dir' program. */
1539 format = many_per_line;
1540 set_quoting_style (NULL, escape_quoting_style);
1541 break;
1543 case LS_LONG_FORMAT:
1544 /* This is for the 'vdir' program. */
1545 format = long_format;
1546 set_quoting_style (NULL, escape_quoting_style);
1547 break;
1549 case LS_LS:
1550 /* This is for the 'ls' program. */
1551 if (isatty (STDOUT_FILENO))
1553 format = many_per_line;
1554 /* See description of qmark_funny_chars, above. */
1555 qmark_funny_chars = true;
1557 else
1559 format = one_per_line;
1560 qmark_funny_chars = false;
1562 break;
1564 default:
1565 abort ();
1568 time_type = time_mtime;
1569 sort_type = sort_name;
1570 sort_reverse = false;
1571 numeric_ids = false;
1572 print_block_size = false;
1573 indicator_style = none;
1574 print_inode = false;
1575 dereference = DEREF_UNDEFINED;
1576 recursive = false;
1577 immediate_dirs = false;
1578 ignore_mode = IGNORE_DEFAULT;
1579 ignore_patterns = NULL;
1580 hide_patterns = NULL;
1581 print_scontext = false;
1583 getenv_quoting_style ();
1585 line_length = 80;
1587 char const *p = getenv ("COLUMNS");
1588 if (p && *p)
1590 unsigned long int tmp_ulong;
1591 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1592 && 0 < tmp_ulong && tmp_ulong <= SIZE_MAX)
1594 line_length = tmp_ulong;
1596 else
1598 error (0, 0,
1599 _("ignoring invalid width in environment variable COLUMNS: %s"),
1600 quotearg (p));
1605 #ifdef TIOCGWINSZ
1607 struct winsize ws;
1609 if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &ws) != -1
1610 && 0 < ws.ws_col && ws.ws_col == (size_t) ws.ws_col)
1611 line_length = ws.ws_col;
1613 #endif
1616 char const *p = getenv ("TABSIZE");
1617 tabsize = 8;
1618 if (p)
1620 unsigned long int tmp_ulong;
1621 if (xstrtoul (p, NULL, 0, &tmp_ulong, NULL) == LONGINT_OK
1622 && tmp_ulong <= SIZE_MAX)
1624 tabsize = tmp_ulong;
1626 else
1628 error (0, 0,
1629 _("ignoring invalid tab size in environment variable TABSIZE: %s"),
1630 quotearg (p));
1635 while (true)
1637 int oi = -1;
1638 int c = getopt_long (argc, argv,
1639 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1640 long_options, &oi);
1641 if (c == -1)
1642 break;
1644 switch (c)
1646 case 'a':
1647 ignore_mode = IGNORE_MINIMAL;
1648 break;
1650 case 'b':
1651 set_quoting_style (NULL, escape_quoting_style);
1652 break;
1654 case 'c':
1655 time_type = time_ctime;
1656 break;
1658 case 'd':
1659 immediate_dirs = true;
1660 break;
1662 case 'f':
1663 /* Same as enabling -a -U and disabling -l -s. */
1664 ignore_mode = IGNORE_MINIMAL;
1665 sort_type = sort_none;
1666 sort_type_specified = true;
1667 /* disable -l */
1668 if (format == long_format)
1669 format = (isatty (STDOUT_FILENO) ? many_per_line : one_per_line);
1670 print_block_size = false; /* disable -s */
1671 print_with_color = false; /* disable --color */
1672 break;
1674 case FILE_TYPE_INDICATOR_OPTION: /* --file-type */
1675 indicator_style = file_type;
1676 break;
1678 case 'g':
1679 format = long_format;
1680 print_owner = false;
1681 break;
1683 case 'h':
1684 file_human_output_opts = human_output_opts =
1685 human_autoscale | human_SI | human_base_1024;
1686 file_output_block_size = output_block_size = 1;
1687 break;
1689 case 'i':
1690 print_inode = true;
1691 break;
1693 case 'k':
1694 kibibytes_specified = true;
1695 break;
1697 case 'l':
1698 format = long_format;
1699 break;
1701 case 'm':
1702 format = with_commas;
1703 break;
1705 case 'n':
1706 numeric_ids = true;
1707 format = long_format;
1708 break;
1710 case 'o': /* Just like -l, but don't display group info. */
1711 format = long_format;
1712 print_group = false;
1713 break;
1715 case 'p':
1716 indicator_style = slash;
1717 break;
1719 case 'q':
1720 qmark_funny_chars = true;
1721 break;
1723 case 'r':
1724 sort_reverse = true;
1725 break;
1727 case 's':
1728 print_block_size = true;
1729 break;
1731 case 't':
1732 sort_type = sort_time;
1733 sort_type_specified = true;
1734 break;
1736 case 'u':
1737 time_type = time_atime;
1738 break;
1740 case 'v':
1741 sort_type = sort_version;
1742 sort_type_specified = true;
1743 break;
1745 case 'w':
1746 line_length = xnumtoumax (optarg, 0, 1, SIZE_MAX, "",
1747 _("invalid line width"), LS_FAILURE);
1748 break;
1750 case 'x':
1751 format = horizontal;
1752 break;
1754 case 'A':
1755 if (ignore_mode == IGNORE_DEFAULT)
1756 ignore_mode = IGNORE_DOT_AND_DOTDOT;
1757 break;
1759 case 'B':
1760 add_ignore_pattern ("*~");
1761 add_ignore_pattern (".*~");
1762 break;
1764 case 'C':
1765 format = many_per_line;
1766 break;
1768 case 'D':
1769 dired = true;
1770 break;
1772 case 'F':
1773 indicator_style = classify;
1774 break;
1776 case 'G': /* inhibit display of group info */
1777 print_group = false;
1778 break;
1780 case 'H':
1781 dereference = DEREF_COMMAND_LINE_ARGUMENTS;
1782 break;
1784 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION:
1785 dereference = DEREF_COMMAND_LINE_SYMLINK_TO_DIR;
1786 break;
1788 case 'I':
1789 add_ignore_pattern (optarg);
1790 break;
1792 case 'L':
1793 dereference = DEREF_ALWAYS;
1794 break;
1796 case 'N':
1797 set_quoting_style (NULL, literal_quoting_style);
1798 break;
1800 case 'Q':
1801 set_quoting_style (NULL, c_quoting_style);
1802 break;
1804 case 'R':
1805 recursive = true;
1806 break;
1808 case 'S':
1809 sort_type = sort_size;
1810 sort_type_specified = true;
1811 break;
1813 case 'T':
1814 tabsize = xnumtoumax (optarg, 0, 0, SIZE_MAX, "",
1815 _("invalid tab size"), LS_FAILURE);
1816 break;
1818 case 'U':
1819 sort_type = sort_none;
1820 sort_type_specified = true;
1821 break;
1823 case 'X':
1824 sort_type = sort_extension;
1825 sort_type_specified = true;
1826 break;
1828 case '1':
1829 /* -1 has no effect after -l. */
1830 if (format != long_format)
1831 format = one_per_line;
1832 break;
1834 case AUTHOR_OPTION:
1835 print_author = true;
1836 break;
1838 case HIDE_OPTION:
1840 struct ignore_pattern *hide = xmalloc (sizeof *hide);
1841 hide->pattern = optarg;
1842 hide->next = hide_patterns;
1843 hide_patterns = hide;
1845 break;
1847 case SORT_OPTION:
1848 sort_type = XARGMATCH ("--sort", optarg, sort_args, sort_types);
1849 sort_type_specified = true;
1850 break;
1852 case GROUP_DIRECTORIES_FIRST_OPTION:
1853 directories_first = true;
1854 break;
1856 case TIME_OPTION:
1857 time_type = XARGMATCH ("--time", optarg, time_args, time_types);
1858 break;
1860 case FORMAT_OPTION:
1861 format = XARGMATCH ("--format", optarg, format_args, format_types);
1862 break;
1864 case FULL_TIME_OPTION:
1865 format = long_format;
1866 time_style_option = bad_cast ("full-iso");
1867 break;
1869 case COLOR_OPTION:
1871 int i;
1872 if (optarg)
1873 i = XARGMATCH ("--color", optarg, color_args, color_types);
1874 else
1875 /* Using --color with no argument is equivalent to using
1876 --color=always. */
1877 i = color_always;
1879 print_with_color = (i == color_always
1880 || (i == color_if_tty
1881 && isatty (STDOUT_FILENO)));
1883 if (print_with_color)
1885 /* Don't use TAB characters in output. Some terminal
1886 emulators can't handle the combination of tabs and
1887 color codes on the same line. */
1888 tabsize = 0;
1890 break;
1893 case INDICATOR_STYLE_OPTION:
1894 indicator_style = XARGMATCH ("--indicator-style", optarg,
1895 indicator_style_args,
1896 indicator_style_types);
1897 break;
1899 case QUOTING_STYLE_OPTION:
1900 set_quoting_style (NULL,
1901 XARGMATCH ("--quoting-style", optarg,
1902 quoting_style_args,
1903 quoting_style_vals));
1904 break;
1906 case TIME_STYLE_OPTION:
1907 time_style_option = optarg;
1908 break;
1910 case SHOW_CONTROL_CHARS_OPTION:
1911 qmark_funny_chars = false;
1912 break;
1914 case BLOCK_SIZE_OPTION:
1916 enum strtol_error e = human_options (optarg, &human_output_opts,
1917 &output_block_size);
1918 if (e != LONGINT_OK)
1919 xstrtol_fatal (e, oi, 0, long_options, optarg);
1920 file_human_output_opts = human_output_opts;
1921 file_output_block_size = output_block_size;
1923 break;
1925 case SI_OPTION:
1926 file_human_output_opts = human_output_opts =
1927 human_autoscale | human_SI;
1928 file_output_block_size = output_block_size = 1;
1929 break;
1931 case 'Z':
1932 print_scontext = true;
1933 break;
1935 case_GETOPT_HELP_CHAR;
1937 case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
1939 default:
1940 usage (LS_FAILURE);
1944 if (! output_block_size)
1946 char const *ls_block_size = getenv ("LS_BLOCK_SIZE");
1947 human_options (ls_block_size,
1948 &human_output_opts, &output_block_size);
1949 if (ls_block_size || getenv ("BLOCK_SIZE"))
1951 file_human_output_opts = human_output_opts;
1952 file_output_block_size = output_block_size;
1954 if (kibibytes_specified)
1956 human_output_opts = 0;
1957 output_block_size = 1024;
1961 max_idx = MAX (1, line_length / MIN_COLUMN_WIDTH);
1963 filename_quoting_options = clone_quoting_options (NULL);
1964 if (get_quoting_style (filename_quoting_options) == escape_quoting_style)
1965 set_char_quoting (filename_quoting_options, ' ', 1);
1966 if (file_type <= indicator_style)
1968 char const *p;
1969 for (p = &"*=>@|"[indicator_style - file_type]; *p; p++)
1970 set_char_quoting (filename_quoting_options, *p, 1);
1973 dirname_quoting_options = clone_quoting_options (NULL);
1974 set_char_quoting (dirname_quoting_options, ':', 1);
1976 /* --dired is meaningful only with --format=long (-l).
1977 Otherwise, ignore it. FIXME: warn about this?
1978 Alternatively, make --dired imply --format=long? */
1979 if (dired && format != long_format)
1980 dired = false;
1982 /* If -c or -u is specified and not -l (or any other option that implies -l),
1983 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
1984 The behavior of ls when using either -c or -u but with neither -l nor -t
1985 appears to be unspecified by POSIX. So, with GNU ls, '-u' alone means
1986 sort by atime (this is the one that's not specified by the POSIX spec),
1987 -lu means show atime and sort by name, -lut means show atime and sort
1988 by atime. */
1990 if ((time_type == time_ctime || time_type == time_atime)
1991 && !sort_type_specified && format != long_format)
1993 sort_type = sort_time;
1996 if (format == long_format)
1998 char *style = time_style_option;
1999 static char const posix_prefix[] = "posix-";
2001 if (! style)
2002 if (! (style = getenv ("TIME_STYLE")))
2003 style = bad_cast ("locale");
2005 while (STREQ_LEN (style, posix_prefix, sizeof posix_prefix - 1))
2007 if (! hard_locale (LC_TIME))
2008 return optind;
2009 style += sizeof posix_prefix - 1;
2012 if (*style == '+')
2014 char *p0 = style + 1;
2015 char *p1 = strchr (p0, '\n');
2016 if (! p1)
2017 p1 = p0;
2018 else
2020 if (strchr (p1 + 1, '\n'))
2021 error (LS_FAILURE, 0, _("invalid time style format %s"),
2022 quote (p0));
2023 *p1++ = '\0';
2025 long_time_format[0] = p0;
2026 long_time_format[1] = p1;
2028 else
2030 ptrdiff_t res = argmatch (style, time_style_args,
2031 (char const *) time_style_types,
2032 sizeof (*time_style_types));
2033 if (res < 0)
2035 /* This whole block used to be a simple use of XARGMATCH.
2036 but that didn't print the "posix-"-prefixed variants or
2037 the "+"-prefixed format string option upon failure. */
2038 argmatch_invalid ("time style", style, res);
2040 /* The following is a manual expansion of argmatch_valid,
2041 but with the added "+ ..." description and the [posix-]
2042 prefixes prepended. Note that this simplification works
2043 only because all four existing time_style_types values
2044 are distinct. */
2045 fputs (_("Valid arguments are:\n"), stderr);
2046 char const *const *p = time_style_args;
2047 while (*p)
2048 fprintf (stderr, " - [posix-]%s\n", *p++);
2049 fputs (_(" - +FORMAT (e.g., +%H:%M) for a 'date'-style"
2050 " format\n"), stderr);
2051 usage (LS_FAILURE);
2053 switch (res)
2055 case full_iso_time_style:
2056 long_time_format[0] = long_time_format[1] =
2057 "%Y-%m-%d %H:%M:%S.%N %z";
2058 break;
2060 case long_iso_time_style:
2061 long_time_format[0] = long_time_format[1] = "%Y-%m-%d %H:%M";
2062 break;
2064 case iso_time_style:
2065 long_time_format[0] = "%Y-%m-%d ";
2066 long_time_format[1] = "%m-%d %H:%M";
2067 break;
2069 case locale_time_style:
2070 if (hard_locale (LC_TIME))
2072 int i;
2073 for (i = 0; i < 2; i++)
2074 long_time_format[i] =
2075 dcgettext (NULL, long_time_format[i], LC_TIME);
2080 /* Note we leave %5b etc. alone so user widths/flags are honored. */
2081 if (strstr (long_time_format[0], "%b")
2082 || strstr (long_time_format[1], "%b"))
2083 if (!abmon_init ())
2084 error (0, 0, _("error initializing month strings"));
2087 return optind;
2090 /* Parse a string as part of the LS_COLORS variable; this may involve
2091 decoding all kinds of escape characters. If equals_end is set an
2092 unescaped equal sign ends the string, otherwise only a : or \0
2093 does. Set *OUTPUT_COUNT to the number of bytes output. Return
2094 true if successful.
2096 The resulting string is *not* null-terminated, but may contain
2097 embedded nulls.
2099 Note that both dest and src are char **; on return they point to
2100 the first free byte after the array and the character that ended
2101 the input string, respectively. */
2103 static bool
2104 get_funky_string (char **dest, const char **src, bool equals_end,
2105 size_t *output_count)
2107 char num; /* For numerical codes */
2108 size_t count; /* Something to count with */
2109 enum {
2110 ST_GND, ST_BACKSLASH, ST_OCTAL, ST_HEX, ST_CARET, ST_END, ST_ERROR
2111 } state;
2112 const char *p;
2113 char *q;
2115 p = *src; /* We don't want to double-indirect */
2116 q = *dest; /* the whole darn time. */
2118 count = 0; /* No characters counted in yet. */
2119 num = 0;
2121 state = ST_GND; /* Start in ground state. */
2122 while (state < ST_END)
2124 switch (state)
2126 case ST_GND: /* Ground state (no escapes) */
2127 switch (*p)
2129 case ':':
2130 case '\0':
2131 state = ST_END; /* End of string */
2132 break;
2133 case '\\':
2134 state = ST_BACKSLASH; /* Backslash scape sequence */
2135 ++p;
2136 break;
2137 case '^':
2138 state = ST_CARET; /* Caret escape */
2139 ++p;
2140 break;
2141 case '=':
2142 if (equals_end)
2144 state = ST_END; /* End */
2145 break;
2147 /* else fall through */
2148 default:
2149 *(q++) = *(p++);
2150 ++count;
2151 break;
2153 break;
2155 case ST_BACKSLASH: /* Backslash escaped character */
2156 switch (*p)
2158 case '0':
2159 case '1':
2160 case '2':
2161 case '3':
2162 case '4':
2163 case '5':
2164 case '6':
2165 case '7':
2166 state = ST_OCTAL; /* Octal sequence */
2167 num = *p - '0';
2168 break;
2169 case 'x':
2170 case 'X':
2171 state = ST_HEX; /* Hex sequence */
2172 num = 0;
2173 break;
2174 case 'a': /* Bell */
2175 num = '\a';
2176 break;
2177 case 'b': /* Backspace */
2178 num = '\b';
2179 break;
2180 case 'e': /* Escape */
2181 num = 27;
2182 break;
2183 case 'f': /* Form feed */
2184 num = '\f';
2185 break;
2186 case 'n': /* Newline */
2187 num = '\n';
2188 break;
2189 case 'r': /* Carriage return */
2190 num = '\r';
2191 break;
2192 case 't': /* Tab */
2193 num = '\t';
2194 break;
2195 case 'v': /* Vtab */
2196 num = '\v';
2197 break;
2198 case '?': /* Delete */
2199 num = 127;
2200 break;
2201 case '_': /* Space */
2202 num = ' ';
2203 break;
2204 case '\0': /* End of string */
2205 state = ST_ERROR; /* Error! */
2206 break;
2207 default: /* Escaped character like \ ^ : = */
2208 num = *p;
2209 break;
2211 if (state == ST_BACKSLASH)
2213 *(q++) = num;
2214 ++count;
2215 state = ST_GND;
2217 ++p;
2218 break;
2220 case ST_OCTAL: /* Octal sequence */
2221 if (*p < '0' || *p > '7')
2223 *(q++) = num;
2224 ++count;
2225 state = ST_GND;
2227 else
2228 num = (num << 3) + (*(p++) - '0');
2229 break;
2231 case ST_HEX: /* Hex sequence */
2232 switch (*p)
2234 case '0':
2235 case '1':
2236 case '2':
2237 case '3':
2238 case '4':
2239 case '5':
2240 case '6':
2241 case '7':
2242 case '8':
2243 case '9':
2244 num = (num << 4) + (*(p++) - '0');
2245 break;
2246 case 'a':
2247 case 'b':
2248 case 'c':
2249 case 'd':
2250 case 'e':
2251 case 'f':
2252 num = (num << 4) + (*(p++) - 'a') + 10;
2253 break;
2254 case 'A':
2255 case 'B':
2256 case 'C':
2257 case 'D':
2258 case 'E':
2259 case 'F':
2260 num = (num << 4) + (*(p++) - 'A') + 10;
2261 break;
2262 default:
2263 *(q++) = num;
2264 ++count;
2265 state = ST_GND;
2266 break;
2268 break;
2270 case ST_CARET: /* Caret escape */
2271 state = ST_GND; /* Should be the next state... */
2272 if (*p >= '@' && *p <= '~')
2274 *(q++) = *(p++) & 037;
2275 ++count;
2277 else if (*p == '?')
2279 *(q++) = 127;
2280 ++count;
2282 else
2283 state = ST_ERROR;
2284 break;
2286 default:
2287 abort ();
2291 *dest = q;
2292 *src = p;
2293 *output_count = count;
2295 return state != ST_ERROR;
2298 enum parse_state
2300 PS_START = 1,
2301 PS_2,
2302 PS_3,
2303 PS_4,
2304 PS_DONE,
2305 PS_FAIL
2309 /* Check if the content of TERM is a valid name in dircolors. */
2311 static bool
2312 known_term_type (void)
2314 char const *term = getenv ("TERM");
2315 if (! term || ! *term)
2316 return false;
2318 char const *line = G_line;
2319 while (line - G_line < sizeof (G_line))
2321 if (STRNCMP_LIT (line, "TERM ") == 0)
2323 if (STREQ (term, line + 5))
2324 return true;
2326 line += strlen (line) + 1;
2329 return false;
2332 static void
2333 parse_ls_color (void)
2335 const char *p; /* Pointer to character being parsed */
2336 char *buf; /* color_buf buffer pointer */
2337 int ind_no; /* Indicator number */
2338 char label[3]; /* Indicator label */
2339 struct color_ext_type *ext; /* Extension we are working on */
2341 if ((p = getenv ("LS_COLORS")) == NULL || *p == '\0')
2343 /* LS_COLORS takes precedence, but if that's not set then
2344 honor the COLORTERM and TERM env variables so that
2345 we only go with the internal ANSI color codes if the
2346 former is non empty or the latter is set to a known value. */
2347 char const *colorterm = getenv ("COLORTERM");
2348 if (! (colorterm && *colorterm) && ! known_term_type ())
2349 print_with_color = false;
2350 return;
2353 ext = NULL;
2354 strcpy (label, "??");
2356 /* This is an overly conservative estimate, but any possible
2357 LS_COLORS string will *not* generate a color_buf longer than
2358 itself, so it is a safe way of allocating a buffer in
2359 advance. */
2360 buf = color_buf = xstrdup (p);
2362 enum parse_state state = PS_START;
2363 while (true)
2365 switch (state)
2367 case PS_START: /* First label character */
2368 switch (*p)
2370 case ':':
2371 ++p;
2372 break;
2374 case '*':
2375 /* Allocate new extension block and add to head of
2376 linked list (this way a later definition will
2377 override an earlier one, which can be useful for
2378 having terminal-specific defs override global). */
2380 ext = xmalloc (sizeof *ext);
2381 ext->next = color_ext_list;
2382 color_ext_list = ext;
2384 ++p;
2385 ext->ext.string = buf;
2387 state = (get_funky_string (&buf, &p, true, &ext->ext.len)
2388 ? PS_4 : PS_FAIL);
2389 break;
2391 case '\0':
2392 state = PS_DONE; /* Done! */
2393 goto done;
2395 default: /* Assume it is file type label */
2396 label[0] = *(p++);
2397 state = PS_2;
2398 break;
2400 break;
2402 case PS_2: /* Second label character */
2403 if (*p)
2405 label[1] = *(p++);
2406 state = PS_3;
2408 else
2409 state = PS_FAIL; /* Error */
2410 break;
2412 case PS_3: /* Equal sign after indicator label */
2413 state = PS_FAIL; /* Assume failure... */
2414 if (*(p++) == '=')/* It *should* be... */
2416 for (ind_no = 0; indicator_name[ind_no] != NULL; ++ind_no)
2418 if (STREQ (label, indicator_name[ind_no]))
2420 color_indicator[ind_no].string = buf;
2421 state = (get_funky_string (&buf, &p, false,
2422 &color_indicator[ind_no].len)
2423 ? PS_START : PS_FAIL);
2424 break;
2427 if (state == PS_FAIL)
2428 error (0, 0, _("unrecognized prefix: %s"), quotearg (label));
2430 break;
2432 case PS_4: /* Equal sign after *.ext */
2433 if (*(p++) == '=')
2435 ext->seq.string = buf;
2436 state = (get_funky_string (&buf, &p, false, &ext->seq.len)
2437 ? PS_START : PS_FAIL);
2439 else
2440 state = PS_FAIL;
2441 break;
2443 case PS_FAIL:
2444 goto done;
2446 default:
2447 abort ();
2450 done:
2452 if (state == PS_FAIL)
2454 struct color_ext_type *e;
2455 struct color_ext_type *e2;
2457 error (0, 0,
2458 _("unparsable value for LS_COLORS environment variable"));
2459 free (color_buf);
2460 for (e = color_ext_list; e != NULL; /* empty */)
2462 e2 = e;
2463 e = e->next;
2464 free (e2);
2466 print_with_color = false;
2469 if (color_indicator[C_LINK].len == 6
2470 && !STRNCMP_LIT (color_indicator[C_LINK].string, "target"))
2471 color_symlink_as_referent = true;
2474 /* Set the quoting style default if the environment variable
2475 QUOTING_STYLE is set. */
2477 static void
2478 getenv_quoting_style (void)
2480 char const *q_style = getenv ("QUOTING_STYLE");
2481 if (q_style)
2483 int i = ARGMATCH (q_style, quoting_style_args, quoting_style_vals);
2484 if (0 <= i)
2485 set_quoting_style (NULL, quoting_style_vals[i]);
2486 else
2487 error (0, 0,
2488 _("ignoring invalid value of environment variable QUOTING_STYLE: %s"),
2489 quotearg (q_style));
2493 /* Set the exit status to report a failure. If SERIOUS, it is a
2494 serious failure; otherwise, it is merely a minor problem. */
2496 static void
2497 set_exit_status (bool serious)
2499 if (serious)
2500 exit_status = LS_FAILURE;
2501 else if (exit_status == EXIT_SUCCESS)
2502 exit_status = LS_MINOR_PROBLEM;
2505 /* Assuming a failure is serious if SERIOUS, use the printf-style
2506 MESSAGE to report the failure to access a file named FILE. Assume
2507 errno is set appropriately for the failure. */
2509 static void
2510 file_failure (bool serious, char const *message, char const *file)
2512 error (0, errno, message, quotearg_colon (file));
2513 set_exit_status (serious);
2516 /* Request that the directory named NAME have its contents listed later.
2517 If REALNAME is nonzero, it will be used instead of NAME when the
2518 directory name is printed. This allows symbolic links to directories
2519 to be treated as regular directories but still be listed under their
2520 real names. NAME == NULL is used to insert a marker entry for the
2521 directory named in REALNAME.
2522 If NAME is non-NULL, we use its dev/ino information to save
2523 a call to stat -- when doing a recursive (-R) traversal.
2524 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2526 static void
2527 queue_directory (char const *name, char const *realname, bool command_line_arg)
2529 struct pending *new = xmalloc (sizeof *new);
2530 new->realname = realname ? xstrdup (realname) : NULL;
2531 new->name = name ? xstrdup (name) : NULL;
2532 new->command_line_arg = command_line_arg;
2533 new->next = pending_dirs;
2534 pending_dirs = new;
2537 /* Read directory NAME, and list the files in it.
2538 If REALNAME is nonzero, print its name instead of NAME;
2539 this is used for symbolic links to directories.
2540 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2542 static void
2543 print_dir (char const *name, char const *realname, bool command_line_arg)
2545 DIR *dirp;
2546 struct dirent *next;
2547 uintmax_t total_blocks = 0;
2548 static bool first = true;
2550 errno = 0;
2551 dirp = opendir (name);
2552 if (!dirp)
2554 file_failure (command_line_arg, _("cannot open directory %s"), name);
2555 return;
2558 if (LOOP_DETECT)
2560 struct stat dir_stat;
2561 int fd = dirfd (dirp);
2563 /* If dirfd failed, endure the overhead of using stat. */
2564 if ((0 <= fd
2565 ? fstat (fd, &dir_stat)
2566 : stat (name, &dir_stat)) < 0)
2568 file_failure (command_line_arg,
2569 _("cannot determine device and inode of %s"), name);
2570 closedir (dirp);
2571 return;
2574 /* If we've already visited this dev/inode pair, warn that
2575 we've found a loop, and do not process this directory. */
2576 if (visit_dir (dir_stat.st_dev, dir_stat.st_ino))
2578 error (0, 0, _("%s: not listing already-listed directory"),
2579 quotearg_colon (name));
2580 closedir (dirp);
2581 set_exit_status (true);
2582 return;
2585 dev_ino_push (dir_stat.st_dev, dir_stat.st_ino);
2588 if (recursive || print_dir_name)
2590 if (!first)
2591 DIRED_PUTCHAR ('\n');
2592 first = false;
2593 DIRED_INDENT ();
2594 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2595 dired_pos += quote_name (stdout, realname ? realname : name,
2596 dirname_quoting_options, NULL);
2597 PUSH_CURRENT_DIRED_POS (&subdired_obstack);
2598 DIRED_FPUTS_LITERAL (":\n", stdout);
2601 /* Read the directory entries, and insert the subfiles into the 'cwd_file'
2602 table. */
2604 clear_files ();
2606 while (1)
2608 /* Set errno to zero so we can distinguish between a readdir failure
2609 and when readdir simply finds that there are no more entries. */
2610 errno = 0;
2611 next = readdir (dirp);
2612 if (next)
2614 if (! file_ignored (next->d_name))
2616 enum filetype type = unknown;
2618 #if HAVE_STRUCT_DIRENT_D_TYPE
2619 switch (next->d_type)
2621 case DT_BLK: type = blockdev; break;
2622 case DT_CHR: type = chardev; break;
2623 case DT_DIR: type = directory; break;
2624 case DT_FIFO: type = fifo; break;
2625 case DT_LNK: type = symbolic_link; break;
2626 case DT_REG: type = normal; break;
2627 case DT_SOCK: type = sock; break;
2628 # ifdef DT_WHT
2629 case DT_WHT: type = whiteout; break;
2630 # endif
2632 #endif
2633 total_blocks += gobble_file (next->d_name, type,
2634 RELIABLE_D_INO (next),
2635 false, name);
2637 /* In this narrow case, print out each name right away, so
2638 ls uses constant memory while processing the entries of
2639 this directory. Useful when there are many (millions)
2640 of entries in a directory. */
2641 if (format == one_per_line && sort_type == sort_none
2642 && !print_block_size && !recursive)
2644 /* We must call sort_files in spite of
2645 "sort_type == sort_none" for its initialization
2646 of the sorted_file vector. */
2647 sort_files ();
2648 print_current_files ();
2649 clear_files ();
2653 else if (errno != 0)
2655 file_failure (command_line_arg, _("reading directory %s"), name);
2656 if (errno != EOVERFLOW)
2657 break;
2659 else
2660 break;
2662 /* When processing a very large directory, and since we've inhibited
2663 interrupts, this loop would take so long that ls would be annoyingly
2664 uninterruptible. This ensures that it handles signals promptly. */
2665 process_signals ();
2668 if (closedir (dirp) != 0)
2670 file_failure (command_line_arg, _("closing directory %s"), name);
2671 /* Don't return; print whatever we got. */
2674 /* Sort the directory contents. */
2675 sort_files ();
2677 /* If any member files are subdirectories, perhaps they should have their
2678 contents listed rather than being mentioned here as files. */
2680 if (recursive)
2681 extract_dirs_from_files (name, false);
2683 if (format == long_format || print_block_size)
2685 const char *p;
2686 char buf[LONGEST_HUMAN_READABLE + 1];
2688 DIRED_INDENT ();
2689 p = _("total");
2690 DIRED_FPUTS (p, stdout, strlen (p));
2691 DIRED_PUTCHAR (' ');
2692 p = human_readable (total_blocks, buf, human_output_opts,
2693 ST_NBLOCKSIZE, output_block_size);
2694 DIRED_FPUTS (p, stdout, strlen (p));
2695 DIRED_PUTCHAR ('\n');
2698 if (cwd_n_used)
2699 print_current_files ();
2702 /* Add 'pattern' to the list of patterns for which files that match are
2703 not listed. */
2705 static void
2706 add_ignore_pattern (const char *pattern)
2708 struct ignore_pattern *ignore;
2710 ignore = xmalloc (sizeof *ignore);
2711 ignore->pattern = pattern;
2712 /* Add it to the head of the linked list. */
2713 ignore->next = ignore_patterns;
2714 ignore_patterns = ignore;
2717 /* Return true if one of the PATTERNS matches FILE. */
2719 static bool
2720 patterns_match (struct ignore_pattern const *patterns, char const *file)
2722 struct ignore_pattern const *p;
2723 for (p = patterns; p; p = p->next)
2724 if (fnmatch (p->pattern, file, FNM_PERIOD) == 0)
2725 return true;
2726 return false;
2729 /* Return true if FILE should be ignored. */
2731 static bool
2732 file_ignored (char const *name)
2734 return ((ignore_mode != IGNORE_MINIMAL
2735 && name[0] == '.'
2736 && (ignore_mode == IGNORE_DEFAULT || ! name[1 + (name[1] == '.')]))
2737 || (ignore_mode == IGNORE_DEFAULT
2738 && patterns_match (hide_patterns, name))
2739 || patterns_match (ignore_patterns, name));
2742 /* POSIX requires that a file size be printed without a sign, even
2743 when negative. Assume the typical case where negative sizes are
2744 actually positive values that have wrapped around. */
2746 static uintmax_t
2747 unsigned_file_size (off_t size)
2749 return size + (size < 0) * ((uintmax_t) OFF_T_MAX - OFF_T_MIN + 1);
2752 #ifdef HAVE_CAP
2753 /* Return true if NAME has a capability (see linux/capability.h) */
2754 static bool
2755 has_capability (char const *name)
2757 char *result;
2758 bool has_cap;
2760 cap_t cap_d = cap_get_file (name);
2761 if (cap_d == NULL)
2762 return false;
2764 result = cap_to_text (cap_d, NULL);
2765 cap_free (cap_d);
2766 if (!result)
2767 return false;
2769 /* check if human-readable capability string is empty */
2770 has_cap = !!*result;
2772 cap_free (result);
2773 return has_cap;
2775 #else
2776 static bool
2777 has_capability (char const *name _GL_UNUSED)
2779 errno = ENOTSUP;
2780 return false;
2782 #endif
2784 /* Enter and remove entries in the table 'cwd_file'. */
2786 static void
2787 free_ent (struct fileinfo *f)
2789 free (f->name);
2790 free (f->linkname);
2791 if (f->scontext != UNKNOWN_SECURITY_CONTEXT)
2793 if (is_smack_enabled ())
2794 free (f->scontext);
2795 else
2796 freecon (f->scontext);
2800 /* Empty the table of files. */
2801 static void
2802 clear_files (void)
2804 size_t i;
2806 for (i = 0; i < cwd_n_used; i++)
2808 struct fileinfo *f = sorted_file[i];
2809 free_ent (f);
2812 cwd_n_used = 0;
2813 any_has_acl = false;
2814 inode_number_width = 0;
2815 block_size_width = 0;
2816 nlink_width = 0;
2817 owner_width = 0;
2818 group_width = 0;
2819 author_width = 0;
2820 scontext_width = 0;
2821 major_device_number_width = 0;
2822 minor_device_number_width = 0;
2823 file_size_width = 0;
2826 /* Return true if ERR implies lack-of-support failure by a
2827 getxattr-calling function like getfilecon or file_has_acl. */
2828 static bool
2829 errno_unsupported (int err)
2831 return (err == EINVAL || err == ENOSYS || is_ENOTSUP (err));
2834 /* Cache *getfilecon failure, when it's trivial to do so.
2835 Like getfilecon/lgetfilecon, but when F's st_dev says it's doesn't
2836 support getting the security context, fail with ENOTSUP immediately. */
2837 static int
2838 getfilecon_cache (char const *file, struct fileinfo *f, bool deref)
2840 /* st_dev of the most recently processed device for which we've
2841 found that [l]getfilecon fails indicating lack of support. */
2842 static dev_t unsupported_device;
2844 if (f->stat.st_dev == unsupported_device)
2846 errno = ENOTSUP;
2847 return -1;
2849 int r = 0;
2850 #ifdef HAVE_SMACK
2851 if (is_smack_enabled ())
2852 r = smack_new_label_from_path (file, "security.SMACK64", deref,
2853 &f->scontext);
2854 else
2855 #endif
2856 r = (deref
2857 ? getfilecon (file, &f->scontext)
2858 : lgetfilecon (file, &f->scontext));
2859 if (r < 0 && errno_unsupported (errno))
2860 unsupported_device = f->stat.st_dev;
2861 return r;
2864 /* Cache file_has_acl failure, when it's trivial to do.
2865 Like file_has_acl, but when F's st_dev says it's on a file
2866 system lacking ACL support, return 0 with ENOTSUP immediately. */
2867 static int
2868 file_has_acl_cache (char const *file, struct fileinfo *f)
2870 /* st_dev of the most recently processed device for which we've
2871 found that file_has_acl fails indicating lack of support. */
2872 static dev_t unsupported_device;
2874 if (f->stat.st_dev == unsupported_device)
2876 errno = ENOTSUP;
2877 return 0;
2880 /* Zero errno so that we can distinguish between two 0-returning cases:
2881 "has-ACL-support, but only a default ACL" and "no ACL support". */
2882 errno = 0;
2883 int n = file_has_acl (file, &f->stat);
2884 if (n <= 0 && errno_unsupported (errno))
2885 unsupported_device = f->stat.st_dev;
2886 return n;
2889 /* Cache has_capability failure, when it's trivial to do.
2890 Like has_capability, but when F's st_dev says it's on a file
2891 system lacking capability support, return 0 with ENOTSUP immediately. */
2892 static bool
2893 has_capability_cache (char const *file, struct fileinfo *f)
2895 /* st_dev of the most recently processed device for which we've
2896 found that has_capability fails indicating lack of support. */
2897 static dev_t unsupported_device;
2899 if (f->stat.st_dev == unsupported_device)
2901 errno = ENOTSUP;
2902 return 0;
2905 bool b = has_capability (file);
2906 if ( !b && errno_unsupported (errno))
2907 unsupported_device = f->stat.st_dev;
2908 return b;
2911 /* Add a file to the current table of files.
2912 Verify that the file exists, and print an error message if it does not.
2913 Return the number of blocks that the file occupies. */
2914 static uintmax_t
2915 gobble_file (char const *name, enum filetype type, ino_t inode,
2916 bool command_line_arg, char const *dirname)
2918 uintmax_t blocks = 0;
2919 struct fileinfo *f;
2921 /* An inode value prior to gobble_file necessarily came from readdir,
2922 which is not used for command line arguments. */
2923 assert (! command_line_arg || inode == NOT_AN_INODE_NUMBER);
2925 if (cwd_n_used == cwd_n_alloc)
2927 cwd_file = xnrealloc (cwd_file, cwd_n_alloc, 2 * sizeof *cwd_file);
2928 cwd_n_alloc *= 2;
2931 f = &cwd_file[cwd_n_used];
2932 memset (f, '\0', sizeof *f);
2933 f->stat.st_ino = inode;
2934 f->filetype = type;
2936 if (command_line_arg
2937 || format_needs_stat
2938 /* When coloring a directory (we may know the type from
2939 direct.d_type), we have to stat it in order to indicate
2940 sticky and/or other-writable attributes. */
2941 || (type == directory && print_with_color
2942 && (is_colored (C_OTHER_WRITABLE)
2943 || is_colored (C_STICKY)
2944 || is_colored (C_STICKY_OTHER_WRITABLE)))
2945 /* When dereferencing symlinks, the inode and type must come from
2946 stat, but readdir provides the inode and type of lstat. */
2947 || ((print_inode || format_needs_type)
2948 && (type == symbolic_link || type == unknown)
2949 && (dereference == DEREF_ALWAYS
2950 || (command_line_arg && dereference != DEREF_NEVER)
2951 || color_symlink_as_referent || check_symlink_color))
2952 /* Command line dereferences are already taken care of by the above
2953 assertion that the inode number is not yet known. */
2954 || (print_inode && inode == NOT_AN_INODE_NUMBER)
2955 || (format_needs_type
2956 && (type == unknown || command_line_arg
2957 /* --indicator-style=classify (aka -F)
2958 requires that we stat each regular file
2959 to see if it's executable. */
2960 || (type == normal && (indicator_style == classify
2961 /* This is so that --color ends up
2962 highlighting files with these mode
2963 bits set even when options like -F are
2964 not specified. Note we do a redundant
2965 stat in the very unlikely case where
2966 C_CAP is set but not the others. */
2967 || (print_with_color
2968 && (is_colored (C_EXEC)
2969 || is_colored (C_SETUID)
2970 || is_colored (C_SETGID)
2971 || is_colored (C_CAP)))
2972 )))))
2975 /* Absolute name of this file. */
2976 char *absolute_name;
2977 bool do_deref;
2978 int err;
2980 if (name[0] == '/' || dirname[0] == 0)
2981 absolute_name = (char *) name;
2982 else
2984 absolute_name = alloca (strlen (name) + strlen (dirname) + 2);
2985 attach (absolute_name, dirname, name);
2988 switch (dereference)
2990 case DEREF_ALWAYS:
2991 err = stat (absolute_name, &f->stat);
2992 do_deref = true;
2993 break;
2995 case DEREF_COMMAND_LINE_ARGUMENTS:
2996 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR:
2997 if (command_line_arg)
2999 bool need_lstat;
3000 err = stat (absolute_name, &f->stat);
3001 do_deref = true;
3003 if (dereference == DEREF_COMMAND_LINE_ARGUMENTS)
3004 break;
3006 need_lstat = (err < 0
3007 ? errno == ENOENT
3008 : ! S_ISDIR (f->stat.st_mode));
3009 if (!need_lstat)
3010 break;
3012 /* stat failed because of ENOENT, maybe indicating a dangling
3013 symlink. Or stat succeeded, ABSOLUTE_NAME does not refer to a
3014 directory, and --dereference-command-line-symlink-to-dir is
3015 in effect. Fall through so that we call lstat instead. */
3018 default: /* DEREF_NEVER */
3019 err = lstat (absolute_name, &f->stat);
3020 do_deref = false;
3021 break;
3024 if (err != 0)
3026 /* Failure to stat a command line argument leads to
3027 an exit status of 2. For other files, stat failure
3028 provokes an exit status of 1. */
3029 file_failure (command_line_arg,
3030 _("cannot access %s"), absolute_name);
3031 if (command_line_arg)
3032 return 0;
3034 f->name = xstrdup (name);
3035 cwd_n_used++;
3037 return 0;
3040 f->stat_ok = true;
3042 /* Note has_capability() adds around 30% runtime to 'ls --color' */
3043 if ((type == normal || S_ISREG (f->stat.st_mode))
3044 && print_with_color && is_colored (C_CAP))
3045 f->has_capability = has_capability_cache (absolute_name, f);
3047 if (format == long_format || print_scontext)
3049 bool have_scontext = false;
3050 bool have_acl = false;
3051 int attr_len = getfilecon_cache (absolute_name, f, do_deref);
3052 err = (attr_len < 0);
3054 if (err == 0)
3056 if (is_smack_enabled ())
3057 have_scontext = ! STREQ ("_", f->scontext);
3058 else
3059 have_scontext = ! STREQ ("unlabeled", f->scontext);
3061 else
3063 f->scontext = UNKNOWN_SECURITY_CONTEXT;
3065 /* When requesting security context information, don't make
3066 ls fail just because the file (even a command line argument)
3067 isn't on the right type of file system. I.e., a getfilecon
3068 failure isn't in the same class as a stat failure. */
3069 if (is_ENOTSUP (errno) || errno == ENODATA)
3070 err = 0;
3073 if (err == 0 && format == long_format)
3075 int n = file_has_acl_cache (absolute_name, f);
3076 err = (n < 0);
3077 have_acl = (0 < n);
3080 f->acl_type = (!have_scontext && !have_acl
3081 ? ACL_T_NONE
3082 : (have_scontext && !have_acl
3083 ? ACL_T_LSM_CONTEXT_ONLY
3084 : ACL_T_YES));
3085 any_has_acl |= f->acl_type != ACL_T_NONE;
3087 if (err)
3088 error (0, errno, "%s", quotearg_colon (absolute_name));
3091 if (S_ISLNK (f->stat.st_mode)
3092 && (format == long_format || check_symlink_color))
3094 struct stat linkstats;
3096 get_link_name (absolute_name, f, command_line_arg);
3097 char *linkname = make_link_name (absolute_name, f->linkname);
3099 /* Avoid following symbolic links when possible, ie, when
3100 they won't be traced and when no indicator is needed. */
3101 if (linkname
3102 && (file_type <= indicator_style || check_symlink_color)
3103 && stat (linkname, &linkstats) == 0)
3105 f->linkok = true;
3107 /* Symbolic links to directories that are mentioned on the
3108 command line are automatically traced if not being
3109 listed as files. */
3110 if (!command_line_arg || format == long_format
3111 || !S_ISDIR (linkstats.st_mode))
3113 /* Get the linked-to file's mode for the filetype indicator
3114 in long listings. */
3115 f->linkmode = linkstats.st_mode;
3118 free (linkname);
3121 if (S_ISLNK (f->stat.st_mode))
3122 f->filetype = symbolic_link;
3123 else if (S_ISDIR (f->stat.st_mode))
3125 if (command_line_arg && !immediate_dirs)
3126 f->filetype = arg_directory;
3127 else
3128 f->filetype = directory;
3130 else
3131 f->filetype = normal;
3133 blocks = ST_NBLOCKS (f->stat);
3134 if (format == long_format || print_block_size)
3136 char buf[LONGEST_HUMAN_READABLE + 1];
3137 int len = mbswidth (human_readable (blocks, buf, human_output_opts,
3138 ST_NBLOCKSIZE, output_block_size),
3140 if (block_size_width < len)
3141 block_size_width = len;
3144 if (format == long_format)
3146 if (print_owner)
3148 int len = format_user_width (f->stat.st_uid);
3149 if (owner_width < len)
3150 owner_width = len;
3153 if (print_group)
3155 int len = format_group_width (f->stat.st_gid);
3156 if (group_width < len)
3157 group_width = len;
3160 if (print_author)
3162 int len = format_user_width (f->stat.st_author);
3163 if (author_width < len)
3164 author_width = len;
3168 if (print_scontext)
3170 int len = strlen (f->scontext);
3171 if (scontext_width < len)
3172 scontext_width = len;
3175 if (format == long_format)
3177 char b[INT_BUFSIZE_BOUND (uintmax_t)];
3178 int b_len = strlen (umaxtostr (f->stat.st_nlink, b));
3179 if (nlink_width < b_len)
3180 nlink_width = b_len;
3182 if (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode))
3184 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3185 int len = strlen (umaxtostr (major (f->stat.st_rdev), buf));
3186 if (major_device_number_width < len)
3187 major_device_number_width = len;
3188 len = strlen (umaxtostr (minor (f->stat.st_rdev), buf));
3189 if (minor_device_number_width < len)
3190 minor_device_number_width = len;
3191 len = major_device_number_width + 2 + minor_device_number_width;
3192 if (file_size_width < len)
3193 file_size_width = len;
3195 else
3197 char buf[LONGEST_HUMAN_READABLE + 1];
3198 uintmax_t size = unsigned_file_size (f->stat.st_size);
3199 int len = mbswidth (human_readable (size, buf,
3200 file_human_output_opts,
3201 1, file_output_block_size),
3203 if (file_size_width < len)
3204 file_size_width = len;
3209 if (print_inode)
3211 char buf[INT_BUFSIZE_BOUND (uintmax_t)];
3212 int len = strlen (umaxtostr (f->stat.st_ino, buf));
3213 if (inode_number_width < len)
3214 inode_number_width = len;
3217 f->name = xstrdup (name);
3218 cwd_n_used++;
3220 return blocks;
3223 /* Return true if F refers to a directory. */
3224 static bool
3225 is_directory (const struct fileinfo *f)
3227 return f->filetype == directory || f->filetype == arg_directory;
3230 /* Put the name of the file that FILENAME is a symbolic link to
3231 into the LINKNAME field of 'f'. COMMAND_LINE_ARG indicates whether
3232 FILENAME is a command-line argument. */
3234 static void
3235 get_link_name (char const *filename, struct fileinfo *f, bool command_line_arg)
3237 f->linkname = areadlink_with_size (filename, f->stat.st_size);
3238 if (f->linkname == NULL)
3239 file_failure (command_line_arg, _("cannot read symbolic link %s"),
3240 filename);
3243 /* If LINKNAME is a relative name and NAME contains one or more
3244 leading directories, return LINKNAME with those directories
3245 prepended; otherwise, return a copy of LINKNAME.
3246 If LINKNAME is NULL, return NULL. */
3248 static char *
3249 make_link_name (char const *name, char const *linkname)
3251 if (!linkname)
3252 return NULL;
3254 if (IS_ABSOLUTE_FILE_NAME (linkname))
3255 return xstrdup (linkname);
3257 /* The link is to a relative name. Prepend any leading directory
3258 in 'name' to the link name. */
3259 size_t prefix_len = dir_len (name);
3260 if (prefix_len == 0)
3261 return xstrdup (linkname);
3263 char *p = xmalloc (prefix_len + 1 + strlen (linkname) + 1);
3265 /* PREFIX_LEN usually specifies a string not ending in slash.
3266 In that case, extend it by one, since the next byte *is* a slash.
3267 Otherwise, the prefix is "/", so leave the length unchanged. */
3268 if ( ! ISSLASH (name[prefix_len - 1]))
3269 ++prefix_len;
3271 stpcpy (stpncpy (p, name, prefix_len), linkname);
3272 return p;
3275 /* Return true if the last component of NAME is '.' or '..'
3276 This is so we don't try to recurse on '././././. ...' */
3278 static bool
3279 basename_is_dot_or_dotdot (const char *name)
3281 char const *base = last_component (name);
3282 return dot_or_dotdot (base);
3285 /* Remove any entries from CWD_FILE that are for directories,
3286 and queue them to be listed as directories instead.
3287 DIRNAME is the prefix to prepend to each dirname
3288 to make it correct relative to ls's working dir;
3289 if it is null, no prefix is needed and "." and ".." should not be ignored.
3290 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
3291 This is desirable when processing directories recursively. */
3293 static void
3294 extract_dirs_from_files (char const *dirname, bool command_line_arg)
3296 size_t i;
3297 size_t j;
3298 bool ignore_dot_and_dot_dot = (dirname != NULL);
3300 if (dirname && LOOP_DETECT)
3302 /* Insert a marker entry first. When we dequeue this marker entry,
3303 we'll know that DIRNAME has been processed and may be removed
3304 from the set of active directories. */
3305 queue_directory (NULL, dirname, false);
3308 /* Queue the directories last one first, because queueing reverses the
3309 order. */
3310 for (i = cwd_n_used; i-- != 0; )
3312 struct fileinfo *f = sorted_file[i];
3314 if (is_directory (f)
3315 && (! ignore_dot_and_dot_dot
3316 || ! basename_is_dot_or_dotdot (f->name)))
3318 if (!dirname || f->name[0] == '/')
3319 queue_directory (f->name, f->linkname, command_line_arg);
3320 else
3322 char *name = file_name_concat (dirname, f->name, NULL);
3323 queue_directory (name, f->linkname, command_line_arg);
3324 free (name);
3326 if (f->filetype == arg_directory)
3327 free_ent (f);
3331 /* Now delete the directories from the table, compacting all the remaining
3332 entries. */
3334 for (i = 0, j = 0; i < cwd_n_used; i++)
3336 struct fileinfo *f = sorted_file[i];
3337 sorted_file[j] = f;
3338 j += (f->filetype != arg_directory);
3340 cwd_n_used = j;
3343 /* Use strcoll to compare strings in this locale. If an error occurs,
3344 report an error and longjmp to failed_strcoll. */
3346 static jmp_buf failed_strcoll;
3348 static int
3349 xstrcoll (char const *a, char const *b)
3351 int diff;
3352 errno = 0;
3353 diff = strcoll (a, b);
3354 if (errno)
3356 error (0, errno, _("cannot compare file names %s and %s"),
3357 quote_n (0, a), quote_n (1, b));
3358 set_exit_status (false);
3359 longjmp (failed_strcoll, 1);
3361 return diff;
3364 /* Comparison routines for sorting the files. */
3366 typedef void const *V;
3367 typedef int (*qsortFunc)(V a, V b);
3369 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants.
3370 The do { ... } while(0) makes it possible to use the macro more like
3371 a statement, without violating C89 rules: */
3372 #define DIRFIRST_CHECK(a, b) \
3373 do \
3375 bool a_is_dir = is_directory ((struct fileinfo const *) a); \
3376 bool b_is_dir = is_directory ((struct fileinfo const *) b); \
3377 if (a_is_dir && !b_is_dir) \
3378 return -1; /* a goes before b */ \
3379 if (!a_is_dir && b_is_dir) \
3380 return 1; /* b goes before a */ \
3382 while (0)
3384 /* Define the 8 different sort function variants required for each sortkey.
3385 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3386 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3387 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3388 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3389 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3390 /* direct, non-dirfirst versions */ \
3391 static int xstrcoll_##key_name (V a, V b) \
3392 { return key_cmp_func (a, b, xstrcoll); } \
3393 static int strcmp_##key_name (V a, V b) \
3394 { return key_cmp_func (a, b, strcmp); } \
3396 /* reverse, non-dirfirst versions */ \
3397 static int rev_xstrcoll_##key_name (V a, V b) \
3398 { return key_cmp_func (b, a, xstrcoll); } \
3399 static int rev_strcmp_##key_name (V a, V b) \
3400 { return key_cmp_func (b, a, strcmp); } \
3402 /* direct, dirfirst versions */ \
3403 static int xstrcoll_df_##key_name (V a, V b) \
3404 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, xstrcoll); } \
3405 static int strcmp_df_##key_name (V a, V b) \
3406 { DIRFIRST_CHECK (a, b); return key_cmp_func (a, b, strcmp); } \
3408 /* reverse, dirfirst versions */ \
3409 static int rev_xstrcoll_df_##key_name (V a, V b) \
3410 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, xstrcoll); } \
3411 static int rev_strcmp_df_##key_name (V a, V b) \
3412 { DIRFIRST_CHECK (a, b); return key_cmp_func (b, a, strcmp); }
3414 static inline int
3415 cmp_ctime (struct fileinfo const *a, struct fileinfo const *b,
3416 int (*cmp) (char const *, char const *))
3418 int diff = timespec_cmp (get_stat_ctime (&b->stat),
3419 get_stat_ctime (&a->stat));
3420 return diff ? diff : cmp (a->name, b->name);
3423 static inline int
3424 cmp_mtime (struct fileinfo const *a, struct fileinfo const *b,
3425 int (*cmp) (char const *, char const *))
3427 int diff = timespec_cmp (get_stat_mtime (&b->stat),
3428 get_stat_mtime (&a->stat));
3429 return diff ? diff : cmp (a->name, b->name);
3432 static inline int
3433 cmp_atime (struct fileinfo const *a, struct fileinfo const *b,
3434 int (*cmp) (char const *, char const *))
3436 int diff = timespec_cmp (get_stat_atime (&b->stat),
3437 get_stat_atime (&a->stat));
3438 return diff ? diff : cmp (a->name, b->name);
3441 static inline int
3442 cmp_size (struct fileinfo const *a, struct fileinfo const *b,
3443 int (*cmp) (char const *, char const *))
3445 int diff = longdiff (b->stat.st_size, a->stat.st_size);
3446 return diff ? diff : cmp (a->name, b->name);
3449 static inline int
3450 cmp_name (struct fileinfo const *a, struct fileinfo const *b,
3451 int (*cmp) (char const *, char const *))
3453 return cmp (a->name, b->name);
3456 /* Compare file extensions. Files with no extension are 'smallest'.
3457 If extensions are the same, compare by filenames instead. */
3459 static inline int
3460 cmp_extension (struct fileinfo const *a, struct fileinfo const *b,
3461 int (*cmp) (char const *, char const *))
3463 char const *base1 = strrchr (a->name, '.');
3464 char const *base2 = strrchr (b->name, '.');
3465 int diff = cmp (base1 ? base1 : "", base2 ? base2 : "");
3466 return diff ? diff : cmp (a->name, b->name);
3469 DEFINE_SORT_FUNCTIONS (ctime, cmp_ctime)
3470 DEFINE_SORT_FUNCTIONS (mtime, cmp_mtime)
3471 DEFINE_SORT_FUNCTIONS (atime, cmp_atime)
3472 DEFINE_SORT_FUNCTIONS (size, cmp_size)
3473 DEFINE_SORT_FUNCTIONS (name, cmp_name)
3474 DEFINE_SORT_FUNCTIONS (extension, cmp_extension)
3476 /* Compare file versions.
3477 Unlike all other compare functions above, cmp_version depends only
3478 on filevercmp, which does not fail (even for locale reasons), and does not
3479 need a secondary sort key. See lib/filevercmp.h for function description.
3481 All the other sort options, in fact, need xstrcoll and strcmp variants,
3482 because they all use a string comparison (either as the primary or secondary
3483 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3484 locale reasons. Lastly, filevercmp is ALWAYS available with gnulib. */
3485 static inline int
3486 cmp_version (struct fileinfo const *a, struct fileinfo const *b)
3488 return filevercmp (a->name, b->name);
3491 static int xstrcoll_version (V a, V b)
3492 { return cmp_version (a, b); }
3493 static int rev_xstrcoll_version (V a, V b)
3494 { return cmp_version (b, a); }
3495 static int xstrcoll_df_version (V a, V b)
3496 { DIRFIRST_CHECK (a, b); return cmp_version (a, b); }
3497 static int rev_xstrcoll_df_version (V a, V b)
3498 { DIRFIRST_CHECK (a, b); return cmp_version (b, a); }
3501 /* We have 2^3 different variants for each sort-key function
3502 (for 3 independent sort modes).
3503 The function pointers stored in this array must be dereferenced as:
3505 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
3507 Note that the order in which sort keys are listed in the function pointer
3508 array below is defined by the order of the elements in the time_type and
3509 sort_type enums! */
3511 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
3514 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
3515 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
3516 }, \
3518 { strcmp_##key_name, strcmp_df_##key_name }, \
3519 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
3523 static qsortFunc const sort_functions[][2][2][2] =
3525 LIST_SORTFUNCTION_VARIANTS (name),
3526 LIST_SORTFUNCTION_VARIANTS (extension),
3527 LIST_SORTFUNCTION_VARIANTS (size),
3531 { xstrcoll_version, xstrcoll_df_version },
3532 { rev_xstrcoll_version, rev_xstrcoll_df_version },
3535 /* We use NULL for the strcmp variants of version comparison
3536 since as explained in cmp_version definition, version comparison
3537 does not rely on xstrcoll, so it will never longjmp, and never
3538 need to try the strcmp fallback. */
3540 { NULL, NULL },
3541 { NULL, NULL },
3545 /* last are time sort functions */
3546 LIST_SORTFUNCTION_VARIANTS (mtime),
3547 LIST_SORTFUNCTION_VARIANTS (ctime),
3548 LIST_SORTFUNCTION_VARIANTS (atime)
3551 /* The number of sort keys is calculated as the sum of
3552 the number of elements in the sort_type enum (i.e., sort_numtypes)
3553 the number of elements in the time_type enum (i.e., time_numtypes) - 1
3554 This is because when sort_type==sort_time, we have up to
3555 time_numtypes possible sort keys.
3557 This line verifies at compile-time that the array of sort functions has been
3558 initialized for all possible sort keys. */
3559 verify (ARRAY_CARDINALITY (sort_functions)
3560 == sort_numtypes + time_numtypes - 1 );
3562 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
3564 static void
3565 initialize_ordering_vector (void)
3567 size_t i;
3568 for (i = 0; i < cwd_n_used; i++)
3569 sorted_file[i] = &cwd_file[i];
3572 /* Sort the files now in the table. */
3574 static void
3575 sort_files (void)
3577 bool use_strcmp;
3579 if (sorted_file_alloc < cwd_n_used + cwd_n_used / 2)
3581 free (sorted_file);
3582 sorted_file = xnmalloc (cwd_n_used, 3 * sizeof *sorted_file);
3583 sorted_file_alloc = 3 * cwd_n_used;
3586 initialize_ordering_vector ();
3588 if (sort_type == sort_none)
3589 return;
3591 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
3592 ignore strcoll failures, as a failing strcoll might be a
3593 comparison function that is not a total order, and if we ignored
3594 the failure this might cause qsort to dump core. */
3596 if (! setjmp (failed_strcoll))
3597 use_strcmp = false; /* strcoll() succeeded */
3598 else
3600 use_strcmp = true;
3601 assert (sort_type != sort_version);
3602 initialize_ordering_vector ();
3605 /* When sort_type == sort_time, use time_type as subindex. */
3606 mpsort ((void const **) sorted_file, cwd_n_used,
3607 sort_functions[sort_type + (sort_type == sort_time ? time_type : 0)]
3608 [use_strcmp][sort_reverse]
3609 [directories_first]);
3612 /* List all the files now in the table. */
3614 static void
3615 print_current_files (void)
3617 size_t i;
3619 switch (format)
3621 case one_per_line:
3622 for (i = 0; i < cwd_n_used; i++)
3624 print_file_name_and_frills (sorted_file[i], 0);
3625 putchar ('\n');
3627 break;
3629 case many_per_line:
3630 print_many_per_line ();
3631 break;
3633 case horizontal:
3634 print_horizontal ();
3635 break;
3637 case with_commas:
3638 print_with_commas ();
3639 break;
3641 case long_format:
3642 for (i = 0; i < cwd_n_used; i++)
3644 set_normal_color ();
3645 print_long_format (sorted_file[i]);
3646 DIRED_PUTCHAR ('\n');
3648 break;
3652 /* Replace the first %b with precomputed aligned month names.
3653 Note on glibc-2.7 at least, this speeds up the whole 'ls -lU'
3654 process by around 17%, compared to letting strftime() handle the %b. */
3656 static size_t
3657 align_nstrftime (char *buf, size_t size, char const *fmt, struct tm const *tm,
3658 int __utc, int __ns)
3660 const char *nfmt = fmt;
3661 /* In the unlikely event that rpl_fmt below is not large enough,
3662 the replacement is not done. A malloc here slows ls down by 2% */
3663 char rpl_fmt[sizeof (abmon[0]) + 100];
3664 const char *pb;
3665 if (required_mon_width && (pb = strstr (fmt, "%b"))
3666 && 0 <= tm->tm_mon && tm->tm_mon <= 11)
3668 if (strlen (fmt) < (sizeof (rpl_fmt) - sizeof (abmon[0]) + 2))
3670 char *pfmt = rpl_fmt;
3671 nfmt = rpl_fmt;
3673 pfmt = mempcpy (pfmt, fmt, pb - fmt);
3674 pfmt = stpcpy (pfmt, abmon[tm->tm_mon]);
3675 strcpy (pfmt, pb + 2);
3678 size_t ret = nstrftime (buf, size, nfmt, tm, __utc, __ns);
3679 return ret;
3682 /* Return the expected number of columns in a long-format time stamp,
3683 or zero if it cannot be calculated. */
3685 static int
3686 long_time_expected_width (void)
3688 static int width = -1;
3690 if (width < 0)
3692 time_t epoch = 0;
3693 struct tm const *tm = localtime (&epoch);
3694 char buf[TIME_STAMP_LEN_MAXIMUM + 1];
3696 /* In case you're wondering if localtime can fail with an input time_t
3697 value of 0, let's just say it's very unlikely, but not inconceivable.
3698 The TZ environment variable would have to specify a time zone that
3699 is 2**31-1900 years or more ahead of UTC. This could happen only on
3700 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
3701 However, this is not possible with Solaris 10 or glibc-2.3.5, since
3702 their implementations limit the offset to 167:59 and 24:00, resp. */
3703 if (tm)
3705 size_t len =
3706 align_nstrftime (buf, sizeof buf, long_time_format[0], tm, 0, 0);
3707 if (len != 0)
3708 width = mbsnwidth (buf, len, 0);
3711 if (width < 0)
3712 width = 0;
3715 return width;
3718 /* Print the user or group name NAME, with numeric id ID, using a
3719 print width of WIDTH columns. */
3721 static void
3722 format_user_or_group (char const *name, unsigned long int id, int width)
3724 size_t len;
3726 if (name)
3728 int width_gap = width - mbswidth (name, 0);
3729 int pad = MAX (0, width_gap);
3730 fputs (name, stdout);
3731 len = strlen (name) + pad;
3734 putchar (' ');
3735 while (pad--);
3737 else
3739 printf ("%*lu ", width, id);
3740 len = width;
3743 dired_pos += len + 1;
3746 /* Print the name or id of the user with id U, using a print width of
3747 WIDTH. */
3749 static void
3750 format_user (uid_t u, int width, bool stat_ok)
3752 format_user_or_group (! stat_ok ? "?" :
3753 (numeric_ids ? NULL : getuser (u)), u, width);
3756 /* Likewise, for groups. */
3758 static void
3759 format_group (gid_t g, int width, bool stat_ok)
3761 format_user_or_group (! stat_ok ? "?" :
3762 (numeric_ids ? NULL : getgroup (g)), g, width);
3765 /* Return the number of columns that format_user_or_group will print. */
3767 static int
3768 format_user_or_group_width (char const *name, unsigned long int id)
3770 if (name)
3772 int len = mbswidth (name, 0);
3773 return MAX (0, len);
3775 else
3777 char buf[INT_BUFSIZE_BOUND (id)];
3778 sprintf (buf, "%lu", id);
3779 return strlen (buf);
3783 /* Return the number of columns that format_user will print. */
3785 static int
3786 format_user_width (uid_t u)
3788 return format_user_or_group_width (numeric_ids ? NULL : getuser (u), u);
3791 /* Likewise, for groups. */
3793 static int
3794 format_group_width (gid_t g)
3796 return format_user_or_group_width (numeric_ids ? NULL : getgroup (g), g);
3799 /* Return a pointer to a formatted version of F->stat.st_ino,
3800 possibly using buffer, BUF, of length BUFLEN, which must be at least
3801 INT_BUFSIZE_BOUND (uintmax_t) bytes. */
3802 static char *
3803 format_inode (char *buf, size_t buflen, const struct fileinfo *f)
3805 assert (INT_BUFSIZE_BOUND (uintmax_t) <= buflen);
3806 return (f->stat_ok && f->stat.st_ino != NOT_AN_INODE_NUMBER
3807 ? umaxtostr (f->stat.st_ino, buf)
3808 : (char *) "?");
3811 /* Print information about F in long format. */
3812 static void
3813 print_long_format (const struct fileinfo *f)
3815 char modebuf[12];
3816 char buf
3817 [LONGEST_HUMAN_READABLE + 1 /* inode */
3818 + LONGEST_HUMAN_READABLE + 1 /* size in blocks */
3819 + sizeof (modebuf) - 1 + 1 /* mode string */
3820 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
3821 + LONGEST_HUMAN_READABLE + 2 /* major device number */
3822 + LONGEST_HUMAN_READABLE + 1 /* minor device number */
3823 + TIME_STAMP_LEN_MAXIMUM + 1 /* max length of time/date */
3825 size_t s;
3826 char *p;
3827 struct timespec when_timespec;
3828 struct tm *when_local;
3830 /* Compute the mode string, except remove the trailing space if no
3831 file in this directory has an ACL or security context. */
3832 if (f->stat_ok)
3833 filemodestring (&f->stat, modebuf);
3834 else
3836 modebuf[0] = filetype_letter[f->filetype];
3837 memset (modebuf + 1, '?', 10);
3838 modebuf[11] = '\0';
3840 if (! any_has_acl)
3841 modebuf[10] = '\0';
3842 else if (f->acl_type == ACL_T_LSM_CONTEXT_ONLY)
3843 modebuf[10] = '.';
3844 else if (f->acl_type == ACL_T_YES)
3845 modebuf[10] = '+';
3847 switch (time_type)
3849 case time_ctime:
3850 when_timespec = get_stat_ctime (&f->stat);
3851 break;
3852 case time_mtime:
3853 when_timespec = get_stat_mtime (&f->stat);
3854 break;
3855 case time_atime:
3856 when_timespec = get_stat_atime (&f->stat);
3857 break;
3858 default:
3859 abort ();
3862 p = buf;
3864 if (print_inode)
3866 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3867 sprintf (p, "%*s ", inode_number_width,
3868 format_inode (hbuf, sizeof hbuf, f));
3869 /* Increment by strlen (p) here, rather than by inode_number_width + 1.
3870 The latter is wrong when inode_number_width is zero. */
3871 p += strlen (p);
3874 if (print_block_size)
3876 char hbuf[LONGEST_HUMAN_READABLE + 1];
3877 char const *blocks =
3878 (! f->stat_ok
3879 ? "?"
3880 : human_readable (ST_NBLOCKS (f->stat), hbuf, human_output_opts,
3881 ST_NBLOCKSIZE, output_block_size));
3882 int pad;
3883 for (pad = block_size_width - mbswidth (blocks, 0); 0 < pad; pad--)
3884 *p++ = ' ';
3885 while ((*p++ = *blocks++))
3886 continue;
3887 p[-1] = ' ';
3890 /* The last byte of the mode string is the POSIX
3891 "optional alternate access method flag". */
3893 char hbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3894 sprintf (p, "%s %*s ", modebuf, nlink_width,
3895 ! f->stat_ok ? "?" : umaxtostr (f->stat.st_nlink, hbuf));
3897 /* Increment by strlen (p) here, rather than by, e.g.,
3898 sizeof modebuf - 2 + any_has_acl + 1 + nlink_width + 1.
3899 The latter is wrong when nlink_width is zero. */
3900 p += strlen (p);
3902 DIRED_INDENT ();
3904 if (print_owner || print_group || print_author || print_scontext)
3906 DIRED_FPUTS (buf, stdout, p - buf);
3908 if (print_owner)
3909 format_user (f->stat.st_uid, owner_width, f->stat_ok);
3911 if (print_group)
3912 format_group (f->stat.st_gid, group_width, f->stat_ok);
3914 if (print_author)
3915 format_user (f->stat.st_author, author_width, f->stat_ok);
3917 if (print_scontext)
3918 format_user_or_group (f->scontext, 0, scontext_width);
3920 p = buf;
3923 if (f->stat_ok
3924 && (S_ISCHR (f->stat.st_mode) || S_ISBLK (f->stat.st_mode)))
3926 char majorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3927 char minorbuf[INT_BUFSIZE_BOUND (uintmax_t)];
3928 int blanks_width = (file_size_width
3929 - (major_device_number_width + 2
3930 + minor_device_number_width));
3931 sprintf (p, "%*s, %*s ",
3932 major_device_number_width + MAX (0, blanks_width),
3933 umaxtostr (major (f->stat.st_rdev), majorbuf),
3934 minor_device_number_width,
3935 umaxtostr (minor (f->stat.st_rdev), minorbuf));
3936 p += file_size_width + 1;
3938 else
3940 char hbuf[LONGEST_HUMAN_READABLE + 1];
3941 char const *size =
3942 (! f->stat_ok
3943 ? "?"
3944 : human_readable (unsigned_file_size (f->stat.st_size),
3945 hbuf, file_human_output_opts, 1,
3946 file_output_block_size));
3947 int pad;
3948 for (pad = file_size_width - mbswidth (size, 0); 0 < pad; pad--)
3949 *p++ = ' ';
3950 while ((*p++ = *size++))
3951 continue;
3952 p[-1] = ' ';
3955 when_local = localtime (&when_timespec.tv_sec);
3956 s = 0;
3957 *p = '\1';
3959 if (f->stat_ok && when_local)
3961 struct timespec six_months_ago;
3962 bool recent;
3963 char const *fmt;
3965 /* If the file appears to be in the future, update the current
3966 time, in case the file happens to have been modified since
3967 the last time we checked the clock. */
3968 if (timespec_cmp (current_time, when_timespec) < 0)
3970 /* Note that gettime may call gettimeofday which, on some non-
3971 compliant systems, clobbers the buffer used for localtime's result.
3972 But it's ok here, because we use a gettimeofday wrapper that
3973 saves and restores the buffer around the gettimeofday call. */
3974 gettime (&current_time);
3977 /* Consider a time to be recent if it is within the past six months.
3978 A Gregorian year has 365.2425 * 24 * 60 * 60 == 31556952 seconds
3979 on the average. Write this value as an integer constant to
3980 avoid floating point hassles. */
3981 six_months_ago.tv_sec = current_time.tv_sec - 31556952 / 2;
3982 six_months_ago.tv_nsec = current_time.tv_nsec;
3984 recent = (timespec_cmp (six_months_ago, when_timespec) < 0
3985 && (timespec_cmp (when_timespec, current_time) < 0));
3986 fmt = long_time_format[recent];
3988 /* We assume here that all time zones are offset from UTC by a
3989 whole number of seconds. */
3990 s = align_nstrftime (p, TIME_STAMP_LEN_MAXIMUM + 1, fmt,
3991 when_local, 0, when_timespec.tv_nsec);
3994 if (s || !*p)
3996 p += s;
3997 *p++ = ' ';
3999 /* NUL-terminate the string -- fputs (via DIRED_FPUTS) requires it. */
4000 *p = '\0';
4002 else
4004 /* The time cannot be converted using the desired format, so
4005 print it as a huge integer number of seconds. */
4006 char hbuf[INT_BUFSIZE_BOUND (intmax_t)];
4007 sprintf (p, "%*s ", long_time_expected_width (),
4008 (! f->stat_ok
4009 ? "?"
4010 : timetostr (when_timespec.tv_sec, hbuf)));
4011 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
4012 p += strlen (p);
4015 DIRED_FPUTS (buf, stdout, p - buf);
4016 size_t w = print_name_with_quoting (f, false, &dired_obstack, p - buf);
4018 if (f->filetype == symbolic_link)
4020 if (f->linkname)
4022 DIRED_FPUTS_LITERAL (" -> ", stdout);
4023 print_name_with_quoting (f, true, NULL, (p - buf) + w + 4);
4024 if (indicator_style != none)
4025 print_type_indicator (true, f->linkmode, unknown);
4028 else if (indicator_style != none)
4029 print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4032 /* Output to OUT a quoted representation of the file name NAME,
4033 using OPTIONS to control quoting. Produce no output if OUT is NULL.
4034 Store the number of screen columns occupied by NAME's quoted
4035 representation into WIDTH, if non-NULL. Return the number of bytes
4036 produced. */
4038 static size_t
4039 quote_name (FILE *out, const char *name, struct quoting_options const *options,
4040 size_t *width)
4042 char smallbuf[BUFSIZ];
4043 size_t len = quotearg_buffer (smallbuf, sizeof smallbuf, name, -1, options);
4044 char *buf;
4045 size_t displayed_width IF_LINT ( = 0);
4047 if (len < sizeof smallbuf)
4048 buf = smallbuf;
4049 else
4051 buf = alloca (len + 1);
4052 quotearg_buffer (buf, len + 1, name, -1, options);
4055 if (qmark_funny_chars)
4057 if (MB_CUR_MAX > 1)
4059 char const *p = buf;
4060 char const *plimit = buf + len;
4061 char *q = buf;
4062 displayed_width = 0;
4064 while (p < plimit)
4065 switch (*p)
4067 case ' ': case '!': case '"': case '#': case '%':
4068 case '&': case '\'': case '(': case ')': case '*':
4069 case '+': case ',': case '-': case '.': case '/':
4070 case '0': case '1': case '2': case '3': case '4':
4071 case '5': case '6': case '7': case '8': case '9':
4072 case ':': case ';': case '<': case '=': case '>':
4073 case '?':
4074 case 'A': case 'B': case 'C': case 'D': case 'E':
4075 case 'F': case 'G': case 'H': case 'I': case 'J':
4076 case 'K': case 'L': case 'M': case 'N': case 'O':
4077 case 'P': case 'Q': case 'R': case 'S': case 'T':
4078 case 'U': case 'V': case 'W': case 'X': case 'Y':
4079 case 'Z':
4080 case '[': case '\\': case ']': case '^': case '_':
4081 case 'a': case 'b': case 'c': case 'd': case 'e':
4082 case 'f': case 'g': case 'h': case 'i': case 'j':
4083 case 'k': case 'l': case 'm': case 'n': case 'o':
4084 case 'p': case 'q': case 'r': case 's': case 't':
4085 case 'u': case 'v': case 'w': case 'x': case 'y':
4086 case 'z': case '{': case '|': case '}': case '~':
4087 /* These characters are printable ASCII characters. */
4088 *q++ = *p++;
4089 displayed_width += 1;
4090 break;
4091 default:
4092 /* If we have a multibyte sequence, copy it until we
4093 reach its end, replacing each non-printable multibyte
4094 character with a single question mark. */
4096 mbstate_t mbstate = { 0, };
4099 wchar_t wc;
4100 size_t bytes;
4101 int w;
4103 bytes = mbrtowc (&wc, p, plimit - p, &mbstate);
4105 if (bytes == (size_t) -1)
4107 /* An invalid multibyte sequence was
4108 encountered. Skip one input byte, and
4109 put a question mark. */
4110 p++;
4111 *q++ = '?';
4112 displayed_width += 1;
4113 break;
4116 if (bytes == (size_t) -2)
4118 /* An incomplete multibyte character
4119 at the end. Replace it entirely with
4120 a question mark. */
4121 p = plimit;
4122 *q++ = '?';
4123 displayed_width += 1;
4124 break;
4127 if (bytes == 0)
4128 /* A null wide character was encountered. */
4129 bytes = 1;
4131 w = wcwidth (wc);
4132 if (w >= 0)
4134 /* A printable multibyte character.
4135 Keep it. */
4136 for (; bytes > 0; --bytes)
4137 *q++ = *p++;
4138 displayed_width += w;
4140 else
4142 /* An unprintable multibyte character.
4143 Replace it entirely with a question
4144 mark. */
4145 p += bytes;
4146 *q++ = '?';
4147 displayed_width += 1;
4150 while (! mbsinit (&mbstate));
4152 break;
4155 /* The buffer may have shrunk. */
4156 len = q - buf;
4158 else
4160 char *p = buf;
4161 char const *plimit = buf + len;
4163 while (p < plimit)
4165 if (! isprint (to_uchar (*p)))
4166 *p = '?';
4167 p++;
4169 displayed_width = len;
4172 else if (width != NULL)
4174 if (MB_CUR_MAX > 1)
4175 displayed_width = mbsnwidth (buf, len, 0);
4176 else
4178 char const *p = buf;
4179 char const *plimit = buf + len;
4181 displayed_width = 0;
4182 while (p < plimit)
4184 if (isprint (to_uchar (*p)))
4185 displayed_width++;
4186 p++;
4191 if (out != NULL)
4192 fwrite (buf, 1, len, out);
4193 if (width != NULL)
4194 *width = displayed_width;
4195 return len;
4198 static size_t
4199 print_name_with_quoting (const struct fileinfo *f,
4200 bool symlink_target,
4201 struct obstack *stack,
4202 size_t start_col)
4204 const char* name = symlink_target ? f->linkname : f->name;
4206 bool used_color_this_time
4207 = (print_with_color
4208 && (print_color_indicator (f, symlink_target)
4209 || is_colored (C_NORM)));
4211 if (stack)
4212 PUSH_CURRENT_DIRED_POS (stack);
4214 size_t width = quote_name (stdout, name, filename_quoting_options, NULL);
4215 dired_pos += width;
4217 if (stack)
4218 PUSH_CURRENT_DIRED_POS (stack);
4220 process_signals ();
4221 if (used_color_this_time)
4223 prep_non_filename_text ();
4224 if (start_col / line_length != (start_col + width - 1) / line_length)
4225 put_indicator (&color_indicator[C_CLR_TO_EOL]);
4228 return width;
4231 static void
4232 prep_non_filename_text (void)
4234 if (color_indicator[C_END].string != NULL)
4235 put_indicator (&color_indicator[C_END]);
4236 else
4238 put_indicator (&color_indicator[C_LEFT]);
4239 put_indicator (&color_indicator[C_RESET]);
4240 put_indicator (&color_indicator[C_RIGHT]);
4244 /* Print the file name of 'f' with appropriate quoting.
4245 Also print file size, inode number, and filetype indicator character,
4246 as requested by switches. */
4248 static size_t
4249 print_file_name_and_frills (const struct fileinfo *f, size_t start_col)
4251 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4253 set_normal_color ();
4255 if (print_inode)
4256 printf ("%*s ", format == with_commas ? 0 : inode_number_width,
4257 format_inode (buf, sizeof buf, f));
4259 if (print_block_size)
4260 printf ("%*s ", format == with_commas ? 0 : block_size_width,
4261 ! f->stat_ok ? "?"
4262 : human_readable (ST_NBLOCKS (f->stat), buf, human_output_opts,
4263 ST_NBLOCKSIZE, output_block_size));
4265 if (print_scontext)
4266 printf ("%*s ", format == with_commas ? 0 : scontext_width, f->scontext);
4268 size_t width = print_name_with_quoting (f, false, NULL, start_col);
4270 if (indicator_style != none)
4271 width += print_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4273 return width;
4276 /* Given these arguments describing a file, return the single-byte
4277 type indicator, or 0. */
4278 static char
4279 get_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4281 char c;
4283 if (stat_ok ? S_ISREG (mode) : type == normal)
4285 if (stat_ok && indicator_style == classify && (mode & S_IXUGO))
4286 c = '*';
4287 else
4288 c = 0;
4290 else
4292 if (stat_ok ? S_ISDIR (mode) : type == directory || type == arg_directory)
4293 c = '/';
4294 else if (indicator_style == slash)
4295 c = 0;
4296 else if (stat_ok ? S_ISLNK (mode) : type == symbolic_link)
4297 c = '@';
4298 else if (stat_ok ? S_ISFIFO (mode) : type == fifo)
4299 c = '|';
4300 else if (stat_ok ? S_ISSOCK (mode) : type == sock)
4301 c = '=';
4302 else if (stat_ok && S_ISDOOR (mode))
4303 c = '>';
4304 else
4305 c = 0;
4307 return c;
4310 static bool
4311 print_type_indicator (bool stat_ok, mode_t mode, enum filetype type)
4313 char c = get_type_indicator (stat_ok, mode, type);
4314 if (c)
4315 DIRED_PUTCHAR (c);
4316 return !!c;
4319 /* Returns whether any color sequence was printed. */
4320 static bool
4321 print_color_indicator (const struct fileinfo *f, bool symlink_target)
4323 enum indicator_no type;
4324 struct color_ext_type *ext; /* Color extension */
4325 size_t len; /* Length of name */
4327 const char* name;
4328 mode_t mode;
4329 int linkok;
4330 if (symlink_target)
4332 name = f->linkname;
4333 mode = f->linkmode;
4334 linkok = f->linkok ? 0 : -1;
4336 else
4338 name = f->name;
4339 mode = FILE_OR_LINK_MODE (f);
4340 linkok = f->linkok;
4343 /* Is this a nonexistent file? If so, linkok == -1. */
4345 if (linkok == -1 && is_colored (C_MISSING))
4346 type = C_MISSING;
4347 else if (!f->stat_ok)
4349 static enum indicator_no filetype_indicator[] = FILETYPE_INDICATORS;
4350 type = filetype_indicator[f->filetype];
4352 else
4354 if (S_ISREG (mode))
4356 type = C_FILE;
4358 if ((mode & S_ISUID) != 0 && is_colored (C_SETUID))
4359 type = C_SETUID;
4360 else if ((mode & S_ISGID) != 0 && is_colored (C_SETGID))
4361 type = C_SETGID;
4362 else if (is_colored (C_CAP) && f->has_capability)
4363 type = C_CAP;
4364 else if ((mode & S_IXUGO) != 0 && is_colored (C_EXEC))
4365 type = C_EXEC;
4366 else if ((1 < f->stat.st_nlink) && is_colored (C_MULTIHARDLINK))
4367 type = C_MULTIHARDLINK;
4369 else if (S_ISDIR (mode))
4371 type = C_DIR;
4373 if ((mode & S_ISVTX) && (mode & S_IWOTH)
4374 && is_colored (C_STICKY_OTHER_WRITABLE))
4375 type = C_STICKY_OTHER_WRITABLE;
4376 else if ((mode & S_IWOTH) != 0 && is_colored (C_OTHER_WRITABLE))
4377 type = C_OTHER_WRITABLE;
4378 else if ((mode & S_ISVTX) != 0 && is_colored (C_STICKY))
4379 type = C_STICKY;
4381 else if (S_ISLNK (mode))
4382 type = C_LINK;
4383 else if (S_ISFIFO (mode))
4384 type = C_FIFO;
4385 else if (S_ISSOCK (mode))
4386 type = C_SOCK;
4387 else if (S_ISBLK (mode))
4388 type = C_BLK;
4389 else if (S_ISCHR (mode))
4390 type = C_CHR;
4391 else if (S_ISDOOR (mode))
4392 type = C_DOOR;
4393 else
4395 /* Classify a file of some other type as C_ORPHAN. */
4396 type = C_ORPHAN;
4400 /* Check the file's suffix only if still classified as C_FILE. */
4401 ext = NULL;
4402 if (type == C_FILE)
4404 /* Test if NAME has a recognized suffix. */
4406 len = strlen (name);
4407 name += len; /* Pointer to final \0. */
4408 for (ext = color_ext_list; ext != NULL; ext = ext->next)
4410 if (ext->ext.len <= len
4411 && STREQ_LEN (name - ext->ext.len, ext->ext.string,
4412 ext->ext.len))
4413 break;
4417 /* Adjust the color for orphaned symlinks. */
4418 if (type == C_LINK && !linkok)
4420 if (color_symlink_as_referent || is_colored (C_ORPHAN))
4421 type = C_ORPHAN;
4425 const struct bin_str *const s
4426 = ext ? &(ext->seq) : &color_indicator[type];
4427 if (s->string != NULL)
4429 /* Need to reset so not dealing with attribute combinations */
4430 if (is_colored (C_NORM))
4431 restore_default_color ();
4432 put_indicator (&color_indicator[C_LEFT]);
4433 put_indicator (s);
4434 put_indicator (&color_indicator[C_RIGHT]);
4435 return true;
4437 else
4438 return false;
4442 /* Output a color indicator (which may contain nulls). */
4443 static void
4444 put_indicator (const struct bin_str *ind)
4446 if (! used_color)
4448 used_color = true;
4449 prep_non_filename_text ();
4452 fwrite (ind->string, ind->len, 1, stdout);
4455 static size_t
4456 length_of_file_name_and_frills (const struct fileinfo *f)
4458 size_t len = 0;
4459 size_t name_width;
4460 char buf[MAX (LONGEST_HUMAN_READABLE + 1, INT_BUFSIZE_BOUND (uintmax_t))];
4462 if (print_inode)
4463 len += 1 + (format == with_commas
4464 ? strlen (umaxtostr (f->stat.st_ino, buf))
4465 : inode_number_width);
4467 if (print_block_size)
4468 len += 1 + (format == with_commas
4469 ? strlen (! f->stat_ok ? "?"
4470 : human_readable (ST_NBLOCKS (f->stat), buf,
4471 human_output_opts, ST_NBLOCKSIZE,
4472 output_block_size))
4473 : block_size_width);
4475 if (print_scontext)
4476 len += 1 + (format == with_commas ? strlen (f->scontext) : scontext_width);
4478 quote_name (NULL, f->name, filename_quoting_options, &name_width);
4479 len += name_width;
4481 if (indicator_style != none)
4483 char c = get_type_indicator (f->stat_ok, f->stat.st_mode, f->filetype);
4484 len += (c != 0);
4487 return len;
4490 static void
4491 print_many_per_line (void)
4493 size_t row; /* Current row. */
4494 size_t cols = calculate_columns (true);
4495 struct column_info const *line_fmt = &column_info[cols - 1];
4497 /* Calculate the number of rows that will be in each column except possibly
4498 for a short column on the right. */
4499 size_t rows = cwd_n_used / cols + (cwd_n_used % cols != 0);
4501 for (row = 0; row < rows; row++)
4503 size_t col = 0;
4504 size_t filesno = row;
4505 size_t pos = 0;
4507 /* Print the next row. */
4508 while (1)
4510 struct fileinfo const *f = sorted_file[filesno];
4511 size_t name_length = length_of_file_name_and_frills (f);
4512 size_t max_name_length = line_fmt->col_arr[col++];
4513 print_file_name_and_frills (f, pos);
4515 filesno += rows;
4516 if (filesno >= cwd_n_used)
4517 break;
4519 indent (pos + name_length, pos + max_name_length);
4520 pos += max_name_length;
4522 putchar ('\n');
4526 static void
4527 print_horizontal (void)
4529 size_t filesno;
4530 size_t pos = 0;
4531 size_t cols = calculate_columns (false);
4532 struct column_info const *line_fmt = &column_info[cols - 1];
4533 struct fileinfo const *f = sorted_file[0];
4534 size_t name_length = length_of_file_name_and_frills (f);
4535 size_t max_name_length = line_fmt->col_arr[0];
4537 /* Print first entry. */
4538 print_file_name_and_frills (f, 0);
4540 /* Now the rest. */
4541 for (filesno = 1; filesno < cwd_n_used; ++filesno)
4543 size_t col = filesno % cols;
4545 if (col == 0)
4547 putchar ('\n');
4548 pos = 0;
4550 else
4552 indent (pos + name_length, pos + max_name_length);
4553 pos += max_name_length;
4556 f = sorted_file[filesno];
4557 print_file_name_and_frills (f, pos);
4559 name_length = length_of_file_name_and_frills (f);
4560 max_name_length = line_fmt->col_arr[col];
4562 putchar ('\n');
4565 static void
4566 print_with_commas (void)
4568 size_t filesno;
4569 size_t pos = 0;
4571 for (filesno = 0; filesno < cwd_n_used; filesno++)
4573 struct fileinfo const *f = sorted_file[filesno];
4574 size_t len = length_of_file_name_and_frills (f);
4576 if (filesno != 0)
4578 char separator;
4580 if (pos + len + 2 < line_length)
4582 pos += 2;
4583 separator = ' ';
4585 else
4587 pos = 0;
4588 separator = '\n';
4591 putchar (',');
4592 putchar (separator);
4595 print_file_name_and_frills (f, pos);
4596 pos += len;
4598 putchar ('\n');
4601 /* Assuming cursor is at position FROM, indent up to position TO.
4602 Use a TAB character instead of two or more spaces whenever possible. */
4604 static void
4605 indent (size_t from, size_t to)
4607 while (from < to)
4609 if (tabsize != 0 && to / tabsize > (from + 1) / tabsize)
4611 putchar ('\t');
4612 from += tabsize - from % tabsize;
4614 else
4616 putchar (' ');
4617 from++;
4622 /* Put DIRNAME/NAME into DEST, handling '.' and '/' properly. */
4623 /* FIXME: maybe remove this function someday. See about using a
4624 non-malloc'ing version of file_name_concat. */
4626 static void
4627 attach (char *dest, const char *dirname, const char *name)
4629 const char *dirnamep = dirname;
4631 /* Copy dirname if it is not ".". */
4632 if (dirname[0] != '.' || dirname[1] != 0)
4634 while (*dirnamep)
4635 *dest++ = *dirnamep++;
4636 /* Add '/' if 'dirname' doesn't already end with it. */
4637 if (dirnamep > dirname && dirnamep[-1] != '/')
4638 *dest++ = '/';
4640 while (*name)
4641 *dest++ = *name++;
4642 *dest = 0;
4645 /* Allocate enough column info suitable for the current number of
4646 files and display columns, and initialize the info to represent the
4647 narrowest possible columns. */
4649 static void
4650 init_column_info (void)
4652 size_t i;
4653 size_t max_cols = MIN (max_idx, cwd_n_used);
4655 /* Currently allocated columns in column_info. */
4656 static size_t column_info_alloc;
4658 if (column_info_alloc < max_cols)
4660 size_t new_column_info_alloc;
4661 size_t *p;
4663 if (max_cols < max_idx / 2)
4665 /* The number of columns is far less than the display width
4666 allows. Grow the allocation, but only so that it's
4667 double the current requirements. If the display is
4668 extremely wide, this avoids allocating a lot of memory
4669 that is never needed. */
4670 column_info = xnrealloc (column_info, max_cols,
4671 2 * sizeof *column_info);
4672 new_column_info_alloc = 2 * max_cols;
4674 else
4676 column_info = xnrealloc (column_info, max_idx, sizeof *column_info);
4677 new_column_info_alloc = max_idx;
4680 /* Allocate the new size_t objects by computing the triangle
4681 formula n * (n + 1) / 2, except that we don't need to
4682 allocate the part of the triangle that we've already
4683 allocated. Check for address arithmetic overflow. */
4685 size_t column_info_growth = new_column_info_alloc - column_info_alloc;
4686 size_t s = column_info_alloc + 1 + new_column_info_alloc;
4687 size_t t = s * column_info_growth;
4688 if (s < new_column_info_alloc || t / column_info_growth != s)
4689 xalloc_die ();
4690 p = xnmalloc (t / 2, sizeof *p);
4693 /* Grow the triangle by parceling out the cells just allocated. */
4694 for (i = column_info_alloc; i < new_column_info_alloc; i++)
4696 column_info[i].col_arr = p;
4697 p += i + 1;
4700 column_info_alloc = new_column_info_alloc;
4703 for (i = 0; i < max_cols; ++i)
4705 size_t j;
4707 column_info[i].valid_len = true;
4708 column_info[i].line_len = (i + 1) * MIN_COLUMN_WIDTH;
4709 for (j = 0; j <= i; ++j)
4710 column_info[i].col_arr[j] = MIN_COLUMN_WIDTH;
4714 /* Calculate the number of columns needed to represent the current set
4715 of files in the current display width. */
4717 static size_t
4718 calculate_columns (bool by_columns)
4720 size_t filesno; /* Index into cwd_file. */
4721 size_t cols; /* Number of files across. */
4723 /* Normally the maximum number of columns is determined by the
4724 screen width. But if few files are available this might limit it
4725 as well. */
4726 size_t max_cols = MIN (max_idx, cwd_n_used);
4728 init_column_info ();
4730 /* Compute the maximum number of possible columns. */
4731 for (filesno = 0; filesno < cwd_n_used; ++filesno)
4733 struct fileinfo const *f = sorted_file[filesno];
4734 size_t name_length = length_of_file_name_and_frills (f);
4735 size_t i;
4737 for (i = 0; i < max_cols; ++i)
4739 if (column_info[i].valid_len)
4741 size_t idx = (by_columns
4742 ? filesno / ((cwd_n_used + i) / (i + 1))
4743 : filesno % (i + 1));
4744 size_t real_length = name_length + (idx == i ? 0 : 2);
4746 if (column_info[i].col_arr[idx] < real_length)
4748 column_info[i].line_len += (real_length
4749 - column_info[i].col_arr[idx]);
4750 column_info[i].col_arr[idx] = real_length;
4751 column_info[i].valid_len = (column_info[i].line_len
4752 < line_length);
4758 /* Find maximum allowed columns. */
4759 for (cols = max_cols; 1 < cols; --cols)
4761 if (column_info[cols - 1].valid_len)
4762 break;
4765 return cols;
4768 void
4769 usage (int status)
4771 if (status != EXIT_SUCCESS)
4772 emit_try_help ();
4773 else
4775 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name);
4776 fputs (_("\
4777 List information about the FILEs (the current directory by default).\n\
4778 Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.\n\
4779 "), stdout);
4781 emit_mandatory_arg_note ();
4783 fputs (_("\
4784 -a, --all do not ignore entries starting with .\n\
4785 -A, --almost-all do not list implied . and ..\n\
4786 --author with -l, print the author of each file\n\
4787 -b, --escape print C-style escapes for nongraphic characters\n\
4788 "), stdout);
4789 fputs (_("\
4790 --block-size=SIZE scale sizes by SIZE before printing them; e.g.,\n\
4791 '--block-size=M' prints sizes in units of\n\
4792 1,048,576 bytes; see SIZE format below\n\
4793 -B, --ignore-backups do not list implied entries ending with ~\n\
4794 -c with -lt: sort by, and show, ctime (time of last\n\
4795 modification of file status information);\n\
4796 with -l: show ctime and sort by name;\n\
4797 otherwise: sort by ctime, newest first\n\
4798 "), stdout);
4799 fputs (_("\
4800 -C list entries by columns\n\
4801 --color[=WHEN] colorize the output; WHEN can be 'always' (default\
4803 if omitted), 'auto', or 'never'; more info below\
4805 -d, --directory list directories themselves, not their contents\n\
4806 -D, --dired generate output designed for Emacs' dired mode\n\
4807 "), stdout);
4808 fputs (_("\
4809 -f do not sort, enable -aU, disable -ls --color\n\
4810 -F, --classify append indicator (one of */=>@|) to entries\n\
4811 --file-type likewise, except do not append '*'\n\
4812 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
4813 single-column -1, verbose -l, vertical -C\n\
4814 --full-time like -l --time-style=full-iso\n\
4815 "), stdout);
4816 fputs (_("\
4817 -g like -l, but do not list owner\n\
4818 "), stdout);
4819 fputs (_("\
4820 --group-directories-first\n\
4821 group directories before files;\n\
4822 can be augmented with a --sort option, but any\n\
4823 use of --sort=none (-U) disables grouping\n\
4824 "), stdout);
4825 fputs (_("\
4826 -G, --no-group in a long listing, don't print group names\n\
4827 -h, --human-readable with -l and/or -s, print human readable sizes\n\
4828 (e.g., 1K 234M 2G)\n\
4829 --si likewise, but use powers of 1000 not 1024\n\
4830 "), stdout);
4831 fputs (_("\
4832 -H, --dereference-command-line\n\
4833 follow symbolic links listed on the command line\n\
4834 --dereference-command-line-symlink-to-dir\n\
4835 follow each command line symbolic link\n\
4836 that points to a directory\n\
4837 --hide=PATTERN do not list implied entries matching shell PATTERN\
4839 (overridden by -a or -A)\n\
4840 "), stdout);
4841 fputs (_("\
4842 --indicator-style=WORD append indicator with style WORD to entry names:\
4844 none (default), slash (-p),\n\
4845 file-type (--file-type), classify (-F)\n\
4846 -i, --inode print the index number of each file\n\
4847 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\
4849 -k, --kibibytes default to 1024-byte blocks for disk usage\n\
4850 "), stdout);
4851 fputs (_("\
4852 -l use a long listing format\n\
4853 -L, --dereference when showing file information for a symbolic\n\
4854 link, show information for the file the link\n\
4855 references rather than for the link itself\n\
4856 -m fill width with a comma separated list of entries\
4858 "), stdout);
4859 fputs (_("\
4860 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
4861 -N, --literal print raw entry names (don't treat e.g. control\n\
4862 characters specially)\n\
4863 -o like -l, but do not list group information\n\
4864 -p, --indicator-style=slash\n\
4865 append / indicator to directories\n\
4866 "), stdout);
4867 fputs (_("\
4868 -q, --hide-control-chars print ? instead of nongraphic characters\n\
4869 --show-control-chars show nongraphic characters as-is (the default,\n\
4870 unless program is 'ls' and output is a terminal)\
4872 -Q, --quote-name enclose entry names in double quotes\n\
4873 --quoting-style=WORD use quoting style WORD for entry names:\n\
4874 literal, locale, shell, shell-always, c, escape\
4876 "), stdout);
4877 fputs (_("\
4878 -r, --reverse reverse order while sorting\n\
4879 -R, --recursive list subdirectories recursively\n\
4880 -s, --size print the allocated size of each file, in blocks\n\
4881 "), stdout);
4882 fputs (_("\
4883 -S sort by file size, largest first\n\
4884 --sort=WORD sort by WORD instead of name: none (-U), size (-S)\
4885 ,\n\
4886 time (-t), version (-v), extension (-X)\n\
4887 --time=WORD with -l, show time as WORD instead of default\n\
4888 modification time: atime or access or use (-u);\
4890 ctime or status (-c); also use specified time\n\
4891 as sort key if --sort=time (newest first)\n\
4892 "), stdout);
4893 fputs (_("\
4894 --time-style=STYLE with -l, show times using style STYLE:\n\
4895 full-iso, long-iso, iso, locale, or +FORMAT;\n\
4896 FORMAT is interpreted like in 'date'; if FORMAT\
4898 is FORMAT1<newline>FORMAT2, then FORMAT1 applies\
4900 to non-recent files and FORMAT2 to recent files;\
4902 if STYLE is prefixed with 'posix-', STYLE\n\
4903 takes effect only outside the POSIX locale\n\
4904 "), stdout);
4905 fputs (_("\
4906 -t sort by modification time, newest first\n\
4907 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
4908 "), stdout);
4909 fputs (_("\
4910 -u with -lt: sort by, and show, access time;\n\
4911 with -l: show access time and sort by name;\n\
4912 otherwise: sort by access time, newest first\n\
4913 -U do not sort; list entries in directory order\n\
4914 -v natural sort of (version) numbers within text\n\
4915 "), stdout);
4916 fputs (_("\
4917 -w, --width=COLS assume screen width instead of current value\n\
4918 -x list entries by lines instead of by columns\n\
4919 -X sort alphabetically by entry extension\n\
4920 -Z, --context print any security context of each file\n\
4921 -1 list one file per line. Avoid '\\n' with -q or -b\
4923 "), stdout);
4924 fputs (HELP_OPTION_DESCRIPTION, stdout);
4925 fputs (VERSION_OPTION_DESCRIPTION, stdout);
4926 emit_size_note ();
4927 fputs (_("\
4929 Using color to distinguish file types is disabled both by default and\n\
4930 with --color=never. With --color=auto, ls emits color codes only when\n\
4931 standard output is connected to a terminal. The LS_COLORS environment\n\
4932 variable can change the settings. Use the dircolors command to set it.\n\
4933 "), stdout);
4934 fputs (_("\
4936 Exit status:\n\
4937 0 if OK,\n\
4938 1 if minor problems (e.g., cannot access subdirectory),\n\
4939 2 if serious trouble (e.g., cannot access command-line argument).\n\
4940 "), stdout);
4941 emit_ancillary_info (PROGRAM_NAME);
4943 exit (status);