From a8dd763f3149797c4d9ee76387274df81d43146f Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 24 Oct 2024 13:18:31 +0000 Subject: [PATCH 1/3] docs: add a manpage --- man/hyprwall.1 | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 man/hyprwall.1 diff --git a/man/hyprwall.1 b/man/hyprwall.1 new file mode 100644 index 0000000..16edc0b --- /dev/null +++ b/man/hyprwall.1 @@ -0,0 +1,75 @@ +.\" manpage for Hyprwall +.TH "hyprwall" "1" "October 2024" "" "Hyprwall Manual" + +.SH NAME +hyprwall \- A tool for setting wallpapers on Wayland (multiple backends). Written in blazingly fast Rust! + +.SH SYNOPSIS +\fBhyprwall [OPTIONS]\fR + +.SH DESCRIPTION +An unofficial GUI for setting wallpapers with multiple backends, built with GTK4 and Rust. +.br +Supports supports a variety of wallpaper backends: \fIswaybg\fR, \fIswww\fR, \fIwallutils\fR, \fIfeh\fR, and \fIhyprpaper\fR. + +.SH GUI +.TP +To launch Hyprwall in GUI mode, simply run: +hyprwall + +.SH OPTIONS +.TP +\fB\-r\fR, \fB\-\-restore\fR +Restore the last selected wallpaper. + +.TP +\fB\-R\fR, \fB\-\-random\fR +Set a random wallpaper. + +.TP +\fB\-b\fR, \fB\-\-backend\fR \fI\fR +Set the wallpaper backend. + +.TP +\fB\-f\fR, \fB\-\-folder\fR \fI\fR +Set the wallpaper folder. + +.TP +\fB\-w\fR, \fB\-\-wallpaper\fR \fI\fR +Set a specific wallpaper. + +.TP +\fB\-g\fR, \fB\-\-generate\fR +Generate the config file. + +.TP +\fB\-F\fR, \fB\-\-force\fR +Force overwrite of existing config file. +.br +Should be used with \fB-g\fR. + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help + +.TP +\fB\-V\fR, \fB\-\-version\fR +Print version + +.SH SUPPORT +If you find Hyprwall useful, please consider giving it a star on GitHub to show your support! +https://github.com/nnyyxxxx/hyprwall + +.SH AUTHOR +Written by Adam Perkowski. + + +.SH REPORTING BUGS +Please consider submitting feedback if you encounter any issues. +https://github.com/nnyyxxxx/hyprwall/issues + +.SH COPYRIGHT +Copyright (c) 2024 Nyx. +.br +GPL-2.0 License. +https://www.gnu.org/licenses/old-licenses/gpl-2.0 From 7c275667488252370c4f4fdf427fa5550bd69256 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 24 Oct 2024 13:28:55 +0000 Subject: [PATCH 2/3] better copyright info --- man/hyprwall.1 | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/man/hyprwall.1 b/man/hyprwall.1 index 16edc0b..4aebe1a 100644 --- a/man/hyprwall.1 +++ b/man/hyprwall.1 @@ -69,7 +69,24 @@ Please consider submitting feedback if you encounter any issues. https://github.com/nnyyxxxx/hyprwall/issues .SH COPYRIGHT -Copyright (c) 2024 Nyx. +Copyright (c) 2024 Nyx, Adam Perkowski. .br GPL-2.0 License. https://www.gnu.org/licenses/old-licenses/gpl-2.0 +.br + +This program is free software; you can redistribute it and/or +.br +modify it under the terms of the GNU General Public License, +.br +version 2. +.br + +This program is distributed in the hope that it will be useful, +.br +but WITHOUT ANY WARRANTY; without even the implied warranty of +.br +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +See the +.br +GNU General Public License for more details. From 3ddfe4b94f9812d5f89a0e2fc36d99469e74ffa5 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 24 Oct 2024 13:30:44 +0000 Subject: [PATCH 3/3] YOINK --- man/hyprwall.1 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/man/hyprwall.1 b/man/hyprwall.1 index 4aebe1a..fe3a68b 100644 --- a/man/hyprwall.1 +++ b/man/hyprwall.1 @@ -60,10 +60,6 @@ Print version If you find Hyprwall useful, please consider giving it a star on GitHub to show your support! https://github.com/nnyyxxxx/hyprwall -.SH AUTHOR -Written by Adam Perkowski. - - .SH REPORTING BUGS Please consider submitting feedback if you encounter any issues. https://github.com/nnyyxxxx/hyprwall/issues @@ -90,3 +86,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .br GNU General Public License for more details. + +.SH AUTHOR +Written by Adam Perkowski. +