aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-search.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-search.1')
-rw-r--r--doc/man/gnunet-search.173
1 files changed, 61 insertions, 12 deletions
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 7f30812e0..1e0973b63 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -9,17 +9,49 @@ gnunet\-search \- a command line interface to search for content on GNUnet
9[\fIOPTIONS\fR] [+]\fIURI\fR 9[\fIOPTIONS\fR] [+]\fIURI\fR
10.SH DESCRIPTION 10.SH DESCRIPTION
11.PP 11.PP
12Search for content on GNUnet. The keywords are case\-sensitive. gnunet\-search can be used both for a search in the global namespace as well as for searching a private subspace. 12Search for content on GNUnet. The keywords are case\-sensitive.
13gnunet\-search can be used both for a search in the global namespace
14as well as for searching a private subspace.
13.TP 15.TP
14\fB\-a \fILEVEL\fR, \fB\-\-anonymity=\fILEVEL\fR 16\fB\-a \fILEVEL\fR, \fB\-\-anonymity=\fILEVEL\fR
15 17
16The \fB\-a\fR option can be used to specify additional anonymity constraints. If set to 0, GNUnet will try to download the file as fast as possible, including using non-anonymous methods. If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. You can gain better privacy by specifying a higher level of anonymity, which increases the amount of cover traffic your own traffic will get, at the expense of performance. Note that your download performance is not only determined by your own anonymity level, but also by the anonymity level of the peers publishing the file. So even if you download with anonymity level 0, the peers publishing the data might be sharing with a higher anonymity level, which in this case will determine performance. Also, peers that cache content in the network always use anonymity level 1. 18The \fB\-a\fR option can be used to specify additional anonymity
17 19constraints. If set to 0, GNUnet will try to download the file as fast
18This option can be used to limit requests further than that. In particular, you can require GNUnet to receive certain amounts of traffic from other peers before sending your queries. This way, you can gain very high levels of anonymity \- at the expense of much more traffic and much higher latency. So set it only if you really believe you need it. 20as possible, including using non-anonymous methods. If you set it to
19 211 (default), you use the standard anonymous routing algorithm (which
20The definition of ANONYMITY\-RECEIVE is the following. 0 means no anonymity is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic can be from the local user, leaving 'v-1' bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of queries in the same time\-period. The time\-period is twice the average delay that GNUnet defers forwarded queries. 22does not explicitly leak your identity). However, a powerful
21 23adversary may still be able to perform traffic analysis (statistics)
22The default is 1 and this should be fine for most users. Also notice that if you choose very large values, you may end up having no throughput at all, especially if many of your fellow GNUnet\-peers all do the same. 24to over time infer data about your identity. You can gain better
25privacy by specifying a higher level of anonymity, which increases the
26amount of cover traffic your own traffic will get, at the expense of
27performance. Note that your download performance is not only
28determined by your own anonymity level, but also by the anonymity
29level of the peers publishing the file. So even if you download with
30anonymity level 0, the peers publishing the data might be sharing with
31a higher anonymity level, which in this case will determine
32performance. Also, peers that cache content in the network always use
33anonymity level 1.
34
35This option can be used to limit requests further than that. In
36particular, you can require GNUnet to receive certain amounts of
37traffic from other peers before sending your queries. This way, you
38can gain very high levels of anonymity \- at the expense of much more
39traffic and much higher latency. So set it only if you really believe
40you need it.
41
42The definition of ANONYMITY\-RECEIVE is the following. 0 means no
43anonymity is required. Otherwise a value of 'v' means that 1 out of v
44bytes of "anonymous" traffic can be from the local user, leaving 'v-1'
45bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n
46bytes of messages from foreign peers (using anonymous routing), it may
47originate n/(v-1) bytes of queries in the same time\-period. The
48time\-period is twice the average delay that GNUnet defers forwarded
49queries.
50
51The default is 1 and this should be fine for most users. Also notice
52that if you choose very large values, you may end up having no
53throughput at all, especially if many of your fellow GNUnet\-peers all
54do the same.
23 55
24.TP 56.TP
25\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR 57\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
@@ -48,7 +80,10 @@ automatically terminate the search after receiving VALUE results.
48 80
49.TP 81.TP
50\fB\-t \fIDELAY\fR, \fB\-\-timeout=\fIDELAY\fR 82\fB\-t \fIDELAY\fR, \fB\-\-timeout=\fIDELAY\fR
51Automatically timeout search after DELAY. The value given must be a number followed by a space and a time unit, for example "500 ms". Note that the quotes are required on the shell. Otherwise the search runs until gnunet\-search is aborted with CTRL\-C. 83Automatically timeout search after DELAY. The value given must be a
84number followed by a space and a time unit, for example "500 ms".
85Note that the quotes are required on the shell. Otherwise the search
86runs until gnunet\-search is aborted with CTRL\-C.
52 87
53.TP 88.TP
54\fB\-v\fR, \fB\-\-version\fR 89\fB\-v\fR, \fB\-\-version\fR
@@ -59,9 +94,17 @@ print the version number
59print meta data from search results as well 94print meta data from search results as well
60.SH NOTES 95.SH NOTES
61 96
62You can run gnunet\-search with an URI instead of a keyword. The URI can have the format for a namespace search or for a keyword search. For a namespace search, the format is gnunet://fs/sks/NAMESPACE/IDENTIFIER. For a keyword search, use gnunet://fs/ksk/KEYWORD[+KEYWORD]*. If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. 97You can run gnunet\-search with an URI instead of a keyword. The URI
98can have the format for a namespace search or for a keyword search.
99For a namespace search, the format is
100gnunet://fs/sks/NAMESPACE/IDENTIFIER. For a keyword search, use
101gnunet://fs/ksk/KEYWORD[+KEYWORD]*. If the format does not correspond
102to a GNUnet URI, GNUnet will automatically assume that keywords are
103supplied directly.
63 104
64If multiple keywords are passed, gnunet-search will look for content matching any of the keywords. The prefix "+" makes a keyword mandatory. 105If multiple keywords are passed, gnunet-search will look for content
106matching any of the keywords. The prefix "+" makes a keyword
107mandatory.
65 108
66# gnunet\-search "Das Kapital" 109# gnunet\-search "Das Kapital"
67 110
@@ -81,7 +124,13 @@ Search results are printed by gnunet\-search like this:
81 Mime-type: text/plain 124 Mime-type: text/plain
82.ad b 125.ad b
83 126
84The first line contains the command to run to download the file. The suggested filename in the example is COPYING. The GNUnet URI consists of the key and query hash of the file and finally the size of the file. After 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). 127The first line contains the command to run to download the file. The
128suggested filename in the example is COPYING. The GNUnet URI consists
129of the key and query hash of the file and finally the size of the
130file. After the command to download the file GNUnet will print
131meta\-data about the file as advertised in the search result, here
132"The GNU General Public License" and the mime\-type (see the options
133for gnunet\-publish on how to supply meta-data by hand).
85 134
86.SH FILES 135.SH FILES
87.TP 136.TP