Document new flags

This commit is contained in:
morganamilo 2018-06-11 19:38:53 +01:00
parent 01fa34093f
commit d0bc1d70d9
No known key found for this signature in database
GPG key ID: 6FE9E7996B0B082E
2 changed files with 56 additions and 2 deletions

10
cmd.go
View file

@ -58,11 +58,19 @@ Permanent configuration options:
--requestsplitn <n> Max amount of packages to query per AUR request --requestsplitn <n> Max amount of packages to query per AUR request
--sortby <field> Sort AUR results by a specific field during search --sortby <field> Sort AUR results by a specific field during search
--answerclean <a> Set a predetermined answer for the clean build menu --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 --answeredit <a> Set a predetermined answer for the edit pkgbuild menu
--answerupgrade <a> Set a predetermined answer for the upgrade menu --answerupgrade <a> Set a predetermined answer for the upgrade menu
--noanswerclean Unset the answer for the clean build menu --noanswerclean Unset the answer for the clean build menu
--noanswerdiff Unset the answer for the edit diff menu
--noansweredit Unset the answer for the edit pkgbuild menu --noansweredit Unset the answer for the edit pkgbuild menu
--noanswerupgrade Unset the answer for the upgrade menu --noanswerupgrade Unset the answer for the upgrade menu
--cleanmenu Give the option to clean build PKGBUILDS
--diffmenu Give the option to show diffs for build files
--editmenu Give the option to edit/view PKGBUILDS
--nocleanmenu Don't clean build PKGBUILDS
--nodiffmenu Don't show diffs for build files
--noeditmenu Don't edit/view PKGBUILDS
--afterclean Remove package sources after successful install --afterclean Remove package sources after successful install
--noafterclean Do not remove package sources after successful build --noafterclean Do not remove package sources after successful build
@ -73,8 +81,6 @@ Permanent configuration options:
--nodevel Do not check development packages --nodevel Do not check development packages
--gitclone Use git clone for PKGBUILD retrieval --gitclone Use git clone for PKGBUILD retrieval
--nogitclone Never use git clone for PKGBUILD retrieval --nogitclone Never use git clone for PKGBUILD retrieval
--showdiffs Show diffs for build files
--noshowdiffs Always show the entire PKGBUILD
--rebuild Always build target packages --rebuild Always build target packages
--rebuildall Always build all AUR packages --rebuildall Always build all AUR packages
--norebuild Skip package build if in cache and up to date --norebuild Skip package build if in cache and up to date

View file

@ -232,6 +232,13 @@ will be used instead of reading from standard input but will be treated exactly
the same when parsed\&. the same when parsed\&.
.RE .RE
.PP .PP
\fB\-\-answerdiff <All|None|Installed|NotInstalled|...>\fR
.RS 4
Set a predetermined answer for the edit diff menu question\&. This answer
will be used instead of reading from standard input but will be treated exactly
the same when parsed\&.
.RE
.PP
\fB\-\-answeredit <All|None|Installed|NotInstalled|...>\fR \fB\-\-answeredit <All|None|Installed|NotInstalled|...>\fR
.RS 4 .RS 4
Set a predetermined answer for the edit pkgbuild menu question\&. This answer Set a predetermined answer for the edit pkgbuild menu question\&. This answer
@ -251,6 +258,11 @@ reading from standard input but will be treated exactly the same\&.
Unset the answer for the clean build menu\&. Unset the answer for the clean build menu\&.
.RE .RE
.PP .PP
\fB\-\-noanswerdiff\fR
.RS 4
Unset the answer for the diff menu\&.
.RE
.PP
\fB\-\-noansweredit\fR \fB\-\-noansweredit\fR
.RS 4 .RS 4
Unset the answer for the edit pkgbuild menu\&. Unset the answer for the edit pkgbuild menu\&.
@ -261,6 +273,42 @@ Unset the answer for the edit pkgbuild menu\&.
Unset the answer for the upgrade menu\&. Unset the answer for the upgrade menu\&.
.RE .RE
.PP .PP
\fB\-\-cleanmenu\fR
.RS 4
Show the clean menu\&. This menu gives you the chance to fully delete the
downloaded build files from Yay's cache before redownloing a fresh copy\&.
.RE
.PP
\fB\-\-diffmenu\fR
.RS 4
Show the diff menu\&. This menu gives you the option to view diffs from
build files before building\&.
.RE
.PP
\fB\-\-editmenu\fR
.RS 4
Show the edit menu\&. This menu gives you the option to edit or view PKGBUILDs
before building\&.
\fBWarning\fR: Yay resolves dependencies ahead of time via the RPC\&. It is not
recommended to edit pkgbuild variables unless you know what you are doing\&.
.RE
.PP
\fB\-\-nocleanmenu\fR
.RS 4
Do not show the clean menu\&.
.RE
.PP
\fB\-\-nodiffmenu\fR
.RS 4
Do not show the diff menu\&.
.RE
.PP
\fB\-\-noeditmenu\fR
.RS 4
Do not show the edit menu\&.
.RE
.PP
\fB\-\-topdown\fR \fB\-\-topdown\fR
.RS 4 .RS 4
Display repository packages first and then AUR packages\&. Display repository packages first and then AUR packages\&.