summaryrefslogtreecommitdiff
path: root/borg-family-0.1/doc
diff options
context:
space:
mode:
authorLudovic Pouzenc <ludovic@pouzenc.fr>2021-01-15 23:17:34 +0100
committerLudovic Pouzenc <ludovic@pouzenc.fr>2021-01-15 23:17:34 +0100
commit1ada10f44e2baf28823156c006c82a076c52f530 (patch)
treec57a5d11efffe6f3a96d02b78765f55a1b6c3889 /borg-family-0.1/doc
downloadborg-family-1ada10f44e2baf28823156c006c82a076c52f530.tar.gz
borg-family-1ada10f44e2baf28823156c006c82a076c52f530.tar.bz2
borg-family-1ada10f44e2baf28823156c006c82a076c52f530.zip
borg-family_0.1-1
Diffstat (limited to 'borg-family-0.1/doc')
-rw-r--r--borg-family-0.1/doc/examples/envvars10
l---------borg-family-0.1/doc/man/bfenv.11
-rw-r--r--borg-family-0.1/doc/man/bfrun.152
l---------borg-family-0.1/doc/man/bfwhat.11
4 files changed, 64 insertions, 0 deletions
diff --git a/borg-family-0.1/doc/examples/envvars b/borg-family-0.1/doc/examples/envvars
new file mode 100644
index 0000000..99f7139
--- /dev/null
+++ b/borg-family-0.1/doc/examples/envvars
@@ -0,0 +1,10 @@
+# To consult or restore backups, just load this file in a root shell environnement variables with:
+# source /etc/borg-family/envvars
+# Then use commands like:
+# borg list
+# mkdir /mnt/restore
+# borg mount ::somehostname-rootfs-2020-08-15 /mnt/restore
+# cp -ai /mnt/restore/rootfs/etc/veryimportantfile /etc/
+export BORG_RSH="ssh -i /etc/borg-family/id_rsa_borg"
+export BORG_PASSCOMMAND="cat /etc/borg-family/passphrase"
+export BORG_REPO="ssh://user@host:port/path/to/repo"
diff --git a/borg-family-0.1/doc/man/bfenv.1 b/borg-family-0.1/doc/man/bfenv.1
new file mode 120000
index 0000000..080be00
--- /dev/null
+++ b/borg-family-0.1/doc/man/bfenv.1
@@ -0,0 +1 @@
+bfrun.1 \ No newline at end of file
diff --git a/borg-family-0.1/doc/man/bfrun.1 b/borg-family-0.1/doc/man/bfrun.1
new file mode 100644
index 0000000..efc42a7
--- /dev/null
+++ b/borg-family-0.1/doc/man/bfrun.1
@@ -0,0 +1,52 @@
+.TH BORG-FAMILY 1 local
+.SH NAME
+bfrun, bfwhat, bfenv \- scripts to run Borg to backup your computers
+.SH SYNOPSIS
+.ll +8
+.B bfrun
+.ll -8
+.br
+.SH DESCRIPTION
+.I bfrun
+invokes
+.I bfenv
+then
+.I bfwhat
+to check repository availability and list local mount points to backup.
+.SH OPTIONS
+.ll +8
+.B No options.
+See /etc/borg-family
+.ll -8
+.SH "ENVIRONMENT"
+.B bfrun
+loads /etc/borg-family/envvars for Borg and /etc/borg-family/confvars for itself.
+.SH "SEE ALSO"
+borgbackup(1)
+.SH CAVEATS
+Poor manpage.
+.SH BUGS
+Reports them to
+.BR "<ludovic@pouzenc.fr>"
+.SH "COPYRIGHT NOTICE"
+Copyright \(co 2020 Ludovic Pouzenc <ludovic@pouzenc.fr>
+.PP
+Permission is granted to make and distribute verbatim copies of
+this manual provided the copyright notice and this permission notice
+are preserved on all copies.
+.ig
+Permission is granted to process this file through troff and print the
+results, provided the printed document carries copying permission
+notice identical to this one except for the removal of this paragraph
+(this paragraph not being relevant to the printed manual).
+..
+.PP
+Permission is granted to copy and distribute modified versions of this
+manual under the conditions for verbatim copying, provided that the entire
+resulting derived work is distributed under the terms of a permission
+notice identical to this one.
+.PP
+Permission is granted to copy and distribute translations of this manual
+into another language, under the above conditions for modified versions,
+except that this permission notice may be stated in a translation approved
+by the Foundation.
diff --git a/borg-family-0.1/doc/man/bfwhat.1 b/borg-family-0.1/doc/man/bfwhat.1
new file mode 120000
index 0000000..080be00
--- /dev/null
+++ b/borg-family-0.1/doc/man/bfwhat.1
@@ -0,0 +1 @@
+bfrun.1 \ No newline at end of file