valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-06 16:45:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Man pages for 0.10.0

Browse Source
This commit is contained in:
Thomas S Hatch 2012-06-16 16:25:22 -06:00
parent 0952be6f24
commit 1b51c648ed
9 changed files with 3201 additions and 595 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/man/salt-call.1
View File

@ -1,4 +1,4 @@
.TH "SALT-CALL" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-CALL" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
@ -46,7 +46,7 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-g, \-\-grains
Return the information generated by the salt grains
Return the information generated by the Salt grains
.UNINDENT
.INDENT 0.0
.TP
@ -57,7 +57,7 @@ directories can be delimited by commas
.INDENT 0.0
.TP
.B \-d, \-\-doc
Return the documentation for the specified module of for all modules if
Return the documentation for the specified module or for all modules if
none are specified
.UNINDENT
.INDENT 0.0
@ -70,9 +70,9 @@ settings see the config file. Default: \fBinfo\fP.
.INDENT 0.0
.TP
.B \-\-raw\-out
Print the output from the salt command in raw python
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.
an executing Python script with eval.
.UNINDENT
.INDENT 0.0
.TP
@ -83,12 +83,12 @@ form the shell would.
.INDENT 0.0
.TP
.B \-\-yaml\-out
Print the output from the salt command in yaml.
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.
Print the output from the salt command in JSON.
.UNINDENT
.INDENT 0.0
.TP
@ -105,5 +105,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

17
doc/man/salt-cp.1
View File

@ -1,4 +1,4 @@
.TH "SALT-CP" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-CP" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
Copy a file to a set of systems
@ -45,7 +45,7 @@ salt\-cp \-G \(aqos:Arch.*\(aq [ options ] SOURCE DEST
.fi
.SH DESCRIPTION
.sp
Salt copy copies a local file out to all of the salt minions matched by the
Salt copy copies a local file out to all of the Salt minions matched by the
given target.
.SH OPTIONS
.INDENT 0.0
@ -56,12 +56,12 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
The timeout in seconds to wait for replies from the Salt minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-pcre
The target expression will be interpreted as a pcre regular expression
The target expression will be interpreted as a PCRE regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
@ -73,14 +73,14 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.INDENT 0.0
.TP
.B \-G, \-\-grain
The target expression matches values returned by the salt grains system on
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 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
@ -106,7 +106,7 @@ make sure that the compound target is encapsulated in quotes.
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the salt master configuration file, the salt master
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
@ -120,5 +120,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

5
doc/man/salt-key.1
View File

@ -1,4 +1,4 @@
.TH "SALT-KEY" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-KEY" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
@ -96,5 +96,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

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

@ -1,4 +1,4 @@
.TH "SALT-MASTER" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-MASTER" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
@ -28,13 +28,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
The Salt master daemon, used to control the Salt minions
.SH SYNOPSIS
.sp
Salt\-master [ options ]
salt\-master [ options ]
.SH DESCRIPTION
.sp
The master daemon controls the Salt minions
@ -81,5 +81,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

5
doc/man/salt-minion.1
View File

@ -1,4 +1,4 @@
.TH "SALT-MINION" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-MINION" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
The Salt minion daemon, receives commands from a remote Salt master.
@ -82,5 +82,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

5
doc/man/salt-run.1
View File

@ -1,4 +1,4 @@
.TH "SALT-RUN" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-RUN" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
Execute a Salt runner
@ -67,5 +67,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

5
doc/man/salt-syndic.1
View File

@ -1,4 +1,4 @@
.TH "SALT-SYNDIC" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT-SYNDIC" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.sp
The Salt syndic daemon, a special minion that passes through commands from a
@ -76,5 +76,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

27
doc/man/salt.1
View File

@ -1,4 +1,4 @@
.TH "SALT" "1" "May 11, 2012" "0.9.9" "Salt"
.TH "SALT" "1" "June 16, 2012" "0.10.0" "Salt"
.SH NAME
salt \- salt
.
@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.INDENT 0.0
@ -58,7 +58,7 @@ Print a usage message briefly summarizing these command\-line options
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
The timeout in seconds to wait for replies from the salt minions.
The timeout in seconds to wait for replies from the Salt minions.
.UNINDENT
.INDENT 0.0
.TP
@ -79,7 +79,7 @@ minions to execute on.
.INDENT 0.0
.TP
.B \-\-version
Print the version of salt that is running.
Print the version of Salt that is running.
.UNINDENT
.INDENT 0.0
.TP
@ -96,7 +96,7 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.INDENT 0.0
.TP
.B \-G, \-\-grain
The target expression matches values returned by the salt grains system on
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
.sp
@ -107,7 +107,7 @@ the \-\-grain\-pcre option.
.INDENT 0.0
.TP
.B \-\-grain\-pcre
The target expression matches values returned by the salt grains system on
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
@ -128,7 +128,7 @@ Instead of using shell globs use the return code of a function.
.INDENT 0.0
.TP
.B \-N, \-\-nodegroup
Use a predefined compound target defined in the salt master configuration
Use a predefined compound target defined in the Salt master configuration
file
.UNINDENT
.INDENT 0.0
@ -152,7 +152,7 @@ but will be sent to the specified return system.
.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
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
@ -161,16 +161,16 @@ previous function call: \-Q test.echo\(aq)
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
The location of the salt master configuration file, the salt master
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
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.
an executing Python script with eval.
.UNINDENT
.INDENT 0.0
.TP
@ -181,12 +181,12 @@ form the shell would.
.INDENT 0.0
.TP
.B \-\-yaml\-out
Print the output from the salt command in yaml.
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.
Print the output from the salt command in JSON.
.UNINDENT
.INDENT 0.0
.TP
@ -203,5 +203,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

3708
doc/man/salt.7
View File

File diff suppressed because it is too large Load Diff