adding man page, sample conf, makefile

[sitarba.git] / shbackup.1

diff --git a/shbackup.1 b/shbackup.1
new file mode 100644 (file)
index 0000000..4788fe3
--- /dev/null
+++ b/shbackup.1
@@ -0,0 +1,60 @@
+'\" -*- coding: us-ascii -*-
+.if \n(.g .ds T< \\FC
+.if \n(.g .ds T> \\F[\n[.fam]]
+.de URL
+\\$2 \(la\\$1\(ra\\$3
+..
+.if \n(.g .mso www.tmac
+.TH shbackup 1 2012-05-13 "" ""
+.SH NAME
+shbackup \- a simple backup solution
+.SH SYNOPSIS
+'nh
+.fi
+.ad l
+\fBshbackup\fR \kx
+.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
+'in \n(.iu+\nxu
+[options] {\fIcommand\fR}
+'in \n(.iu-\nxu
+.ad b
+'hy
+.SH DESCRIPTION
+\fBshbackup\fR is a simple backup solution
+which packs user-defined file sets with tar. Each
+backup belongs to an epoch, which can be year, month,
+week, day, hour or sporadic. The backup can be made
+either full, differential or incremental.
+\fBshbackup\fR takes care for pruning old
+backups. The user defines for each epoch the number of
+backups to keep, except for 'sporadic'. Sporadic
+backups need to be removed manually.
+.SH COMMANDS
+.TP 
+\*(T<\fBbackup\fR\*(T>
+Make a backup
+.TP 
+\*(T<\fBlist\fR\*(T>
+List all backups
+.TP 
+\*(T<\fBprune\fR\*(T>
+Prune outdated/stale backups
+.SH OPTIONS
+.TP 
+\*(T<\fB\-h, \-\-help\fR\*(T>
+Print out a help summary.
+.TP 
+\*(T<\fB\-c, \-\-conf FILE\fR\*(T>
+Use given configuration file instead of
+/etc/shbackup.conf.
+.TP 
+\*(T<\fB\-e, \-\-epoch EPOCH\fR\*(T>
+Do not determine epoch automatically, but
+use EPOCH, which can be year, month,
+week, day, hour, sporadic.
+.TP 
+\*(T<\fB\-m, \-\-mode MODE\fR\*(T>
+Instead of configured mode use MODE,
+which can be full, diff or incr.
+.SH AUTHOR
+Stefan HUBER