faubackup/doc faubackup-find.8.in,NONE,1.1 faubackup-gather.8.in,NONE,1.1 faubackup.8.in,NONE,1.1 faubackup.conf.5.in,NONE,1.1 faubackup-find.8,1.1,NONE faubackup-gather.8,1.1,NONE faubackup.8,1.1,NONE faubackup.conf.5,1.1,NONE

Update of /cvsroot/faubackup/faubackup/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv366/doc

Added Files:
	faubackup-find.8.in faubackup-gather.8.in faubackup.8.in 
	faubackup.conf.5.in 
Removed Files:
	faubackup-find.8 faubackup-gather.8 faubackup.8 
	faubackup.conf.5 
Log Message:
use @sysconfdir@ to locate faubackup.conf in scripts and documentation
use @PACKAGE_*@ to name the package


--- NEW FILE: faubackup-find.8.in ---
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH FAUBACKUP 8 "March 10, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
faubackup \- Backup System using a Filesystem for Storage


.SH SYNOPSIS
\fBfaubackup-find\fP [\fB--noregexp\fP] [\fIregexp\fP]...


.SH DESCRIPTION
\fBfaubackup-find\fP searches for files in the current directory,
and prints their name to standard-output.
That output is intended to be piped through \fBfaubackup-gather\fP,
in order to build a backup.

\fBfaubackup-find\fP is a lot like 'find . -depth -print0', with one
additional feature: you can specify a filter list of files to ignore.
When a directory matches one of these filters, the whole directory
gets ignored (like in find without -depth).

As the output is relative to the current directory, so are the
filters. You can't use absolute paths here.

You can specify these filters using one of these two formats:
shell-like and perl-regexp. Shell-like filters have '*' and '?'
Wildcards. In addition to most shells, faubackup-find  filters
understand a special '**' Wildcard, matching everything,
even subdirectories. For example, '**/,*' matches all files beginning
with a comma, in all subdirectories, while '*~' only matches
files in the current directory that end with a tilde.
The second form, Perl regexps can be used by prepending them
with 'REGEXP:'.
As Perl regular expressions may be used for malicous things,
it is possible to disable all Perl regexps via the command line
option \fB--noregexp\fP.

Both types of filters are matched against the relative
path of files (with an implicit ^ at the beginning and $ at the end).
Don't start your filter with '**/' if you want to match files
in the current directory (they don't have a / in them).


Filter expressions are read from the command line and from
\fB.faubackuprc\fP files in each subdirectory.
Those specified at the command line are matched against
every file, while those read from a directory only affect
that directory (and subdirectories eventually).


.SH FILES
.TP
.B .faubackuprc
Configuration for faubackup-find. Lines beginning with # are comments.
faubackup-find recognizes lines that start with 'Ignore', specifying
a filter for that directory.  All files matching that filter will be ignored.
Example: 'Ignore **.o' ignores all object files in all subdirectories.
.\" FIXME: better description

.SH BUGS
Please report all bugs to @PACKAGE_BUGREPORT@.

Man-pages may be confusing ;-).
Please send your ideas/comments to help improve @PACKAGE@.


.SH SEE ALSO
.BR faubackup (8),
.BR find (1),


.SH COPYRIGHT
FauBackup is Copyright (c) 2000-2003 Volkmar Sieh, Martin Waitz.
Developed at Friedrich Alexander University Erlangen-Nuremberg.

FauBackup comes with ABSOLUTELY NO WARRANTY.
This 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, or (at your option) any later
version.
Look at COPYING for details.


.SH AUTHOR
This manual page was written by Martin Waitz <[email protected]>.


.SH CONTACT
mailto:@PACKAGE_BUGREPORT@


--- NEW FILE: faubackup-gather.8.in ---
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH FAUBACKUP 8 "June 23, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
faubackup \- Backup System using a Filesystem for Storage
.SH SYNOPSIS
\fBfaubackup-gather\fP [\fB-v\fP]
.br
\fBfaubackup-scatter\fP [\fB-v\fP]
.br

.SH DESCRIPTION
\fBfaubackup-gather\fP, \fBfaubackup-scatter\fP uses a filesystem on a
hard drive for incremental and full backups.
This enables the backup to be accessable through standard filesystem
tools.

Later Backups to the same filesystem will automatically be
incremental, as unchanged files are only hard-linked with
the existing version of the file.

\fBfaubackup-gather\fP reads a NUL-delimited list of filenames from stdin
and serializes the contents of these files to stdout in a special format,
containing all inode informations.
All Error messages or other output are written to stderr.
To backup the current directory you can use 'faubackup-find | faubackup-gather'.
To be able to correctly read all files, \fBfaubackup-gather\fP
should be run as the superuser.

