From e84cf81b1335720d256c002bb55439dcd862782b Mon Sep 17 00:00:00 2001
From: Fuxino <dfucini@gmail.com>
Date: Thu, 1 Jun 2023 17:08:31 +0200
Subject: [PATCH] Add man page

---
 PKGBUILD            | 11 ++++----
 man/simple_backup.1 | 67 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 73 insertions(+), 5 deletions(-)
 create mode 100644 man/simple_backup.1

diff --git a/PKGBUILD b/PKGBUILD
index 6e03e11..3f2ebaa 100644
--- a/PKGBUILD
+++ b/PKGBUILD
@@ -29,13 +29,14 @@ sha256sums=('fd418a9c641d604c64bd0a8487b5ab431ff71f192d6021e55b194085951cb40d'
 
 build()
 {
-   cd ${srcdir}/${pkgname}-${pkgver}
-   python -m build --wheel --no-isolation
+    cd ${srcdir}/${pkgname}-${pkgver}
+    python -m build --wheel --no-isolation
 }
 
 package()
 {
-   cd ${srcdir}/${pkgname}-${pkgver}
-   python -m installer --destdir=${pkgdir} dist/*.whl
-   install -Dm644 ${srcdir}/${pkgname}-${pkgver}/${pkgname}.conf ${pkgdir}/etc/${pkgname}/${pkgname}.conf
+    cd ${srcdir}/${pkgname}-${pkgver}
+    python -m installer --destdir=${pkgdir} dist/*.whl
+    install -Dm644 ${pkgname}.conf ${pkgdir}/etc/${pkgname}/${pkgname}.conf
+    install -Dm644 man/${pkgname}.1 ${pkgdir}/usr/share/man/man1/${pkgname}.1
 }
diff --git a/man/simple_backup.1 b/man/simple_backup.1
new file mode 100644
index 0000000..c37cc03
--- /dev/null
+++ b/man/simple_backup.1
@@ -0,0 +1,67 @@
+.TH SIMPLE_BACKUP 1 2023-06-01 SIMPLE_BACKUP 3.2.6
+.SH NAME
+simple_backup \- Backup files and folders using rsync
+.SH SYNOPSIS
+.BR simple_backup
+\-h, \-\-help
+.PD 0
+.P
+.PD
+.BR simple_backup
+[\-c, \-\-config FILE]
+[\-i, \-\-input INPUT [INPUT...]]
+[\-o, \-\-output DIR]
+.PD 0
+.P
+.PD
+.RS 14 [\-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
+[\-k, \-\-keep N]
+[\-s, \-\-checksum]
+[\-\-remove\-before\-backup]
+.RE
+.SH DESCRIPTION
+.BR simple_backup
+is a python script for performing backup of files and folders. It uses rsync to copy the files to the specified location.
+Parameters for the backup such as input files/directories, output location and files or folders to exclude can be specified
+in a configuration file (default location $HOME/.config/simple_backup/simple_backup.conf) or directly on the command line.
+Parameters specified on the command line will override those in the configuration file.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Print a short help message and exit
+.TP
+.B \-c, \-\-config FILE
+Specify the configuration file, useful to specify a different one from the default.
+.TP
+.B \-i, \-\-input INPUT [INPUT...]
+Specify the files and directories to backup. Multiple inputs can be specified, just separate them with a space.
+If filenames or paths contain spaces, don't forget to escape them, or to use single or double quotes around them.
+.TP
+.B \-o, \-\-output DIR
+Specify the directory where the files will be copied. The program will automatically create a subdirectory called
+\(aqsimple_backup\(aq (if it does not already exist) and inside this directory the actual backup directory (using
+the current date and time)
+.TP
+.B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
+Specify files, directories or patterns to exclude from the backup. Matching files and directories will not be copied.
+Multiple elements can be specified, in the same way as for the \-\-input option
+.TP
+.B \-k, \-\-keep N
+Specify how many old backups (so excluding the current one) will be kept. The default behavior is to keep them all
+(same as N=\-1)
+.TP
+.B \-s, \-\-checksums
+Same as rsync option \(aq\-\-checksum\(aq, use checksums instead of mod\-time and size to skip files.
+.TP
+.B \-\-remove\-before\-backup
+Remove old backups (if necessary) before creating the new backup. Useful to free some space before performing the backup.
+Default behavior is to remove old backups after successfully completing the backup.
+.SH CONFIGURATION
+An example configuration file is provided at \(aq/etc/simple_backup/simple_backup.conf\(aq. Copy it to the default location
+($HOME/.config/simple_backup) and edit it as needed.
+.SH SEE ALSO
+.BR rsync (1)
+.SH AUTHORS
+.MT https://github.com/Fuxino
+Daniele Fucini
+.ME