CVS commit: pkgsrc/sysutils/eza/files

["Santhosh Raju" <fox%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   fox
Date:           Sun Oct 15 20:16:26 UTC 2023

Modified Files:
        pkgsrc/sysutils/eza/files: eza.1 eza_colors-explanation.5 eza_colors.5

Log Message:
sysutils/eza: Update the man pages.


To generate a diff of this commit:
cvs rdiff -u -r1.4 -r1.5 pkgsrc/sysutils/eza/files/eza.1 \
    pkgsrc/sysutils/eza/files/eza_colors-explanation.5 \
    pkgsrc/sysutils/eza/files/eza_colors.5

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/sysutils/eza/files/eza.1
diff -u pkgsrc/sysutils/eza/files/eza.1:1.4 pkgsrc/sysutils/eza/files/eza.1:1.5
--- pkgsrc/sysutils/eza/files/eza.1:1.4 Sun Sep 24 14:22:46 2023
+++ pkgsrc/sysutils/eza/files/eza.1     Sun Oct 15 20:16:26 2023
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "eza" "1" "" "v0.9.0" ""
+.TH "eza" "1" "" "$version" ""
 .hy
 .SH NAME
 .PP
@@ -46,6 +46,13 @@ metadata, inode, and Git status.
 \f[V]eza --long --tree --level=3\f[R]
 Displays a tree of files, three levels deep, as well as each file\[cq]s
 metadata.
+.SH META OPTIONS
+.TP
+\f[V]--help\f[R]
+Show list of command-line options.
+.TP
+\f[V]-v\f[R], \f[V]--version\f[R]
+Show version of eza.
 .SH DISPLAY OPTIONS
 .TP
 \f[V]-1\f[R], \f[V]--oneline\f[R]
@@ -66,13 +73,30 @@ Recurse into directories.
 \f[V]-T\f[R], \f[V]--tree\f[R]
 Recurse into directories as a tree.
 .TP
+\f[V]-X\f[R], \f[V]--dereference\f[R]
+Dereference symbolic links when displaying information.
+.TP
 \f[V]-x\f[R], \f[V]--across\f[R]
 Sort the grid across, rather than downwards.
 .TP
-\f[V]--color\f[R], \f[V]--colour=WHEN\f[R]
-When to use terminal colours.
-Valid settings are `\f[V]always\f[R]', `\f[V]automatic\f[R]', and
-`\f[V]never\f[R]'.
+\f[V]--color=WHEN\f[R], \f[V]--colour=WHEN\f[R]
+When to use terminal colours (using ANSI escape code to colorize the
+output).
+.PP
+Valid settings are `\f[V]always\f[R]', `\f[V]automatic\f[R]' (or
+`\f[V]auto\f[R]' for short), and `\f[V]never\f[R]'.
+The default value is `\f[V]automatic\f[R]'.
+.PP
+The default behavior (`\f[V]automatic\f[R]' or `\f[V]auto\f[R]') is to
+colorize the output only when the standard output is connected to a real
+terminal.
+If the output of \f[V]eza\f[R] is redirected to a file or piped into
+another program, terminal colors will not be used.
+Setting this option to `\f[V]always\f[R]' causes \f[V]eza\f[R] to always
+output terminal color, while `\f[V]never\f[R]' disables the use of
+terminal color.
+.PP
+Manually setting this option overrides \f[V]NO_COLOR\f[R] environment.
 .TP
 \f[V]--color-scale\f[R], \f[V]--colour-scale\f[R]
 Colour file sizes on a scale.
@@ -84,6 +108,9 @@ Display icons next to file names.
 Don\[cq]t display icons.
 (Always overrides \[en]icons)
 .TP
+\f[V]--no-quotes\f[R]
+Don\[cq]t quote file names with spaces.
+.TP
 \f[V]--hyperlink\f[R]
 Display entries as hyperlinks
 .TP
@@ -96,6 +123,9 @@ Show hidden and \[lq]dot\[rq] files.
 Use this twice to also show the `\f[V].\f[R]' and `\f[V]..\f[R]'
 directories.
 .TP
+\f[V]-A\f[R], \f[V]--almost-all\f[R]
+Equivalent to \[en]all; included for compatibility with \f[V]ls -A\f[R].
+.TP
 \f[V]-d\f[R], \f[V]--list-dirs\f[R]
 List directories as regular files, rather than recursing and listing
 their contents.
@@ -135,6 +165,9 @@ List directories before other files.
 .TP
 \f[V]-D\f[R], \f[V]--only-dirs\f[R]
 List only directories, not files.
+.TP
+\f[V]-f\f[R], \f[V]--only-files\f[R]
+List only files, not directories.
 .SH LONG VIEW OPTIONS
 .PP
 These options are available when running with \f[V]--long\f[R]
@@ -181,7 +214,12 @@ Valid timestamp fields are `\f[V]modifie
 \f[V]--time-style=STYLE\f[R]
 How to format timestamps.
 Valid timestamp styles are `\f[V]default\f[R]', `\f[V]iso\f[R]',
-`\f[V]long-iso\f[R]', `\f[V]full-iso\f[R]', and `\f[V]relative\f[R]'.
+`\f[V]long-iso\f[R]', `\f[V]full-iso\f[R]', `\f[V]relative\f[R]', or you
+can use a \f[V]custom\f[R] style with `\f[V]+\f[R]' as prefix.
+(Ex: \[lq]\f[V]+%Y/%m/%d, %H:%M\f[R]\[rq] =>
+\[lq]\f[V]2023/9/30, 12:00\f[R]\[rq]).
+for more details about format syntax, please read:
+https://docs.rs/chrono/latest/chrono/format/strftime/index.html
 .TP
 \f[V]-u\f[R], \f[V]--accessed\f[R]
 Use the accessed timestamp field.
@@ -219,8 +257,8 @@ The status character can be `\f[V]-\f[R]
 `\f[V]D\f[R]' for deleted, `\f[V]R\f[R]' for renamed, `\f[V]T\f[R]' for
 type-change, `\f[V]I\f[R]' for ignored, and `\f[V]U\f[R]' for
 conflicted.
-:Directories will be shown to have the status of their contents, which
-is how `deleted' is possible if a directory contains a file that has a
+Directories will be shown to have the status of their contents, which is
+how `deleted' is possible if a directory contains a file that has a
 certain status, it will be shown to have that status.
 .TP
 \f[V]--git-repos\f[R] [if eza was built with git support]
@@ -238,6 +276,10 @@ Don\[cq]t show Git status (always overri
 \f[V]--git-repos\f[R], \f[V]--git-repos-no-status\f[R])
 .SH ENVIRONMENT VARIABLES
 .PP
+If an environment variable prefixed with \f[V]EZA_\f[R] is not set, for
+backward compatibility, it will default to its counterpart starting with
+\f[V]EXA_\f[R].
+.PP
 eza responds to the following environment variables:
 .SS \f[V]COLUMNS\f[R]
 .PP
@@ -249,7 +291,7 @@ maximum width of 80 characters.
 .PP
 This option won\[cq]t do anything when eza\[cq]s output doesn\[cq]t
 wrap, such as when using the \f[V]--long\f[R] view.
-.SS \f[V]EXA_STRICT\f[R]
+.SS \f[V]EZA_STRICT\f[R]
 .PP
 Enables \f[I]strict mode\f[R], which will make eza error when two
 command-line options are incompatible.
@@ -266,7 +308,7 @@ In strict mode, the two options will not
 This option is intended for use with automated scripts and other
 situations where you want to be certain you\[cq]re typing in the right
 command.
-.SS \f[V]EXA_GRID_ROWS\f[R]
+.SS \f[V]EZA_GRID_ROWS\f[R]
 .PP
 Limits the grid-details view (`\f[V]eza --grid --long\f[R]') so it\[cq]s
 only activated when at least the given number of rows of output would be
@@ -277,7 +319,7 @@ wide and sparse, on just one or two line
 lining up.
 By specifying a minimum number of rows, you can only use the view if
 it\[cq]s going to be worth using.
-.SS \f[V]EXA_ICON_SPACING\f[R]
+.SS \f[V]EZA_ICON_SPACING\f[R]
 .PP
 Specifies the number of spaces to print between an icon (see the
 `\f[V]--icons\f[R]' option) and its file name.
@@ -296,13 +338,16 @@ Disables colours in the output (regardle
 Can be overridden by \f[V]--color\f[R] option.
 .PP
 See \f[V]https://no-color.org/\f[R] for details.
-.SS \f[V]LS_COLORS\f[R], \f[V]EXA_COLORS\f[R]
+.SS \f[V]LS_COLORS\f[R], \f[V]EZA_COLORS\f[R]
 .PP
 Specifies the colour scheme used to highlight files based on their name
 and kind, as well as highlighting metadata and parts of the UI.
 .PP
 For more information on the format of these environment variables, see
 the eza_colors.5.md manual page.
+.SS \f[V]EZA_OVERRIDE_GIT\f[R]
+.PP
+Overrides any \f[V]--git\f[R] or \f[V]--git-repos\f[R] argument
 .SH EXIT STATUSES
 .TP
 0
Index: pkgsrc/sysutils/eza/files/eza_colors-explanation.5
diff -u pkgsrc/sysutils/eza/files/eza_colors-explanation.5:1.4 pkgsrc/sysutils/eza/files/eza_colors-explanation.5:1.5
--- pkgsrc/sysutils/eza/files/eza_colors-explanation.5:1.4      Sun Sep 24 14:22:46 2023
+++ pkgsrc/sysutils/eza/files/eza_colors-explanation.5  Sun Oct 15 20:16:26 2023
@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "" "" "" "" ""
+.TH "eza_colors-explanation" "5" "" "$version" ""
 .hy
 .SH Name
 .PP
@@ -29,31 +29,31 @@ set: running eza with \f[V]LS_COLORS=\[d
 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
+\f[V]reset\f[R] entry at the beginning of \f[V]EZA_COLORS\f[R].
+So setting \f[V]EZA_COLORS=\[dq]reset:*.txt=31\[dq]\f[R] will highlight
+only text files; setting \f[V]EZA_COLORS=\[dq]reset\[dq]\f[R] will
 highlight nothing.
 .SS Examples
 .IP \[bu] 2
 Disable the \[lq]current user\[rq] highlighting:
-\f[V]EXA_COLORS=\[dq]uu=0:gu=0\[dq]\f[R]
+\f[V]EZA_COLORS=\[dq]uu=0:gu=0\[dq]\f[R]
 .IP \[bu] 2
-Turn the date column green: \f[V]EXA_COLORS=\[dq]da=32\[dq]\f[R]
+Turn the date column green: \f[V]EZA_COLORS=\[dq]da=32\[dq]\f[R]
 .IP \[bu] 2
 Highlight Vagrantfiles:
-\f[V]EXA_COLORS=\[dq]Vagrantfile=1;4;33\[dq]\f[R]
+\f[V]EZA_COLORS=\[dq]Vagrantfile=1;4;33\[dq]\f[R]
 .IP \[bu] 2
 Override the existing zip colour:
-\f[V]EXA_COLORS=\[dq]*.zip=38;5;125\[dq]\f[R]
+\f[V]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[V]EXA_COLORS=\[dq]*.md=38;5;121:*.log=38;5;248\[dq]\f[R]
+\f[V]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[V]bright\f[R] colour codes when selecting your custom colours in
-your \f[V]#EXA_COLORS\f[R] environment variable.
+your \f[V]#EZA_COLORS\f[R] environment variable.
 .IP \[bu] 2
 Build (Makefile, Cargo.toml, package.json) are yellow and underlined.
 .IP \[bu] 2
Index: pkgsrc/sysutils/eza/files/eza_colors.5
diff -u pkgsrc/sysutils/eza/files/eza_colors.5:1.4 pkgsrc/sysutils/eza/files/eza_colors.5:1.5
--- pkgsrc/sysutils/eza/files/eza_colors.5:1.4  Sun Sep 24 14:22:46 2023
+++ pkgsrc/sysutils/eza/files/eza_colors.5      Sun Oct 15 20:16:26 2023
@@ -14,14 +14,14 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "eza_colors" "5" "" "v0.9.0" ""
+.TH "eza_colors" "5" "" "$version" ""
 .hy
 .SH NAME
 .PP
 eza_colors \[em] customising the file and UI colours of eza
 .SH SYNOPSIS
 .PP
-The \f[V]EXA_COLORS\f[R] environment variable can be used to customise
+The \f[V]EZA_COLORS\f[R] environment variable can be used to customise
 the colours that \f[V]eza\f[R] uses to highlight file names, file
 metadata, and parts of the UI.
 .PP
@@ -42,21 +42,24 @@ Finally, multiple pairs are separated by
 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[V]EXA_COLORS\f[R] environment variables
+is checked if \f[V]EZA_COLORS\f[R] is unset.
 .SH EXAMPLES
 .TP
-\f[V]EXA_COLORS=\[dq]uu=0:gu=0\[dq]\f[R]
+\f[V]EZA_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]
+\f[V]EZA_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]
+\f[V]EZA_COLORS=\[dq]Vagrantfile=1;4;33\[dq]\f[R]
 Highlight Vagrantfiles
 .TP
-\f[V]EXA_COLORS=\[dq]*.zip=38;5;125\[dq]\f[R]
+\f[V]EZA_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]
+\f[V]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
 .PP
@@ -89,7 +92,10 @@ symlinks
 \f[V]or\f[R]
 symlinks with no target
 .PP
-\f[V]EXA_COLORS\f[R] can use many more:
+\f[V]EZA_COLORS\f[R] can use many more:
+.TP
+\f[V]oc\f[R]
+the permissions displayed as octal
 .TP
 \f[V]ur\f[R]
 the user-read permission bit
@@ -177,12 +183,18 @@ a device\[cq]s minor ID
 \f[V]uu\f[R]
 a user that\[cq]s you
 .TP
+\f[V]uR\f[R]
+a user that\[cq]s root
+.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]gR\f[R]
+a group related to root
+.TP
 \f[V]gn\f[R]
 a group you aren\[cq]t a member of
 .TP
