8000 Man pages for 0.10.0 · linuxadmin/salt@1b51c64 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1b51c64

Browse files
thatch45thatch45
committed
Man pages for 0.10.0
1 parent 0952be6 commit 1b51c64

File tree

9 files changed

+3319
-713
lines changed

9 files changed

+3319
-713
lines changed

‎doc/man/salt-call.1

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-CALL" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-CALL" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-call \- salt-call Documentation
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.SH SYNOPSIS
3434
.sp
@@ -46,7 +46,7 @@ Print a usage message briefly summarizing these command\-line options
4646
.INDENT 0.0
4747
.TP
4848
.B \-g, \-\-grains
49-
Return the information generated by the salt grains
49+
Return the information generated by the Salt grains
5050
.UNINDENT
5151
.INDENT 0.0
5252
.TP
@@ -57,7 +57,7 @@ directories can be delimited by commas
5757
.INDENT 0.0
5858
.TP
5959
.B \-d, \-\-doc
60-
Return the documentation for the specified module of for all modules if
60+
Return the documentation for the specified module or for all modules if
6161
none are specified
6262
.UNINDENT
6363
.INDENT 0.0
@@ -70,9 +70,9 @@ settings see the config file. Default: \fBinfo\fP.
7070
.INDENT 0.0
7171
.TP
7272
.B \-\-raw\-out
73-
Print the output from the salt command in raw python
73+
Print the output from the salt command in raw Python
7474
form, this is suitable for re\-reading the output into
75-
an executing python script with eval.
75+
an executing Python script with eval.
7676
.UNINDENT
7777
.INDENT 0.0
7878
.TP
@@ -83,12 +83,12 @@ form the shell would.
8383
.INDENT 0.0
8484
.TP
8585
.B \-\-yaml\-out
86-
Print the output from the salt command in yaml.
86+
Print the output from the salt command in YAML.
8787
.UNINDENT
8888
.INDENT 0.0
8989
.TP
9090
.B \-\-json\-out
91-
Print the output from the salt command in json.
91+
Print the output from the salt command in JSON.
9292
.UNINDENT
9393
.INDENT 0.0
9494
.TP
@@ -105,5 +105,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
105105
.SH COPYRIGHT
106106
2012, Thomas S. Hatch
107107
.\" Generated by docutils manpage writer.
108-
.\"
109108
.

