From b37de72a199eb2c54589209314e3a4d43d9b81f4 Mon Sep 17 00:00:00 2001
From: DieGurke <maxi@kske.dev>
Date: Wed, 19 May 2021 22:03:19 +0200
Subject: [PATCH] Introduced man page and adjusted PKGBUILD and RM

---
 PKGBUILD       |  1 +
 README.md      |  8 ++++---
 paperchanger.1 | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 3 deletions(-)
 create mode 100644 paperchanger.1

diff --git a/PKGBUILD b/PKGBUILD
index 4abe800..56f6671 100644
--- a/PKGBUILD
+++ b/PKGBUILD
@@ -34,5 +34,6 @@ package() {
 #	install -Dm755 current_wallpaper.txt "${pkgdir}${HOME}/.${pkgname}/current_wallpaper.txt"
 	install -Dm644 README.md "${pkgdir}/usr/share/doc/${pkgname}/README.md"
 	install -Dm644 LICENSE "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
+	install -DM644 paperchanger.1 "${pkgdir}/usr/share/man/man1/paperchanger.1"
 	install -Dm755 paperchanger.sh "${pkgdir}/usr/bin/paperchanger"
 }
diff --git a/README.md b/README.md
index edb1354..86c0851 100644
--- a/README.md
+++ b/README.md
@@ -71,10 +71,10 @@ $ cd paperchanger/
 Now copy the shell script into the `/usr/bin/` folder on your system:
 
 ```shell
-$ sudo cp paperchanger.sh /usr/bin/paperchanger
+$ sudo cp paperchanger.sh /usr/local/bin/paperchanger
 ```
 
-Now the `README.md` and the `LICENSE` files have to be copied to the appropriate folders on your system:
+Now the `README.md`, the `LICENSE` and the `paperchanger.1` files have to be copied to the appropriate folders on your system:
 
 ```shell
 $ sudo mkdir /usr/share/doc/paperchanger
@@ -82,6 +82,8 @@ $ sudo cp README.md /usr/share/doc/paperchanger/README.md
 
 $ sudo mkdir /usr/share/licenses/paperchanger
 $ sudo cp LICENSE /usr/share/licenses/paperchanger/LICENSE
+
+$ sudo cp paperchanger.1 /usr/local/man/man1/paperchanger.1
 ```
 
 Paperchanger is now installed on your system, thus the folder you are in right now used for the installation might be deleted.
@@ -95,7 +97,7 @@ A breef overview about the functionality can be accessed by looking into the hel
 $ paperchanger -h
 
 or just
-$p paperchanger
+$ paperchanger
 ```
 
 This will look something like this:
diff --git a/paperchanger.1 b/paperchanger.1
new file mode 100644
index 0000000..042a982
--- /dev/null
+++ b/paperchanger.1
@@ -0,0 +1,62 @@
+.TH "PAPERCHANGER" "1" "May 2021"
+
+.SH NAME
+.PP
+paperchanger - providing a comfortable way of changing the wallpaper
+
+.SH SYNOPSIS
+.PP
+.SS paperchanger
+[-OPTION] [PATH]
+.SS paperchanger
+-h | -d | -S | -dS | -P
+.SS paperchanger
+-s [file] | -ds [file] | -p [directory]
+
+.SH DESCRIPTION
+.PP
+Paperchanger provides an easy way of changing the wallpaper in an x environment. It uses xwallpaper internally. Paperchanger provides functionality of saving the current wallpaper in the users home directory as well as setting a default directory, where all wallpapers are usually stored. This makes it much easier to change wallpapers, as you are in the right directory just when you want to change the wallpaper. It also eliminates the need of setting the wallpapers path manually every time the window manager / desktop environment is started. Furthermore it gives the user the option of choosing a wallpaper through a graphical dialogue which is very nice as one is selecting images.
+
+.SH OPTIONS
+.PP
+.SS -h, --help, help
+Prints the help output.
+.PP
+.SS -d, --display, display
+Displays the specified wallpaper.
+.PP
+.SS -s [file], --set [file], set [file]
+Sets the wallpaper to the file given as a parameter.
+.PP
+.SS -S, --Set, Set
+Sets the wallpaper to the file selected through a graphical selection dialogue.
+.PP
+.SS -ds [file], --display-and-set [file], display-and-set [file]
+Sets and directly displays the wallpaper to the file given as a parameter.
+.PP
+.SS -dS, --display-and-Set, display-and-Set
+Sets and directly displays the wallpaper choosen through a graphical selection dialogue.
+.PP
+.SS -p, --path, path
+Sets the default wallpaper directory to the path given as a parameter.
+.PP
+.SS -P, --Path, Path
+Sets the default wallpaper directory to the path selected through a graphical dialogue.
+.PP
+
+.SH FILES
+.SS /usr/bin/paperchanger
+The paperchanger binary.
+.PP
+.SS ~/.paperchanger/current_wallpaper.txt
+The file, where the path to the current wallpaper is stored.
+.PP
+.SS ~/.paperchanger/paperchanger.conf.sh
+The configuration file.
+.PP
+
+.SH AUTHOR
+Maximilian Käfer (maxi@kske.dev)
+.PP
+Git Repository (\fIhttps://git.kske.dev/DieGurke/paperchanger\fP)
+.PP