Fix man page option description indentation.

This commit is contained in:
Tim Bielawa 2012-04-17 11:39:51 -04:00
parent e9e8417735
commit 621dc83ac2
4 changed files with 70 additions and 45 deletions

View file

@ -92,14 +92,16 @@ Ignore the inventory file and run the playbook against only these hosts\&. "host
\fIall\fR
when using this option\&.
.RE
.sp
.PP
\fB\-s\fR, \fB\-\-sudo\fR
.sp
.RS 4
Force all plays to use sudo, even if not marked as such\&.
.sp
.RE
.PP
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
.sp
.RS 4
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
.RE
.SH "ENVIRONMENT"
.sp
The following environment variables may specified\&.

View file

@ -75,12 +75,12 @@ Ignore the inventory file and run the playbook against only these hosts. "hosts
in playbook should be set to 'all' when using this option.
*-s*, *--sudo*
*-s*, *--sudo*::
Force all plays to use sudo, even if not marked as such.
*-u* 'USERNAME', *--remote-user=*'USERNAME'
*-u* 'USERNAME', *--remote-user=*'USERNAME'::
Use this remote user name on playbook steps that do not indicate a user name to run as.

View file

@ -78,50 +78,73 @@ The
\fIARGUMENTS\fR
to pass to the module\&.
.RE
.sp
.PP
\fB\-D\fR, \fB\-\-debug\fR
.sp
.RS 4
Print any messages the remote module sends to standard error to the console
.sp
.RE
.PP
\fB\-k\fR, \fB\-\-ask\-pass\fR
.sp
.RS 4
Prompt for the SSH password instead of assuming key\-based authentication with ssh\-agent\&.
.sp
.RE
.PP
\fB\-K\fR, \fB\-\-ask\-sudo\-pass\fR
.sp
.RS 4
Prompt for the password to use with \-\-sudo, if any
.sp
.RE
.PP
\fB\-o\fR, \fB\-\-one\-line\fR
.sp
.RS 4
Try to output everything on one line\&.
.sp
.RE
.PP
\fB\-s\fR, \fB\-\-sudo\fR
.sp
.RS 4
Run the command as the user given by \-u and sudo to root\&.
.sp
.RE
.PP
\fB\-t\fR \fIDIRECTORY\fR, \fB\-\-tree=\fR\fIDIRECTORY\fR
.sp
Save contents in this output \fIDIRECTORY\fR, with the results saved in a file named after each host\&.
.sp
.RS 4
Save contents in this output
\fIDIRECTORY\fR, with the results saved in a file named after each host\&.
.RE
.PP
\fB\-T\fR \fISECONDS\fR, \fB\-\-timeout=\fR\fISECONDS\fR
.sp
Connection timeout to use when trying to talk to hosts, in \fISECONDS\fR\&.
.sp
.RS 4
Connection timeout to use when trying to talk to hosts, in
\fISECONDS\fR\&.
.RE
.PP
\fB\-B\fR \fINUM\fR, \fB\-\-background=\fR\fINUM\fR
.sp
Run commands in the background, killing the task after \fINUM\fR seconds\&.
.sp
.RS 4
Run commands in the background, killing the task after
\fINUM\fR
seconds\&.
.RE
.PP
\fB\-P\fR \fINUM\fR, \fB\-\-poll=\fR\fINUM\fR
.sp
Poll a background job every \fINUM\fR seconds\&. Requires \fB\-B\fR\&.
.sp
.RS 4
Poll a background job every
\fINUM\fR
seconds\&. Requires
\fB\-B\fR\&.
.RE
.PP
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
.sp
Use this remote \fIUSERNAME\fR instead of root\&.
.sp
.RS 4
Use this remote
\fIUSERNAME\fR
instead of root\&.
.RE
.PP
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
.sp
Connection type to use\&. Possible options are \fIparamiko\fR (SSH) and \fIlocal\fR\&. Local is mostly useful for crontab or kickstarts\&.
.RS 4
Connection type to use\&. Possible options are
\fIparamiko\fR
(SSH) and
\fIlocal\fR\&. Local is mostly useful for crontab or kickstarts\&.
.RE
.SH "INVENTORY"
.sp
Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is one host per line\&. Groups headers are allowed and are included on their own line, enclosed in square brackets\&.

View file

@ -60,48 +60,48 @@ The 'DIRECTORY' to load modules from. The default is '/usr/share/ansible'.
The 'ARGUMENTS' to pass to the module.
*-D*, *--debug*
*-D*, *--debug*::
Print any messages the remote module sends to standard error to the console
*-k*, *--ask-pass*
*-k*, *--ask-pass*::
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent.
*-K*, *--ask-sudo-pass*
*-K*, *--ask-sudo-pass*::
Prompt for the password to use with --sudo, if any
*-o*, *--one-line*
*-o*, *--one-line*::
Try to output everything on one line.
*-s*, *--sudo*
*-s*, *--sudo*::
Run the command as the user given by -u and sudo to root.
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'
*-t* 'DIRECTORY', *--tree=*'DIRECTORY'::
Save contents in this output 'DIRECTORY', with the results saved in a
file named after each host.
*-T* 'SECONDS', *--timeout=*'SECONDS'
*-T* 'SECONDS', *--timeout=*'SECONDS'::
Connection timeout to use when trying to talk to hosts, in 'SECONDS'.
*-B* 'NUM', *--background=*'NUM'
*-B* 'NUM', *--background=*'NUM'::
Run commands in the background, killing the task after 'NUM' seconds.
*-P* 'NUM', *--poll=*'NUM'
*-P* 'NUM', *--poll=*'NUM'::
Poll a background job every 'NUM' seconds. Requires *-B*.
*-u* 'USERNAME', *--remote-user=*'USERNAME'
*-u* 'USERNAME', *--remote-user=*'USERNAME'::
Use this remote 'USERNAME' instead of root.
*-c* 'CONNECTION', *--connection=*'CONNECTION'
*-c* 'CONNECTION', *--connection=*'CONNECTION'::
Connection type to use. Possible options are 'paramiko' (SSH) and 'local'.
Local is mostly useful for crontab or kickstarts.