diff options
author | madmurphy <madmurphy333@gmail.com> | 2022-02-11 14:59:28 +0000 |
---|---|---|
committer | madmurphy <madmurphy333@gmail.com> | 2022-02-11 14:59:28 +0000 |
commit | b99f65d5ed563faaad4772b5f93cc64d90de5515 (patch) | |
tree | 04b07975946b18bd2bda5bdcf4fc53a8643b52c8 /doc/man | |
parent | c4bd3744ac1452e88e9e6b19e38ad8d397bc2dc3 (diff) | |
download | gnunet-b99f65d5ed563faaad4772b5f93cc64d90de5515.tar.gz gnunet-b99f65d5ed563faaad4772b5f93cc64d90de5515.zip |
`man gnunet-search`: general review (cont'd)
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/gnunet-search.1 | 62 |
1 files changed, 50 insertions, 12 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index ff21f4670..120a2e6ba 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 | |||
@@ -90,7 +90,7 @@ defaults to | |||
90 | is missing too | 90 | is missing too |
91 | .Fl -dir-printf | 91 | .Fl -dir-printf |
92 | defaults to | 92 | defaults to |
93 | .Dq #%n:\engnunet-download -o "%f" -R %u\en\en Ns | 93 | .Ql #%n:\engnunet-download -o "%f" -R %u\en\en Ns |
94 | \&. | 94 | \&. |
95 | .It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT | 95 | .It Fl f Ar FORMAT | Fl -printf= Ns Ar FORMAT |
96 | Write the search results according to | 96 | Write the search results according to |
@@ -126,6 +126,13 @@ an ASCII NUL. | |||
126 | the character whose ASCII code is N..., expressed in octal digits | 126 | the character whose ASCII code is N..., expressed in octal digits |
127 | .It Li \exX... | 127 | .It Li \exX... |
128 | the character whose ASCII code is X..., expressed in hexadecimal digits | 128 | the character whose ASCII code is X..., expressed in hexadecimal digits |
129 | .Pp | ||
130 | .El | ||
131 | .Sy Note: | ||
132 | The | ||
133 | .Ql \e | ||
134 | character followed by any other character not listed above is treated as an ordinary character, so both characters are printed. | ||
135 | .Bl -tag -width indent | ||
129 | .It Li %% | 136 | .It Li %% |
130 | a percent sign | 137 | a percent sign |
131 | .It Li %a | 138 | .It Li %a |
@@ -156,15 +163,24 @@ the file's size in bytes | |||
156 | the file's URI | 163 | the file's URI |
157 | .El | 164 | .El |
158 | .Pp | 165 | .Pp |
166 | .Sy Note: | ||
167 | The | ||
168 | .Ql % | ||
169 | character followed by any other character not listed above is treated as an ordinary character, so both characters are printed. | ||
170 | .Pp | ||
159 | If missing, | 171 | If missing, |
160 | .Fl -printf | 172 | .Fl -printf |
161 | defaults to | 173 | defaults to |
162 | .Dq #%n:\engnunet-download -o "%f" %u\en\en Ns | 174 | .Ql #%n:\engnunet-download -o "%f" %u\en\en Ns |
163 | \&. | 175 | \&. |
164 | .It Fl h | -help | 176 | .It Fl h | -help |
165 | Print the help page. | 177 | Print the help page. |
166 | .It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT | 178 | .It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT |
167 | When the %a or %j format specifiers appear in | 179 | When the |
180 | .Ql %a | ||
181 | or | ||
182 | .Ql %j | ||
183 | format specifiers appear in | ||
168 | .Fl -printf | 184 | .Fl -printf |
169 | or | 185 | or |
170 | .Fl -dir-printf Ns | 186 | .Fl -dir-printf Ns |
@@ -196,12 +212,17 @@ the property type (available only if compiled with libextractor) | |||
196 | the name of the plugin that provided the information | 212 | the name of the plugin that provided the information |
197 | .El | 213 | .El |
198 | .Pp | 214 | .Pp |
215 | .Sy Note: | ||
216 | The | ||
217 | .Ql % | ||
218 | character followed by any other character not listed above is treated as an ordinary character, so both characters are printed. | ||
219 | .Pp | ||
199 | If missing, | 220 | If missing, |
200 | .Fl -iter-printf | 221 | .Fl -iter-printf |
201 | defaults to | 222 | defaults to |
202 | .Dq \& \& %t: %p\en | 223 | .Ql \& \& %t: %p\en |
203 | or | 224 | or |
204 | .Dq \& \& MetaType #%i: %p\en Ns | 225 | .Ql \& \& MetaType #%i: %p\en Ns |
205 | , depending on whether the program was compiled with libextractor or not. | 226 | , depending on whether the program was compiled with libextractor or not. |
206 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | 227 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
207 | Change the loglevel. | 228 | Change the loglevel. |
@@ -231,7 +252,7 @@ argument is required). | |||
231 | Automatically timeout search after | 252 | Automatically timeout search after |
232 | .Ar DELAY . | 253 | .Ar DELAY . |
233 | The value given must be a number followed by a space and a time unit, for example "500 ms". | 254 | The value given must be a number followed by a space and a time unit, for example "500 ms". |
234 | Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1 second = 1000000). | 255 | Note that the quotes are required on the shell. Without a unit it defaults to microseconds (1000000 = 1 second). |
235 | If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C. | 256 | If 0 or omitted the search runs until gnunet-search is aborted with CTRL-C. |
236 | .It Fl v | -version | 257 | .It Fl v | -version |
237 | print the version number | 258 | print the version number |
@@ -269,12 +290,26 @@ prefix makes a keyword mandatory. | |||
269 | .Pa ~/.config/gnunet.conf | 290 | .Pa ~/.config/gnunet.conf |
270 | GNUnet configuration file; specifies the default value for the timeout | 291 | GNUnet configuration file; specifies the default value for the timeout |
271 | .Sh EXAMPLES | 292 | .Sh EXAMPLES |
272 | .Dl $ gnunet-search "Das Kapital" | 293 | Example 1: |
294 | .Pp | ||
295 | .Dl $ gnunet-search 'Das Kapital' | ||
273 | .Pp | 296 | .Pp |
274 | searches for content matching the keyword | 297 | searches for content matching the keyword |
275 | .Dq Das Kapital Ns | 298 | .Dq Das Kapital Ns |
276 | . | 299 | . |
277 | .Pp | 300 | .Pp |
301 | Example 2: | ||
302 | .Pp | ||
303 | .Dl $ gnunet-search Das Kapital | ||
304 | .Pp | ||
305 | searches for content matching either keyword | ||
306 | .Dq Das | ||
307 | or keyword | ||
308 | .Dq Kapital Ns | ||
309 | . | ||
310 | .Pp | ||
311 | Example 3: | ||
312 | .Pp | ||
278 | .Dl $ gnunet-search +Das +Kapital | 313 | .Dl $ gnunet-search +Das +Kapital |
279 | .Pp | 314 | .Pp |
280 | searches for content matching both mandatory keywords | 315 | searches for content matching both mandatory keywords |
@@ -283,19 +318,22 @@ and | |||
283 | .Dq Kapital Ns | 318 | .Dq Kapital Ns |
284 | . | 319 | . |
285 | .sp | 320 | .sp |
286 | Search results are printed by gnunet-search like this: | 321 | Search results are printed by |
322 | .Nm gnunet-search | ||
323 | like this: | ||
287 | .Pp | 324 | .Pp |
288 | .ad l | 325 | .ad l |
289 | gnunet-download -V -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE | 326 | gnunet-download -V -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE |
290 | 327 | .Pp | |
291 | Description: The GNU General Public License | 328 | Description: The GNU General Public License |
292 | Mime-type: text/plain | 329 | Mime-type: text/plain |
293 | ... | 330 | ... |
294 | .ad b | 331 | .ad b |
295 | 332 | .Pp | |
296 | The first line contains the command to run to download the file. | 333 | The first line contains the command to run to download the file. |
297 | The suggested filename in the example is COPYING. | 334 | The suggested filename in the example is |
298 | The GNUnet URI consists of the key and query hash of the file and finally the size of the file. | 335 | .Ql COPYING Ns |
336 | \&. The GNUnet URI consists of the key and query hash of the file and finally the size of the file. | ||
299 | If the | 337 | If the |
300 | .Fl -verbose | 338 | .Fl -verbose |
301 | option was provided, after the command to download the file, GNUnet will print meta-data about the file as advertised in the search result. | 339 | option was provided, after the command to download the file, GNUnet will print meta-data about the file as advertised in the search result. |