@@ -210,6 +222,21 @@ a modified metadata flag in Git
 \f[V]gi\f[R]
 an ignored flag in Git
 .TP
+\f[V]gc\f[R]
+a conflicted flag in Git
+.TP
+\f[V]Gm\f[R]
+main branch of repo
+.TP
+\f[V]Go\f[R]
+other branch of repo
+.TP
+\f[V]Gc\f[R]
+clean branch of repo
+.TP
+\f[V]Gd\f[R]
+dirty branch of repo
+.TP
 \f[V]xx\f[R]
 \[lq]punctuation\[rq], including many background UI elements
 .TP
@@ -234,6 +261,10 @@ an escaped character in a filename
 \f[V]bO\f[R]
 the overlay style for broken symlink paths
 .TP
+\f[V]sp\f[R]
+special (not file, dir, mount, exec, pipe, socket, block device, char
+device, or link)
+.TP
 \f[V]mp\f[R]
 a mount point
 .TP
@@ -256,7 +287,7 @@ a regular file that is related to crypto
 a regular file that is a document (ex: office suite document or PDF)
 .TP
 \f[V]co\f[R]
-a regular file this is compressed
+a regular file that is compressed
 .TP
 \f[V]tm\f[R]
 a regular file that is temporary (ex: a text editor\[cq]s backup file)
@@ -266,6 +297,21 @@ a regular file that is a compilation art
 .TP
 \f[V]bu\f[R]
 a regular file that is used to build a project (ex: Makefile)
+.TP
+\f[V]Sn\f[R]
+No security context on a file
+.TP
+\f[V]Su\f[R]
+SELinux user
+.TP
+\f[V]Sr\f[R]
+SELinux role
+.TP
+\f[V]St\f[R]
+SELinux type
+.TP
+\f[V]Sl\f[R]
+SELinux level
 .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
@@ -349,9 +395,9 @@ set: running eza with \f[V]LS_COLORS=\[d
 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
+\f[V]reset\f[R] entry at the beginning of \f[V]EZA_COLORS\f[R].
+So setting \f[V]EZA_COLORS=\[dq]reset:*.txt=31\[dq]\f[R] will highlight
+only text files; setting \f[V]EZA_COLORS=\[dq]reset\[dq]\f[R] will
 highlight nothing.
 .SH AUTHOR
 .PP