mpk/paperchanger
1
Fork 0
Code Issues Pull Requests Releases Activity

Introduced man page and adjusted PKGBUILD and RM

Browse Source
This commit is contained in:
Maximilian P. Käfer 2021-05-19 22:03:19 +02:00
parent 3815c2891f
commit b37de72a19
Signed by: mpk
GPG Key ID: 035869C949377C5C
3 changed files with 68 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
PKGBUILD
View File

@ -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"
}

8
README.md
View File

@ -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:

62
paperchanger.1 Normal file
View File

@ -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