summaryrefslogtreecommitdiffstats
path: root/bfs.1
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2020-06-08 20:05:59 -0400
committerTavian Barnes <tavianator@tavianator.com>2020-06-08 20:05:59 -0400
commita66e8a6df7b04b2d54408061181eead12473fe1b (patch)
tree7a138ab19f73d6b07a58d63701c6e8ecef5c4a73 /bfs.1
parent9a8368704c5824b36d4f21783e36ba3a3ef1a10f (diff)
downloadbfs-a66e8a6df7b04b2d54408061181eead12473fe1b.tar.xz
bfs.1: Add a section on environment variables.
Follow-up for #55.
Diffstat (limited to 'bfs.1')
-rw-r--r--bfs.151
1 files changed, 51 insertions, 0 deletions
diff --git a/bfs.1 b/bfs.1
index 1b5ac0d..20e1c77 100644
--- a/bfs.1
+++ b/bfs.1
@@ -662,6 +662,57 @@ Print version information.
.TP
.B \-help
Print usage information.
+.SH ENVIRONMENT
+Certain environment variables affect the behavior of
+.BR bfs .
+.PP
+.B LANG
+.br
+.B LC_*
+.RS
+Specifies the
+.BR locale (7)
+in use for various things.
+.B bfs
+is not (yet) translated to any languages except English, but the locale will still affect the format of printed values.
+Yes/no prompts (e.g. from
+.BR \-ok )
+will also be interpreted according to the current locale.
+.RE
+.TP
+.B LS_COLORS
+Controls the colors used when displaying file paths if
+.B \-color
+is enabled.
+.B bfs
+interprets this environment variable is interpreted the same way GNU
+.BR ls (1)
+does (see
+.BR dir_colors (5)).
+.TP
+.B NO_COLOR
+Causes
+.B bfs
+to default to
+.B \-nocolor
+if it is set (see https://no-color.org/).
+.TP
+.B PAGER
+Specifies the pager used for
+.B \-help
+output.
+Defaults to
+.BR more (1).
+.TP
+.B POSIXLY_CORRECT
+Makes
+.B bfs
+conform more strictly to the POSIX.1-2017 specification for
+.BR find (1).
+Currently this just disables warnings by default.
+It does not disable
+.BR bfs 's
+various extensions to the base POSIX functionality.
.SH EXAMPLES
.TP
.B bfs