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