summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2011-09-17 17:55:29 +0000
committerChristian Grothoff <christian@grothoff.org>2011-09-17 17:55:29 +0000
commit0a38c0c8acce8328c0f5be6acee82a4da6cd53ab (patch)
tree352d559d8161ab1e0ba0fc60fa9a2253393ab14d /doc
parent7d9e72ed7787feec407edff7e8140b2379e867e4 (diff)
fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-download.14
-rw-r--r--doc/man/gnunet-publish.17
-rw-r--r--doc/man/gnunet-search.12
-rw-r--r--doc/man/gnunet-transport.196
-rw-r--r--doc/man/gnunet-unindex.12
6 files changed, 4 insertions, 108 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 20575204f..dcc60e6fb 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -8,7 +8,6 @@ man_MANS = \
gnunet-publish.1 \
gnunet-search.1 \
gnunet-statistics.1 \
- gnunet-transport.1 \
gnunet-unindex.1 \
gnunet-monkey.1
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index 2da931554..5c5eb64a9 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -25,10 +25,6 @@ causes gnunet\-download to delete incomplete downloads when aborted with CTRL\-C
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.
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index 904a7947c..402fef2d0 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -24,7 +24,7 @@ It is possible to update content in GNUnet if that content was placed and obtain
.PP
You can use automatic meta\-data extraction (based on libextractor) or the command\-line option \-m to specify meta-data. For the \-m option you need to use the form keyword\-type:value. For example, use "\-m os:Linux" to specify that the operating system is Linux. Common meta\-data types are "author", "title" , "mimetype", "filename", "language", "subject" and "keywords". A full list can be obtained from the extract tool using the option \-\-list. The meta\-data is used to help users in searching for files on the network. The keywords are case\-sensitive.
.PP
-GNUnet supports two styles of publishing files on the network. Publishing a file means that a copy of the file is made in the local (!) database of the node. Indexing a file means that an index is added to the local (!) database with symbolic links to the file itself. The links will use the SHA-512 hash of the entire file as the filename. Indexing is generally significantly more efficient and the default choice. However, indexing only works if the indexed file can be read (using the same absolute path) by gnunetd. If this is not the case, indexing will fail (and gnunet\-publish will automatically revert to publishing instead). Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. If you publish or index a file and then leave the network, it will almost always NOT be available anymore.
+GNUnet supports two styles of publishing files on the network. Publishing a file means that a copy of the file is made in the local (!) database of the node. Indexing a file means that an index is added to the local (!) database with symbolic links to the file itself. The links will use the SHA-512 hash of the entire file as the filename. Indexing is generally significantly more efficient and the default choice. However, indexing only works if the indexed file can be read (using the same absolute path) by gnunet-service-fs. If this is not the case, indexing will fail (and gnunet\-publish will automatically revert to publishing instead). Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network. If you publish or index a file and then leave the network, it will almost always NOT be available anymore.
\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
Use alternate config file (if this option is not specified, the default is ~/.gnunet/gnunet.conf).
@@ -42,9 +42,6 @@ Print the list of keywords that will be used for each file given the current opt
Print a brief help page with all the options.
.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\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR
additional key to index the content with (to add multiple keys, specify multiple times). Each additional key is case\-sensitive. Can be specified multiple times. The keyword is only applied to the top\-level file or directory.
@@ -165,4 +162,4 @@ 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\-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)
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1)
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index ce985be5c..9fb8bc123 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -89,4 +89,4 @@ 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)
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-download\fP(1), \fBgnunet\-pseudonym\fP(1), \fBgnunet.conf\fP(5),
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
deleted file mode 100644
index 643759395..000000000
--- a/doc/man/gnunet-transport.1
+++ /dev/null
@@ -1,96 +0,0 @@
-.TH GNUNET-TRANSPORT "1" "23 Dec 2006" "GNUnet"
-.SH NAME
-gnunet\-transport \- a tool to test a GNUnet transport service
-.SH SYNOPSIS
-.B gnunet\-transport\
-[\fIOPTIONS\fR]
-.SH DESCRIPTION
-.PP
-gnunet\-transport can be used to test or profile
-a GNUnet transport service. The tool can be used to test
-both the correctness of the software as well as the correctness
-of the configuration. gnunet\-transport features two modes,
-called loopback mode and ping mode. In loopback mode the test is limited to testing if the
-transport can be used to communicate with itself (loopback).
-This mode does not include communication with other peers which
-may be blocked by firewalls and other general Internet connectivity
-problems. The loopback mode is particularly useful to test
-the SMTP transport service since this service is fairly hard to
-configure correctly and most problems can be reveiled by just
-testing the loopback. In ping mode the tool will attempt to download
-peer advertisements from the URL specified in the configuration file
-and then try to contact each of the peers. Note that it is perfectly
-normal that some peers do not respond, but if no peer responds something
-is likely to be wrong. The configuration is always taken
-from the configuration file. Do not run gnunetd while running
-gnunet\-transport since the transport services cannot
-be used by two processes at the same time.
-.PP
-gnunet\-transport will always produce an error\-message for
-the NAT transport in loopback mode. If NAT is configured in accept\-mode (as in,
-accept connections from peers using network address translation),
-the check will fail with the message "could not create HELO",
-which is correct since the peer itself is clearly not going to
-advertise itself as a NAT. If the peer is configured in NAT\-mode,
-that is, the peer is behind a NAT box, the message will be
-'could not connect'. For NAT, both messages are NOT errors
-but exactly what is supposed to happen.
-.PP
-Similarly, a NAT\-ed peer should typically configure the TCP transport
-to use port 0 (not listen on any port). In this case,
-gnunet\-transport will print 'could not create HELO' for the
-TCP transport. This is also ok. In fact, a correctly configured
-peer using NAT should give just two errors (could not connect for
-tcp and could not create HELO for NAT) when tested using
-gnunet\-transport\. The reason is, that gnunet\-transport\
-only tests loopback connectivity, and for a NAT\-ed peer, that just
-does not apply.
-.PP
-Note that in ping mode the HTTP download times out after 5 minutes,
-so if the list of peers is very large and not all peers can be
-queried within the 5 minutes the tool may abort before trying all
-peers.
-.TP
-\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
-use config file (default: /etc/gnunetd.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 \fILOGLEVEL\fR are NOTHING, FATAL, ERROR, FAILURE, WARNING, MESSAGE, INFO, DEBUG, CRON and EVERYTHING.
-.TP
-\fB\-p\fR, \fB\-\-ping\fR
-use ping mode (loopback mode is default)
-.TP
-\fB\-r\fI COUNT \fB\-\-repeat=\fICOUNT\fR
-send COUNT messages in a sequence over the same connection
-.TP
-\fB\-s\fI SIZE \fB\-\-size=\fISIZE\fR
-test using the specified message size, default is 11
-.TP
-\fB\-t\fI TRANSPORT\fR, \fB\-\-transport=\fITRANSPORT\fR
-run using the specified transport, if not given the transports
-configured in the configuration file are used.
-.TP
-\fB\-u \fIUSER\fR, \fB\-\-user=USER\fR
-run as user USER (and if available as group USER). Note that to use this option, you will probably have to start gnunet-transport as
-root. It is typically better to directly start gnunet-transport as that user instead.
-.TP
-\fB\-v\fR, \fB\-\-version\fR
-print the version number
-.TP
-\fB\-V\fR, \fB\-\-verbose\fR
-be verbose
-.SH NOTES
-gnunet\-transport can run for a long time, depending on
-how high you have set the \fICOUNT\fR level. Run first with small numbers
-for \fICOUNT\fR to get an initial estimate on the runtime.
-.SH FILES
-.TP
-/etc/gnunetd.conf
-default gnunetd configuration file
-.SH "REPORTING BUGS"
-Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet-developers@gnu.org>
-.SH "SEE ALSO"
-\fBgnunetd.conf\fP(5), \fBgnunetd\fP(1)
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1
index be478eace..9cbb7aa57 100644
--- a/doc/man/gnunet-unindex.1
+++ b/doc/man/gnunet-unindex.1
@@ -34,4 +34,4 @@ 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)
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5)