system/yay
system/yay
1
0
Fork 0
mirror of https://github.com/Jguer/yay synced 2024-10-31 04:12:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update man page

Browse source
This commit is contained in:
morganamilo 2018-06-04 20:00:01 +01:00
parent 63509365c1
commit 6c22d5987c
No known key found for this signature in database
GPG key ID: 6FE9E7996B0B082E
1 changed files with 78 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
doc/yay.8
View file

@ -1,5 +1,5 @@
'\" t '\" t
.TH "YAY" "8" "2018-02-29" "Yay v3\&.460+" "Yay Manual" .TH "YAY" "8" "2018\-06\-04" "Yay v6\&.784+" "Yay Manual"
.nh .nh
.ad l .ad l
.SH "NAME" .SH "NAME"
@ -20,29 +20,29 @@ This manpage only covers options unique to Yay\&. For other options see
\fBpacman(8)\fR\&. \fBpacman(8)\fR\&.
.SH "YAY OPERATIONS" .SH "YAY OPERATIONS"
.PP .PP
\fB\-Y, --yay\fR \fB\-Y, \-\-yay\fR
.RS 4 .RS 4
Perform yay specific operations\&. This is the default if no other operation is Perform yay specific operations\&. This is the default if no other operation is
selected\&. selected\&.
.RE .RE
.PP .PP
\fB\-P, --print\fR \fB\-P, \-\-print\fR
.RS 4 .RS 4
Perform yay specific print operations\&. Perform yay specific print operations\&.
.RE .RE
.PP .PP
\fB\-G, --getpkgbuild\fR \fB\-G, \-\-getpkgbuild\fR
.RS 4 .RS 4
Downloads PKGBUILD from ABS or AUR\&. Downloads PKGBUILD from ABS or AUR\&.
.RE .RE
.PP .PP
If no arguments are provided 'yay -Syu' will be performed\&. If no arguments are provided 'yay \-Syu' will be performed\&.
.RE .RE
.PP .PP
If no operation is selected -Y will be assumed\&. If no operation is selected \-Y will be assumed\&.
.SH "EXTENDED PACMAN OPERATIONS" .SH "EXTENDED PACMAN OPERATIONS"
.PP .PP
\fB\-S, -Si, -Ss, -Su, -Sc, -Qu\fR \fB\-S, \-Si, \-Ss, \-Su, \-Sc, \-Qu\fR
.RS 4 .RS 4
These operations are extended to support both AUR and repo packages\&. These operations are extended to support both AUR and repo packages\&.
.RE .RE
@ -58,9 +58,23 @@ sources or built packages but will keep already downloaded vcs sources\&.
\fB\-R\fR \fB\-R\fR
.RS 4 .RS 4
Yay will also remove cached data about devel packages\&. Yay will also remove cached data about devel packages\&.
.RE .RE
.SH "YAY OPTIONS (APPLY TO -Y AND --YAY)" .SH "NEW OPTIONS"
.PP
\fB \-\-repo\fR
.RS 4
Assume all targets are from the repositories\&. Aditionally Actions such as
sysupgrade will only act on repository packages\&.
.RE
\fB\-a \-\-aur\fR
.RS 4
Assume all targets are from the AUR\&. Aditionally Actions such as
sysupgrade will only act on AUR packages\&.
Note that dependency resolving will still act as normal and include repository
packages\&.
.RE
.SH "YAY OPTIONS (APPLY TO \-Y AND \-\-YAY)"
.PP .PP
\fB<NO OPTION>\fR \fB<NO OPTION>\fR
.RS 4 .RS 4
@ -80,7 +94,7 @@ used when migrating to Yay from another AUR helper.
.RS 4 .RS 4
Remove unneeded dependencies\&. Remove unneeded dependencies\&.
.RE .RE
.SH "PRINT OPTIONS (APPLY TO -P AND --PRINT)" .SH "PRINT OPTIONS (APPLY TO \-P AND \-\-PRINT)"
\fB\-c \-\-complete\fR \fB\-c \-\-complete\fR
.RS 4 .RS 4
Print a list of all AUR and repo packages\&. This is to allow shell completion Print a list of all AUR and repo packages\&. This is to allow shell completion
@ -105,30 +119,30 @@ Print current yay configuration\&.
\fB\-n \-\-numberupgrades\fR \fB\-n \-\-numberupgrades\fR
.RS 4 .RS 4
Print number of packages that need to be updated\&. Note this does not perform Print number of packages that need to be updated\&. Note this does not perform
a database refresh\&. Run \fByay -Sy\fR Before this for an up to date result\&. a database refresh\&. Run \fByay \-Sy\fR Before this for an up to date result\&.
.RE .RE
.PP .PP
\fB\-s \-\-stats\fR \fB\-s \-\-stats\fR
.RS 4 .RS 4
Displays information about installed packages and system health\&. If there are Displays information about installed packages and system health\&. If there are
orphaned, out-of-date or packages that no longer exist on the AUR warnings will orphaned, out\-of\-date or packages that no longer exist on the AUR warnings will
be displayed\&. be displayed\&.
.RE .RE
.PP .PP
\fB\-u \-\-upgrades\fR \fB\-u \-\-upgrades\fR
.RS 4 .RS 4
Print Names of packages that need to be updated\&. Note this does not perform Print Names of packages that need to be updated\&. Note this does not perform
a database refresh\&. Run \fByay -Sy\fR Before this for an up to date result\&. a database refresh\&. Run \fByay \-Sy\fR Before this for an up to date result\&.
.RE .RE
.PP .PP
\fB\-w --news\fR \fB\-w \-\-news\fR
.RS 4 .RS 4
Print new news from the Archlinux homepage\&. News is considered new if it is Print new news from the Archlinux homepage\&. News is considered new if it is
newer than the build date of all native packages\&. Pass this twice to show all newer than the build date of all native packages\&. Pass this twice to show all
avaliable news\&. avaliable news\&.
.RE .RE
.PP .PP
\fB\-q --quiet\fR \fB\-q \-\-quiet\fR
.RS 4 .RS 4
Only show titles when printing news\&. Only show titles when printing news\&.
.RE .RE
@ -271,9 +285,9 @@ Do not check for development packages updates during sysupgrade\&.
\fB\-\-gitclone\fR \fB\-\-gitclone\fR
.RS 4 .RS 4
Use git to download and update PKGBUILDs\&. PKGBUILDs previously downloaded Use git to download and update PKGBUILDs\&. PKGBUILDs previously downloaded
using tarball will continue to use tarballs until the package is clean built\&. using tarball will continue to use tarballs until the package is clean
Similarly, PKGBUILDs managed with git will continue to use git until the package built\&. Similarly, PKGBUILDs managed with git will continue to use git until
is clean built.\&. the package is clean built.\&.
.RE .RE
.PP .PP
\fB\-\-nogitclone\fR \fB\-\-nogitclone\fR
@ -282,6 +296,18 @@ Download and update PKGBUILDs using tarballs\&. The above conditions about
previously installed packages still apply\&. previously installed packages still apply\&.
.RE .RE
.PP .PP
\fB\-\-showdiffs\fR
.RS 4
Show diffs for build files\&. Diffs are shown via \fBgit diff\fR which uses
less by default\&. This behaviour can be changed via git's config, the
\fB$GIT_PAGER\fR or \fB$PAGER\fR environment variables\&.
.RE
.PP
\fB\-\-noshowdiffs\fR
.RS 4
Show diffs for build files\&. Files will be opened by the editor\%.
.RE
.PP
\fB\-\-afterclean\fR \fB\-\-afterclean\fR
.RS 4 .RS 4
Remove package sources after successful Install\&. Remove package sources after successful Install\&.
@ -320,6 +346,32 @@ When downloading pkgbuilds if the pkgbuild is found in cache and is equal or
newer than the AUR's version use that instead of downloading a new one\&. newer than the AUR's version use that instead of downloading a new one\&.
.RE .RE
.PP .PP
\fB\-\-provides\fR
.RS 4
Look for matching providers when searching for AUR packages\&. When multiple
providers are found a menu will appear prompting you to pick one\&. This
increases dependency resolve time although this should not be noticable\&.
.RE
.PP
\fB\-\-noprovides\fR
.RS 4
Do not look for matching providers when searching for AUR packages\&. If
multiple providers happen to be found the menu will still apear\&.
.RE
.PP
\fB\-\-pgpfetch\fR
.RS 4
Prompt to import unknown PGP keys from the \fBvalidpgpkeys\fR field of each
PKGBUILD.
.RE
.PP
\fB\-\-pgpfetch\fR
.RS 4
Do not prompt to import unknown PGP keys\&. This is likley to cause a build
failiure unless using options such as \fB\-\-skippgpcheck\fR or a customized
gpg config\%.
.RE
.PP
\fB\-\-rebuild\fR \fB\-\-rebuild\fR
.RS 4 .RS 4
Always build target packages even when a copy is available in cache\&. Always build target packages even when a copy is available in cache\&.
@ -378,37 +430,37 @@ yay \fIfoo\fR
Search and install from the repos and the \fBAUR\fR\ using yogurt mode\&. Search and install from the repos and the \fBAUR\fR\ using yogurt mode\&.
.RE .RE
.PP .PP
yay -Syu yay \-Syu
.RS 4 .RS 4
Update package list and upgrade all currently installed repo and \fBAUR\fR\&. Update package list and upgrade all currently installed repo and \fBAUR\fR\&.
.RE .RE
.PP .PP
yay -S \fIfoo\fR yay \-S \fIfoo\fR
.RS 4 .RS 4
Installs package \fIfoo\fR from the repos or the \fBAUR\fR\&. Installs package \fIfoo\fR from the repos or the \fBAUR\fR\&.
.RE .RE
.PP .PP
yay -Ss \fIfoo\fR yay \-Ss \fIfoo\fR
.RS 4 .RS 4
Searches for package \fIfoo\fR on the repos or the \fBAUR\fR\&. Searches for package \fIfoo\fR on the repos or the \fBAUR\fR\&.
.RE .RE
.PP .PP
yay -Si \fIfoo\fR yay \-Si \fIfoo\fR
.RS 4 .RS 4
Gets information about package \fIfoo\fR from the repos or the \fBAUR\fR\&. Gets information about package \fIfoo\fR from the repos or the \fBAUR\fR\&.
.RE .RE
.PP .PP
yay -S \fIfoo\fR --mflags "--skipchecksums --skippgpcheck" yay \-S \fIfoo\fR \-\-mflags "\-\-skipchecksums \-\-skippgpcheck"
.RS 4 .RS 4
Installs \fIfoo\fR while skipping checksums and pgp checks\&. Installs \fIfoo\fR while skipping checksums and pgp checks\&.
.RE .RE
.PP .PP
yay --devel --save yay \-\-devel \-\-save
.RS 4 .RS 4
Sets devel to true in the config\&. Sets devel to true in the config\&.
.RE .RE
.PP .PP
yay -P --stats yay \-P \-\-stats
.RS 4 .RS 4
Shows statistics for installed packages and system health\&. Shows statistics for installed packages and system health\&.
.RE .RE
@ -448,7 +500,7 @@ and built packages from those packages\&.
\fBPACMAN.CONF\fR \fBPACMAN.CONF\fR
.RS 4 .RS 4
Yay uses Pacman's config file to set certain pacman options either through Yay uses Pacman's config file to set certain pacman options either through
go-alpm or Yay itself. Options inherited include most libalpm options and go\-alpm or Yay itself. Options inherited include most libalpm options and
pacman options\&. pacman options\&.
.PP .PP
Notably \fBDatabases\fR, \fBColor\fR and \fB*Path/*Dir\fR options are used\&. Notably \fBDatabases\fR, \fBColor\fR and \fB*Path/*Dir\fR options are used\&.