1 /* 'dir', 'vdir' and 'ls' directory listing programs for GNU.
2 Copyright (C) 1985-2024 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 <https://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.
28 the output format depends on whether the output
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>. */
40 #include <sys/types.h>
46 #include <sys/ioctl.h>
48 #ifdef WINSIZE_IN_PTEM
49 # include <sys/stream.h>
50 # include <sys/ptem.h>
58 #include <selinux/selinux.h>
61 #if HAVE_LANGINFO_CODESET
62 # include <langinfo.h>
65 /* Use SA_NOCLDSTOP as a proxy for whether the sigaction machinery is
68 # define SA_NOCLDSTOP 0
69 # define sigprocmask(How, Set, Oset) /* empty */
71 # if ! HAVE_SIGINTERRUPT
72 # define siginterrupt(sig, flag) /* empty */
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. */
90 #include "c-strcase.h"
92 #include "filenamecat.h"
93 #include "hard-locale.h"
97 #include "filevercmp.h"
100 #include "mbswidth.h"
105 #include "stat-size.h"
106 #include "stat-time.h"
107 #include "strftime.h"
108 #include "xdectoint.h"
110 #include "xstrtol-error.h"
111 #include "areadlink.h"
112 #include "dircolors.h"
113 #include "xgethostname.h"
115 #include "canonicalize.h"
118 /* Include <sys/capability.h> last to avoid a clash of <sys/types.h>
119 include guards with some premature versions of libcap.
120 For more details, see <https://bugzilla.redhat.com/483548>. */
122 # include <sys/capability.h>
125 #define PROGRAM_NAME (ls_mode == LS_LS ? "ls" \
126 : (ls_mode == LS_MULTI_COL \
130 proper_name ("Richard M. Stallman"), \
131 proper_name ("David MacKenzie")
133 #define obstack_chunk_alloc malloc
134 #define obstack_chunk_free free
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
150 #if READDIR_LIES_ABOUT_MOUNTPOINT_D_INO
151 # define RELIABLE_D_INO(dp) NOT_AN_INODE_NUMBER
153 # define RELIABLE_D_INO(dp) D_INO (dp)
156 #if ! HAVE_STRUCT_STAT_ST_AUTHOR
157 # define st_author st_uid
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 static_assert (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 \
191 ACL_T_LSM_CONTEXT_ONLY
,
200 /* For symbolic link, name of the file linked to, otherwise zero. */
203 /* For terminal hyperlinks. */
208 enum filetype filetype
;
210 /* For symbolic link and long listing, st_mode of file linked to, otherwise
214 /* security context. */
219 /* For symbolic link and color printing, true if linked-to file
220 exists, otherwise false. */
223 /* For long listings, true if the file has an access control list,
224 or a security context. */
225 enum acl_type acl_type
;
227 /* For color listings, true if a regular file has capability info. */
230 /* Whether file name needs quoting. tri-state with -1 == unknown. */
233 /* Cached screen width (including quoting). */
237 #define LEN_STR_PAIR(s) sizeof (s) - 1, s
239 /* Null is a valid character in a color indicator (think about Epson
240 printers, for example) so we have to use a length/buffer string
245 size_t len
; /* Number of bytes */
246 char const *string
; /* Pointer to the same */
250 # define tcgetpgrp(Fd) 0
253 static size_t quote_name (char const *name
,
254 struct quoting_options
const *options
,
255 int needs_general_quoting
,
256 const struct bin_str
*color
,
257 bool allow_pad
, struct obstack
*stack
,
258 char const *absolute_name
);
259 static size_t quote_name_buf (char **inbuf
, size_t bufsize
, char *name
,
260 struct quoting_options
const *options
,
261 int needs_general_quoting
, size_t *width
,
263 static int decode_switches (int argc
, char **argv
);
264 static bool file_ignored (char const *name
);
265 static uintmax_t gobble_file (char const *name
, enum filetype type
,
266 ino_t inode
, bool command_line_arg
,
267 char const *dirname
);
268 static const struct bin_str
* get_color_indicator (const struct fileinfo
*f
,
269 bool symlink_target
);
270 static bool print_color_indicator (const struct bin_str
*ind
);
271 static void put_indicator (const struct bin_str
*ind
);
272 static void add_ignore_pattern (char const *pattern
);
273 static void attach (char *dest
, char const *dirname
, char const *name
);
274 static void clear_files (void);
275 static void extract_dirs_from_files (char const *dirname
,
276 bool command_line_arg
);
277 static void get_link_name (char const *filename
, struct fileinfo
*f
,
278 bool command_line_arg
);
279 static void indent (size_t from
, size_t to
);
280 static size_t calculate_columns (bool by_columns
);
281 static void print_current_files (void);
282 static void print_dir (char const *name
, char const *realname
,
283 bool command_line_arg
);
284 static size_t print_file_name_and_frills (const struct fileinfo
*f
,
286 static void print_horizontal (void);
287 static int format_user_width (uid_t u
);
288 static int format_group_width (gid_t g
);
289 static void print_long_format (const struct fileinfo
*f
);
290 static void print_many_per_line (void);
291 static size_t print_name_with_quoting (const struct fileinfo
*f
,
293 struct obstack
*stack
,
295 static void prep_non_filename_text (void);
296 static bool print_type_indicator (bool stat_ok
, mode_t mode
,
298 static void print_with_separator (char sep
);
299 static void queue_directory (char const *name
, char const *realname
,
300 bool command_line_arg
);
301 static void sort_files (void);
302 static void parse_ls_color (void);
304 static int getenv_quoting_style (void);
306 static size_t quote_name_width (char const *name
,
307 struct quoting_options
const *options
,
308 int needs_general_quoting
);
310 /* Initial size of hash table.
311 Most hierarchies are likely to be shallower than this. */
312 enum { INITIAL_TABLE_SIZE
= 30 };
314 /* The set of 'active' directories, from the current command-line argument
315 to the level in the hierarchy at which files are being listed.
316 A directory is represented by its device and inode numbers (struct dev_ino).
317 A directory is added to this set when ls begins listing it or its
318 entries, and it is removed from the set just after ls has finished
319 processing it. This set is used solely to detect loops, e.g., with
320 mkdir loop; cd loop; ln -s ../loop sub; ls -RL */
321 static Hash_table
*active_dir_set
;
323 #define LOOP_DETECT (!!active_dir_set)
325 /* The table of files in the current directory:
327 'cwd_file' points to a vector of 'struct fileinfo', one per file.
328 'cwd_n_alloc' is the number of elements space has been allocated for.
329 'cwd_n_used' is the number actually in use. */
331 /* Address of block containing the files that are described. */
332 static struct fileinfo
*cwd_file
;
334 /* Length of block that 'cwd_file' points to, measured in files. */
335 static size_t cwd_n_alloc
;
337 /* Index of first unused slot in 'cwd_file'. */
338 static size_t cwd_n_used
;
340 /* Whether files needs may need padding due to quoting. */
341 static bool cwd_some_quoted
;
343 /* Whether quoting style _may_ add outer quotes,
344 and whether aligning those is useful. */
345 static bool align_variable_outer_quotes
;
347 /* Vector of pointers to files, in proper sorted order, and the number
348 of entries allocated for it. */
349 static void **sorted_file
;
350 static size_t sorted_file_alloc
;
352 /* When true, in a color listing, color each symlink name according to the
353 type of file it points to. Otherwise, color them according to the 'ln'
354 directive in LS_COLORS. Dangling (orphan) symlinks are treated specially,
355 regardless. This is set when 'ln=target' appears in LS_COLORS. */
357 static bool color_symlink_as_referent
;
359 static char const *hostname
;
361 /* Mode of appropriate file for coloring. */
363 file_or_link_mode (struct fileinfo
const *file
)
365 return (color_symlink_as_referent
&& file
->linkok
366 ? file
->linkmode
: file
->stat
.st_mode
);
370 /* Record of one pending directory waiting to be listed. */
375 /* If the directory is actually the file pointed to by a symbolic link we
376 were told to list, 'realname' will contain the name of the symbolic
377 link, otherwise zero. */
379 bool command_line_arg
;
380 struct pending
*next
;
383 static struct pending
*pending_dirs
;
385 /* Current time in seconds and nanoseconds since 1970, updated as
386 needed when deciding whether a file is recent. */
388 static struct timespec current_time
;
390 static bool print_scontext
;
391 static char UNKNOWN_SECURITY_CONTEXT
[] = "?";
393 /* Whether any of the files has an ACL. This affects the width of the
396 static bool any_has_acl
;
398 /* The number of columns to use for columns containing inode numbers,
399 block sizes, link counts, owners, groups, authors, major device
400 numbers, minor device numbers, and file sizes, respectively. */
402 static int inode_number_width
;
403 static int block_size_width
;
404 static int nlink_width
;
405 static int scontext_width
;
406 static int owner_width
;
407 static int group_width
;
408 static int author_width
;
409 static int major_device_number_width
;
410 static int minor_device_number_width
;
411 static int file_size_width
;
415 /* long_format for lots of info, one per line.
416 one_per_line for just names, one per line.
417 many_per_line for just names, many per line, sorted vertically.
418 horizontal for just names, many per line, sorted horizontally.
419 with_commas for just names, many per line, separated by commas.
421 -l (and other options that imply -l), -1, -C, -x and -m control
426 long_format
, /* -l and other options that imply -l */
427 one_per_line
, /* -1 */
428 many_per_line
, /* -C */
433 static enum format format
;
435 /* 'full-iso' uses full ISO-style dates and times. 'long-iso' uses longer
436 ISO-style timestamps, though shorter than 'full-iso'. 'iso' uses shorter
437 ISO-style timestamps. 'locale' uses locale-dependent timestamps. */
440 full_iso_time_style
, /* --time-style=full-iso */
441 long_iso_time_style
, /* --time-style=long-iso */
442 iso_time_style
, /* --time-style=iso */
443 locale_time_style
/* --time-style=locale */
446 static char const *const time_style_args
[] =
448 "full-iso", "long-iso", "iso", "locale", nullptr
450 static enum time_style
const time_style_types
[] =
452 full_iso_time_style
, long_iso_time_style
, iso_time_style
,
455 ARGMATCH_VERIFY (time_style_args
, time_style_types
);
457 /* Type of time to print or sort by. Controlled by -c and -u.
458 The values of each item of this enum are important since they are
459 used as indices in the sort functions array (see sort_files()). */
463 time_mtime
= 0, /* default */
466 time_btime
, /* birth time */
467 time_numtypes
/* the number of elements of this enum */
470 static enum time_type time_type
;
472 /* The file characteristic to sort by. Controlled by -t, -S, -U, -X, -v.
473 The values of each item of this enum are important since they are
474 used as indices in the sort functions array (see sort_files()). */
478 sort_name
= 0, /* default */
479 sort_extension
, /* -X */
482 sort_version
, /* -v */
483 sort_time
, /* -t; must be second to last */
484 sort_none
, /* -U; must be last */
485 sort_numtypes
/* the number of elements of this enum */
488 static enum sort_type sort_type
;
490 /* Direction of sort.
491 false means highest first if numeric,
492 lowest first if alphabetic;
493 these are the defaults.
494 true means the opposite order in each case. -r */
496 static bool sort_reverse
;
498 /* True means to display owner information. -g turns this off. */
500 static bool print_owner
= true;
502 /* True means to display author information. */
504 static bool print_author
;
506 /* True means to display group information. -G and -o turn this off. */
508 static bool print_group
= true;
510 /* True means print the user and group id's as numbers rather
513 static bool numeric_ids
;
515 /* True means mention the size in blocks of each file. -s */
517 static bool print_block_size
;
519 /* Human-readable options for output, when printing block counts. */
520 static int human_output_opts
;
522 /* The units to use when printing block counts. */
523 static uintmax_t output_block_size
;
525 /* Likewise, but for file sizes. */
526 static int file_human_output_opts
;
527 static uintmax_t file_output_block_size
= 1;
529 /* Follow the output with a special string. Using this format,
530 Emacs' dired mode starts up twice as fast, and can handle all
531 strange characters in file names. */
534 /* 'none' means don't mention the type of files.
535 'slash' means mention directories only, with a '/'.
536 'file_type' means mention file types.
537 'classify' means mention file types and mark executables.
539 Controlled by -F, -p, and --indicator-style. */
543 none
= 0, /* --indicator-style=none (default) */
544 slash
, /* -p, --indicator-style=slash */
545 file_type
, /* --indicator-style=file-type */
546 classify
/* -F, --indicator-style=classify */
549 static enum indicator_style indicator_style
;
551 /* Names of indicator styles. */
552 static char const *const indicator_style_args
[] =
554 "none", "slash", "file-type", "classify", nullptr
556 static enum indicator_style
const indicator_style_types
[] =
558 none
, slash
, file_type
, classify
560 ARGMATCH_VERIFY (indicator_style_args
, indicator_style_types
);
562 /* True means use colors to mark types. Also define the different
563 colors as well as the stuff for the LS_COLORS environment variable.
564 The LS_COLORS variable is now in a termcap-like format. */
566 static bool print_with_color
;
568 static bool print_hyperlink
;
570 /* Whether we used any colors in the output so far. If so, we will
571 need to restore the default color later. If not, we will need to
572 call prep_non_filename_text before using color for the first time. */
574 static bool used_color
= false;
578 when_never
, /* 0: default or --color=never */
579 when_always
, /* 1: --color=always */
580 when_if_tty
/* 2: --color=tty */
583 enum Dereference_symlink
585 DEREF_UNDEFINED
= 0, /* default */
587 DEREF_COMMAND_LINE_ARGUMENTS
, /* -H */
588 DEREF_COMMAND_LINE_SYMLINK_TO_DIR
, /* the default, in certain cases */
589 DEREF_ALWAYS
/* -L */
594 C_LEFT
, C_RIGHT
, C_END
, C_RESET
, C_NORM
, C_FILE
, C_DIR
, C_LINK
,
596 C_BLK
, C_CHR
, C_MISSING
, C_ORPHAN
, C_EXEC
, C_DOOR
, C_SETUID
, C_SETGID
,
597 C_STICKY
, C_OTHER_WRITABLE
, C_STICKY_OTHER_WRITABLE
, C_CAP
, C_MULTIHARDLINK
,
601 static char const *const indicator_name
[]=
603 "lc", "rc", "ec", "rs", "no", "fi", "di", "ln", "pi", "so",
604 "bd", "cd", "mi", "or", "ex", "do", "su", "sg", "st",
605 "ow", "tw", "ca", "mh", "cl", nullptr
608 struct color_ext_type
610 struct bin_str ext
; /* The extension we're looking for */
611 struct bin_str seq
; /* The sequence to output when we do */
612 bool exact_match
; /* Whether to compare case insensitively */
613 struct color_ext_type
*next
; /* Next in list */
616 static struct bin_str color_indicator
[] =
618 { LEN_STR_PAIR ("\033[") }, /* lc: Left of color sequence */
619 { LEN_STR_PAIR ("m") }, /* rc: Right of color sequence */
620 { 0, nullptr }, /* ec: End color (replaces lc+rs+rc) */
621 { LEN_STR_PAIR ("0") }, /* rs: Reset to ordinary colors */
622 { 0, nullptr }, /* no: Normal */
623 { 0, nullptr }, /* fi: File: default */
624 { LEN_STR_PAIR ("01;34") }, /* di: Directory: bright blue */
625 { LEN_STR_PAIR ("01;36") }, /* ln: Symlink: bright cyan */
626 { LEN_STR_PAIR ("33") }, /* pi: Pipe: yellow/brown */
627 { LEN_STR_PAIR ("01;35") }, /* so: Socket: bright magenta */
628 { LEN_STR_PAIR ("01;33") }, /* bd: Block device: bright yellow */
629 { LEN_STR_PAIR ("01;33") }, /* cd: Char device: bright yellow */
630 { 0, nullptr }, /* mi: Missing file: undefined */
631 { 0, nullptr }, /* or: Orphaned symlink: undefined */
632 { LEN_STR_PAIR ("01;32") }, /* ex: Executable: bright green */
633 { LEN_STR_PAIR ("01;35") }, /* do: Door: bright magenta */
634 { LEN_STR_PAIR ("37;41") }, /* su: setuid: white on red */
635 { LEN_STR_PAIR ("30;43") }, /* sg: setgid: black on yellow */
636 { LEN_STR_PAIR ("37;44") }, /* st: sticky: black on blue */
637 { LEN_STR_PAIR ("34;42") }, /* ow: other-writable: blue on green */
638 { LEN_STR_PAIR ("30;42") }, /* tw: ow w/ sticky: black on green */
639 { 0, nullptr }, /* ca: disabled by default */
640 { 0, nullptr }, /* mh: disabled by default */
641 { LEN_STR_PAIR ("\033[K") }, /* cl: clear to end of line */
644 /* A list mapping file extensions to corresponding display sequence. */
645 static struct color_ext_type
*color_ext_list
= nullptr;
647 /* Buffer for color sequences */
648 static char *color_buf
;
650 /* True means to check for orphaned symbolic link, for displaying
651 colors, or to group symlink to directories with other dirs. */
653 static bool check_symlink_mode
;
655 /* True means mention the inode number of each file. -i */
657 static bool print_inode
;
659 /* What to do with symbolic links. Affected by -d, -F, -H, -l (and
660 other options that imply -l), and -L. */
662 static enum Dereference_symlink dereference
;
664 /* True means when a directory is found, display info on its
667 static bool recursive
;
669 /* True means when an argument is a directory name, display info
672 static bool immediate_dirs
;
674 /* True means that directories are grouped before files. */
676 static bool directories_first
;
678 /* Which files to ignore. */
682 /* Ignore files whose names start with '.', and files specified by
683 --hide and --ignore. */
686 /* Ignore '.', '..', and files specified by --ignore. */
687 IGNORE_DOT_AND_DOTDOT
,
689 /* Ignore only files specified by --ignore. */
693 /* A linked list of shell-style globbing patterns. If a non-argument
694 file name matches any of these patterns, it is ignored.
695 Controlled by -I. Multiple -I options accumulate.
696 The -B option adds '*~' and '.*~' to this list. */
698 struct ignore_pattern
701 struct ignore_pattern
*next
;
704 static struct ignore_pattern
*ignore_patterns
;
706 /* Similar to IGNORE_PATTERNS, except that -a or -A causes this
707 variable itself to be ignored. */
708 static struct ignore_pattern
*hide_patterns
;
710 /* True means output nongraphic chars in file names as '?'.
711 (-q, --hide-control-chars)
712 qmark_funny_chars and the quoting style (-Q, --quoting-style=WORD) are
713 independent. The algorithm is: first, obey the quoting style to get a
714 string representing the file name; then, if qmark_funny_chars is set,
715 replace all nonprintable chars in that string with '?'. It's necessary
716 to replace nonprintable chars even in quoted strings, because we don't
717 want to mess up the terminal if control chars get sent to it, and some
718 quoting methods pass through control chars as-is. */
719 static bool qmark_funny_chars
;
721 /* Quoting options for file and dir name output. */
723 static struct quoting_options
*filename_quoting_options
;
724 static struct quoting_options
*dirname_quoting_options
;
726 /* The number of chars per hardware tab stop. Setting this to zero
727 inhibits the use of TAB characters for separating columns. -T */
728 static size_t tabsize
;
730 /* True means print each directory name before listing it. */
732 static bool print_dir_name
;
734 /* The line length to use for breaking lines in many-per-line format.
735 Can be set with -w. If zero, there is no limit. */
737 static size_t line_length
;
739 /* The local time zone rules, as per the TZ environment variable. */
741 static timezone_t localtz
;
743 /* If true, the file listing format requires that stat be called on
746 static bool format_needs_stat
;
748 /* Similar to 'format_needs_stat', but set if only the file type is
751 static bool format_needs_type
;
753 /* An arbitrary limit on the number of bytes in a printed timestamp.
754 This is set to a relatively small value to avoid the need to worry
755 about denial-of-service attacks on servers that run "ls" on behalf
756 of remote clients. 1000 bytes should be enough for any practical
759 enum { TIME_STAMP_LEN_MAXIMUM
= MAX (1000, INT_STRLEN_BOUND (time_t)) };
761 /* strftime formats for non-recent and recent files, respectively, in
764 static char const *long_time_format
[2] =
766 /* strftime format for non-recent files (older than 6 months), in
767 -l output. This should contain the year, month and day (at
768 least), in an order that is understood by people in your
769 locale's territory. Please try to keep the number of used
770 screen columns small, because many people work in windows with
771 only 80 columns. But make this as wide as the other string
772 below, for recent files. */
773 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
774 so be wary of using variable width fields from the locale.
775 Note %b is handled specially by ls and aligned correctly.
776 Note also that specifying a width as in %5b is erroneous as strftime
777 will count bytes rather than characters in multibyte locales. */
779 /* strftime format for recent files (younger than 6 months), in -l
780 output. This should contain the month, day and time (at
781 least), in an order that is understood by people in your
782 locale's territory. Please try to keep the number of used
783 screen columns small, because many people work in windows with
784 only 80 columns. But make this as wide as the other string
785 above, for non-recent files. */
786 /* TRANSLATORS: ls output needs to be aligned for ease of reading,
787 so be wary of using variable width fields from the locale.
788 Note %b is handled specially by ls and aligned correctly.
789 Note also that specifying a width as in %5b is erroneous as strftime
790 will count bytes rather than characters in multibyte locales. */
794 /* The set of signals that are caught. */
796 static sigset_t caught_signals
;
798 /* If nonzero, the value of the pending fatal signal. */
800 static sig_atomic_t volatile interrupt_signal
;
802 /* A count of the number of pending stop signals that have been received. */
804 static sig_atomic_t volatile stop_signal_count
;
806 /* Desired exit status. */
808 static int exit_status
;
813 /* "ls" had a minor problem. E.g., while processing a directory,
814 ls obtained the name of an entry via readdir, yet was later
815 unable to stat that name. This happens when listing a directory
816 in which entries are actively being removed or renamed. */
817 LS_MINOR_PROBLEM
= 1,
819 /* "ls" had more serious trouble (e.g., memory exhausted, invalid
820 option or failure to stat a command line argument. */
824 /* For long options that have no equivalent short option, use a
825 non-character as a pseudo short option, starting with CHAR_MAX + 1. */
828 AUTHOR_OPTION
= CHAR_MAX
+ 1,
831 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION
,
832 FILE_TYPE_INDICATOR_OPTION
,
835 GROUP_DIRECTORIES_FIRST_OPTION
,
838 INDICATOR_STYLE_OPTION
,
839 QUOTING_STYLE_OPTION
,
840 SHOW_CONTROL_CHARS_OPTION
,
848 static struct option
const long_options
[] =
850 {"all", no_argument
, nullptr, 'a'},
851 {"escape", no_argument
, nullptr, 'b'},
852 {"directory", no_argument
, nullptr, 'd'},
853 {"dired", no_argument
, nullptr, 'D'},
854 {"full-time", no_argument
, nullptr, FULL_TIME_OPTION
},
855 {"group-directories-first", no_argument
, nullptr,
856 GROUP_DIRECTORIES_FIRST_OPTION
},
857 {"human-readable", no_argument
, nullptr, 'h'},
858 {"inode", no_argument
, nullptr, 'i'},
859 {"kibibytes", no_argument
, nullptr, 'k'},
860 {"numeric-uid-gid", no_argument
, nullptr, 'n'},
861 {"no-group", no_argument
, nullptr, 'G'},
862 {"hide-control-chars", no_argument
, nullptr, 'q'},
863 {"reverse", no_argument
, nullptr, 'r'},
864 {"size", no_argument
, nullptr, 's'},
865 {"width", required_argument
, nullptr, 'w'},
866 {"almost-all", no_argument
, nullptr, 'A'},
867 {"ignore-backups", no_argument
, nullptr, 'B'},
868 {"classify", optional_argument
, nullptr, 'F'},
869 {"file-type", no_argument
, nullptr, FILE_TYPE_INDICATOR_OPTION
},
870 {"si", no_argument
, nullptr, SI_OPTION
},
871 {"dereference-command-line", no_argument
, nullptr, 'H'},
872 {"dereference-command-line-symlink-to-dir", no_argument
, nullptr,
873 DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION
},
874 {"hide", required_argument
, nullptr, HIDE_OPTION
},
875 {"ignore", required_argument
, nullptr, 'I'},
876 {"indicator-style", required_argument
, nullptr, INDICATOR_STYLE_OPTION
},
877 {"dereference", no_argument
, nullptr, 'L'},
878 {"literal", no_argument
, nullptr, 'N'},
879 {"quote-name", no_argument
, nullptr, 'Q'},
880 {"quoting-style", required_argument
, nullptr, QUOTING_STYLE_OPTION
},
881 {"recursive", no_argument
, nullptr, 'R'},
882 {"format", required_argument
, nullptr, FORMAT_OPTION
},
883 {"show-control-chars", no_argument
, nullptr, SHOW_CONTROL_CHARS_OPTION
},
884 {"sort", required_argument
, nullptr, SORT_OPTION
},
885 {"tabsize", required_argument
, nullptr, 'T'},
886 {"time", required_argument
, nullptr, TIME_OPTION
},
887 {"time-style", required_argument
, nullptr, TIME_STYLE_OPTION
},
888 {"zero", no_argument
, nullptr, ZERO_OPTION
},
889 {"color", optional_argument
, nullptr, COLOR_OPTION
},
890 {"hyperlink", optional_argument
, nullptr, HYPERLINK_OPTION
},
891 {"block-size", required_argument
, nullptr, BLOCK_SIZE_OPTION
},
892 {"context", no_argument
, 0, 'Z'},
893 {"author", no_argument
, nullptr, AUTHOR_OPTION
},
894 {GETOPT_HELP_OPTION_DECL
},
895 {GETOPT_VERSION_OPTION_DECL
},
896 {nullptr, 0, nullptr, 0}
899 static char const *const format_args
[] =
901 "verbose", "long", "commas", "horizontal", "across",
902 "vertical", "single-column", nullptr
904 static enum format
const format_types
[] =
906 long_format
, long_format
, with_commas
, horizontal
, horizontal
,
907 many_per_line
, one_per_line
909 ARGMATCH_VERIFY (format_args
, format_types
);
911 static char const *const sort_args
[] =
913 "none", "time", "size", "extension", "version", "width", nullptr
915 static enum sort_type
const sort_types
[] =
917 sort_none
, sort_time
, sort_size
, sort_extension
, sort_version
, sort_width
919 ARGMATCH_VERIFY (sort_args
, sort_types
);
921 static char const *const time_args
[] =
923 "atime", "access", "use",
925 "mtime", "modification",
929 static enum time_type
const time_types
[] =
931 time_atime
, time_atime
, time_atime
,
932 time_ctime
, time_ctime
,
933 time_mtime
, time_mtime
,
934 time_btime
, time_btime
,
936 ARGMATCH_VERIFY (time_args
, time_types
);
938 static char const *const when_args
[] =
940 /* force and none are for compatibility with another color-ls version */
941 "always", "yes", "force",
942 "never", "no", "none",
943 "auto", "tty", "if-tty", nullptr
945 static enum when_type
const when_types
[] =
947 when_always
, when_always
, when_always
,
948 when_never
, when_never
, when_never
,
949 when_if_tty
, when_if_tty
, when_if_tty
951 ARGMATCH_VERIFY (when_args
, when_types
);
953 /* Information about filling a column. */
961 /* Array with information about column fullness. */
962 static struct column_info
*column_info
;
964 /* Maximum number of columns ever possible for this display. */
965 static size_t max_idx
;
967 /* The minimum width of a column is 3: 1 character for the name and 2
968 for the separating white space. */
969 enum { MIN_COLUMN_WIDTH
= 3 };
972 /* This zero-based index is for the --dired option. It is incremented
973 for each byte of output generated by this program so that the beginning
974 and ending indices (in that output) of every file name can be recorded
975 and later output themselves. */
976 static off_t dired_pos
;
979 dired_outbyte (char c
)
985 /* Output the buffer S, of length S_LEN, and increment DIRED_POS by S_LEN. */
987 dired_outbuf (char const *s
, size_t s_len
)
990 fwrite (s
, sizeof *s
, s_len
, stdout
);
993 /* Output the string S, and increment DIRED_POS by its length. */
995 dired_outstring (char const *s
)
997 dired_outbuf (s
, strlen (s
));
1004 dired_outstring (" ");
1007 /* With --dired, store pairs of beginning and ending indices of file names. */
1008 static struct obstack dired_obstack
;
1010 /* With --dired, store pairs of beginning and ending indices of any
1011 directory names that appear as headers (just before 'total' line)
1012 for lists of directory entries. Such directory names are seen when
1013 listing hierarchies using -R and when a directory is listed with at
1014 least one other command line argument. */
1015 static struct obstack subdired_obstack
;
1017 /* Save the current index on the specified obstack, OBS. */
1019 push_current_dired_pos (struct obstack
*obs
)
1022 obstack_grow (obs
, &dired_pos
, sizeof dired_pos
);
1025 /* With -R, this stack is used to help detect directory cycles.
1026 The device/inode pairs on this stack mirror the pairs in the
1027 active_dir_set hash table. */
1028 static struct obstack dev_ino_obstack
;
1030 /* Push a pair onto the device/inode stack. */
1032 dev_ino_push (dev_t dev
, ino_t ino
)
1036 int dev_ino_size
= sizeof *di
;
1037 obstack_blank (&dev_ino_obstack
, dev_ino_size
);
1038 vdi
= obstack_next_free (&dev_ino_obstack
);
1045 /* Pop a dev/ino struct off the global dev_ino_obstack
1046 and return that struct. */
1047 static struct dev_ino
1052 int dev_ino_size
= sizeof *di
;
1053 affirm (dev_ino_size
<= obstack_object_size (&dev_ino_obstack
));
1054 obstack_blank_fast (&dev_ino_obstack
, -dev_ino_size
);
1055 vdi
= obstack_next_free (&dev_ino_obstack
);
1061 assert_matching_dev_ino (char const *name
, struct dev_ino di
)
1063 MAYBE_UNUSED
struct stat sb
;
1064 assure (0 <= stat (name
, &sb
));
1065 assure (sb
.st_dev
== di
.st_dev
);
1066 assure (sb
.st_ino
== di
.st_ino
);
1069 static char eolbyte
= '\n';
1071 /* Write to standard output PREFIX, followed by the quoting style and
1072 a space-separated list of the integers stored in OS all on one line. */
1075 dired_dump_obstack (char const *prefix
, struct obstack
*os
)
1079 n_pos
= obstack_object_size (os
) / sizeof (dired_pos
);
1082 off_t
*pos
= obstack_finish (os
);
1083 fputs (prefix
, stdout
);
1084 for (size_t i
= 0; i
< n_pos
; i
++)
1086 intmax_t p
= pos
[i
];
1093 /* Return the platform birthtime member of the stat structure,
1094 or fallback to the mtime member, which we have populated
1095 from the statx structure or reset to an invalid timestamp
1096 where birth time is not supported. */
1097 static struct timespec
1098 get_stat_btime (struct stat
const *st
)
1100 struct timespec btimespec
;
1102 #if HAVE_STATX && defined STATX_INO
1103 btimespec
= get_stat_mtime (st
);
1105 btimespec
= get_stat_birthtime (st
);
1111 #if HAVE_STATX && defined STATX_INO
1114 time_type_to_statx (void)
1134 calc_req_mask (void)
1136 unsigned int mask
= STATX_MODE
;
1141 if (print_block_size
)
1142 mask
|= STATX_BLOCKS
;
1144 if (format
== long_format
) {
1145 mask
|= STATX_NLINK
| STATX_SIZE
| time_type_to_statx ();
1146 if (print_owner
|| print_author
)
1157 case sort_extension
:
1161 mask
|= time_type_to_statx ();
1174 do_statx (int fd
, char const *name
, struct stat
*st
, int flags
,
1178 bool want_btime
= mask
& STATX_BTIME
;
1179 int ret
= statx (fd
, name
, flags
| AT_NO_AUTOMOUNT
, mask
, &stx
);
1182 statx_to_stat (&stx
, st
);
1183 /* Since we only need one timestamp type,
1184 store birth time in st_mtim. */
1187 if (stx
.stx_mask
& STATX_BTIME
)
1188 st
->st_mtim
= statx_timestamp_to_timespec (stx
.stx_btime
);
1190 st
->st_mtim
.tv_sec
= st
->st_mtim
.tv_nsec
= -1;
1198 do_stat (char const *name
, struct stat
*st
)
1200 return do_statx (AT_FDCWD
, name
, st
, 0, calc_req_mask ());
1204 do_lstat (char const *name
, struct stat
*st
)
1206 return do_statx (AT_FDCWD
, name
, st
, AT_SYMLINK_NOFOLLOW
, calc_req_mask ());
1210 stat_for_mode (char const *name
, struct stat
*st
)
1212 return do_statx (AT_FDCWD
, name
, st
, 0, STATX_MODE
);
1215 /* dev+ino should be static, so no need to sync with backing store */
1217 stat_for_ino (char const *name
, struct stat
*st
)
1219 return do_statx (AT_FDCWD
, name
, st
, 0, STATX_INO
);
1223 fstat_for_ino (int fd
, struct stat
*st
)
1225 return do_statx (fd
, "", st
, AT_EMPTY_PATH
, STATX_INO
);
1229 do_stat (char const *name
, struct stat
*st
)
1231 return stat (name
, st
);
1235 do_lstat (char const *name
, struct stat
*st
)
1237 return lstat (name
, st
);
1241 stat_for_mode (char const *name
, struct stat
*st
)
1243 return stat (name
, st
);
1247 stat_for_ino (char const *name
, struct stat
*st
)
1249 return stat (name
, st
);
1253 fstat_for_ino (int fd
, struct stat
*st
)
1255 return fstat (fd
, st
);
1259 /* Return the address of the first plain %b spec in FMT, or nullptr if
1260 there is no such spec. %5b etc. do not match, so that user
1261 widths/flags are honored. */
1265 first_percent_b (char const *fmt
)
1271 case 'b': return fmt
;
1272 case '%': fmt
++; break;
1277 static char RFC3986
[256];
1279 file_escape_init (void)
1281 for (int i
= 0; i
< 256; i
++)
1282 RFC3986
[i
] |= c_isalnum (i
) || i
== '~' || i
== '-' || i
== '.' || i
== '_';
1285 enum { MBSWIDTH_FLAGS
= MBSW_REJECT_INVALID
| MBSW_REJECT_UNPRINTABLE
};
1287 /* Read the abbreviated month names from the locale, to align them
1288 and to determine the max width of the field and to truncate names
1289 greater than our max allowed.
1290 Note even though this handles multibyte locales correctly
1291 it's not restricted to them as single byte locales can have
1292 variable width abbreviated months and also precomputing/caching
1293 the names was seen to increase the performance of ls significantly. */
1295 /* abformat[RECENT][MON] is the format to use for timestamps with
1296 recentness RECENT and month MON. */
1297 enum { ABFORMAT_SIZE
= 128 };
1298 static char abformat
[2][12][ABFORMAT_SIZE
];
1299 /* True if precomputed formats should be used. This can be false if
1300 nl_langinfo fails, if a format or month abbreviation is unusually
1301 long, or if a month abbreviation contains '%'. */
1302 static bool use_abformat
;
1304 /* Store into ABMON the abbreviated month names, suitably aligned.
1305 Return true if successful. */
1308 abmon_init (char abmon
[12][ABFORMAT_SIZE
])
1310 #ifndef HAVE_NL_LANGINFO
1313 int max_mon_width
= 0;
1317 for (int i
= 0; i
< 12; i
++)
1319 char const *abbr
= nl_langinfo (ABMON_1
+ i
);
1320 mon_len
[i
] = strnlen (abbr
, ABFORMAT_SIZE
);
1321 if (mon_len
[i
] == ABFORMAT_SIZE
)
1323 if (strchr (abbr
, '%'))
1325 mon_width
[i
] = mbswidth (strcpy (abmon
[i
], abbr
), MBSWIDTH_FLAGS
);
1326 if (mon_width
[i
] < 0)
1328 max_mon_width
= MAX (max_mon_width
, mon_width
[i
]);
1331 for (int i
= 0; i
< 12; i
++)
1333 int fill
= max_mon_width
- mon_width
[i
];
1334 if (ABFORMAT_SIZE
- mon_len
[i
] <= fill
)
1336 bool align_left
= !isdigit (to_uchar (abmon
[i
][0]));
1339 fill_offset
= mon_len
[i
];
1342 memmove (abmon
[i
] + fill
, abmon
[i
], mon_len
[i
]);
1345 memset (abmon
[i
] + fill_offset
, ' ', fill
);
1346 abmon
[i
][mon_len
[i
] + fill
] = '\0';
1353 /* Initialize ABFORMAT and USE_ABFORMAT. */
1356 abformat_init (void)
1359 for (int recent
= 0; recent
< 2; recent
++)
1360 pb
[recent
] = first_percent_b (long_time_format
[recent
]);
1361 if (! (pb
[0] || pb
[1]))
1364 char abmon
[12][ABFORMAT_SIZE
];
1365 if (! abmon_init (abmon
))
1368 for (int recent
= 0; recent
< 2; recent
++)
1370 char const *fmt
= long_time_format
[recent
];
1371 for (int i
= 0; i
< 12; i
++)
1373 char *nfmt
= abformat
[recent
][i
];
1377 nbytes
= snprintf (nfmt
, ABFORMAT_SIZE
, "%s", fmt
);
1380 if (! (pb
[recent
] - fmt
<= MIN (ABFORMAT_SIZE
, INT_MAX
)))
1382 int prefix_len
= pb
[recent
] - fmt
;
1383 nbytes
= snprintf (nfmt
, ABFORMAT_SIZE
, "%.*s%s%s",
1384 prefix_len
, fmt
, abmon
[i
], pb
[recent
] + 2);
1387 if (! (0 <= nbytes
&& nbytes
< ABFORMAT_SIZE
))
1392 use_abformat
= true;
1396 dev_ino_hash (void const *x
, size_t table_size
)
1398 struct dev_ino
const *p
= x
;
1399 return (uintmax_t) p
->st_ino
% table_size
;
1403 dev_ino_compare (void const *x
, void const *y
)
1405 struct dev_ino
const *a
= x
;
1406 struct dev_ino
const *b
= y
;
1407 return PSAME_INODE (a
, b
);
1411 dev_ino_free (void *x
)
1416 /* Add the device/inode pair (P->st_dev/P->st_ino) to the set of
1417 active directories. Return true if there is already a matching
1418 entry in the table. */
1421 visit_dir (dev_t dev
, ino_t ino
)
1423 struct dev_ino
*ent
;
1424 struct dev_ino
*ent_from_table
;
1427 ent
= xmalloc (sizeof *ent
);
1431 /* Attempt to insert this entry into the table. */
1432 ent_from_table
= hash_insert (active_dir_set
, ent
);
1434 if (ent_from_table
== nullptr)
1436 /* Insertion failed due to lack of memory. */
1440 found_match
= (ent_from_table
!= ent
);
1444 /* ent was not inserted, so free it. */
1452 free_pending_ent (struct pending
*p
)
1460 is_colored (enum indicator_no type
)
1462 size_t len
= color_indicator
[type
].len
;
1463 char const *s
= color_indicator
[type
].string
;
1465 || (len
== 1 && STRNCMP_LIT (s
, "0") == 0)
1466 || (len
== 2 && STRNCMP_LIT (s
, "00") == 0));
1470 restore_default_color (void)
1472 put_indicator (&color_indicator
[C_LEFT
]);
1473 put_indicator (&color_indicator
[C_RIGHT
]);
1477 set_normal_color (void)
1479 if (print_with_color
&& is_colored (C_NORM
))
1481 put_indicator (&color_indicator
[C_LEFT
]);
1482 put_indicator (&color_indicator
[C_NORM
]);
1483 put_indicator (&color_indicator
[C_RIGHT
]);
1487 /* An ordinary signal was received; arrange for the program to exit. */
1490 sighandler (int sig
)
1493 signal (sig
, SIG_IGN
);
1494 if (! interrupt_signal
)
1495 interrupt_signal
= sig
;
1498 /* A SIGTSTP was received; arrange for the program to suspend itself. */
1501 stophandler (int sig
)
1504 signal (sig
, stophandler
);
1505 if (! interrupt_signal
)
1506 stop_signal_count
++;
1509 /* Process any pending signals. If signals are caught, this function
1510 should be called periodically. Ideally there should never be an
1511 unbounded amount of time when signals are not being processed.
1512 Signal handling can restore the default colors, so callers must
1513 immediately change colors after invoking this function. */
1516 process_signals (void)
1518 while (interrupt_signal
|| stop_signal_count
)
1525 restore_default_color ();
1528 sigprocmask (SIG_BLOCK
, &caught_signals
, &oldset
);
1530 /* Reload interrupt_signal and stop_signal_count, in case a new
1531 signal was handled before sigprocmask took effect. */
1532 sig
= interrupt_signal
;
1533 stops
= stop_signal_count
;
1535 /* SIGTSTP is special, since the application can receive that signal
1536 more than once. In this case, don't set the signal handler to the
1537 default. Instead, just raise the uncatchable SIGSTOP. */
1540 stop_signal_count
= stops
- 1;
1544 signal (sig
, SIG_DFL
);
1546 /* Exit or suspend the program. */
1548 sigprocmask (SIG_SETMASK
, &oldset
, nullptr);
1550 /* If execution reaches here, then the program has been
1551 continued (after being suspended). */
1555 /* Setup signal handlers if INIT is true,
1556 otherwise restore to the default. */
1559 signal_setup (bool init
)
1561 /* The signals that are trapped, and the number of such signals. */
1562 static int const sig
[] =
1564 /* This one is handled specially. */
1567 /* The usual suspects. */
1568 SIGALRM
, SIGHUP
, SIGINT
, SIGPIPE
, SIGQUIT
, SIGTERM
,
1585 enum { nsigs
= ARRAY_CARDINALITY (sig
) };
1588 static bool caught_sig
[nsigs
];
1596 struct sigaction act
;
1598 sigemptyset (&caught_signals
);
1599 for (j
= 0; j
< nsigs
; j
++)
1601 sigaction (sig
[j
], nullptr, &act
);
1602 if (act
.sa_handler
!= SIG_IGN
)
1603 sigaddset (&caught_signals
, sig
[j
]);
1606 act
.sa_mask
= caught_signals
;
1607 act
.sa_flags
= SA_RESTART
;
1609 for (j
= 0; j
< nsigs
; j
++)
1610 if (sigismember (&caught_signals
, sig
[j
]))
1612 act
.sa_handler
= sig
[j
] == SIGTSTP
? stophandler
: sighandler
;
1613 sigaction (sig
[j
], &act
, nullptr);
1616 for (j
= 0; j
< nsigs
; j
++)
1618 caught_sig
[j
] = (signal (sig
[j
], SIG_IGN
) != SIG_IGN
);
1621 signal (sig
[j
], sig
[j
] == SIGTSTP
? stophandler
: sighandler
);
1622 siginterrupt (sig
[j
], 0);
1630 for (j
= 0; j
< nsigs
; j
++)
1631 if (sigismember (&caught_signals
, sig
[j
]))
1632 signal (sig
[j
], SIG_DFL
);
1634 for (j
= 0; j
< nsigs
; j
++)
1636 signal (sig
[j
], SIG_DFL
);
1644 signal_setup (true);
1648 signal_restore (void)
1650 signal_setup (false);
1654 main (int argc
, char **argv
)
1657 struct pending
*thispend
;
1660 initialize_main (&argc
, &argv
);
1661 set_program_name (argv
[0]);
1662 setlocale (LC_ALL
, "");
1663 bindtextdomain (PACKAGE
, LOCALEDIR
);
1664 textdomain (PACKAGE
);
1666 initialize_exit_failure (LS_FAILURE
);
1667 atexit (close_stdout
);
1669 static_assert (ARRAY_CARDINALITY (color_indicator
) + 1
1670 == ARRAY_CARDINALITY (indicator_name
));
1672 exit_status
= EXIT_SUCCESS
;
1673 print_dir_name
= true;
1674 pending_dirs
= nullptr;
1676 current_time
.tv_sec
= TYPE_MINIMUM (time_t);
1677 current_time
.tv_nsec
= -1;
1679 i
= decode_switches (argc
, argv
);
1681 if (print_with_color
)
1684 /* Test print_with_color again, because the call to parse_ls_color
1685 may have just reset it -- e.g., if LS_COLORS is invalid. */
1687 if (print_with_color
)
1689 /* Don't use TAB characters in output. Some terminal
1690 emulators can't handle the combination of tabs and
1691 color codes on the same line. */
1695 if (directories_first
)
1696 check_symlink_mode
= true;
1697 else if (print_with_color
)
1699 /* Avoid following symbolic links when possible. */
1700 if (is_colored (C_ORPHAN
)
1701 || (is_colored (C_EXEC
) && color_symlink_as_referent
)
1702 || (is_colored (C_MISSING
) && format
== long_format
))
1703 check_symlink_mode
= true;
1706 if (dereference
== DEREF_UNDEFINED
)
1707 dereference
= ((immediate_dirs
1708 || indicator_style
== classify
1709 || format
== long_format
)
1711 : DEREF_COMMAND_LINE_SYMLINK_TO_DIR
);
1713 /* When using -R, initialize a data structure we'll use to
1714 detect any directory cycles. */
1717 active_dir_set
= hash_initialize (INITIAL_TABLE_SIZE
, nullptr,
1721 if (active_dir_set
== nullptr)
1724 obstack_init (&dev_ino_obstack
);
1727 localtz
= tzalloc (getenv ("TZ"));
1729 format_needs_stat
= sort_type
== sort_time
|| sort_type
== sort_size
1730 || format
== long_format
1732 || print_block_size
;
1733 format_needs_type
= (! format_needs_stat
1736 || indicator_style
!= none
1737 || directories_first
));
1741 obstack_init (&dired_obstack
);
1742 obstack_init (&subdired_obstack
);
1745 if (print_hyperlink
)
1747 file_escape_init ();
1749 hostname
= xgethostname ();
1750 /* The hostname is generally ignored,
1751 so ignore failures obtaining it. */
1757 cwd_file
= xnmalloc (cwd_n_alloc
, sizeof *cwd_file
);
1767 gobble_file (".", directory
, NOT_AN_INODE_NUMBER
, true, "");
1769 queue_directory (".", nullptr, true);
1773 gobble_file (argv
[i
++], unknown
, NOT_AN_INODE_NUMBER
, true, "");
1779 if (!immediate_dirs
)
1780 extract_dirs_from_files (nullptr, true);
1781 /* 'cwd_n_used' might be zero now. */
1784 /* In the following if/else blocks, it is sufficient to test 'pending_dirs'
1785 (and not pending_dirs->name) because there may be no markers in the queue
1786 at this point. A marker may be enqueued when extract_dirs_from_files is
1787 called with a non-empty string or via print_dir. */
1790 print_current_files ();
1792 dired_outbyte ('\n');
1794 else if (n_files
<= 1 && pending_dirs
&& pending_dirs
->next
== 0)
1795 print_dir_name
= false;
1797 while (pending_dirs
)
1799 thispend
= pending_dirs
;
1800 pending_dirs
= pending_dirs
->next
;
1804 if (thispend
->name
== nullptr)
1806 /* thispend->name == nullptr means this is a marker entry
1807 indicating we've finished processing the directory.
1808 Use its dev/ino numbers to remove the corresponding
1809 entry from the active_dir_set hash table. */
1810 struct dev_ino di
= dev_ino_pop ();
1811 struct dev_ino
*found
= hash_remove (active_dir_set
, &di
);
1813 assert_matching_dev_ino (thispend
->realname
, di
);
1815 dev_ino_free (found
);
1816 free_pending_ent (thispend
);
1821 print_dir (thispend
->name
, thispend
->realname
,
1822 thispend
->command_line_arg
);
1824 free_pending_ent (thispend
);
1825 print_dir_name
= true;
1828 if (print_with_color
&& used_color
)
1832 /* Skip the restore when it would be a no-op, i.e.,
1833 when left is "\033[" and right is "m". */
1834 if (!(color_indicator
[C_LEFT
].len
== 2
1835 && memcmp (color_indicator
[C_LEFT
].string
, "\033[", 2) == 0
1836 && color_indicator
[C_RIGHT
].len
== 1
1837 && color_indicator
[C_RIGHT
].string
[0] == 'm'))
1838 restore_default_color ();
1844 /* Act on any signals that arrived before the default was restored.
1845 This can process signals out of order, but there doesn't seem to
1846 be an easy way to do them in order, and the order isn't that
1847 important anyway. */
1848 for (j
= stop_signal_count
; j
; j
--)
1850 j
= interrupt_signal
;
1857 /* No need to free these since we're about to exit. */
1858 dired_dump_obstack ("//DIRED//", &dired_obstack
);
1859 dired_dump_obstack ("//SUBDIRED//", &subdired_obstack
);
1860 printf ("//DIRED-OPTIONS// --quoting-style=%s\n",
1861 quoting_style_args
[get_quoting_style (filename_quoting_options
)]);
1866 assure (hash_get_n_entries (active_dir_set
) == 0);
1867 hash_free (active_dir_set
);
1873 /* Return the line length indicated by the value given by SPEC, or -1
1874 if unsuccessful. 0 means no limit on line length. */
1877 decode_line_length (char const *spec
)
1881 /* Treat too-large values as if they were 0, which is
1882 effectively infinity. */
1883 switch (xstrtoumax (spec
, nullptr, 0, &val
, ""))
1886 return val
<= MIN (PTRDIFF_MAX
, SIZE_MAX
) ? val
: 0;
1888 case LONGINT_OVERFLOW
:
1896 /* Return true if standard output is a tty, caching the result. */
1899 stdout_isatty (void)
1901 static signed char out_tty
= -1;
1903 out_tty
= isatty (STDOUT_FILENO
);
1904 assume (out_tty
== 0 || out_tty
== 1);
1908 /* Set all the option flags according to the switches specified.
1909 Return the index of the first non-option argument. */
1912 decode_switches (int argc
, char **argv
)
1914 char const *time_style_option
= nullptr;
1916 /* These variables are false or -1 unless a switch says otherwise. */
1917 bool kibibytes_specified
= false;
1918 int format_opt
= -1;
1919 int hide_control_chars_opt
= -1;
1920 int quoting_style_opt
= -1;
1922 ptrdiff_t tabsize_opt
= -1;
1923 ptrdiff_t width_opt
= -1;
1928 int c
= getopt_long (argc
, argv
,
1929 "abcdfghiklmnopqrstuvw:xABCDFGHI:LNQRST:UXZ1",
1937 ignore_mode
= IGNORE_MINIMAL
;
1941 quoting_style_opt
= escape_quoting_style
;
1945 time_type
= time_ctime
;
1949 immediate_dirs
= true;
1953 ignore_mode
= IGNORE_MINIMAL
; /* enable -a */
1954 sort_opt
= sort_none
; /* enable -U */
1955 if (format_opt
== long_format
)
1956 format_opt
= -1; /* disable -l */
1957 print_with_color
= false; /* disable --color */
1958 print_hyperlink
= false; /* disable --hyperlink */
1959 print_block_size
= false; /* disable -s */
1962 case FILE_TYPE_INDICATOR_OPTION
: /* --file-type */
1963 indicator_style
= file_type
;
1967 format_opt
= long_format
;
1968 print_owner
= false;
1972 file_human_output_opts
= human_output_opts
=
1973 human_autoscale
| human_SI
| human_base_1024
;
1974 file_output_block_size
= output_block_size
= 1;
1982 kibibytes_specified
= true;
1986 format_opt
= long_format
;
1990 format_opt
= with_commas
;
1995 format_opt
= long_format
;
1998 case 'o': /* Just like -l, but don't display group info. */
1999 format_opt
= long_format
;
2000 print_group
= false;
2004 indicator_style
= slash
;
2008 hide_control_chars_opt
= true;
2012 sort_reverse
= true;
2016 print_block_size
= true;
2020 sort_opt
= sort_time
;
2024 time_type
= time_atime
;
2028 sort_opt
= sort_version
;
2032 width_opt
= decode_line_length (optarg
);
2034 error (LS_FAILURE
, 0, "%s: %s", _("invalid line width"),
2039 format_opt
= horizontal
;
2043 ignore_mode
= IGNORE_DOT_AND_DOTDOT
;
2047 add_ignore_pattern ("*~");
2048 add_ignore_pattern (".*~");
2052 format_opt
= many_per_line
;
2056 format_opt
= long_format
;
2057 print_hyperlink
= false;
2065 i
= XARGMATCH ("--classify", optarg
, when_args
, when_types
);
2067 /* Using --classify with no argument is equivalent to using
2068 --classify=always. */
2071 if (i
== when_always
|| (i
== when_if_tty
&& stdout_isatty ()))
2072 indicator_style
= classify
;
2076 case 'G': /* inhibit display of group info */
2077 print_group
= false;
2081 dereference
= DEREF_COMMAND_LINE_ARGUMENTS
;
2084 case DEREFERENCE_COMMAND_LINE_SYMLINK_TO_DIR_OPTION
:
2085 dereference
= DEREF_COMMAND_LINE_SYMLINK_TO_DIR
;
2089 add_ignore_pattern (optarg
);
2093 dereference
= DEREF_ALWAYS
;
2097 quoting_style_opt
= literal_quoting_style
;
2101 quoting_style_opt
= c_quoting_style
;
2109 sort_opt
= sort_size
;
2113 tabsize_opt
= xnumtoumax (optarg
, 0, 0, MIN (PTRDIFF_MAX
, SIZE_MAX
),
2114 "", _("invalid tab size"), LS_FAILURE
);
2118 sort_opt
= sort_none
;
2122 sort_opt
= sort_extension
;
2126 /* -1 has no effect after -l. */
2127 if (format_opt
!= long_format
)
2128 format_opt
= one_per_line
;
2132 print_author
= true;
2137 struct ignore_pattern
*hide
= xmalloc (sizeof *hide
);
2138 hide
->pattern
= optarg
;
2139 hide
->next
= hide_patterns
;
2140 hide_patterns
= hide
;
2145 sort_opt
= XARGMATCH ("--sort", optarg
, sort_args
, sort_types
);
2148 case GROUP_DIRECTORIES_FIRST_OPTION
:
2149 directories_first
= true;
2153 time_type
= XARGMATCH ("--time", optarg
, time_args
, time_types
);
2157 format_opt
= XARGMATCH ("--format", optarg
, format_args
,
2161 case FULL_TIME_OPTION
:
2162 format_opt
= long_format
;
2163 time_style_option
= "full-iso";
2170 i
= XARGMATCH ("--color", optarg
, when_args
, when_types
);
2172 /* Using --color with no argument is equivalent to using
2176 print_with_color
= (i
== when_always
2177 || (i
== when_if_tty
&& stdout_isatty ()));
2181 case HYPERLINK_OPTION
:
2185 i
= XARGMATCH ("--hyperlink", optarg
, when_args
, when_types
);
2187 /* Using --hyperlink with no argument is equivalent to using
2188 --hyperlink=always. */
2191 print_hyperlink
= (i
== when_always
2192 || (i
== when_if_tty
&& stdout_isatty ()));
2196 case INDICATOR_STYLE_OPTION
:
2197 indicator_style
= XARGMATCH ("--indicator-style", optarg
,
2198 indicator_style_args
,
2199 indicator_style_types
);
2202 case QUOTING_STYLE_OPTION
:
2203 quoting_style_opt
= XARGMATCH ("--quoting-style", optarg
,
2205 quoting_style_vals
);
2208 case TIME_STYLE_OPTION
:
2209 time_style_option
= optarg
;
2212 case SHOW_CONTROL_CHARS_OPTION
:
2213 hide_control_chars_opt
= false;
2216 case BLOCK_SIZE_OPTION
:
2218 enum strtol_error e
= human_options (optarg
, &human_output_opts
,
2219 &output_block_size
);
2220 if (e
!= LONGINT_OK
)
2221 xstrtol_fatal (e
, oi
, 0, long_options
, optarg
);
2222 file_human_output_opts
= human_output_opts
;
2223 file_output_block_size
= output_block_size
;
2228 file_human_output_opts
= human_output_opts
=
2229 human_autoscale
| human_SI
;
2230 file_output_block_size
= output_block_size
= 1;
2234 print_scontext
= true;
2239 hide_control_chars_opt
= false;
2240 if (format_opt
!= long_format
)
2241 format_opt
= one_per_line
;
2242 print_with_color
= false;
2243 quoting_style_opt
= literal_quoting_style
;
2246 case_GETOPT_HELP_CHAR
;
2248 case_GETOPT_VERSION_CHAR (PROGRAM_NAME
, AUTHORS
);
2255 if (! output_block_size
)
2257 char const *ls_block_size
= getenv ("LS_BLOCK_SIZE");
2258 human_options (ls_block_size
,
2259 &human_output_opts
, &output_block_size
);
2260 if (ls_block_size
|| getenv ("BLOCK_SIZE"))
2262 file_human_output_opts
= human_output_opts
;
2263 file_output_block_size
= output_block_size
;
2265 if (kibibytes_specified
)
2267 human_output_opts
= 0;
2268 output_block_size
= 1024;
2272 format
= (0 <= format_opt
? format_opt
2273 : ls_mode
== LS_LS
? (stdout_isatty ()
2274 ? many_per_line
: one_per_line
)
2275 : ls_mode
== LS_MULTI_COL
? many_per_line
2276 : /* ls_mode == LS_LONG_FORMAT */ long_format
);
2278 /* If the line length was not set by a switch but is needed to determine
2279 output, go to the work of obtaining it from the environment. */
2280 ptrdiff_t linelen
= width_opt
;
2281 if (format
== many_per_line
|| format
== horizontal
|| format
== with_commas
2282 || print_with_color
)
2288 if (stdout_isatty ()
2289 && 0 <= ioctl (STDOUT_FILENO
, TIOCGWINSZ
, &ws
)
2291 linelen
= ws
.ws_col
<= MIN (PTRDIFF_MAX
, SIZE_MAX
) ? ws
.ws_col
: 0;
2296 char const *p
= getenv ("COLUMNS");
2299 linelen
= decode_line_length (p
);
2302 _("ignoring invalid width"
2303 " in environment variable COLUMNS: %s"),
2309 line_length
= linelen
< 0 ? 80 : linelen
;
2311 /* Determine the max possible number of display columns. */
2312 max_idx
= line_length
/ MIN_COLUMN_WIDTH
;
2313 /* Account for first display column not having a separator,
2314 or line_lengths shorter than MIN_COLUMN_WIDTH. */
2315 max_idx
+= line_length
% MIN_COLUMN_WIDTH
!= 0;
2317 if (format
== many_per_line
|| format
== horizontal
|| format
== with_commas
)
2319 if (0 <= tabsize_opt
)
2320 tabsize
= tabsize_opt
;
2324 char const *p
= getenv ("TABSIZE");
2328 if (xstrtoumax (p
, nullptr, 0, &tmp
, "") == LONGINT_OK
2333 _("ignoring invalid tab size"
2334 " in environment variable TABSIZE: %s"),
2340 qmark_funny_chars
= (hide_control_chars_opt
< 0
2341 ? ls_mode
== LS_LS
&& stdout_isatty ()
2342 : hide_control_chars_opt
);
2344 int qs
= quoting_style_opt
;
2346 qs
= getenv_quoting_style ();
2348 qs
= (ls_mode
== LS_LS
2349 ? (stdout_isatty () ? shell_escape_quoting_style
: -1)
2350 : escape_quoting_style
);
2352 set_quoting_style (nullptr, qs
);
2353 qs
= get_quoting_style (nullptr);
2354 align_variable_outer_quotes
2355 = ((format
== long_format
2356 || ((format
== many_per_line
|| format
== horizontal
) && line_length
))
2357 && (qs
== shell_quoting_style
2358 || qs
== shell_escape_quoting_style
2359 || qs
== c_maybe_quoting_style
));
2360 filename_quoting_options
= clone_quoting_options (nullptr);
2361 if (qs
== escape_quoting_style
)
2362 set_char_quoting (filename_quoting_options
, ' ', 1);
2363 if (file_type
<= indicator_style
)
2366 for (p
= &"*=>@|"[indicator_style
- file_type
]; *p
; p
++)
2367 set_char_quoting (filename_quoting_options
, *p
, 1);
2370 dirname_quoting_options
= clone_quoting_options (nullptr);
2371 set_char_quoting (dirname_quoting_options
, ':', 1);
2373 /* --dired implies --format=long (-l) and sans --hyperlink.
2374 So ignore it if those overridden. */
2375 dired
&= (format
== long_format
) & !print_hyperlink
;
2377 if (eolbyte
< dired
)
2378 error (LS_FAILURE
, 0, _("--dired and --zero are incompatible"));
2380 /* If -c or -u is specified and not -l (or any other option that implies -l),
2381 and no sort-type was specified, then sort by the ctime (-c) or atime (-u).
2382 The behavior of ls when using either -c or -u but with neither -l nor -t
2383 appears to be unspecified by POSIX. So, with GNU ls, '-u' alone means
2384 sort by atime (this is the one that's not specified by the POSIX spec),
2385 -lu means show atime and sort by name, -lut means show atime and sort
2388 sort_type
= (0 <= sort_opt
? sort_opt
2389 : (format
!= long_format
2390 && (time_type
== time_ctime
|| time_type
== time_atime
2391 || time_type
== time_btime
))
2392 ? sort_time
: sort_name
);
2394 if (format
== long_format
)
2396 char const *style
= time_style_option
;
2397 static char const posix_prefix
[] = "posix-";
2401 style
= getenv ("TIME_STYLE");
2406 while (STREQ_LEN (style
, posix_prefix
, sizeof posix_prefix
- 1))
2408 if (! hard_locale (LC_TIME
))
2410 style
+= sizeof posix_prefix
- 1;
2415 char const *p0
= style
+ 1;
2416 char *p0nl
= strchr (p0
, '\n');
2417 char const *p1
= p0
;
2420 if (strchr (p0nl
+ 1, '\n'))
2421 error (LS_FAILURE
, 0, _("invalid time style format %s"),
2426 long_time_format
[0] = p0
;
2427 long_time_format
[1] = p1
;
2431 ptrdiff_t res
= argmatch (style
, time_style_args
,
2432 (char const *) time_style_types
,
2433 sizeof (*time_style_types
));
2436 /* This whole block used to be a simple use of XARGMATCH.
2437 but that didn't print the "posix-"-prefixed variants or
2438 the "+"-prefixed format string option upon failure. */
2439 argmatch_invalid ("time style", style
, res
);
2441 /* The following is a manual expansion of argmatch_valid,
2442 but with the added "+ ..." description and the [posix-]
2443 prefixes prepended. Note that this simplification works
2444 only because all four existing time_style_types values
2446 fputs (_("Valid arguments are:\n"), stderr
);
2447 char const *const *p
= time_style_args
;
2449 fprintf (stderr
, " - [posix-]%s\n", *p
++);
2450 fputs (_(" - +FORMAT (e.g., +%H:%M) for a 'date'-style"
2451 " format\n"), stderr
);
2456 case full_iso_time_style
:
2457 long_time_format
[0] = long_time_format
[1] =
2458 "%Y-%m-%d %H:%M:%S.%N %z";
2461 case long_iso_time_style
:
2462 long_time_format
[0] = long_time_format
[1] = "%Y-%m-%d %H:%M";
2465 case iso_time_style
:
2466 long_time_format
[0] = "%Y-%m-%d ";
2467 long_time_format
[1] = "%m-%d %H:%M";
2470 case locale_time_style
:
2471 if (hard_locale (LC_TIME
))
2473 for (int i
= 0; i
< 2; i
++)
2474 long_time_format
[i
] =
2475 dcgettext (nullptr, long_time_format
[i
], LC_TIME
);
2486 /* Parse a string as part of the LS_COLORS variable; this may involve
2487 decoding all kinds of escape characters. If equals_end is set an
2488 unescaped equal sign ends the string, otherwise only a : or \0
2489 does. Set *OUTPUT_COUNT to the number of bytes output. Return
2492 The resulting string is *not* null-terminated, but may contain
2495 Note that both dest and src are char **; on return they point to
2496 the first free byte after the array and the character that ended
2497 the input string, respectively. */
2500 get_funky_string (char **dest
, char const **src
, bool equals_end
,
2501 size_t *output_count
)
2503 char num
; /* For numerical codes */
2504 size_t count
; /* Something to count with */
2506 ST_GND
, ST_BACKSLASH
, ST_OCTAL
, ST_HEX
, ST_CARET
, ST_END
, ST_ERROR
2511 p
= *src
; /* We don't want to double-indirect */
2512 q
= *dest
; /* the whole darn time. */
2514 count
= 0; /* No characters counted in yet. */
2517 state
= ST_GND
; /* Start in ground state. */
2518 while (state
< ST_END
)
2522 case ST_GND
: /* Ground state (no escapes) */
2527 state
= ST_END
; /* End of string */
2530 state
= ST_BACKSLASH
; /* Backslash escape sequence */
2534 state
= ST_CARET
; /* Caret escape */
2540 state
= ST_END
; /* End */
2551 case ST_BACKSLASH
: /* Backslash escaped character */
2562 state
= ST_OCTAL
; /* Octal sequence */
2567 state
= ST_HEX
; /* Hex sequence */
2570 case 'a': /* Bell */
2573 case 'b': /* Backspace */
2576 case 'e': /* Escape */
2579 case 'f': /* Form feed */
2582 case 'n': /* Newline */
2585 case 'r': /* Carriage return */
2591 case 'v': /* Vtab */
2594 case '?': /* Delete */
2597 case '_': /* Space */
2600 case '\0': /* End of string */
2601 state
= ST_ERROR
; /* Error! */
2603 default: /* Escaped character like \ ^ : = */
2607 if (state
== ST_BACKSLASH
)
2616 case ST_OCTAL
: /* Octal sequence */
2617 if (*p
< '0' || *p
> '7')
2624 num
= (num
<< 3) + (*(p
++) - '0');
2627 case ST_HEX
: /* Hex sequence */
2640 num
= (num
<< 4) + (*(p
++) - '0');
2648 num
= (num
<< 4) + (*(p
++) - 'a') + 10;
2656 num
= (num
<< 4) + (*(p
++) - 'A') + 10;
2666 case ST_CARET
: /* Caret escape */
2667 state
= ST_GND
; /* Should be the next state... */
2668 if (*p
>= '@' && *p
<= '~')
2670 *(q
++) = *(p
++) & 037;
2689 *output_count
= count
;
2691 return state
!= ST_ERROR
;
2705 /* Check if the content of TERM is a valid name in dircolors. */
2708 known_term_type (void)
2710 char const *term
= getenv ("TERM");
2711 if (! term
|| ! *term
)
2714 char const *line
= G_line
;
2715 while (line
- G_line
< sizeof (G_line
))
2717 if (STRNCMP_LIT (line
, "TERM ") == 0)
2719 if (fnmatch (line
+ 5, term
, 0) == 0)
2722 line
+= strlen (line
) + 1;
2729 parse_ls_color (void)
2731 char const *p
; /* Pointer to character being parsed */
2732 char *buf
; /* color_buf buffer pointer */
2733 int ind_no
; /* Indicator number */
2734 char label
[3]; /* Indicator label */
2735 struct color_ext_type
*ext
; /* Extension we are working on */
2737 if ((p
= getenv ("LS_COLORS")) == nullptr || *p
== '\0')
2739 /* LS_COLORS takes precedence, but if that's not set then
2740 honor the COLORTERM and TERM env variables so that
2741 we only go with the internal ANSI color codes if the
2742 former is non empty or the latter is set to a known value. */
2743 char const *colorterm
= getenv ("COLORTERM");
2744 if (! (colorterm
&& *colorterm
) && ! known_term_type ())
2745 print_with_color
= false;
2750 strcpy (label
, "??");
2752 /* This is an overly conservative estimate, but any possible
2753 LS_COLORS string will *not* generate a color_buf longer than
2754 itself, so it is a safe way of allocating a buffer in
2756 buf
= color_buf
= xstrdup (p
);
2758 enum parse_state state
= PS_START
;
2763 case PS_START
: /* First label character */
2771 /* Allocate new extension block and add to head of
2772 linked list (this way a later definition will
2773 override an earlier one, which can be useful for
2774 having terminal-specific defs override global). */
2776 ext
= xmalloc (sizeof *ext
);
2777 ext
->next
= color_ext_list
;
2778 color_ext_list
= ext
;
2779 ext
->exact_match
= false;
2782 ext
->ext
.string
= buf
;
2784 state
= (get_funky_string (&buf
, &p
, true, &ext
->ext
.len
)
2789 state
= PS_DONE
; /* Done! */
2792 default: /* Assume it is file type label */
2799 case PS_2
: /* Second label character */
2806 state
= PS_FAIL
; /* Error */
2809 case PS_3
: /* Equal sign after indicator label */
2810 state
= PS_FAIL
; /* Assume failure... */
2811 if (*(p
++) == '=')/* It *should* be... */
2813 for (ind_no
= 0; indicator_name
[ind_no
] != nullptr; ++ind_no
)
2815 if (STREQ (label
, indicator_name
[ind_no
]))
2817 color_indicator
[ind_no
].string
= buf
;
2818 state
= (get_funky_string (&buf
, &p
, false,
2819 &color_indicator
[ind_no
].len
)
2820 ? PS_START
: PS_FAIL
);
2824 if (state
== PS_FAIL
)
2825 error (0, 0, _("unrecognized prefix: %s"), quote (label
));
2829 case PS_4
: /* Equal sign after *.ext */
2832 ext
->seq
.string
= buf
;
2833 state
= (get_funky_string (&buf
, &p
, false, &ext
->seq
.len
)
2834 ? PS_START
: PS_FAIL
);
2849 if (state
== PS_FAIL
)
2851 struct color_ext_type
*e
;
2852 struct color_ext_type
*e2
;
2855 _("unparsable value for LS_COLORS environment variable"));
2857 for (e
= color_ext_list
; e
!= nullptr; /* empty */)
2863 print_with_color
= false;
2867 /* Postprocess list to set EXACT_MATCH on entries where there are
2868 different cased extensions with separate sequences defined.
2869 Also set ext.len to SIZE_MAX on any entries that can't
2870 match due to precedence, to avoid redundant string compares. */
2871 struct color_ext_type
*e1
;
2873 for (e1
= color_ext_list
; e1
!= nullptr; e1
= e1
->next
)
2875 struct color_ext_type
*e2
;
2876 bool case_ignored
= false;
2878 for (e2
= e1
->next
; e2
!= nullptr; e2
= e2
->next
)
2880 if (e2
->ext
.len
< SIZE_MAX
&& e1
->ext
.len
== e2
->ext
.len
)
2882 if (memcmp (e1
->ext
.string
, e2
->ext
.string
, e1
->ext
.len
) == 0)
2883 e2
->ext
.len
= SIZE_MAX
; /* Ignore */
2884 else if (c_strncasecmp (e1
->ext
.string
, e2
->ext
.string
,
2889 e2
->ext
.len
= SIZE_MAX
; /* Ignore */
2891 else if (e1
->seq
.len
== e2
->seq
.len
2892 && memcmp (e1
->seq
.string
, e2
->seq
.string
,
2895 e2
->ext
.len
= SIZE_MAX
; /* Ignore */
2896 case_ignored
= true; /* Ignore all subsequent */
2900 e1
->exact_match
= true;
2901 e2
->exact_match
= true;
2909 if (color_indicator
[C_LINK
].len
== 6
2910 && !STRNCMP_LIT (color_indicator
[C_LINK
].string
, "target"))
2911 color_symlink_as_referent
= true;
2914 /* Return the quoting style specified by the environment variable
2915 QUOTING_STYLE if set and valid, -1 otherwise. */
2918 getenv_quoting_style (void)
2920 char const *q_style
= getenv ("QUOTING_STYLE");
2923 int i
= ARGMATCH (q_style
, quoting_style_args
, quoting_style_vals
);
2927 _("ignoring invalid value"
2928 " of environment variable QUOTING_STYLE: %s"),
2932 return quoting_style_vals
[i
];
2935 /* Set the exit status to report a failure. If SERIOUS, it is a
2936 serious failure; otherwise, it is merely a minor problem. */
2939 set_exit_status (bool serious
)
2942 exit_status
= LS_FAILURE
;
2943 else if (exit_status
== EXIT_SUCCESS
)
2944 exit_status
= LS_MINOR_PROBLEM
;
2947 /* Assuming a failure is serious if SERIOUS, use the printf-style
2948 MESSAGE to report the failure to access a file named FILE. Assume
2949 errno is set appropriately for the failure. */
2952 file_failure (bool serious
, char const *message
, char const *file
)
2954 error (0, errno
, message
, quoteaf (file
));
2955 set_exit_status (serious
);
2958 /* Request that the directory named NAME have its contents listed later.
2959 If REALNAME is nonzero, it will be used instead of NAME when the
2960 directory name is printed. This allows symbolic links to directories
2961 to be treated as regular directories but still be listed under their
2962 real names. NAME == nullptr is used to insert a marker entry for the
2963 directory named in REALNAME.
2964 If NAME is non-null, we use its dev/ino information to save
2965 a call to stat -- when doing a recursive (-R) traversal.
2966 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2969 queue_directory (char const *name
, char const *realname
, bool command_line_arg
)
2971 struct pending
*new = xmalloc (sizeof *new);
2972 new->realname
= realname
? xstrdup (realname
) : nullptr;
2973 new->name
= name
? xstrdup (name
) : nullptr;
2974 new->command_line_arg
= command_line_arg
;
2975 new->next
= pending_dirs
;
2979 /* Read directory NAME, and list the files in it.
2980 If REALNAME is nonzero, print its name instead of NAME;
2981 this is used for symbolic links to directories.
2982 COMMAND_LINE_ARG means this directory was mentioned on the command line. */
2985 print_dir (char const *name
, char const *realname
, bool command_line_arg
)
2988 struct dirent
*next
;
2989 uintmax_t total_blocks
= 0;
2990 static bool first
= true;
2993 dirp
= opendir (name
);
2996 file_failure (command_line_arg
, _("cannot open directory %s"), name
);
3002 struct stat dir_stat
;
3003 int fd
= dirfd (dirp
);
3005 /* If dirfd failed, endure the overhead of stat'ing by path */
3007 ? fstat_for_ino (fd
, &dir_stat
)
3008 : stat_for_ino (name
, &dir_stat
)) < 0)
3010 file_failure (command_line_arg
,
3011 _("cannot determine device and inode of %s"), name
);
3016 /* If we've already visited this dev/inode pair, warn that
3017 we've found a loop, and do not process this directory. */
3018 if (visit_dir (dir_stat
.st_dev
, dir_stat
.st_ino
))
3020 error (0, 0, _("%s: not listing already-listed directory"),
3023 set_exit_status (true);
3027 dev_ino_push (dir_stat
.st_dev
, dir_stat
.st_ino
);
3032 if (recursive
|| print_dir_name
)
3035 dired_outbyte ('\n');
3039 char *absolute_name
= nullptr;
3040 if (print_hyperlink
)
3042 absolute_name
= canonicalize_filename_mode (name
, CAN_MISSING
);
3043 if (! absolute_name
)
3044 file_failure (command_line_arg
,
3045 _("error canonicalizing %s"), name
);
3047 quote_name (realname
? realname
: name
, dirname_quoting_options
, -1,
3048 nullptr, true, &subdired_obstack
, absolute_name
);
3050 free (absolute_name
);
3052 dired_outstring (":\n");
3055 /* Read the directory entries, and insert the subfiles into the 'cwd_file'
3060 /* Set errno to zero so we can distinguish between a readdir failure
3061 and when readdir simply finds that there are no more entries. */
3063 next
= readdir (dirp
);
3066 if (! file_ignored (next
->d_name
))
3068 enum filetype type
= unknown
;
3070 #if HAVE_STRUCT_DIRENT_D_TYPE
3071 switch (next
->d_type
)
3073 case DT_BLK
: type
= blockdev
; break;
3074 case DT_CHR
: type
= chardev
; break;
3075 case DT_DIR
: type
= directory
; break;
3076 case DT_FIFO
: type
= fifo
; break;
3077 case DT_LNK
: type
= symbolic_link
; break;
3078 case DT_REG
: type
= normal
; break;
3079 case DT_SOCK
: type
= sock
; break;
3081 case DT_WHT
: type
= whiteout
; break;
3085 total_blocks
+= gobble_file (next
->d_name
, type
,
3086 RELIABLE_D_INO (next
),
3089 /* In this narrow case, print out each name right away, so
3090 ls uses constant memory while processing the entries of
3091 this directory. Useful when there are many (millions)
3092 of entries in a directory. */
3093 if (format
== one_per_line
&& sort_type
== sort_none
3094 && !print_block_size
&& !recursive
)
3096 /* We must call sort_files in spite of
3097 "sort_type == sort_none" for its initialization
3098 of the sorted_file vector. */
3100 print_current_files ();
3105 else if (errno
!= 0)
3107 file_failure (command_line_arg
, _("reading directory %s"), name
);
3108 if (errno
!= EOVERFLOW
)
3114 /* When processing a very large directory, and since we've inhibited
3115 interrupts, this loop would take so long that ls would be annoyingly
3116 uninterruptible. This ensures that it handles signals promptly. */
3120 if (closedir (dirp
) != 0)
3122 file_failure (command_line_arg
, _("closing directory %s"), name
);
3123 /* Don't return; print whatever we got. */
3126 /* Sort the directory contents. */
3129 /* If any member files are subdirectories, perhaps they should have their
3130 contents listed rather than being mentioned here as files. */
3133 extract_dirs_from_files (name
, false);
3135 if (format
== long_format
|| print_block_size
)
3137 char buf
[LONGEST_HUMAN_READABLE
+ 3];
3138 char *p
= human_readable (total_blocks
, buf
+ 1, human_output_opts
,
3139 ST_NBLOCKSIZE
, output_block_size
);
3140 char *pend
= p
+ strlen (p
);
3144 dired_outstring (_("total"));
3145 dired_outbuf (p
, pend
- p
);
3149 print_current_files ();
3152 /* Add 'pattern' to the list of patterns for which files that match are
3156 add_ignore_pattern (char const *pattern
)
3158 struct ignore_pattern
*ignore
;
3160 ignore
= xmalloc (sizeof *ignore
);
3161 ignore
->pattern
= pattern
;
3162 /* Add it to the head of the linked list. */
3163 ignore
->next
= ignore_patterns
;
3164 ignore_patterns
= ignore
;
3167 /* Return true if one of the PATTERNS matches FILE. */
3170 patterns_match (struct ignore_pattern
const *patterns
, char const *file
)
3172 struct ignore_pattern
const *p
;
3173 for (p
= patterns
; p
; p
= p
->next
)
3174 if (fnmatch (p
->pattern
, file
, FNM_PERIOD
) == 0)
3179 /* Return true if FILE should be ignored. */
3182 file_ignored (char const *name
)
3184 return ((ignore_mode
!= IGNORE_MINIMAL
3186 && (ignore_mode
== IGNORE_DEFAULT
|| ! name
[1 + (name
[1] == '.')]))
3187 || (ignore_mode
== IGNORE_DEFAULT
3188 && patterns_match (hide_patterns
, name
))
3189 || patterns_match (ignore_patterns
, name
));
3192 /* POSIX requires that a file size be printed without a sign, even
3193 when negative. Assume the typical case where negative sizes are
3194 actually positive values that have wrapped around. */
3197 unsigned_file_size (off_t size
)
3199 return size
+ (size
< 0) * ((uintmax_t) OFF_T_MAX
- OFF_T_MIN
+ 1);
3203 /* Return true if NAME has a capability (see linux/capability.h) */
3205 has_capability (char const *name
)
3210 cap_t cap_d
= cap_get_file (name
);
3211 if (cap_d
== nullptr)
3214 result
= cap_to_text (cap_d
, nullptr);
3219 /* check if human-readable capability string is empty */
3220 has_cap
= !!*result
;
3227 has_capability (MAYBE_UNUSED
char const *name
)
3234 /* Enter and remove entries in the table 'cwd_file'. */
3237 free_ent (struct fileinfo
*f
)
3241 free (f
->absolute_name
);
3242 if (f
->scontext
!= UNKNOWN_SECURITY_CONTEXT
)
3244 if (is_smack_enabled ())
3247 freecon (f
->scontext
);
3251 /* Empty the table of files. */
3255 for (size_t i
= 0; i
< cwd_n_used
; i
++)
3257 struct fileinfo
*f
= sorted_file
[i
];
3262 cwd_some_quoted
= false;
3263 any_has_acl
= false;
3264 inode_number_width
= 0;
3265 block_size_width
= 0;
3271 major_device_number_width
= 0;
3272 minor_device_number_width
= 0;
3273 file_size_width
= 0;
3276 /* Return true if ERR implies lack-of-support failure by a
3277 getxattr-calling function like getfilecon or file_has_acl. */
3279 errno_unsupported (int err
)
3281 return (err
== EINVAL
|| err
== ENOSYS
|| is_ENOTSUP (err
));
3284 /* Cache *getfilecon failure, when it's trivial to do so.
3285 Like getfilecon/lgetfilecon, but when F's st_dev says it's doesn't
3286 support getting the security context, fail with ENOTSUP immediately. */
3288 getfilecon_cache (char const *file
, struct fileinfo
*f
, bool deref
)
3290 /* st_dev of the most recently processed device for which we've
3291 found that [l]getfilecon fails indicating lack of support. */
3292 static dev_t unsupported_device
;
3294 if (f
->stat
.st_dev
== unsupported_device
)
3301 if (is_smack_enabled ())
3302 r
= smack_new_label_from_path (file
, "security.SMACK64", deref
,
3307 ? getfilecon (file
, &f
->scontext
)
3308 : lgetfilecon (file
, &f
->scontext
));
3309 if (r
< 0 && errno_unsupported (errno
))
3310 unsupported_device
= f
->stat
.st_dev
;
3314 /* Cache file_has_acl failure, when it's trivial to do.
3315 Like file_has_acl, but when F's st_dev says it's on a file
3316 system lacking ACL support, return 0 with ENOTSUP immediately. */
3318 file_has_acl_cache (char const *file
, struct fileinfo
*f
)
3320 /* st_dev of the most recently processed device for which we've
3321 found that file_has_acl fails indicating lack of support. */
3322 static dev_t unsupported_device
;
3324 if (f
->stat
.st_dev
== unsupported_device
)
3330 /* Zero errno so that we can distinguish between two 0-returning cases:
3331 "has-ACL-support, but only a default ACL" and "no ACL support". */
3333 int n
= file_has_acl (file
, &f
->stat
);
3334 if (n
<= 0 && errno_unsupported (errno
))
3335 unsupported_device
= f
->stat
.st_dev
;
3339 /* Cache has_capability failure, when it's trivial to do.
3340 Like has_capability, but when F's st_dev says it's on a file
3341 system lacking capability support, return 0 with ENOTSUP immediately. */
3343 has_capability_cache (char const *file
, struct fileinfo
*f
)
3345 /* st_dev of the most recently processed device for which we've
3346 found that has_capability fails indicating lack of support. */
3347 static dev_t unsupported_device
;
3349 if (f
->stat
.st_dev
== unsupported_device
)
3355 bool b
= has_capability (file
);
3356 if ( !b
&& errno_unsupported (errno
))
3357 unsupported_device
= f
->stat
.st_dev
;
3362 needs_quoting (char const *name
)
3365 size_t len
= quotearg_buffer (test
, sizeof test
, name
, -1,
3366 filename_quoting_options
);
3367 return *name
!= *test
|| strlen (name
) != len
;
3370 /* Add a file to the current table of files.
3371 Verify that the file exists, and print an error message if it does not.
3372 Return the number of blocks that the file occupies. */
3374 gobble_file (char const *name
, enum filetype type
, ino_t inode
,
3375 bool command_line_arg
, char const *dirname
)
3377 uintmax_t blocks
= 0;
3380 /* An inode value prior to gobble_file necessarily came from readdir,
3381 which is not used for command line arguments. */
3382 affirm (! command_line_arg
|| inode
== NOT_AN_INODE_NUMBER
);
3384 if (cwd_n_used
== cwd_n_alloc
)
3386 cwd_file
= xnrealloc (cwd_file
, cwd_n_alloc
, 2 * sizeof *cwd_file
);
3390 f
= &cwd_file
[cwd_n_used
];
3391 memset (f
, '\0', sizeof *f
);
3392 f
->stat
.st_ino
= inode
;
3396 if ((! cwd_some_quoted
) && align_variable_outer_quotes
)
3398 /* Determine if any quoted for padding purposes. */
3399 f
->quoted
= needs_quoting (name
);
3401 cwd_some_quoted
= 1;
3404 if (command_line_arg
3406 || format_needs_stat
3407 /* When coloring a directory (we may know the type from
3408 direct.d_type), we have to stat it in order to indicate
3409 sticky and/or other-writable attributes. */
3410 || (type
== directory
&& print_with_color
3411 && (is_colored (C_OTHER_WRITABLE
)
3412 || is_colored (C_STICKY
)
3413 || is_colored (C_STICKY_OTHER_WRITABLE
)))
3414 /* When dereferencing symlinks, the inode and type must come from
3415 stat, but readdir provides the inode and type of lstat. */
3416 || ((print_inode
|| format_needs_type
)
3417 && (type
== symbolic_link
|| type
== unknown
)
3418 && (dereference
== DEREF_ALWAYS
3419 || color_symlink_as_referent
|| check_symlink_mode
))
3420 /* Command line dereferences are already taken care of by the above
3421 assertion that the inode number is not yet known. */
3422 || (print_inode
&& inode
== NOT_AN_INODE_NUMBER
)
3423 || (format_needs_type
3424 && (type
== unknown
|| command_line_arg
3425 /* --indicator-style=classify (aka -F)
3426 requires that we stat each regular file
3427 to see if it's executable. */
3428 || (type
== normal
&& (indicator_style
== classify
3429 /* This is so that --color ends up
3430 highlighting files with these mode
3431 bits set even when options like -F are
3432 not specified. Note we do a redundant
3433 stat in the very unlikely case where
3434 C_CAP is set but not the others. */
3435 || (print_with_color
3436 && (is_colored (C_EXEC
)
3437 || is_colored (C_SETUID
)
3438 || is_colored (C_SETGID
)
3439 || is_colored (C_CAP
)))
3443 /* Absolute name of this file. */
3448 if (name
[0] == '/' || dirname
[0] == 0)
3449 full_name
= (char *) name
;
3452 full_name
= alloca (strlen (name
) + strlen (dirname
) + 2);
3453 attach (full_name
, dirname
, name
);
3456 if (print_hyperlink
)
3458 f
->absolute_name
= canonicalize_filename_mode (full_name
,
3460 if (! f
->absolute_name
)
3461 file_failure (command_line_arg
,
3462 _("error canonicalizing %s"), full_name
);
3465 switch (dereference
)
3468 err
= do_stat (full_name
, &f
->stat
);
3472 case DEREF_COMMAND_LINE_ARGUMENTS
:
3473 case DEREF_COMMAND_LINE_SYMLINK_TO_DIR
:
3474 if (command_line_arg
)
3477 err
= do_stat (full_name
, &f
->stat
);
3480 if (dereference
== DEREF_COMMAND_LINE_ARGUMENTS
)
3483 need_lstat
= (err
< 0
3484 ? (errno
== ENOENT
|| errno
== ELOOP
)
3485 : ! S_ISDIR (f
->stat
.st_mode
));
3489 /* stat failed because of ENOENT || ELOOP, maybe indicating a
3490 non-traversable symlink. Or stat succeeded,
3491 FULL_NAME does not refer to a directory,
3492 and --dereference-command-line-symlink-to-dir is in effect.
3493 Fall through so that we call lstat instead. */
3497 default: /* DEREF_NEVER */
3498 err
= do_lstat (full_name
, &f
->stat
);
3505 /* Failure to stat a command line argument leads to
3506 an exit status of 2. For other files, stat failure
3507 provokes an exit status of 1. */
3508 file_failure (command_line_arg
,
3509 _("cannot access %s"), full_name
);
3511 f
->scontext
= UNKNOWN_SECURITY_CONTEXT
;
3513 if (command_line_arg
)
3516 f
->name
= xstrdup (name
);
3524 /* Note has_capability() adds around 30% runtime to 'ls --color' */
3525 if ((type
== normal
|| S_ISREG (f
->stat
.st_mode
))
3526 && print_with_color
&& is_colored (C_CAP
))
3527 f
->has_capability
= has_capability_cache (full_name
, f
);
3529 if (format
== long_format
|| print_scontext
)
3531 bool have_scontext
= false;
3532 bool have_acl
= false;
3533 int attr_len
= getfilecon_cache (full_name
, f
, do_deref
);
3534 err
= (attr_len
< 0);
3538 if (is_smack_enabled ())
3539 have_scontext
= ! STREQ ("_", f
->scontext
);
3541 have_scontext
= ! STREQ ("unlabeled", f
->scontext
);
3545 f
->scontext
= UNKNOWN_SECURITY_CONTEXT
;
3547 /* When requesting security context information, don't make
3548 ls fail just because the file (even a command line argument)
3549 isn't on the right type of file system. I.e., a getfilecon
3550 failure isn't in the same class as a stat failure. */
3551 if (is_ENOTSUP (errno
) || errno
== ENODATA
)
3555 if (err
== 0 && format
== long_format
)
3557 int n
= file_has_acl_cache (full_name
, f
);
3562 f
->acl_type
= (!have_scontext
&& !have_acl
3564 : (have_scontext
&& !have_acl
3565 ? ACL_T_LSM_CONTEXT_ONLY
3567 any_has_acl
|= f
->acl_type
!= ACL_T_NONE
;
3570 error (0, errno
, "%s", quotef (full_name
));
3573 if (S_ISLNK (f
->stat
.st_mode
)
3574 && (format
== long_format
|| check_symlink_mode
))
3576 struct stat linkstats
;
3578 get_link_name (full_name
, f
, command_line_arg
);
3580 /* Use the slower quoting path for this entry, though
3581 don't update CWD_SOME_QUOTED since alignment not affected. */
3582 if (f
->linkname
&& f
->quoted
== 0 && needs_quoting (f
->linkname
))
3585 /* Avoid following symbolic links when possible, i.e., when
3586 they won't be traced and when no indicator is needed. */
3588 && (file_type
<= indicator_style
|| check_symlink_mode
)
3589 && stat_for_mode (full_name
, &linkstats
) == 0)
3592 f
->linkmode
= linkstats
.st_mode
;
3596 if (S_ISLNK (f
->stat
.st_mode
))
3597 f
->filetype
= symbolic_link
;
3598 else if (S_ISDIR (f
->stat
.st_mode
))
3600 if (command_line_arg
&& !immediate_dirs
)
3601 f
->filetype
= arg_directory
;
3603 f
->filetype
= directory
;
3606 f
->filetype
= normal
;
3608 blocks
= STP_NBLOCKS (&f
->stat
);
3609 if (format
== long_format
|| print_block_size
)
3611 char buf
[LONGEST_HUMAN_READABLE
+ 1];
3612 int len
= mbswidth (human_readable (blocks
, buf
, human_output_opts
,
3613 ST_NBLOCKSIZE
, output_block_size
),
3615 if (block_size_width
< len
)
3616 block_size_width
= len
;
3619 if (format
== long_format
)
3623 int len
= format_user_width (f
->stat
.st_uid
);
3624 if (owner_width
< len
)
3630 int len
= format_group_width (f
->stat
.st_gid
);
3631 if (group_width
< len
)
3637 int len
= format_user_width (f
->stat
.st_author
);
3638 if (author_width
< len
)
3645 int len
= strlen (f
->scontext
);
3646 if (scontext_width
< len
)
3647 scontext_width
= len
;
3650 if (format
== long_format
)
3652 char b
[INT_BUFSIZE_BOUND (uintmax_t)];
3653 int b_len
= strlen (umaxtostr (f
->stat
.st_nlink
, b
));
3654 if (nlink_width
< b_len
)
3655 nlink_width
= b_len
;
3657 if (S_ISCHR (f
->stat
.st_mode
) || S_ISBLK (f
->stat
.st_mode
))
3659 char buf
[INT_BUFSIZE_BOUND (uintmax_t)];
3660 int len
= strlen (umaxtostr (major (f
->stat
.st_rdev
), buf
));
3661 if (major_device_number_width
< len
)
3662 major_device_number_width
= len
;
3663 len
= strlen (umaxtostr (minor (f
->stat
.st_rdev
), buf
));
3664 if (minor_device_number_width
< len
)
3665 minor_device_number_width
= len
;
3666 len
= major_device_number_width
+ 2 + minor_device_number_width
;
3667 if (file_size_width
< len
)
3668 file_size_width
= len
;
3672 char buf
[LONGEST_HUMAN_READABLE
+ 1];
3673 uintmax_t size
= unsigned_file_size (f
->stat
.st_size
);
3674 int len
= mbswidth (human_readable (size
, buf
,
3675 file_human_output_opts
,
3676 1, file_output_block_size
),
3678 if (file_size_width
< len
)
3679 file_size_width
= len
;
3686 char buf
[INT_BUFSIZE_BOUND (uintmax_t)];
3687 int len
= strlen (umaxtostr (f
->stat
.st_ino
, buf
));
3688 if (inode_number_width
< len
)
3689 inode_number_width
= len
;
3692 f
->name
= xstrdup (name
);
3698 /* Return true if F refers to a directory. */
3700 is_directory (const struct fileinfo
*f
)
3702 return f
->filetype
== directory
|| f
->filetype
== arg_directory
;
3705 /* Return true if F refers to a (symlinked) directory. */
3707 is_linked_directory (const struct fileinfo
*f
)
3709 return f
->filetype
== directory
|| f
->filetype
== arg_directory
3710 || S_ISDIR (f
->linkmode
);
3713 /* Put the name of the file that FILENAME is a symbolic link to
3714 into the LINKNAME field of 'f'. COMMAND_LINE_ARG indicates whether
3715 FILENAME is a command-line argument. */
3718 get_link_name (char const *filename
, struct fileinfo
*f
, bool command_line_arg
)
3720 f
->linkname
= areadlink_with_size (filename
, f
->stat
.st_size
);
3721 if (f
->linkname
== nullptr)
3722 file_failure (command_line_arg
, _("cannot read symbolic link %s"),
3726 /* Return true if the last component of NAME is '.' or '..'
3727 This is so we don't try to recurse on '././././. ...' */
3730 basename_is_dot_or_dotdot (char const *name
)
3732 char const *base
= last_component (name
);
3733 return dot_or_dotdot (base
);
3736 /* Remove any entries from CWD_FILE that are for directories,
3737 and queue them to be listed as directories instead.
3738 DIRNAME is the prefix to prepend to each dirname
3739 to make it correct relative to ls's working dir;
3740 if it is null, no prefix is needed and "." and ".." should not be ignored.
3741 If COMMAND_LINE_ARG is true, this directory was mentioned at the top level,
3742 This is desirable when processing directories recursively. */
3745 extract_dirs_from_files (char const *dirname
, bool command_line_arg
)
3749 bool ignore_dot_and_dot_dot
= (dirname
!= nullptr);
3751 if (dirname
&& LOOP_DETECT
)
3753 /* Insert a marker entry first. When we dequeue this marker entry,
3754 we'll know that DIRNAME has been processed and may be removed
3755 from the set of active directories. */
3756 queue_directory (nullptr, dirname
, false);
3759 /* Queue the directories last one first, because queueing reverses the
3761 for (i
= cwd_n_used
; i
-- != 0; )
3763 struct fileinfo
*f
= sorted_file
[i
];
3765 if (is_directory (f
)
3766 && (! ignore_dot_and_dot_dot
3767 || ! basename_is_dot_or_dotdot (f
->name
)))
3769 if (!dirname
|| f
->name
[0] == '/')
3770 queue_directory (f
->name
, f
->linkname
, command_line_arg
);
3773 char *name
= file_name_concat (dirname
, f
->name
, nullptr);
3774 queue_directory (name
, f
->linkname
, command_line_arg
);
3777 if (f
->filetype
== arg_directory
)
3782 /* Now delete the directories from the table, compacting all the remaining
3785 for (i
= 0, j
= 0; i
< cwd_n_used
; i
++)
3787 struct fileinfo
*f
= sorted_file
[i
];
3789 j
+= (f
->filetype
!= arg_directory
);
3794 /* Use strcoll to compare strings in this locale. If an error occurs,
3795 report an error and longjmp to failed_strcoll. */
3797 static jmp_buf failed_strcoll
;
3800 xstrcoll (char const *a
, char const *b
)
3804 diff
= strcoll (a
, b
);
3807 error (0, errno
, _("cannot compare file names %s and %s"),
3808 quote_n (0, a
), quote_n (1, b
));
3809 set_exit_status (false);
3810 longjmp (failed_strcoll
, 1);
3815 /* Comparison routines for sorting the files. */
3817 typedef void const *V
;
3818 typedef int (*qsortFunc
)(V a
, V b
);
3820 /* Used below in DEFINE_SORT_FUNCTIONS for _df_ sort function variants. */
3822 dirfirst_check (struct fileinfo
const *a
, struct fileinfo
const *b
,
3825 int diff
= is_linked_directory (b
) - is_linked_directory (a
);
3826 return diff
? diff
: cmp (a
, b
);
3829 /* Define the 8 different sort function variants required for each sortkey.
3830 KEY_NAME is a token describing the sort key, e.g., ctime, atime, size.
3831 KEY_CMP_FUNC is a function to compare records based on that key, e.g.,
3832 ctime_cmp, atime_cmp, size_cmp. Append KEY_NAME to the string,
3833 '[rev_][x]str{cmp|coll}[_df]_', to create each function name. */
3834 #define DEFINE_SORT_FUNCTIONS(key_name, key_cmp_func) \
3835 /* direct, non-dirfirst versions */ \
3836 static int xstrcoll_##key_name (V a, V b) \
3837 { return key_cmp_func (a, b, xstrcoll); } \
3838 ATTRIBUTE_PURE static int strcmp_##key_name (V a, V b) \
3839 { return key_cmp_func (a, b, strcmp); } \
3841 /* reverse, non-dirfirst versions */ \
3842 static int rev_xstrcoll_##key_name (V a, V b) \
3843 { return key_cmp_func (b, a, xstrcoll); } \
3844 ATTRIBUTE_PURE static int rev_strcmp_##key_name (V a, V b) \
3845 { return key_cmp_func (b, a, strcmp); } \
3847 /* direct, dirfirst versions */ \
3848 static int xstrcoll_df_##key_name (V a, V b) \
3849 { return dirfirst_check (a, b, xstrcoll_##key_name); } \
3850 ATTRIBUTE_PURE static int strcmp_df_##key_name (V a, V b) \
3851 { return dirfirst_check (a, b, strcmp_##key_name); } \
3853 /* reverse, dirfirst versions */ \
3854 static int rev_xstrcoll_df_##key_name (V a, V b) \
3855 { return dirfirst_check (a, b, rev_xstrcoll_##key_name); } \
3856 ATTRIBUTE_PURE static int rev_strcmp_df_##key_name (V a, V b) \
3857 { return dirfirst_check (a, b, rev_strcmp_##key_name); }
3860 cmp_ctime (struct fileinfo
const *a
, struct fileinfo
const *b
,
3861 int (*cmp
) (char const *, char const *))
3863 int diff
= timespec_cmp (get_stat_ctime (&b
->stat
),
3864 get_stat_ctime (&a
->stat
));
3865 return diff
? diff
: cmp (a
->name
, b
->name
);
3869 cmp_mtime (struct fileinfo
const *a
, struct fileinfo
const *b
,
3870 int (*cmp
) (char const *, char const *))
3872 int diff
= timespec_cmp (get_stat_mtime (&b
->stat
),
3873 get_stat_mtime (&a
->stat
));
3874 return diff
? diff
: cmp (a
->name
, b
->name
);
3878 cmp_atime (struct fileinfo
const *a
, struct fileinfo
const *b
,
3879 int (*cmp
) (char const *, char const *))
3881 int diff
= timespec_cmp (get_stat_atime (&b
->stat
),
3882 get_stat_atime (&a
->stat
));
3883 return diff
? diff
: cmp (a
->name
, b
->name
);
3887 cmp_btime (struct fileinfo
const *a
, struct fileinfo
const *b
,
3888 int (*cmp
) (char const *, char const *))
3890 int diff
= timespec_cmp (get_stat_btime (&b
->stat
),
3891 get_stat_btime (&a
->stat
));
3892 return diff
? diff
: cmp (a
->name
, b
->name
);
3896 off_cmp (off_t a
, off_t b
)
3898 return (a
> b
) - (a
< b
);
3902 cmp_size (struct fileinfo
const *a
, struct fileinfo
const *b
,
3903 int (*cmp
) (char const *, char const *))
3905 int diff
= off_cmp (b
->stat
.st_size
, a
->stat
.st_size
);
3906 return diff
? diff
: cmp (a
->name
, b
->name
);
3910 cmp_name (struct fileinfo
const *a
, struct fileinfo
const *b
,
3911 int (*cmp
) (char const *, char const *))
3913 return cmp (a
->name
, b
->name
);
3916 /* Compare file extensions. Files with no extension are 'smallest'.
3917 If extensions are the same, compare by file names instead. */
3920 cmp_extension (struct fileinfo
const *a
, struct fileinfo
const *b
,
3921 int (*cmp
) (char const *, char const *))
3923 char const *base1
= strrchr (a
->name
, '.');
3924 char const *base2
= strrchr (b
->name
, '.');
3925 int diff
= cmp (base1
? base1
: "", base2
? base2
: "");
3926 return diff
? diff
: cmp (a
->name
, b
->name
);
3929 /* Return the (cached) screen width,
3930 for the NAME associated with the passed fileinfo F. */
3933 fileinfo_name_width (struct fileinfo
const *f
)
3937 : quote_name_width (f
->name
, filename_quoting_options
, f
->quoted
);
3941 cmp_width (struct fileinfo
const *a
, struct fileinfo
const *b
,
3942 int (*cmp
) (char const *, char const *))
3944 int diff
= fileinfo_name_width (a
) - fileinfo_name_width (b
);
3945 return diff
? diff
: cmp (a
->name
, b
->name
);
3948 DEFINE_SORT_FUNCTIONS (ctime
, cmp_ctime
)
3949 DEFINE_SORT_FUNCTIONS (mtime
, cmp_mtime
)
3950 DEFINE_SORT_FUNCTIONS (atime
, cmp_atime
)
3951 DEFINE_SORT_FUNCTIONS (btime
, cmp_btime
)
3952 DEFINE_SORT_FUNCTIONS (size
, cmp_size
)
3953 DEFINE_SORT_FUNCTIONS (name
, cmp_name
)
3954 DEFINE_SORT_FUNCTIONS (extension
, cmp_extension
)
3955 DEFINE_SORT_FUNCTIONS (width
, cmp_width
)
3957 /* Compare file versions.
3958 Unlike the other compare functions, cmp_version does not fail
3959 because filevercmp and strcmp do not fail; cmp_version uses strcmp
3960 instead of xstrcoll because filevercmp is locale-independent so
3961 strcmp is its appropriate secondary.
3963 All the other sort options need xstrcoll and strcmp variants,
3964 because they all use xstrcoll (either as the primary or secondary
3965 sort key), and xstrcoll has the ability to do a longjmp if strcoll fails for
3968 cmp_version (struct fileinfo
const *a
, struct fileinfo
const *b
)
3970 int diff
= filevercmp (a
->name
, b
->name
);
3971 return diff
? diff
: strcmp (a
->name
, b
->name
);
3975 xstrcoll_version (V a
, V b
)
3977 return cmp_version (a
, b
);
3980 rev_xstrcoll_version (V a
, V b
)
3982 return cmp_version (b
, a
);
3985 xstrcoll_df_version (V a
, V b
)
3987 return dirfirst_check (a
, b
, xstrcoll_version
);
3990 rev_xstrcoll_df_version (V a
, V b
)
3992 return dirfirst_check (a
, b
, rev_xstrcoll_version
);
3996 /* We have 2^3 different variants for each sort-key function
3997 (for 3 independent sort modes).
3998 The function pointers stored in this array must be dereferenced as:
4000 sort_variants[sort_key][use_strcmp][reverse][dirs_first]
4002 Note that the order in which sort keys are listed in the function pointer
4003 array below is defined by the order of the elements in the time_type and
4006 #define LIST_SORTFUNCTION_VARIANTS(key_name) \
4009 { xstrcoll_##key_name, xstrcoll_df_##key_name }, \
4010 { rev_xstrcoll_##key_name, rev_xstrcoll_df_##key_name }, \
4013 { strcmp_##key_name, strcmp_df_##key_name }, \
4014 { rev_strcmp_##key_name, rev_strcmp_df_##key_name }, \
4018 static qsortFunc
const sort_functions
[][2][2][2] =
4020 LIST_SORTFUNCTION_VARIANTS (name
),
4021 LIST_SORTFUNCTION_VARIANTS (extension
),
4022 LIST_SORTFUNCTION_VARIANTS (width
),
4023 LIST_SORTFUNCTION_VARIANTS (size
),
4027 { xstrcoll_version
, xstrcoll_df_version
},
4028 { rev_xstrcoll_version
, rev_xstrcoll_df_version
},
4031 /* We use nullptr for the strcmp variants of version comparison
4032 since as explained in cmp_version definition, version comparison
4033 does not rely on xstrcoll, so it will never longjmp, and never
4034 need to try the strcmp fallback. */
4036 { nullptr, nullptr },
4037 { nullptr, nullptr },
4041 /* last are time sort functions */
4042 LIST_SORTFUNCTION_VARIANTS (mtime
),
4043 LIST_SORTFUNCTION_VARIANTS (ctime
),
4044 LIST_SORTFUNCTION_VARIANTS (atime
),
4045 LIST_SORTFUNCTION_VARIANTS (btime
)
4048 /* The number of sort keys is calculated as the sum of
4049 the number of elements in the sort_type enum (i.e., sort_numtypes)
4050 -2 because neither sort_time nor sort_none use entries themselves
4051 the number of elements in the time_type enum (i.e., time_numtypes)
4052 This is because when sort_type==sort_time, we have up to
4053 time_numtypes possible sort keys.
4055 This line verifies at compile-time that the array of sort functions has been
4056 initialized for all possible sort keys. */
4057 static_assert (ARRAY_CARDINALITY (sort_functions
)
4058 == sort_numtypes
- 2 + time_numtypes
);
4060 /* Set up SORTED_FILE to point to the in-use entries in CWD_FILE, in order. */
4063 initialize_ordering_vector (void)
4065 for (size_t i
= 0; i
< cwd_n_used
; i
++)
4066 sorted_file
[i
] = &cwd_file
[i
];
4069 /* Cache values based on attributes global to all files. */
4072 update_current_files_info (void)
4074 /* Cache screen width of name, if needed multiple times. */
4075 if (sort_type
== sort_width
4076 || (line_length
&& (format
== many_per_line
|| format
== horizontal
)))
4079 for (i
= 0; i
< cwd_n_used
; i
++)
4081 struct fileinfo
*f
= sorted_file
[i
];
4082 f
->width
= fileinfo_name_width (f
);
4087 /* Sort the files now in the table. */
4094 if (sorted_file_alloc
< cwd_n_used
+ cwd_n_used
/ 2)
4097 sorted_file
= xnmalloc (cwd_n_used
, 3 * sizeof *sorted_file
);
4098 sorted_file_alloc
= 3 * cwd_n_used
;
4101 initialize_ordering_vector ();
4103 update_current_files_info ();
4105 if (sort_type
== sort_none
)
4108 /* Try strcoll. If it fails, fall back on strcmp. We can't safely
4109 ignore strcoll failures, as a failing strcoll might be a
4110 comparison function that is not a total order, and if we ignored
4111 the failure this might cause qsort to dump core. */
4113 if (! setjmp (failed_strcoll
))
4114 use_strcmp
= false; /* strcoll() succeeded */
4118 affirm (sort_type
!= sort_version
);
4119 initialize_ordering_vector ();
4122 /* When sort_type == sort_time, use time_type as subindex. */
4123 mpsort ((void const **) sorted_file
, cwd_n_used
,
4124 sort_functions
[sort_type
+ (sort_type
== sort_time
? time_type
: 0)]
4125 [use_strcmp
][sort_reverse
]
4126 [directories_first
]);
4129 /* List all the files now in the table. */
4132 print_current_files (void)
4139 for (i
= 0; i
< cwd_n_used
; i
++)
4141 print_file_name_and_frills (sorted_file
[i
], 0);
4148 print_with_separator (' ');
4150 print_many_per_line ();
4155 print_with_separator (' ');
4157 print_horizontal ();
4161 print_with_separator (',');
4165 for (i
= 0; i
< cwd_n_used
; i
++)
4167 set_normal_color ();
4168 print_long_format (sorted_file
[i
]);
4169 dired_outbyte (eolbyte
);
4175 /* Replace the first %b with precomputed aligned month names.
4176 Note on glibc-2.7 at least, this speeds up the whole 'ls -lU'
4177 process by around 17%, compared to letting strftime() handle the %b. */
4180 align_nstrftime (char *buf
, size_t size
, bool recent
, struct tm
const *tm
,
4181 timezone_t tz
, int ns
)
4183 char const *nfmt
= (use_abformat
4184 ? abformat
[recent
][tm
->tm_mon
]
4185 : long_time_format
[recent
]);
4186 return nstrftime (buf
, size
, nfmt
, tm
, tz
, ns
);
4189 /* Return the expected number of columns in a long-format timestamp,
4190 or zero if it cannot be calculated. */
4193 long_time_expected_width (void)
4195 static int width
= -1;
4201 char buf
[TIME_STAMP_LEN_MAXIMUM
+ 1];
4203 /* In case you're wondering if localtime_rz can fail with an input time_t
4204 value of 0, let's just say it's very unlikely, but not inconceivable.
4205 The TZ environment variable would have to specify a time zone that
4206 is 2**31-1900 years or more ahead of UTC. This could happen only on
4207 a 64-bit system that blindly accepts e.g., TZ=UTC+20000000000000.
4208 However, this is not possible with Solaris 10 or glibc-2.3.5, since
4209 their implementations limit the offset to 167:59 and 24:00, resp. */
4210 if (localtime_rz (localtz
, &epoch
, &tm
))
4212 size_t len
= align_nstrftime (buf
, sizeof buf
, false,
4215 width
= mbsnwidth (buf
, len
, MBSWIDTH_FLAGS
);
4225 /* Print the user or group name NAME, with numeric id ID, using a
4226 print width of WIDTH columns. */
4229 format_user_or_group (char const *name
, uintmax_t id
, int width
)
4233 int name_width
= mbswidth (name
, MBSWIDTH_FLAGS
);
4234 int width_gap
= name_width
< 0 ? 0 : width
- name_width
;
4235 int pad
= MAX (0, width_gap
);
4236 dired_outstring (name
);
4239 dired_outbyte (' ');
4243 dired_pos
+= printf ("%*ju ", width
, id
);
4246 /* Print the name or id of the user with id U, using a print width of
4250 format_user (uid_t u
, int width
, bool stat_ok
)
4252 format_user_or_group (! stat_ok
? "?" :
4253 (numeric_ids
? nullptr : getuser (u
)), u
, width
);
4256 /* Likewise, for groups. */
4259 format_group (gid_t g
, int width
, bool stat_ok
)
4261 format_user_or_group (! stat_ok
? "?" :
4262 (numeric_ids
? nullptr : getgroup (g
)), g
, width
);
4265 /* Return the number of columns that format_user_or_group will print,
4266 or -1 if unknown. */
4269 format_user_or_group_width (char const *name
, uintmax_t id
)
4272 ? mbswidth (name
, MBSWIDTH_FLAGS
)
4273 : snprintf (nullptr, 0, "%ju", id
));
4276 /* Return the number of columns that format_user will print,
4277 or -1 if unknown. */
4280 format_user_width (uid_t u
)
4282 return format_user_or_group_width (numeric_ids
? nullptr : getuser (u
), u
);
4285 /* Likewise, for groups. */
4288 format_group_width (gid_t g
)
4290 return format_user_or_group_width (numeric_ids
? nullptr : getgroup (g
), g
);
4293 /* Return a pointer to a formatted version of F->stat.st_ino,
4294 possibly using buffer, which must be at least
4295 INT_BUFSIZE_BOUND (uintmax_t) bytes. */
4297 format_inode (char buf
[INT_BUFSIZE_BOUND (uintmax_t)],
4298 const struct fileinfo
*f
)
4300 return (f
->stat_ok
&& f
->stat
.st_ino
!= NOT_AN_INODE_NUMBER
4301 ? umaxtostr (f
->stat
.st_ino
, buf
)
4305 /* Print information about F in long format. */
4307 print_long_format (const struct fileinfo
*f
)
4311 [LONGEST_HUMAN_READABLE
+ 1 /* inode */
4312 + LONGEST_HUMAN_READABLE
+ 1 /* size in blocks */
4313 + sizeof (modebuf
) - 1 + 1 /* mode string */
4314 + INT_BUFSIZE_BOUND (uintmax_t) /* st_nlink */
4315 + LONGEST_HUMAN_READABLE
+ 2 /* major device number */
4316 + LONGEST_HUMAN_READABLE
+ 1 /* minor device number */
4317 + TIME_STAMP_LEN_MAXIMUM
+ 1 /* max length of time/date */
4321 struct timespec when_timespec
;
4322 struct tm when_local
;
4323 bool btime_ok
= true;
4325 /* Compute the mode string, except remove the trailing space if no
4326 file in this directory has an ACL or security context. */
4328 filemodestring (&f
->stat
, modebuf
);
4331 modebuf
[0] = filetype_letter
[f
->filetype
];
4332 memset (modebuf
+ 1, '?', 10);
4337 else if (f
->acl_type
== ACL_T_LSM_CONTEXT_ONLY
)
4339 else if (f
->acl_type
== ACL_T_YES
)
4345 when_timespec
= get_stat_ctime (&f
->stat
);
4348 when_timespec
= get_stat_mtime (&f
->stat
);
4351 when_timespec
= get_stat_atime (&f
->stat
);
4354 when_timespec
= get_stat_btime (&f
->stat
);
4355 if (when_timespec
.tv_sec
== -1 && when_timespec
.tv_nsec
== -1)
4366 char hbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
4367 p
+= sprintf (p
, "%*s ", inode_number_width
, format_inode (hbuf
, f
));
4370 if (print_block_size
)
4372 char hbuf
[LONGEST_HUMAN_READABLE
+ 1];
4373 char const *blocks
=
4376 : human_readable (STP_NBLOCKS (&f
->stat
), hbuf
, human_output_opts
,
4377 ST_NBLOCKSIZE
, output_block_size
));
4378 int blocks_width
= mbswidth (blocks
, MBSWIDTH_FLAGS
);
4379 for (int pad
= blocks_width
< 0 ? 0 : block_size_width
- blocks_width
;
4382 while ((*p
++ = *blocks
++))
4387 /* The last byte of the mode string is the POSIX
4388 "optional alternate access method flag". */
4390 char hbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
4391 p
+= sprintf (p
, "%s %*s ", modebuf
, nlink_width
,
4392 ! f
->stat_ok
? "?" : umaxtostr (f
->stat
.st_nlink
, hbuf
));
4397 if (print_owner
|| print_group
|| print_author
|| print_scontext
)
4399 dired_outbuf (buf
, p
- buf
);
4402 format_user (f
->stat
.st_uid
, owner_width
, f
->stat_ok
);
4405 format_group (f
->stat
.st_gid
, group_width
, f
->stat_ok
);
4408 format_user (f
->stat
.st_author
, author_width
, f
->stat_ok
);
4411 format_user_or_group (f
->scontext
, 0, scontext_width
);
4417 && (S_ISCHR (f
->stat
.st_mode
) || S_ISBLK (f
->stat
.st_mode
)))
4419 char majorbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
4420 char minorbuf
[INT_BUFSIZE_BOUND (uintmax_t)];
4421 int blanks_width
= (file_size_width
4422 - (major_device_number_width
+ 2
4423 + minor_device_number_width
));
4424 p
+= sprintf (p
, "%*s, %*s ",
4425 major_device_number_width
+ MAX (0, blanks_width
),
4426 umaxtostr (major (f
->stat
.st_rdev
), majorbuf
),
4427 minor_device_number_width
,
4428 umaxtostr (minor (f
->stat
.st_rdev
), minorbuf
));
4432 char hbuf
[LONGEST_HUMAN_READABLE
+ 1];
4436 : human_readable (unsigned_file_size (f
->stat
.st_size
),
4437 hbuf
, file_human_output_opts
, 1,
4438 file_output_block_size
));
4439 int size_width
= mbswidth (size
, MBSWIDTH_FLAGS
);
4440 for (int pad
= size_width
< 0 ? 0 : file_size_width
- size_width
;
4443 while ((*p
++ = *size
++))
4451 if (f
->stat_ok
&& btime_ok
4452 && localtime_rz (localtz
, &when_timespec
.tv_sec
, &when_local
))
4454 struct timespec six_months_ago
;
4457 /* If the file appears to be in the future, update the current
4458 time, in case the file happens to have been modified since
4459 the last time we checked the clock. */
4460 if (timespec_cmp (current_time
, when_timespec
) < 0)
4461 gettime (¤t_time
);
4463 /* Consider a time to be recent if it is within the past six months.
4464 A Gregorian year has 365.2425 * 24 * 60 * 60 == 31556952 seconds
4465 on the average. Write this value as an integer constant to
4466 avoid floating point hassles. */
4467 six_months_ago
.tv_sec
= current_time
.tv_sec
- 31556952 / 2;
4468 six_months_ago
.tv_nsec
= current_time
.tv_nsec
;
4470 recent
= (timespec_cmp (six_months_ago
, when_timespec
) < 0
4471 && timespec_cmp (when_timespec
, current_time
) < 0);
4473 /* We assume here that all time zones are offset from UTC by a
4474 whole number of seconds. */
4475 s
= align_nstrftime (p
, TIME_STAMP_LEN_MAXIMUM
+ 1, recent
,
4476 &when_local
, localtz
, when_timespec
.tv_nsec
);
4486 /* The time cannot be converted using the desired format, so
4487 print it as a huge integer number of seconds. */
4488 char hbuf
[INT_BUFSIZE_BOUND (intmax_t)];
4489 p
+= sprintf (p
, "%*s ", long_time_expected_width (),
4490 (! f
->stat_ok
|| ! btime_ok
4492 : timetostr (when_timespec
.tv_sec
, hbuf
)));
4493 /* FIXME: (maybe) We discarded when_timespec.tv_nsec. */
4496 dired_outbuf (buf
, p
- buf
);
4497 size_t w
= print_name_with_quoting (f
, false, &dired_obstack
, p
- buf
);
4499 if (f
->filetype
== symbolic_link
)
4503 dired_outstring (" -> ");
4504 print_name_with_quoting (f
, true, nullptr, (p
- buf
) + w
+ 4);
4505 if (indicator_style
!= none
)
4506 print_type_indicator (true, f
->linkmode
, unknown
);
4509 else if (indicator_style
!= none
)
4510 print_type_indicator (f
->stat_ok
, f
->stat
.st_mode
, f
->filetype
);
4513 /* Write to *BUF a quoted representation of the file name NAME, if non-null,
4514 using OPTIONS to control quoting. *BUF is set to NAME if no quoting
4515 is required. *BUF is allocated if more space required (and the original
4516 *BUF is not deallocated).
4517 Store the number of screen columns occupied by NAME's quoted
4518 representation into WIDTH, if non-null.
4519 Store into PAD whether an initial space is needed for padding.
4520 Return the number of bytes in *BUF. */
4523 quote_name_buf (char **inbuf
, size_t bufsize
, char *name
,
4524 struct quoting_options
const *options
,
4525 int needs_general_quoting
, size_t *width
, bool *pad
)
4528 size_t displayed_width
IF_LINT ( = 0);
4532 enum quoting_style qs
= get_quoting_style (options
);
4533 bool needs_further_quoting
= qmark_funny_chars
4534 && (qs
== shell_quoting_style
4535 || qs
== shell_always_quoting_style
4536 || qs
== literal_quoting_style
);
4538 if (needs_general_quoting
!= 0)
4540 len
= quotearg_buffer (buf
, bufsize
, name
, -1, options
);
4543 buf
= xmalloc (len
+ 1);
4544 quotearg_buffer (buf
, len
+ 1, name
, -1, options
);
4547 quoted
= (*name
!= *buf
) || strlen (name
) != len
;
4549 else if (needs_further_quoting
)
4551 len
= strlen (name
);
4553 buf
= xmalloc (len
+ 1);
4554 memcpy (buf
, name
, len
+ 1);
4560 len
= strlen (name
);
4565 if (needs_further_quoting
)
4569 char const *p
= buf
;
4570 char const *plimit
= buf
+ len
;
4572 displayed_width
= 0;
4577 case ' ': case '!': case '"': case '#': case '%':
4578 case '&': case '\'': case '(': case ')': case '*':
4579 case '+': case ',': case '-': case '.': case '/':
4580 case '0': case '1': case '2': case '3': case '4':
4581 case '5': case '6': case '7': case '8': case '9':
4582 case ':': case ';': case '<': case '=': case '>':
4584 case 'A': case 'B': case 'C': case 'D': case 'E':
4585 case 'F': case 'G': case 'H': case 'I': case 'J':
4586 case 'K': case 'L': case 'M': case 'N': case 'O':
4587 case 'P': case 'Q': case 'R': case 'S': case 'T':
4588 case 'U': case 'V': case 'W': case 'X': case 'Y':
4590 case '[': case '\\': case ']': case '^': case '_':
4591 case 'a': case 'b': case 'c': case 'd': case 'e':
4592 case 'f': case 'g': case 'h': case 'i': case 'j':
4593 case 'k': case 'l': case 'm': case 'n': case 'o':
4594 case 'p': case 'q': case 'r': case 's': case 't':
4595 case 'u': case 'v': case 'w': case 'x': case 'y':
4596 case 'z': case '{': case '|': case '}': case '~':
4597 /* These characters are printable ASCII characters. */
4599 displayed_width
+= 1;
4602 /* If we have a multibyte sequence, copy it until we
4603 reach its end, replacing each non-printable multibyte
4604 character with a single question mark. */
4606 mbstate_t mbstate
; mbszero (&mbstate
);
4613 bytes
= mbrtoc32 (&wc
, p
, plimit
- p
, &mbstate
);
4615 if (bytes
== (size_t) -1)
4617 /* An invalid multibyte sequence was
4618 encountered. Skip one input byte, and
4619 put a question mark. */
4622 displayed_width
+= 1;
4626 if (bytes
== (size_t) -2)
4628 /* An incomplete multibyte character
4629 at the end. Replace it entirely with
4633 displayed_width
+= 1;
4638 /* A null wide character was encountered. */
4644 /* A printable multibyte character.
4646 for (; bytes
> 0; --bytes
)
4648 displayed_width
+= w
;
4652 /* An nonprintable multibyte character.
4653 Replace it entirely with a question
4657 displayed_width
+= 1;
4660 while (! mbsinit (&mbstate
));
4665 /* The buffer may have shrunk. */
4671 char const *plimit
= buf
+ len
;
4675 if (! isprint (to_uchar (*p
)))
4679 displayed_width
= len
;
4682 else if (width
!= nullptr)
4686 displayed_width
= mbsnwidth (buf
, len
, MBSWIDTH_FLAGS
);
4687 displayed_width
= MAX (0, displayed_width
);
4691 char const *p
= buf
;
4692 char const *plimit
= buf
+ len
;
4694 displayed_width
= 0;
4697 if (isprint (to_uchar (*p
)))
4704 /* Set padding to better align quoted items,
4705 and also give a visual indication that quotes are
4706 not actually part of the name. */
4707 *pad
= (align_variable_outer_quotes
&& cwd_some_quoted
&& ! quoted
);
4709 if (width
!= nullptr)
4710 *width
= displayed_width
;
4718 quote_name_width (char const *name
, struct quoting_options
const *options
,
4719 int needs_general_quoting
)
4721 char smallbuf
[BUFSIZ
];
4722 char *buf
= smallbuf
;
4726 quote_name_buf (&buf
, sizeof smallbuf
, (char *) name
, options
,
4727 needs_general_quoting
, &width
, &pad
);
4729 if (buf
!= smallbuf
&& buf
!= name
)
4737 /* %XX escape any input out of range as defined in RFC3986,
4738 and also if PATH, convert all path separators to '/'. */
4740 file_escape (char const *str
, bool path
)
4742 char *esc
= xnmalloc (3, strlen (str
) + 1);
4746 if (path
&& ISSLASH (*str
))
4751 else if (RFC3986
[to_uchar (*str
)])
4754 p
+= sprintf (p
, "%%%02x", to_uchar (*str
++));
4761 quote_name (char const *name
, struct quoting_options
const *options
,
4762 int needs_general_quoting
, const struct bin_str
*color
,
4763 bool allow_pad
, struct obstack
*stack
, char const *absolute_name
)
4765 char smallbuf
[BUFSIZ
];
4766 char *buf
= smallbuf
;
4770 len
= quote_name_buf (&buf
, sizeof smallbuf
, (char *) name
, options
,
4771 needs_general_quoting
, nullptr, &pad
);
4773 if (pad
&& allow_pad
)
4774 dired_outbyte (' ');
4777 print_color_indicator (color
);
4779 /* If we're padding, then don't include the outer quotes in
4780 the --hyperlink, to improve the alignment of those links. */
4781 bool skip_quotes
= false;
4785 if (align_variable_outer_quotes
&& cwd_some_quoted
&& ! pad
)
4790 char *h
= file_escape (hostname
, /* path= */ false);
4791 char *n
= file_escape (absolute_name
, /* path= */ true);
4792 /* TODO: It would be good to be able to define parameters
4793 to give hints to the terminal as how best to render the URI.
4794 For example since ls is outputting a dense block of URIs
4795 it would be best to not underline by default, and only
4796 do so upon hover etc. */
4797 printf ("\033]8;;file://%s%s%s\a", h
, *n
== '/' ? "" : "/", n
);
4803 push_current_dired_pos (stack
);
4805 fwrite (buf
+ skip_quotes
, 1, len
- (skip_quotes
* 2), stdout
);
4810 push_current_dired_pos (stack
);
4814 fputs ("\033]8;;\a", stdout
);
4816 putchar (*(buf
+ len
- 1));
4819 if (buf
!= smallbuf
&& buf
!= name
)
4826 print_name_with_quoting (const struct fileinfo
*f
,
4827 bool symlink_target
,
4828 struct obstack
*stack
,
4831 char const *name
= symlink_target
? f
->linkname
: f
->name
;
4833 const struct bin_str
*color
4834 = print_with_color
? get_color_indicator (f
, symlink_target
) : nullptr;
4836 bool used_color_this_time
= (print_with_color
4837 && (color
|| is_colored (C_NORM
)));
4839 size_t len
= quote_name (name
, filename_quoting_options
, f
->quoted
,
4840 color
, !symlink_target
, stack
, f
->absolute_name
);
4843 if (used_color_this_time
)
4845 prep_non_filename_text ();
4847 /* We use the byte length rather than display width here as
4848 an optimization to avoid accurately calculating the width,
4849 because we only output the clear to EOL sequence if the name
4850 _might_ wrap to the next line. This may output a sequence
4851 unnecessarily in multi-byte locales for example,
4852 but in that case it's inconsequential to the output. */
4854 && (start_col
/ line_length
!= (start_col
+ len
- 1) / line_length
))
4855 put_indicator (&color_indicator
[C_CLR_TO_EOL
]);
4862 prep_non_filename_text (void)
4864 if (color_indicator
[C_END
].string
!= nullptr)
4865 put_indicator (&color_indicator
[C_END
]);
4868 put_indicator (&color_indicator
[C_LEFT
]);
4869 put_indicator (&color_indicator
[C_RESET
]);
4870 put_indicator (&color_indicator
[C_RIGHT
]);
4874 /* Print the file name of 'f' with appropriate quoting.
4875 Also print file size, inode number, and filetype indicator character,
4876 as requested by switches. */
4879 print_file_name_and_frills (const struct fileinfo
*f
, size_t start_col
)
4881 char buf
[MAX (LONGEST_HUMAN_READABLE
+ 1, INT_BUFSIZE_BOUND (uintmax_t))];
4883 set_normal_color ();
4886 printf ("%*s ", format
== with_commas
? 0 : inode_number_width
,
4887 format_inode (buf
, f
));
4889 if (print_block_size
)
4890 printf ("%*s ", format
== with_commas
? 0 : block_size_width
,
4892 : human_readable (STP_NBLOCKS (&f
->stat
), buf
, human_output_opts
,
4893 ST_NBLOCKSIZE
, output_block_size
));
4896 printf ("%*s ", format
== with_commas
? 0 : scontext_width
, f
->scontext
);
4898 size_t width
= print_name_with_quoting (f
, false, nullptr, start_col
);
4900 if (indicator_style
!= none
)
4901 width
+= print_type_indicator (f
->stat_ok
, f
->stat
.st_mode
, f
->filetype
);
4906 /* Given these arguments describing a file, return the single-byte
4907 type indicator, or 0. */
4909 get_type_indicator (bool stat_ok
, mode_t mode
, enum filetype type
)
4913 if (stat_ok
? S_ISREG (mode
) : type
== normal
)
4915 if (stat_ok
&& indicator_style
== classify
&& (mode
& S_IXUGO
))
4922 if (stat_ok
? S_ISDIR (mode
) : type
== directory
|| type
== arg_directory
)
4924 else if (indicator_style
== slash
)
4926 else if (stat_ok
? S_ISLNK (mode
) : type
== symbolic_link
)
4928 else if (stat_ok
? S_ISFIFO (mode
) : type
== fifo
)
4930 else if (stat_ok
? S_ISSOCK (mode
) : type
== sock
)
4932 else if (stat_ok
&& S_ISDOOR (mode
))
4941 print_type_indicator (bool stat_ok
, mode_t mode
, enum filetype type
)
4943 char c
= get_type_indicator (stat_ok
, mode
, type
);
4949 /* Returns if color sequence was printed. */
4951 print_color_indicator (const struct bin_str
*ind
)
4955 /* Need to reset so not dealing with attribute combinations */
4956 if (is_colored (C_NORM
))
4957 restore_default_color ();
4958 put_indicator (&color_indicator
[C_LEFT
]);
4959 put_indicator (ind
);
4960 put_indicator (&color_indicator
[C_RIGHT
]);
4963 return ind
!= nullptr;
4966 /* Returns color indicator or nullptr if none. */
4968 static const struct bin_str
*
4969 get_color_indicator (const struct fileinfo
*f
, bool symlink_target
)
4971 enum indicator_no type
;
4972 struct color_ext_type
*ext
; /* Color extension */
4973 size_t len
; /* Length of name */
4982 linkok
= f
->linkok
? 0 : -1;
4987 mode
= file_or_link_mode (f
);
4991 /* Is this a nonexistent file? If so, linkok == -1. */
4993 if (linkok
== -1 && is_colored (C_MISSING
))
4995 else if (!f
->stat_ok
)
4997 static enum indicator_no filetype_indicator
[] = FILETYPE_INDICATORS
;
4998 type
= filetype_indicator
[f
->filetype
];
5006 if ((mode
& S_ISUID
) != 0 && is_colored (C_SETUID
))
5008 else if ((mode
& S_ISGID
) != 0 && is_colored (C_SETGID
))
5010 else if (is_colored (C_CAP
) && f
->has_capability
)
5012 else if ((mode
& S_IXUGO
) != 0 && is_colored (C_EXEC
))
5014 else if ((1 < f
->stat
.st_nlink
) && is_colored (C_MULTIHARDLINK
))
5015 type
= C_MULTIHARDLINK
;
5017 else if (S_ISDIR (mode
))
5021 if ((mode
& S_ISVTX
) && (mode
& S_IWOTH
)
5022 && is_colored (C_STICKY_OTHER_WRITABLE
))
5023 type
= C_STICKY_OTHER_WRITABLE
;
5024 else if ((mode
& S_IWOTH
) != 0 && is_colored (C_OTHER_WRITABLE
))
5025 type
= C_OTHER_WRITABLE
;
5026 else if ((mode
& S_ISVTX
) != 0 && is_colored (C_STICKY
))
5029 else if (S_ISLNK (mode
))
5031 else if (S_ISFIFO (mode
))
5033 else if (S_ISSOCK (mode
))
5035 else if (S_ISBLK (mode
))
5037 else if (S_ISCHR (mode
))
5039 else if (S_ISDOOR (mode
))
5043 /* Classify a file of some other type as C_ORPHAN. */
5048 /* Check the file's suffix only if still classified as C_FILE. */
5052 /* Test if NAME has a recognized suffix. */
5054 len
= strlen (name
);
5055 name
+= len
; /* Pointer to final \0. */
5056 for (ext
= color_ext_list
; ext
!= nullptr; ext
= ext
->next
)
5058 if (ext
->ext
.len
<= len
)
5060 if (ext
->exact_match
)
5062 if (STREQ_LEN (name
- ext
->ext
.len
, ext
->ext
.string
,
5068 if (c_strncasecmp (name
- ext
->ext
.len
, ext
->ext
.string
,
5076 /* Adjust the color for orphaned symlinks. */
5077 if (type
== C_LINK
&& !linkok
)
5079 if (color_symlink_as_referent
|| is_colored (C_ORPHAN
))
5083 const struct bin_str
*const s
5084 = ext
? &(ext
->seq
) : &color_indicator
[type
];
5086 return s
->string
? s
: nullptr;
5089 /* Output a color indicator (which may contain nulls). */
5091 put_indicator (const struct bin_str
*ind
)
5097 /* If the standard output is a controlling terminal, watch out
5098 for signals, so that the colors can be restored to the
5099 default state if "ls" is suspended or interrupted. */
5101 if (0 <= tcgetpgrp (STDOUT_FILENO
))
5104 prep_non_filename_text ();
5107 fwrite (ind
->string
, ind
->len
, 1, stdout
);
5111 length_of_file_name_and_frills (const struct fileinfo
*f
)
5114 char buf
[MAX (LONGEST_HUMAN_READABLE
+ 1, INT_BUFSIZE_BOUND (uintmax_t))];
5117 len
+= 1 + (format
== with_commas
5118 ? strlen (umaxtostr (f
->stat
.st_ino
, buf
))
5119 : inode_number_width
);
5121 if (print_block_size
)
5122 len
+= 1 + (format
== with_commas
5123 ? strlen (! f
->stat_ok
? "?"
5124 : human_readable (STP_NBLOCKS (&f
->stat
), buf
,
5125 human_output_opts
, ST_NBLOCKSIZE
,
5127 : block_size_width
);
5130 len
+= 1 + (format
== with_commas
? strlen (f
->scontext
) : scontext_width
);
5132 len
+= fileinfo_name_width (f
);
5134 if (indicator_style
!= none
)
5136 char c
= get_type_indicator (f
->stat_ok
, f
->stat
.st_mode
, f
->filetype
);
5144 print_many_per_line (void)
5146 size_t row
; /* Current row. */
5147 size_t cols
= calculate_columns (true);
5148 struct column_info
const *line_fmt
= &column_info
[cols
- 1];
5150 /* Calculate the number of rows that will be in each column except possibly
5151 for a short column on the right. */
5152 size_t rows
= cwd_n_used
/ cols
+ (cwd_n_used
% cols
!= 0);
5154 for (row
= 0; row
< rows
; row
++)
5157 size_t filesno
= row
;
5160 /* Print the next row. */
5163 struct fileinfo
const *f
= sorted_file
[filesno
];
5164 size_t name_length
= length_of_file_name_and_frills (f
);
5165 size_t max_name_length
= line_fmt
->col_arr
[col
++];
5166 print_file_name_and_frills (f
, pos
);
5169 if (filesno
>= cwd_n_used
)
5172 indent (pos
+ name_length
, pos
+ max_name_length
);
5173 pos
+= max_name_length
;
5180 print_horizontal (void)
5184 size_t cols
= calculate_columns (false);
5185 struct column_info
const *line_fmt
= &column_info
[cols
- 1];
5186 struct fileinfo
const *f
= sorted_file
[0];
5187 size_t name_length
= length_of_file_name_and_frills (f
);
5188 size_t max_name_length
= line_fmt
->col_arr
[0];
5190 /* Print first entry. */
5191 print_file_name_and_frills (f
, 0);
5194 for (filesno
= 1; filesno
< cwd_n_used
; ++filesno
)
5196 size_t col
= filesno
% cols
;
5205 indent (pos
+ name_length
, pos
+ max_name_length
);
5206 pos
+= max_name_length
;
5209 f
= sorted_file
[filesno
];
5210 print_file_name_and_frills (f
, pos
);
5212 name_length
= length_of_file_name_and_frills (f
);
5213 max_name_length
= line_fmt
->col_arr
[col
];
5218 /* Output name + SEP + ' '. */
5221 print_with_separator (char sep
)
5226 for (filesno
= 0; filesno
< cwd_n_used
; filesno
++)
5228 struct fileinfo
const *f
= sorted_file
[filesno
];
5229 size_t len
= line_length
? length_of_file_name_and_frills (f
) : 0;
5236 || ((pos
+ len
+ 2 < line_length
)
5237 && (pos
<= SIZE_MAX
- len
- 2)))
5245 separator
= eolbyte
;
5249 putchar (separator
);
5252 print_file_name_and_frills (f
, pos
);
5258 /* Assuming cursor is at position FROM, indent up to position TO.
5259 Use a TAB character instead of two or more spaces whenever possible. */
5262 indent (size_t from
, size_t to
)
5266 if (tabsize
!= 0 && to
/ tabsize
> (from
+ 1) / tabsize
)
5269 from
+= tabsize
- from
% tabsize
;
5279 /* Put DIRNAME/NAME into DEST, handling '.' and '/' properly. */
5280 /* FIXME: maybe remove this function someday. See about using a
5281 non-malloc'ing version of file_name_concat. */
5284 attach (char *dest
, char const *dirname
, char const *name
)
5286 char const *dirnamep
= dirname
;
5288 /* Copy dirname if it is not ".". */
5289 if (dirname
[0] != '.' || dirname
[1] != 0)
5292 *dest
++ = *dirnamep
++;
5293 /* Add '/' if 'dirname' doesn't already end with it. */
5294 if (dirnamep
> dirname
&& dirnamep
[-1] != '/')
5302 /* Allocate enough column info suitable for the current number of
5303 files and display columns, and initialize the info to represent the
5304 narrowest possible columns. */
5307 init_column_info (size_t max_cols
)
5311 /* Currently allocated columns in column_info. */
5312 static size_t column_info_alloc
;
5314 if (column_info_alloc
< max_cols
)
5316 size_t new_column_info_alloc
;
5319 if (!max_idx
|| max_cols
< max_idx
/ 2)
5321 /* The number of columns is far less than the display width
5322 allows. Grow the allocation, but only so that it's
5323 double the current requirements. If the display is
5324 extremely wide, this avoids allocating a lot of memory
5325 that is never needed. */
5326 column_info
= xnrealloc (column_info
, max_cols
,
5327 2 * sizeof *column_info
);
5328 new_column_info_alloc
= 2 * max_cols
;
5332 column_info
= xnrealloc (column_info
, max_idx
, sizeof *column_info
);
5333 new_column_info_alloc
= max_idx
;
5336 /* Allocate the new size_t objects by computing the triangle
5337 formula n * (n + 1) / 2, except that we don't need to
5338 allocate the part of the triangle that we've already
5339 allocated. Check for address arithmetic overflow. */
5341 size_t column_info_growth
= new_column_info_alloc
- column_info_alloc
;
5342 size_t s
= column_info_alloc
+ 1 + new_column_info_alloc
;
5343 size_t t
= s
* column_info_growth
;
5344 if (s
< new_column_info_alloc
|| t
/ column_info_growth
!= s
)
5346 p
= xnmalloc (t
/ 2, sizeof *p
);
5349 /* Grow the triangle by parceling out the cells just allocated. */
5350 for (i
= column_info_alloc
; i
< new_column_info_alloc
; i
++)
5352 column_info
[i
].col_arr
= p
;
5356 column_info_alloc
= new_column_info_alloc
;
5359 for (i
= 0; i
< max_cols
; ++i
)
5363 column_info
[i
].valid_len
= true;
5364 column_info
[i
].line_len
= (i
+ 1) * MIN_COLUMN_WIDTH
;
5365 for (j
= 0; j
<= i
; ++j
)
5366 column_info
[i
].col_arr
[j
] = MIN_COLUMN_WIDTH
;
5370 /* Calculate the number of columns needed to represent the current set
5371 of files in the current display width. */
5374 calculate_columns (bool by_columns
)
5376 size_t filesno
; /* Index into cwd_file. */
5377 size_t cols
; /* Number of files across. */
5379 /* Normally the maximum number of columns is determined by the
5380 screen width. But if few files are available this might limit it
5382 size_t max_cols
= 0 < max_idx
&& max_idx
< cwd_n_used
? max_idx
: cwd_n_used
;
5384 init_column_info (max_cols
);
5386 /* Compute the maximum number of possible columns. */
5387 for (filesno
= 0; filesno
< cwd_n_used
; ++filesno
)
5389 struct fileinfo
const *f
= sorted_file
[filesno
];
5390 size_t name_length
= length_of_file_name_and_frills (f
);
5392 for (size_t i
= 0; i
< max_cols
; ++i
)
5394 if (column_info
[i
].valid_len
)
5396 size_t idx
= (by_columns
5397 ? filesno
/ ((cwd_n_used
+ i
) / (i
+ 1))
5398 : filesno
% (i
+ 1));
5399 size_t real_length
= name_length
+ (idx
== i
? 0 : 2);
5401 if (column_info
[i
].col_arr
[idx
] < real_length
)
5403 column_info
[i
].line_len
+= (real_length
5404 - column_info
[i
].col_arr
[idx
]);
5405 column_info
[i
].col_arr
[idx
] = real_length
;
5406 column_info
[i
].valid_len
= (column_info
[i
].line_len
5413 /* Find maximum allowed columns. */
5414 for (cols
= max_cols
; 1 < cols
; --cols
)
5416 if (column_info
[cols
- 1].valid_len
)
5426 if (status
!= EXIT_SUCCESS
)
5430 printf (_("Usage: %s [OPTION]... [FILE]...\n"), program_name
);
5432 List information about the FILEs (the current directory by default).\n\
5433 Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.\n\
5436 emit_mandatory_arg_note ();
5439 -a, --all do not ignore entries starting with .\n\
5440 -A, --almost-all do not list implied . and ..\n\
5441 --author with -l, print the author of each file\n\
5442 -b, --escape print C-style escapes for nongraphic characters\n\
5445 --block-size=SIZE with -l, scale sizes by SIZE when printing them;\n\
5446 e.g., '--block-size=M'; see SIZE format below\n\
5450 -B, --ignore-backups do not list implied entries ending with ~\n\
5453 -c with -lt: sort by, and show, ctime (time of last\n\
5454 change of file status information);\n\
5455 with -l: show ctime and sort by name;\n\
5456 otherwise: sort by ctime, newest first\n\
5460 -C list entries by columns\n\
5461 --color[=WHEN] color the output WHEN; more info below\n\
5462 -d, --directory list directories themselves, not their contents\n\
5463 -D, --dired generate output designed for Emacs' dired mode\n\
5466 -f do not sort, enable -aU, disable -ls --color\n\
5467 -F, --classify[=WHEN] append indicator (one of */=>@|) to entries WHEN\n\
5468 --file-type likewise, except do not append '*'\n\
5471 --format=WORD across -x, commas -m, horizontal -x, long -l,\n\
5472 single-column -1, verbose -l, vertical -C\n\
5476 --full-time like -l --time-style=full-iso\n\
5479 -g like -l, but do not list owner\n\
5482 --group-directories-first\n\
5483 group directories before files;\n\
5484 can be augmented with a --sort option, but any\n\
5485 use of --sort=none (-U) disables grouping\n\
5489 -G, --no-group in a long listing, don't print group names\n\
5492 -h, --human-readable with -l and -s, print sizes like 1K 234M 2G etc.\n\
5493 --si likewise, but use powers of 1000 not 1024\n\
5496 -H, --dereference-command-line\n\
5497 follow symbolic links listed on the command line\n\
5500 --dereference-command-line-symlink-to-dir\n\
5501 follow each command line symbolic link\n\
5502 that points to a directory\n\
5506 --hide=PATTERN do not list implied entries matching shell PATTERN\
5508 (overridden by -a or -A)\n\
5512 --hyperlink[=WHEN] hyperlink file names WHEN\n\
5515 --indicator-style=WORD\n\
5516 append indicator with style WORD to entry names:\n\
5517 none (default), slash (-p),\n\
5518 file-type (--file-type), classify (-F)\n\
5522 -i, --inode print the index number of each file\n\
5523 -I, --ignore=PATTERN do not list implied entries matching shell PATTERN\
5527 -k, --kibibytes default to 1024-byte blocks for file system usage;\
5529 used only with -s and per directory totals\n\
5533 -l use a long listing format\n\
5536 -L, --dereference when showing file information for a symbolic\n\
5537 link, show information for the file the link\n\
5538 references rather than for the link itself\n\
5542 -m fill width with a comma separated list of entries\
5546 -n, --numeric-uid-gid like -l, but list numeric user and group IDs\n\
5547 -N, --literal print entry names without quoting\n\
5548 -o like -l, but do not list group information\n\
5549 -p, --indicator-style=slash\n\
5550 append / indicator to directories\n\
5553 -q, --hide-control-chars print ? instead of nongraphic characters\n\
5556 --show-control-chars show nongraphic characters as-is (the default,\n\
5557 unless program is 'ls' and output is a terminal)\
5562 -Q, --quote-name enclose entry names in double quotes\n\
5565 --quoting-style=WORD use quoting style WORD for entry names:\n\
5566 literal, locale, shell, shell-always,\n\
5567 shell-escape, shell-escape-always, c, escape\n\
5568 (overrides QUOTING_STYLE environment variable)\n\
5572 -r, --reverse reverse order while sorting\n\
5573 -R, --recursive list subdirectories recursively\n\
5574 -s, --size print the allocated size of each file, in blocks\n\
5577 -S sort by file size, largest first\n\
5580 --sort=WORD sort by WORD instead of name: none (-U), size (-S)\
5582 time (-t), version (-v), extension (-X), width\n\
5586 --time=WORD select which timestamp used to display or sort;\n\
5587 access time (-u): atime, access, use;\n\
5588 metadata change time (-c): ctime, status;\n\
5589 modified time (default): mtime, modification;\n\
5590 birth time: birth, creation;\n\
5591 with -l, WORD determines which time to show;\n\
5592 with --sort=time, sort by WORD (newest first)\n\
5596 --time-style=TIME_STYLE\n\
5597 time/date format with -l; see TIME_STYLE below\n\
5600 -t sort by time, newest first; see --time\n\
5601 -T, --tabsize=COLS assume tab stops at each COLS instead of 8\n\
5604 -u with -lt: sort by, and show, access time;\n\
5605 with -l: show access time and sort by name;\n\
5606 otherwise: sort by access time, newest first\n\
5610 -U do not sort; list entries in directory order\n\
5613 -v natural sort of (version) numbers within text\n\
5616 -w, --width=COLS set output width to COLS. 0 means no limit\n\
5617 -x list entries by lines instead of by columns\n\
5618 -X sort alphabetically by entry extension\n\
5619 -Z, --context print any security context of each file\n\
5620 --zero end each output line with NUL, not newline\n\
5621 -1 list one file per line\n\
5623 fputs (HELP_OPTION_DESCRIPTION
, stdout
);
5624 fputs (VERSION_OPTION_DESCRIPTION
, stdout
);
5628 The TIME_STYLE argument can be full-iso, long-iso, iso, locale, or +FORMAT.\n\
5629 FORMAT is interpreted like in date(1). If FORMAT is FORMAT1<newline>FORMAT2,\n\
5630 then FORMAT1 applies to non-recent files and FORMAT2 to recent files.\n\
5631 TIME_STYLE prefixed with 'posix-' takes effect only outside the POSIX locale.\n\
5632 Also the TIME_STYLE environment variable sets the default style to use.\n\
5636 The WHEN argument defaults to 'always' and can also be 'auto' or 'never'.\n\
5640 Using color to distinguish file types is disabled both by default and\n\
5641 with --color=never. With --color=auto, ls emits color codes only when\n\
5642 standard output is connected to a terminal. The LS_COLORS environment\n\
5643 variable can change the settings. Use the dircolors(1) command to set it.\n\
5649 1 if minor problems (e.g., cannot access subdirectory),\n\
5650 2 if serious trouble (e.g., cannot access command-line argument).\n\
5652 emit_ancillary_info (PROGRAM_NAME
);