man1/aur-pkglist.1

   1 .TH AUR.PKGLIST 1 2022-09-13 AURUTILS
   2 .SH NAME
   3 aur\-pkglist \- retrieve AUR metadata archives
   4 .
   5 .SH SYNOPSIS
   6 .SY "aur pkglist"
   7 .OP \-bQiq
   8 .OP \-t ttl
   9 .YS
  10 .
  11 .SH DESCRIPTION
  12 .B aur\-pkglist
  13 retrieves metadata archives from the AUR, stored as
  14 .BR git (1)
  15 repositories. The archives include an array of package names
  16 .RB ( pkgnames.git/pkgname.json ),
  17 AUR users
  18 .RB ( users.git/users.json ),
  19 and
  20 package bases
  21 .RB ( pkgbases.git/pkgbase.json ).
  22 Other metadata is available through
  23 .RB ( metadata.git/pkgname.json ,
  24 .BR metadata.git/pkgbase.json ).
  25 .PP
  26 See
  27 .B doc/git\-archive.md
  28 in the
  29 .B aurweb
  30 source tree for detailed information on these formats.
  31 .PP
  32 .B aur\-pkglist
  33 defaults to retrieving
  34 .BR pkgnames.git/pkgname.json .
  35 .
  36 .SH OPTIONS
  37 .TP
  38 .BR \-b ", " \-\-pkgbase
  39 Retrieve
  40 .BR pkgbases.git/pkgbase.json .
  41 .
  42 .TP
  43 .BR \-n ", " \-\-pkgname
  44 Retrieve
  45 .BR pkgnames.git/pkgname.json .
  46 This is the default.
  47 .
  48 .TP
  49 .B \-\-users
  50 Retrieve
  51 .BR users.git/users.json .
  52 .
  53 .TP
  54 .BR \-i ", " \-\-info
  55 Retrieve
  56 .BR metadata.git/pkgname.json .
  57 .
  58 .TP
  59 .BR \-\-info\-pkgbase
  60 Retrieve
  61 .BR metadata.git/pkgbase.json .
  62 .
  63 .TP
  64 .BR \-\-plain
  65 When retrieving
  66 .BR pkgname.json ,
  67 .BR pkgbase.json
  68 or
  69 .BR users.json ,
  70 print each entry separated by a newline.
  71 .
  72 .SS List retrieval options
  73 .TP
  74 .BR \-q ", " \-u ", " \-\-quiet
  75 Update the package list and print its path to standard output.
  76 .
  77 .TP
  78 .BR \-Q ", " \-\-systime
  79 Use the system clock when verifying the list modification date (see
  80 .BR \-\-time ).
  81 This option should only be used when the clock is synchronized, for example with
  82 NTP. If this option is not specified, new revisions are retrieved with
  83 .BR git\-fetch (1)
  84 on every call of
  85 .BR aur\-pkglist .
  86 .
  87 .TP
  88 .BR \-t ", " \-\-ttl
  89 A positive integer specifying the delay in seconds for retrieving list upgrades with
  90 .BR \-\-systime .
  91 A negative integer skips upgrades, regardless of
  92 .BR \-\-systime .
  93 Defaults to
  94 .B 600
  95 seconds.
  96 .PP
  97 New lists are generated by the AUR every 10 to 15 minutes. Setting smaller
  98 intervals with
  99 .B \-t
 100 will thus not give any new results.
 101 .
 102 .TP
 103 .BR \-\-gc
 104 Run
 105 .B git\-gc \-\-aggressive
 106 after updating metadata archives.
 107 .
 108 .SH ENVIRONMENT
 109 .TP
 110 .B AUR_LOCATION
 111 The URI of the AUR endpoint. Defaults to
 112 .IR https://\:aur.archlinux.org .
 113 .
 114 .TP
 115 .B AUR_ARCHIVE
 116 The parent URI for metadata archives. Defaults to the value of
 117 .IR AUR_LOCATION .
 118 .
 119 .TP
 120 .B AUR_ARCHIVE_ROOT
 121 The parent directory where metadata archives are stored. Defaults to
 122 .IR $XDG_STATE_HOME/aurweb\-archive .
 123 .
 124 .TP
 125 .B GIT_HTTP_USER_AGENT
 126 This variable is set to
 127 .BR aurutils .
 128 .
 129 .SH NOTES
 130 To improve performance of archive updates,
 131 .B prefetch
 132 tasks can be run periodically. Similarly, disk usage can be decreased with
 133 .B gc
 134 tasks. See
 135 .BR git\-maintenance (1)
 136 for details. Alternatively,
 137 .BR git\-fetch can be run periodically with
 138 .BR \-\-systime .
 139 This option assumes a correctly configured (NTP-synchronized) clock.
 140 .PP
 141 The following threads provide more background on the AUR metadata archives:
 142 .PP
 143 .UR https://\:gitlab.archlinux.org/\:archlinux/\:aurweb/\:-/\:issues/\:172
 144 RFC for new AUR Metadata Archives format + diffs
 145 .UE ,
 146 .PP
 147 .UR https://lists.archlinux.org/pipermail/aur-general/2021-November/036659.html
 148 [aur\-general] New AUR Metadata Archives
 149 .UE ,
 150 .PP
 151 .UR https://\:lists.archlinux.org/\:pipermail/\:aur-dev/\:2016-May/\:004036.html
 152 [aur\-dev] Making the package list more useful
 153 .UE .
 154 .
 155 .SH SEE ALSO
 156 .ad l
 157 .nh
 158 .BR aur (1),
 159 .BR aur\-query (1),
 160 .BR git\-fetch (1),
 161 .BR git\-merge (1),
 162 .BR git\-pull (1)
 163 .
 164 .SH AUTHORS
 165 .MT https://github.com/AladW
 166 Alad Wenter
 167 .ME
 168 .
 169 .\" vim: set textwidth=72: