Adding manpage

README.md

@@ -12,7 +12,7 @@ GUI wallpaper setter for Wayland and Xorg window managers. It works as a fronten
 - Works on both Wayland (with `swww` or `swaybg` or `wallutils`) and Xorg (with `feh` or `wallutils`)
 - Restores wallpaper at launch of your WM
 - Caching for fast loading
-- Translated in en, fr, de, ru, pl
+- Translated in en, fr, de, ru, pl, zh
   
 ## Installation
 
@@ -86,15 +86,12 @@ If you wish to change language, change `laguage` variable in `.config/waypaper/c
 
 ## Roadmap
 
-- Additional options for ~subfolders~, ~color~, ~sorting~, ~randomizing~ and setting a uniform color.
-- ~Support for other backends like swww, feh, wallutils~, and maybe hyprpaper.
-- ~Better keyboard-driven experience and hjkl support.~
-- ~Support for multiple monitors with swww~ and swaybg
+- Possible support for other backends like mpvpaper, and maybe hyprpaper.
+- Support for various `swww` options
 - Display animated previews of gif wallpapers
-- Translations
 
 ## Contributions
 
-Feel free to propose PR and suggest the improvements. I'll also appreciate any help with packaging for various distributions. Also, if you wish to contribute with translation into your language, plese translate `translation_en.py` file, and I'll do the rest.
+Feel free to propose PR and suggest the improvements. I'll highly appreciate help with packaging for various distributions. If you wish to contribute with translation into your language, please see the `translations.py` file.
 
 If you'd like to support the development, consider [donations](https://www.buymeacoffee.com/angryprofessor).

data/waypaper.1.gz

@@ -0,0 +1,41 @@
+.TH WAYPAPER 2024-01-01
+.nh
+.SH NAME
+waypaper \- GUI wallpaper manager for Wayland and X11
+.SH SYNOPSIS
+.B waypaper
+[ \fIOPTION\fR ]
+.SH DESCRIPTION
+.B Waypaper
+is a TUI wallpaper setter for Wayland and Xorg window managers. It works as a frontend for popular wallpaper backends like swaybg, swww, wallutils and feh.  \fIhttps://anufrievroman.gitbook.com/waypaper \fR
+.SH OPTIONS
+
+.TP
+\fB\-v \fP
+Print version.
+
+.TP
+\fB\-h \fP
+Print help.
+
+.TP
+\fB\-\-restore \fP
+Restore the last chosen wallpaper. Useful at launch of the window manager.
+
+.TP
+\fB\-\-random \fP
+Set a random wallpaper.
+
+.TP
+\fB\-\-backend XXX \fP
+Specify which backend to use, which can be either \fIswaybg, swww, feh\fR, or \fIwallutils\fR. Useful if you use waypaper on both Wayland and Xorg on the same machine. By default, last used backend is used.
+
+.TP
+\fB\-\-fill XXX \fP
+Specifies filling type, which can be eiher \fIfill, stretch, fit, center\fR, or \fItile\fR.
+
+.SH COMMANDS DURING USE
+Press '\fB?\fP' during use to get a list of keybindings.
+.br
+.SH AUTHOR
+Written by Roman Anufriev. For more information, visit \fIhttps://anufrievroman.gitbook.com/waypaper\fR

setup.py

@@ -44,5 +44,8 @@ setuptools.setup(
         ('share/applications',
          ['data/waypaper.desktop']
          )
+        ('share/man/man1',
+         ['data/waypaper.1.gz']
+         )
     ],
 )