smwltr/cdist
1
0
Fork 0
forked from ungleich-public/cdist
Code Pull requests Activity

cdist man page: update --colors metavar name

Browse source
This commit is contained in:
Dennis Camera 2020-06-07 16:45:48 +02:00
parent 23e66e08fa
commit 89ebd7a4f7
1 changed files with 27 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
docs/src/man1/cdist.rst
View file

@ -15,21 +15,19 @@ SYNOPSIS
cdist banner [-h] [-l LOGLEVEL] [-q] [-v] cdist banner [-h] [-l LOGLEVEL] [-q] [-v]
cdist config [-h] [-l LOGLEVEL] [-q] [-v] [-b] cdist config [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE] [-4] [-6] [-g CONFIG_FILE] [-4] [-6] [-C CACHE_PATH_PATTERN]
[-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST] [-c CONF_DIR] [-i MANIFEST] [-j [JOBS]] [-n] [-o OUT_PATH] [-P]
[-j [JOBS]] [-n] [-o OUT_PATH] [-P]
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH] [-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC] [--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
[-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE] [-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE]
[-p [HOST_MAX]] [-s] [-t] [-p [HOST_MAX]] [-s] [-t]
[host [host ...]] [host [host ...]]
cdist install [-h] [-l LOGLEVEL] [-q] [-v] [-b] cdist install [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE] [-4] [-6] [-g CONFIG_FILE] [-4] [-6] [-C CACHE_PATH_PATTERN]
[-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST] [-c CONF_DIR] [-i MANIFEST] [-j [JOBS]] [-n] [-o OUT_PATH]
[-j [JOBS]] [-n] [-o OUT_PATH] [-P] [-P] [-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC] [--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
[-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE] [-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE]
[-p [HOST_MAX]] [-s] [-t] [-p [HOST_MAX]] [-s] [-t]
@ -37,35 +35,31 @@ SYNOPSIS
cdist inventory [-h] {add-host,add-tag,del-host,del-tag,list} ... cdist inventory [-h] {add-host,add-tag,del-host,del-tag,list} ...
cdist inventory add-host [-h] [-l LOGLEVEL] [-q] [-v] [-b] cdist inventory add-host [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE] [-g CONFIG_FILE] [-I INVENTORY_DIR] [-f HOSTFILE]
[-I INVENTORY_DIR] [-f HOSTFILE]
[host [host ...]] [host [host ...]]
cdist inventory add-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b] cdist inventory add-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE] [-g CONFIG_FILE] [-I INVENTORY_DIR] [-f HOSTFILE]
[-I INVENTORY_DIR] [-f HOSTFILE] [-T TAGFILE]
[-t TAGLIST]
[host [host ...]]
cdist inventory del-host [-h] [-l LOGLEVEL] [-q] [-v] [-b]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE]
[-I INVENTORY_DIR] [-a] [-f HOSTFILE]
[host [host ...]]
cdist inventory del-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE]
[-I INVENTORY_DIR] [-a] [-f HOSTFILE]
[-T TAGFILE] [-t TAGLIST] [-T TAGFILE] [-t TAGLIST]
[host [host ...]] [host [host ...]]
cdist inventory list [-h] [-l LOGLEVEL] [-q] [-v] [-b] cdist inventory del-host [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[--colors COLORED_OUTPUT] [-g CONFIG_FILE] [-g CONFIG_FILE] [-I INVENTORY_DIR] [-a]
[-I INVENTORY_DIR] [-a] [-f HOSTFILE] [-H] [-t] [-f HOSTFILE]
[host [host ...]]
cdist inventory del-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a]
[-f HOSTFILE] [-T TAGFILE] [-t TAGLIST]
[host [host ...]]
cdist inventory list [-h] [-l LOGLEVEL] [-q] [-v] [-b] [--colors WHEN]
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a] [-f HOSTFILE]
[-H] [-t]
[host [host ...]] [host [host ...]]
cdist preos [-h] [-l LOGLEVEL] [-q] [-v] [-c CONF_DIR] [-g CONFIG_FILE] cdist preos [-h] [-l LOGLEVEL] [-q] [-v] [-c CONF_DIR] [-g CONFIG_FILE] [-L]
[-L]
[preos] ... [preos] ...
cdist preos [preos-options] debian [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B] cdist preos [preos-options] debian [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B]
@ -89,8 +83,7 @@ SYNOPSIS
[-S SCRIPT] [-s SUITE] [-y REMOTE_COPY] [-S SCRIPT] [-s SUITE] [-y REMOTE_COPY]
target_dir target_dir
cdist shell [-h] [-l LOGLEVEL] [-q] [-v] [--colors COLORED_OUTPUT] cdist shell [-h] [-l LOGLEVEL] [-q] [-v] [--colors WHEN] [-s SHELL]
[-s SHELL]
cdist info [-h] [-a] [-c CONF_DIR] [-e] [-F] [-f] [-g CONFIG_FILE] [-t] cdist info [-h] [-a] [-c CONF_DIR] [-e] [-F] [-f] [-g CONFIG_FILE] [-t]
[pattern] [pattern]
@ -114,8 +107,7 @@ All commands accept the following options:
**--colors WHEN** **--colors WHEN**
Colorize cdist's output. If enabled, cdist will use different colors for Colorize cdist's output. If enabled, cdist will use different colors for
different log levels. different log levels.
COLORED_OUTPUT recognizes the values 'always', 'never', WHEN recognizes the values 'always', 'never', and 'auto' (the default).
and 'auto' (the default).
If the value is 'auto', colored output is enabled if stdout is a TTY If the value is 'auto', colored output is enabled if stdout is a TTY
unless the NO_COLOR (https://no-color.org/) environment variable is defined. unless the NO_COLOR (https://no-color.org/) environment variable is defined.