From 233dda84202f1a400429a08fddd6012f00bebc75 Mon Sep 17 00:00:00 2001 From: Evgeniy Alekseev Date: Thu, 10 Nov 2022 20:10:07 +0200 Subject: [PATCH] man update --- docs/ahriman.1 | 338 ++++++++++++++++++++++++++----------------------- 1 file changed, 182 insertions(+), 156 deletions(-) diff --git a/docs/ahriman.1 b/docs/ahriman.1 index 4ef18898..bccbe17f 100644 --- a/docs/ahriman.1 +++ b/docs/ahriman.1 @@ -1,9 +1,9 @@ -.TH AHRIMAN "1" Manual +.TH AHRIMAN "1" "2022\-11\-10" "ahriman" "Generated Python Manual" .SH NAME ahriman .SH SYNOPSIS .B ahriman -[-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} ... +[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--report | --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 ArcH linux ReposItory MANager @@ -25,8 +25,8 @@ force run, remove file lock lock file .TP -\fB\-\-no\-report\fR -force disable reporting to web service +\fB\-\-report\fR, \fB\-\-no\-report\fR +force enable or disable reporting to web service (default: True) .TP \fB\-q\fR, \fB\-\-quiet\fR @@ -43,7 +43,7 @@ show program's version number and exit .SH COMMAND .TP -\fBahriman\fR \fI\,aur-search\/\fR +\fBahriman\fR \fI\,aur\-search\/\fR search for package .TP \fBahriman\fR \fI\,daemon\/\fR @@ -52,91 +52,91 @@ run application as daemon \fBahriman\fR \fI\,help\/\fR show help message .TP -\fBahriman\fR \fI\,help-commands-unsafe\/\fR +\fBahriman\fR \fI\,help\-commands\-unsafe\/\fR list unsafe commands .TP -\fBahriman\fR \fI\,key-import\/\fR +\fBahriman\fR \fI\,key\-import\/\fR import PGP key .TP -\fBahriman\fR \fI\,package-add\/\fR +\fBahriman\fR \fI\,package\-add\/\fR add package .TP -\fBahriman\fR \fI\,package-remove\/\fR +\fBahriman\fR \fI\,package\-remove\/\fR remove package .TP -\fBahriman\fR \fI\,package-status\/\fR +\fBahriman\fR \fI\,package\-status\/\fR get package status .TP -\fBahriman\fR \fI\,package-status-remove\/\fR +\fBahriman\fR \fI\,package\-status\-remove\/\fR remove package status .TP -\fBahriman\fR \fI\,package-status-update\/\fR +\fBahriman\fR \fI\,package\-status\-update\/\fR update package status .TP -\fBahriman\fR \fI\,patch-add\/\fR +\fBahriman\fR \fI\,patch\-add\/\fR add patch for PKGBUILD function .TP -\fBahriman\fR \fI\,patch-list\/\fR +\fBahriman\fR \fI\,patch\-list\/\fR list patch sets .TP -\fBahriman\fR \fI\,patch-remove\/\fR +\fBahriman\fR \fI\,patch\-remove\/\fR remove patch set .TP -\fBahriman\fR \fI\,patch-set-add\/\fR +\fBahriman\fR \fI\,patch\-set\-add\/\fR add patch set .TP -\fBahriman\fR \fI\,repo-backup\/\fR +\fBahriman\fR \fI\,repo\-backup\/\fR backup repository data .TP -\fBahriman\fR \fI\,repo-check\/\fR +\fBahriman\fR \fI\,repo\-check\/\fR check for updates .TP -\fBahriman\fR \fI\,repo-clean\/\fR +\fBahriman\fR \fI\,repo\-clean\/\fR clean local caches .TP -\fBahriman\fR \fI\,repo-config\/\fR +\fBahriman\fR \fI\,repo\-config\/\fR dump configuration .TP -\fBahriman\fR \fI\,repo-rebuild\/\fR +\fBahriman\fR \fI\,repo\-rebuild\/\fR rebuild repository .TP -\fBahriman\fR \fI\,repo-remove-unknown\/\fR +\fBahriman\fR \fI\,repo\-remove\-unknown\/\fR remove unknown packages .TP -\fBahriman\fR \fI\,repo-report\/\fR +\fBahriman\fR \fI\,repo\-report\/\fR generate report .TP -\fBahriman\fR \fI\,repo-restore\/\fR +\fBahriman\fR \fI\,repo\-restore\/\fR restore repository data .TP -\fBahriman\fR \fI\,repo-setup\/\fR +\fBahriman\fR \fI\,repo\-setup\/\fR initial service configuration .TP -\fBahriman\fR \fI\,repo-sign\/\fR +\fBahriman\fR \fI\,repo\-sign\/\fR sign packages .TP -\fBahriman\fR \fI\,repo-status-update\/\fR +\fBahriman\fR \fI\,repo\-status\-update\/\fR update repository status .TP -\fBahriman\fR \fI\,repo-sync\/\fR +\fBahriman\fR \fI\,repo\-sync\/\fR sync repository .TP -\fBahriman\fR \fI\,repo-triggers\/\fR +\fBahriman\fR \fI\,repo\-triggers\/\fR run triggers .TP -\fBahriman\fR \fI\,repo-update\/\fR +\fBahriman\fR \fI\,repo\-update\/\fR update packages .TP \fBahriman\fR \fI\,shell\/\fR envoke python shell .TP -\fBahriman\fR \fI\,user-add\/\fR +\fBahriman\fR \fI\,user\-add\/\fR create or update user .TP -\fBahriman\fR \fI\,user-list\/\fR +\fBahriman\fR \fI\,user\-list\/\fR user known users and their access .TP -\fBahriman\fR \fI\,user-remove\/\fR +\fBahriman\fR \fI\,user\-remove\/\fR remove user .TP \fBahriman\fR \fI\,version\/\fR @@ -144,9 +144,10 @@ application version .TP \fBahriman\fR \fI\,web\/\fR web server -.SH COMMAND \fI\,'ahriman aur-search'\/\fR -usage: ahriman aur-search [-h] [-e] [-i] - [--sort-by {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,url,url_path,version}] + +.SH COMMAND \fI\,'ahriman aur\-search'\/\fR +usage: ahriman aur\-search [\-h] [\-e] [\-\-info | \-\-no\-info] + [\-\-sort\-by {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,url,url_path,version}] search [search ...] search for package in AUR using API @@ -155,14 +156,14 @@ search for package in AUR using API \fBsearch\fR search terms, can be specified multiple times, result will match all terms -.SH OPTIONS \fI\,'ahriman aur-search'\/\fR +.SH OPTIONS \fI\,'ahriman aur\-search'\/\fR .TP \fB\-e\fR, \fB\-\-exit\-code\fR return non\-zero exit status if result is empty .TP -\fB\-i\fR, \fB\-\-info\fR -show additional package information +\fB\-\-info\fR, \fB\-\-no\-info\fR +show additional package information (default: False) .TP \fB\-\-sort\-by\fR \fI\,{description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,url,url_path,version}\/\fR @@ -170,7 +171,8 @@ sort field by this field. In case if two packages have the same value of the spe by name .SH COMMAND \fI\,'ahriman daemon'\/\fR -usage: ahriman daemon [-h] [-i INTERVAL] [--no-aur] [--no-local] [--no-manual] [--no-vcs] +usage: ahriman daemon [\-h] [\-i INTERVAL] [\-\-aur | \-\-no\-aur] [\-\-local | \-\-no\-local] [\-\-manual | \-\-no\-manual] + [\-\-vcs | \-\-no\-vcs] [\-y] start process which periodically will run update process @@ -180,23 +182,27 @@ start process which periodically will run update process interval between runs in seconds .TP -\fB\-\-no\-aur\fR -do not check for AUR updates. Implies \-\-no\-vcs +\fB\-\-aur\fR, \fB\-\-no\-aur\fR +enable or disable checking for AUR updates. Implies \-\-no\-vcs (default: True) .TP -\fB\-\-no\-local\fR -do not check local packages for updates +\fB\-\-local\fR, \fB\-\-no\-local\fR +enable or disable checking of local packages for updates (default: True) .TP -\fB\-\-no\-manual\fR -do not include manual updates +\fB\-\-manual\fR, \fB\-\-no\-manual\fR +include or exclude manual updates (default: True) .TP -\fB\-\-no\-vcs\fR -do not check VCS packages +\fB\-\-vcs\fR, \fB\-\-no\-vcs\fR +enable or disable checking of VCS packages (default: True) + +.TP +\fB\-y\fR, \fB\-\-refresh\fR +download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date .SH COMMAND \fI\,'ahriman help'\/\fR -usage: ahriman help [-h] [command] +usage: ahriman help [\-h] [command] show help message for application or command and exit @@ -204,19 +210,19 @@ show help message for application or command and exit \fBcommand\fR show help message for specific command -.SH COMMAND \fI\,'ahriman help-commands-unsafe'\/\fR -usage: ahriman help-commands-unsafe [-h] [--command COMMAND] +.SH COMMAND \fI\,'ahriman help\-commands\-unsafe'\/\fR +usage: ahriman help\-commands\-unsafe [\-h] [\-\-command COMMAND] list unsafe commands as defined in default args -.SH OPTIONS \fI\,'ahriman help-commands-unsafe'\/\fR +.SH OPTIONS \fI\,'ahriman help\-commands\-unsafe'\/\fR .TP \fB\-\-command\fR \fI\,COMMAND\/\fR instead of showing commands, just test command line for unsafe subcommand and return 0 in case if command is safe and 1 otherwise -.SH COMMAND \fI\,'ahriman key-import'\/\fR -usage: ahriman key-import [-h] [--key-server KEY_SERVER] key +.SH COMMAND \fI\,'ahriman key\-import'\/\fR +usage: ahriman key\-import [\-h] [\-\-key\-server KEY_SERVER] key import PGP key from public sources to the repository user @@ -224,14 +230,14 @@ import PGP key from public sources to the repository user \fBkey\fR PGP key to import from public server -.SH OPTIONS \fI\,'ahriman key-import'\/\fR +.SH OPTIONS \fI\,'ahriman key\-import'\/\fR .TP \fB\-\-key\-server\fR \fI\,KEY_SERVER\/\fR key server for key import -.SH COMMAND \fI\,'ahriman package-add'\/\fR -usage: ahriman package-add [-h] [-e] [-n] [-s {auto,archive,aur,directory,local,remote,repository}] - [--without-dependencies] +.SH COMMAND \fI\,'ahriman package\-add'\/\fR +usage: ahriman package\-add [\-h] [\-e] [\-n] [\-y] [\-s {auto,archive,aur,directory,local,remote,repository}] + [\-\-without\-dependencies] package [package ...] add existing or new package to the build queue @@ -240,7 +246,7 @@ add existing or new package to the build queue \fBpackage\fR package source (base name, path to local files, remote URL) -.SH OPTIONS \fI\,'ahriman package-add'\/\fR +.SH OPTIONS \fI\,'ahriman package\-add'\/\fR .TP \fB\-e\fR, \fB\-\-exit\-code\fR return non\-zero exit status if result is empty @@ -249,6 +255,10 @@ return non\-zero exit status if result is empty \fB\-n\fR, \fB\-\-now\fR run update function after +.TP +\fB\-y\fR, \fB\-\-refresh\fR +download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date + .TP \fB\-s\fR \fI\,{auto,archive,aur,directory,local,remote,repository}\/\fR, \fB\-\-source\fR \fI\,{auto,archive,aur,directory,local,remote,repository}\/\fR explicitly specify the package source for this command @@ -257,8 +267,8 @@ explicitly specify the package source for this command \fB\-\-without\-dependencies\fR do not add dependencies -.SH COMMAND \fI\,'ahriman package-remove'\/\fR -usage: ahriman package-remove [-h] package [package ...] +.SH COMMAND \fI\,'ahriman package\-remove'\/\fR +usage: ahriman package\-remove [\-h] package [package ...] remove package from the repository @@ -266,8 +276,8 @@ remove package from the repository \fBpackage\fR package name or base -.SH COMMAND \fI\,'ahriman package-status'\/\fR -usage: ahriman package-status [-h] [--ahriman] [-e] [-i] [-s {unknown,pending,building,failed,success}] [package ...] +.SH COMMAND \fI\,'ahriman package\-status'\/\fR +usage: ahriman package\-status [\-h] [\-\-ahriman] [\-e] [\-i] [\-s {unknown,pending,building,failed,success}] [package ...] request status of the package @@ -275,7 +285,7 @@ request status of the package \fBpackage\fR filter status by package base -.SH OPTIONS \fI\,'ahriman package-status'\/\fR +.SH OPTIONS \fI\,'ahriman package\-status'\/\fR .TP \fB\-\-ahriman\fR get service status itself @@ -292,8 +302,8 @@ show additional package information \fB\-s\fR \fI\,{unknown,pending,building,failed,success}\/\fR, \fB\-\-status\fR \fI\,{unknown,pending,building,failed,success}\/\fR filter packages by status -.SH COMMAND \fI\,'ahriman package-status-remove'\/\fR -usage: ahriman package-status-remove [-h] package [package ...] +.SH COMMAND \fI\,'ahriman package\-status\-remove'\/\fR +usage: ahriman package\-status\-remove [\-h] package [package ...] remove the package from the status page @@ -301,8 +311,8 @@ remove the package from the status page \fBpackage\fR remove specified packages -.SH COMMAND \fI\,'ahriman package-status-update'\/\fR -usage: ahriman package-status-update [-h] [-s {unknown,pending,building,failed,success}] [package ...] +.SH COMMAND \fI\,'ahriman package\-status\-update'\/\fR +usage: ahriman package\-status\-update [\-h] [\-s {unknown,pending,building,failed,success}] [package ...] update package status on the status page @@ -310,13 +320,13 @@ update package status on the status page \fBpackage\fR set status for specified packages. If no packages supplied, service status will be updated -.SH OPTIONS \fI\,'ahriman package-status-update'\/\fR +.SH OPTIONS \fI\,'ahriman package\-status\-update'\/\fR .TP \fB\-s\fR \fI\,{unknown,pending,building,failed,success}\/\fR, \fB\-\-status\fR \fI\,{unknown,pending,building,failed,success}\/\fR new status -.SH COMMAND \fI\,'ahriman patch-add'\/\fR -usage: ahriman patch-add [-h] package variable [patch] +.SH COMMAND \fI\,'ahriman patch\-add'\/\fR +usage: ahriman patch\-add [\-h] package variable [patch] create or update patched PKGBUILD function or variable @@ -332,8 +342,8 @@ PKGBUILD variable or function name. If variable is a function, it must end with \fBpatch\fR 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 -usage: ahriman patch-list [-h] [-e] [-v VARIABLE] [package] +.SH COMMAND \fI\,'ahriman patch\-list'\/\fR +usage: ahriman patch\-list [\-h] [\-e] [\-v VARIABLE] [package] list available patches for the package @@ -341,7 +351,7 @@ list available patches for the package \fBpackage\fR package base -.SH OPTIONS \fI\,'ahriman patch-list'\/\fR +.SH OPTIONS \fI\,'ahriman patch\-list'\/\fR .TP \fB\-e\fR, \fB\-\-exit\-code\fR return non\-zero exit status if result is empty @@ -350,8 +360,8 @@ return non\-zero exit status if result is empty \fB\-v\fR \fI\,VARIABLE\/\fR, \fB\-\-variable\fR \fI\,VARIABLE\/\fR if set, show only patches for specified PKGBUILD variables -.SH COMMAND \fI\,'ahriman patch-remove'\/\fR -usage: ahriman patch-remove [-h] [-v VARIABLE] package +.SH COMMAND \fI\,'ahriman patch\-remove'\/\fR +usage: ahriman patch\-remove [\-h] [\-v VARIABLE] package remove patches for the package @@ -359,14 +369,14 @@ remove patches for the package \fBpackage\fR package base -.SH OPTIONS \fI\,'ahriman patch-remove'\/\fR +.SH OPTIONS \fI\,'ahriman patch\-remove'\/\fR .TP \fB\-v\fR \fI\,VARIABLE\/\fR, \fB\-\-variable\fR \fI\,VARIABLE\/\fR should be used for single\-function patches in case if you wold like to remove only specified PKGBUILD variables. In case if not set, it will remove all patches related to the package -.SH COMMAND \fI\,'ahriman patch-set-add'\/\fR -usage: ahriman patch-set-add [-h] [-t TRACK] package +.SH COMMAND \fI\,'ahriman patch\-set\-add'\/\fR +usage: ahriman patch\-set\-add [\-h] [\-t TRACK] package create or update source patches @@ -374,13 +384,13 @@ create or update source patches \fBpackage\fR path to directory with changed files for patch addition/update -.SH OPTIONS \fI\,'ahriman patch-set-add'\/\fR +.SH OPTIONS \fI\,'ahriman patch\-set\-add'\/\fR .TP \fB\-t\fR \fI\,TRACK\/\fR, \fB\-\-track\fR \fI\,TRACK\/\fR files which has to be tracked -.SH COMMAND \fI\,'ahriman repo-backup'\/\fR -usage: ahriman repo-backup [-h] path +.SH COMMAND \fI\,'ahriman repo\-backup'\/\fR +usage: ahriman repo\-backup [\-h] path backup settings and database @@ -388,8 +398,8 @@ backup settings and database \fBpath\fR path of the output archive -.SH COMMAND \fI\,'ahriman repo-check'\/\fR -usage: ahriman repo-check [-h] [-e] [--no-vcs] [package ...] +.SH COMMAND \fI\,'ahriman repo\-check'\/\fR +usage: ahriman repo\-check [\-h] [\-e] [\-\-vcs | \-\-no\-vcs] [\-y] [package ...] check for packages updates. Same as update \-\-dry\-run \-\-no\-manual @@ -397,48 +407,57 @@ check for packages updates. Same as update \-\-dry\-run \-\-no\-manual \fBpackage\fR filter check by package base -.SH OPTIONS \fI\,'ahriman repo-check'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-check'\/\fR .TP \fB\-e\fR, \fB\-\-exit\-code\fR return non\-zero exit status if result is empty .TP -\fB\-\-no\-vcs\fR -do not check VCS packages +\fB\-\-vcs\fR, \fB\-\-no\-vcs\fR +enable or disable checking of VCS packages (default: True) -.SH COMMAND \fI\,'ahriman repo-clean'\/\fR -usage: ahriman repo-clean [-h] [--cache] [--chroot] [--manual] [--packages] +.TP +\fB\-y\fR, \fB\-\-refresh\fR +download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date + +.SH COMMAND \fI\,'ahriman repo\-clean'\/\fR +usage: ahriman repo\-clean [\-h] [\-\-cache | \-\-no\-cache] [\-\-chroot | \-\-no\-chroot] [\-\-manual | \-\-no\-manual] + [\-\-packages | \-\-no\-packages] [\-\-pacman | \-\-no\-pacman] remove local caches -.SH OPTIONS \fI\,'ahriman repo-clean'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-clean'\/\fR .TP -\fB\-\-cache\fR -clear directory with package caches +\fB\-\-cache\fR, \fB\-\-no\-cache\fR +clear directory with package caches (default: False) .TP -\fB\-\-chroot\fR -clear build chroot +\fB\-\-chroot\fR, \fB\-\-no\-chroot\fR +clear build chroot (default: False) .TP -\fB\-\-manual\fR -clear manually added packages queue +\fB\-\-manual\fR, \fB\-\-no\-manual\fR +clear manually added packages queue (default: False) .TP -\fB\-\-packages\fR -clear directory with built packages +\fB\-\-packages\fR, \fB\-\-no\-packages\fR +clear directory with built packages (default: False) -.SH COMMAND \fI\,'ahriman repo-config'\/\fR -usage: ahriman repo-config [-h] +.TP +\fB\-\-pacman\fR, \fB\-\-no\-pacman\fR +clear directory with pacman local database cache (default: False) + +.SH COMMAND \fI\,'ahriman repo\-config'\/\fR +usage: ahriman repo\-config [\-h] dump configuration for the specified architecture -.SH COMMAND \fI\,'ahriman repo-rebuild'\/\fR -usage: ahriman repo-rebuild [-h] [--depends-on DEPENDS_ON] [--dry-run] [--from-database] [-e] +.SH COMMAND \fI\,'ahriman repo\-rebuild'\/\fR +usage: ahriman repo\-rebuild [\-h] [\-\-depends\-on DEPENDS_ON] [\-\-dry\-run] [\-\-from\-database] [\-e] force rebuild whole repository -.SH OPTIONS \fI\,'ahriman repo-rebuild'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-rebuild'\/\fR .TP \fB\-\-depends\-on\fR \fI\,DEPENDS_ON\/\fR only rebuild packages that depend on specified package @@ -457,27 +476,23 @@ original ahriman instance run with web service and have run repo\-update at leas \fB\-e\fR, \fB\-\-exit\-code\fR return non\-zero exit status if result is empty -.SH COMMAND \fI\,'ahriman repo-remove-unknown'\/\fR -usage: ahriman repo-remove-unknown [-h] [--dry-run] [-i] +.SH COMMAND \fI\,'ahriman repo\-remove\-unknown'\/\fR +usage: ahriman repo\-remove\-unknown [\-h] [\-\-dry\-run] remove packages which are missing in AUR and do not have local PKGBUILDs -.SH OPTIONS \fI\,'ahriman repo-remove-unknown'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-remove\-unknown'\/\fR .TP \fB\-\-dry\-run\fR just perform check for packages without removal -.TP -\fB\-i\fR, \fB\-\-info\fR -show additional package information - -.SH COMMAND \fI\,'ahriman repo-report'\/\fR -usage: ahriman repo-report [-h] +.SH COMMAND \fI\,'ahriman repo\-report'\/\fR +usage: ahriman repo\-report [\-h] generate repository report according to current settings -.SH COMMAND \fI\,'ahriman repo-restore'\/\fR -usage: ahriman repo-restore [-h] [-o OUTPUT] path +.SH COMMAND \fI\,'ahriman repo\-restore'\/\fR +usage: ahriman repo\-restore [\-h] [\-o OUTPUT] path restore settings and database @@ -485,20 +500,20 @@ restore settings and database \fBpath\fR path of the input archive -.SH OPTIONS \fI\,'ahriman repo-restore'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-restore'\/\fR .TP \fB\-o\fR \fI\,OUTPUT\/\fR, \fB\-\-output\fR \fI\,OUTPUT\/\fR root path of the extracted files -.SH COMMAND \fI\,'ahriman repo-setup'\/\fR -usage: ahriman repo-setup [-h] [--build-as-user BUILD_AS_USER] [--build-command BUILD_COMMAND] - [--from-configuration FROM_CONFIGURATION] [--no-multilib] --packager PACKAGER --repository - REPOSITORY [--sign-key SIGN_KEY] [--sign-target {disabled,pacakges,repository}] - [--web-port WEB_PORT] +.SH COMMAND \fI\,'ahriman repo\-setup'\/\fR +usage: ahriman repo\-setup [\-h] [\-\-build\-as\-user BUILD_AS_USER] [\-\-build\-command BUILD_COMMAND] + [\-\-from\-configuration FROM_CONFIGURATION] [\-\-multilib | \-\-no\-multilib] \-\-packager PACKAGER + \-\-repository REPOSITORY [\-\-sign\-key SIGN_KEY] [\-\-sign\-target {disabled,pacakges,repository}] + [\-\-web\-port WEB_PORT] create initial service configuration, requires root -.SH OPTIONS \fI\,'ahriman repo-setup'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-setup'\/\fR .TP \fB\-\-build\-as\-user\fR \fI\,BUILD_AS_USER\/\fR force makepkg user to the specific one @@ -512,8 +527,8 @@ build command prefix path to default devtools pacman configuration .TP -\fB\-\-no\-multilib\fR -do not add multilib repository +\fB\-\-multilib\fR, \fB\-\-no\-multilib\fR +add or do not multilib repository (default: True) .TP \fB\-\-packager\fR \fI\,PACKAGER\/\fR @@ -535,8 +550,8 @@ sign options \fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR port of the web service -.SH COMMAND \fI\,'ahriman repo-sign'\/\fR -usage: ahriman repo-sign [-h] [package ...] +.SH COMMAND \fI\,'ahriman repo\-sign'\/\fR +usage: ahriman repo\-sign [\-h] [package ...] (re\-)sign packages and repository database according to current settings @@ -544,23 +559,23 @@ usage: ahriman repo-sign [-h] [package ...] \fBpackage\fR sign only specified packages -.SH COMMAND \fI\,'ahriman repo-status-update'\/\fR -usage: ahriman repo-status-update [-h] [-s {unknown,pending,building,failed,success}] +.SH COMMAND \fI\,'ahriman repo\-status\-update'\/\fR +usage: ahriman repo\-status\-update [\-h] [\-s {unknown,pending,building,failed,success}] update repository status on the status page -.SH OPTIONS \fI\,'ahriman repo-status-update'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-status\-update'\/\fR .TP \fB\-s\fR \fI\,{unknown,pending,building,failed,success}\/\fR, \fB\-\-status\fR \fI\,{unknown,pending,building,failed,success}\/\fR new status -.SH COMMAND \fI\,'ahriman repo-sync'\/\fR -usage: ahriman repo-sync [-h] +.SH COMMAND \fI\,'ahriman repo\-sync'\/\fR +usage: ahriman repo\-sync [\-h] sync repository files to remote server according to current settings -.SH COMMAND \fI\,'ahriman repo-triggers'\/\fR -usage: ahriman repo-triggers [-h] [trigger ...] +.SH COMMAND \fI\,'ahriman repo\-triggers'\/\fR +usage: ahriman repo\-triggers [\-h] [trigger ...] run triggers on empty build result as configured by settings @@ -568,8 +583,10 @@ run triggers on empty build result as configured by settings \fBtrigger\fR instead of running all triggers as set by configuration, just process specified ones oin order of metion -.SH COMMAND \fI\,'ahriman repo-update'\/\fR -usage: ahriman repo-update [-h] [--dry-run] [-e] [--no-aur] [--no-local] [--no-manual] [--no-vcs] [package ...] +.SH COMMAND \fI\,'ahriman repo\-update'\/\fR +usage: ahriman repo\-update [\-h] [\-\-dry\-run] [\-e] [\-\-aur | \-\-no\-aur] [\-\-local | \-\-no\-local] [\-\-manual | \-\-no\-manual] + [\-\-vcs | \-\-no\-vcs] [\-y] + [package ...] check for packages updates and run build process if requested @@ -577,7 +594,7 @@ check for packages updates and run build process if requested \fBpackage\fR filter check by package base -.SH OPTIONS \fI\,'ahriman repo-update'\/\fR +.SH OPTIONS \fI\,'ahriman repo\-update'\/\fR .TP \fB\-\-dry\-run\fR just perform check for updates, same as check command @@ -587,28 +604,36 @@ just perform check for updates, same as check command return non\-zero exit status if result is empty .TP -\fB\-\-no\-aur\fR -do not check for AUR updates. Implies \-\-no\-vcs +\fB\-\-aur\fR, \fB\-\-no\-aur\fR +enable or disable checking for AUR updates. Implies \-\-no\-vcs (default: True) .TP -\fB\-\-no\-local\fR -do not check local packages for updates +\fB\-\-local\fR, \fB\-\-no\-local\fR +enable or disable checking of local packages for updates (default: True) .TP -\fB\-\-no\-manual\fR -do not include manual updates +\fB\-\-manual\fR, \fB\-\-no\-manual\fR +include or exclude manual updates (default: True) .TP -\fB\-\-no\-vcs\fR -do not check VCS packages +\fB\-\-vcs\fR, \fB\-\-no\-vcs\fR +enable or disable checking of VCS packages (default: True) + +.TP +\fB\-y\fR, \fB\-\-refresh\fR +download fresh package databases from the mirror before actions, \-yy to force refresh even if up to date .SH COMMAND \fI\,'ahriman shell'\/\fR -usage: ahriman shell [-h] +usage: ahriman shell [\-h] [code] drop into python shell while having created application -.SH COMMAND \fI\,'ahriman user-add'\/\fR -usage: ahriman user-add [-h] [--as-service] [-p PASSWORD] [-r {unauthorized,read,reporter,full}] [-s] username +.TP +\fBcode\fR +instead of dropping into shell, just execute the specified code + +.SH COMMAND \fI\,'ahriman user\-add'\/\fR +usage: ahriman user\-add [\-h] [\-\-as\-service] [\-p PASSWORD] [\-r {unauthorized,read,reporter,full}] [\-s] username update user for web services with the given password and role. In case if password was not entered it will be asked interactively @@ -616,7 +641,7 @@ update user for web services with the given password and role. In case if passwo \fBusername\fR username for web service -.SH OPTIONS \fI\,'ahriman user-add'\/\fR +.SH OPTIONS \fI\,'ahriman user\-add'\/\fR .TP \fB\-\-as\-service\fR add user as service user @@ -634,8 +659,8 @@ user access level \fB\-s\fR, \fB\-\-secure\fR set file permissions to user\-only -.SH COMMAND \fI\,'ahriman user-list'\/\fR -usage: ahriman user-list [-h] [-e] [-r {unauthorized,read,reporter,full}] [username] +.SH COMMAND \fI\,'ahriman user\-list'\/\fR +usage: ahriman user\-list [\-h] [\-e] [\-r {unauthorized,read,reporter,full}] [username] list users from the user mapping and their roles @@ -643,7 +668,7 @@ list users from the user mapping and their roles \fBusername\fR filter users by username -.SH OPTIONS \fI\,'ahriman user-list'\/\fR +.SH OPTIONS \fI\,'ahriman user\-list'\/\fR .TP \fB\-e\fR, \fB\-\-exit\-code\fR return non\-zero exit status if result is empty @@ -652,8 +677,8 @@ return non\-zero exit status if result is empty \fB\-r\fR \fI\,{unauthorized,read,reporter,full}\/\fR, \fB\-\-role\fR \fI\,{unauthorized,read,reporter,full}\/\fR filter users by role -.SH COMMAND \fI\,'ahriman user-remove'\/\fR -usage: ahriman user-remove [-h] [-s] username +.SH COMMAND \fI\,'ahriman user\-remove'\/\fR +usage: ahriman user\-remove [\-h] [\-s] username remove user from the user mapping and update the configuration @@ -661,18 +686,18 @@ remove user from the user mapping and update the configuration \fBusername\fR username for web service -.SH OPTIONS \fI\,'ahriman user-remove'\/\fR +.SH OPTIONS \fI\,'ahriman user\-remove'\/\fR .TP \fB\-s\fR, \fB\-\-secure\fR set file permissions to user\-only .SH COMMAND \fI\,'ahriman version'\/\fR -usage: ahriman version [-h] +usage: ahriman version [\-h] print application and its dependencies versions .SH COMMAND \fI\,'ahriman web'\/\fR -usage: ahriman web [-h] +usage: ahriman web [\-h] start web server @@ -682,7 +707,8 @@ Argument list can also be read from file by using @ prefix. .SH AUTHORS .nf ahriman team -.fi.nf +.fi +.nf .fi