‎doc/man/salt-cp.1

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-CP" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-CP" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-cp \- salt-cp Documentation
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.sp
3434
Copy a file to a set of systems
@@ -45,7 +45,7 @@ salt\-cp \-G \(aqos:Arch.*\(aq [ options ] SOURCE DEST
4545
.fi
4646
.SH DESCRIPTION
4747
.sp
48-
Salt copy copies a local file out to all of the salt minions matched by the
48+
Salt copy copies a local file out to all of the Salt minions matched by the
4949
given target.
5050
.SH OPTIONS
5151
.INDENT 0.0
@@ -56,12 +56,12 @@ Print a usage message briefly summarizing these command\-line options
5656
.INDENT 0.0
5757
.TP
5858
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
59-
The timeout in seconds to wait for replies from the salt minions.
59+
The timeout in seconds to wait for replies from the Salt minions.
6060
.UNINDENT
6161
.INDENT 0.0
6262
.TP
6363
.B \-E, \-\-pcre
64-
The target expression will be interpreted as a pcre regular expression
64+
The target expression will be interpreted as a PCRE regular expression
6565
rather than a shell glob.
6666
.UNINDENT
6767
.INDENT 0.0
@@ -73,14 +73,14 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
7373
.INDENT 0.0
7474
.TP
7575
.B \-G, \-\-grain
76-
The target expression matches values returned by the salt grains system on
76+
The target expression matches values returned by the Salt grains system on
7777
the minions. The target expression is in the format of \(aq<grain value>:<glob
7878
expression>\(aq; example: \(aqos:Arch*\(aq
7979
.UNINDENT
8080
.INDENT 0.0
8181
.TP
8282
.B \-\-grain\-pcre
83-
The target expression matches values returned by the salt grains system on
83+
The target expression matches values returned by the Salt grains system on
8484
the minions. The target expression is in the format of \(aq<grain value>:<pcre
8585
regular expression>\(aq; example: \(aqos:Arch.*\(aq
8686
.UNINDENT
@@ -106,7 +106,7 @@ make sure that the compound target is encapsulated in quotes.
106106
.INDENT 0.0
107107
.TP
108108
.B \-c CONFIG, \-\-config=CONFIG
109-
The location of the salt master configuration file, the salt master
109+
The location of the Salt master configuration file, the Salt master
110110
settings are required to know where the connections are;
111111
default=/etc/salt/master
112112
.UNINDENT
@@ -120,5 +120,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
120120
.SH COPYRIGHT
121121
2012, Thomas S. Hatch
122122
.\" Generated by docutils manpage writer.
123-
.\"
124123
.

‎doc/man/salt-key.1

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-KEY" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-KEY" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-key \- salt-key Documentation
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.SH SYNOPSIS
3434
.sp
@@ -96,5 +96,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
9696
.SH COPYRIGHT
9797
2012, Thomas S. Hatch
9898
.\" Generated by docutils manpage writer.
99-
.\"
10099
.

‎doc/man/salt-master.1

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-MASTER" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-MASTER" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-master \- salt-master Documentation
44
.
@@ -28,13 +28,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.sp
3434
The Salt master daemon, used to control the Salt minions
3535
.SH SYNOPSIS
3636
.sp
37-
Salt\-master [ options ]
37+
salt\-master [ options ]
3838
.SH DESCRIPTION
3939
.sp
4040
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
8181
.SH COPYRIGHT
8282
2012, Thomas S. Hatch
8383
.\" Generated by docutils manpage writer.
84-
.\"
8584
.

‎doc/man/salt-minion.1

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-MINION" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-MINION" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-minion \- salt-minion Documentation
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.sp
3434
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
8282
.SH COPYRIGHT
8383
2012, Thomas S. Hatch
8484
.\" Generated by docutils manpage writer.
85-
.\"
8685
.

‎doc/man/salt-run.1

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-RUN" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-RUN" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-run \- salt-run Documentation
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.sp
3434
Execute a Salt runner
@@ -67,5 +67,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
6767
.SH COPYRIGHT
6868
2012, Thomas S. Hatch
6969
.\" Generated by docutils manpage writer.
70-
.\"
7170
.

‎doc/man/salt-syndic.1

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT-SYNDIC" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT-SYNDIC" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt-syndic \- salt-syndic Documentation
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.sp
3434
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
7676
.SH COPYRIGHT
7777
2012, Thomas S. Hatch
7878
.\" Generated by docutils manpage writer.
79-
.\"
8079
.

‎doc/man/salt.1

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "SALT" "1" "May 11, 2012" "0.9.9" "Salt"
1+
.TH "SALT" "1" "June 16, 2012" "0.10.0" "Salt"
22
.SH NAME
33
salt \- salt
44
.
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2929
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
3030
..
31-
.\" Man page generated from reStructeredText.
31+
.\" Man page generated from reStructuredText.
3232
.
3333
.SH SYNOPSIS
3434
.INDENT 0.0
@@ -58,7 +58,7 @@ Print a usage message briefly summarizing these command\-line options
5858
.INDENT 0.0
5959
.TP
6060
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
61-
The timeout in seconds to wait for replies from the salt minions.
61+
The timeout in seconds to wait for replies from the Salt minions.
6262
.UNINDENT
6363
.INDENT 0.0
6464
.TP
@@ -79,7 +79,7 @@ minions to execute on.
7979
.INDENT 0.0
8080
.TP
8181
.B \-\-version
82-
Print the version of salt that is running.
82+
Print the version of Salt that is running.
8383
.UNINDENT
8484
.INDENT 0.0
8585
.TP
@@ -96,7 +96,7 @@ example: server1.foo.bar,server2.foo.bar,example7.quo.qux
9696
.INDENT 0.0
9797
.TP
9898
.B \-G, \-\-grain
99-
The target expression matches values returned by the salt grains system on
99+
The target expression matches values returned by the Salt grains system on
100100
the minions. The target expression is in the format of \(aq<grain value>:<glob
101101
expression>\(aq; example: \(aqos:Arch*\(aq
102102
.sp
@@ -107,7 +107,7 @@ the \-\-grain\-pcre option.
107107
.INDENT 0.0
108108
.TP
109109
.B \-\-grain\-pcre
110-
The target expression matches values returned by the salt grains system on
110+
The target expression matches values returned by the Salt grains system on
111111
the minions. The target expression is in the format of \(aq<grain value>:<
112112
regular expression>\(aq; example: \(aqos:Arch.*\(aq
113113
.UNINDENT
@@ -128,7 +128,7 @@ Instead of using shell globs use the return code of a function.
128128
.INDENT 0.0
129129
.TP
130130
.B \-N, \-\-nodegroup
131-
Use a predefined compound target defined in the salt master configuration
131+
Use a predefined compound target defined in the Salt master configuration
132132
file
133133
.UNINDENT
134134
.INDENT 0.0
@@ -152,7 +152,7 @@ but will be sent to the specified return system.
152152
.TP
153153
.B \-Q, \-\-query
154154
The \-Q option is being deprecated and will be removed in version 0.9.9,
155-
Use the salt jobs interface instead, for documentation on the salt jobs
155+
Use the Salt jobs interface instead, for documentation on the Salt jobs
156156
interface execute the command "salt\-run \-d jobs"
157157
.sp
158158
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)
161161
.INDENT 0.0
162162
.TP
163163
.B \-c CONFIG, \-\-config=CONFIG
164-
The location of the salt master configuration file, the salt master
164+
The location of the Salt master configuration file, the Salt master
165165
settings are required to know where the connections are;
166166
default=/etc/salt/master
167167
.UNINDENT
168168
.INDENT 0.0
169169
.TP
170170
.B \-\-raw\-out
171-
Print the output from the salt command in raw python
171+
Print the output from the salt command in raw Python
172172
form, this is suitable for re\-reading the output into
173-
an executing python script with eval.
173+
an executing Python script with eval.
174174
.UNINDENT
175175
.INDENT 0.0
176176
.TP
@@ -181,12 +181,12 @@ form the shell would.
181181
.INDENT 0.0
182182
.TP
183183
.B \-\-yaml\-out
184-
Print the output from the salt command in yaml.
184+
Print the output from the salt command in YAML.
185185
.UNINDENT
186186
.INDENT 0.0
187187
.TP
188188
.B \-\-json\-out
189-
Print the output from the salt command in json.
189+
Print the output from the salt command in JSON.
190190
.UNINDENT
191191
.INDENT 0.0
192192
.TP
@@ -203,5 +203,4 @@ Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
203203
.SH COPYRIGHT
204204
2012, Thomas S. Hatch
205205
.\" Generated by docutils manpage writer.
206-
.\"
207206
.

0 commit comments

Comments
 (0)
0