saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #23413 from terminalmage/update-manpages

Browse source 
Update manpages for 2015.2 -> 2015.5
This commit is contained in:
Colton Myers 2015-05-06 11:12:57 -06:00
commit f2d7646a58
22 changed files with 729 additions and 409 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-API" "1" "April 21, 2015" "2015.5.0rc2-143-g32ef5ca" "Salt"
.TH "SALT-API" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-api \- salt-api Command
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CALL" "1" "April 14, 2015" "2014.7.4-180-gc0d1bdd" "Salt"
.TH "SALT-CALL" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-call \- salt-call Documentation
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CLOUD" "1" "April 21, 2015" "2015.5.0rc2-143-g32ef5ca" "Salt"
.TH "SALT-CLOUD" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-cloud \- Salt Cloud Command
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-CP" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-CP" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-cp \- salt-cp Documentation
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-KEY" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-KEY" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-key \- salt-key Documentation
.
@ -70,6 +70,17 @@ on most systems is \fB/etc/salt\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-u USER, \-\-user=USER
Specify user to run salt\-key
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hard\-crash
Raise any original exception rather than exiting gracefully. Default is
False.
.UNINDENT
.INDENT 0.0
.TP
.B \-q, \-\-quiet
Suppress output
.UNINDENT
@ -78,6 +89,13 @@ Suppress output
.B \-y, \-\-yes
Answer \(aqYes\(aq to all questions presented, defaults to False
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rotate\-aes\-key=ROTATE_AES_KEY
Setting this to False prevents the master from refreshing the key session
when keys are deleted or rejected, this lowers the security of the key
deletion/rejection operation. Default is True.
.UNINDENT
.SS Logging Options
.sp
Logging options which override any settings defined on the configuration files.
@ -246,6 +264,35 @@ 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
Create a signature file of the masters public\-key named
master_pubkey_signature. The signature can be send to a minion in the
masters auth\-reply and enables the minion to verify the 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 \-\-priv=PRIV
The private\-key file to create a signature with
.UNINDENT
.INDENT 0.0
.TP
.B \-\-signature\-path=SIGNATURE_PATH
The path where the signature file should be written
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pub=PUB
The public\-key file to create a signature for
.UNINDENT
.INDENT 0.0
.TP
.B \-\-auto\-create
Auto\-create a signing key\-pair if it does not yet exist
.UNINDENT
.SH SEE ALSO
.sp
\fIsalt(7)\fP

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MASTER" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-MASTER" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-master \- salt-master Documentation
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-MINION" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-MINION" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-minion \- salt-minion Documentation
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-RUN" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-RUN" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-run \- salt-run Documentation
.
@ -80,6 +80,12 @@ query the minions and check on running jobs. Default: 1
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hard\-crash
Raise any original exception rather than exiting gracefully. Default is
False.
.UNINDENT
.INDENT 0.0
.TP
.B \-d, \-\-doc, \-\-documentation
Display documentation for runners, pass a module or a runner to see
documentation on only that module/runner.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SSH" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-SSH" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-ssh \- salt-ssh Documentation
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-SYNDIC" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-SYNDIC" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-syndic \- salt-syndic Documentation
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT-UNITY" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT-UNITY" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt-unity \- salt-unity Command
.

8
doc/man/salt.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SALT" "1" "March 09, 2015" "2015.5.0rc1-133-g24fa806" "Salt"
.TH "SALT" "1" "May 06, 2015" "2015.5.0" "Salt"
.SH NAME
salt \- salt
.
@ -98,9 +98,9 @@ New in version 0.17.
.sp
Override the configured \fBstate_output\fP value for minion output. One of
\fBfull\fP, \fBterse\fP, \fBmixed\fP, \fBchanges\fP or \fBfilter\fP\&.
Default: \fBfull\fB\&.
\fBfull\fP, \fBterse\fP, \fBmixed\fP, \fBchanges\fP or \fBfilter\fP\&. Default:
\fBfull\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subset=SUBSET

1029
doc/man/salt.7
View file

File diff suppressed because it is too large Load diff

6
doc/ref/roster/all/salt.roster.clustershell.rst Normal file
View file

@ -0,0 +1,6 @@
========================
salt.roster.clustershell
========================
.. automodule:: salt.roster.clustershell
:members:

2
salt/modules/boto_dynamodb.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon DynamoDB
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
:configuration: This module accepts explicit DynamoDB credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.

6
salt/modules/file.py
View file

@ -4428,7 +4428,7 @@ def normpath(path):
'''
Returns Normalize path, eliminating double slashes, etc.
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
This can be useful at the CLI but is frequently useful when scripting.
@ -4449,7 +4449,7 @@ def basename(path):
'''
Returns the final component of a pathname
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
This can be useful at the CLI but is frequently useful when scripting.
@ -4470,7 +4470,7 @@ def dirname(path):
'''
Returns the directory component of a pathname
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
This can be useful at the CLI but is frequently useful when scripting.

2
salt/modules/http.py
View file

@ -3,7 +3,7 @@
Module for making various web calls. Primarily designed for webhooks and the
like, but also useful for basic http testing.
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
'''
from __future__ import absolute_import

2
salt/modules/splunk_search.py
View file

@ -2,7 +2,7 @@
'''
Module for interop with the Splunk API
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
:depends: - splunk-sdk python module
:configuration: Configure this module by specifying the name of a configuration

2
salt/runners/http.py
View file

@ -3,7 +3,7 @@
Module for making various web calls. Primarily designed for webhooks and the
like, but also useful for basic http testing.
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
'''
from __future__ import absolute_import
# Import Python libs

2
salt/states/boto_dynamodb.py
View file

@ -3,7 +3,7 @@
Manage DynamoDB Tables
=================
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
Create and destroy DynamoDB tables. Be aware that this interacts with Amazon's
services, and so may incur charges.

2
salt/states/pkg.py
View file

@ -1567,7 +1567,7 @@ def uptodate(name, refresh=False, **kwargs):
kwargs
Any keyword arguments to pass through to ``pkg.upgrade``.
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
'''
ret = {'name': name,
'changes': {},

2
salt/states/splunk_search.py
View file

@ -2,7 +2,7 @@
'''
Splunk Search State Module
.. versionadded:: 2015.2
.. versionadded:: 2015.5.0
This state is used to ensure presence of splunk searches.