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 the manpages

Browse source
This commit is contained in:
Thomas S Hatch 2012-01-14 20:23:12 -07:00
parent fcca8ddc59
commit 4169f45899
9 changed files with 1921 additions and 516 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,4 +1,4 @@
.TH "SALT-CALL" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-CALL" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.

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

@ -1,4 +1,4 @@
.TH "SALT-CP" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-CP" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
@ -80,7 +80,7 @@ regular expresion>\(aq; example: \(aqos:Arch.*\(aq
.INDENT 0.0
.TP
.B \-Q, \-\-query
Execute a salt command query, this can be used to find the results os a
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

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

@ -1,4 +1,4 @@
.TH "SALT-KEY" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-KEY" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.

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

@ -1,4 +1,4 @@
.TH "SALT-MASTER" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-MASTER" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.

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

@ -1,4 +1,4 @@
.TH "SALT-MINION" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-MINION" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.

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

@ -1,4 +1,4 @@
.TH "SALT-RUN" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-RUN" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.

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

@ -1,4 +1,4 @@
.TH "SALT-SYNDIC" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT-SYNDIC" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.

61
doc/man/salt.1
View file

@ -1,4 +1,4 @@
.TH "SALT" "1" "November 27, 2011" "0.9.4" "Salt"
.TH "SALT" "1" "January 14, 2012" "0.9.5" "Salt"
.SH NAME
salt \- salt
.
@ -39,6 +39,8 @@ salt \-E \(aq.*\(aq [ options ] sys.doc cmd
.sp
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
@ -60,6 +62,11 @@ The timeout in seconds to wait for replies from the salt minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Print the version of salt that is running.
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a pcre regular expression
rather than a shell glob.
@ -79,8 +86,35 @@ regular expression>\(aq; example: \(aqos:Arch.*\(aq
.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
.B \-X, \-\-exsel
Instead of using shell globs use the return code of a function.
.UNINDENT
.INDENT 0.0
.TP
.B \-N, \-\-nodegroup
Use a predefined compound target defined in the salt 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
but will be sent to the specified return system.
.UNINDENT
.INDENT 0.0
.TP
.B \-Q, \-\-query
Execute a salt command query, this can be used to find the results os a
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
@ -90,6 +124,29 @@ The location of the salt master configuration file, the salt master
settings are required to know where the connections are;
default=/etc/salt/master
.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
.SH SEE ALSO
.sp
\fIsalt(7)\fP

2360
doc/man/salt.7
View file

File diff suppressed because it is too large Load diff