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

add generated manpages

Browse source
This commit is contained in:
Thomas S Hatch 2011-08-27 11:38:12 -06:00
parent 4f6182d804
commit 54abecd9bc
9 changed files with 1206 additions and 304 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
doc/man/salt-call.1 Normal file
View file

@ -0,0 +1,69 @@
.TH "SALT-CALL" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
.nf
.ft C
salt\-call [options]
.ft P
.fi
.SH OPTIONS
.INDENT 0.0
.TP
.B \-h, \-\-help
Print a usage message briefly summarizing these command\-line options
.UNINDENT
.INDENT 0.0
.TP
.B \-g, \-\-grains
Return the information generated by the salt grains
.UNINDENT
.INDENT 0.0
.TP
.B \-m MODULE_DIRS, \-\-module\-dirs=MODULE_DIRS
Specify an additional directories to pull modules from, multiple
directories can be delimited by commas
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-doc
Return the documentation for the specified module of for all modules if
none are specified
.UNINDENT
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2011, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

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

@ -1,4 +1,4 @@
.TH "SALT-CP" "1" "July 09, 2011" "0.8.9" "Salt"
.TH "SALT-CP" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
@ -51,33 +51,28 @@ given target.
.INDENT 0.0
.TP
.B \-h, \-\-help
.sp
Print a usage message briefly summarizing these command\-line options
.UNINDENT
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
.sp
The timeout in seconds to wait for replies from the salt minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-pcre
.sp
The target expresion will be interpereted as a pcre regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-list
.sp
The target expression will be interpereted as a comma delimited list,
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.UNINDENT
.INDENT 0.0
.TP
.B \-G, \-\-grain
.sp
The target expression matches values returned by the salt grains system on
the minions. The target expresion is in the format of \(aq<grain value>:<pcre
regular expresion>\(aq; example: \(aqos:Arch.*\(aq
@ -85,14 +80,12 @@ regular expresion>\(aq; example: \(aqos:Arch.*\(aq
.INDENT 0.0
.TP
.B \-Q, \-\-query
.sp
Execute a salt command query, this can be used to find the results os a
previous function call: \-Q test.echo\(aq)
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
.sp
The location of the salt master configuration file, the salt master
settings are required to know where the connections are;
default=/etc/salt/master

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

@ -1,4 +1,4 @@
.TH "SALT-KEY" "1" "July 09, 2011" "0.8.9" "Salt"
.TH "SALT-KEY" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -41,38 +41,32 @@ authentication.
.INDENT 0.0
.TP
.B \-h, \-\-help
.sp
Print a usage message briefly summarizing these command\-line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-list
.sp
List the unaccepted minion public keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-list\-all
.sp
List all public keys on this salt master, both accepted and pending
acceptance.
.UNINDENT
.INDENT 0.0
.TP
.B \-a ACCEPT, \-\-accept=ACCEPT
.sp
Accept the named minion public key for command execution.
.UNINDENT
.INDENT 0.0
.TP
.B \-A, \-\-accept\-all
.sp
Accepts all pending public keys.
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
.sp
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

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

@ -1,4 +1,4 @@
.TH "SALT-MASTER" "1" "July 09, 2011" "0.8.9" "Salt"
.TH "SALT-MASTER" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
@ -42,19 +42,16 @@ The master daemon controls the salt minions
.INDENT 0.0
.TP
.B \-h, \-\-help
.sp
Print a usage message briefly summarizing these command\-line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
.sp
Run the salt master as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
.sp
The master configuration file to use, the default is /etc/salt/master
.UNINDENT
.SH AUTHOR

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

@ -1,4 +1,4 @@
.TH "SALT-MINION" "1" "July 09, 2011" "0.8.9" "Salt"
.TH "SALT-MINION" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
@ -43,19 +43,16 @@ the results of said commands.
.INDENT 0.0
.TP
.B \-h, \-\-help
.sp
Print a usage message briefly summarizing these command\-line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
.sp
Run the salt minion as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
.sp
The minion configuration file to use, the default is /etc/salt/minion
.UNINDENT
.SH AUTHOR

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

@ -1,4 +1,4 @@
.TH "SALT-RUN" "1" "July 09, 2011" "0.8.9" "Salt"
.TH "SALT-RUN" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
@ -48,13 +48,11 @@ master
.INDENT 0.0
.TP
.B \-h, \-\-help
.sp
Print a usage message briefly summarizing these command\-line options
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
.sp
The location of the salt master configuration file, the salt master
settings are required to know where the connections are;
default=/etc/salt/master

70
doc/man/salt-syndic.1 Normal file
View file

@ -0,0 +1,70 @@
.TH "SALT-SYNDIC" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.sp
The salt syndic daemon, a special minion that passes through commands from a
higher master
.SH SYNOPSIS
.sp
salt\-syndic [ options ]
.SH DESCRIPTION
.sp
The salt syndic daemon, a special minion that passes through commands from a
higher master.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-h, \-\-help
Print a usage message briefly summarizing these command\-line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-daemon
Run the salt syndic as a daemon
.UNINDENT
.INDENT 0.0
.TP
.B \-\-master\-config=MASTER_CONFIG
The master configuration file to use, the default is /etc/salt/master
.UNINDENT
.INDENT 0.0
.TP
.B \-\-minion\-config=MINION_CONFIG
The minion configuration file to use, the default is /etc/salt/minion
.UNINDENT
.SH AUTHOR
Thomas S. Hatch <thatch@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2011, Thomas S. Hatch
.\" Generated by docutils manpage writer.
.\"
.

10
doc/man/salt.1
View file

@ -1,4 +1,4 @@
.TH "SALT" "1" "July 09, 2011" "0.8.9" "Salt"
.TH "SALT" "1" "August 27, 2011" "0.9.0" "Salt"
.SH NAME
salt \- salt
.
@ -33,7 +33,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
salt \(aq*\(aq [ options ] sys.doc
.sp
salt \-E \(aq.*\(aq [ options ] sys.doc cmd
@ -52,33 +51,28 @@ with ease.
.INDENT 0.0
.TP
.B \-h, \-\-help
.sp
Print a usage message briefly summarizing these command\-line options
.UNINDENT
.INDENT 0.0
.TP
.B \-t TIMEOUT, \-\-timeout=TIMEOUT
.sp
The timeout in seconds to wait for replies from the salt minions.
.UNINDENT
.INDENT 0.0
.TP
.B \-E, \-\-pcre
.sp
The target expression will be interpreted as a pcre regular expression
rather than a shell glob.
.UNINDENT
.INDENT 0.0
.TP
.B \-L, \-\-list
.sp
The target expression will be interpreted as a comma delimited list,
example: server1.foo.bar,server2.foo.bar,example7.quo.qux
.UNINDENT
.INDENT 0.0
.TP
.B \-G, \-\-grain
.sp
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
@ -86,14 +80,12 @@ regular expression>\(aq; example: \(aqos:Arch.*\(aq
.INDENT 0.0
.TP
.B \-Q, \-\-query
.sp
Execute a salt command query, this can be used to find the results os a
previous function call: \-Q test.echo\(aq)
.UNINDENT
.INDENT 0.0
.TP
.B \-c CONFIG, \-\-config=CONFIG
.sp
The location of the salt master configuration file, the salt master
settings are required to know where the connections are;
default=/etc/salt/master

1330
doc/man/salt.7
View file

File diff suppressed because it is too large Load diff