.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "GTKRSYNC" "1" "19 February 2010" "John Goerzen" "gtkrsync Manual"

.SH NAME
gtkrsync \- GUI front-end for rsync
.SH SYNOPSIS

\fBgtkrsync\fR [ \fB\fIargs for rsync\fB\fR\fI ...\fR ]


\fBgtkrsyncp\fR

.SH "DESCRIPTION"
.PP
\fBgtkrsync\fR is a graphical interface for displaying the progress of
an \fBrsync\fR(1) session.  It displays a running status display from
parsing the output of rsync --progress -v
(with --no-inc-recursive with \fBrsync\fR v3.0 or
above).  This
status display includes a per-file and overall status bar, overall
estimated time to completion, and an expandable button that shows
all rsync status output.
.PP
Unlike other GUI rsync frontends such as grsync, \fBgtkrsync\fR does
not have any GUI tools for configuring or invoking rsync.  \fBgtkrsync\fR
is designed to be invoked from the command line or shell scripts,
which already specify all the needed rsync options.  It is thus ideal
for scripted \fBrsync\fR runs that need a GUI, or for command-line users
that would like a GUI to monitor their \fBrsync\fR progress.
.PP
\fBgtkrsync\fR is a drop-in replacement
for rsync.  It fires up the GUI and invokes \fBrsync\fR, passing all args to
it.  When invoked this way, \fBgtkrsync\fR is able to detect if \fBrsync\fR exits
in error and alerts the user.  \fBgtkrsync\fR can also monitor both stdout
and stderr from \fBrsync\fR, and displays both.  The cancel button in
\fBgtkrsync\fR also will kill off the \fBrsync\fR process.  You must make sure to
pass --progress -v on the \fBgtkrsync\fR command line in
order to get enough information out of \fBrsync\fR to build a proper GUI.
.PP
If ysing \fBrsync\fR version 3.0 or above, you must also add
--no-inc-recursive to your command line.
These newer versions of \fBrsync\fR use incremental tree scanning
by default.  As a result, they do not emit information up
front about the expected number of files to transfer, and thus
\fBgtkrsync\fR would lack enough information to display its
progress bars.
.PP
Besides \fBgtkrsync\fR, the other binary is \fBgtkrsyncp\fR\&.  This program accepts the output of
rsync --progress -v on standard input and displays it in a GUI.  It
cannot detect whether \fBrsync\fR exited in error and cannot kill \fBrsync\fR when
Cancel is pressed.  However, this program may be useful in some cases
when direct control of \fBrsync\fR is handled elsewhere.
.SH "OPTIONS"
.PP
All options passed to \fBgtkrsync\fR are sent directly to
\fBrsync\fR(1).  \fBgtkrsyncp\fR takes no options.
.SH "EXIT VALUES"
.PP
\fBgtkrsync\fR and \fBgtkrsyncp\fR both return 0 on success or 20 if the user
clicked Cancel or closed the window before the \fBrsync\fR was complete.
20 is also the code that \fBrsync\fR uses to indicate a transfer
interrupted by the user.
.PP
In all other cases, \fBgtkrsync\fR returns the result code that \fBrsync\fR
returned.  \fBgtkrsyncp\fR returns 0.
.SH "ENVIRONMENT VARIABLES"
.PP
\fBgtkrsync\fR will look for an RSYNC environment
variable.  If set, it is taken to be the name of the \fBrsync\fR binary.
If not given, rsync is used.  \fBgtkrsyncp\fR does not
use this variable.
.PP
This application uses no other environment variables directly, but other
programs or standard libraries may do so.  DISPLAY,
for instance, must be set for the X libraries to work.
.PP
Users using \fBrsync\fR over \fBssh\fR may find the
SSH_ASKPASS variable useful.  This is interpreted
directly by \fBssh\fR and can specify a GUI tool
to use to prompt the user for a password when needed.
.SH "COPYRIGHT"
.PP
\fBgtkrsync\fR, all associated scripts and programs, this manual,
and all build scripts are Copyright (C) 2007-2010 John Goerzen.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.SH "AUTHOR"
.PP
\fBgtkrsync\fR, its modules, documentation, executables, and all
included files, except where noted, was written by
John Goerzen <jgoerzen@complete.org> and
copyright is held as stated in the COPYRIGHT section.
.PP
\fBgtkrsync\fR may be downloaded from the Debian packaging system or at
 <URL:http://packages.debian.org/gtkrsync>\&.
.PP
\fBgtkrsync\fR may also be downloaded using git by running
\fBgit clone
git://git.complete.org/gtkrsync\fR\&.
.SH "SEE ALSO"
.PP
\fBrsync\fR(1),
\fBgtkrsync\fR(1),
\fBgtkrsyncp\fR(1),
\fBssh\fR(1).