aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-search.1
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-21 20:08:52 +0000
committerng0 <ng0@n0.is>2019-04-21 20:08:52 +0000
commita07991f9be04ede254b6e4991c7cfda44bd53700 (patch)
tree4f85ecaaea370bb36d6e5cd4aa661cd6eb0e3f51 /doc/man/gnunet-search.1
parentabc12a14473dc304b2388901add772ba0711f087 (diff)
downloadgnunet-a07991f9be04ede254b6e4991c7cfda44bd53700.tar.gz
gnunet-a07991f9be04ede254b6e4991c7cfda44bd53700.zip
manpages.
Diffstat (limited to 'doc/man/gnunet-search.1')
-rw-r--r--doc/man/gnunet-search.154
1 files changed, 38 insertions, 16 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 58e16ea7b..484bfca24 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -1,3 +1,26 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V.
3.\"
4.\" Permission is granted to copy, distribute and/or modify this document
5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" ``FDL-1.3''.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" ``GPL3''.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
1.Dd February 25, 2012 24.Dd February 25, 2012
2.Dt GNUNET-SEARCH 1 25.Dt GNUNET-SEARCH 1
3.Os 26.Os
@@ -24,27 +47,26 @@ Search for content on GNUnet.
24The keywords are case-sensitive. 47The keywords are case-sensitive.
25.Nm 48.Nm
26can be used both for a search in the global namespace as well as for searching a private subspace. 49can be used both for a search in the global namespace as well as for searching a private subspace.
27.Sh OPTIONS 50The options are as follows:
28.Bl -tag -width Ds 51.Bl -tag -width Ds
29.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL 52.It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
30This option can be used to specify additional anonymity constraints. The default is 1. 53This option can be used to specify additional anonymity constraints.
54The default is 1.
31If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key. 55If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key.
32This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer). 56This will allow other users to download the file as fast as possible, including using non-anonymous methods (discovery via DHT and CADET transfer).
33If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). 57If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
34However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity. 58However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time discovery your identity.
35You can gain better privacy by specifying a higher level of anonymity (using values above 1). 59You can gain better privacy by specifying a higher level of anonymity (using values above 1).
36This tells FS that it must hide your own requests in equivalent\-looking cover traffic. 60This tells FS that it must hide your own requests in equivalent-looking cover traffic.
37This should confound an adversaries traffic analysis, increasing the time and effort it would 61This should confound an adversaries traffic analysis, increasing the time and effort it would take to discover your identity.
38take to discover your identity. However, it also can significantly reduce performance, as 62However, it also can significantly reduce performance, as your requests will be delayed until sufficient cover traffic is available.
39your requests will be delayed until sufficient cover traffic is available. The specific 63The specific numeric value (for anonymity levels above 1) is simple:
40numeric value (for anonymity levels above 1) is simple: 64Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L-1 equivalent requests of cover traffic (traffic your peer routes for others) in the same time-period.
41Given an anonymity level L (above 1), each request FS makes on your behalf must be hidden in L\-1 equivalent 65The time-period is twice the average delay by which GNUnet artificially delays traffic.
42requests of cover traffic (traffic your peer routes for others) in the same time\-period. 66Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
43The time\-period is twice the average delay by which GNUnet artificially delays traffic.
44Note that regardless of the anonymity level you choose, peers that cache content in the
45network always use anonymity level 1.
46.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 67.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
47use config file (defaults: ~/.config/gnunet.conf) 68Use the configuration file FILENAME (default:
69.Pa ~/.config/gnunet.conf )
48.It Fl h | \-help 70.It Fl h | \-help
49print help page 71print help page
50.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 72.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
@@ -62,13 +84,13 @@ Automatically terminate the search after receiving VALUE results.
62Automatically timeout search after DELAY. 84Automatically timeout search after DELAY.
63The value given must be a number followed by a space and a time unit, for example "500 ms". 85The value given must be a number followed by a space and a time unit, for example "500 ms".
64Note that the quotes are required on the shell. 86Note that the quotes are required on the shell.
65Otherwise the search runs until gnunet\-search is aborted with CTRL\-C. 87Otherwise the search runs until gnunet-search is aborted with CTRL\-C.
66.It Fl v | \-version 88.It Fl v | \-version
67print the version number 89print the version number
68.It Fl V | \-verbose 90.It Fl V | \-verbose
69print meta data from search results as well 91print meta data from search results as well
70.El 92.El
71You can run gnunet\-search with an URI instead of a keyword. 93You can run gnunet-search with an URI instead of a keyword.
72The URI can have the format for a namespace search or for a keyword search. 94The URI can have the format for a namespace search or for a keyword search.
73For a namespace search, the format is 95For a namespace search, the format is
74.Pp 96.Pp
@@ -108,7 +130,7 @@ Search results are printed by gnunet\-search like this:
108The first line contains the command to run to download the file. 130The first line contains the command to run to download the file.
109The suggested filename in the example is COPYING. 131The suggested filename in the example is COPYING.
110The GNUnet URI consists of the key and query hash of the file and finally the size of the file. 132The GNUnet URI consists of the key and query hash of the file and finally the size of the file.
111After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU General Public License" and the mime\-type (see the options for gnunet\-publish on how to supply meta-data by hand). 133After the command to download the file GNUnet will print meta\-data about the file as advertised in the search result, here "The GNU General Public License" and the mime\-type (see the options for gnunet-publish on how to supply meta-data by hand).
112.Sh SEE ALSO 134.Sh SEE ALSO
113.Xr gnunet-fs-gtk 1 , 135.Xr gnunet-fs-gtk 1 ,
114.Xr gnunet\-publish 1 , 136.Xr gnunet\-publish 1 ,