.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "exa_colors" "5" "" "v0.9.0" ""
.hy
.SH NAME
.PP
exa_colors \[em] customising the file and UI colours of exa
.SH SYNOPSIS
.PP
The \f[V]EXA_COLORS\f[R] environment variable can be used to customise
the colours that \f[V]exa\f[R] uses to highlight file names, file
metadata, and parts of the UI.
.PP
You can use the \f[V]dircolors\f[R] program to generate a script that
sets the variable from an input file, or if you don\[cq]t mind editing
long strings of text, you can just type it out directly.
These variables have the following structure:
.IP \[bu] 2
A list of key-value pairs separated by `\f[V]=\f[R]', such as
`\f[V]*.txt=32\f[R]'.
.IP \[bu] 2
Multiple ANSI formatting codes are separated by `\f[V];\f[R]', such as
`\f[V]*.txt=32;1;4\f[R]'.
.IP \[bu] 2
Finally, multiple pairs are separated by `\f[V]:\f[R]', such as
`\f[V]*.txt=32:*.mp3=1;35\f[R]'.
.PP
The key half of the pair can either be a two-letter code or a file glob,
and anything that\[cq]s not a valid code will be treated as a glob,
including keys that happen to be two letters long.
.SH EXAMPLES
.TP
\f[V]EXA_COLORS=\[dq]uu=0:gu=0\[dq]\f[R]
Disable the \[lq]current user\[rq] highlighting
.TP
\f[V]EXA_COLORS=\[dq]da=32\[dq]\f[R]
Turn the date column green
.TP
\f[V]EXA_COLORS=\[dq]Vagrantfile=1;4;33\[dq]\f[R]
Highlight Vagrantfiles
.TP
\f[V]EXA_COLORS=\[dq]*.zip=38;5;125\[dq]\f[R]
Override the existing zip colour
.TP
\f[V]EXA_COLORS=\[dq]*.md=38;5;121:*.log=38;5;248\[dq]\f[R]
Markdown files a shade of green, log files a shade of grey
.SH LIST OF CODES
.PP
\f[V]LS_COLORS\f[R] can use these ten codes:
.TP
\f[V]di\f[R]
directories
.TP
\f[V]ex\f[R]
executable files
.TP
\f[V]fi\f[R]
regular files
.TP
\f[V]pi\f[R]
named pipes
.TP
\f[V]so\f[R]
sockets
.TP
\f[V]bd\f[R]
block devices
.TP
\f[V]cd\f[R]
character devices
.TP
\f[V]ln\f[R]
symlinks
.TP
\f[V]or\f[R]
symlinks with no target
.PP
\f[V]EXA_COLORS\f[R] can use many more:
.TP
\f[V]ur\f[R]
the user-read permission bit
.TP
\f[V]uw\f[R]
the user-write permission bit
.TP
\f[V]ux\f[R]
the user-execute permission bit for regular files
.TP
\f[V]ue\f[R]
the user-execute for other file kinds
.TP
\f[V]gr\f[R]
the group-read permission bit
.TP
\f[V]gw\f[R]
the group-write permission bit
.TP
\f[V]gx\f[R]
the group-execute permission bit
.TP
\f[V]tr\f[R]
the others-read permission bit
.TP
\f[V]tw\f[R]
the others-write permission bit
.TP
\f[V]tx\f[R]
the others-execute permission bit
.TP
\f[V]su\f[R]
setuid, setgid, and sticky permission bits for files
.TP
\f[V]sf\f[R]
setuid, setgid, and sticky for other file kinds
.TP
\f[V]xa\f[R]
the extended attribute indicator
.TP
\f[V]sn\f[R]
the numbers of a file\[cq]s size (sets \f[V]nb\f[R], \f[V]nk\f[R],
\f[V]nm\f[R], \f[V]ng\f[R] and \f[V]nh\f[R])
.TP
\f[V]nb\f[R]
the numbers of a file\[cq]s size if it is lower than 1 KB/Kib
.TP
\f[V]nk\f[R]
the numbers of a file\[cq]s size if it is between 1 KB/KiB and 1 MB/MiB
.TP
\f[V]nm\f[R]
the numbers of a file\[cq]s size if it is between 1 MB/MiB and 1 GB/GiB
.TP
\f[V]ng\f[R]
the numbers of a file\[cq]s size if it is between 1 GB/GiB and 1 TB/TiB
.TP
\f[V]nt\f[R]
the numbers of a file\[cq]s size if it is 1 TB/TiB or higher
.TP
\f[V]sb\f[R]
the units of a file\[cq]s size (sets \f[V]ub\f[R], \f[V]uk\f[R],
\f[V]um\f[R], \f[V]ug\f[R] and \f[V]uh\f[R])
.TP
\f[V]ub\f[R]
the units of a file\[cq]s size if it is lower than 1 KB/Kib
.TP
\f[V]uk\f[R]
the units of a file\[cq]s size if it is between 1 KB/KiB and 1 MB/MiB
.TP
\f[V]um\f[R]
the units of a file\[cq]s size if it is between 1 MB/MiB and 1 GB/GiB
.TP
\f[V]ug\f[R]
the units of a file\[cq]s size if it is between 1 GB/GiB and 1 TB/TiB
.TP
\f[V]ut\f[R]
the units of a file\[cq]s size if it is 1 TB/TiB or higher
.TP
\f[V]df\f[R]
a device\[cq]s major ID
.TP
\f[V]ds\f[R]
a device\[cq]s minor ID
.TP
\f[V]uu\f[R]
a user that\[cq]s you
.TP
\f[V]un\f[R]
a user that\[cq]s someone else
.TP
\f[V]gu\f[R]
a group that you belong to
.TP
\f[V]gn\f[R]
a group you aren\[cq]t a member of
.TP
\f[V]lc\f[R]
a number of hard links
.TP
\f[V]lm\f[R]
a number of hard links for a regular file with at least two
.TP
\f[V]ga\f[R]
a new flag in Git
.TP
\f[V]gm\f[R]
a modified flag in Git
.TP
\f[V]gd\f[R]
a deleted flag in Git
.TP
\f[V]gv\f[R]
a renamed flag in Git
.TP
\f[V]gt\f[R]
a modified metadata flag in Git
.TP
\f[V]xx\f[R]
\[lq]punctuation\[rq], including many background UI elements
.TP
\f[V]da\f[R]
a file\[cq]s date
.TP
\f[V]in\f[R]
a file\[cq]s inode number
.TP
\f[V]bl\f[R]
a file\[cq]s number of blocks
.TP
\f[V]hd\f[R]
the header row of a table
.TP
\f[V]lp\f[R]
the path of a symlink
.TP
\f[V]cc\f[R]
an escaped character in a filename
.TP
\f[V]bO\f[R]
the overlay style for broken symlink paths
.PP
Values in \f[V]EXA_COLORS\f[R] override those given in
\f[V]LS_COLORS\f[R], so you don\[cq]t need to re-write an existing
\f[V]LS_COLORS\f[R] variable with proprietary extensions.
.SH LIST OF STYLES
.PP
Unlike some versions of \f[V]ls\f[R], the given ANSI values must be
valid colour codes: exa won\[cq]t just print out whichever characters
are given.
.PP
The codes accepted by exa are:
.TP
\f[V]1\f[R]
for bold
.TP
\f[V]4\f[R]
for underline
.TP
\f[V]31\f[R]
for red text
.TP
\f[V]32\f[R]
for green text
.TP
\f[V]33\f[R]
for yellow text
.TP
\f[V]34\f[R]
for blue text
.TP
\f[V]35\f[R]
for purple text
.TP
\f[V]36\f[R]
for cyan text
.TP
\f[V]37\f[R]
for white text
.TP
\f[V]38;5;nnn\f[R]
for a colour from 0 to 255 (replace the \f[V]nnn\f[R] part)
.PP
Many terminals will treat bolded text as a different colour, or at least
provide the option to.
.PP
exa provides its own built-in set of file extension mappings that cover
a large range of common file extensions, including documents, archives,
media, and temporary files.
Any mappings in the environment variables will override this default
set: running exa with \f[V]LS_COLORS=\[dq]*.zip=32\[dq]\f[R] will turn
zip files green but leave the colours of other compressed files alone.
.PP
You can also disable this built-in set entirely by including a
\f[V]reset\f[R] entry at the beginning of \f[V]EXA_COLORS\f[R].
So setting \f[V]EXA_COLORS=\[dq]reset:*.txt=31\[dq]\f[R] will highlight
only text files; setting \f[V]EXA_COLORS=\[dq]reset\[dq]\f[R] will
highlight nothing.
.SH AUTHOR
.PP
exa is maintained by Benjamin `ogham' Sago and many other contributors.
.PP
\f[B]Website:\f[R] \f[V]https://the.exa.website/\f[R]
.PD 0
.P
.PD
\f[B]Source code:\f[R] \f[V]https://github.com/ogham/exa\f[R]
.PD 0
.P
.PD
\f[B]Contributors:\f[R]
\f[V]https://github.com/ogham/exa/graphs/contributors\f[R]
.SH SEE ALSO
.IP \[bu] 2
\f[V]exa(1)\f[R]