README.md: remove mascot
[aurutils.git] / man1 / aur-repo.1
blob61bc76b4c01788c6ac9bdae81199e26edf6c83b2
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 explicitely with the
36 .BR \-d option.
38 .SH OPERATIONS
39 .TP
40 .BI \-F " FIELD" "\fR,\fP \-\-field=" FIELD
41 List the attribute
42 .I FIELD
43 for all packages in the local repository. May be one of
44 .BR filename ,
45 .BR name ,
46 .BR base ,
47 .BR version ,
48 .BR desc ,
49 .BR url ,
50 .BR license ,
51 .BR arch ,
52 .BR builddate ,
53 .BR packager ,
54 .BR conflicts ,
55 .BR provides ,
56 .BR depends ,
57 .BR makedepends ,
58 .BR optdepends ,
59 or any other valid fields generated by
60 .BR repo\-add (1).
62 .TP
63 .BR \-l ", " \-\-list
64 List the contents of a local repository in the following format:
65 .IP
66 .BI pkgname \et pkgver \en
68 .TP
69 .BR \-t ", " \-\-table
70 List the contents of a local repository in the following format:
71 .IP
72 .BI pkgname \et depends \et pkgbase \et pkgver \en\c
73 \&.
74 .IP
75 If a package has no dependencies
76 .B pkgname
77 is used as
78 .BR depends ,
79 otherwise missing values are represented by
80 .IR \- .
81 See also
82 .BR \-\-table
84 .BR aur\-depends (1)
86 .TP
87 .BR \-u ", " \-\-upgrades
88 Check package updates with
89 .BR aur\-vercmp (1)
91 .TP
92 .BR \-\-list\-field
93 List valid fields in the local repository generated by
94 .R repo\-add (1).
95 See
96 .BR \-\-field .
98 .TP
99 .BR \-\-list\-path
100 List the paths of configured local repositories.
103 .BR \-\-list\-repo
104 List the names of configured local repositories.
107 .BR \-\-path
108 List the resolved path of the selected
109 .BR pacman (8)
110 repository.
112 .SH OPTIONS
114 .BI \-c " FILE" "\fR,\fP \-\-config=" FILE
115 Specify an alternate
116 .BR pacman (8)
117 configuration file.
120 .BI \-d " NAME" "\fR,\fP \-\-database=" NAME
121 The name of a
122 .BR pacman (8)
123 repository.
125 The repository should have a
126 .B file://
127 location, or any other location when using
128 .BR \-\-sync .
131 .BI \-r " PATH" "\fR,\fP \-\-root=" PATH
132 The path to the root of a local repository. 
135 .BR \-a ", " \-\-all
137 .B "aur\-vercmp \-\-all"
138 when checking for upgrades. Implies
139 .BR \-\-upgrades .
142 .BR \-q ", " \-\-quiet
143 Only print package names when listing the repository
144 .RB ( \-\-list )
145 or checking for upgrades
146 .RB ( \-\-upgrades ).
149 .BR \-S ", " \-\-sync
150 Query repositories in
151 .BI DBPATH /sync
152 (defaults to
153 .BR /var/lib/pacman/sync )
154 instead of by their
155 .B file://
156 path.
159 .BI \-\-status\-file= FILE
160 Print status information to a specified file, in the following format:
165 repo:<repository name>
166 root:<root of repository>
167 path:<path of repository>
170 Can be combined with other operations.
173 .SH EXAMPLES
174 List information on configured local repositories:
177   $ aur repo --repo-list | while read -r repo; do 
178         printf '[%s]\\n' "$repo"
179         pacconf --repo="$repo"
180     done
184 .SH ENVIRONMENT
186 .B AUR_REPO
187 The name of a pacman repository, see
188 .BR \-d .
191 .B AUR_DBROOT
192 The path to the root of a local repository, see
193 .BR \-r .
196 .B AUR_DBEXT
197 The extension of the local repository. Defaults to
198 .BR .db .
200 .SH SEE ALSO
201 .ad l
203 .BR aur (1),
204 .BR aur\-depends (1),
205 .BR aur\-vercmp (1),
206 .BR pacman.conf (5),
207 .BR pacman (8)
209 .SH AUTHORS
210 .MT https://github.com/AladW
211 Alad Wenter
214 .\" vim: set textwidth=72: