.\" # ##############################################################################################
.\" # Man-pagina voor kzbackup.
.\" #
.\" # Geschreven door Karel Zimmer (https://karelzimmer.nl).
.\" # ##############################################################################################
.\" Versiegegevens worden bijgehouden door kzdeploy
.\" REL_NUM=35.03.03
.\" REL_DAT=2020-08-01
.\" REL_MSG='Logboekeldingen bij het afsluitnen met een waarschuwing (signal_exit_warning)'
.\"
.TH "KZBACKUP" "1" "2020-08-01" "35.03.03" "KZ Backup"

.SH NAAM
kzbackup \- Back-up maken

.SH SAMENVATTING
.B kzbackup
[OPTIE...] [--] [\fISELECTIE\fR...]

.SH BESCHRIJVING
\fBkzbackup\fR maakt een back-up (reservekopie) van mappen en bestanden.

In een grafische werkomgeving zoals GNOME (e.g. Ubuntu) kan \fBkzbackup\fR worden gestart met toepassing \fBBack-up maken\fR.
.br
Dan zal een back-up worden gemaakt van alle Persoonlijke mappen, d.i. /home en /root (en KVM VMs als aanwezig).

Standaard, tenzij \fISELECTIE\fRs zijn opgegeven, wordt er een back-up gemaakt van:
.br
- Persoonlijke mappen van alle gebruikers, d.i. /home en /root
.br
- KVM VMs, d.i. /etc/libvirt en /var/lib/libvirt

Opbouw van de back-up-bestandsnaam is 'backup-COMPUTERNAAM-jjjj:mm:ddTuu.mm.ss.sss.tar'.

Standaard locatie voor het plaatsen van de back-up is een medium zoals een (externe) harddisk, USB-stick, of een NAS op '/media/MEDIUMNAAM/backups/COMPUTERNAAM'.
.br
Als er meer dan één medium is gevonden dient er een locatie opgegeven te worden.

Met optie \fB--target\fR (\fB-t\fR) kan een (andere) locatie opgegeven worden.

Standaard worden de volgende bestanden en mappen NIET in de back-up opgenomen:
.RS
/dev
.br
/home/*/.adobe/Flash_Player/AssetCache
.br
/home/*/.cache
.br
/home/*/.ccache
.br
/home/.ecryptfs
.br
/home/gast
.br
/home/*/.gvfs
.br
/home/*/.recent-applications.xbel
.br
/home/*/.recently-used.xbel
.br
/home/*/snap/*/*/.cache
.br
/home/*/snapshots
.br
/home/*/.steam/root
.br
/home/*/.thumbnails
.br
/home/*/.xsession-errors
.br
/proc
.br
/run
.br
/sys
.br
/tmp
.RE

Met optie \fB--exclude\fR (\fB-e\fR) zijn extra mappen en bestanden uit te sluiten.

Voor het aanmaken van de back-up wordt tar gebruikt.
De inhoud van de back-up is op te vragen met opdracht:
.RS
\fBtar tvf \fIBESTAND\fR\fB [--wildcards \fISELECTIE\fR\fB...]\fR
.RE

Met opdracht \fBkzrestore\fR zijn individuele -of alle- bestanden en mappen uit een back-up te herstellen.

.SH OPTIES
Lange opties kunnen worden afgekort, zolang de afkorting uniek blijft.

Een argument dat verplicht of optioneel is voor een lange optie, is dat ook voor de overeenkomstige korte optie.
.TP
\fB-e\fR, \fB--exclude=\fIUITSLUITEN\fR
Sluit bestanden of mappen \fIUITSLUITEN\fR uit.
Mag meerdere keren opgegeven worden.
.TP
\fB-t\fR, \fB--target=\fIDOELMAP\fR
Plaats back-up in de \fIDOELMAP\fR.
.TP
\fB-d\fR, \fB--debug\fR
Geef foutopsporingsinformatie weer in het logboek (gebruik 'journalctl -ab -tbackup').
.TP
\fB-g\fR, \fB--gui\fR
Start in grafische modus (gui = graphical user interface).
.TP
\fB-h\fR, \fB--help\fR
Toon een een korte omschrijving van de beschikbare opties.
.TP
\fB-u\fR, \fB--usage\fR
Toon de beschikbare opties.
.TP
\fB-v\fR, \fB--version\fR
Toon de versie, de auteur, en het auteursrecht.
.TP
\fB--\fR
Een -- geeft het einde van de opties aan en schakelt de verdere verwerking van opties uit.
Alle argumenten na de -- worden behandeld als bestandsnamen en argumenten.
Een argument van - is gelijk aan --.

.SH STOPSTATUS
Normaal wordt afsluitwaarde 0 teruggegeven; als er een fout optreedt, is de afsluitwaarde 1.
Als er een waarschuwing optreedt, is de afsluitwaarde 2.

.SH MAPPEN
/media/\fIaangekoppelde-media\fR/backups/COMPUTERNAAM
.RS
Als er geen \fIDOEL\fR is opegegeven wordt de back-up in deze map geplaatst.
.RE

/
.RS
Vanaf deze map wordt een back-up gemaakt.
Hierdoor kan een back-up op de originele plek worden teruggezet door \fBkzrestore\fR.
.RE

.SH BESTANDEN
/usr/bin/common.sh
.RS
Algemene variabelen en functies voor bash scripts.
.RE

/root/.backup-exclude-dflt
.RS
Standaard uit te sluiten bestanden en mappen.
.RE

/root/.backup-exclude-opt
.RS
Opgegeven uit te sluiten bestanden en mappen.
.RE

.SH NOTITIES
.IP " 1." 4
Checklist installatie
.RS 4
https://karelzimmer.nl
.RE

.SH VOORBEELDEN

\fBkzbackup\fR
.RS
Maak een back-up van de Persoonlijke mappen en KVM VMs.
Hiervoor is ook starter 'Back-up maken' beschikbaar.
.RE

\fBkzbackup --target /tmp /home/*/Documenten\fR
.RS
Maak een back-up van alle documenten en plaats deze in map /tmp.
.RE

\fBkzbackup --exclude '*.JPG' /home/*/Afbeeldingen\fR
.RS
Maak een back-up van alle foto's maar geen JPG's.
.RE

.SH AUTEUR
Geschreven door Karel Zimmer (https://karelzimmer.nl).

.SH ZIE OOK
\fBkzcheckname\fR(1),
\fBkzcommon.sh\fR(1),
\fBkzmenu\fR(1),
\fBkzrestore\fR(1),
\fBhttps://karelzimmer.nl\fR

.\" EOF