path: root/upstream/debian-unstable/man1/vdir.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH VDIR "1" "January 2024" "GNU coreutils 9.4" "User Commands"
.SH NAME
vdir \- list directory contents
.SH SYNOPSIS
.B vdir
[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
.SH DESCRIPTION
.\" Add any additional description here
.PP
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of \fB\-cftuvSUX\fR nor \fB\-\-sort\fR is specified.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
\fB\-a\fR, \fB\-\-all\fR
do not ignore entries starting with .
.TP
\fB\-A\fR, \fB\-\-almost\-all\fR
do not list implied . and ..
.TP
\fB\-\-author\fR
with \fB\-l\fR, print the author of each file
.TP
\fB\-b\fR, \fB\-\-escape\fR
print C\-style escapes for nongraphic characters
.TP
\fB\-\-block\-size\fR=\fI\,SIZE\/\fR
with \fB\-l\fR, scale sizes by SIZE when printing them;
e.g., '\-\-block\-size=M'; see SIZE format below
.TP
\fB\-B\fR, \fB\-\-ignore\-backups\fR
do not list implied entries ending with ~
.TP
\fB\-c\fR
with \fB\-lt\fR: sort by, and show, ctime (time of last
change of file status information);
with \fB\-l\fR: show ctime and sort by name;
otherwise: sort by ctime, newest first
.TP
\fB\-C\fR
list entries by columns
.TP
\fB\-\-color\fR[=\fI\,WHEN\/\fR]
color the output WHEN; more info below
.TP
\fB\-d\fR, \fB\-\-directory\fR
list directories themselves, not their contents
.TP
\fB\-D\fR, \fB\-\-dired\fR
generate output designed for Emacs' dired mode
.TP
\fB\-f\fR
list all entries in directory order
.TP
\fB\-F\fR, \fB\-\-classify\fR[=\fI\,WHEN\/\fR]
append indicator (one of */=>@|) to entries WHEN
.TP
\fB\-\-file\-type\fR
likewise, except do not append '*'
.TP
\fB\-\-format\fR=\fI\,WORD\/\fR
across \fB\-x\fR, commas \fB\-m\fR, horizontal \fB\-x\fR, long \fB\-l\fR,
single\-column \fB\-1\fR, verbose \fB\-l\fR, vertical \fB\-C\fR
.TP
\fB\-\-full\-time\fR
like \fB\-l\fR \fB\-\-time\-style\fR=\fI\,full\-iso\/\fR
.TP
\fB\-g\fR
like \fB\-l\fR, but do not list owner
.TP
\fB\-\-group\-directories\-first\fR
group directories before files;
can be augmented with a \fB\-\-sort\fR option, but any
use of \fB\-\-sort\fR=\fI\,none\/\fR (\fB\-U\fR) disables grouping
.TP
\fB\-G\fR, \fB\-\-no\-group\fR
in a long listing, don't print group names
.TP
\fB\-h\fR, \fB\-\-human\-readable\fR
with \fB\-l\fR and \fB\-s\fR, print sizes like 1K 234M 2G etc.
.TP
\fB\-\-si\fR
likewise, but use powers of 1000 not 1024
.TP
\fB\-H\fR, \fB\-\-dereference\-command\-line\fR
follow symbolic links listed on the command line
.TP
\fB\-\-dereference\-command\-line\-symlink\-to\-dir\fR
follow each command line symbolic link
that points to a directory
.TP
\fB\-\-hide\fR=\fI\,PATTERN\/\fR
do not list implied entries matching shell PATTERN
(overridden by \fB\-a\fR or \fB\-A\fR)
.TP
\fB\-\-hyperlink\fR[=\fI\,WHEN\/\fR]
hyperlink file names WHEN
.TP
\fB\-\-indicator\-style\fR=\fI\,WORD\/\fR
append indicator with style WORD to entry names:
none (default), slash (\fB\-p\fR),
file\-type (\fB\-\-file\-type\fR), classify (\fB\-F\fR)
.TP
\fB\-i\fR, \fB\-\-inode\fR
print the index number of each file
.TP
\fB\-I\fR, \fB\-\-ignore\fR=\fI\,PATTERN\/\fR
do not list implied entries matching shell PATTERN
.TP
\fB\-k\fR, \fB\-\-kibibytes\fR
default to 1024\-byte blocks for file system usage;
used only with \fB\-s\fR and per directory totals
.TP
\fB\-l\fR
use a long listing format
.TP
\fB\-L\fR, \fB\-\-dereference\fR
when showing file information for a symbolic
link, show information for the file the link
references rather than for the link itself
.TP
\fB\-m\fR
fill width with a comma separated list of entries
.TP
\fB\-n\fR, \fB\-\-numeric\-uid\-gid\fR
like \fB\-l\fR, but list numeric user and group IDs
.TP
\fB\-N\fR, \fB\-\-literal\fR
print entry names without quoting
.TP
\fB\-o\fR
like \fB\-l\fR, but do not list group information
.TP
\fB\-p\fR, \fB\-\-indicator\-style\fR=\fI\,slash\/\fR
append / indicator to directories
.TP
\fB\-q\fR, \fB\-\-hide\-control\-chars\fR
print ? instead of nongraphic characters
.TP
\fB\-\-show\-control\-chars\fR
show nongraphic characters as\-is (the default,
unless program is 'ls' and output is a terminal)
.TP
\fB\-Q\fR, \fB\-\-quote\-name\fR
enclose entry names in double quotes
.TP
\fB\-\-quoting\-style\fR=\fI\,WORD\/\fR
use quoting style WORD for entry names:
literal, locale, shell, shell\-always,
shell\-escape, shell\-escape\-always, c, escape
(overrides QUOTING_STYLE environment variable)
.TP
\fB\-r\fR, \fB\-\-reverse\fR
reverse order while sorting
.TP
\fB\-R\fR, \fB\-\-recursive\fR
list subdirectories recursively
.TP
\fB\-s\fR, \fB\-\-size\fR
print the allocated size of each file, in blocks
.TP
\fB\-S\fR
sort by file size, largest first
.TP
\fB\-\-sort\fR=\fI\,WORD\/\fR
sort by WORD instead of name: none (\fB\-U\fR), size (\fB\-S\fR),
time (\fB\-t\fR), version (\fB\-v\fR), extension (\fB\-X\fR), width
.TP
\fB\-\-time\fR=\fI\,WORD\/\fR
select which timestamp used to display or sort;
access time (\fB\-u\fR): atime, access, use;
metadata change time (\fB\-c\fR): ctime, status;
modified time (default): mtime, modification;
birth time: birth, creation;
.IP
with \fB\-l\fR, WORD determines which time to show;
with \fB\-\-sort\fR=\fI\,time\/\fR, sort by WORD (newest first)
.TP
\fB\-\-time\-style\fR=\fI\,TIME_STYLE\/\fR
time/date format with \fB\-l\fR; see TIME_STYLE below
.TP
\fB\-t\fR
sort by time, newest first; see \fB\-\-time\fR
.TP
\fB\-T\fR, \fB\-\-tabsize\fR=\fI\,COLS\/\fR
assume tab stops at each COLS instead of 8
.TP
\fB\-u\fR
with \fB\-lt\fR: sort by, and show, access time;
with \fB\-l\fR: show access time and sort by name;
otherwise: sort by access time, newest first
.TP
\fB\-U\fR
do not sort; list entries in directory order
.TP
\fB\-v\fR
natural sort of (version) numbers within text
.TP
\fB\-w\fR, \fB\-\-width\fR=\fI\,COLS\/\fR
set output width to COLS.  0 means no limit
.TP
\fB\-x\fR
list entries by lines instead of by columns
.TP
\fB\-X\fR
sort alphabetically by entry extension
.TP
\fB\-Z\fR, \fB\-\-context\fR
print any security context of each file
.TP
\fB\-\-zero\fR
end each output line with NUL, not newline
.TP
\fB\-1\fR
list one file per line
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-version\fR
output version information and exit
.PP
The SIZE argument is an integer and optional unit (example: 10K is 10*1024).
Units are K,M,G,T,P,E,Z,Y,R,Q (powers of 1024) or KB,MB,... (powers of 1000).
Binary prefixes can be used, too: KiB=K, MiB=M, and so on.
.PP
The TIME_STYLE argument can be full\-iso, long\-iso, iso, locale, or +FORMAT.
FORMAT is interpreted like in \fBdate\fP(1).  If FORMAT is FORMAT1<newline>FORMAT2,
then FORMAT1 applies to non\-recent files and FORMAT2 to recent files.
TIME_STYLE prefixed with 'posix\-' takes effect only outside the POSIX locale.
Also the TIME_STYLE environment variable sets the default style to use.
.PP
The WHEN argument defaults to 'always' and can also be 'auto' or 'never'.
.PP
Using color to distinguish file types is disabled both by default and
with \fB\-\-color\fR=\fI\,never\/\fR.  With \fB\-\-color\fR=\fI\,auto\/\fR, ls emits color codes only when
standard output is connected to a terminal.  The LS_COLORS environment
variable can change the settings.  Use the \fBdircolors\fP(1) command to set it.
.SS "Exit status:"
.TP
0
if OK,
.TP
1
if minor problems (e.g., cannot access subdirectory),
.TP
2
if serious trouble (e.g., cannot access command\-line argument).
.SH AUTHOR
Written by Richard M. Stallman and David MacKenzie.
.SH "REPORTING BUGS"
GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
.br
Report any translation bugs to <https://translationproject.org/team/>
.SH COPYRIGHT
Copyright \(co 2023 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
Full documentation <https://www.gnu.org/software/coreutils/vdir>
.br
or available locally via: info \(aq(coreutils) vdir invocation\(aq