\fBfaubackup-scatter\fP will read contents of directories from stdin,
and recreate all files.
stdin must be in the format used by \fBfaubackup-gather\fP.
It first creates a directory for current date and time inside
the current directory (e.g. './2001-02-07@03:20:10').
Everything written will go into this directory or subdirectories.

Everything read by \fBfaubackup-gather\fP will be recreated with
exactly the same names, contents, permissions and times
(with one exeption: inode change time will be the time of the backup).
Thus, these two programs are capable of backing up directories
just like \fBcpio\fP and \fBtar\fP.
\fBfaubackup-scatter\fP can deal with holes in files.
To be able to correctly set all permissions, \fBfaubackup-scatter\fP
should be run as the superuser.

\fBfaubackup-scatter\fP will detect if there are other backups to the
same destination directory (with only differing timestamps).
In this case, files that haven't changed since the last backups will
not be written to the filesystem, but instead hard-linked against
the previous version.
Thus, diskspace is only needed for the directory inodes and for
changed files.

To be able to hard-link files, \fBfaubackup-scatter\fP will create
an additional directory, \fB..inodes\fP, which contains all files,
named after their inode (this is: device/inode of the source).
These entries are hardlinked to the actual location where they are
stored in the backup.

To be able to detect a broken transmission, a special entry (".")
is used as an end-of-backup marker.
If the connection between the gather and scatter programs suddenly
breaks (e.g. because of network outage), faubackup-scatter will
detect the missing end-of-backup marker and will mark the backup
as broken.
To make that system work, the filelist feed into faubackup-gather
has to end with a single dot.
But that is a good idea anyway,
as it ensures that access rights for the root directory of the backup
are set correctly.
"\fBfaubackup-find\fP already generates this marker automatically.

If you want to remove an old backup, simply delete the directory
created by \fBfaubackup-scatter\fP (the one named after the backup-time).
When the same version of a file is needed by an other backup, it
will still remain on the disk.

.SH OPTIONS
.TP
.B \-v
Show verbose output.
This includes all filenames being read/written.

.SH FORMAT
The format used by these tools includes the filenames, device numbers,
inode-numbers, inode-contents and file contents of all inodes
in a binary format.

The exact format is subject to change.
Look at the source for details.

.SH BUGS
Please report all bugs to @PACKAGE_BUGREPORT@.

.SH SEE ALSO
.BR faubackup (8),
.BR faubackup-find (8),
.BR cpio (1),
.BR tar (1),
.BR find (1),
.BR ls (1),
.BR grep (1).

.SH COPYRIGHT
FauBackup is Copyright (c) 2000-2003 Martin Waitz, Dr. Volkmar Sieh.
Developed at Friedrich Alexander University Erlangen-Nuremberg.

FauBackup comes with ABSOLUTELY NO WARRANTY.
This 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, or (at your option) any later
version.
Look at COPYING for details.


.SH AUTHOR
This manual page was written by Martin Waitz <[email protected]>.


.SH CONTACT
mailto:@PACKAGE_BUGREPORT@


--- NEW FILE: faubackup.8.in ---
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH FAUBACKUP 8 "June 24, 2003"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
faubackup \- Backup System using a Filesystem for Storage


.SH SYNOPSIS
\fBfaubackup\fP [\fIoptions\fP] \fIsrcdir\fP [\fIdestdir\fP]

\fBfaubackup\fP \fB--clean\fP[\fB=\fP\fIdestdir\fP]

\fBfaubackup\fP [\fB--list\fP[\fB=\fP\fIdestdir\fP]]


.SH DESCRIPTION
\fBfaubackup\fP uses a filesystem on a hard drive for incremental
and full backups.
This enables the backup to be accessable through standard filesystem
tools.

Later Backups to the same filesystem will automatically be
incremental, as unchanged files are only hard-linked with
the existing version of the file.

Executing 'faubackup srcdir destdir' is a bit like 'cp -a srcdir destdir/`date`'.
That is, it will copy everything from \fIsrcdir\fP to a subdirectory
of \fIdestdir\fP.  This directory is named after the time of the backup
(format 'YYYY-MM-DD@hh:mm:ss').
All filenames, permissions, contents will be preserved.
It can cope with soft-, hardlinks and with holes in files.

The big advantage over a simple copy is the use of hard-links between
unchanged files to minimize disk space usage.
You can execute faubackup on a regular basis, and any files which
haven't changed between these calls are not copied again, but are
hardlinked between the various backup-directories.
This is similar to incremental backups, where only changed files
are written to the tape.

