docs update

This commit is contained in:
Evgenii Alekseev 2021-09-26 14:37:54 +03:00
parent af5363d158
commit 8add507957
2 changed files with 13 additions and 5 deletions

View File

@ -46,8 +46,8 @@ mypy:
cd src && mypy --implicit-reexport --strict -p "$(PROJECT)" --install-types --non-interactive || true cd src && mypy --implicit-reexport --strict -p "$(PROJECT)" --install-types --non-interactive || true
cd src && mypy --implicit-reexport --strict -p "$(PROJECT)" cd src && mypy --implicit-reexport --strict -p "$(PROJECT)"
push: archlinux push: architecture man archlinux
git add package/archlinux/PKGBUILD src/ahriman/version.py git add package/archlinux/PKGBUILD src/ahriman/version.py docs/ahriman-architecture.svg docs/ahriman.1
git commit -m "Release $(VERSION)" git commit -m "Release $(VERSION)"
git tag "$(VERSION)" git tag "$(VERSION)"
git push git push

View File

@ -100,7 +100,7 @@ manage users for web services
\fBahriman\fR \fI\,web\/\fR \fBahriman\fR \fI\,web\/\fR
start web server start web server
.SH OPTIONS 'ahriman add' .SH OPTIONS 'ahriman add'
usage: ahriman add [-h] [--now] [--without-dependencies] package [package ...] usage: ahriman add [-h] [--now] [--source {PackageSource.Auto,PackageSource.Archive,PackageSource.Directory,PackageSource.AUR}] [--without-dependencies] package [package ...]
add package add package
@ -112,6 +112,10 @@ package base/name or archive path
\fB\-\-now\fR \fB\-\-now\fR
run update function after run update function after
.TP
\fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.Directory,PackageSource.AUR}
package source
.TP .TP
\fB\-\-without\-dependencies\fR \fB\-\-without\-dependencies\fR
do not add dependencies do not add dependencies
@ -351,7 +355,7 @@ do not include manual updates
do not check VCS packages do not check VCS packages
.SH OPTIONS 'ahriman user' .SH OPTIONS 'ahriman user'
usage: ahriman user [-h] [--as-service] [-a {UserAccess.Read,UserAccess.Write}] [--no-reload] [-p PASSWORD] [-r] username usage: ahriman user [-h] [--as-service] [-a {UserAccess.Safe,UserAccess.Read,UserAccess.Write}] [--no-reload] [-p PASSWORD] [-r] [--secure] username
manage users for web services with password and role. In case if password was not entered it will be asked interactively manage users for web services with password and role. In case if password was not entered it will be asked interactively
@ -364,7 +368,7 @@ username for web service
add user as service user add user as service user
.TP .TP
\fB\-a\fR {UserAccess.Read,UserAccess.Write}, \fB\-\-access\fR {UserAccess.Read,UserAccess.Write} \fB\-a\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}, \fB\-\-access\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}
user access level user access level
.TP .TP
@ -379,6 +383,10 @@ user password
\fB\-r\fR, \fB\-\-remove\fR \fB\-r\fR, \fB\-\-remove\fR
remove user from configuration remove user from configuration
.TP
\fB\-\-secure\fR
set file permissions to user\-only
.SH OPTIONS 'ahriman web' .SH OPTIONS 'ahriman web'
usage: ahriman web [-h] usage: ahriman web [-h]