From 073e937c5d6c80a2bbf36f157b8c26701a198f55 Mon Sep 17 00:00:00 2001 From: Erich Eckner Date: Tue, 24 May 2016 09:02:36 +0200 Subject: manpage .1 -> .8 --- Makefile | 8 +++---- hardlinkedbackups.1.in | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ hardlinkedbackups.8.in | 57 -------------------------------------------------- 3 files changed, 61 insertions(+), 61 deletions(-) create mode 100644 hardlinkedbackups.1.in delete mode 100644 hardlinkedbackups.8.in diff --git a/Makefile b/Makefile index 35bd6c6..ffdd23f 100644 --- a/Makefile +++ b/Makefile @@ -26,7 +26,7 @@ MANDIR = /usr/share/man VERSION = 1.0.4 -all: hardlinkedbackups.8 backup lastBackups +all: hardlinkedbackups.1 backup lastBackups %: %.in sed "s/#VERSION#/$(VERSION)/; s@#BINDIR#@$(BINDIR)@; s@#ETCDIR#@$(ETCDIR)@" $< > $@ @@ -35,12 +35,12 @@ all: hardlinkedbackups.8 backup lastBackups install: all install -D -m0755 -t $(DESTDIR)$(BINDIR) backup lastBackups - install -D -m0644 -t $(DESTDIR)$(MANDIR)/man8 hardlinkedbackups.8 - ln -s $(DESTDIR)$(MANDIR)/man8/{hardlinkedbackups,backups,lastBackups}.8 + install -D -m0644 -t $(DESTDIR)$(MANDIR)/man1 hardlinkedbackups.1 + ln -s $(DESTDIR)$(MANDIR)/man1/{hardlinkedbackups,backups,lastBackups}.1 install -D -m0644 -t $(DESTDIR)$(ETCDIR) backup.conf clean: - rm -f backup lastBackups hardlinkedbackups.8 + rm -f backup lastBackups hardlinkedbackups.1 dist: clean git status --porcelain 2> /dev/null | grep -q "\S" && (git add .; git commit -m"neue Version: $(VERSION)") || true diff --git a/hardlinkedbackups.1.in b/hardlinkedbackups.1.in new file mode 100644 index 0000000..480aa18 --- /dev/null +++ b/hardlinkedbackups.1.in @@ -0,0 +1,57 @@ +.TH hardlinkedbackups 8 "" "hardlinkedbackups #VERSION#" "" +.SH NAME +hardlinkedbackups \- hardlinked incremental backups via rsync (and possibly through a SOCKS\-tunnel via ssh) +.SH SYNOPSIS +.TP +\fBbackup /tmp/pidFile /path/to/destination/ user@source:path [proxy_user@ssh_host]\fP +.TP +\fBlastBackups\fP +.SH DESCRIPTION +\fBbackup\fP generates incremental backups (by hardlinking old unchanged files) via rsync and possibly a SOCKS\-tunnel. +\fBlastBackups\fP shows date of backups and warns about outdated ones. +.SH USAGE +.TP +.B "backup /tmp/pidFile /path/to/destination/ user@source:path" +Creates incremental backup in \fB/path/to/destination/\fP from \fBuser@source:path\fP, saving its PID in \fB/tmp/pidFile\fP. +.TP +.B "backup /tmp/pidFile /path/to/destination/ user@source:path proxy_user@ssh_host" +Same as above, but tunneling via SSH through \fBproxy_user@ssh_host\fP. +.TP +.B "symLinkName -> #BINDIR#/backup" +Same as one of the above. +Command line parameters are filled from variable \fB$backups["symLinkName"]\fP in \fB#ETCDIR#/backup.conf\fP. +This is designed to be called from a cron daemon for daily backups. +.TP +.B "lastBackups" +reports about actuality of backups defined in \fB#ETCDIR#/backup.conf\fP +.SH CONFIGURATION +The configfile \fB#ETCDIR#/backup.conf\fP is a bash script, which defines the following variables: +.TP +.B "excludes" +array of paths to exclude from backup +.TP +.B "backups" +array with command line arguments for predefined backups +.TP +.B "maxWait" +maximum time to wait for destination directories to appear in lastBackups [seconds] +.TP +.B "outdatedLimit" +time before backups are considered outdated [seconds] +.TP +.B "recognSubdirRegex" +regular expression of subdirectories which should be appended to the parent directory in the report +.SH FILES +.TP +.B "#BINDIR#/backup" +program for creation of backups +.TP +.B "#BINDIR#/lastBackups" +program for check of backups +.TP +.B "#ETCDIR#/backup.conf" +configuration of backups +.SH AUTHOR +.nf +Erich Eckner +.fi diff --git a/hardlinkedbackups.8.in b/hardlinkedbackups.8.in deleted file mode 100644 index 480aa18..0000000 --- a/hardlinkedbackups.8.in +++ /dev/null @@ -1,57 +0,0 @@ -.TH hardlinkedbackups 8 "" "hardlinkedbackups #VERSION#" "" -.SH NAME -hardlinkedbackups \- hardlinked incremental backups via rsync (and possibly through a SOCKS\-tunnel via ssh) -.SH SYNOPSIS -.TP -\fBbackup /tmp/pidFile /path/to/destination/ user@source:path [proxy_user@ssh_host]\fP -.TP -\fBlastBackups\fP -.SH DESCRIPTION -\fBbackup\fP generates incremental backups (by hardlinking old unchanged files) via rsync and possibly a SOCKS\-tunnel. -\fBlastBackups\fP shows date of backups and warns about outdated ones. -.SH USAGE -.TP -.B "backup /tmp/pidFile /path/to/destination/ user@source:path" -Creates incremental backup in \fB/path/to/destination/\fP from \fBuser@source:path\fP, saving its PID in \fB/tmp/pidFile\fP. -.TP -.B "backup /tmp/pidFile /path/to/destination/ user@source:path proxy_user@ssh_host" -Same as above, but tunneling via SSH through \fBproxy_user@ssh_host\fP. -.TP -.B "symLinkName -> #BINDIR#/backup" -Same as one of the above. -Command line parameters are filled from variable \fB$backups["symLinkName"]\fP in \fB#ETCDIR#/backup.conf\fP. -This is designed to be called from a cron daemon for daily backups. -.TP -.B "lastBackups" -reports about actuality of backups defined in \fB#ETCDIR#/backup.conf\fP -.SH CONFIGURATION -The configfile \fB#ETCDIR#/backup.conf\fP is a bash script, which defines the following variables: -.TP -.B "excludes" -array of paths to exclude from backup -.TP -.B "backups" -array with command line arguments for predefined backups -.TP -.B "maxWait" -maximum time to wait for destination directories to appear in lastBackups [seconds] -.TP -.B "outdatedLimit" -time before backups are considered outdated [seconds] -.TP -.B "recognSubdirRegex" -regular expression of subdirectories which should be appended to the parent directory in the report -.SH FILES -.TP -.B "#BINDIR#/backup" -program for creation of backups -.TP -.B "#BINDIR#/lastBackups" -program for check of backups -.TP -.B "#ETCDIR#/backup.conf" -configuration of backups -.SH AUTHOR -.nf -Erich Eckner -.fi -- cgit v1.2.3