Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe expose-secrets in rear.8.adoc #3039

Merged
merged 1 commit into from Aug 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 15 additions & 12 deletions doc/rear.8.adoc
Expand Up @@ -12,7 +12,7 @@ rear - bare metal disaster recovery and system migration tool


== SYNOPSIS
*rear* [*-h*|*--help*] [*-V*|*--version*] [*-dsSv*] [*-D*|*--debugscripts* _SET_] [*-c* _DIR_] [*-C* _CONFIG_] [*-r* _KERNEL_] [*-n*|*--non-interactive*] [--] _COMMAND_ [_ARGS_...]
*rear* [*-h*|*--help*] [*-V*|*--version*] [*-dsSv*] [*-D*|*--debugscripts* _SET_] [*-c* _DIR_] [*-C* _CONFIG_] [*-r* _KERNEL_] [*-n*|*--non-interactive*] [*-e*|*--expose-secrets*] [--] _COMMAND_ [_ARGS_...]


== DESCRIPTION
Expand Down Expand Up @@ -57,34 +57,37 @@ the GNU General Public License at: http://www.gnu.org/licenses/gpl.html
usage information

-c DIR::
alternative config directory; instead of /etc/rear
alternative config directory instead of /etc/rear

-C CONFIG::
additional config files; absolute path or relative to config directory
-C CONFIG::
additional config files (absolute path or relative to config directory)

-d::
*debug mode* (run many commands verbosely with debug messages in log file - also sets -v)
*debug mode*: run many commands verbosely with debug messages in the log file (also sets -v)

-D::
*debugscript mode* (log executed commands via 'set -x' - also sets -v and -d)
*debugscript mode*: log executed commands via 'set -x' (also sets -v and -d)

--debugscripts SET::
same as -d -v -D but *debugscript mode* with 'set -SET'
same as -D but *debugscript mode* with 'set -SET'

-r KERNEL::
kernel version to use (by default use running kernel)
kernel version to use (by default the version of the running kernel)

-s::
*simulation mode* (show what scripts are run without executing them)
*simulation mode*: show what scripts are run without executing them

-S::
*step-by-step mode* (acknowledge each script individually)
*step-by-step mode*: acknowledge each script individually

-v::
*verbose mode* (show messages what ReaR is doing on the terminal)
*verbose mode*: show messages what ReaR is doing on the terminal

-n --non-interactive::
*non-interactive mode* (aborts when any user input is required, experimental)
*non-interactive mode*: abort in UserInput() if default input does not make ReaR proceed (experimental)

-e --expose-secrets::
do not suppress output of confidential values (passwords, encryption keys) in particular in the log file

-V --version::
version information
Expand Down