1 |
commit: 3472565d8829029e827a710d46c2dd3caa4e74c9 |
2 |
Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org> |
3 |
AuthorDate: Mon Jan 2 06:20:40 2017 +0000 |
4 |
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon Jan 2 06:20:40 2017 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/gentoostats.git/commit/?id=3472565d |
7 |
|
8 |
man: add the manpage for gentoostats-cli |
9 |
|
10 |
man/gentoostats-cli.1 | 146 ++++++++++++++++++++++++++++++++++++++++++++++++++ |
11 |
1 file changed, 146 insertions(+) |
12 |
|
13 |
diff --git a/man/gentoostats-cli.1 b/man/gentoostats-cli.1 |
14 |
new file mode 100644 |
15 |
index 0000000..5f085a8 |
16 |
--- /dev/null |
17 |
+++ b/man/gentoostats-cli.1 |
18 |
@@ -0,0 +1,146 @@ |
19 |
+.TH "GENTOOSTATS-CLI" "1" "Jan 2017" "" "Gentoostats" |
20 |
+.SH "NAME" |
21 |
+gentoostats\-cli \- Command\-line interface to request gentoostats statistics |
22 |
+.SH "SYNOPSIS" |
23 |
+.TP |
24 |
+\fBgentoostats\-cli\fR [\fIoptions\fR] \fBlist\fR [\fIlist-options\fR] \ |
25 |
+[\fBarch\fR | \fBpackage\fR | \fBlang\fR | \fBuse\fR | \fBmirror\fR | \ |
26 |
+\fBfeature\fR | \fBrepo\fR] |
27 |
+.TP |
28 |
+\fBgentoostats\-cli\fR [\fIoptions\fR] \fBsearch\fR [\fIsearch-options\fR] |
29 |
+.SH "DESCRIPTION" |
30 |
+gentoostats\-cli is a command line utility for requesting various |
31 |
+statistics from a gentoostats server. The results are presented in the |
32 |
+JSON format. |
33 |
+.SH "DEFAULT OPTIONS" |
34 |
+.TP |
35 |
+.B \-s, \-\-server |
36 |
+Host name of the remote gentoostats server |
37 |
+.TP |
38 |
+.B \-p, \-\-port |
39 |
+Port number of the remote gentoostats server |
40 |
+.TP |
41 |
+.B \-u, \-\-url |
42 |
+URL of the remote gentoostats server |
43 |
+.TP |
44 |
+.B \-h, \-\-help |
45 |
+Show the help information |
46 |
+.SH "COMMANDS" |
47 |
+.TP |
48 |
+.B list |
49 |
+The list command allows the following statistics to be queried: |
50 |
+.RS |
51 |
+.TP |
52 |
+.B arch |
53 |
+The host count statistics of ARCH keywords |
54 |
+.TP |
55 |
+.B package |
56 |
+The statistics for the total number of package versions, packages, |
57 |
+categories, hosts, and the most popular categories |
58 |
+.TP |
59 |
+.B lang |
60 |
+The host count statistics for the LANG environment variable |
61 |
+.TP |
62 |
+.B use |
63 |
+The total number of USE flags |
64 |
+.TP |
65 |
+.B mirror |
66 |
+The host count statistics for Gentoo mirrors |
67 |
+.TP |
68 |
+.B feature |
69 |
+The host count statistics for package manager features |
70 |
+.TP |
71 |
+.B repo |
72 |
+The host count statistics for package repositories |
73 |
+.RE |
74 |
+.TP |
75 |
+.B search |
76 |
+The search command returns the host count statistics for package |
77 |
+versions along with their repository information. The results can be |
78 |
+further filtered using combinations of the search command options. |
79 |
+.SH "OPTIONS for list command" |
80 |
+.TP |
81 |
+.B \-h, \-\-help |
82 |
+Show the help information for the \fBlist\fR command |
83 |
+.SH "OPTIONS for search command" |
84 |
+.TP |
85 |
+.B \-c, \-\-category |
86 |
+Filter the results by category |
87 |
+.TP |
88 |
+.B \-p, \-\-package |
89 |
+Filter the results by package name |
90 |
+.TP |
91 |
+.B \-v, \-\-version |
92 |
+Filter the results by package version |
93 |
+.TP |
94 |
+.B \-, \-\-repo |
95 |
+Filter the results by package repository |
96 |
+.TP |
97 |
+.B \-\-min_hosts |
98 |
+Filter the results by the minimum number of hosts per package version |
99 |
+.TP |
100 |
+.B \-\-max_hosts |
101 |
+Filter the results by the maximum number of hosts per package version |
102 |
+.TP |
103 |
+.B \-h, \-\-help |
104 |
+Show the help message for the \fBsearch\fR command |
105 |
+.SH "EXAMPLES" |
106 |
+.TP |
107 |
+The following are examples for the \fBlist\fR command: |
108 |
+.RS |
109 |
+.PP |
110 |
+.B $ gentoostats\-cli list arch |
111 |
+.nf |
112 |
+Arch |
113 |
+{'amd64': {'HOSTS': 4}, 'x86': {'HOSTS': 1}} |
114 |
+.fi |
115 |
+.PP |
116 |
+.B $ gentoostats\-cli list package |
117 |
+.nf |
118 |
+Categories |
119 |
+ {'CPV_COUNT': 2244, |
120 |
+ 'CP_COUNT': 1904, |
121 |
+ 'C_COUNT': 100, |
122 |
+ 'HOST_COUNT': 5, |
123 |
+ 'TOP_C': [{'CAT': 'app-admin', 'HOST_COUNT': 5}, |
124 |
+ {'CAT': 'app-arch', 'HOST_COUNT': 5}, |
125 |
+ {'CAT': 'app-crypt', 'HOST_COUNT': 5}, |
126 |
+ {'CAT': 'app-editors', 'HOST_COUNT': 5}, |
127 |
+ {'CAT': 'app-emacs', 'HOST_COUNT': 5}]} |
128 |
+.fi |
129 |
+.RE |
130 |
+.TP |
131 |
+The following are examples for the \fBsearch\fR command: |
132 |
+.RS |
133 |
+.PP |
134 |
+.B $ gentoostats\-cli search \-\-package gentoostats |
135 |
+.nf |
136 |
+Search results |
137 |
+[{'CAT': 'app-portage', |
138 |
+ 'HOSTS': 5, |
139 |
+ 'PKG': 'gentoostats', |
140 |
+ 'REPO': 'gentoo', |
141 |
+ 'VER': '9999'}, |
142 |
+{'CAT': 'www-apps', |
143 |
+ 'HOSTS': 2, |
144 |
+ 'PKG': 'gentoostats', |
145 |
+ 'REPO': 'gentoo', |
146 |
+ 'VER': '9999'}] |
147 |
+.fi |
148 |
+.PP |
149 |
+.B $ gentoostats\-cli search \-\-c sys-apps \-\-p portage \-\-v 2.3.0 \-\-r gentoo \-\-min_hosts 4 |
150 |
+.nf |
151 |
+Search results |
152 |
+[{'CAT': 'sys-apps', |
153 |
+ 'HOSTS': 5, |
154 |
+ 'PKG': 'portage', |
155 |
+ 'REPO': 'gentoo', |
156 |
+ 'VER': '2.3.0'}] |
157 |
+.fi |
158 |
+.RE |
159 |
+.SH "BUGS" |
160 |
+Please report bugs via https://bugs.gentoo.org/ |
161 |
+.SH "AUTHOR" |
162 |
+Göktürk Yüksek <gokturk@g.o> |
163 |
+.SH "SEE ALSO" |
164 |
+\fBgentoostats\-send\fR(1) |