rdup-up.1.in

'\" t
.TH RDUP-UP 1 "13 Dec 2008" "@PACKAGE_VERSION@" "@PACKAGE_NAME@"
.SH NAME
@PACKAGE_NAME@-up \- update a directory tree with a rdup archive
.SH SYNOPSIS
.B @PACKAGE_NAME@-up
[\fIOPTION\fR]...
\fIDIRECTORY\fR

.SH DESCRIPTION
With \fBrdup-up\fR you can update an (possibly) existing directory
structure with a rdup archive.

The rdup archive has to be given to \fBrdup-up\fR's standard input.

.SS Username and uids
\fBrdup\fR outputs both the user name and uid, the receiving system (which
may be a totally different system) checks if the user name and uid
match. If the user name and uid don't match the (numeric) uid is
used on the file. The same holds true for the group name and gid.

.SS File ownership
As \fBrdup\fR supports backups via SSH the following situation can occur:
locally \fBrdup\fR is run a root, but \fBrdup-up\fR is run as a non-root
user (the one logged in via SSH). In this case the original owner- and
group name can not be set. If this happens \fBrdup-up\fR will create
a \fI._rdup_.\fR file which contains the user/group information, also
see the \fI\-u\fR flag for \fBrdup-tr\fR (and \fBrdup\fR).

.SH OPTIONS
.TP
.B \-n
Do a dry-run and do not create anything on disk.
.TP
.B \-t 
Create DIRECTORY (ala mkdir -p) if it does not exist.
.TP
.B \-s N
Strip N path components from a pathname. If the resulting pathname is
empty after this operation it is skipped. Be careful however with the following
structure:

    /foo
    /foo/bar
    /foo/bar/bla.txt
    /foo/blork/bla.txt


With \fBrdup-up -s\fI2\fR this will leave:


    <empty>
    <empty>
    /bla.txt
    /bla.txt


And the last 'bla.txt' will \fIover write\fR the previous one, this will
happen without warnings.
.TP
.B \-r PATH
This option is related to the \-s option, but works different. The
string PATH is removed from (the beginning of) each pathname. With \fI-r
/home/backup\fR the pathname \fI/home/backup/bin/mycmd\fR becomes
\fI/bin/mycmd\fR. The same could be done with \fB-s 2\fR, but then you need
to count the slashes. Note \-s is always performed before \-r.
.TP
.B \-v
Be more verbose and echo the processed files to \fIstandard output\fR.
.TP
.B \-T
Show a table of contents of the rdup stream received (ala tar \-tf \-).
With \-T the directory argument is optional. \-T unsets any verbose (\-v) options.
.TP
.B \-u
Do not create a \fI._rdup_.\fR file which contains user/group information when failing
to \fBchown\fR the actual file or directory. Useful when restoring a backup when you
do not want to see \fI._rdup._\fR-files being created.
.TP
.B \-q
Silence 'chown' failures even when running as root. This can be helpful when the 
file system does not implement 'chown' or disallows it ('sshfs' for instance).
.TP
.B \-h
A short help message.
.TP
.B \-V
Show the version.

.SH EXIT CODE
\fBrdup-up\fR return a zero exit code on success, otherwise 1 is returned.

.SH AUTHOR
Written by Miek Gieben. 

.SH REPORTING BUGS
Report bugs to <miek@miek.nl>. 

.SH SEE ALSO
http:/www.miek.nl/projects/rdup/ is the main site of rdup. Also see rdup(1),
rdup-tr(1) and rdup-backups(7).

.SH COPYRIGHT
Copyright (C) 2005-2010 Miek Gieben. This is free software. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.
.PP
Licensed under the GPL version 3. See the file LICENSE in the source distribution
of rdup.