aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am5
-rw-r--r--doc/man/gnunet-download.168
-rw-r--r--doc/man/gnunet-peerinfo.12
-rw-r--r--doc/man/gnunet-publish.18
-rw-r--r--doc/man/gnunet-search.172
-rw-r--r--doc/man/gnunet-statistics.12
-rw-r--r--doc/man/gnunet-unindex.137
7 files changed, 186 insertions, 8 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index b5af700e0..aa8c737d7 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,8 +1,11 @@
1man_MANS = \ 1man_MANS = \
2 gnunet-arm.1 \ 2 gnunet-arm.1 \
3 gnunet-download.1 \
3 gnunet-peerinfo.1 \ 4 gnunet-peerinfo.1 \
4 gnunet-publish.1 \ 5 gnunet-publish.1 \
6 gnunet-search.1 \
5 gnunet-statistics.1 \ 7 gnunet-statistics.1 \
6 gnunet-transport.c 8 gnunet-transport.1 \
9 gnunet-unindex.1
7 10
8EXTRA_DIST = ${man_MANS} 11EXTRA_DIST = ${man_MANS}
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
new file mode 100644
index 000000000..c729683e9
--- /dev/null
+++ b/doc/man/gnunet-download.1
@@ -0,0 +1,68 @@
1.TH GNUNET-DOWNLOAD "1" "6 Sep 2009" "GNUnet"
2.SH NAME
3gnunet\-download \- a command line interface for downloading files from GNUnet
4.SH SYNOPSIS
5.B gnunet\-download
6[\fIOPTIONS\fR] \-\- GNUNET_URI
7.SH DESCRIPTION
8.PP
9Download files from GNUnet.
10.TP
11\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
12set desired level of receiver anonymity. Default is 1.
13.TP
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
15use config file (defaults: ~/.gnunet/gnunet.conf)
16.TP
17\fB\-d, \fB\-\-directory\fR
18download a GNUnet directory that has already been downloaded. Requires that a filename of an existing file is specified instead of the URI. The download will only download the top\-level files in the directory unless the `\-R' option is also specified.
19.TP
20\fB\-D, \fB\-\-delete\-incomplete\fR
21causes gnunet\-download to delete incomplete downloads when aborted with CTRL\-C. Note that complete files that are part of an incomplete recursive download will not be deleted even with this option. Without this option, terminating gnunet\-download with a signal will cause incomplete downloads to stay on disk. If gnunet\-download runs to (normal) completion finishing the download, this option has no effect.
22.TP
23\fB\-h\fR, \fB\-\-help\fR
24print help page
25.TP
26\fB\-H \fIHOSTNAME\fR, \fB\-\-host=\fIHOSTNAME\fR
27on which host is gnunetd running (default: localhost). You can also specify a port using the syntax HOSTNAME:PORT. The default port is 2087.
28.TP
29\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
30Change the loglevel. Possible values for LOGLEVEL are
31ERROR, WARNING, INFO and DEBUG.
32.TP
33\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
34write the file to FILENAME. Hint: when recursively downloading a directory, append a '/' to the end of the FILENAME to create a directory of that name. If no FILENAME is specified, gnunet\-download constructs a temporary ID from the URI of the file. The final filename is constructed based on meta\-data extracted using libextractor (if available).
35.TP
36\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
37set the maximum number of parallel downloads that is allowed. More parallel downloads can, to some extent, improve the overall time to download content. However, parallel downloads also take more memory. The specified number is the number of files that are downloaded in parallel, not the number of blocks that are concurrently requested. As a result, the number only matters for recursive downloads. The default value is 32.
38.TP
39\fB\-R\fR, \fB\-\-recursive\fR
40download directories recursively (and in parallel); note that the URI must belong to a GNUnet directory and that the filename given must end with a '/' \-\- otherwise, only the file corresponding to the URI will be downloaded.
41.TP
42\fB\-v\fR, \fB\-\-version\fR
43print the version number
44.TP
45\fB\-V\fR, \fB\-\-verbose\fR
46print progress information
47.SH NOTES
48The GNUNET_URI is typically obtained from gnunet\-search. gnunet\-gtk can also be used instead of gnunet\-download.
49If you ever have to abort a download, you can at any time continue it by re\-issuing gnunet\-download with the same filename. In that case GNUnet will not download blocks again that are already present. GNUnets file\-encoding will ensure file integrity, even if the existing file was not downloaded from GNUnet in the first place. Temporary information will be appended to the target file until the download is completed.
50
51.SH SETTING ANONYMITY LEVEL
52
53The \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 without any additional slowdown by the anonymity code. Note that you will still have a fair degree of anonymity depending on the current network load and the power of the adversary. The download is still unlikely to be terribly fast since the sender may have requested sender\-anonymity and since in addition to that, GNUnet will still do the anonymous routing.
54
55This 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.
56
57The definition of ANONYMITY\-RECEIVE is the following: If the value v is < 1000, it means that if GNUnet routes n bytes of messages from foreign peers, it may originate n/v bytes of queries in the same time\-period. The time\-period is twice the average delay that GNUnet deferrs forwarded queries. If the value v is >= 1000, it means that if GNUnet routes n bytes of QUERIES from at least (v % 1000) peers, it may originate n/v/1000 bytes of queries in the same time\-period.
58
59The default is 0 and this should be fine for most users. Also notice that if you choose values above 1000, you may end up having no throughput at all, especially if many of your fellow GNUnet\-peers do the same.
60
61.SH FILES
62.TP
63~/.gnunet/gnunet.conf
64GNUnet configuration file
65.SH "REPORTING BUGS"
66Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
67.SH "SEE ALSO"
68\fBgnunet\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-gtk\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBgnunetd\fP(1)
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index 2980d3544..d25dfa3d3 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -1,4 +1,4 @@
1.TH GNUNET-PEERINFO 1 "Mar 15, 2009" "GNUnet" 1.TH GNUNET\-PEERINFO 1 "Mar 15, 2009" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-peerinfo \- Display information about other peers. 4gnunet\-peerinfo \- Display information about other peers.
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index 4926295cf..df2059629 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -50,10 +50,8 @@ additional key to index the content with (to add multiple keys, specify multiple
50 50
51.TP 51.TP
52\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR 52\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
53Change the loglevel. Possible values for LOGLEVEL are NOTHING, FATAL, 53Change the loglevel. Possible values for LOGLEVEL are
54ERROR, WARNING, INFO, STATUS and DEBUG. Note that options in the 54ERROR, WARNING, INFO and DEBUG.
55configuration file take precedence over this option (the argument
56will be ignored in that case).
57 55
58.TP 56.TP
59\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR 57\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR
@@ -161,6 +159,6 @@ Update the previous entry, do not allow any future updates:
161~/.gnunet/gnunet.conf 159~/.gnunet/gnunet.conf
162GNUnet configuration file 160GNUnet configuration file
163.SH "REPORTING BUGS" 161.SH "REPORTING BUGS"
164Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> 162Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
165.SH "SEE ALSO" 163.SH "SEE ALSO"
166\fBgnunet\-auto\-share\fP(1), \fBgnunet\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBgnunetd\fP(1), \fBextract\fP(1) 164\fBgnunet\-auto\-share\fP(1), \fBgnunet\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBgnunetd\fP(1), \fBextract\fP(1)
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
new file mode 100644
index 000000000..5f6fffedd
--- /dev/null
+++ b/doc/man/gnunet-search.1
@@ -0,0 +1,72 @@
1.TH GNUNET-SEARCH "1" "6 Sep 2009" "GNUnet"
2.SH NAME
3gnunet\-search \- a command line interface to search for content on GNUnet
4.SH SYNOPSIS
5.B gnunet\-search
6[\fIOPTIONS\fR] [+]\fIKEYWORD\fR [[+]\fIKEYWORD\fR]*
7
8.B gnunet\-search
9[\fIOPTIONS\fR] [+]\fIURI\fR
10.SH DESCRIPTION
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.
13.TP
14\fB\-a \fILEVEL\fR, \fB\-\-anonymity=\fILEVEL\fR
15The \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 without any additional slowdown for anonymous routing. Note that you may still have some amount of anonymity depending on the current network load and the power of the adversary. Use at least 1 to force GNUnet to use anonymous routing.
16
17This option can be used to limit requests further than that. In particular, you can require GNUnet to have a certain amount of cover 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 this option to values beyond 1 only if you really believe you need it.
18
19The definition of ANONYMITY\-RECEIVE is the following: If the value v is 0, anonymous routing is not required. For 1, anonymous routing is required, but there is no lower bound on how much cover traffic must be present. For values > 1 and < 1000, it means that if GNUnet routes n bytes of messages from foreign peers, it may originate n/v bytes of queries in the same time\-period. The time\-period is twice the average delay that GNUnet deferrs forwarded queries. If the value v is >= 1000, it means that if GNUnet routes n bytes of QUERIES from at least (v % 1000) peers, it may originate n/v/1000 bytes of queries in the same time\-period.
20
21The default is 1 and this should be fine for most users. Also notice that if you choose values above 1000, you may end up having no throughput at all, especially if many of your fellow GNUnet\-peers do the same.
22
23.TP
24\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
25use config file (defaults: ~/.gnunet/gnunet.conf)
26.TP
27\fB\-h\fR, \fB\-\-help\fR
28print help page
29.TP
30\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
31Change the loglevel. Possible values for LOGLEVEL are
32ERROR, WARNING, INFO and DEBUG.
33.TP
34\fB\-o \fIPREFIX\fR, \fB\-\-output=\fIPREFIX\fR
35Writes the encountered (unencrypted) RBlocks or SBlocks to files with name PREFIX.XXX, where XXX is a number. This is useful to keep search results around.
36.TP
37\fB\-v\fR, \fB\-\-version\fR
38print the version number
39.SH NOTES
40
41You 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://ecrs/ksk/KEYWORD[+KEYWORD]*. If the format does not correspond to a GNUnet URI, GNUnet will automatically assume that keywords are supplied directly.
42
43If multiple keywords are passed, gnunet-search will look for content matching any of the keywords. The prefix "+" makes a keyword mandatory.
44
45# gnunet\-search "Das Kapital"
46
47searches for content matching the keyword "Das Kapital". Whereas
48
49# gnunet\-search +Das +Kapital
50
51Searches for content matching both mandatory keywords "Das" and "Kapital".
52
53Search results are printed by gnunet\-search like this:
54.P
55.ad l
56 gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
57
58 Description: The GNU Public License
59
60 Mime-type: text/plain
61.ad b
62
63The 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 Public License" and the mime\-type (see the options for gnunet\-insert on how to supply meta-data by hand).
64
65.SH FILES
66.TP
67~/.gnunet/gnunet.conf
68GNUnet configuration file; specifies the default value for the timeout
69.SH "REPORTING BUGS"
70Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet-developers@gnu.org>
71.SH "SEE ALSO"
72\fBgnunet\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-download\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet.conf\fP(5), \fBgnunetd\fP(1)
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
index 8a23e01e0..25f548ef6 100644
--- a/doc/man/gnunet-statistics.1
+++ b/doc/man/gnunet-statistics.1
@@ -4,7 +4,7 @@
4gnunet\-statistics \- Display statistics about your GNUnet system 4gnunet\-statistics \- Display statistics about your GNUnet system
5 5
6.SH SYNOPSIS 6.SH SYNOPSIS
7.B gnunet-statistics 7.B gnunet\-statistics
8.RI [ options ] [ VALUE ] 8.RI [ options ] [ VALUE ]
9.br 9.br
10 10
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1
new file mode 100644
index 000000000..be478eace
--- /dev/null
+++ b/doc/man/gnunet-unindex.1
@@ -0,0 +1,37 @@
1.TH GNUNET-UNINDEX "1" "6 Sep 2009" "GNUnet"
2.SH NAME
3gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet
4.SH SYNOPSIS
5.B gnunet\-unindex
6[\fIOPTIONS\fR] FILENAME
7.SH DESCRIPTION
8.PP
9gnunet\-unindex is used for deleting indexed files from GNUnet.
10.TP
11\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
12use config file (defaults: ~/.gnunet/gnunet.conf)
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15print help page
16.TP
17\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
18Change the loglevel. Possible values for LOGLEVEL are NOTHING,
19ERROR, WARNING, INFO and DEBUG.
20
21.TP
22\fB\-v\fR, \fB\-\-version\fR
23print the version number
24.TP
25\fB\-V\fR, \fB\-\-verbose\fR
26be verbose
27.SH NOTES
28You can only unindex files that you indexed and that you still have available locally in full. You should use gnunet\-unindex on files that you indexed (not inserted) and that you are going to delete or move locally.
29.TP
30.SH FILES
31.TP
32~/.gnunet/gnunet.conf
33GNUnet configuration file
34.SH "REPORTING BUGS"
35Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
36.SH "SEE ALSO"
37\fBgnunet\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-gtk\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBgnunetd\fP(1)