aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/gnunet-download.117
-rw-r--r--doc/man/gnunet-search.16
2 files changed, 22 insertions, 1 deletions
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index b0ad09b73..2da931554 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -7,43 +7,60 @@ gnunet\-download \- a command line interface for downloading files from GNUnet
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP 8.PP
9Download files from GNUnet. 9Download files from GNUnet.
10
10.TP 11.TP
11\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR 12\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
12set desired level of receiver anonymity. Default is 1. 13set desired level of receiver anonymity. Default is 1.
14
13.TP 15.TP
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
15use config file (defaults: ~/.gnunet/gnunet.conf) 17use config file (defaults: ~/.gnunet/gnunet.conf)
18
16.TP 19.TP
17\fB\-D, \fB\-\-delete\-incomplete\fR 20\fB\-D, \fB\-\-delete\-incomplete\fR
18causes 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. 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
19.TP 23.TP
20\fB\-h\fR, \fB\-\-help\fR 24\fB\-h\fR, \fB\-\-help\fR
21print help page 25print help page
26
22.TP 27.TP
23\fB\-H \fIHOSTNAME\fR, \fB\-\-host=\fIHOSTNAME\fR 28\fB\-H \fIHOSTNAME\fR, \fB\-\-host=\fIHOSTNAME\fR
24on which host is gnunetd running (default: localhost). You can also specify a port using the syntax HOSTNAME:PORT. The default port is 2087. 29on which host is gnunetd running (default: localhost). You can also specify a port using the syntax HOSTNAME:PORT. The default port is 2087.
30
25.TP 31.TP
26\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 32\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
27Change the loglevel. Possible values for LOGLEVEL are 33Change the loglevel. Possible values for LOGLEVEL are
28ERROR, WARNING, INFO and DEBUG. 34ERROR, WARNING, INFO and DEBUG.
35
36.TP
37\fB\-n\fR, \fB\-\-no-network\fR
38Only search locally, do not forward requests to other peers.
39
29.TP 40.TP
30\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR 41\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
31write 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). 42write 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).
43
32.TP 44.TP
33\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR 45\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
34set 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 (see also option \-r which can be used to limit memory utilization) and more sockets. GNUnet typically only supports 1024 sockets per process, and each parallel download requires a new socket. Hence it is not possible to run more than about 1000 downloads in parallel. This option is used to limit the number of files that are downloaded in parallel (\-r can be used to limit the number of blocks that are concurrently requested). As a result, the value only matters for recursive downloads. The default value is 32. Note that the overall limit of 1000 downloads applies to gnunet\-service\-fs as well and using multiple gnunet\-download processes hence does not increase this limit. 46set 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 (see also option \-r which can be used to limit memory utilization) and more sockets. GNUnet typically only supports 1024 sockets per process, and each parallel download requires a new socket. Hence it is not possible to run more than about 1000 downloads in parallel. This option is used to limit the number of files that are downloaded in parallel (\-r can be used to limit the number of blocks that are concurrently requested). As a result, the value only matters for recursive downloads. The default value is 32. Note that the overall limit of 1000 downloads applies to gnunet\-service\-fs as well and using multiple gnunet\-download processes hence does not increase this limit.
47
35.TP 48.TP
36\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR 49\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
37set the maximum number of parallel requests that is allowed. If multiple files are downloaded, gnunet\-download will not run them in parallel if this would cause the number of pending requests to possibly exceed the given value. This is useful since, for example, downloading dozens of multi\-gigabyte files in parallel could exhaust memory resources and would hardly improve performance. Note that the limit only applies to this specific process and that other download activities by other processes are not included in this limit. Consider raising this limit for large recursive downloads with many large files if memory and network bandwidth are not fully utilized and if the parallelism limit (\-p option) is not reached. This option also only matters for recursive downloads. The default value is 4092. 50set the maximum number of parallel requests that is allowed. If multiple files are downloaded, gnunet\-download will not run them in parallel if this would cause the number of pending requests to possibly exceed the given value. This is useful since, for example, downloading dozens of multi\-gigabyte files in parallel could exhaust memory resources and would hardly improve performance. Note that the limit only applies to this specific process and that other download activities by other processes are not included in this limit. Consider raising this limit for large recursive downloads with many large files if memory and network bandwidth are not fully utilized and if the parallelism limit (\-p option) is not reached. This option also only matters for recursive downloads. The default value is 4092.
51
38.TP 52.TP
39\fB\-R\fR, \fB\-\-recursive\fR 53\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. Note that in addition to using '-R', you must also specify a filename ending in '.gnd' so that the code realizes that the top-level file is a directory (since we have no meta data). 54download 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. Note that in addition to using '-R', you must also specify a filename ending in '.gnd' so that the code realizes that the top-level file is a directory (since we have no meta data).
55
41.TP 56.TP
42\fB\-v\fR, \fB\-\-version\fR 57\fB\-v\fR, \fB\-\-version\fR
43print the version number 58print the version number
59
44.TP 60.TP
45\fB\-V\fR, \fB\-\-verbose\fR 61\fB\-V\fR, \fB\-\-verbose\fR
46print progress information 62print progress information
63
47.SH NOTES 64.SH NOTES
48The GNUNET_URI is typically obtained from gnunet\-search. gnunet\-gtk can also be used instead of gnunet\-download. 65The 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. 66If 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.
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 5eefaa099..526097733 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -1,4 +1,4 @@
1.TH GNUNET-SEARCH "1" "6 Sep 2009" "GNUnet" 1.TH GNUNET-SEARCH "1" "28 Apr 2010" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-search \- a command line interface to search for content on GNUnet 3gnunet\-search \- a command line interface to search for content on GNUnet
4.SH SYNOPSIS 4.SH SYNOPSIS
@@ -38,6 +38,10 @@ ERROR, WARNING, INFO and DEBUG.
38Writes a GNUnet directory containing all of the search results to FILENAME. 38Writes a GNUnet directory containing all of the search results to FILENAME.
39 39
40.TP 40.TP
41\fB\-n\fR, \fB\-\-no-network\fR
42Only search locally, do not forward requests to other peers.
43
44.TP
41\fB\-v\fR, \fB\-\-version\fR 45\fB\-v\fR, \fB\-\-version\fR
42print the version number 46print the version number
43 47