.\" Automatically generated by Pandoc 3.1.9
.\"
.TH "lsd" "1" "" "lsd" "User Manual"
.SH NAME
lsd - LSDeluxe
.SH SYNOPSIS
\f[CR]lsd [FLAGS] [OPTIONS] [--] [FILE]...\f[R]
.SH DESCRIPTION
lsd is a ls command with a lot of pretty colours and some other stuff to
enrich and enhance the directory listing experience.
.SH OPTIONS
.TP
\f[CR]-a\f[R], \f[CR]--all\f[R]
Do not ignore entries starting with \f[B].\f[R]
.TP
\f[CR]-A\f[R], \f[CR]--almost-all\f[R]
Do not list implied \f[B].\f[R] and \f[B]..\f[R]
.TP
\f[CR]--classic\f[R]
Enable classic mode (no colours or icons)
.TP
\f[CR]-L\f[R], \f[CR]--dereference\f[R]
When showing file information for a symbolic link, show information for
the file the link references rather than for the link itself
.TP
\f[CR]-d\f[R], \f[CR]--directory-only\f[R]
Display directories themselves, and not their contents (recursively when
used with \[en]tree)
.TP
\f[CR]-X\f[R], \f[CR]--extensionsort\f[R]
Sort by file extension
.TP
\f[CR]--git\f[R]
Display git status.
Directory git status is a reduction of included file statuses
(recursively).
.TP
\f[CR]--help\f[R]
Prints help information
.TP
\f[CR]-h\f[R], \f[CR]--human-readable\f[R]
For ls compatibility purposes ONLY, currently set by default
.TP
\f[CR]--ignore-config\f[R]
Ignore the configuration file
.TP
\f[CR]--config-file <path>\f[R]
Provide the config file from a custom location
.TP
\f[CR]-F\f[R], \f[CR]--classify\f[R]
Append indicator (one of */=>\[at]|) at the end of the file names
.TP
\f[CR]-i\f[R], \f[CR]--inode\f[R]
Display the index number of each file
.TP
\f[CR]-l\f[R], \f[CR]--long\f[R]
Display extended file metadata as a table
.TP
\f[CR]--no-symlink\f[R]
Do not display symlink target
.TP
\f[CR]-1\f[R], \f[CR]--oneline\f[R]
Display one entry per line
.TP
\f[CR]-R\f[R], \f[CR]--recursive\f[R]
Recurse into directories
.TP
\f[CR]-r\f[R], \f[CR]--reverse\f[R]
Reverse the order of the sort
.TP
\f[CR]-S\f[R], \f[CR]--sizesort\f[R]
Sort by size
.TP
\f[CR]-t\f[R], \f[CR]--timesort\f[R]
Sort by time modified
.TP
\f[CR]--total-size\f[R]
Display the total size of directories
.TP
\f[CR]--tree\f[R]
Recurse into directories and present the result as a tree
.TP
\f[CR]-V\f[R], \f[CR]--version\f[R]
Prints version information
.TP
\f[CR]-v\f[R], \f[CR]--versionsort\f[R]
Natural sort of (version) numbers within text
.TP
\f[CR]--blocks <blocks>...\f[R]
Specify the blocks that will be displayed and in what order [possible
values: permission, user, group, size, date, name, inode, git]
.TP
\f[CR]--color <color>...\f[R]
When to use terminal colours [default: auto] [possible values: always,
auto, never]
.TP
\f[CR]--date <date>...\f[R]
How to display date [possible values: date, locale, relative,
+date-time-format] [default: date]
.TP
\f[CR]--depth <num>...\f[R]
Stop recursing into directories after reaching specified depth
.TP
\f[CR]--group-dirs <group-dirs>...\f[R]
Sort the directories then the files [default: none] [possible values:
none, first, last]
.TP
\f[CR]--group-directories-first\f[R]
Groups the directories at the top before the files.
Same as \f[CR]--group-dirs=first\f[R]
.TP
\f[CR]--hyperlink <hyperlink>...\f[R]
Attach hyperlink to filenames [default: never] [possible values: always,
auto, never]
.TP
\f[CR]--icon <icon>...\f[R]
When to print the icons [default: auto] [possible values: always, auto,
never]
.TP
\f[CR]--icon-theme <icon-theme>...\f[R]
Whether to use fancy or unicode icons [default: fancy] [possible values:
fancy, unicode]
.TP
\f[CR]-I, --ignore-glob <pattern>...\f[R]
Do not display files/directories with names matching the glob
pattern(s).
More than one can be specified by repeating the argument [default: ]
.TP
\f[CR]--permission <permission>...\f[R]
How to display permissions [default: rwx for linux, attributes for
windows] [possible values: rwx, octal, attributes, disable]
.TP
\f[CR]--size <size>...\f[R]
How to display size [default: default] [possible values: default, short,
bytes]
.TP
\f[CR]--sort <WORD>...\f[R]
Sort by WORD instead of name [possible values: size, time, version,
extension, git]
.TP
\f[CR]-U\f[R], \f[CR]--no-sort\f[R]
Do not sort.
List entries in directory order
.TP
\f[CR]-Z\f[R] \f[CR]--context\f[R]
Display SELinux or SMACK security context
.TP
\f[CR]--header\f[R]
Display block headers
.TP
\f[CR]-N --literal\f[R]
Print entry names without quoting
.TP
\f[CR]--truncate-owner-after\f[R]
Truncate the user and group names if they exceed a certain number of
characters
.TP
\f[CR]--truncate-owner-marker\f[R]
Truncation marker appended to a truncated user or group name
.SH ARGS
.TP
\f[CR]<FILE>...\f[R]
A file or directory to list [default: .]
.SH EXAMPLES
.TP
\f[CR]lsd\f[R]
Display listing for current directory
.TP
\f[CR]lsd /etc\f[R]
Display listing of /etc
.TP
\f[CR]lsd -la\f[R]
Display listing of current directory, including files starting with
\f[CR].\f[R] and the current directory\[cq]s entry.
.SH ENVIRONMENT
.TP
\f[CR]LS_COLORS\f[R]
Used to determine color for displaying filenames.
See \f[B]dir_colors\f[R].
.TP
\f[CR]XDG_CONFIG_HOME\f[R]
Used to locate optional config file.
If \f[CR]XDG_CONFIG_HOME\f[R] is set, use
\f[CR]$XDG_CONFIG_HOME/lsd/config.yaml\f[R] else
\f[CR]$HOME/.config/lsd/config.yaml\f[R].
.TP
\f[CR]SHELL_COMPLETIONS_DIR\f[R] or \f[CR]OUT_DIR\f[R]
Used to specify the directory for generating a shell completions file.
If neither are set, no completions file will be generated.
The directory will be created if it does not exist.