summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2009-09-06 21:03:16 +0000
committerChristian Grothoff <christian@grothoff.org>2009-09-06 21:03:16 +0000
commit2a534fc5efadca1b65648efb903c3b4c17ac33ad (patch)
treed20be6f1d2ce6faff9ae6475c507f2aa33691e16 /doc
parentc263f813925949b97bfd899e174eefe4ecccced8 (diff)
fs tools
Diffstat (limited to 'doc')
-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 @@
man_MANS = \
gnunet-arm.1 \
+ gnunet-download.1 \
gnunet-peerinfo.1 \
gnunet-publish.1 \
+ gnunet-search.1 \
gnunet-statistics.1 \
- gnunet-transport.c
+ gnunet-transport.1 \
+ gnunet-unindex.1
EXTRA_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 @@
+.TH GNUNET-DOWNLOAD "1" "6 Sep 2009" "GNUnet"
+.SH NAME
+gnunet\-download \- a command line interface for downloading files from GNUnet
+.SH SYNOPSIS
+.B gnunet\-download
+[\fIOPTIONS\fR] \-\- GNUNET_URI
+.SH DESCRIPTION
+.PP
+Download files from GNUnet.
+.TP
+\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
+set desired level of receiver anonymity. Default is 1.
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+use config file (defaults: ~/.gnunet/gnunet.conf)
+.TP
+\fB\-d, \fB\-\-directory\fR
+download 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.
+.TP
+\fB\-D, \fB\-\-delete\-incomplete\fR
+causes 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.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-H \fIHOSTNAME\fR, \fB\-\-host=\fIHOSTNAME\fR
+on which host is gnunetd running (default: localhost). You can also specify a port using the syntax HOSTNAME:PORT. The default port is 2087.
+.TP
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+Change the loglevel. Possible values for LOGLEVEL are
+ERROR, WARNING, INFO and DEBUG.
+.TP
+\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
+write 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).
+.TP
+\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
+set 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.
+.TP
+\fB\-R\fR, \fB\-\-recursive\fR
+download 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.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+print progress information
+.SH NOTES
+The GNUNET_URI is typically obtained from gnunet\-search. gnunet\-gtk can also be used instead of gnunet\-download.
+If 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.
+
+.SH SETTING ANONYMITY LEVEL
+
+The \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.
+
+This 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.
+
+The 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.
+
+The 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.
+
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+GNUnet configuration file
+.SH "REPORTING BUGS"
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+.SH "SEE ALSO"
+\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 @@
-.TH GNUNET-PEERINFO 1 "Mar 15, 2009" "GNUnet"
+.TH GNUNET\-PEERINFO 1 "Mar 15, 2009" "GNUnet"
.SH NAME
gnunet\-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
.TP
\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
-Change the loglevel. Possible values for LOGLEVEL are NOTHING, FATAL,
-ERROR, WARNING, INFO, STATUS and DEBUG. Note that options in the
-configuration file take precedence over this option (the argument
-will be ignored in that case).
+Change the loglevel. Possible values for LOGLEVEL are
+ERROR, WARNING, INFO and DEBUG.
.TP
\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR
@@ -161,6 +159,6 @@ Update the previous entry, do not allow any future updates:
~/.gnunet/gnunet.conf
GNUnet configuration file
.SH "REPORTING BUGS"
-Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
.SH "SEE ALSO"
\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 @@
+.TH GNUNET-SEARCH "1" "6 Sep 2009" "GNUnet"
+.SH NAME
+gnunet\-search \- a command line interface to search for content on GNUnet
+.SH SYNOPSIS
+.B gnunet\-search
+[\fIOPTIONS\fR] [+]\fIKEYWORD\fR [[+]\fIKEYWORD\fR]*
+
+.B gnunet\-search
+[\fIOPTIONS\fR] [+]\fIURI\fR
+.SH DESCRIPTION
+.PP
+Search 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.
+.TP
+\fB\-a \fILEVEL\fR, \fB\-\-anonymity=\fILEVEL\fR
+The \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.
+
+This 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.
+
+The 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.
+
+The 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.
+
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
+use config file (defaults: ~/.gnunet/gnunet.conf)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
+Change the loglevel. Possible values for LOGLEVEL are
+ERROR, WARNING, INFO and DEBUG.
+.TP
+\fB\-o \fIPREFIX\fR, \fB\-\-output=\fIPREFIX\fR
+Writes 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.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.SH NOTES
+
+You 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.
+
+If multiple keywords are passed, gnunet-search will look for content matching any of the keywords. The prefix "+" makes a keyword mandatory.
+
+# gnunet\-search "Das Kapital"
+
+searches for content matching the keyword "Das Kapital". Whereas
+
+# gnunet\-search +Das +Kapital
+
+Searches for content matching both mandatory keywords "Das" and "Kapital".
+
+Search results are printed by gnunet\-search like this:
+.P
+.ad l
+ gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
+
+ Description: The GNU Public License
+
+ Mime-type: text/plain
+.ad b
+
+The 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).
+
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+GNUnet configuration file; specifies the default value for the timeout
+.SH "REPORTING BUGS"
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet-developers@gnu.org>
+.SH "SEE ALSO"
+\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 @@
gnunet\-statistics \- Display statistics about your GNUnet system
.SH SYNOPSIS
-.B gnunet-statistics
+.B gnunet\-statistics
.RI [ options ] [ VALUE ]
.br
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 @@
+.TH GNUNET-UNINDEX "1" "6 Sep 2009" "GNUnet"
+.SH NAME
+gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet
+.SH SYNOPSIS
+.B gnunet\-unindex
+[\fIOPTIONS\fR] FILENAME
+.SH DESCRIPTION
+.PP
+gnunet\-unindex is used for deleting indexed files from GNUnet.
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+use config file (defaults: ~/.gnunet/gnunet.conf)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+Change the loglevel. Possible values for LOGLEVEL are NOTHING,
+ERROR, WARNING, INFO and DEBUG.
+
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+be verbose
+.SH NOTES
+You 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.
+.TP
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+GNUnet configuration file
+.SH "REPORTING BUGS"
+Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+.SH "SEE ALSO"
+\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)