1 |
commit: b8cc6a4cd9990a86894ff14f2832f5f3a88bbd22 |
2 |
Author: Aaron Bauman <bman <AT> gentoo <DOT> org> |
3 |
AuthorDate: Sun Aug 25 20:13:26 2019 +0000 |
4 |
Commit: Zac Medico <zmedico <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon Aug 26 18:09:49 2019 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=b8cc6a4c |
7 |
|
8 |
man/glsa-check.1: update the glsa-check man page |
9 |
|
10 |
* Remove "Gentoo" from the name. It is obvious. |
11 |
* Change "SYNTAX" to "SYNOPSIS" which is more common among man pages |
12 |
* Update description to use the command name vice "This tool" |
13 |
* Move bug reporting information to BUGS section |
14 |
* Remove references to the "portage tree". Just call it a repo. |
15 |
* Add the "sets" all, new, and affected to the SYNOPSIS |
16 |
* Sentence case and add periods to all option descriptions |
17 |
|
18 |
Signed-off-by: Aaron Bauman <bman <AT> gentoo.org> |
19 |
Signed-off-by: Zac Medico <zmedico <AT> gentoo.org> |
20 |
|
21 |
man/glsa-check.1 | 119 ++++++++++++++++++++++++++----------------------------- |
22 |
1 file changed, 57 insertions(+), 62 deletions(-) |
23 |
|
24 |
diff --git a/man/glsa-check.1 b/man/glsa-check.1 |
25 |
index 67527230c..a0d49d4dd 100644 |
26 |
--- a/man/glsa-check.1 |
27 |
+++ b/man/glsa-check.1 |
28 |
@@ -1,66 +1,61 @@ |
29 |
-.TH "GLSA-CHECK" "1" "Aug 2019" "Portage VERSION" "Portage" |
30 |
+.TH "GLSA\-CHECK" "1" "August 2019" "Portage VERSION" "Portage" |
31 |
+. |
32 |
.SH "NAME" |
33 |
-.LP |
34 |
-glsa\-check \- Gentoo: Tool to locally monitor and manage GLSAs |
35 |
-.SH "SYNTAX" |
36 |
-.LP |
37 |
-glsa\-check <\fIoption\fP> [\fIglsa\-list\fP] |
38 |
- |
39 |
-[\fIglsa\-list\fR] can contain an arbitrary number of GLSA ids, filenames containing GLSAs or the special identifiers 'all' and 'affected' |
40 |
+\fBglsa\-check\fR \- Tool to locally monitor and manage GLSAs |
41 |
+. |
42 |
+.SH "SYNOPSIS" |
43 |
+\fBglsa\-check\fR [options] [glsa\-id | all | new | affected] |
44 |
+. |
45 |
.SH "DESCRIPTION" |
46 |
-.LP |
47 |
-This tool is used to locally monitor and manage Gentoo Linux Security Advisories. |
48 |
-Please read: |
49 |
-.br |
50 |
-http://www.gentoo.org/security |
51 |
-.br |
52 |
-before reporting a bug. |
53 |
-.LP |
54 |
-Note: In order for this tool to be effective, you must regularly sync your local portage tree. |
55 |
+\fBglsa\-check\fR is used to locally monitor and manage Gentoo Linux Security Advisories\. In order for \fBglsa\-check\fR to be effective, it is required that a local repository exists containing GLSA metadata\. |
56 |
+. |
57 |
.SH "OPTIONS" |
58 |
-.LP |
59 |
-.TP |
60 |
-.B \-l, \-\-list |
61 |
-list the a summary for all GLSAs in glsa\-list and whether they affect the system |
62 |
-.TP |
63 |
-.B \-d, \-\-dump, \-\-print |
64 |
-show all information about the GLSAs in glsa\-list |
65 |
-.TP |
66 |
-.B \-t, \-\-test |
67 |
-test if this system is affected by the GLSAs in glsa\-list and output the GLSA IDs |
68 |
-.TP |
69 |
-.B \-p, \-\-pretend |
70 |
-show the necessary steps to apply the GLSAs in glsa\-list |
71 |
-.TP |
72 |
-.B \-f, \-\-fix |
73 |
-try to auto\-apply the GLSAs in in glsa\-list using emerge. This will only upgrade packages to later version, but not remove packages when no upgrade path exists (experimental) |
74 |
-.TP |
75 |
-.B \-i, \-\-inject |
76 |
-inject the given GLSA into the glsa_injected file |
77 |
-.TP |
78 |
-.B \-n, \-\-nocolor |
79 |
-disable colors (option) |
80 |
-.TP |
81 |
-.B \-h, \-\-help |
82 |
-show this help message |
83 |
-.TP |
84 |
-.B \-V, \-\-version |
85 |
-some information about this tool |
86 |
-.TP |
87 |
-.B \-v, \-\-verbose |
88 |
-print more messages (option) |
89 |
-.TP |
90 |
-.B \-c, \-\-cve |
91 |
-show CVE ids in listing mode (option) |
92 |
-.TP |
93 |
-.B \-q, \-\-quiet |
94 |
-be less verbose and do not send empty mail (option) |
95 |
-.TP |
96 |
-.B \-m, \-\-mail |
97 |
-send a mail with the given GLSAs to the administrator |
98 |
+\fB\-l\fR, \fB\-\-list\fR List a summary for the given GLSA(s) or set and whether they affect the system\. |
99 |
+. |
100 |
+.P |
101 |
+\fB\-d\fR, \fB\-\-dump\fR, \fB\-\-print\fR Show all information about the GLSA(s) or set\. |
102 |
+. |
103 |
+.P |
104 |
+\fB\-t\fR, \fB\-\-test\fR Test if this system is affected by the GLSA(s) or set and output the GLSA ID(s)\. |
105 |
+. |
106 |
+.P |
107 |
+\fB\-p\fR, \fB\-\-pretend\fR Show the necessary steps to remediate the system\. |
108 |
+. |
109 |
+.P |
110 |
+\fB\-f\fR, \fB\-\-fix\fR (experimental) Attempt to remediate the system based on the instructions given in the GLSA(s) or set\. This will only upgrade (when an upgrade path exists) or remove packages\. |
111 |
+. |
112 |
+.P |
113 |
+\fB\-i\fR, \fB\-\-inject\fR Inject the given GLSA(s) into the glsa_injected file\. |
114 |
+. |
115 |
+.P |
116 |
+\fB\-n\fR, \fB\-\-nocolor\fR Removes color from output\. |
117 |
+. |
118 |
+.P |
119 |
+\fB\-h\fR, \fB\-\-help\fR Show this help message\. |
120 |
+. |
121 |
+.P |
122 |
+\fBV\fR, \fB\-\-version\fR Show information about \fBglsa\-check\fR\. |
123 |
+. |
124 |
+.P |
125 |
+\fB\-v\fR, \fB\-\-verbose\fR Print more messages\. |
126 |
+. |
127 |
+.P |
128 |
+\fB\-c\fR, \fB\-\-cve\fR Show CVE IDs in listing mode\. |
129 |
+. |
130 |
+.P |
131 |
+\fB\-q\fR, \fB\-\-quiet\fR Be less verbose and do not send empty mail\. |
132 |
+. |
133 |
+.P |
134 |
+\fB\-m\fR, \fB\-\-mail\fR Send a mail with the given GLSAs to the administrator\. |
135 |
+. |
136 |
+.SH "EXAMPLES" |
137 |
+\fBglsa\-check \-t all\fR Test the system against all GLSAs in the GLSA repository\. |
138 |
+. |
139 |
+.P |
140 |
+\fBglsa\-check \-t 201801\-01\fR Test the system against the specific GLSA 201801\-01\. |
141 |
+. |
142 |
.SH "FILES" |
143 |
-.LP |
144 |
-.TP |
145 |
-.B /var/lib/portage/glsa_injected |
146 |
-List of GLSA ids that have been injected and will never show up as 'affected' on this system. |
147 |
-The file must contain one GLSA id (e.g. '200804\-02') per line. |
148 |
+\fB/var/lib/portage/glsa_injected\fR List of GLSA ids that have been injected and will never show up as \'affected\' on this system\. The file must contain one GLSA ID (e\.g\. \'200804\-02\') per line\. |
149 |
+. |
150 |
+.SH "BUGS" |
151 |
+All bugs should be reported to the Portage team via https://bugs\.gentoo\.org |