From 6bd3811ef848676aa969d9fd27cc562f15e56a83 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 13 Oct 2021 23:45:13 -0400 Subject: [PATCH] backups: Add dumpster.8 man page No good tool should go undocumented :) I do kindof get a kick out of when the man page is WAY longer than the source code.. --- Makefile | 1 + usr/local/man/man8/dumpster.8 | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 usr/local/man/man8/dumpster.8 diff --git a/Makefile b/Makefile index 792f40c..7fe5c65 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,7 @@ FILES = /etc/httpd.conf \ /usr/local/bin/wggen \ /usr/local/bin/dumpster \ /usr/local/man/man8/wggen.8 \ + /usr/local/man/man8/dumpster.8 \ /home/_soju/soju.cfg .PHONY: pull diff --git a/usr/local/man/man8/dumpster.8 b/usr/local/man/man8/dumpster.8 new file mode 100644 index 0000000..d6a4e05 --- /dev/null +++ b/usr/local/man/man8/dumpster.8 @@ -0,0 +1,40 @@ +.Dd October 12, 2021 +.Dt DUMPSTER 8 +.Os +.Sh NAME +.Nm dumpster +.Nd +.Xr dump 8 wrapper for routine backups +.Sh SYNOPSIS +.Nm dumpster +.Op Ar N +.Sh DESCRIPTION +.Nm +will invoke +.Xr dump 8 +on the following partitions: +.Bl -tag -width "/home" -offset 4n +.It Pa / +Critical configuration files (wg keys, etc) +.It Pa /home +Location of most user files +.It Pa /var +Location of public git repos +.El +.Pp +If +.Ar N +is specified, +it will be the dumplevel used. +Otherwise, +the default dumplevel is the day of the week +(Monday is 1, Sunday is 7) to facilitate +use within +.Xr cron 8 . +.Pp +Dumps are saved to +.Pa /bak/YYYY-MM-DD_N/{path}.dump.N . +.Sh SEE ALSO +.Xr daily 8 , +.Xr dump 8 , +.Xr restore 8 -- libgit2 1.1.1