Update documentation

This commit is contained in:
morganamilo 2019-10-21 15:02:38 +01:00
parent 169d0a07fc
commit 3baf2e1ff1
No known key found for this signature in database
GPG key ID: 6FE9E7996B0B082E
2 changed files with 36 additions and 0 deletions

4
cmd.go
View file

@ -45,6 +45,7 @@ Permanent configuration options:
--aururl <url> Set an alternative AUR URL
--builddir <dir> Directory used to download and run PKGBUILDS
--absdir <dir> Directory used to store downloads from the ABS
--editor <file> Editor to use when editing PKGBUILDs
--editorflags <flags> Pass arguments to editor
--makepkg <file> makepkg command to use
@ -62,6 +63,7 @@ Permanent configuration options:
--requestsplitn <n> Max amount of packages to query per AUR request
--completioninterval <n> Time in days to to refresh completion cache
--sortby <field> Sort AUR results by a specific field during search
--searchby <field> Search for packages using a specified field
--answerclean <a> Set a predetermined answer for the clean build menu
--answerdiff <a> Set a predetermined answer for the diff menu
--answeredit <a> Set a predetermined answer for the edit pkgbuild menu
@ -106,6 +108,8 @@ Permanent configuration options:
--nouseask Confirm conflicts manually during the install
--combinedupgrade Refresh then perform the repo and AUR upgrade together
--nocombinedupgrade Perform the repo upgrade and AUR upgrade separately
--batchinstall Build multiple AUR packages then install them together
--nobatchinstall Build and install each AUR package one by one
--sudoloop Loop sudo calls in the background to avoid timeout
--nosudoloop Do not loop sudo calls in the background

View file

@ -153,6 +153,11 @@ to use https://aur.tuna.tsinghua.edu.cn/.
Directory to use for Building AUR Packages. This directory is also used as
the AUR cache when deciding if Yay should skip builds.
.TP
.B \-\-absdir <dir>
Directory used to store downloads from the ABS. During \-G, the PKGBUILD
placed in the current dir symlinks to absdir.
.TP
.B \-\-editor <command>
Editor to use when editing PKGBUILDs. If this is not set the \fBEDITOR\fR
@ -221,6 +226,10 @@ cache to never be refreshed.
.B \-\-sortby <votes|popularity|id|baseid|name|base|submitted|modified>
Sort AUR results by a specific field during search.
.TP
.B \-\-searchby <name|name-desc|maintainer|depends|checkdepends|makedepends|optdepends>
Search for AUR packages by querying the specified field.
.TP
.B \-\-answerclean <All|None|Installed|NotInstalled|...>
Set a predetermined answer for the clean build menu question. This answer
@ -447,6 +456,17 @@ During sysupgrade, Pacman \-Syu will be called, then the AUR upgrade will
start. This means the upgrade menu and pkgbuild review will be performed
after the sysupgrade has finished.
.TP
.B \-\-batchinstall
When building and installing AUR packages instead of installing each package
after building, queue each package for install. Then once either all packages
are built or a package in the build queue is needed as a dependnecy to build
another package, install all the packages in the install queue.
.TP
.B \-\-nobatchinstall
Always install AUR packages immediately after building them.
.TP
.B \-\-rebuild
Always build target packages even when a copy is available in cache.
@ -532,6 +552,18 @@ Shows statistics for installed packages and system health.
pacman -Qmq | grep -Ee '-(cvs|svn|git|hg|bzr|darcs)$' | yay -S --needed -
pacaur-like devel check.
.SH ENVIRONMENT VARIABLES
.TP
.B AURDEST
Can be set to configure the build directory.
Overridden by \-\-builddir.
.TP
.B VISUAL, EDITOR
When editor is not configured, use these variables to pick what editor
to use when editing PKGBUILDS.
.SH FILES
.TP
.B CONFIG DIRECTORY