diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/README | 2 | ||||
-rw-r--r-- | doc/man/gnunet-gns.1 | 115 | ||||
-rw-r--r-- | doc/man/gnunet-scrypt.1 | 96 | ||||
-rw-r--r-- | doc/man/gnunet-search.1 | 268 |
4 files changed, 248 insertions, 233 deletions
diff --git a/doc/man/README b/doc/man/README index fb95a11f2..b1c95b754 100644 --- a/doc/man/README +++ b/doc/man/README | |||
@@ -5,4 +5,4 @@ TODO: | |||
5 | 5 | ||
6 | * incomplete pages: | 6 | * incomplete pages: |
7 | - gnunet-timeout | 7 | - gnunet-timeout |
8 | \ No newline at end of file | 8 | - gnunet-gns: Make use of .Ex macro for DIAGNOSTICS section \ No newline at end of file |
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index 750c72d95..decb8f569 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 | |||
@@ -1,60 +1,75 @@ | |||
1 | .TH GNUNET\-GNS 1 "March 23, 2018" "GNUnet" | 1 | .Dd March 23, 2018 |
2 | .SH NAME | 2 | .Dt GNUNET-GNS 1 |
3 | gnunet\-gns \- Access to GNU Name System | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-gns | 5 | .Nm gnunet-gns |
6 | .RI [ options ] | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | access to GNU Name System |
8 | \fBgnunet\-gns\fP can be used to lookup and process GNU Name Service | 8 | .Sh SYNOPSIS |
9 | names. | 9 | .Nm |
10 | .SH OPTIONS | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
11 | .IP "\-c FILENAME, \-\-config=FILENAME" | 11 | .Op Fl h | \-help |
12 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
13 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME | ||
14 | .Op Fl r | \-raw | ||
15 | .Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | ||
16 | .Op Fl u Ar NAME | Fl \-lookup= Ns Ar NAME | ||
17 | .Op Fl v | \-version | ||
18 | .Sh DESCRIPTION | ||
19 | .Nm | ||
20 | can be used to lookup and process GNU Name Service names. | ||
21 | .Bl -tag -width Ds | ||
22 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
12 | Use the configuration file FILENAME. | 23 | Use the configuration file FILENAME. |
13 | .IP "\-r, \-\-raw" | 24 | .It Fl h | \-help |
14 | No unneeded output. | ||
15 | This is a quiet mode where only important information is displayed. | ||
16 | For example a lookup for an IP address will only yield the IP address, | ||
17 | no descriptive text. | ||
18 | .IP "\-h, \-\-help" | ||
19 | Print short help on options. | 25 | Print short help on options. |
20 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 26 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
21 | Use LOGLEVEL for logging. | 27 | Use LOGLEVEL for logging. |
22 | Valid values are DEBUG, INFO, WARNING and ERROR. | 28 | Valid values are DEBUG, INFO, WARNING and ERROR. |
23 | .IP "\-u NAME, \-\-lookup=NAME" | 29 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
24 | Name to lookup. | 30 | Write logs to FILENAME. |
25 | Resolve the specified name using the GNU Name System. | 31 | .It Fl r | \-raw |
26 | .IP "\-t TYPE, \-\-type=TYPE" | 32 | No unneeded output. |
33 | This is a quiet mode where only important information is displayed. | ||
34 | For example a lookup for an IP address will only yield the IP address, no descriptive text. | ||
35 | .It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | ||
27 | Resource Record Type (TYPE) to look for. | 36 | Resource Record Type (TYPE) to look for. |
28 | Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, | 37 | Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR, TXT. |
29 | MX, LEHO, VPN, REV, PTR, TXT. | ||
30 | Defaults to "A". | 38 | Defaults to "A". |
31 | .IP "\-v, \-\-version" | 39 | .It Fl u Ar NAME | Fl \-lookup= Ns Ar NAME |
40 | Name to lookup. | ||
41 | Resolve the specified name using the GNU Name System. | ||
42 | .It Fl v | \-version | ||
32 | Print GNUnet version number. | 43 | Print GNUnet version number. |
33 | .SH RETURN VALUE | 44 | .El |
34 | gnunet\-gns will return 0 on success, 1 on internal failures, 2 on | 45 | .Sh DIAGNOSTICS |
46 | .Nm | ||
47 | will return 0 on success, 1 on internal failures, 2 on | ||
35 | launch failures, 4 if the given name is not configured to use GNS. | 48 | launch failures, 4 if the given name is not configured to use GNS. |
36 | .SH BUGS | 49 | .Sh SEE ALSO |
37 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 50 | .Xr gnunet-namestore 1 , |
38 | electronic mail to <gnunet\-developers@gnu.org> | 51 | .Xr gnunet-identity 1 |
39 | .SH SEE ALSO | 52 | .sp |
40 | \fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1) | 53 | The full documentation for gnunet is maintained as a Texinfo manual. |
41 | .PP | 54 | If the |
42 | The full documentation for | 55 | .Xr info 1 |
43 | .B gnunet | 56 | and gnunet programs are properly installed at your site, the command |
44 | is maintained as a Texinfo manual. If the | 57 | .Pp |
45 | .B info | 58 | .Dl info gnunet |
46 | and | 59 | .Pp |
47 | .B gnunet | ||
48 | programs are properly installed at your site, the command | ||
49 | .IP | ||
50 | .B info gnunet | ||
51 | .PP | ||
52 | should give you access to the complete handbook, | 60 | should give you access to the complete handbook, |
53 | .IP | 61 | .Pp |
54 | .B info gnunet-c-tutorial | 62 | .Dl info gnunet-c-tutorial |
55 | .PP | 63 | .Pp |
56 | will give you access to a tutorial for developers. | 64 | will give you access to a tutorial for developers. |
57 | .PP | 65 | .sp |
58 | Depending on your installation, this information is also | 66 | Depending on your installation, this information is also available in |
59 | available in | 67 | .Xr gnunet 7 and |
60 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 68 | .Xr gnunet-c-tutorial 7 . |
69 | .\".Sh HISTORY | ||
70 | .\".Sh AUTHORS | ||
71 | .Sh BUGS | ||
72 | Report bugs by using | ||
73 | .Lk https://bugs.gnunet.org | ||
74 | or by sending electronic mail to | ||
75 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1 index 545af37e9..915acbb7a 100644 --- a/doc/man/gnunet-scrypt.1 +++ b/doc/man/gnunet-scrypt.1 | |||
@@ -1,51 +1,65 @@ | |||
1 | .TH GNUNET-SCRYPT 1 "September 13, 2014" "GNUnet" | 1 | .Dd September 13, 2014 |
2 | .SH NAME | 2 | .Dt GNUNET-SCRYPT 1 |
3 | gnunet\-scrypt \- Manipulate GNUnet proof of work files. | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-scrypt | 5 | .Nm gnunet-scrypt |
6 | .RI [ options ] | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | manipulate GNUnet proof of work files |
8 | \fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof of work files. | 8 | .Sh SYNOPSIS |
9 | .SH OPTIONS | 9 | .Nm |
10 | .IP "\-b BITS, \-\-bits=BITS" | 10 | .Op Fl b Ar BITS | Fl \-bits= Ns Ar BITS |
11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
12 | .Op Fl h | \-help | ||
13 | .Op Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME | ||
14 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
15 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME | ||
16 | .Op Fl o Ar FILENAME | Fl \-outfile= Ns Ar FILENAME | ||
17 | .Op Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY | ||
18 | .Op Fl v | \-version | ||
19 | .Sh DESCRIPTION | ||
20 | .Nm | ||
21 | is a command line tool to manipulate GNUnet proof of work files. | ||
22 | .Bl -tag -width Ds | ||
23 | .It Fl b Ar BITS | Fl \-bits= Ns Ar BITS | ||
11 | Number of bits to require for the proof of work. | 24 | Number of bits to require for the proof of work. |
12 | .IP "\-c FILENAME, \-\-config=FILENAME" | 25 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
13 | Use the configuration file FILENAME. | 26 | Use the configuration file FILENAME. |
14 | .IP "\-h, \-\-help" | 27 | .It Fl h | \-help |
15 | Print short help on options. | 28 | Print short help on options. |
16 | .IP "\-k FILE, \-\-keyfile=FILE" | 29 | .It Fl k Ar FILENAME | Fl \-keyfile= Ns Ar FILENAME |
17 | File with private key, otherwise default is used. | 30 | File with private key, otherwise default is used. |
18 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 31 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
19 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 32 | Use LOGLEVEL for logging. |
20 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | 33 | Valid values are DEBUG, INFO, WARNING and ERROR. |
21 | Configure logging to write logs to LOGFILE. | 34 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
22 | .IP "\-o FILE, \-\-outfile=FILE" | 35 | Configure logging to write logs to FILENAME. |
36 | .It Fl o Ar FILENAME | Fl \-outfile= Ns Ar FILENAME | ||
23 | File with proof of work, otherwise default is used. | 37 | File with proof of work, otherwise default is used. |
24 | .IP "\-t TIME, \-\-timeout=TIME" | 38 | .It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY |
25 | Time to wait between calculations. | 39 | Time to wait between calculations. |
26 | .IP "\-v, \-\-version" | 40 | .It Fl v | \-version |
27 | Print GNUnet version number. | 41 | Print GNUnet version number. |
28 | .SH BUGS | 42 | .Sh SEE ALSO |
29 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 43 | The full documentation for gnunet is maintained as a Texinfo manual. |
30 | electronic mail to <gnunet\-developers@gnu.org> | ||
31 | .SH SEE ALSO | ||
32 | The full documentation for | ||
33 | .B gnunet | ||
34 | is maintained as a Texinfo manual. | ||
35 | If the | 44 | If the |
36 | .B info | 45 | .Xr info 1 |
37 | and | 46 | and gnunet programs are properly installed at your site, the command |
38 | .B gnunet | 47 | .Pp |
39 | programs are properly installed at your site, the command | 48 | .Dl info gnunet |
40 | .IP | 49 | .Pp |
41 | .B info gnunet | ||
42 | .PP | ||
43 | should give you access to the complete handbook, | 50 | should give you access to the complete handbook, |
44 | .IP | 51 | .Pp |
45 | .B info gnunet-c-tutorial | 52 | .Dl info gnunet-c-tutorial |
46 | .PP | 53 | .Pp |
47 | will give you access to a tutorial for developers. | 54 | will give you access to a tutorial for developers. |
48 | .PP | 55 | .sp |
49 | Depending on your installation, this information is also | 56 | Depending on your installation, this information is also available in |
50 | available in | 57 | .Xr gnunet 7 and |
51 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 58 | .Xr gnunet-c-tutorial 7 . |
59 | .\".Sh HISTORY | ||
60 | .\".Sh AUTHORS | ||
61 | .Sh BUGS | ||
62 | Report bugs by using | ||
63 | .Lk https://bugs.gnunet.org | ||
64 | or by sending electronic mail to | ||
65 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index af72d369d..c1bb7c1e4 100644 --- a/doc/man/gnunet-search.1 +++ b/doc/man/gnunet-search.1 | |||
@@ -1,121 +1,108 @@ | |||
1 | .TH GNUNET-SEARCH "1" "February 25, 2012" "0.9.6" "GNUnet" | 1 | .Dd February 25, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-SEARCH 1 |
3 | gnunet\-search \- a command line interface to search for content on GNUnet | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-search | 5 | .Nm gnunet-search |
6 | [\fIOPTIONS\fR] [+]\fIKEYWORD\fR [[+]\fIKEYWORD\fR]* | 6 | .Nd |
7 | 7 | a command line interface to search for content on GNUnet | |
8 | .B gnunet\-search | 8 | .Sh SYNOPSIS |
9 | [\fIOPTIONS\fR] [+]\fIURI\fR | 9 | .Nm |
10 | .SH DESCRIPTION | 10 | .Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL |
11 | .PP | 11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
12 | Search for content on GNUnet. The keywords are case\-sensitive. | 12 | .Op Fl h | \-help |
13 | gnunet\-search can be used both for a search in the global namespace | 13 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
14 | as well as for searching a private subspace. | 14 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
15 | .TP | 15 | .Op Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME |
16 | \fB\-a \fILEVEL\fR, \fB\-\-anonymity=\fILEVEL\fR | 16 | .Op Fl n | \-no-network |
17 | 17 | .Op Fl N Ar VALUE | Fl \-results= Ns Ar VALUE | |
18 | The \fB\-a\fR option can be used to specify additional anonymity | 18 | .Op Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY |
19 | constraints. If set to 0, GNUnet will try to download the file as fast | 19 | .Op Fl v | \-version |
20 | as possible, including using non-anonymous methods. If you set it to | 20 | .Op Fl V | \-verbose |
21 | 1 (default), you use the standard anonymous routing algorithm (which | 21 | .Ao KEYWORD Ac Ao +KEYWORD Ac | Ao Ar URI Ac Ao Ar +URI Ac |
22 | does not explicitly leak your identity). However, a powerful | 22 | .Sh DESCRIPTION |
23 | adversary may still be able to perform traffic analysis (statistics) | 23 | Search for content on GNUnet. |
24 | to over time infer data about your identity. You can gain better | 24 | The keywords are case-sensitive. |
25 | privacy by specifying a higher level of anonymity, which increases the | 25 | .Nm |
26 | amount of cover traffic your own traffic will get, at the expense of | 26 | can be used both for a search in the global namespace as well as for searching a private subspace. |
27 | performance. Note that your download performance is not only | 27 | .Bl -tag -width Ds |
28 | determined by your own anonymity level, but also by the anonymity | 28 | .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL |
29 | level of the peers publishing the file. So even if you download with | 29 | The \fB\-a\fR option can be used to specify additional anonymity constraints. |
30 | anonymity level 0, the peers publishing the data might be sharing with | 30 | If set to 0, GNUnet will try to download the file as fast as possible, including using non-anonymous methods. |
31 | a higher anonymity level, which in this case will determine | 31 | If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity). |
32 | performance. Also, peers that cache content in the network always use | 32 | However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity. |
33 | anonymity level 1. | 33 | 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. |
34 | 34 | 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. | |
35 | This option can be used to limit requests further than that. In | 35 | 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. |
36 | particular, you can require GNUnet to receive certain amounts of | 36 | Also, peers that cache content in the network always use anonymity level 1. |
37 | traffic from other peers before sending your queries. This way, you | 37 | .sp |
38 | can gain very high levels of anonymity \- at the expense of much more | 38 | This option can be used to limit requests further than that. |
39 | traffic and much higher latency. So set it only if you really believe | 39 | In particular, you can require GNUnet to receive certain amounts of traffic from other peers before sending your queries. |
40 | you need it. | 40 | This way, you can gain very high levels of anonymity \- at the expense of much more traffic and much higher latency. |
41 | 41 | So set it only if you really believe you need it. | |
42 | The definition of ANONYMITY\-RECEIVE is the following. 0 means no | 42 | .sp |
43 | anonymity is required. Otherwise a value of 'v' means that 1 out of v | 43 | The definition of ANONYMITY\-RECEIVE is the following. |
44 | bytes of "anonymous" traffic can be from the local user, leaving 'v-1' | 44 | 0 means no anonymity is required. |
45 | bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n | 45 | 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. |
46 | bytes of messages from foreign peers (using anonymous routing), it may | 46 | 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. |
47 | originate n/(v-1) bytes of queries in the same time\-period. The | 47 | The time\-period is twice the average delay that GNUnet defers forwarded queries. |
48 | time\-period is twice the average delay that GNUnet defers forwarded | 48 | .sp |
49 | queries. | 49 | The default is 1 and this should be fine for most users. |
50 | 50 | 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. | |
51 | The default is 1 and this should be fine for most users. Also notice | 51 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
52 | that if you choose very large values, you may end up having no | ||
53 | throughput at all, especially if many of your fellow GNUnet\-peers all | ||
54 | do the same. | ||
55 | |||
56 | .TP | ||
57 | \fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR | ||
58 | use config file (defaults: ~/.config/gnunet.conf) | 52 | use config file (defaults: ~/.config/gnunet.conf) |
59 | 53 | .It Fl h | \-help | |
60 | .TP | ||
61 | \fB\-h\fR, \fB\-\-help\fR | ||
62 | print help page | 54 | print help page |
63 | 55 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | |
64 | .TP | 56 | Change the loglevel. |
65 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR | 57 | Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. |
66 | Change the loglevel. Possible values for LOGLEVEL are | 58 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
67 | ERROR, WARNING, INFO and DEBUG. | 59 | Write logs to FILENAME. |
68 | 60 | .It Fl o Ar FILENAME | Fl \-output= Ns Ar FILENAME | |
69 | .TP | ||
70 | \fB\-o \fIFILENAME\fR, \fB\-\-output=\fIFILENAME\fR | ||
71 | Writes a GNUnet directory containing all of the search results to FILENAME. | 61 | Writes a GNUnet directory containing all of the search results to FILENAME. |
72 | 62 | .It Fl n | \-no-network | |
73 | .TP | ||
74 | \fB\-n\fR, \fB\-\-no-network\fR | ||
75 | Only search locally, do not forward requests to other peers. | 63 | Only search locally, do not forward requests to other peers. |
76 | 64 | .It Fl N Ar VALUE | Fl \-results= Ns Ar VALUE | |
77 | .TP | 65 | Automatically terminate the search after receiving VALUE results. |
78 | \fB\-N \fIVALUE\fR, \fB\-\-results=\fIVALUE\fR | 66 | .It Fl t Ar DELAY | Fl \-timeout= Ns Ar DELAY |
79 | automatically terminate the search after receiving VALUE results. | 67 | Automatically timeout search after DELAY. |
80 | 68 | The value given must be a number followed by a space and a time unit, for example "500 ms". | |
81 | .TP | 69 | Note that the quotes are required on the shell. |
82 | \fB\-t \fIDELAY\fR, \fB\-\-timeout=\fIDELAY\fR | 70 | Otherwise the search runs until gnunet\-search is aborted with CTRL\-C. |
83 | Automatically timeout search after DELAY. The value given must be a | 71 | .It Fl v | \-version |
84 | number followed by a space and a time unit, for example "500 ms". | ||
85 | Note that the quotes are required on the shell. Otherwise the search | ||
86 | runs until gnunet\-search is aborted with CTRL\-C. | ||
87 | |||
88 | .TP | ||
89 | \fB\-v\fR, \fB\-\-version\fR | ||
90 | print the version number | 72 | print the version number |
91 | 73 | .It Fl V | \-verbose | |
92 | .TP | ||
93 | \fB\-V\fR, \fB\-\-verbose\fR | ||
94 | print meta data from search results as well | 74 | print meta data from search results as well |
95 | .SH NOTES | 75 | .El |
96 | 76 | You can run gnunet\-search with an URI instead of a keyword. | |
97 | You can run gnunet\-search with an URI instead of a keyword. The URI | 77 | The URI can have the format for a namespace search or for a keyword search. |
98 | can have the format for a namespace search or for a keyword search. | ||
99 | For a namespace search, the format is | 78 | For a namespace search, the format is |
100 | gnunet://fs/sks/NAMESPACE/IDENTIFIER. For a keyword search, use | 79 | .Pp |
101 | gnunet://fs/ksk/KEYWORD[+KEYWORD]*. If the format does not correspond | 80 | .Dl gnunet://fs/sks/NAMESPACE/IDENTIFIER |
102 | to a GNUnet URI, GNUnet will automatically assume that keywords are | 81 | .Pp |
103 | supplied directly. | 82 | For a keyword search, use |
104 | 83 | .Pp | |
84 | .Dl gnunet://fs/ksk/KEYWORD[+KEYWORD]* | ||
85 | .Pp | ||
86 | If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly. | ||
87 | .sp | ||
105 | If multiple keywords are passed, gnunet-search will look for content | 88 | If multiple keywords are passed, gnunet-search will look for content |
106 | matching any of the keywords. The prefix "+" makes a keyword | 89 | matching any of the keywords. |
107 | mandatory. | 90 | The prefix "+" makes a keyword mandatory. |
108 | 91 | .Sh FILES | |
109 | # gnunet\-search "Das Kapital" | 92 | .Pa ~/.config/gnunet.conf |
110 | 93 | GNUnet configuration file; specifies the default value for the timeout | |
111 | searches for content matching the keyword "Das Kapital". Whereas | 94 | .Sh EXAMPLES |
112 | 95 | .Pp | |
113 | # gnunet\-search +Das +Kapital | 96 | .Dl $ gnunet\-search "Das Kapital" |
114 | 97 | .Pp | |
98 | Searches for content matching the keyword "Das Kapital". | ||
99 | .Pp | ||
100 | .Dl $ gnunet\-search +Das +Kapital | ||
101 | .Pp | ||
115 | Searches for content matching both mandatory keywords "Das" and "Kapital". | 102 | Searches for content matching both mandatory keywords "Das" and "Kapital". |
116 | 103 | .sp | |
117 | Search results are printed by gnunet\-search like this: | 104 | Search results are printed by gnunet\-search like this: |
118 | .P | 105 | .Pp |
119 | .ad l | 106 | .ad l |
120 | gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE | 107 | gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE |
121 | 108 | ||
@@ -124,38 +111,37 @@ Search results are printed by gnunet\-search like this: | |||
124 | Mime-type: text/plain | 111 | Mime-type: text/plain |
125 | .ad b | 112 | .ad b |
126 | 113 | ||
127 | The first line contains the command to run to download the file. The | 114 | The first line contains the command to run to download the file. |
128 | suggested filename in the example is COPYING. The GNUnet URI consists | 115 | The suggested filename in the example is COPYING. |
129 | of the key and query hash of the file and finally the size of the | 116 | The GNUnet URI consists of the key and query hash of the file and finally the size of the file. |
130 | file. After the command to download the file GNUnet will print | 117 | 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). |
131 | meta\-data about the file as advertised in the search result, here | 118 | .Sh SEE ALSO |
132 | "The GNU General Public License" and the mime\-type (see the options | 119 | .Xr gnunet-fs-gtk 1 , |
133 | for gnunet\-publish on how to supply meta-data by hand). | 120 | .Xr gnunet\-publish 1 , |
134 | 121 | .Xr gnunet\-download 1 , | |
135 | .SH FILES | 122 | .Xr gnunet.conf 5 |
136 | .TP | 123 | .sp |
137 | ~/.config/gnunet.conf | 124 | The full documentation for gnunet is maintained as a Texinfo manual. |
138 | GNUnet configuration file; specifies the default value for the timeout | 125 | If the |
139 | .SH "REPORTING BUGS" | 126 | .Xr info 1 |
140 | Report bugs to <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 127 | and gnunet programs are properly installed at your site, the command |
141 | .SH "SEE ALSO" | 128 | .Pp |
142 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), | 129 | .Dl info gnunet |
143 | The full documentation for | 130 | .Pp |
144 | .B gnunet | ||
145 | is maintained as a Texinfo manual. If the | ||
146 | .B info | ||
147 | and | ||
148 | .B gnunet | ||
149 | programs are properly installed at your site, the command | ||
150 | .IP | ||
151 | .B info gnunet | ||
152 | .PP | ||
153 | should give you access to the complete handbook, | 131 | should give you access to the complete handbook, |
154 | .IP | 132 | .Pp |
155 | .B info gnunet-c-tutorial | 133 | .Dl info gnunet-c-tutorial |
156 | .PP | 134 | .Pp |
157 | will give you access to a tutorial for developers. | 135 | will give you access to a tutorial for developers. |
158 | .PP | 136 | .sp |
159 | Depending on your installation, this information is also | 137 | Depending on your installation, this information is also available in |
160 | available in | 138 | .Xr gnunet 7 and |
161 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 139 | .Xr gnunet-c-tutorial 7 . |
140 | .\".Sh HISTORY | ||
141 | .\"gnunet-search first appeared in GNUnet 0.9.6. | ||
142 | .\".Sh AUTHORS | ||
143 | .Sh BUGS | ||
144 | Report bugs by using | ||
145 | .Lk https://bugs.gnunet.org | ||
146 | or by sending electronic mail to | ||
147 | .Aq Mt gnunet-developers@gnu.org . | ||