.\" Automatically generated by Pandoc 3.5
.\"
.TH "eza_colors\-explanation" "5" "" "$version"
.SH Name
eza_colors\-explanation \[em] more details on customizing eza colors
.SH Eza Color Explanation
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.
.SS Examples
.IP \[bu] 2
Disable the \[lq]current user\[rq] highlighting:
\f[CR]EZA_COLORS=\[dq]uu=0:gu=0\[dq]\f[R]
.IP \[bu] 2
Turn the date column green: \f[CR]EZA_COLORS=\[dq]da=32\[dq]\f[R]
.IP \[bu] 2
Highlight Vagrantfiles:
\f[CR]EZA_COLORS=\[dq]Vagrantfile=1;4;33\[dq]\f[R]
.IP \[bu] 2
Override the existing zip colour:
\f[CR]EZA_COLORS=\[dq]*.zip=38;5;125\[dq]\f[R]
.IP \[bu] 2
Markdown files a shade of green, log files a shade of grey:
\f[CR]EZA_COLORS=\[dq]*.md=38;5;121:*.log=38;5;248\[dq]\f[R]
.SS BUILT\-IN EXTENSIONS
.IP \[bu] 2
eza now supports bright colours!
As supported by most modern 256\-colour terminals, you can now choose
from \f[CR]bright\f[R] colour codes when selecting your custom colours
in your \f[CR]#EZA_COLORS\f[R] environment variable.
.IP \[bu] 2
Build (Makefile, Cargo.toml, package.json) are yellow and underlined.
.IP \[bu] 2
Images (png, jpeg, gif) are purple.
.IP \[bu] 2
Videos (mp4, ogv, m2ts) are a slightly purpler purple.
.IP \[bu] 2
Music (mp3, m4a, ogg) is a faint blue.
.IP \[bu] 2
Lossless music (flac, alac, wav) is a less faint blue.
.IP \[bu] 2
Cryptographic files (asc, enc, p12) are bright green.
.IP \[bu] 2
Documents (pdf, doc, dvi) are a fainter green.
.IP \[bu] 2
Compressed files (zip, tgz, Z) are red.
.IP \[bu] 2
Temporary files (tmp, swp, \[ti]) are dimmed default foreground color.
.IP \[bu] 2
Compiled files (class, o, pyc) are yellow.
A file is also counted as compiled if it uses a common extension and is
in the same directory as one of its source files: styles.css will count
as compiled when next to styles.less or styles.sass, and scripts.js when
next to scripts.ts or scripts.coffee.
.IP \[bu] 2
Source files (cpp, js, java) are bright yellow.
.SS Theme Configuration file
Now you can specify these options and more in a \f[CR]theme.yml\f[R]
file with convenient syntax for defining your styles.
.PP
Set \f[CR]EZA_CONFIG_DIR\f[R] to specify which directory you would like
eza to look for your \f[CR]theme.yml\f[R] file, otherwise eza will look
for \f[CR]$XDG_CONFIG_HOME/eza/theme.yml\f[R].
.PP
These are the available options:
.SH LIST OF THEME OPTIONS
.IP
.EX
filekinds\f[B]:\f[R]
  normal
  directory
  symlink
  pipe
  block_device
  char_device
  socket
  special
  executable
  mount_point

perms\f[B]:\f[R]
  user_read
  user_write
  user_execute_file
  user_execute_other
  group_read
  group_write
  group_execute
  other_read
  other_write
  other_execute
  special_user_file
  special_other
  attribute

size\f[B]:\f[R]
  major
  minor
  number_byte
  number_kilo
  number_mega
  number_giga
  number_huge
  unit_byte
  unit_kilo
  unit_mega
  unit_giga
  unit_huge

users\f[B]:\f[R]
  user_you
  user_root
  user_other
  group_yours
  group_other
  group_root

links\f[B]:\f[R]
  normal
  multi_link_file

git\f[B]:\f[R]
  new
  modified
  deleted
  renamed
  ignored
  conflicted

git_repo\f[B]:\f[R]
  branch_main
  branch_other
  git_clean
  git_dirty

security_context\f[B]:\f[R]
  none\f[B]:\f[R]
  selinux\f[B]:\f[R]
    colon
    user
    role
    typ
    range

file_type\f[B]:\f[R]
  image
  video
  music
  crypto
  document
  compressed
  temp
  compiled
  build
  source

punctuation\f[B]:\f[R]

date\f[B]:\f[R]

inode\f[B]:\f[R]

blocks\f[B]:\f[R]

header\f[B]:\f[R]

octal\f[B]:\f[R]

flags\f[B]:\f[R]

control_char\f[B]:\f[R]

broken_symlink\f[B]:\f[R]

broken_path_overlay\f[B]:\f[R]
.EE
.PP
Each of those fields/sub fields can have the following styling
properties defined beneath it
.IP
.EX
    foreground\f[B]:\f[R] Blue
    background\f[B]:\f[R] null
    is_bold\f[B]:\f[R] false
    is_dimmed\f[B]:\f[R] false
    is_italic\f[B]:\f[R] false
    is_underline\f[B]:\f[R] false
    is_blink\f[B]:\f[R] false
    is_reverse\f[B]:\f[R] false
    is_hidden\f[B]:\f[R] false
    is_strikethrough\f[B]:\f[R] true
    prefix_with_reset\f[B]:\f[R] false
.EE
.PP
Example:
.IP
.EX

file_type\f[B]:\f[R]
  image\f[B]:\f[R]
    foreground\f[B]:\f[R] Blue
    is_italic\f[B]:\f[R] true
date\f[B]:\f[R]
  foreground\f[B]:\f[R] White

security_context\f[B]:\f[R]
  selinux\f[B]:\f[R]
    role\f[B]:\f[R]
      is_hidden\f[B]:\f[R] true
.EE
.PP
Icons can now be customized as well in the \f[CR]filenames\f[R] and
\f[CR]extensions\f[R] fields
.IP
.EX

filenames\f[B]:\f[R]
\f[I]  # Just change the icon glyph\f[R]
  Cargo.toml\f[B]:\f[R] \f[B]{\f[R]icon\f[B]:\f[R] \f[B]{\f[R]glyph\f[B]:\f[R] 🦀\f[B]}}\f[R]
  Cargo.lock\f[B]:\f[R] \f[B]{\f[R]icon\f[B]:\f[R] \f[B]{\f[R]glyph\f[B]:\f[R] 🦀\f[B]}}\f[R]

extensions\f[B]:\f[R]
  rs\f[B]:\f[R] \f[B]{\f[R]  filename\f[B]:\f[R] \f[B]{\f[R]foreground\f[B]:\f[R] Red\f[B]},\f[R] icon\f[B]:\f[R] \f[B]{\f[R]glyph\f[B]:\f[R] 🦀\f[B]}}\f[R]
.EE
.PP
\f[B]NOTES:\f[R]
.PP
Not all glyphs support changing colors.
.PP
If your theme is not working properly, double check the syntax in the
config file, as a syntax issue can cause multiple properties to not be
applied.
.PP
You must name the file \f[CR]theme.yml\f[R], no matter the directory you
specify.
.SS See also
.IP \[bu] 2
\f[B]eza\f[R](1)
.IP \[bu] 2
\f[B]eza_colors\f[R](5)