Fixed incorrect options in both the man page and the code itself.
[portpeek.git] / portpeek.1
1 .TH "PORTPEEK" "1" "Aug 2009"
2 .SH "NAME"
3 portpeek \- Package (un)masking management script
4 .SH "SYNOPSIS"
5 .TP
6 .BR portpeek
7 [\fIoptions\fR] \fIcommand\fR 
8 .TP
9 .BR portpeek
10 \fB\-\-keyword\fR | \fB\-\-unmask\fR | \fB\-\-mask\fR | \fB\-\-package\-use\fR | \fB\-\-all
11 .TP
12 .BR portpeek
13 \fB\-\-changes-only\fR [\fB--keyword\fR | \fB\-\-unmask\fR | \fB\-\-mask\fR | \fB\-\-package\-use\fR | \fB\-\-all]
14 .SH "DESCRIPTION"
15 \fBportpeek\fR is a utility script that will process a system's package.*
16 files and display to the user potential package upgrades. Along with displaying
17 the installed packages and the versions that the package could be upgraded to,
18 the keywords for each specific package will also be displayed.
19 Results are colorcoded for readability.
20 .SH "OPTIONS"
21 The 'command' is the only mandatory option to \fBportpeek\fR.
22
23 [options] may only be:
24
25 .B \-c, \-\-changes-only:
26 show only packages that have a possible upgrade
27 .PP
28 .B \-n, \-\-no-color:
29 suppress color output 
30 .PP
31 .B \-r, \-\-removable-only:
32 show all matches that can be removed from package files
33 .PP
34 .B \-f \-\-fix:
35 remove the unnecessary packages without asking for confirmation
36 .PP
37 .B \-q \-\-fix-confirm:
38 ask for confirmation before removing the unnecessary packages 
39 .PP
40 .B \-d \-\-debug:
41 display more verbose output for debugging
42 .PP
43 Except for version information, commands can be combined.  The possible commands are:
44
45 .B \-a, \-\-all
46 show all matches
47 .PP
48 .B \-h, \-\-help
49 displays a help summary
50 .PP
51 .B \-k, \-\-keyword
52 show matches from package.keywords and package.accept_keywords only
53 .PP
54 .B \-m, \-\-mask
55 show matches from package.mask only
56 .PP
57 .B \-u, \-\-unmask
58 show matches from package.unmask only
59 .PP
60 .B \-s, \-\-package-use
61 show matches from package.use only
62 .PP
63 .B \-t, \-\-tilde-check
64 process tilde entries ~(cat/pkg-version) 
65 .PP
66 .B \-V, \-\-version
67 displays the equery version
68 .PP
69
70 .SH "OTHER OPTIONS"
71 Putting the words "portpeek-skip" with or without quotes on a comment line will make portpeek skip the rest of the file. This is useful, for example, if one has a separate KDE keywords file with many lines of the form: ~kde-base/kde-program.  These tend to take awhile to process and might be a file you don't want analyzed for every portpeek call.
72
73 .SH "EXAMPLES"
74
75 portpeek \-\-changes-only \-\-keyword \- list all packages with a potential upgrade located in package.keywords or package.accept_keywords
76
77 portpeek \-\-unmask \- list all packages and their keywords currently listed in package.unmask
78
79 portpeek \-ac \- list all packages and keywords from all package.* files
80
81 portpeek \-arf \- list all packages which are stable and can be removed and then remove them automatically
82
83 .SH "AUTHORS"
84 .nf
85 Michael Pagano <mpagano@gentoo.org>