| blob | e499775c2423df1229d4dfaaccf3df0400fe8ab0 |
1 .TH AUR-REPO 1 2022-03-12 AURUTILS
2 .SH NAME
3 aur\-repo \- manage local repositories
4 .
5 .SH SYNOPSIS
6 .SY "aur repo"
7 .OP \-\-list
8 .OP \-\-table
9 .OP \-\-upgrades
10 .SY "aur repo"
11 .OP \-c file
12 .OP \-d name
13 .OP \-r path
14 .OP \-F field
15 .OP \-aqS
16 .YS
17 .
18 .SH DESCRIPTION
19 .B aur\-repo
20 helps manage local
21 .RI ( file:// )
22 .BR pacman (8)
23 repositories. In particular, it serves to parse repository contents
24 .RI ( \-\-list ", " \-\-table ),
25 compare package versions to the AUR
26 .RI ( \-\-upgrades ),
27 and list local repository file paths
28 .RI ( \-\-list\-path ).
29 .PP
30 If
31 .BR pacman.conf (5)
32 contains only a single local repository,
33 .B aur\-repo
34 selects it automatically. If multiple local repositories are
35 configured, they must specified explicitly with the
36 .BR \-d
37 option.
38 .
39 .SH OPERATIONS
40 .TP
41 .BI \-\-status
42 Print status information to a standard output, in the following format:
43 .IP
44 .RS
45 .EX
46 .PP
47 repo:<repository name>
48 root:<root of repository>
49 path:<path of repository>
50 .PP
51 .EE
52 Unless
53 .B \-\-missing
54 is specified,
55 .I root
56 and
57 .I path
58 must be existing paths. This is the default operation.
59 .RE
60 .
61 .TP
62 .BI \-f " FORMAT" "\fR,\fP \-\-format=" FORMAT
63 Transform the contents of the local repository with
64 .BR aur\-format (1).
65 .
66 .TP
67 .BI \-F " FIELD" "\fR,\fP \-\-field=" FIELD "\fR,\fP \-\-attr=" FIELD
68 List the attribute
69 .I FIELD
70 for all packages in the local repository. May be one of
71 .BR filename ,
72 .BR name ,
73 .BR base ,
74 .BR version ,
75 .BR desc ,
76 .BR url ,
77 .BR license ,
78 .BR arch ,
79 .BR builddate ,
80 .BR packager ,
81 .BR conflicts ,
82 .BR provides ,
83 .BR depends ,
84 .BR makedepends ,
85 .BR optdepends ,
86 or any other valid fields generated by
87 .BR repo\-add (1).
88 .
89 .TP
90 .BR \-l ", " \-\-list
91 List the contents of a local repository in the following format:
92 .IP
93 .BI pkgname \et pkgver \en
94 .
95 .TP
96 .BR \-\-list\-field
97 List valid fields in a local repository generated by
98 .BR repo\-add (1).
99 See
100 .BR \-\-field .
101 .
102 .TP
103 .BR \-\-list\-path
104 List the paths of configured local repositories.
105 .IP
106 Unless
107 .BR \-\-missing
108 is specified, all paths must exist.
109 .
110 .TP
111 .BR \-\-path
112 List the resolved path of the selected
113 .BR pacman (8)
114 repository.
115 .IP
116 Unless
117 .BR \-\-missing
118 is specified, the path must exist.
119 .
120 .TP
121 .BR \-\-list\-repo
122 List the names of configured local repositories.
123 .
124 .TP
125 .BR \-t ", " \-\-table
126 List the contents of a local repository in the following format:
127 .IP
128 .BI pkgname \et depends \et pkgbase \et pkgver \en\c
129 \&.
130 .IP
131 If a package has no dependencies
132 .B pkgname
133 is used as
134 .BR depends ,
135 otherwise missing values are represented by
136 .IR \- .
137 See also
138 .BR \-\-table
139 in
140 .BR aur\-depends (1)
141 .
142 .TP
143 .BR \-u ", " \-\-upgrades
144 Check package updates with
145 .BR aur\-vercmp (1)
146 .
147 .TP
148 .BR \-J ", " \-\-json
149 Output repository contents as JSON.
150 .RB ( aur\-repo\-parse \-\-json ).
151 .
152 .TP
153 .BR \-\-jsonl
154 Output repository contents as JSON Lines.
155 .RB ( aur\-repo\-parse \-\-jsonl ).
156 .
157 .SH OPTIONS
158 .TP
159 .BI \-c " FILE" "\fR,\fP \-\-config=" FILE
160 Specify an alternate
161 .BR pacman (8)
162 configuration file.
163 .
164 .TP
165 .BI \-d " NAME" "\fR,\fP \-\-database=" NAME
166 The name of a
167 .BR pacman (8)
168 repository.
169 .IP
170 The repository should have a
171 .B file://
172 location, or any other location when using
173 .BR \-\-sync .
174 .
175 .TP
176 .BI \-r " PATH" "\fR,\fP \-\-root=" PATH
177 The path to the root of a local
178 .BR pacman (8)
179 repository.
180 .
181 .TP
182 .BI \-\-delim " SEP"
183 The delimiter for expanding arrays with
184 .BR \-\-format .
185 .
186 .TP
187 .BI \-s " REGEXP" "\fR,\fP \-\-search=" REGEXP
188 Limit results to matches specified by
189 .IR PATTERN .
190 .
191 .TP
192 .BI \-\-search\-by= FIELD
193 The field (see
194 .BR \-\-field )
195 matched on with
196 .BR \-\-search .
197 Defaults to
198 .BR name .
199 If
200 .B FIELD
201 corresponds to an array value such as
202 .BR depends ,
203 at least one value in the array should match.
204 .
205 .TP
206 .BI \-i " PATTERN" "\fR,\fP \-\-ignore=" PATTERN
207 Ignore results with matches specified by
208 .IR PATTERN .
209 .
210 .TP
211 .BI \-\-ignore\-by= FIELD
212 The field matched on witch
213 .BR \-\-ignore .
214 Defaults to
215 .BR name .
216 .
217 .TP
218 .BR \-a ", " \-\-all
219 Use
220 .B "aur\-vercmp \-\-all"
221 when checking for upgrades. Implies
222 .BR \-\-upgrades .
223 .
224 .TP
225 .BR \-q ", " \-\-quiet
226 Only print package names when listing the repository
227 .RB ( \-\-list )
228 or checking for upgrades
229 .RB ( \-\-upgrades ).
230 .
231 .TP
232 .BR \-S ", " \-\-sync
233 Query repositories in
234 .BI DBPATH /sync
235 (defaults to
236 .BR /var/lib/pacman/sync )
237 instead of by their
238 .B file://
239 path.
240 .
241 .TP
242 .BR \-m ", " \-\-missing
243 Do not require paths to exist with
244 .BR \-\-status ,
245 .BR \-\-path
246 and
247 .BR \-\-list\-path .
248 .
249 .B
250 .SH EXAMPLES
251 List information on configured local repositories:
252 .PP
253 .EX
254 $ aur repo --repo-list | while read -r repo; do
255 printf '[%s]\\n' "$repo"
256 pacconf --repo="$repo"
257 done
258 .EE
259 .PP
260 .
261 .SH ENVIRONMENT
262 .TP
263 .B AUR_REPO
264 The name of a pacman repository, see
265 .BR \-d .
266 .
267 .TP
268 .B AUR_DBROOT
269 The path to the root of a local repository, see
270 .BR \-r .
271 .
272 .TP
273 .B AUR_DBEXT
274 The extension of the local repository. Defaults to
275 .BR .db .
276 .
277 .SH SEE ALSO
278 .ad l
279 .nh
280 .BR aur (1),
281 .BR aur\-depends (1),
282 .BR aur\-vercmp (1),
283 .BR pacman.conf (5),
284 .BR pacman (8)
285 .
286 .SH AUTHORS
287 .MT https://github.com/AladW
288 Alad Wenter
289 .ME
290 .
291 .\" vim: set textwidth=72: