.\" Automatically generated by Pandoc 3.1.9
.\"
.TH "eza_colors" "5" "" "$version" ""
.SH NAME
eza_colors \[em] customising the file and UI colours of eza
.SH SYNOPSIS
The \f[CR]EZA_COLORS\f[R] environment variable can be used to customise
the colours that \f[CR]eza\f[R] uses to highlight file names, file
metadata, and parts of the UI.
.PP
You can use the \f[CR]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[CR]=\f[R]', such as
`\f[CR]*.txt=32\f[R]'.
.IP \[bu] 2
Multiple ANSI formatting codes are separated by `\f[CR];\f[R]', such as
`\f[CR]*.txt=32;1;4\f[R]'.
.IP \[bu] 2
Finally, multiple pairs are separated by `\f[CR]:\f[R]', such as
`\f[CR]*.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.
.PP
For backwards compatibility \f[CR]EXA_COLORS\f[R] environment variables
is checked if \f[CR]EZA_COLORS\f[R] is unset.
.SH EXAMPLES
.TP
\f[CR]EZA_COLORS=\[dq]uu=0:gu=0\[dq]\f[R]
Disable the \[lq]current user\[rq] highlighting
.TP
\f[CR]EZA_COLORS=\[dq]da=32\[dq]\f[R]
Turn the date column green
.TP
\f[CR]EZA_COLORS=\[dq]Vagrantfile=1;4;33\[dq]\f[R]
Highlight Vagrantfiles
.TP
\f[CR]EZA_COLORS=\[dq]*.zip=38;5;125\[dq]\f[R]
Override the existing zip colour
.TP
\f[CR]EZA_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
\f[CR]LS_COLORS\f[R] can use these ten codes:
.TP
\f[CR]di\f[R]
directories
.TP
\f[CR]ex\f[R]
executable files
.TP
\f[CR]fi\f[R]
regular files
.TP
\f[CR]pi\f[R]
named pipes
.TP
\f[CR]so\f[R]
sockets
.TP
\f[CR]bd\f[R]
block devices
.TP
\f[CR]cd\f[R]
character devices
.TP
\f[CR]ln\f[R]
symlinks
.TP
\f[CR]or\f[R]
symlinks with no target
.PP
\f[CR]EZA_COLORS\f[R] can use many more:
.TP
\f[CR]oc\f[R]
the permissions displayed as octal
.TP
\f[CR]ur\f[R]
the user-read permission bit
.TP
\f[CR]uw\f[R]
the user-write permission bit
.TP
\f[CR]ux\f[R]
the user-execute permission bit for regular files
.TP
\f[CR]ue\f[R]
the user-execute for other file kinds
.TP
\f[CR]gr\f[R]
the group-read permission bit
.TP
\f[CR]gw\f[R]
the group-write permission bit
.TP
\f[CR]gx\f[R]
the group-execute permission bit
.TP
\f[CR]tr\f[R]
the others-read permission bit
.TP
\f[CR]tw\f[R]
the others-write permission bit
.TP
\f[CR]tx\f[R]
the others-execute permission bit
.TP
\f[CR]su\f[R]
setuid, setgid, and sticky permission bits for files
.TP
\f[CR]sf\f[R]
setuid, setgid, and sticky for other file kinds
.TP
\f[CR]xa\f[R]
the extended attribute indicator
.TP
\f[CR]sn\f[R]
the numbers of a file\[cq]s size (sets \f[CR]nb\f[R], \f[CR]nk\f[R],
\f[CR]nm\f[R], \f[CR]ng\f[R] and \f[CR]nt\f[R])
.TP
\f[CR]nb\f[R]
the numbers of a file\[cq]s size if it is lower than 1 KB/Kib
.TP
\f[CR]nk\f[R]
the numbers of a file\[cq]s size if it is between 1 KB/KiB and 1 MB/MiB
.TP
\f[CR]nm\f[R]
the numbers of a file\[cq]s size if it is between 1 MB/MiB and 1 GB/GiB
.TP
\f[CR]ng\f[R]
the numbers of a file\[cq]s size if it is between 1 GB/GiB and 1 TB/TiB
.TP
\f[CR]nt\f[R]
the numbers of a file\[cq]s size if it is 1 TB/TiB or higher
.TP
\f[CR]sb\f[R]
the units of a file\[cq]s size (sets \f[CR]ub\f[R], \f[CR]uk\f[R],
\f[CR]um\f[R], \f[CR]ug\f[R] and \f[CR]ut\f[R])
.TP
\f[CR]ub\f[R]
the units of a file\[cq]s size if it is lower than 1 KB/Kib
.TP
\f[CR]uk\f[R]
the units of a file\[cq]s size if it is between 1 KB/KiB and 1 MB/MiB
.TP
\f[CR]um\f[R]
the units of a file\[cq]s size if it is between 1 MB/MiB and 1 GB/GiB
.TP
\f[CR]ug\f[R]
the units of a file\[cq]s size if it is between 1 GB/GiB and 1 TB/TiB
.TP
\f[CR]ut\f[R]
the units of a file\[cq]s size if it is 1 TB/TiB or higher
.TP
\f[CR]df\f[R]
a device\[cq]s major ID
.TP
\f[CR]ds\f[R]
a device\[cq]s minor ID
.TP
\f[CR]uu\f[R]
a user that\[cq]s you
.TP
\f[CR]uR\f[R]
a user that\[cq]s root
.TP
\f[CR]un\f[R]
a user that\[cq]s someone else
.TP
\f[CR]gu\f[R]
a group that you belong to
.TP
\f[CR]gR\f[R]
a group related to root
.TP
\f[CR]gn\f[R]
a group you aren\[cq]t a member of
.TP
\f[CR]lc\f[R]
a number of hard links
.TP
\f[CR]lm\f[R]
a number of hard links for a regular file with at least two
.TP
\f[CR]ga\f[R]
a new flag in Git
.TP
\f[CR]gm\f[R]
a modified flag in Git
.TP
\f[CR]gd\f[R]
a deleted flag in Git
.TP
\f[CR]gv\f[R]
a renamed flag in Git
.TP
\f[CR]gt\f[R]
a modified metadata flag in Git
.TP
\f[CR]gi\f[R]
an ignored flag in Git
.TP
\f[CR]gc\f[R]
a conflicted flag in Git
.TP
\f[CR]Gm\f[R]
main branch of repo
.TP
\f[CR]Go\f[R]
other branch of repo
.TP
\f[CR]Gc\f[R]
clean branch of repo
.TP
\f[CR]Gd\f[R]
dirty branch of repo
.TP
\f[CR]xx\f[R]
\[lq]punctuation\[rq], including many background UI elements
.TP
\f[CR]da\f[R]
a file\[cq]s date
.TP
\f[CR]in\f[R]
a file\[cq]s inode number
.TP
\f[CR]bl\f[R]
a file\[cq]s number of blocks
.TP
\f[CR]hd\f[R]
the header row of a table
.TP
\f[CR]lp\f[R]
the path of a symlink
.TP
\f[CR]cc\f[R]
an escaped character in a filename
.TP
\f[CR]bO\f[R]
the overlay style for broken symlink paths
.TP
\f[CR]sp\f[R]
special (not file, dir, mount, exec, pipe, socket, block device, char
device, or link)
.TP
\f[CR]mp\f[R]
a mount point
.TP
\f[CR]im\f[R]
a regular file that is an image
.TP
\f[CR]vi\f[R]
a regular file that is a video
.TP
\f[CR]mu\f[R]
a regular file that is lossy music
.TP
\f[CR]lo\f[R]
a regular file that is lossless music
.TP
\f[CR]cr\f[R]
a regular file that is related to cryptography (ex: key or certificate)
.TP
\f[CR]do\f[R]
a regular file that is a document (ex: office suite document or PDF)
.TP
\f[CR]co\f[R]
a regular file that is compressed
.TP
\f[CR]tm\f[R]
a regular file that is temporary (ex: a text editor\[cq]s backup file)
.TP
\f[CR]cm\f[R]
a regular file that is a compilation artifact (ex: Java class file)
.TP
\f[CR]bu\f[R]
a regular file that is used to build a project (ex: Makefile)
.TP
\f[CR]sc\f[R]
a regular file that is source code
.TP
\f[CR]Sn\f[R]
No security context on a file
.TP
\f[CR]Su\f[R]
SELinux user
.TP
\f[CR]Sr\f[R]
SELinux role
.TP
\f[CR]St\f[R]
SELinux type
.TP
\f[CR]Sl\f[R]
SELinux level
.TP
\f[CR]ff\f[R]
BSD file flags
.PP
Values in \f[CR]EXA_COLORS\f[R] override those given in
\f[CR]LS_COLORS\f[R], so you don\[cq]t need to re-write an existing
\f[CR]LS_COLORS\f[R] variable with proprietary extensions.
.SH LIST OF STYLES
Unlike some versions of \f[CR]ls\f[R], the given ANSI values must be
valid colour codes: eza won\[cq]t just print out whichever characters
are given.
.PP
The codes accepted by eza are:
.TP
\f[CR]1\f[R]
for bold
.TP
\f[CR]2\f[R]
for dimmed
.TP
\f[CR]3\f[R]
for italic
.TP
\f[CR]4\f[R]
for underline
.TP
\f[CR]31\f[R]
for red text
.TP
\f[CR]32\f[R]
for green text
.TP
\f[CR]33\f[R]
for yellow text
.TP
\f[CR]34\f[R]
for blue text
.TP
\f[CR]35\f[R]
for purple text
.TP
\f[CR]36\f[R]
for cyan text
.TP
\f[CR]37\f[R]
for white text
.TP
\f[CR]90\f[R]
for dark gray text
.TP
\f[CR]91\f[R]
for bright red text
.TP
\f[CR]92\f[R]
for bright green text
.TP
\f[CR]93\f[R]
for bright yellow text
.TP
\f[CR]94\f[R]
for bright blue text
.TP
\f[CR]95\f[R]
for bright purple text
.TP
\f[CR]96\f[R]
for bright cyan text
.TP
\f[CR]97\f[R]
for bright text
.TP
\f[CR]38;5;nnn\f[R]
for a colour from 0 to 255 (replace the \f[CR]nnn\f[R] part)
.PP
Many terminals will treat bolded text as a different colour, or at least
provide the option to.
.PP
eza 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 eza with \f[CR]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[CR]reset\f[R] entry at the beginning of \f[CR]EZA_COLORS\f[R].
So setting \f[CR]EZA_COLORS=\[dq]reset:*.txt=31\[dq]\f[R] will highlight
only text files; setting \f[CR]EZA_COLORS=\[dq]reset\[dq]\f[R] will
highlight nothing.
.SH AUTHOR
eza is maintained by Christina Sørensen and many other contributors.
.PP
\f[B]Source code:\f[R] \f[CR]https://github.com/eza-community/eza\f[R]
.PD 0
.P
.PD
\f[B]Contributors:\f[R]
\f[CR]https://github.com/eza-community/eza/graphs/contributors\f[R]
.PP
Our infinite thanks to Benjamin `ogham' Sago and all the other
contributors of exa, from which eza was forked.
.SH SEE ALSO
.IP \[bu] 2
eza.1.md
.IP \[bu] 2
eza_colors-explanation.5.md