1 .\" man page for prt-get
2 .\" Johannes Winkelmann, jw@tks6.net
3 .\"
4 .\" my first man page, so forgive me for the errors :-)
5 .\"
6 .\" .PU
7 .TH "prt-get" "8" "" "" ""
8 .SH "NAME"
9 .LP
10 prt\-get \- an advanced package management tool to be used with
11 pkgutils from CRUX (see http://www.crux.nu)
12 .SH "SYNOPSIS"
13 .B prt\-get command [options] <arguments>
14 .br
15 .SH "DESCRIPTION"
16 prt\-get is a package management tool which provides additional
17 functionality to crux' package management system. It works with the
18 local ports tree and is therefore fully compatible with ports(8) and
19 pkgmk(8)/pkgadd(8). It offers the following features:
20
21 .PP
22 .TP
23 \ \ \ \(bu
24 abstract ports installation/update from file system
25
26 .TP
27 \ \ \ \(bu
28 install/update a list of packages with one command
29
30 .TP
31 \ \ \ \(bu
32 list dependencies for a list of packages
33
34 .TP
35 \ \ \ \(bu
36 show information about ports
37
38 .TP
39 \ \ \ \(bu
40 search within the ports
41
42 .PP
43
44 What prt\-get basically does is installing and upgrading packages, using
45 pkgmk and pkgadd. Additionally, you don't have be in the port's
46 directory to call prt\-get. prt\-get will search for the respective port
47 itself in a list of directories specified in /etc/prt\-get.conf. This
48 allows you to just install or update a package, without caring where
49 it actually is located on your file system.
50
51 .PP
52
53 prt\-get also offers some features like searching ports by name,
54 showing information about ports (without installing them of course)
55 and can list the dependencies listed in the Pkgfile, and provide a
56 complete dependency list for a port. Note that dependencies are no
57 requirement for crux packages and therefore not always accurate. There's
58 a possiblity to use an external dependency map to get dependency
59 listings for ports which don't provide them in their Pkgfile.
60
61 .PP
62
63 prt\-get has a test mode so you can see what effect an install/update
64 operation would have. Use the \-\-test switch for this (see also:
65 OPTIONS)
66
67 .SH "RETURN VALUE"
68 prt\-get returns 0 on success and a non-zero value otherwise (exact
69 value -> meaning mapping to be determined...)
70
71 .SH "COMMANDS"
72 prt\-get uses so called commands, which always have to be the first
73 non-option argument passed. This is very similar to
74 .B cvs(1).
75 [command] can be one of the following:
76
77
78 .TP
79 .B install [\-\-margs] [\-\-aargs] [\-\-log] <package1> [<package2> ...]
80 install all packages in the listed order. Note that you can do this
81 from any directory
82
83 .TP
84 .B depinst [\-\-margs] [\-\-aargs] [\-\-log] <package1> [<package2> ...]
85 install all packages in the listed order including their dependencies.
86 Note that outdated packages won't be updated.
87
88 .TP
89 .B grpinst [\-\-margs] [\-\-aargs] [\-\-log] <package1> [<package2> ...]
90 install all packages in the listed order, but stop if installation of
91 one package fails. This can be used to install packages where package2
92 depends on package1
93
94 .TP
95 .B update [\-\-margs] [\-\-aargs] [\-\-log] <package1> [<package2> ...]
96 update all packages listed in this order
97
98 .TP
99 .B remove <package1> [<package2> ...]
100 remove packages listed in this order
101
102 .TP
103 .B sysup [\-\-nodeps]
104 Update all installed packages which are outdated. Sorts by dependencies
105 if specified. If you don't want prt-get to resolve the dependencies, use
106 the --nodeps switch. Also see the
107 .B lock
108 and
109 .B unlock
110 commands to keep the currently installed versions, even if there are
111 changes in the ports tree. If you want to update only diffs which have
112 a lower version installed than the one in the ports tree, use the
113 --prefer-higher option.
114
115 .TP
116 .B lock <package1> [<package2>...]
117 Do not update these packages in a
118 .B sysup
119 operation
120
121 .TP
122 .B unlock <package1> [<package2>...]
123 Remove lock from these packages
124
125 .TP
126 .B listlocked [-v|-vv]
127 List names of packages which are locked. As always,
128 .B -v
129 will additionally show the version, and
130 .B -vv
131 also includes the description from the Pkgfile. Note that the
132 .B -vv
133 switch will slow down the operation remarkably.
134
135 .TP
136 .B diff [--all] [<package1> <package2> ...]
137 show differences between installed packages and ports in the ports
138 tree. If arguments are given, shows only differences for these
139 packages, otherwise all differences are shown. It's also possible to use
140 shell like
141 .B wildcards
142 for the diff command. Make sure you escape where needed. Locked
143 packages are only displayed if you use the --all switch. If you want
144 to see only diffs which have a lower version installed than the one in
145 the ports tree, use the --prefer-higher option.
146
147 .TP
148 .B quickdiff
149 prints a simple list of packages which have a different version in the
150 ports tree than what is installed. This is meant as an input for
151 .B prt\-get update,
152 so you can update all ports on your system with one simple command. If you want
153 to see only diffs which have a lower version installed than the one in
154 the ports tree, use the --prefer-higher option.
155
156 .TP
157 .B search [\-v|\-vv] [--path] [--regex]<expr>
158 Search the ports tree for
159 .B expr
160 in their name
161
162 .TP
163 .B dsearch [\-v|\-vv] [--path] [--regex]<expr>
164 Search the ports tree for
165 .B expr
166 in both name and description. The search in the description is not case
167 sensitive. Note that this requires prt\-get to read every Pkgfile, which
168 makes it rather slow; if you like this, consider using the cache
169 functionality, so you only have to spend this time once after updating
170 the ports tree has been updated.
171
172 .TP
173 .B fsearch [--full] [--regex] <pattern>
174 Search the ports tree for
175 .B pattern
176 as file name in their footprint. When called without '--full', strips
177 the directories from the file names before matching; this behaviour
178 will change in prt-get 0.6, where full path search will be
179 default. Pattern can be a shell-like wildcard pattern (e.g prt-get
180 fsearch "*.h") or regexps.
181
182
183 .TP
184 .B info <port>
185 Print available info for a port
186
187 .TP
188 .B path <port>
189 Print the path of a port
190
191 .TP
192 .B readme <port>
193 Print the port's README file if it exists; if set, uses $PAGER
194
195 .TP
196 .B depends <package1> [<package2> ...]
197 print a recursive list of dependencies to install the packages passed
198 as argument. It shows a list with ports which are found, plus a list
199 of ports which are missing
200
201 .TP
202 .B quickdep <package1> [<package2> ...]
203 print a simple list of recursive dependencies for all the ports passed
204 as argument in a simple format to be used by
205 .B prt\-get install
206 to make an install including dependencies
207 .B Does not display dependencies which are not in the ports tree
208
209 .TP
210 .B dependent <package>
211 print a list of package which depend on
212 .B package.
213 Only list direct dependencies. Usually shows dependent packages which
214 are installed. To see all dependencies, add the --all switch
215
216 .TP
217 .B deptree <package>
218 print a tree of the dependencies of the package
219 .B package.
220 Subtrees already shown are marked with '-->' to save some space, in
221 order to show them all, add the --all switch
222
223 .TP
224 .B dup
225 List ports which can be found in multiple directories configured in
226 .B /etc/prt-get.conf
227
228
229 .TP
230 .B list [\-v|\-vv] [filter] [--path] [--regex]
231 List ports available in the ports tree. It's basically the same as
232 .B ports \-l
233 but looks in all directories specified in
234 .B /etc/prt\-get.conf.
235 It's also possible to use
236 shell like
237 .B wildcards
238 for the list command. Make sure you escape where needed
239
240 .TP
241 .B printf <format string1> [\-\-sort=<format string2>] [\-\-filter=<filter>]
242 Print formated port list format string can contain variables, which
243 are replaced like this:
244 .TP
245 \ \ \ \(bu
246 %n \-> name
247
248 .TP
249 \ \ \ \(bu
250 %p \-> path
251
252 .TP
253 \ \ \ \(bu
254 %v \-> version
255
256 .TP
257 \ \ \ \(bu
258 %r \-> release
259
260 .TP
261 \ \ \ \(bu
262 %d \-> description
263
264 .TP
265 \ \ \ \(bu
266 %e \-> dependencies
267
268 .TP
269 \ \ \ \(bu
270 %u \-> URL
271
272 .TP
273 \ \ \ \(bu
274 %P -> Packager
275
276 .TP
277 \ \ \ \(bu
278 %M -> Maintainer
279
280 .TP
281 \ \ \ \(bu
282 %R -> Readme ("yes"/"no")
283
284 .TP
285 \ \ \ \(bu
286 %E -> pre-install script ("yes"/"no")
287
288 .TP
289 \ \ \ \(bu
290 %O -> post-install script ("yes"/"no")
291
292 .TP
293 \ \ \ \(bu
294 %l -> is locked ("yes"/"no")
295
296 .TP
297 \ \ \ \(bu
298 %i \-> "no" if not installed, "yes" if it's installed and
299 up to date and "diff" if it's installed and a new version is in the
300 ports tree.
301
302 Use "\\n" and "\\t" to format your output (no additional format specified
303 suported). The optional format string2 can contain the same variables
304 as format string1 and is used to sort the output. You can specify a
305 .B wildcard filter
306 to filter by package name.
307
308
309 .TP
310 .B listinst [\-v|\-vv] [filter] [--regex]
311 List installed ports. It's basically the same as
312 .B pkginfo \-i,
313 but omits version when called without verbose (\-v, \-vv) switch. Plus
314 it is notably faster in my tests. \-v adds version information, \-vv
315 adds version and description.
316 .B Warning:
317 \-vv will slow down the process because it requires prt\-get to scan
318 both the ports database and the ports tree.
319 It's also possible to use shell like
320 .B wildcards
321 for the listinst command. Make sure you escape where needed
322
323
324
325 .TP
326 .B isinst <package>
327 Check whether a package is installed. The same as
328 .B pkginfo \-i|grep ^package
329 .TP
330
331 .TP
332 .B current <package>
333 Prints out the version of the currently installed package
334
335
336 .TP
337 .B ls [--path] <package>
338 Prints out a listing of the port's directory
339
340 .TP
341 .B cat <package> [<file>]
342 Prints out the file to stdout. If <file> is not specified, 'Pkgfile' is used. If set, uses $PAGER
343
344 .TP
345 .B edit <package> <file>
346 Edit the file using the editor specified in the $EDITOR environment variable.
347 If <file> is not specified, 'Pkgfile' is used
348
349
350 .TP
351 .B help
352 Shows a help screen
353
354 .TP
355 .B dumpconfig
356 Dump the configuration to the current terminal
357
358 .TP
359 .B version
360 Shows the current version of prt\-get
361
362 .TP
363 .B cache
364 create a cache file from the ports tree to be used by prt\-get using the
365 \-\-cache option. Remember to run prt\-get cache each time you update the
366 ports tree
367
368 .SH "OPTIONS"
369
370 .TP
371 .B -f, -i
372 Force install; Implies 'pkgadd -f'; same as --aargs=-f
373
374 .TP
375 .B -fr
376 Force rebuild, Implies 'pkgmk -f'; same as --margs=-f
377
378 .TP
379 .B -um
380 Update md5sum, implies 'pkgmk -um'; same as --margs=-um
381
382 .TP
383 .B -im
384 Ignore md5sum, implies 'pkgmk -im'; same as --margs=-im
385
386 .TP
387 .B -uf
388 Update footprint, implies 'pkgmk -uf'; same as --margs=-uf
389
390 .TP
391 .B -if
392 Ignore footprint, implies 'pkgmk -if'; same as --margs=-if
393
394 .TP
395 .B -ns
396 No stripping, implies 'pkgmk -ns'; same as --margs=-ns
397
398 .TP
399 .B -kw
400 Keep working directory, implies 'pkgmk -kw'; same as --margs=-kw
401
402 .TP
403 .B --ignore=<package1,package2,...>
404 Don't install those packages, even if they're listed as dependency
405
406
407 .TP
408 .B \-\-cache
409 Use cache file for this command
410
411 .TP
412 .B \-\-test
413 Dry run, don't actually install anything, mostly interesting for
414 .B prt\-get install, prt\-get grpinst, prt\-get update, prt\-get sysup
415
416 .TP
417 .B \-\-pre-install
418 Execute pre-install script if it's there
419
420 .TP
421 .B \-\-post-install
422 Execute post-install script if it's there
423
424 .TP
425 .B \-\-install-scripts
426 Execute pre-install and post-install script if they're there
427
428 .TP
429 .B \-\-no-std-config
430 Don't parse the default configuration file
431
432 .TP
433 .B \-\-config-prepend=<string>
434 Prepend <string> to configuration
435
436 .TP
437 .B \-\-config-append=<string>
438 Append <string> to configuration
439
440 .TP
441 .B \-\-config-set=<string>
442 Set <string> in configuration, overriding configuration file
443
444
445 .TP
446 .B \-v, \-vv
447 verbose and more verbose, relevant for
448 .B prt\-get search, prt\-get list
449 verbose shows version of a port, more verbose shows version and
450 description (if available)
451
452 .B \-\-path
453 Show path info; used in 'search', 'dsearch', 'list' and 'depends'
454
455 .B \-\-regex
456 Interpret filter and search pattern as regular expression
457
458 .TP
459 .B \-\-margs="...", e.g. \-\-margs="\-im"
460 arguments to be passed to pkgmk, relevant for
461 .B prt\-get install, prt\-get grpinst, prt\-get update
462 note that \-d is already passed to pkgmk anyway
463
464 .TP
465 .B \-\-aargs="...", e.g. \-\-aargs="\-f"
466 arguments to be passed to pkgadd, relevant for
467 .B prt\-get install, prt\-get grpinst, prt\-get update
468
469 .TP
470 .B \-\-rargs="..."
471 arguments to be passed to pkgrm; currently not used, implemented for
472 future uses and consistency reasons
473
474 .TP
475 .B \-\-prefer-higher, -ph
476 Make prt-get parse the version strings and prefer the higher version,
477 even if the one found in the ports tree is lower. Will influence diff,
478 quickdiff and sysup.
479
480 .TP
481 .B \-\-strict-diff, -sd
482 Override the 'preferhigher' configuration option
483
484
485 .TP
486 .B \-\-config=<file>
487 Use alternative configuration file to read ports directories from
488
489 .TP
490 .B \-\-install-root=<dir>
491 Use <dir> as root directory for your installation; allows to install to
492 a different directory than '/'. In daily usage, this option is not
493 required; helpful if you're developing an independent installation.
494
495 .TP
496 .B \-\-log
497 Write build output to log file
498
499 .SH "CONFIGURATION"
500 .TP
501 See man prt\-get.conf(5)
502
503 .SH "EXAMPLES"
504 .TP
505 .B prt\-get install irssi
506 download, build and install irssi, with one simple command
507
508 .TP
509 .B prt\-get install indent mplayer
510 install indent and mplayer
511
512 .TP
513 .B prt\-get update openssh
514 update your current version of openssh :\-)
515
516 .TP
517 .B prt\-get info kdelibs
518 show info about kdelibs
519
520 .TP
521 .B prt\-get search icq
522 Search all ports containing 'icq' in their name
523
524 .TP
525 .B prt\-get grpinst \-\-test `prt\-get quickdep kdenetwork`
526 Show what would happen if you installed all packages needed for
527 kdenetwork (test mode). Remove \-\-test to install kdenetwork and all
528 it's dependencies. Remember that grpinst stops installing when one
529 installing of one package fails
530
531 .TP
532 .B prt\-get update `prt\-get quickdiff`
533 Update all packages where a different version is in the ports tree
534
535 .SH "AUTHORS"
536 Johannes Winkelmann <jw@tks6.net>
537 .SH "SEE ALSO"
538 prt\-get.conf(5), prt\-cache(8), pkgmk(8) pkgadd(8), ports(8)
|