If \fIsrcdir\fP or \fIdestdir\fI contains a colon (\fB:\fP),
it is considered a remote backup.
The part preceeding the colon will be the machine to backup from,
the part following the colon will be the directory to backup.
\fBfaubackup\fP must be able to get a root shell account on the remote machine,
in order to backup its files.
On the remote machines, PATH should include the directory containing
the faubackup sub-programs.
When using ssh, this can be achieved by setting it in /root/.ssh/environment.

If \fIdestdir\fP is omitted, a default will be chosen.
It contains the machine-name and \fIsrcdir\fP of the backup and may
be customized via
.BR faubackup.conf (5)
.

.SH MANAGING BACKUPS
FauBackup may be configured to keep certain backups for a long time and remove
others. Have a look at traditional backup systems. You have tapes for
daily, weekly, monthly and yearly backups, and store them according to your
local backup policy. FauBackup can do this for you on harddisks, too.
That is, it can keep some yearly, weekly, etc. backups for you and
automatically remove other obsoleted backups.

Four different backup-types are recognized: daily, weekly, monthly and yearly.
The first existing backup in such an interval will be considered belonging
to the coresponding type.
Thus, the first backup in a month (eg. 2000-12-01@06:30:00) will be a
monthly backup; the first backup in 2001 will be of all four types,
as January 1st, 2001 is a Monday.

The number of backups kept for each type is configureable (See
.BR faubackup.conf (5)
). If a backup doesn't belong to such a type (eg. second backup in a day),
or is too old for that type, it will be removed on \fBfaubackup --clean\fP.


.SH DISPLAYING INFO
FauBackup can print some informations about the backups kept on filesystem.
If used without verbose output, it just displays the first daily, weekly,
monthly and yearly backup made.

If used with verbose output, a list of all backups will be displayed.
For every backup, the number of files which was added or removed
by this backup will be shown, together with the overall size of these
files and the size of files exclusively used by this backup.
In addition, a backup will get marked, when it is the first of an
backup interval (daily, weekly, ...).


.SH OPTIONS
.TP
.B -h, --help
Show short help page and exit.
.TP
.B --version
Show version string and exit.
.TP
\fB-l, --list\fP [\fIdestdir\fP]
Show information about the backups already created.
If combined with verbose (see below), information about
the size of the backups is given, too.
See DISPLAYING INFO above.
If no \fIdestdir\fP is given, search for possible backups
in the standard location.
.TP
.B -v, --verbose
Show verbose output.
This includes all filenames being read/written.
.TP
\fB--find=\fP\fIcommand\fP
The command used to compute the file list to backup.
Default is "faubackup-find".
This command must list all files on stdout, separated by NUL characters.
The last entry sent MUST be the current directory, "."!
.TP
\fB--rsh=\fP\fIcommand\fP
The command used to get access to remote machines.
Default is to use the FAUBACKUP_RSH environtment variable if it exists,
"rsh" otherwise.
.TP
\fB-o\fP \fIsrcdir\fP, \fB-i\fP \fIdestdir\fP
The 'do only half the backup' options. Use them to pipe your backup to some
other location. ('faubackup -o srcdir | somepipe | faubackup -i destdir')
.TP
\fB--clean\fP [\fIdestdir\fP]
Remove old backups from \fIdestdir\fP.
If \fIdestdir\fP is omitted, search for possible destination directories in the
standard location.
.TP
\fB--years=\fP\fInumber\fP, \fB-y\fP \fInumber\fP, \
\fB--months=\fP\fInumber\fP, \fB-m\fP \fInumber\fP, \
\fB--weeks=\fP\fInumber\fP, \fB-w\fP \fInumber\fP, \
\fB--days=\fP\fInumber\fP, \fB-d\fP \fInumber\fP
Specify how long to keep backups on \fB--clean\fP. These options override
the settings in the configuration file.
.TP
\fB--keep-last\fP
As described above, the first backup in an interval will be kept for later use.
If you do an automated backup in the morning and want to do an additional
backup after some important work, this is annoying.
When using this option, the last daily backup will be kept,
instead of the first. Other backups will be unaffected (weekly, etc).


.SH ENVIRONMENT
.TP
.B FAUBACKUP_RSH
Default value for \fB--rsh\fP switch.


.SH FILES
.TP
.B @sysconfdir@/faubackup.conf
Configuration file. See faubackup.conf(5) for details.
.TP
\fIdestdir\fP/\fIdate\fP/
Your backup will be available here.
.TP
\fIdestdir\fP/\fIdate\fP/\fB..inodes\fP
This directory contains all inodes included in this backup.
They are hashed across several (sub-)directories inside \fB..inodes\fP.
This directory is neede to be able to hardlink with existing
backups of the same \fIsrcdir\fP.


.SH NOTES
You should not rely on your harddisk as the sole backup medium ;-).
The Author recommends to regularly tar (a selection of) the disk backup
to a tape, which should be stored in a different room.

Additionaly, you should be careful when creating your backup filesystem.
As directories cannot be shared across several backups, they consume
an considerable amount of inodes.
On filesystems with a limited number of inodes (like ext2),
one may need to increase the inode limit on filesystem creation.

.SH BUGS
Please report all bugs to @PACKAGE_BUGREPORT@.

Man-pages may be confusing ;-).
Please send your ideas/comments to help improve FauBackup.


.SH SEE ALSO
.BR faubackup.conf (5),
.BR faubackup-gather (8),
.BR faubackup-scatter (8),
.BR faubackup-find (8),


.SH COPYRIGHT
FauBackup is Copyright (c) 2000-2003 Volkmar Sieh, Martin Waitz.
Developed at Friedrich Alexander University Erlangen-Nuremberg.

FauBackup comes with ABSOLUTELY NO WARRANTY.
This 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, or (at your option) any later
version.
Look at COPYING for details.


.SH AUTHOR
This manual page was written by Martin Waitz <[email protected]>.


.SH CONTACT
mailto:[email protected]


--- NEW FILE: faubackup.conf.5.in ---
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH FAUBACKUP.CONF 5 "February  9, 2001"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
faubackup.conf - Configuration for faubackup(8)


.SH SYNOPSIS
\fB@sysconfdir@/faubackup.conf\fP


.SH DESCRIPTION
Configuration is read from \fB@sysconfdir@/faubackup.conf\fP.
Blank lines and lines starting with `#' are ignored.
Perl-Syntax is used to change things: `$key = value;'.
The file must start with \fBpackage FAUBACKUP;\fP and end
with \fB1;\fP.
.pp

These settings are supported:

.TP
.B $backup = \fIstring\fP;
The default destination for backups. This is used when no destination
directory is specified on the command line.
It may contain the special strings \fBMACHINE\fP and/or \fBDIR\fP,
which are replaced by the hostname or directory-name of the backup source.
Slashes in the source directory name will be converted to dashes.
Default is "/backup/MACHINE:DIR".
.TP
.B $autocreate = \fInumber\fP;
If non-zero, \fBfaubackup\fP will create the destination
directory, if it doesn't already exist.
Default is enabled (1).
.TP
.B $keepyears = \fInumber\fP;
Yearly backups are kept for at least \fInumber\fP years when cleaning.
Default is to keep two yearly backups.
.TP
.B $keepmonths = \fInumber\fP;
Monthly backups are kept for at least \fInumber\fP months when cleaning.
Default is to keep twelve monthly backups.
.TP
.B $keepweeks = \fInumber\fP;
Weekly backups are kept for at least \fInumber\fP weeks when cleaning.
Default is to keep four weekly backups.
.TP
.B $keepdays = \fInumber\fP;
Daily backups are kept for at least \fInumber\fP days when cleaning.
Default is to keep seven daily backups.
.TP
.B $keeplastofday = \fIboolean\fP;
If this is nonzero, the last daily backup (instead of the first)
will be kept when cleaning.
Default is zero (keep the first even for daily backups).
.TP
.B $rsh = \fIstring\fP;
The command executed to start commands on remote machines.
This may be overwritten by the environment Variable
\fBFAUBACKUP_RSH\fP.
Default is to use "rsh".
.TP
.B $gather = \fIstring\fP;
The command used to gather the files.
Default is "faubackup-gather".
.TP
.B $scatter = \fIstring\fP;
The command used to scatter the files.
Default is "faubackup-scatter".
.TP
.B $find = \fIstring\fP;
The command used to find the files to backup.
Default is "faubackup-find".
.TP
.B $getroot = \fIstring\fP;
The command used to obtain root access. Can be set to "sudo" or similar.
There is no default.
.TP
.B @ignore = \fIlist of strings\fP;
Arguments passed to the $find Command.
For faubackup-find, this is a list of expressions not to be processed.
See faubackup-find(8) for details.


.SH SEE ALSO
.BR faubackup (8)


.SH COPYRIGHT
FauBackup is Copyright (c) 2000-2003 Volkmar Sieh, Martin Waitz.
Developed at Friedrich Alexander University Erlangen-Nuremberg.

FauBackup comes with ABSOLUTELY NO WARRANTY.
This 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, or (at your option) any later
version.
Look at COPYING for details.


.SH AUTHOR
This manual page was written by Martin Waitz <[email protected]>.

--- faubackup-find.8 DELETED ---

--- faubackup-gather.8 DELETED ---

--- faubackup.8 DELETED ---

--- faubackup.conf.5 DELETED ---




-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?  SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/