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. This includes plain-text lists
  14 of available package names
  15 .RB ( packages.gz ),
  16 AUR users
  17 .RB ( users.gz ),
  18 package bases
  19 .RB ( pkgbase.gz ),
  20 and JSON lists of all available metadata
  21 .RB ( packages-meta-v1.json ,
  22 .BR packages-meta-v1-ext.json ).
  23 The JSON lists either match the output of
  24 .B search
  25 or
  26 .B info
  27 type requests; see
  28 .BR aur\-query (1).
  29 .
  30 .SH OPTIONS
  31 .TP
  32 .BR \-b ", " \-\-pkgbase
  33 Retrieve
  34 .BR pkgbases.git/pkgbase.json .
  35 .
  36 .TP
  37 .BR \-n ", " \-\-pkgname
  38 Retrieve
  39 .BR pkgnames.git/pkgname.json .
  40 This is the default.
  41 .
  42 .TP
  43 .B \-\-users
  44 Retrieve
  45 .BR users.git/users.json .
  46 .
  47 .TP
  48 .BR \-i ", " \-\-info
  49 Retrieve
  50 .BR metadata.git/pkgname.json .
  51 .
  52 .TP
  53 .BR \-\-plain
  54 Print the package list to standard output.
  55 .
  56 .TP
  57 .BR \-F ", " \-\-fixed-strings
  58 Interpret the given
  59 .I pattern
  60 as a list of fixed strings, separated by newlines,
  61 any of which is to be matched.
  62 .
  63 .TP
  64 .BR \-P ", " \-\-perl\-regexp
  65 Interpret the given
  66 .I pattern
  67 as a Perl-compatible regular expression (PCRE).
  68 .
  69 .SS List retrieval options
  70 .TP
  71 .BR \-q ", " \-u ", " \-\-quiet
  72 Update the package list and print its path to standard output.
  73 .
  74 .TP
  75 .BR \-Q ", " \-\-systime
  76 Use the system clock when verifying the list modification date (see
  77 .BR \-\-time ).
  78 This option should only be used when the clock is synchronized, for example with
  79 NTP.
  80 .
  81 .TP
  82 .BR \-t ", " \-\-ttl
  83 A positive integer specifying the delay in seconds for retrieving list upgrades with
  84 .BR \-\-systime .
  85 A negative integer skips upgrades, regardless of
  86 .BR \-\-systime .
  87 Defaults to
  88 .B 600
  89 seconds.
  90 .PP
  91 New lists are generated by the AUR every 10 to 15 minutes. Setting smaller
  92 intervals with
  93 .B \-t
  94 will thus not give any new results.
  95 .
  96 .TP
  97 .BR \-v ", " \-\-verify
  98 Verify checksums of the compressed list with
  99 .BR sha256sum (1).
 100 .
 101 .SH ENVIRONMENT
 102 .TP
 103 .B AUR_LOCATION
 104 The URI of the AUR endpoint. Defaults to
 105 .IR https://\:aur.archlinux.org .
 106 .
 107 .TP
 108 .B GIT_HTTP_USER_AGENT
 109 This variable is set to
 110 .BR aurutils .
 111 .
 112 .SH NOTES
 113 The following threads provide more background on the AUR metadata archives:
 114 .PP
 115 .UR https://\:gitlab.archlinux.org/\:archlinux/\:aurweb/\:-/\:issues/\:172
 116 RFC for new AUR Metadata Archives format + diffs
 117 .UE ,
 118 .PP
 119 .UR https://lists.archlinux.org/pipermail/aur-general/2021-November/036659.html
 120 [aur\-general] New AUR Metadata Archives
 121 .UE ,
 122 .PP
 123 .UR https://\:lists.archlinux.org/\:pipermail/\:aur-dev/\:2016-May/\:004036.html
 124 [aur\-dev] Making the package list more useful
 125 .UE .
 126 .
 127 .SH SEE ALSO
 128 .ad l
 129 .nh
 130 .BR aur (1),
 131 .BR curl (1),
 132 .BR sha256sum (1)
 133 .
 134 .SH AUTHORS
 135 .MT https://github.com/AladW
 136 Alad Wenter
 137 .ME
 138 .
 139 .\" vim: set textwidth=72: