aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-search.1
diff options
context:
space:
mode:
authormadmurphy <madmurphy333@gmail.com>2022-02-11 03:20:27 +0000
committermadmurphy <madmurphy333@gmail.com>2022-02-11 03:20:27 +0000
commitc4bd3744ac1452e88e9e6b19e38ad8d397bc2dc3 (patch)
tree204f2c79dee8a662060ee066c4711ae5358ee13e /doc/man/gnunet-search.1
parent0e04edc6bf5a03eabc367114a945ade0d40690a1 (diff)
downloadgnunet-c4bd3744ac1452e88e9e6b19e38ad8d397bc2dc3.tar.gz
gnunet-c4bd3744ac1452e88e9e6b19e38ad8d397bc2dc3.zip
`man gnunet-search`: general review
Diffstat (limited to 'doc/man/gnunet-search.1')
-rw-r--r--doc/man/gnunet-search.188
1 files changed, 56 insertions, 32 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 633e72961..ff21f4670 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -80,15 +80,15 @@ Use the configuration file
80Write the search results for directories according to 80Write the search results for directories according to
81.Ar FORMAT Ns 81.Ar FORMAT Ns
82\&. The directives supported here are identical to those supported in the 82\&. The directives supported here are identical to those supported in the
83.Nm --printf 83.Fl -printf
84argument (please refer to it for more information). If missing, 84argument (please refer to it for more information). If missing,
85.Nm --dir-printf 85.Fl -dir-printf
86defaults to 86defaults to
87.Nm --printf Ns 87.Fl -printf Ns
88\&. If 88\&. If
89.Nm --printf 89.Fl -printf
90is missing too 90is missing too
91.Nm --dir-printf 91.Fl -dir-printf
92defaults to 92defaults to
93.Dq #%n:\engnunet-download -o "%f" -R %u\en\en Ns 93.Dq #%n:\engnunet-download -o "%f" -R %u\en\en Ns
94\&. 94\&.
@@ -129,8 +129,8 @@ the character whose ASCII code is X..., expressed in hexadecimal digits
129.It Li %% 129.It Li %%
130a percent sign 130a percent sign
131.It Li %a 131.It Li %a
132the complete list of all the printable metadata available, displayed according to the 132the complete list of all the printable metadata properties available, displayed according to the
133.Nm --iter-printf 133.Fl -iter-printf
134argument; this specifier optionally supports metatype filtering via hash sign 134argument; this specifier optionally supports metatype filtering via hash sign
135.No (e.g. 135.No (e.g.
136.Dq %2#a 136.Dq %2#a
@@ -138,8 +138,8 @@ prints all embedded file names, if present - see libextractor's metatypes for th
138.It Li %f 138.It Li %f
139the file's name 139the file's name
140.It Li %j 140.It Li %j
141the first printable metadatum available, displayed according to the 141the first printable metadata property available, displayed according to the
142.Nm --iter-printf 142.Fl -iter-printf
143argument; this specifier optionally supports metatype filtering via hash sign 143argument; this specifier optionally supports metatype filtering via hash sign
144.No (e.g. 144.No (e.g.
145.Dq %5#j 145.Dq %5#j
@@ -157,7 +157,7 @@ the file's URI
157.El 157.El
158.Pp 158.Pp
159If missing, 159If missing,
160.Nm --printf 160.Fl -printf
161defaults to 161defaults to
162.Dq #%n:\engnunet-download -o "%f" %u\en\en Ns 162.Dq #%n:\engnunet-download -o "%f" %u\en\en Ns
163\&. 163\&.
@@ -165,17 +165,17 @@ defaults to
165Print the help page. 165Print the help page.
166.It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT 166.It Fl i Ar FORMAT | Fl -iter-printf= Ns Ar FORMAT
167When the %a or %j format specifiers appear in 167When the %a or %j format specifiers appear in
168.Nm --printf 168.Fl -printf
169or 169or
170.Nm --dir-printf Ns 170.Fl -dir-printf Ns
171, list each metadata property according to 171, list each metadata property according to
172.Ar FORMAT Ns 172.Ar FORMAT Ns
173, in which the 173, in which the
174.Ql \e 174.Ql \e
175directives are interpreted as in 175directives are interpreted as in
176.Nm --printf 176.Fl -printf
177and 177and
178.Nm --dir-printf Ns 178.Fl -dir-printf Ns
179, while the 179, while the
180.Ql % 180.Ql %
181directives are interpreted as follows: 181directives are interpreted as follows:
@@ -191,13 +191,13 @@ the property type's unique identifier
191.It Li %n 191.It Li %n
192the property number 192the property number
193.It Li %t 193.It Li %t
194the property type's string (available only if compiled with libextractor) 194the property type (available only if compiled with libextractor)
195.It Li %w 195.It Li %w
196the name of the plugin that provided the information 196the name of the plugin that provided the information
197.El 197.El
198.Pp 198.Pp
199If missing, 199If missing,
200.Nm --iter-printf 200.Fl -iter-printf
201defaults to 201defaults to
202.Dq \& \& %t: %p\en 202.Dq \& \& %t: %p\en
203or 203or
@@ -205,7 +205,9 @@ or
205, depending on whether the program was compiled with libextractor or not. 205, depending on whether the program was compiled with libextractor or not.
206.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 206.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
207Change the loglevel. 207Change the loglevel.
208Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 208Possible values for
209.Ar LOGLEVEL
210are ERROR, WARNING, INFO and DEBUG.
209.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME 211.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
210Write logs to 212Write logs to
211.Ar FILENAME . 213.Ar FILENAME .
@@ -223,7 +225,7 @@ Automatically terminate the search after receiving
223results. 225results.
224.It Fl s | -silent 226.It Fl s | -silent
225Enable silent mode and do not print any result (the 227Enable silent mode and do not print any result (the
226.Nm --output 228.Fl -output
227argument is required). 229argument is required).
228.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY 230.It Fl t Ar DELAY | Fl -timeout= Ns Ar DELAY
229Automatically timeout search after 231Automatically timeout search after
@@ -237,13 +239,15 @@ print the version number
237append 239append
238.Dq %a\en 240.Dq %a\en
239to the default 241to the default
240.Nm --printf 242.Fl -printf
241and 243and
242.Nm --dir-printf 244.Fl -dir-printf
243arguments \[u2013] ignored when these are provided by the user 245arguments \[u2013] ignored when these are provided by the user
244.El 246.El
245.Pp 247.Pp
246You can run gnunet-search with an URI instead of a keyword. 248It is possible to run
249.Nm gnunet-search
250with an URI instead of a keyword.
247The URI can have the format for a namespace search or for a keyword search. 251The URI can have the format for a namespace search or for a keyword search.
248For a namespace search, the format is 252For a namespace search, the format is
249.Pp 253.Pp
@@ -255,33 +259,53 @@ For a keyword search, use
255.Pp 259.Pp
256If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. 260If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly.
257.sp 261.sp
258If multiple keywords are passed, gnunet-search will look for content matching any of the keywords. 262If multiple keywords are passed,
259The prefix "+" makes a keyword mandatory. 263.Nm gnunet-search
264will look for content matching any of the keywords.
265The
266.Ql +
267prefix makes a keyword mandatory.
260.Sh FILES 268.Sh FILES
261.Pa ~/.config/gnunet.conf 269.Pa ~/.config/gnunet.conf
262GNUnet configuration file; specifies the default value for the timeout 270GNUnet configuration file; specifies the default value for the timeout
263.Sh EXAMPLES 271.Sh EXAMPLES
264.Dl $ gnunet-search "Das Kapital" 272.Dl $ gnunet-search "Das Kapital"
265.Pp 273.Pp
266Searches for content matching the keyword "Das Kapital". 274searches for content matching the keyword
275.Dq Das Kapital Ns
276.
267.Pp 277.Pp
268.Dl $ gnunet-search +Das +Kapital 278.Dl $ gnunet-search +Das +Kapital
269.Pp 279.Pp
270Searches for content matching both mandatory keywords "Das" and "Kapital". 280searches for content matching both mandatory keywords
281.Dq Das
282and
283.Dq Kapital Ns
284.
271.sp 285.sp
272Search results are printed by gnunet-search like this: 286Search results are printed by gnunet-search like this:
273.Pp 287.Pp
274.ad l 288.ad l
275 gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE 289 gnunet-download -V -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
276 Description: The GNU General Public License 290
277 Mime-type: text/plain 291 Description: The GNU General Public License
292 Mime-type: text/plain
293 ...
278.ad b 294.ad b
279 295
280The first line contains the command to run to download the file. 296The first line contains the command to run to download the file.
281The suggested filename in the example is COPYING. 297The suggested filename in the example is COPYING.
282The GNUnet URI consists of the key and query hash of the file and finally the size of the file. 298The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
283After the command to download the file, GNUnet will print meta-data about the file as advertised in the search result. 299If the
284The meta-data here is the description ("The GNU General Public License") and the mime-type ("text-plain"). 300.Fl -verbose
301option was provided, after the command to download the file, GNUnet will print meta-data about the file as advertised in the search result.
302The meta-data here is the description
303.No ( Ns
304.Dq The GNU General Public License Ns
305) and the mime-type
306.No ( Ns
307.Dq text-plain Ns
308).
285See the options for 309See the options for
286.Xr gnunet-publish 1 310.Xr gnunet-publish 1
287on how to supply meta-data by hand. 311on how to supply meta-data by hand.
@@ -291,10 +315,10 @@ on how to supply meta-data by hand.
291.Xr gnunet-publish 1 , 315.Xr gnunet-publish 1 ,
292.Xr gnunet.conf 5 316.Xr gnunet.conf 5
293.sp 317.sp
294The full documentation for gnunet is maintained as a Texinfo manual. 318The full documentation for GNUnet is maintained as a Texinfo manual.
295If the 319If the
296.Xr info 1 320.Xr info 1
297and gnunet programs are properly installed at your site, the command 321and gnunet packages are properly installed at your site, the command
298.Pp 322.Pp
299.Dl info gnunet 323.Dl info gnunet
300.Pp 324.Pp