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 live manpages for 0.9.8

Browse source
This commit is contained in:
Thomas S Hatch 2012-03-19 13:02:36 -06:00
parent 66cb8daba7
commit a8f48832af
9 changed files with 6459 additions and 320 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,4 +1,4 @@
.TH "SALT-CALL" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-CALL" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
@ -60,6 +60,41 @@ directories can be delimited by commas
Return the documentation for the specified module of for all modules if
none are specified
.UNINDENT
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
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: \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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-text\-out
Print the output from the salt command in the same
form the shell would.
.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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT

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

@ -1,4 +1,4 @@
.TH "SALT-CP" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-CP" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
@ -74,14 +74,34 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.TP
.B \-G, \-\-grain
The target expression matches values returned by the salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
.UNINDENT
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<pcre
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
.INDENT 0.0
.TP
.B \-Q, \-\-query
Execute a salt command query, this can be used to find the results of a
previous function call: \-Q test.echo\(aq)
.B \-R, \-\-range
Instead of using shell globs to evaluate the targe use a range expression
to identify targets. Range expressions look like %cluster.
.sp
Using the Range option requires that a range server is set up and the
location of the range server is referenced in the master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
.B \-C, \-\-compound
Utilize many target definitions to make the call very granular. This option
takes a group of targets separated by and or or. The default matcher is a
glob as usual, if something other than a glob is used preface it with the
letter denoting the type, example: \(aqwebserv* and \fI\%G@os\fP:Debian or \fI\%E@db*\fP\(aq
make sure that the compound target is encapsulated in quotes.
.UNINDENT
.INDENT 0.0
.TP

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

@ -1,4 +1,4 @@
.TH "SALT-KEY" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-KEY" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -73,10 +73,16 @@ Reject the named minion public key.
.TP
.B \-R, \-\-reject\-all
Rejects all pending public keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-delete=DELETE
Delete the named minion public key for command execution.
.B \-d DELETE, \-\-delete=DELETE
Delete the named minion key for command execution.
.UNINDENT
.INDENT 0.0
.TP
.B \-D DELETE_ALL, \-\-delete\-all=DELETE_ALL
Deleta all keys
.UNINDENT
.INDENT 0.0
.TP

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

@ -1,4 +1,4 @@
.TH "SALT-MASTER" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-MASTER" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
@ -61,6 +61,11 @@ Specify user to run minion
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
Specify the location of the pidfile.
.UNINDENT
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console log level. One of \fBinfo\fP, \fBnone\fP, \fBgarbage\fP,
\fBtrace\fP, \fBwarning\fP, \fBerror\fP, \fBdebug\fP. For the logfile

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

@ -1,4 +1,4 @@
.TH "SALT-MINION" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-MINION" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
@ -62,6 +62,11 @@ Specify user to run minion
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
Specify the location of the pidfile
.UNINDENT
.INDENT 0.0
.TP
.B \-l LOG_LEVEL, \-\-log\-level=LOG_LEVEL
Console log level. One of \fBinfo\fP, \fBnone\fP, \fBgarbage\fP,
\fBtrace\fP, \fBwarning\fP, \fBerror\fP, \fBdebug\fP. For the logfile

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

@ -1,4 +1,4 @@
.TH "SALT-RUN" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-RUN" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.

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

@ -1,4 +1,4 @@
.TH "SALT-SYNDIC" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT-SYNDIC" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
@ -53,6 +53,11 @@ Run the salt syndic as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pid\-file PIDFILE
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
.UNINDENT

52
doc/man/salt.1
View file

@ -1,4 +1,4 @@
.TH "SALT" "1" "February 15, 2012" "0.9.7" "Salt"
.TH "SALT" "1" "March 19, 2012" "0.9.8" "Salt"
.SH NAME
salt \- salt
.
@ -62,6 +62,22 @@ The timeout in seconds to wait for replies from the salt minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-s STATIC, \-\-static=STATIC
By default as of version 0.9.8 the salt command returns data to the
console as it is received from minions, but previous releases would return
data only after all data was received. To only return the data with a hard
timeout and after all minions have returned then use the static option.
.UNINDENT
.INDENT 0.0
.TP
.B \-b BATCH, \-\-batch\-size=BATCH
Instead of executing on all targeted minions at once, execute on a
progressive set of minions. This option takes an argument in the form of
an explicit number of minions to execute at once, or a percentage of
minions to execute on.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Print the version of salt that is running.
.UNINDENT
@ -81,7 +97,18 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.TP
.B \-G, \-\-grain
The target expression matches values returned by the salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<pcre
the minions. The target expression is in the format of \(aq<grain value>:<glob
expression>\(aq; example: \(aqos:Arch*\(aq
.sp
This was changed in version 0.9.8 to accept glob expressions instead of
regular expression. To use regular expression matching with grains use
the \-\-grain\-pcre option.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the salt grains system on
the minions. The target expression is in the format of \(aq<grain value>:<
regular expression>\(aq; example: \(aqos:Arch.*\(aq
.UNINDENT
.INDENT 0.0
@ -90,7 +117,7 @@ regular expression>\(aq; example: \(aqos:Arch.*\(aq
Utilize many target definitions to make the call very granular. This option
takes a group of targets separated by and or or. The default matcher is a
glob as usual, if something other than a glob is used preface it with the
letter denoting the type, example: \(aqwebserv* and \fI\%G@os\fP:Debian or \fI\%E@db.*\fP\(aq
letter denoting the type, example: \(aqwebserv* and \fI\%G@os\fP:Debian or \fI\%E@db*\fP\(aq
make sure that the compound target is encapsulated in quotes.
.UNINDENT
.INDENT 0.0
@ -106,6 +133,16 @@ file
.UNINDENT
.INDENT 0.0
.TP
.B \-R, \-\-range
Instead of using shell globs to evaluate the targe use a range expression
to identify targets. Range expressions look like %cluster.
.sp
Using the Range option requires that a range server is set up and the
location of the range server is referenced in the master configuration
file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-return
Chose an alternative returner to call on the minion, if an alternative
returner is used then the return will not come back tot he command line
@ -114,6 +151,10 @@ but will be sent to the specified return system.
.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
@ -147,6 +188,11 @@ Print the output from the salt command in yaml.
.B \-\-json\-out
Print the output from the salt command in json.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-color
Disable all colored output
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(7)\fP

6627
doc/man/salt.7
View file

File diff suppressed because it is too large Load diff