Regenerated and updated man pages, updated release version in conf.py to 2014.7.2

This commit is contained in:
Jacob Hammons 2015-03-10 09:22:57 -06:00
parent 6ac6a53302
commit 921d679065
14 changed files with 76207 additions and 31734 deletions

View file

@ -151,7 +151,7 @@ copyright = '2014 SaltStack, Inc.'
version = salt.version.__version__
#release = '.'.join(map(str, salt.version.__version_info__))
release = '2014.7.1'
release = '2014.7.2'
needs_sphinx = '1.3'

View file

@ -1,8 +1,8 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-API" "1" "April 05, 2014" "0.8.3" "salt-api"
.TH "SALT-API" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-api \- salt-api
salt-api \- salt-api Command
.
.nr rst2man-indent-level 0
.
@ -65,6 +65,6 @@ Specify an alternative location for the salt master configuration file.
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2012, Thomas S. Hatch
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CALL" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-CALL" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.
@ -178,6 +178,16 @@ Disable all colored output
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
@ -187,6 +197,6 @@ Force colored output
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CLOUD" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-CLOUD" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-cloud \- Salt Cloud Command
.
@ -161,18 +161,11 @@ 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.
.B \-\-out=OUTPUT, \-\-output=OUTPUT
Print the output from the salt\-cloud command using the specified outputter. The
builtins are \(aqraw\(aq, \(aqcompact\(aq, \(aqno_return\(aq, \(aqgrains\(aq, \(aqoverstatestage\(aq, \(aqpprint\(aq,
\(aqjson\(aq, \(aqnested\(aq, \(aqyaml\(aq, \(aqhighstate\(aq, \(aqquiet\(aq, \(aqkey\(aq, \(aqtxt\(aq, \(aqnewline_values_only\(aq,
\(aqvirt_query\(aq.
.UNINDENT
.INDENT 0.0
.TP
@ -261,6 +254,6 @@ salt\-cloud \-m /path/to/cloud.map \-Q
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CP" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-CP" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.
@ -158,6 +158,6 @@ file.
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-KEY" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-KEY" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -31,8 +31,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-key [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Salt\-key executes simple management of Salt server public keys used for
@ -136,6 +144,16 @@ Disable all colored output
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Actions
.INDENT 0.0
@ -214,14 +232,12 @@ Print all keys\(aq fingerprints.
.B \-\-gen\-keys=GEN_KEYS
Set a name to generate a keypair for use with salt
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen\-keys\-dir=GEN_KEYS_DIR
Set the directory to save the generated keypair. Only works
with \(aqgen_keys_dir\(aq option; default is the current directory.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-keysize=KEYSIZE
@ -230,78 +246,6 @@ the \(aq\-\-gen\-keys\(aq option, the key size must be 2048 or
higher, otherwise it will be rounded up to 2048. The
default is 2048.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-gen-signature
Generate the signature file named master_pubkey_signature for the
salt-masters public key. The signatur itself can be send to the
minions in auth-replies and enables the minions to verify
the salt-masters public-key cryptographically. This requires a new
signing-key-pair which can be auto-created with the --auto-create
parameter.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-signature-path
Target path for the signature file (must already exist)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auto-create
Auto-Create a signing key-pair if it does not yet exist
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pub=PUB
The path to the public-key file to generate a signature for
.UNINDENT
.INDENT 0.0
.TP
.B \-\-priv=PRIV
The path to the private-key file to generate a signature with
.UNINDENT
Example which will auto-create a default master_sign.* key-pair and
a signature file named master_pubkey_signature for an already
existing master.pub key
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt-key --gen-signature --auto-create
.ft P
.fi
.UNINDENT
.UNINDENT
Example which will auto-create a new key-pair called signature.* and the
signature itself for an already existing master.pub
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt-key --gen-signature --auto-create --key-pair signature
.UNINDENT
.UNINDENT
.ft P
.fi
Example with specific pub- and private key-files which creates the signature for
the given public key
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt-key --gen-signature --pub /etc/salt/pki/master/master.pub --priv /root/signature.pem
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(7)\fP
@ -310,6 +254,6 @@ salt-key --gen-signature --pub /etc/salt/pki/master/master.pub --priv /root/sign
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MASTER" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-MASTER" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.
@ -33,8 +33,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.sp
The Salt master daemon, used to control the Salt minions
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-master [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The master daemon controls the Salt minions
@ -106,6 +114,6 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MINION" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-MINION" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.
@ -33,8 +33,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.sp
The Salt minion daemon, receives commands from a remote Salt master.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-minion [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The Salt minion receives commands from the central Salt master and replies with
@ -107,6 +115,6 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-RUN" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-RUN" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
@ -114,6 +114,6 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SSH" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-SSH" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-ssh \- salt-ssh Documentation
.
@ -33,9 +33,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
salt\-ssh \(aq*\(aq [ options ] sys.doc
.sp
.nf
.ft C
salt\-ssh \(aq*\(aq [ options ] sys.doc
salt\-ssh \-E \(aq.*\(aq [ options ] sys.doc cmd
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@ -49,9 +54,24 @@ Execute a raw shell command.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-roster\-file
.B \-\-priv
Specify the SSH private key file to be used for authentication.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-roster
Define which roster system to use, this defines if a database backend,
scanner, or custom roster system is used. Default is the flat file roster.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-roster\-file
Define an alternative location for the default roster file location. The
default roster file is called \fBroster\fP and is found in the same directory
as the master config file.
.sp
New in version 2014.1.0.
.UNINDENT
.INDENT 0.0
.TP
@ -70,8 +90,14 @@ is 25.
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-ignore\-host\-keys
Ignore the ssh host keys which by default are honored and connections
would ask for approval.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-passwd
Set te default password to attempt to use when authenticating.
Set the default password to attempt to use when authenticating.
.UNINDENT
.INDENT 0.0
.TP
@ -222,6 +248,16 @@ Disable all colored output
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
@ -231,6 +267,6 @@ Force colored output
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SYNDIC" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT-SYNDIC" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.
@ -34,8 +34,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
The Salt syndic daemon, a special minion that passes through commands from a
higher master
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
salt\-syndic [ options ]
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The Salt syndic daemon, a special minion that passes through commands from a
@ -108,6 +116,6 @@ Logfile logging log level. One of \fBall\fP, \fBgarbage\fP, \fBtrace\fP,
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-UNITY" "1" "September 13, 2014" "2014.7.0rc1-587-g80369db" "Salt"
.TH "SALT-UNITY" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt-unity \- salt-unity Command
.

View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT" "1" "January 02, 2014" "2014.1.0" "Salt"
.TH "SALT" "1" "March 10, 2015" "2014.7.2-280-g6ac6a53" "Salt"
.SH NAME
salt \- salt
.
@ -115,6 +115,12 @@ print out extra data like the job id.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-show\-timeout
Instead of only showing the return data from the online minions this option
also prints the names of the minions which could not be reached.
.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
@ -233,11 +239,6 @@ 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 \-I, \-\-pillar
Instead of using shell globs to evaluate the target, use a pillar value to
identify targets. The syntax for the target is the pillar key followed by
@ -299,6 +300,16 @@ Disable all colored output
.TP
.B \-\-force\-color
Force colored output
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using colored output the color codes are as follows:
.sp
\fBgreen\fP denotes success, \fBred\fP denotes failure, \fBblue\fP denotes
changes and success and \fByellow\fP denotes a expected future change in configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
@ -308,6 +319,6 @@ Force colored output
.SH AUTHOR
Thomas S. Hatch <thatch45@gmail.com> and many others, please see the Authors file
.SH COPYRIGHT
2013 SaltStack, Inc.
2014 SaltStack, Inc.
.\" Generated by docutils manpage writer.
.

File diff suppressed because it is too large Load diff