saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-16 09:40:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

update manpages to 0.11.0

Browse source
This commit is contained in:
Thomas S Hatch 2012-12-14 06:50:47 -07:00
parent 5bee3b8c15
commit 66b4f36e52
9 changed files with 3042 additions and 1923 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
doc/man/salt-call.1
View file

@ -1,4 +1,4 @@
.TH "SALT-CALL" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-CALL" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
@ -60,6 +60,18 @@ directories can be delimited by commas
.UNINDENT
.INDENT 0.0
.TP
.B \-\-return RETURNER
Set salt\-call to pass the return data to one or many returner interfaces.
To use many returner interfaces specify a comma delimited list of
returners.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-local
Run salt\-call locally, as if there was no master running.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-doc
Return the documentation for the specified module or for all modules if
none are specified
@ -73,32 +85,45 @@ settings see the config file. Default: \fBinfo\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-raw\-out
Print the output from the salt command in raw Python
form, this is suitable for re\-reading the output into
an executing Python script with eval.
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-text\-out
Print the output from the salt command in the same
form the shell would.
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
grains, highstate, json, key, overstatestage, pprint, raw, txt, yaml
Some outputters are formatted only for data returned from specific
functions, for instance the grains outputter will not work for non grains
data.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the pprint outputter and display the return data
using the python pprint library.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yaml\-out
Print the output from the salt command in YAML.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-json\-out
Print the output from the salt command in JSON.
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disables indentation. Only applicable in outputters that support indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Show program\(aqs version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP

2
doc/man/salt-cp.1
View file

@ -1,4 +1,4 @@
.TH "SALT-CP" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-CP" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.

49
doc/man/salt-key.1
View file

@ -1,4 +1,4 @@
.TH "SALT-KEY" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-KEY" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -87,10 +87,10 @@ Delete all keys
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The master configuration file needs to be read to determine where the Salt
keys are stored via the pki_dir configuration value;
default=/etc/salt/master
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.INDENT 0.0
.TP
@ -136,6 +136,45 @@ the \(aq\-\-gen\-keys\(aq option, the key size must be 2048 or
higher, otherwise it will be rounded up to 2048. The
default is 2048.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
grains, highstate, json, key, overstatestage, pprint, raw, txt, yaml
Some outputters are formatted only for data returned from specific
functions, for instance the grains outputter will not work for non grains
data.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the pprint outputter and display the return data
using the python pprint library.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disables indentation. Only applicable in outputters that support indentation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Show program\(aqs version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(7)\fP
\fIsalt\-master(1)\fP
\fIsalt\-minion(1)\fP
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT

18
doc/man/salt-master.1
View file

@ -1,4 +1,4 @@
.TH "SALT-MASTER" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-MASTER" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
@ -46,13 +46,25 @@ Print a usage message briefly summarizing these command\-line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Show program\(aqs version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run the Salt master as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The master configuration file to use, the default is /etc/salt/master
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.INDENT 0.0
.TP

18
doc/man/salt-minion.1
View file

@ -1,4 +1,4 @@
.TH "SALT-MINION" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-MINION" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
@ -52,8 +52,10 @@ Run the Salt minion as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The minion configuration file to use, the default is /etc/salt/minion
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.INDENT 0.0
.TP
@ -72,6 +74,16 @@ Console log level. One of \fBinfo\fP, \fBnone\fP, \fBgarbage\fP,
\fBtrace\fP, \fBwarning\fP, \fBerror\fP, \fBdebug\fP. For the logfile
settings see the config file. Default: \fBwarning\fP.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Show program\(aqs version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(1)\fP

20
doc/man/salt-run.1
View file

@ -1,4 +1,4 @@
.TH "SALT-RUN" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-RUN" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
@ -52,10 +52,20 @@ Print a usage message briefly summarizing these command\-line options
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
.B \-\-version
Show program\(aqs version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.SH SEE ALSO
.sp

17
doc/man/salt-syndic.1
View file

@ -1,4 +1,4 @@
.TH "SALT-SYNDIC" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT-SYNDIC" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
@ -58,13 +58,20 @@ Specify the location of the pidfile
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master\-config=MASTER_CONFIG
The master configuration file to use, the default is /etc/salt/master
.B \-\-version
Show program\(aqs version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-\-minion\-config=MINION_CONFIG
The minion configuration file to use, the default is /etc/salt/minion
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.SH SEE ALSO
.sp

63
doc/man/salt.1
View file

@ -1,4 +1,4 @@
.TH "SALT" "1" "November 15, 2012" "0.10.5" "Salt"
.TH "SALT" "1" "December 14, 2012" "0.11.0" "Salt"
.SH NAME
salt \- salt
.
@ -40,8 +40,6 @@ salt \-E \(aq.*\(aq [ options ] sys.doc cmd
salt \-G \(aqos:Arch.*\(aq [ options ] test.ping
.sp
salt \-C \fI\%'G@os\fP:Arch.* and webserv* or \fI\%G@kernel\fP:FreeBSD\(aq [ options ] test.ping
.sp
salt \-Q test.ping
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@ -96,6 +94,11 @@ Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-versions\-report
Show program\(aqs dependencies version number and exit
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a pcre regular expression
rather than a shell glob.
@ -146,6 +149,13 @@ file.
.UNINDENT
.INDENT 0.0
.TP
.B \-I, \-\-pillar
Instead of using shell globs to evaluate the target use a pillar value to
identify targets, the syntax for the target is the pillar key followed by
a glob expression: "role:production*"
.UNINDENT
.INDENT 0.0
.TP
.B \-S, \-\-ipcidr
Match based on Subnet (CIDR notation) or IPv4 address.
.UNINDENT
@ -168,20 +178,10 @@ but will be sent to the specified return system.
.UNINDENT
.INDENT 0.0
.TP
.B \-Q, \-\-query
The \-Q option is being deprecated and will be removed in version 0.9.9,
Use the Salt jobs interface instead, for documentation on the Salt jobs
interface execute the command "salt\-run \-d jobs"
.sp
Execute a salt command query, this can be used to find the results of a
previous function call: \-Q test.echo\(aq)
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the Salt master configuration file, the Salt master
settings are required to know where the connections are;
default=/etc/salt/master
.B \-c CONFIG_DIR, \-\-config\-dir=CONFIG_dir
The location of the Salt configuration directory, this directory contains
the configuration files for Salt master and minions. The default location
on most systems is /etc/salt.
.UNINDENT
.INDENT 0.0
.TP
@ -191,26 +191,27 @@ print out extra data like the job id.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-raw\-out
Print the output from the salt command in raw Python
form, this is suitable for re\-reading the output into
an executing Python script with eval.
.B \-d, \-\-doc, \-\-documentation
Return the documentation for the module functions available on the minions
.UNINDENT
.INDENT 0.0
.TP
.B \-\-text\-out
Print the output from the salt command in the same
form the shell would.
.B \-\-out
Pass in an alternative outputter to display the return of data. This
outputter can be any of the available outputters:
grains, highstate, json, key, overstatestage, pprint, raw, txt, yaml
Some outputters are formatted only for data returned from specific
functions, for instance the grains outputter will not work for non grains
data.
If an outputter is used that does not support the data passed into it, then
Salt will fall back on the pprint outputter and display the return data
using the python pprint library.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-yaml\-out
Print the output from the salt command in YAML.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-json\-out
Print the output from the salt command in JSON.
.B \-\-out\-indent OUTPUT_INDENT, \-\-output\-indent OUTPUT_INDENT
Print the output indented by the provided value in spaces. Negative values
disables indentation. Only applicable in outputters that support indentation.
.UNINDENT
.INDENT 0.0
.TP

4723
doc/man/salt.7
View file

File diff suppressed because it is too large Load diff