docs update

This commit is contained in:
Evgenii Alekseev 2022-11-02 04:17:26 +02:00
parent 48da4646cf
commit 77ad35fce8
2 changed files with 40 additions and 4 deletions

View File

@ -3,7 +3,7 @@
ahriman ahriman
.SH SYNOPSIS .SH SYNOPSIS
.B ahriman .B ahriman
[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--no-report] [-q] [--unsafe] [-V] {aur-search,search,help,help-commands-unsafe,key-import,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-clean,clean,repo-config,config,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-setup,init,repo-init,setup,repo-sign,sign,repo-status-update,repo-sync,sync,repo-triggers,repo-update,update,shell,user-add,user-list,user-remove,version,web} ... [-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--no-report] [-q] [--unsafe] [-V] {aur-search,search,daemon,help,help-commands-unsafe,key-import,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-clean,clean,repo-config,config,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-setup,init,repo-init,setup,repo-sign,sign,repo-status-update,repo-sync,sync,repo-triggers,repo-update,update,shell,user-add,user-list,user-remove,version,web} ...
.SH DESCRIPTION .SH DESCRIPTION
ArcH linux ReposItory MANager ArcH linux ReposItory MANager
@ -46,6 +46,9 @@ COMMAND
\fBahriman\fR \fI\,aur-search\/\fR \fBahriman\fR \fI\,aur-search\/\fR
search for package search for package
.TP .TP
\fBahriman\fR \fI\,daemon\/\fR
run application as daemon
.TP
\fBahriman\fR \fI\,help\/\fR \fBahriman\fR \fI\,help\/\fR
show help message show help message
.TP .TP
@ -166,6 +169,32 @@ show additional package information
sort field by this field. In case if two packages have the same value of the specified field, they will be always sorted sort field by this field. In case if two packages have the same value of the specified field, they will be always sorted
by name by name
.SH COMMAND \fI\,'ahriman daemon'\/\fR
usage: ahriman daemon [-h] [-i INTERVAL] [--no-aur] [--no-local] [--no-manual] [--no-vcs]
start process which periodically will run update process
.SH OPTIONS \fI\,'ahriman daemon'\/\fR
.TP
\fB\-i\fR \fI\,INTERVAL\/\fR, \fB\-\-interval\fR \fI\,INTERVAL\/\fR
interval between runs in seconds
.TP
\fB\-\-no\-aur\fR
do not check for AUR updates. Implies \-\-no\-vcs
.TP
\fB\-\-no\-local\fR
do not check local packages for updates
.TP
\fB\-\-no\-manual\fR
do not include manual updates
.TP
\fB\-\-no\-vcs\fR
do not check VCS packages
.SH COMMAND \fI\,'ahriman help'\/\fR .SH COMMAND \fI\,'ahriman help'\/\fR
usage: ahriman help [-h] [command] usage: ahriman help [-h] [command]
@ -287,7 +316,7 @@ set status for specified packages. If no packages supplied, service status will
new status new status
.SH COMMAND \fI\,'ahriman patch-add'\/\fR .SH COMMAND \fI\,'ahriman patch-add'\/\fR
usage: ahriman patch-add [-h] [-p PATCH] package variable usage: ahriman patch-add [-h] package variable [patch]
create or update patched PKGBUILD function or variable create or update patched PKGBUILD function or variable
@ -299,9 +328,8 @@ package base
\fBvariable\fR \fBvariable\fR
PKGBUILD variable or function name. If variable is a function, it must end with () PKGBUILD variable or function name. If variable is a function, it must end with ()
.SH OPTIONS \fI\,'ahriman patch-add'\/\fR
.TP .TP
\fB\-p\fR \fI\,PATCH\/\fR, \fB\-\-patch\fR \fI\,PATCH\/\fR \fBpatch\fR
path to file which contains function or variable value. If not set, the value will be read from stdin path to file which contains function or variable value. If not set, the value will be read from stdin
.SH COMMAND \fI\,'ahriman patch-list'\/\fR .SH COMMAND \fI\,'ahriman patch-list'\/\fR

View File

@ -28,6 +28,14 @@ ahriman.application.handlers.clean module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.application.handlers.daemon module
------------------------------------------
.. automodule:: ahriman.application.handlers.daemon
:members:
:no-undoc-members:
:show-inheritance:
ahriman.application.handlers.dump module ahriman.application.handlers.dump module
---------------------------------------- ----------------------------------------