Skip to content

Commit

Permalink
#48: Update man
Browse files Browse the repository at this point in the history
  • Loading branch information
oinume committed Apr 16, 2014
1 parent 683dcc6 commit 24c19ac
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 23 deletions.
17 changes: 7 additions & 10 deletions man/man1/tomahawk-rsync.1
@@ -1,4 +1,6 @@
.TH "TOMAHAWK-RSYNC" "1" "April 21, 2013" "0.6.0" "tomahawk"
.\" Man page generated from reStructuredText.
.
.TH "TOMAHAWK-RSYNC" "1" "April 17, 2014" "0.7.0" "tomahawk"
.SH NAME
tomahawk-rsync \- enables to copy files to many hosts
.
Expand Down Expand Up @@ -28,8 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
\fBtomahawk\-rsync\fP [\fIoptions\fP] source destination
Expand Down Expand Up @@ -80,7 +80,7 @@ tomahawk\-rsync copies files via \(aqrsync\(aq. You can specify options for rsyn
These programs follow the usual GNU command line syntax, with long options starting with two dashes (\(aq\-\-\(aq).
A summary of options is included below.
For a complete description, see the Info files.
.SS \-h, \-\-hosts
.SS \-H, \-\-hosts
.sp
Specifies host names for sending commands. You can specify multiple hosts with \(aq,\(aq.
.SS \-f, \-\-hosts\-files
Expand All @@ -106,9 +106,6 @@ web04
A line of starting with \(aq#\(aq disables a host.
.SS \-l, \-\-prompt\-login\-password
.sp
DUPLICATED. Use \-P/\-\-prompt\-password. Will be deleted in v0.6.0
.SS \-P, \-\-prompt\-login\-password
.sp
Prompts a password for ssh authentication of rsync at first. If the password is all the same between target hosts, you\(aqll input a password just once.
.SS \-c, \-\-continue\-on\-error
.sp
Expand All @@ -124,7 +121,7 @@ Specifies timeout seconds for a command.
.SS \-F, \-\-output\-format
.sp
Specifies command output format.
The default is \fI\%'${user}@${host\fP} % ${command}n${output}n\(aq
The default is \fI\%\(aq${user}@${host\fP} % ${command}n${output}n\(aq
.SS \-u, \-\-rsync\-user
.sp
Specifies rsync user. The default is a current logged in user.
Expand All @@ -137,7 +134,7 @@ Selection of \(aqpush\(aq or \(aqpull\(aq.
\(aqpull\(aq means copy files from remote to local. The default is \(aqpush\(aq.
.SS \-C, \-\-conf
.sp
Specifies configuration file path.
Specifies configuration file path. For additional information, see \fIomit\-command\-line\-options\fP
.SH ENVIRONMENT VARIABLES
.sp
tomahawk\(aqs behavior is affected by the following environment variables.
Expand All @@ -156,6 +153,6 @@ This variable specifies an environment of \(aqproduction\(aq, \(aqtesting\(aq or
.SH AUTHOR
Kazuhiro Oinuma, Kohei Maeda
.SH COPYRIGHT
2011-2013, Kazuhiro Oinuma
2011-2014, Kazuhiro Oinuma
.\" Generated by docutils manpage writer.
.
21 changes: 8 additions & 13 deletions man/man1/tomahawk.1
@@ -1,4 +1,6 @@
.TH "TOMAHAWK" "1" "April 21, 2013" "0.6.0" "tomahawk"
.\" Man page generated from reStructuredText.
.
.TH "TOMAHAWK" "1" "April 17, 2014" "0.7.0" "tomahawk"
.SH NAME
tomahawk \- enables to execute a command to many hosts
.
Expand Down Expand Up @@ -28,8 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.sp
\fBtomahawk\fP [\fIoptions\fP] command
Expand Down Expand Up @@ -105,7 +105,7 @@ $ tomahawk \-h host1,host2 \(aqps auxww | grep python\(aq
These programs follow the usual GNU command line syntax, with long options starting with two dashes (\(aq\-\-\(aq).
A summary of options is included below.
For a complete description, see the Info files.
.SS \-h, \-\-hosts
.SS \-H, \-\-hosts
.sp
Specifies host names for sending commands. You can specify multiple hosts with \(aq,\(aq.
.SS \-f, \-\-hosts\-files
Expand All @@ -131,9 +131,6 @@ web04
A line of starting with \(aq#\(aq disables a host.
.SS \-l, \-\-prompt\-login\-password
.sp
DUPLICATED. Use \-P/\-\-prompt\-password. Will be deleted in v0.6.0
.SS \-P, \-\-prompt\-login\-password
.sp
Prompts a password for ssh authentication at first. If the password is all the same between target hosts, you\(aqll input a password just once.
.SS \-\-login\-password\-stdin
.sp
Expand All @@ -152,9 +149,6 @@ If your machine has multiple cpu cores, \-\-parallel 2 .. N might be faster.
.SS \-t, \-\-timeout
.sp
Specifies timeout seconds for a command.
.SS \-\-expect\-timeout
.sp
DUPLICATED. Use t (\-timeout) instead. Will be deleted in v0.6.0.
.SS \-u, \-\-ssh\-user
.sp
Specifies ssh user. The default is a current logged in user.
Expand All @@ -164,13 +158,14 @@ Specifies ssh options.
.SS \-F, \-\-output\-format
.sp
Specifies command output format.
The default is \fI\%'${user}@${host\fP} % ${command}n${output}n\(aq
The default is \fB\(aq${user}@${host} % ${command}\en${output}\en\(aq\fP
.SS \-V, \-\-verify\-output
.sp
Verify command output of all hosts.
For additional information, see \fIchecking\-files\-on\-remote\-hosts\fP
.SS \-C, \-\-conf
.sp
Specifies configuration file path.
Specifies configuration file path. For additional information, see \fIomit\-command\-line\-options\fP
.SH ENVIRONMENT VARIABLES
.sp
tomahawk\(aqs behavior is affected by the following environment variables.
Expand All @@ -187,6 +182,6 @@ This variable specifies an environment of \(aqproduction\(aq, \(aqtesting\(aq or
.SH AUTHOR
Kazuhiro Oinuma, Kohei Maeda
.SH COPYRIGHT
2011-2013, Kazuhiro Oinuma
2011-2014, Kazuhiro Oinuma
.\" Generated by docutils manpage writer.
.

0 comments on commit 24c19ac

Please sign in to comment.