Add manpage

This commit is contained in:
Marko Korhonen 2022-06-12 11:48:51 +03:00
parent 78cc2ba87d
commit e262e9a506
No known key found for this signature in database
GPG key ID: 911B85FBC6003FE5
2 changed files with 36 additions and 0 deletions

View file

@ -23,6 +23,7 @@ printf "\e[34m Copying needed files for release\e[0m\n\n"
mkdir release
cp target/release/lqsd release/
cp LICENSE release/
cp manpage.adoc release/
cd release
printf "\e[34m Signing binary with GPG\e[0m\n"
@ -45,6 +46,10 @@ md5sum -c lqsd.md5
printf "\n\n"
printf "\e[34m Building documentation\e[0m\n"
asciidoc -b manpage manpage.adoc
printf "\n\n"
printf "\e[34m Compressing to tar.zst\e[0m\n\n"
tar cf lqsd_${VERSION_NR}_x86_64.tar.zst * --zstd

31
manpage.adoc Normal file
View file

@ -0,0 +1,31 @@
= lqsd(1)
Marko Korhonen
v0.1.1
:doctype: manpage
:manmanual: LQSD
:mansource: LQSD
:man-linkstyle: pass:[blue R < >]
== Name
lqsd - dim your screen smoothly
== Synopsis
*lqsd* [_OPTION_]
== Options
*-d, --dim*::
Dims the screen to idle level set in configuration
*-r, --resume*::
Sets the backlight to the value it was before dimming
*--copy-config*::
Copies the default config file to $XDG_CONFIG_HOME/lqsd
*-h, --help*::
Prints help information
*-V, --version*::
Prints version information
== Resources
*Project source code:* https://git.korhonen.cc/FunctionalHacker/lqsd