Merge pull request #1117 from frazar/improve-readme
[aurutils.git] / man1 / aur-repo.1
blob0241c23c7e21292d9c467533a5b5970d5d46fd04
1 .TH AUR-REPO 1 2022-03-12 AURUTILS
2 .SH NAME
3 aur\-repo \- manage local repositories
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
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
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.
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 This is the default operation.
53 .RE
55 .TP
56 .BI \-f " FORMAT" "\fR,\fP \-\-format=" FORMAT
57 Transform the contents of the local repository with
58 .BR aur\-format (1).
60 .TP
61 .BI \-F " FIELD" "\fR,\fP \-\-field=" FIELD
62 List the attribute
63 .I FIELD
64 for all packages in the local repository. May be one of
65 .BR filename ,
66 .BR name ,
67 .BR base ,
68 .BR version ,
69 .BR desc ,
70 .BR url ,
71 .BR license ,
72 .BR arch ,
73 .BR builddate ,
74 .BR packager ,
75 .BR conflicts ,
76 .BR provides ,
77 .BR depends ,
78 .BR makedepends ,
79 .BR optdepends ,
80 or any other valid fields generated by
81 .BR repo\-add (1).
83 .TP
84 .BR \-l ", " \-\-list
85 List the contents of a local repository in the following format:
86 .IP
87 .BI pkgname \et pkgver \en
89 .TP
90 .BR \-\-list\-field
91 List valid fields in a local repository generated by
92 .BR repo\-add (1).
93 See
94 .BR \-\-field .
96 .TP
97 .BR \-\-list\-path
98 List the paths of configured local repositories.
101 .BR \-\-path
102 List the resolved path of the selected
103 .BR pacman (8)
104 repository.
107 .BR \-\-list\-repo
108 List the names of configured local repositories.
111 .BR \-t ", " \-\-table
112 List the contents of a local repository in the following format:
114 .BI pkgname \et depends \et pkgbase \et pkgver \en\c
117 If a package has no dependencies
118 .B pkgname
119 is used as
120 .BR depends ,
121 otherwise missing values are represented by
122 .IR \- .
123 See also
124 .BR \-\-table
126 .BR aur\-depends (1)
129 .BR \-u ", " \-\-upgrades
130 Check package updates with
131 .BR aur\-vercmp (1)
134 .BR \-J ", " \-\-json
135 Output repository contents as JSON.
136 .RB ( aur\-repo\-parse \-\-json ).
139 .BR \-\-jsonl
140 Output repository contents as JSON Lines.
141 .RB ( aur\-repo\-parse \-\-jsonl ).
143 .SH OPTIONS
145 .BI \-c " FILE" "\fR,\fP \-\-config=" FILE
146 Specify an alternate
147 .BR pacman (8)
148 configuration file.
151 .BI \-d " NAME" "\fR,\fP \-\-database=" NAME
152 The name of a
153 .BR pacman (8)
154 repository.
156 The repository should have a
157 .B file://
158 location, or any other location when using
159 .BR \-\-sync .
162 .BI \-r " PATH" "\fR,\fP \-\-root=" PATH
163 The path to the root of a local 
164 .BR pacman (8)
165 repository. 
168 .BI \-\-delim " SEP"
169 The delimiter for expanding arrays with
170 .BR \-\-format .
173 .BI \-s " REGEXP" "\fR,\fP \-\-search=" REGEXP
174 Limit results to matches specified by
175 .IR PATTERN .
178 .BI \-\-search\-by= FIELD
179 The field (see
180 .BR \-\-attr )
181 matched on with
182 .BR \-\-search .
183 Defaults to
184 .BR name .
186 .B FIELD
187 corresponds to an array value such as
188 .BR depends ,
189 at least one value in the array should match.
192 .BR \-a ", " \-\-all
194 .B "aur\-vercmp \-\-all"
195 when checking for upgrades. Implies
196 .BR \-\-upgrades .
199 .BR \-q ", " \-\-quiet
200 Only print package names when listing the repository
201 .RB ( \-\-list )
202 or checking for upgrades
203 .RB ( \-\-upgrades ).
206 .BR \-S ", " \-\-sync
207 Query repositories in
208 .BI DBPATH /sync
209 (defaults to
210 .BR /var/lib/pacman/sync )
211 instead of by their
212 .B file://
213 path.
215 .SH EXAMPLES
216 List information on configured local repositories:
219   $ aur repo --repo-list | while read -r repo; do 
220         printf '[%s]\\n' "$repo"
221         pacconf --repo="$repo"
222     done
226 .SH ENVIRONMENT
228 .B AUR_REPO
229 The name of a pacman repository, see
230 .BR \-d .
233 .B AUR_DBROOT
234 The path to the root of a local repository, see
235 .BR \-r .
238 .B AUR_DBEXT
239 The extension of the local repository. Defaults to
240 .BR .db .
242 .SH SEE ALSO
243 .ad l
245 .BR aur (1),
246 .BR aur\-depends (1),
247 .BR aur\-vercmp (1),
248 .BR pacman.conf (5),
249 .BR pacman (8)
251 .SH AUTHORS
252 .MT https://github.com/AladW
253 Alad Wenter
256 .\" vim: set textwidth=72: