Added manpage.

* Added a simple manpage
* Updated PKGBUILD to install manpage.

Signed-off-by: Kolaer <overlordin777@gmail.com>
This commit is contained in:
Kolaer
2020-05-06 13:28:22 +04:00
parent 28902116a5
commit da70fc34ed
3 changed files with 62 additions and 4 deletions

1
.gitignore vendored
View File

@ -2,3 +2,4 @@
.idea
pkg
*.pkg.tar.xz
/docs/*gz

View File

@ -1,6 +1,6 @@
# Maintainer: s3rius <win10@list.com>
pkgname=awatch
pkgver=0.1.0
pkgver=0.3.1
pkgrel=2
pkgdesc="Anime watcher."
arch=('i686' 'x86_64' 'arm' 'armv7h' 'armv6h' 'aarch64')
@ -10,16 +10,17 @@ options=(!emptydirs)
depends=()
makedepends=(
'rust'
'cargo'
)
build() {
cd "$startdir/"
pwd
cargo build --release
gzip -c docs/awatch.1 > docs/awatch.1.gz
}
package() {
mkdir -p "$pkgdir/usr/bin"
cp "$startdir/target/release/awatch" "$pkgdir/usr/bin"
install -Dm 755 "$startdir/target/release/awatch" -t "$pkgdir/usr/bin"
install -Dm 755 "$startdir/docs/awatch.1.gz" -t "$pkgdir/usr/share/man/man1"
}

56
docs/awatch.1 Normal file
View File

@ -0,0 +1,56 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
.TH AWATCH "1" "May 2020" "awatch 0.3.1" "User Commands"
.SH NAME
awatch \- manual page for awatch 0.3.1
.SH DESCRIPTION
awatch 0.3.1
Here to help you with watching anime on your PC.
.SS "USAGE:"
.IP
awatch [SUBCOMMAND]
.SS "FLAGS:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Prints help information
.TP
\fB\-V\fR, \fB\-\-version\fR
Prints version information
.SS "SUBCOMMANDS:"
.TP
completion
Generate autocompletion for your shell. If no shell was specified, then it will try to recognize
it automatically.
Supports bash, zsh, fish, powershell, elvish.
.TP
help
Prints this message or the help of the given subcommand(s)
.TP
init
Initialize config
There are some patterns, that you can use in command specification:
{} - current episode file's name;
{n} - current episode number (starts from 0);
{n+} - current episode number (starts from 1);
{zn} - current episode number (starts from 0; paddes left with 0s, if needed);
{zn+} - current episode number (starts from 1; paddes left with 0s, if needed);
.TP
next
Increase episode counter by one
.TP
play
Play next episode
.TP
prev
Decrease episode counter by one
.TP
reset
Set episode to 0
.TP
update
Update saved config