prsync(1)

1prsync(1)                   General Commands Manual                  prsync(1)
2
3
4

NAME

6       prsync — parallel file sync program
7
8
9

SYNOPSIS

11       prsync  [-vAraz]  [-h hosts_file] [-H [user@]host[:port]] [-l user] [-p
12       par] [-o outdir] [-e errdir] [-t timeout] [-O options]  [-x  args]  [-X
13       arg] [-S args] local ...  remote
14
15
16

DESCRIPTION

18       prsync  is a program for copying files in parallel to a number of hosts
19       using the popular rsync program.  It provides features such as  passing
20       a password to ssh, saving output to files, and timing out.
21
22
23

OPTIONS

25       -h host_file
26       --hosts host_file
27              Read hosts from the given host_file.  Lines in the host file are
28              of the form [user@]host[:port] and can include blank  lines  and
29              comments (lines beginning with "#").  If multiple host files are
30              given (the -h option is used more than once),  then  prsync  be‐
31              haves  as  though  these files were concatenated together.  If a
32              host is specified multiple times, then prsync will  connect  the
33              given number of times.
34
35       -H     [user@]host[:port]
36       --host [user@]host[:port]
37       -H     "[user@]host[:port] [ [user@]host[:port ] ... ]"
38       --host "[user@]host[:port] [ [user@]host[:port ] ... ]"
39              Add  the  given  host strings to the list of hosts.  This option
40              may be given multiple times, and may be used in conjunction with
41              the -h option.
42
43       -l user
44       --user user
45              Use  the given username as the default for any host entries that
46              don't specifically specify a user.
47
48       -p parallelism
49       --par parallelism
50              Use the given number as the maximum number of concurrent connec‐
51              tions.
52
53       -t timeout
54       --timeout timeout
55              Make  connections  time  out  after the given number of seconds.
56              With a value of 0, prsync will not timeout any connections.
57
58       -o outdir
59       --outdir outdir
60              Save standard output to files in the given directory.  Filenames
61              are of the form [user@]host[:port][.num] where the user and port
62              are only included for hosts that explicitly specify  them.   The
63              number is a counter that is incremented each time for hosts that
64              are specified more than once.
65
66       -e errdir
67       --errdir errdir
68              Save standard error to files in the given directory.   Filenames
69              are of the same form as with the -o option.
70
71       -x args
72       --extra-args args
73              Passes  extra rsync command-line arguments (see the rsync(1) man
74              page for more information about rsync arguments).   This  option
75              may be specified multiple times.  The arguments are processed to
76              split on whitespace, protect text within quotes, and escape with
77              backslashes.  To pass arguments without such processing, use the
78              -X option instead.
79
80       -X arg
81       --extra-arg arg
82              Passes a single rsync command-line argument  (see  the  rsync(1)
83              man  page  for  more information about rsync arguments).  Unlike
84              the -x option, no processing is performed on the  argument,  in‐
85              cluding  word  splitting.   To  pass multiple command-line argu‐
86              ments, use the option once for each argument.
87
88       -O options
89       --options options
90              SSH options in the format used in  the  SSH  configuration  file
91              (see the ssh_config(5) man page for more information).  This op‐
92              tion may be specified multiple times.
93
94       -A
95       --askpass
96              Prompt for a password and pass it to ssh.  The password  may  be
97              used  for either to unlock a key or for password authentication.
98              The password is transferred in a fairly secure manner (e.g.,  it
99              will  not  show up in argument lists).  However, be aware that a
100              root user on your system could potentially intercept  the  pass‐
101              word.
102
103       -v
104       --verbose
105              Include error messages from rsync with the -i and -e options.
106
107       -r
108       --recursive
109              Recursively copy directories.
110
111       -a
112       --archive
113              Use rsync archive mode (rsync's -a option).
114
115       -z
116       --compress
117              Use rsync compression.
118
119       -S args
120       --ssh-args args
121              Passes extra SSH command-line arguments (see the ssh(1) man page
122              for more information about SSH arguments).  The given  value  is
123              appended to the ssh command (rsync's -e option) without any pro‐
124              cessing.
125
126
127
128
129

TIPS

131       The ssh_config file can include an arbitrary number of  Host  sections.
132       Each  host  entry  specifies  ssh options which apply only to the given
133       host.  Host definitions can even behave like aliases  if  the  HostName
134       option  is  included.   This ssh feature, in combination with pssh host
135       files, provides a tremendous amount of flexibility.
136
137

EXIT STATUS

139       The exit status codes from prsync are as follows:
140
141       0      Success
142
143       1      Miscellaneous error
144
145       2      Syntax or usage error
146
147       3      At least one process was killed by a signal or timed out.
148
149       4      All processes completed, but at least one rsync process reported
150              an error (exit status other than 0).
151
152

AUTHORS

154       Written  by  Brent  N. Chun <bnc@theether.org> and Andrew McNabb <amcn‐
155       abb@mcnabbs.org>.
156
157       https://github.com/lilydjwg/pssh
158
159