From a4678ab3c4decfadef41890c20a48538162bcf49 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Mon, 10 Oct 2022 16:36:54 +0200 Subject: [PATCH] man/nmcli: document variables affecting fancy output Notably, PAGER, TERM and NO_COLORS. --- man/nmcli.xml | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/man/nmcli.xml b/man/nmcli.xml index 768087ea46..1caafd3176 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -2253,8 +2253,47 @@ unset or null. - + + NO_COLOR + + Default to not producing colored and paged output. The + option, if used, takes precedence. + + + + + PAGER + + Filter to pipe the output through if it doesn't fit on a screen. + Can be a file name of an executable or a shell command. Empty string to + disable the functionality. + + Note that the pager command is expected to handle wide characters + and ANSI escape sequences for changing colors (unless they're disabled). + nmcli sets up the environment variables + LESS and LESSCHARSET appropriately for the + less1 + pager, other pagers may or may not need extra configuration. + + If unspecified, + pager1, + less1 + and more1 + will be tried (in that order). + + + + + TERM + + Terminal type. If dumb, nmcli + will not use a pager or produce ANSI escape sequences for coloring. + Terminal types other than dumb are assumed to + support ASCII escape sequences for setting the output color. + + + Internationalization notes