aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/gnunet-arm.131
-rw-r--r--doc/man/gnunet-ats.136
-rw-r--r--doc/man/gnunet-auto-share.171
-rw-r--r--doc/man/gnunet-bcd.131
-rw-r--r--doc/man/gnunet-cadet.123
-rw-r--r--doc/man/gnunet-config.133
-rw-r--r--doc/man/gnunet-conversation-test.154
-rw-r--r--doc/man/gnunet-conversation.152
-rw-r--r--doc/man/gnunet-core.138
-rw-r--r--doc/man/gnunet-datastore.148
-rw-r--r--doc/man/gnunet-directory.139
-rw-r--r--doc/man/gnunet-dns2gns.123
-rw-r--r--doc/man/gnunet-download-manager.186
-rw-r--r--doc/man/gnunet-download.157
-rw-r--r--doc/man/gnunet-ecc.125
-rw-r--r--doc/man/gnunet-fs.156
-rw-r--r--doc/man/gnunet-gns-proxy.136
-rw-r--r--doc/man/gnunet-gns.160
-rw-r--r--doc/man/gnunet-identity.1103
-rw-r--r--doc/man/gnunet-namecache.128
-rw-r--r--doc/man/gnunet-namestore-fcfsd.141
-rw-r--r--doc/man/gnunet-namestore.128
-rw-r--r--doc/man/gnunet-nat-auto.173
-rw-r--r--doc/man/gnunet-nat-server.144
-rw-r--r--doc/man/gnunet-nat.1109
-rw-r--r--doc/man/gnunet-peerinfo.138
-rw-r--r--doc/man/gnunet-publish.1524
-rw-r--r--doc/man/gnunet-qr.130
-rw-r--r--doc/man/gnunet-resolver.132
-rw-r--r--doc/man/gnunet-revocation.123
-rw-r--r--doc/man/gnunet-scalarproduct.143
-rw-r--r--doc/man/gnunet-scrypt.132
-rw-r--r--doc/man/gnunet-search.127
-rw-r--r--doc/man/gnunet-statistics.134
-rw-r--r--doc/man/gnunet-testbed-profiler.127
-rw-r--r--doc/man/gnunet-testing-run-service.136
-rw-r--r--doc/man/gnunet-testing.134
-rw-r--r--doc/man/gnunet-timeout.134
-rw-r--r--doc/man/gnunet-transport-certificate-creation.132
-rw-r--r--doc/man/gnunet-transport.128
-rw-r--r--doc/man/gnunet-unindex.122
-rw-r--r--doc/man/gnunet-uri.133
-rw-r--r--doc/man/gnunet-vpn.189
-rw-r--r--doc/man/gnunet-zoneimport.151
-rw-r--r--doc/man/gnunet.conf.550
45 files changed, 1570 insertions, 874 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index 099978f24..0e7486d28 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -1,19 +1,14 @@
1.TH GNUNET\-ARM 1 "Jan 4, 2012" "GNUnet" 1.TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-arm \- control GNUnet services 3gnunet\-arm \- control GNUnet services
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-arm 5.B gnunet\-arm
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including 8\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including
13the ARM service itself. The ARM service is a supervisor for GNUnet's 9the ARM service itself. The ARM service is a supervisor for GNUnet's
14service processes. ARM starts services on-demand or as configured and 10service processes. ARM starts services on-demand or as configured and
15re-starts them if they crash. 11re-starts them if they crash.
16
17.SH OPTIONS 12.SH OPTIONS
18.B 13.B
19.IP "\-c FILENAME, \-\-config=FILENAME" 14.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -55,11 +50,29 @@ List all running services.
55.B 50.B
56.IP "\-v, \-\-version" 51.IP "\-v, \-\-version"
57Print GNUnet version number. 52Print GNUnet version number.
58
59
60.SH BUGS 53.SH BUGS
61Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 54Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
62electronic mail to <gnunet\-developers@gnu.org> 55electronic mail to <gnunet\-developers@gnu.org>
63
64.SH SEE ALSO 56.SH SEE ALSO
65gnunet\-config(1), gnunet\-setup(1) 57gnunet\-config(1), gnunet\-setup(1)
58.PP
59The full documentation for
60.B gnunet
61is maintained as a Texinfo manual.
62If the
63.B info
64and
65.B gnunet
66programs are properly installed at your site, the command
67.IP
68.B info gnunet
69.PP
70should give you access to the complete handbook,
71.IP
72.B info gnunet-c-tutorial
73.PP
74will give you access to a tutorial for developers.
75.PP
76Depending on your installation, this information is also
77available in
78\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1
index cac55e79f..895c71942 100644
--- a/doc/man/gnunet-ats.1
+++ b/doc/man/gnunet-ats.1
@@ -1,18 +1,14 @@
1.TH GNUNET\-ATS 1 "Oct 16, 2015" "GNUnet" 1.TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-ats \- display information about transport resource allocation 3gnunet\-ats \- display information about transport resource allocation
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-ats 5.B gnunet\-ats
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-ats\fP can be used to display information about the GNUnet's 9\fBgnunet\-ats\fP can be used to display information about the GNUnet's
13transport selection mechanism. It shows information about the 10transport selection mechanism. It shows information about the
14addresses and the assigned input and output bandwidth. 11addresses and the assigned input and output bandwidth.
15
16.SH OPTIONS 12.SH OPTIONS
17.B 13.B
18.IP "\-a, \-\-aa" 14.IP "\-a, \-\-aa"
@@ -22,8 +18,10 @@ List all addresses currently known to ats.
22Use the configuration file FILENAME. 18Use the configuration file FILENAME.
23.B 19.B
24.IP "\-C, \-\-connect=PEERID" 20.IP "\-C, \-\-connect=PEERID"
25Ask ATS to suggest an address for PEERID to transport to establish a connection. 21Ask ATS to suggest an address for PEERID to transport to establish a
26Note that you can use the gnunet\-transport command\-line tool to force disconnects. 22connection.
23Note that you can use the gnunet\-transport command\-line tool to
24force disconnects.
27.B 25.B
28.IP "\-h, \-\-help" 26.IP "\-h, \-\-help"
29Print short help on options. 27Print short help on options.
@@ -35,7 +33,8 @@ Print information for a specific peer identity only
35Value to set for when changing preference values 33Value to set for when changing preference values
36.B 34.B
37.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 35.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
38Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 36Use LOGLEVEL for logging.
37Valid values are DEBUG, INFO, WARNING and ERROR.
39.B 38.B
40.IP "\-m, \-\-monitor" 39.IP "\-m, \-\-monitor"
41Monitor changes to the bandwidth assignments continuously 40Monitor changes to the bandwidth assignments continuously
@@ -60,10 +59,27 @@ Print verbose output (include ATS address properties)
60.B 59.B
61.IP "\-v, \-\-version" 60.IP "\-v, \-\-version"
62Print GNUnet version number. 61Print GNUnet version number.
63
64.SH BUGS 62.SH BUGS
65Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 63Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
66electronic mail to <bug\-gnunet@gnu.org> 64electronic mail to <bug\-gnunet@gnu.org>
67
68.SH SEE ALSO 65.SH SEE ALSO
69gnunet\-transport(1) 66gnunet\-transport(1)
67The full documentation for
68.B gnunet
69is maintained as a Texinfo manual. If the
70.B info
71and
72.B gnunet
73programs are properly installed at your site, the command
74.IP
75.B info gnunet
76.PP
77should give you access to the complete handbook,
78.IP
79.B info gnunet-c-tutorial
80.PP
81will give you access to a tutorial for developers.
82.PP
83Depending on your installation, this information is also
84available in
85\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index fc2668d44..3989b1351 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -1,11 +1,11 @@
1.TH GNUNET\-AUTO\-SHARE "1" "18 Jun 2012" "GNUnet" 1.TH GNUNET\-AUTO\-SHARE "1" "June 18, 2012" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-auto\-share \- a command line tool to automatically share an entire directory with other users 3gnunet\-auto\-share \- a command line tool to automatically share an
4entire directory with other users
4.SH SYNOPSIS 5.SH SYNOPSIS
5.B gnunet\-auto\-share 6.B gnunet\-auto\-share
6[\fIOPTIONS\fR] DIRNAME 7[\fIOPTIONS\fR] DIRNAME
7.SH DESCRIPTION 8.SH DESCRIPTION
8.PP
9In order to share files with other GNUnet users, the files must first be made 9In order to share files with other GNUnet users, the files must first be made
10available to GNUnet. This tool can be used to automatically share all files 10available to GNUnet. This tool can be used to automatically share all files
11from a certain directory. The program will periodically scan the directory 11from a certain directory. The program will periodically scan the directory
@@ -17,35 +17,28 @@ has many options in common with gnunet\-publish, but can only be used to
17index files. 17index files.
18.PP 18.PP
19You can use automatic meta\-data extraction (based on libextractor). 19You can use automatic meta\-data extraction (based on libextractor).
20.PP 20.TP
21
22\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 21\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
23Use alternate config file (if this option is not specified, the 22Use alternate config file (if this option is not specified, the
24default is ~/.config/gnunet.conf). 23default is ~/.config/gnunet.conf).
25
26.TP 24.TP
27\fB\-D\fR, \fB\-\-disable\-extractor\fR 25\fB\-D\fR, \fB\-\-disable\-extractor\fR
28Disable use of GNU libextractor for finding additional keywords and metadata. 26Disable use of GNU libextractor for finding additional keywords and metadata.
29
30.TP 27.TP
31\fB\-h\fR, \fB\-\-help\fR 28\fB\-h\fR, \fB\-\-help\fR
32Print a brief help page with all the options. 29Print a brief help page with all the options.
33
34.TP 30.TP
35\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR 31\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
36Change the loglevel. Possible values for LOGLEVEL are 32Change the loglevel. Possible values for LOGLEVEL are
37ERROR, WARNING, INFO and DEBUG. 33ERROR, WARNING, INFO and DEBUG.
38
39.TP 34.TP
40\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR 35\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
41Executive summary: You probably don't need it. 36Executive summary: You probably don't need it.
42
43Set the priority of the published content (default: 365). If the local 37Set the priority of the published content (default: 365). If the local
44database is full, GNUnet will discard the content with the lowest ranking. 38database is full, GNUnet will discard the content with the lowest ranking.
45Note that ranks change over time depending on popularity. The default 39Note that ranks change over time depending on popularity. The default
46should be high enough to preserve the locally published content in favor 40should be high enough to preserve the locally published content in favor
47of content that migrates from other peers. 41of content that migrates from other peers.
48
49.TP 42.TP
50\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR 43\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
51Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet 44Set the desired replication level. If CONTENT_PUSHING is set to YES, GNUnet
@@ -54,20 +47,15 @@ normal "random" replication of all content. This option can be used to push
54some content out into the network harder. Note that pushing content LEVEL 47some content out into the network harder. Note that pushing content LEVEL
55times into the network does not guarantee that there will actually be LEVEL 48times into the network does not guarantee that there will actually be LEVEL
56replicas. 49replicas.
57
58.TP 50.TP
59\fB\-v\fR, \fB\-\-version\fR 51\fB\-v\fR, \fB\-\-version\fR
60Print the version number. 52Print the version number.
61
62.TP 53.TP
63\fB\-V\fR, \fB\-\-verbose\fR 54\fB\-V\fR, \fB\-\-verbose\fR
64Be verbose. Using this option causes gnunet\-publish to print progress 55Be verbose. Using this option causes gnunet\-publish to print progress
65information and at the end the file identification that can be used to download 56information and at the end the file identification that can be used to download
66the file from GNUnet. 57the file from GNUnet.
67
68
69.SH SETTING ANONYMITY LEVEL 58.SH SETTING ANONYMITY LEVEL
70
71The \fB\-a\fR option can be used to specify additional anonymity constraints. 59The \fB\-a\fR option can be used to specify additional anonymity constraints.
72If set to 0, GNUnet will publish the file non-anonymously and in fact sign 60If set to 0, GNUnet will publish the file non-anonymously and in fact sign
73the advertisement for the file using your peer's private key. This will 61the advertisement for the file using your peer's private key. This will
@@ -81,7 +69,7 @@ anonymity, which increases the amount of cover traffic your own traffic will
81get, at the expense of performance. Note that regardless of the anonymity 69get, at the expense of performance. Note that regardless of the anonymity
82level you choose, peers that cache content in the network always use anonymity 70level you choose, peers that cache content in the network always use anonymity
83level 1. 71level 1.
84 72.PP
85The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity 73The definition of the ANONYMITY LEVEL is the following. 0 means no anonymity
86is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" 74is required. Otherwise a value of 'v' means that 1 out of v bytes of "anonymous"
87traffic can be from the local user, leaving 'v-1' bytes of cover traffic per 75traffic can be from the local user, leaving 'v-1' bytes of cover traffic per
@@ -89,35 +77,50 @@ byte on the wire. Thus, if GNUnet routes n bytes of messages from foreign
89peers (using anonymous routing), it may originate n/(v-1) bytes of data in 77peers (using anonymous routing), it may originate n/(v-1) bytes of data in
90the same time\-period. The time\-period is twice the average delay that 78the same time\-period. The time\-period is twice the average delay that
91GNUnet defers forwarded queries. 79GNUnet defers forwarded queries.
92 80.PP
93The default is 1 and this should be fine for most users. Also notice that if 81The default is 1 and this should be fine for most users. Also notice that if
94you choose very large values, you may end up having no throughput at all, 82you choose very large values, you may end up having no throughput at all,
95especially if many of your fellow GNUnet\-peers all do the same. 83especially if many of your fellow GNUnet\-peers all do the same.
96
97
98.SH EXAMPLES 84.SH EXAMPLES
99.PP
100
101\fBBasic example\fR 85\fBBasic example\fR
102 86.TP
103Share a directory "$HOME/gnunet\-share/": 87# gnunet\-auto\-share $HOME/gnunet\-share/ &
104 88Share a directory "$HOME/gnunet\-share/"
105 # gnunet\-auto\-share $HOME/gnunet\-share/ & 89.PP
106
107
108\fBBasic configuration\fR 90\fBBasic configuration\fR
109 91.PP
110Share a directory "$HOME/gnunet\-share/": 92Share a directory "$HOME/gnunet\-share/":
111 93
112 [gnunet-auto-share] 94 [gnunet-auto-share]
113 OPTIONS = $HOME/gnunet\-share 95 OPTIONS = $HOME/gnunet\-share
114 IMMEDIATE_START = YES # start this service when the peer starts 96 IMMEDIATE_START = YES # start this service when the peer starts
115
116.SH FILES 97.SH FILES
117.TP 98.TP
118~/.config/gnunet.conf 99~/.config/gnunet.conf
119GNUnet configuration file 100GNUnet configuration file
120.SH "REPORTING BUGS" 101.SH BUGS
121Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 102Report bugs to <https://gnunet.org/bugs/> or by sending electronic
122.SH "SEE ALSO" 103mail to <gnunet\-developers@gnu.org>
123\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1) 104.SH SEE ALSO
105\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
106\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1),
107\fBgnunet.conf\fP(5), \fBextract\fP(1)
108The full documentation for
109.B gnunet
110is maintained as a Texinfo manual. If the
111.B info
112and
113.B gnunet
114programs are properly installed at your site, the command
115.IP
116.B info gnunet
117.PP
118should give you access to the complete handbook,
119.IP
120.B info gnunet-c-tutorial
121.PP
122will give you access to a tutorial for developers.
123.PP
124Depending on your installation, this information is also
125available in
126\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1
index f23196687..f10e6f891 100644
--- a/doc/man/gnunet-bcd.1
+++ b/doc/man/gnunet-bcd.1
@@ -1,13 +1,10 @@
1.TH GNUNET\-BCD 1 "Dec 5, 2013" "GNUnet" 1.TH GNUNET\-BCD 1 "December 5, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-bcd \- run HTTP server to create GNS business cards 3gnunet\-bcd \- run HTTP server to create GNS business cards
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-bcd 5.B gnunet\-bcd
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-bcd\fP can be used to create an business card with a QR code 9\fBgnunet\-bcd\fP can be used to create an business card with a QR code
13containing the public key of a zone from the GNU Name System. 10containing the public key of a zone from the GNU Name System.
@@ -15,7 +12,6 @@ gnunet\-bcd requires LaTeX (pdflatex) with various packages to be
15installed. If it does not work for you, try installing the full 12installed. If it does not work for you, try installing the full
16TeXLive distribution first, for example using the package\-manager 13TeXLive distribution first, for example using the package\-manager
17apt: "apt-get install texlive-full". 14apt: "apt-get install texlive-full".
18
19.SH OPTIONS 15.SH OPTIONS
20.B 16.B
21.IP "\-p PORT, \-\-port=PORT" 17.IP "\-p PORT, \-\-port=PORT"
@@ -32,7 +28,26 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
32.B 28.B
33.IP "\-v, \-\-version" 29.IP "\-v, \-\-version"
34Print GNUnet version number. 30Print GNUnet version number.
35
36.SH BUGS 31.SH BUGS
37Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 32Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
38 33electronic mail to <gnunet\-developers@gnu.org>
34.SH SEE ALSO
35The full documentation for
36.B gnunet
37is maintained as a Texinfo manual. If the
38.B info
39and
40.B gnunet
41programs are properly installed at your site, the command
42.IP
43.B info gnunet
44.PP
45should give you access to the complete handbook,
46.IP
47.B info gnunet-c-tutorial
48.PP
49will give you access to a tutorial for developers.
50.PP
51Depending on your installation, this information is also
52available in
53\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1
index d95cf851c..3551a335d 100644
--- a/doc/man/gnunet-cadet.1
+++ b/doc/man/gnunet-cadet.1
@@ -64,4 +64,25 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
64Print GNUnet version number. 64Print GNUnet version number.
65 65
66.SH BUGS 66.SH BUGS
67Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 67Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
68electronic mail to <gnunet\-developers@gnu.org>
69.SH SEE ALSO
70The full documentation for
71.B gnunet
72is maintained as a Texinfo manual. If the
73.B info
74and
75.B gnunet
76programs are properly installed at your site, the command
77.IP
78.B info gnunet
79.PP
80should give you access to the complete handbook,
81.IP
82.B info gnunet-c-tutorial
83.PP
84will give you access to a tutorial for developers.
85.PP
86Depending on your installation, this information is also
87available in
88\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index 74839ee0e..c4f979fb0 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -1,16 +1,11 @@
1.TH GNUNET\-CONFIG 1 "Jul 15, 2012" "GNUnet" 1.TH GNUNET-CONFIG 1 "July 15, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-config \- manipulate GNUnet configuration files 3gnunet\-config \- manipulate GNUnet configuration files
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-config 5.B gnunet\-config
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. 8\fBgnunet\-config\fP can be used to read or modify GNUnet configuration files.
13
14.SH OPTIONS 9.SH OPTIONS
15.B 10.B
16.IP "\-f, \-\-filename" 11.IP "\-f, \-\-filename"
@@ -46,7 +41,27 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
46.B 41.B
47.IP "\-v, \-\-version" 42.IP "\-v, \-\-version"
48Print GNUnet version number. 43Print GNUnet version number.
49
50
51.SH BUGS 44.SH BUGS
52Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 45Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
46electronic mail to <gnunet\-developers@gnu.org>
47.SH SEE ALSO
48The full documentation for
49.B gnunet
50is maintained as a Texinfo manual.
51If the
52.B info
53and
54.B gnunet
55programs are properly installed at your site, the command
56.IP
57.B info gnunet
58.PP
59should give you access to the complete handbook,
60.IP
61.B info gnunet-c-tutorial
62.PP
63will give you access to a tutorial for developers.
64.PP
65Depending on your installation, this information is also
66available in
67\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-conversation-test.1 b/doc/man/gnunet-conversation-test.1
index 3cda104df..046091752 100644
--- a/doc/man/gnunet-conversation-test.1
+++ b/doc/man/gnunet-conversation-test.1
@@ -1,23 +1,21 @@
1.TH GNUNET\-CONVERSATION\-TEST 1 "Oct 30, 2013" "GNUnet" 1.TH GNUNET\-CONVERSATION\-TEST 1 "October 30, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-conversation\-test \- check your speaker and microphone settings 3gnunet\-conversation\-test \- check your speaker and microphone settings
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-conversation\-test [OPTIONS] 5.B gnunet\-conversation\-test [OPTIONS]
8.RI URI 6.RI URI
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-conversation\-test\fP can be used to check your speaker and microphone 9\fBgnunet\-conversation\-test\fP can be used to check your speaker and
13settings. It will record you for five seconds and then play the recording back 10microphone settings.
14to you. If this fails, you might want to use the \fBpavucontrol\fP tool to 11It will record you for five seconds and then play the recording back
15check which microphone or speaker were assigned to GNUnet by PulseAudio (you 12to you.
16may have more than one set of microphones or speakers known to your computer). 13If this fails, you might want to use the \fBpavucontrol\fP tool to
17 14check which microphone or speaker were assigned to GNUnet by
18You can use gnunet\-conversation\-test without having a peer running on your 15PulseAudio (you may have more than one set of microphones or speakers
19computer. 16known to your computer).
20 17You can use gnunet\-conversation\-test without having a peer running
18on your computer.
21.SH OPTIONS 19.SH OPTIONS
22.B 20.B
23.IP "\-c FILENAME, \-\-config=FILENAME" 21.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -27,13 +25,33 @@ Use the configuration file FILENAME.
27Print short help on options. 25Print short help on options.
28.B 26.B
29.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 27.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
30Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 28Use LOGLEVEL for logging.
29Valid values are DEBUG, INFO, WARNING and ERROR.
31.B 30.B
32.IP "\-v, \-\-version" 31.IP "\-v, \-\-version"
33Print GNUnet version number. 32Print GNUnet version number.
34
35
36.SH BUGS 33.SH BUGS
37Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 34Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
38.SH "SEE ALSO" 35electronic mail to <gnunet\-developers@gnu.org>
36.SH SEE ALSO
39\fBgnunet\-conversation\fP(1) 37\fBgnunet\-conversation\fP(1)
38The full documentation for
39.B gnunet
40is maintained as a Texinfo manual.
41If the
42.B info
43and
44.B gnunet
45programs are properly installed at your site, the command
46.IP
47.B info gnunet
48.PP
49should give you access to the complete handbook,
50.IP
51.B info gnunet-c-tutorial
52.PP
53will give you access to a tutorial for developers.
54.PP
55Depending on your installation, this information is also
56available in
57\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-conversation.1 b/doc/man/gnunet-conversation.1
index ae2523f82..fb0596e19 100644
--- a/doc/man/gnunet-conversation.1
+++ b/doc/man/gnunet-conversation.1
@@ -1,20 +1,19 @@
1.TH GNUNET\-CONVERSATION 1 "Oct 5, 2013" "GNUnet" 1.TH GNUNET\-CONVERSATION 1 "October 5, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-conversation \- have a conversation with your peers 3gnunet\-conversation \- have a conversation with your peers
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-conversation \-e NAME [OPTIONS] 5.B gnunet\-conversation \-e NAME [OPTIONS]
8.RI URI 6.RI URI
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-conversation\fP can be used to have a conversation with other GNUnet 9\fBgnunet\-conversation\fP can be used to have a conversation with
13users. You can make calls and receive incoming calls. You need to setup an 10other GNUnet users.
14ego using gnunet\-identity first. For others to be able to call you, you must 11You can make calls and receive incoming calls.
15add a PHONE record to your zone in the GNU Name System (using gnunet\-namestore). 12You need to setup an ego using gnunet\-identity first.
16gnunet\-conversation has an interactive help system via the /help command. 13For others to be able to call you, you must add a PHONE record to
17 14your zone in the GNU Name System (using gnunet\-namestore).
15gnunet\-conversation has an interactive help system via the /help
16command.
18.SH OPTIONS 17.SH OPTIONS
19.B 18.B
20.IP "\-c FILENAME, \-\-config=FILENAME" 19.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -27,18 +26,37 @@ Specifies the NAME of the ego to use (for caller ID).
27Print short help on options. 26Print short help on options.
28.B 27.B
29.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 28.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
30Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 29Use LOGLEVEL for logging.
30Valid values are DEBUG, INFO, WARNING and ERROR.
31.B 31.B
32.IP "\-p LINE, \-\-phone=LINE" 32.IP "\-p LINE, \-\-phone=LINE"
33Optional argument that can be used to specify the phone LINE to be used with 33Optional argument that can be used to specify the phone LINE to be used with
34the conversation service. The default LINE is zero, which should be fine 34the conversation service.
35for most users. 35The default LINE is zero, which should be fine for most users.
36.B 36.B
37.IP "\-v, \-\-version" 37.IP "\-v, \-\-version"
38Print GNUnet version number. 38Print GNUnet version number.
39
40
41.SH BUGS 39.SH BUGS
42Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 40Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
43.SH "SEE ALSO" 41electronic mail to <gnunet\-developers@gnu.org>
42.SH SEE ALSO
44\fBgnunet\-identity\fP(1), \fBgnunet\-namestore\fP(1), \fBgnunet\-gns\fP(1) 43\fBgnunet\-identity\fP(1), \fBgnunet\-namestore\fP(1), \fBgnunet\-gns\fP(1)
44The full documentation for
45.B gnunet
46is maintained as a Texinfo manual. If the
47.B info
48and
49.B gnunet
50programs are properly installed at your site, the command
51.IP
52.B info gnunet
53.PP
54should give you access to the complete handbook,
55.IP
56.B info gnunet-c-tutorial
57.PP
58will give you access to a tutorial for developers.
59.PP
60Depending on your installation, this information is also
61available in
62\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1
index 2ed3df880..dd2b566f9 100644
--- a/doc/man/gnunet-core.1
+++ b/doc/man/gnunet-core.1
@@ -1,17 +1,13 @@
1.TH gnunet\-core "1" "11 Apr 2014" "GNUnet" 1.TH GNUNET-CORE "1" "April 11, 2014" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-core \- monitor CORE subsystem 3gnunet\-core \- monitor CORE subsystem
4
5.SH SYNOPSIS 4.SH SYNOPSIS
6.B gnunet\-core 5.B gnunet\-core
7[\fIOPTIONS\fR] 6[\fIOPTIONS\fR]
8.SH DESCRIPTION 7.SH DESCRIPTION
9.PP
10
11gnunet\-core is a tool to access various functions of GNUnet's core subsystem 8gnunet\-core is a tool to access various functions of GNUnet's core subsystem
12from the command\-line. The only function right now is to monitor the status 9from the command\-line. The only function right now is to monitor the status
13of peers known to the CORE service. 10of peers known to the CORE service.
14
15.TP 11.TP
16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 12\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
17configuration file to use 13configuration file to use
@@ -31,11 +27,29 @@ print the version number
31.TP 27.TP
32\fB\-V\fR, \fB\-\-verbose\fR 28\fB\-V\fR, \fB\-\-verbose\fR
33be verbose 29be verbose
34 30.SH BUGS
35.SH NOTES 31Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
36 32electronic mail to <gnunet\-developers@gnu.org>
37 33.SH SEE ALSO
38.SH "REPORTING BUGS"
39Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
40.SH "SEE ALSO"
41\fBgnunet\-transport\fP(1) 34\fBgnunet\-transport\fP(1)
35.PP
36The full documentation for
37.B gnunet
38is maintained as a Texinfo manual.
39If the
40.B info
41and
42.B gnunet
43programs are properly installed at your site, the command
44.IP
45.B info gnunet
46.PP
47should give you access to the complete handbook,
48.IP
49.B info gnunet-c-tutorial
50.PP
51will give you access to a tutorial for developers.
52.PP
53Depending on your installation, this information is also
54available in
55\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1
index 6bba7fb47..4cb536f51 100644
--- a/doc/man/gnunet-datastore.1
+++ b/doc/man/gnunet-datastore.1
@@ -1,18 +1,16 @@
1.TH gnunet\-datastore "1" "13 April 2017" "GNUnet" 1.TH GNUNET-DATASTORE "1" "April 13, 2017" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-datastore \- dump or insert (restore) GNUnet datastore databases 3gnunet\-datastore \- dump or insert (restore) GNUnet datastore databases
4
5.SH SYNOPSIS 4.SH SYNOPSIS
6.B gnunet\-datastore 5.B gnunet\-datastore
7[\fIOPTIONS\fR] 6[\fIOPTIONS\fR]
8.SH DESCRIPTION 7.SH DESCRIPTION
9.PP 8gnunet\-datastore can be used to backup and restore or merge GNUnet
10 9datastores.
11gnunet\-datastore can be used to backup and restore or merge GNUnet datastores. 10This is useful if a datastore is to be migrated between SQL databases,
12This is useful if a datastore is to be migrated between SQL databases, i.e. 11i.e. from sqlite to postgres or vice versa.
13from sqlite to postgres or vice versa. gnunet\-datastore will dump the 12gnunet\-datastore will dump the entire contents of the database or
14entire contents of the database or insert a dump file into the database. 13insert a dump file into the database.
15
16.TP 14.TP
17\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 15\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
18configuration file to use 16configuration file to use
@@ -37,11 +35,29 @@ configure logging to write logs to FILENAME
37.TP 35.TP
38\fB\-v\fR, \fB\-\-version\fR 36\fB\-v\fR, \fB\-\-version\fR
39print the version number 37print the version number
40 38.SH BUGS
41.SH NOTES 39Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
42 40electronic mail to <gnunet\-developers@gnu.org>
43 41.SH SEE ALSO
44.SH "REPORTING BUGS"
45Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
46.SH "SEE ALSO"
47\fBgnunet\-publish\fP(1) 42\fBgnunet\-publish\fP(1)
43.PP
44The full documentation for
45.B gnunet
46is maintained as a Texinfo manual.
47If the
48.B info
49and
50.B gnunet
51programs are properly installed at your site, the command
52.IP
53.B info gnunet
54.PP
55should give you access to the complete handbook,
56.IP
57.B info gnunet-c-tutorial
58.PP
59will give you access to a tutorial for developers.
60.PP
61Depending on your installation, this information is also
62available in
63\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1
index 9a44be244..109b2fc6c 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -1,7 +1,6 @@
1.TH gnunet-directory "1" "25 Feb 2012" "GNUnet" 1.TH GNUNET-DIRECTORY "1" "February 25, 2012" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-directory \- display directories 3gnunet\-directory \- display directories
4
5.SH SYNOPSIS 4.SH SYNOPSIS
6.B gnunet\-directory 5.B gnunet\-directory
7[\fIOPTIONS\fR] (FILENAME)* 6[\fIOPTIONS\fR] (FILENAME)*
@@ -37,7 +36,7 @@ availability but does not produce useless duplicates (for example, it is a
37better idea to publish a collection of pictures or compressed sound files 36better idea to publish a collection of pictures or compressed sound files
38using a GNUnet directory instead of processing them with archivers such as 37using a GNUnet directory instead of processing them with archivers such as
39tar or zip first). Directories can contain arbitrary meta data for each file. 38tar or zip first). Directories can contain arbitrary meta data for each file.
40 39.PP
41If a directory has missing blocks (for example, some blocks failed to download), 40If a directory has missing blocks (for example, some blocks failed to download),
42GNUnet is typically able to retrieve information about other files in the 41GNUnet is typically able to retrieve information about other files in the
43directory. Files in a GNUnet directory have no particular order; the GNUnet 42directory. Files in a GNUnet directory have no particular order; the GNUnet
@@ -45,18 +44,40 @@ code that generates a directory can reorder the entries in order to better
45fit the information about files into blocks of 32k. Respecting 32k boundaries 44fit the information about files into blocks of 32k. Respecting 32k boundaries
46where possible makes it easier for gnunet\-directory (and other tools) to 45where possible makes it easier for gnunet\-directory (and other tools) to
47recover information from partially downloaded directory files. 46recover information from partially downloaded directory files.
48 47.PP
49At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP 48At the moment, directories can be created by \fBgnunet\-fs\-gtk\fP
50and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be 49and \fBgnunet\-publish\fP. Just like ordinary files, a directory can be
51published in a namespace. 50published in a namespace.
52 51.PP
53GNUnet directories use the (unregistered) 52GNUnet directories use the (unregistered)
54mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal 53mimetype \fBapplication/gnunet\-directory\fP. They can show up among normal
55search results. The directory file can be downloaded to disk 54search results. The directory file can be downloaded to disk
56by \fBgnunet\-download\fP(1) for later processing or be handled more directly 55by \fBgnunet\-download\fP(1) for later processing or be handled more directly
57by \fBgnunet\-fs\-gtk\fP(1). 56by \fBgnunet\-fs\-gtk\fP(1).
58 57
59.SH "REPORTING BUGS" 58.SH BUGS
60Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 59Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
61.SH "SEE ALSO" 60electronic mail to <gnunet\-developers@gnu.org>
62\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1) 61.SH SEE ALSO
62\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
63\fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
64The full documentation for
65.B gnunet
66is maintained as a Texinfo manual.
67If the
68.B info
69and
70.B gnunet
71programs are properly installed at your site, the command
72.IP
73.B info gnunet
74.PP
75should give you access to the complete handbook,
76.IP
77.B info gnunet-c-tutorial
78.PP
79will give you access to a tutorial for developers.
80.PP
81Depending on your installation, this information is also
82available in
83\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1
index e04901062..6ecad3c42 100644
--- a/doc/man/gnunet-dns2gns.1
+++ b/doc/man/gnunet-dns2gns.1
@@ -35,7 +35,26 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
35Print GNUnet version number. 35Print GNUnet version number.
36 36
37.SH BUGS 37.SH BUGS
38Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> 38Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
39 39electronic mail to <bug\-gnunet@gnu.org>
40.SH SEE ALSO 40.SH SEE ALSO
41gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1) 41gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1)
42The full documentation for
43.B gnunet
44is maintained as a Texinfo manual. If the
45.B info
46and
47.B gnunet
48programs are properly installed at your site, the command
49.IP
50.B info gnunet
51.PP
52should give you access to the complete handbook,
53.IP
54.B info gnunet-c-tutorial
55.PP
56will give you access to a tutorial for developers.
57.PP
58Depending on your installation, this information is also
59available in
60\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-download-manager.1 b/doc/man/gnunet-download-manager.1
index ec1f7538a..7cc6dbffb 100644
--- a/doc/man/gnunet-download-manager.1
+++ b/doc/man/gnunet-download-manager.1
@@ -1,30 +1,80 @@
1.TH GNUNET-DOWNLOAD-MANAGER 1 "15 Jan, 2011" "GNUnet" 1.TH GNUNET-DOWNLOAD-MANAGER 1 "October 26, 2018" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet-download-manager \- manage downloads across sessions 3gnunet-download-manager \- manage downloads across sessions
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-download\-manager 5.B gnunet\-download\-manager
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-download\-manager\fP is a script that can be used to track 9\fBgnunet\-download\-manager\fP is a script that can be used to track
13download sessions. It makes the process of resuming downloads after a 10download sessions.
14system reboot easier. A typical use is to define an alias (depending 11It makes the process of resuming downloads after a system reboot
15on your shell) of the form 12easier.
16 13A typical use is to define an alias (depending on your shell) of the
14form:
15.TP
17$ alias gnunet\-download='gnunet\-download\-manager.scm download' 16$ alias gnunet\-download='gnunet\-download\-manager.scm download'
18 17.PP
19Other commands for the download manager include resume (resumes all 18The options for the download manager include:
20downloads), status (show status of pending downloads), killall (abort 19.TP
21all downloads), settings (for configuration) and help (print help text). 20.B download
22 21download
23gnunet\-download\-manager is a scheme script and will only work if Guile 22.TP
24is available. 23.B resume
25 24resumes all downloads
25.TP
26.B status
27show status of pending downloads
28.TP
29.B killall
30abort all downloads
31.TP
32.B settings
33for configuration
34.TP
35.B help
36print help text
37.PP
38gnunet\-download\-manager is a Scheme script and will only work if GNU
39Guile is available.
40.SH EXAMPLES
41(add-hook! *completed-download-hook* completed-download-notification-hook)
42.TP
43Add this to the configuration file to be notified of completed
44downloads.
45.SH FILES
46.TP
47~/.gnunet-download-manager.scm
48Configuration file.
26.SH BUGS 49.SH BUGS
27Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet-developers@gnu.org> 50Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
28 51electronic mail to <gnunet-developers@gnu.org>.
52.PP
53Furthermore it is assumed that gnunet-download-manager is no longer
54working correctly with Guile 2.2 series or current GNUnet, bugfixes
55are welcome.
29.SH SEE ALSO 56.SH SEE ALSO
30gnunet\-download(1) 57gnunet\-download(1)
58The full documentation for
59.B gnunet
60is maintained as a Texinfo manual.
61If the
62.B info
63and
64.B gnunet
65programs are properly installed at your site, the command
66.IP
67.B info gnunet
68.PP
69should give you access to the complete handbook,
70.IP
71.B info gnunet-c-tutorial
72.PP
73will give you access to a tutorial for developers.
74.PP
75Depending on your installation, this information is also
76available in
77\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
78.SH HISTORY
79.SH AUTHORS
80gnunet\-download\-manager was contributed by Ludovic Courtes in 2004.
diff --git a/doc/man/gnunet-download.1 b/doc/man/gnunet-download.1
index 824c2414d..58e82e790 100644
--- a/doc/man/gnunet-download.1
+++ b/doc/man/gnunet-download.1
@@ -1,21 +1,17 @@
1.TH GNUNET-DOWNLOAD "1" "31 Jan 2016" "GNUnet" 1.TH GNUNET-DOWNLOAD "1" "January 31, 2016" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-download \- a command line interface for downloading files from GNUnet 3gnunet\-download \- a command line interface for downloading files from GNUnet
4.SH SYNOPSIS 4.SH SYNOPSIS
5.B gnunet\-download 5.B gnunet\-download
6[\fIOPTIONS\fR] \-\- GNUNET_URI 6[\fIOPTIONS\fR] \-\- GNUNET_URI
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP
9Download files from GNUnet. 8Download files from GNUnet.
10
11.TP 9.TP
12\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR 10\fB\-a \fILEVEL\fR, \fB\-\-anonymity=LEVEL\fR
13set desired level of receiver anonymity. Default is 1. 11set desired level of receiver anonymity. Default is 1.
14
15.TP 12.TP
16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 13\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
17use config file (defaults: ~/.config/gnunet.conf) 14use config file (defaults: ~/.config/gnunet.conf)
18
19.TP 15.TP
20\fB\-D, \fB\-\-delete\-incomplete\fR 16\fB\-D, \fB\-\-delete\-incomplete\fR
21causes gnunet\-download to delete incomplete downloads when aborted with 17causes gnunet\-download to delete incomplete downloads when aborted with
@@ -24,20 +20,16 @@ download will not be deleted even with this option. Without this option,
24terminating gnunet\-download with a signal will cause incomplete 20terminating gnunet\-download with a signal will cause incomplete
25downloads to stay on disk. If gnunet\-download runs to (normal) completion 21downloads to stay on disk. If gnunet\-download runs to (normal) completion
26finishing the download, this option has no effect. 22finishing the download, this option has no effect.
27
28.TP 23.TP
29\fB\-h\fR, \fB\-\-help\fR 24\fB\-h\fR, \fB\-\-help\fR
30print help page 25print help page
31
32.TP 26.TP
33\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 27\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
34Change the loglevel. Possible values for LOGLEVEL are 28Change the loglevel. Possible values for LOGLEVEL are
35ERROR, WARNING, INFO and DEBUG. 29ERROR, WARNING, INFO and DEBUG.
36
37.TP 30.TP
38\fB\-n\fR, \fB\-\-no-network\fR 31\fB\-n\fR, \fB\-\-no-network\fR
39Only search locally, do not forward requests to other peers. 32Only search locally, do not forward requests to other peers.
40
41.TP 33.TP
42\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR 34\fB\-o \fIFILENAME\fR, \fB\-\-output=FILENAME\fR
43write the file to FILENAME. Hint: when recursively downloading a directory, 35write the file to FILENAME. Hint: when recursively downloading a directory,
@@ -45,7 +37,6 @@ append a '/' to the end of the FILENAME to create a directory of that name.
45If no FILENAME is specified, gnunet\-download constructs a temporary ID from 37If no FILENAME is specified, gnunet\-download constructs a temporary ID from
46the URI of the file. The final filename is constructed based on meta\-data 38the URI of the file. The final filename is constructed based on meta\-data
47extracted using libextractor (if available). 39extracted using libextractor (if available).
48
49.TP 40.TP
50\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR 41\fB\-p \fIDOWNLOADS\fR, \fB\-\-parallelism=DOWNLOADS\fR
51set the maximum number of parallel downloads that is allowed. More parallel 42set the maximum number of parallel downloads that is allowed. More parallel
@@ -56,7 +47,6 @@ used to limit the number of files that are downloaded in parallel (\-r can
56be used to limit the number of blocks that are concurrently requested). 47be used to limit the number of blocks that are concurrently requested).
57As a result, the value only matters for recursive downloads. 48As a result, the value only matters for recursive downloads.
58The default value is 32. 49The default value is 32.
59
60.TP 50.TP
61\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR 51\fB\-r \fIREQUESTS\fR, \fB\-\-request-parallelism=REQUESTS\fR
62set the maximum number of parallel requests that is allowed. If multiple 52set the maximum number of parallel requests that is allowed. If multiple
@@ -71,7 +61,6 @@ recursive downloads with many large files if memory and network
71bandwidth are not fully utilized and if the parallelism limit (\-p option) 61bandwidth are not fully utilized and if the parallelism limit (\-p option)
72is not reached. This option also only matters for recursive downloads. 62is not reached. This option also only matters for recursive downloads.
73The default value is 4092. 63The default value is 4092.
74
75.TP 64.TP
76\fB\-R\fR, \fB\-\-recursive\fR 65\fB\-R\fR, \fB\-\-recursive\fR
77download directories recursively (and in parallel). Note that the URI 66download directories recursively (and in parallel). Note that the URI
@@ -83,15 +72,12 @@ information will be stored in "DIRNAME/.gnd". However, it is also
83possible to specify "DIRNAME.gnd", in which case the files from the 72possible to specify "DIRNAME.gnd", in which case the files from the
84directory will end up in "DIRNAME/", while GNUnet's directory meta 73directory will end up in "DIRNAME/", while GNUnet's directory meta
85data will be in "DIRNAME.gnd". 74data will be in "DIRNAME.gnd".
86
87.TP 75.TP
88\fB\-v\fR, \fB\-\-version\fR 76\fB\-v\fR, \fB\-\-version\fR
89print the version number 77print the version number
90
91.TP 78.TP
92\fB\-V\fR, \fB\-\-verbose\fR 79\fB\-V\fR, \fB\-\-verbose\fR
93print progress information 80print progress information
94
95.SH NOTES 81.SH NOTES
96The GNUNET_URI is typically obtained from 82The GNUNET_URI is typically obtained from
97gnunet\-search. gnunet\-fs\-gtk can also be used instead of 83gnunet\-search. gnunet\-fs\-gtk can also be used instead of
@@ -102,9 +88,7 @@ already present. GNUnet's file\-encoding will ensure file integrity,
102even if the existing file was not downloaded from GNUnet in the first 88even if the existing file was not downloaded from GNUnet in the first
103place. Temporary information will be appended to the target file until 89place. Temporary information will be appended to the target file until
104the download is completed. 90the download is completed.
105
106.SH SETTING ANONYMITY LEVEL 91.SH SETTING ANONYMITY LEVEL
107
108The \fB\-a\fR option can be used to specify additional anonymity 92The \fB\-a\fR option can be used to specify additional anonymity
109constraints. If set to 0, GNUnet will try to download the file as fast 93constraints. If set to 0, GNUnet will try to download the file as fast
110as possible, including using non-anonymous methods. If you set it to 94as possible, including using non-anonymous methods. If you set it to
@@ -121,14 +105,14 @@ anonymity level 0, the peers publishing the data might be sharing with
121a higher anonymity level, which in this case will determine 105a higher anonymity level, which in this case will determine
122performance. Also, peers that cache content in the network always use 106performance. Also, peers that cache content in the network always use
123anonymity level 1. 107anonymity level 1.
124 108.PP
125This option can be used to limit requests further than that. In 109This option can be used to limit requests further than that. In
126particular, you can require GNUnet to receive certain amounts of 110particular, you can require GNUnet to receive certain amounts of
127traffic from other peers before sending your queries. This way, you 111traffic from other peers before sending your queries. This way, you
128can gain very high levels of anonymity \- at the expense of much more 112can gain very high levels of anonymity \- at the expense of much more
129traffic and much higher latency. So set it only if you really believe 113traffic and much higher latency. So set it only if you really believe
130you need it. 114you need it.
131 115.PP
132The definition of ANONYMITY\-RECEIVE is the following. 0 means no 116The definition of ANONYMITY\-RECEIVE is the following. 0 means no
133anonymity is required. Otherwise a value of 'v' means that 1 out of v 117anonymity is required. Otherwise a value of 'v' means that 1 out of v
134bytes of "anonymous" traffic can be from the local user, leaving 'v-1' 118bytes of "anonymous" traffic can be from the local user, leaving 'v-1'
@@ -137,17 +121,40 @@ bytes of messages from foreign peers (using anonymous routing), it may
137originate n/(v-1) bytes of queries in the same time\-period. The 121originate n/(v-1) bytes of queries in the same time\-period. The
138time\-period is twice the average delay that GNUnet defers forwarded 122time\-period is twice the average delay that GNUnet defers forwarded
139queries. 123queries.
140 124.PP
141The default is 1 and this should be fine for most users. Also notice 125The default is 1 and this should be fine for most users. Also notice
142that if you choose very large values, you may end up having no 126that if you choose very large values, you may end up having no
143throughput at all, especially if many of your fellow GNUnet\-peers all 127throughput at all, especially if many of your fellow GNUnet\-peers all
144do the same. 128do the same.
145
146.SH FILES 129.SH FILES
147.TP 130.TP
148~/.config/gnunet.conf 131~/.config/gnunet.conf
149GNUnet configuration file 132GNUnet configuration file
150.SH "REPORTING BUGS" 133.SH BUGS
151Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 134Report bugs to <https://gnunet.org/bugs/> or by sending electronic
152.SH "SEE ALSO" 135mail to <gnunet\-developers@gnu.org>
153\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), \fBgnunet\-service\-fs\fP(1) 136.SH SEE ALSO
137\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1),
138\fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5),
139\fBgnunet\-service\-fs\fP(1)
140.PP
141The full documentation for
142.B gnunet
143is maintained as a Texinfo manual.
144If the
145.B info
146and
147.B gnunet
148programs are properly installed at your site, the command
149.IP
150.B info gnunet
151.PP
152should give you access to the complete handbook,
153.IP
154.B info gnunet-c-tutorial
155.PP
156will give you access to a tutorial for developers.
157.PP
158Depending on your installation, this information is also
159available in
160\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-ecc.1 b/doc/man/gnunet-ecc.1
index 22a3c5d44..e3db11eab 100644
--- a/doc/man/gnunet-ecc.1
+++ b/doc/man/gnunet-ecc.1
@@ -1,4 +1,4 @@
1.TH GNUNET\-ECC 1 "Jun 5, 2017" "GNUnet" 1.TH GNUNET\-ECC 1 "June 5, 2017" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-ecc \- manipulate GNUnet ECC key files 4gnunet\-ecc \- manipulate GNUnet ECC key files
@@ -49,4 +49,25 @@ Print GNUnet version number.
49 49
50 50
51.SH BUGS 51.SH BUGS
52Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 52Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
53electronic mail to <gnunet\-developers@gnu.org>
54.SH SEE ALSO
55The full documentation for
56.B gnunet
57is maintained as a Texinfo manual. If the
58.B info
59and
60.B gnunet
61programs are properly installed at your site, the command
62.IP
63.B info gnunet
64.PP
65should give you access to the complete handbook,
66.IP
67.B info gnunet-c-tutorial
68.PP
69will give you access to a tutorial for developers.
70.PP
71Depending on your installation, this information is also
72available in
73\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1
index dfdaabbdb..8a9f0838c 100644
--- a/doc/man/gnunet-fs.1
+++ b/doc/man/gnunet-fs.1
@@ -1,19 +1,17 @@
1.TH gnunet\-fs "1" "2 Nov 2011" "GNUnet" 1.TH GNUNET\-FS "1" "November 2, 2011" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-fs \- measure and control the fs subsystem 3gnunet\-fs \- measure and control the fs subsystem
4
5.SH SYNOPSIS 4.SH SYNOPSIS
6.B gnunet\-fs 5.B gnunet\-fs
7[\fIOPTIONS\fR] 6[\fIOPTIONS\fR]
8.SH DESCRIPTION 7.SH DESCRIPTION
9.PP 8.PP
10
11gnunet\-fs is a tool to access various functions of GNUnet's fs 9gnunet\-fs is a tool to access various functions of GNUnet's fs
12subsystem from the command\-line. Most of these are not expected to 10subsystem from the command\-line.
13be useful for end-users. gnunet\-fs can currently only be used to 11Most of these are not expected to be useful for end-users.
14obtain a list of indexed files. Other functions should be added in 12gnunet\-fs can currently only be used to obtain a list of indexed
15the near future. 13files.
16 14Other functions should be added in the near future.
17.TP 15.TP
18\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR 16\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
19configuration file to use 17configuration file to use
@@ -21,20 +19,40 @@ configuration file to use
21\fB\-h\fR, \fB\-\-help\fR 19\fB\-h\fR, \fB\-\-help\fR
22print help page 20print help page
23.TP 21.TP
24\fB\-i\fR, \fB\-\-list-indexed\fR print information about files that 22\fB\-i\fR, \fB\-\-list-indexed\fR
25are currently indexed by file-sharing 23print information about files that are currently indexed by
24file-sharing
26.TP 25.TP
27\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR Change the 26\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
28loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and 27Change the loglevel.
29DEBUG. 28Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
30.TP 29.TP
31\fB\-v\fR, \fB\-\-version\fR print the version number 30\fB\-v\fR, \fB\-\-version\fR
31print the version number
32.TP 32.TP
33\fB\-V\fR, \fB\-\-verbose\fR be verbose 33\fB\-V\fR, \fB\-\-verbose\fR
34 34be verbose
35
36.SH BUGS 35.SH BUGS
37Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 36Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
38 37electronic mail to <gnunet\-developers@gnu.org>
39.SH SEE ALSO 38.SH SEE ALSO
40\fBgnunet\-publish\fP(1) 39\fBgnunet\-publish\fP(1)
40The full documentation for
41.B gnunet
42is maintained as a Texinfo manual. If the
43.B info
44and
45.B gnunet
46programs are properly installed at your site, the command
47.IP
48.B info gnunet
49.PP
50should give you access to the complete handbook,
51.IP
52.B info gnunet-c-tutorial
53.PP
54will give you access to a tutorial for developers.
55.PP
56Depending on your installation, this information is also
57available in
58\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1
index 96e9911a2..f99be5104 100644
--- a/doc/man/gnunet-gns-proxy.1
+++ b/doc/man/gnunet-gns-proxy.1
@@ -1,24 +1,19 @@
1.TH GNUNET\-GNS\-PROXY 1 "Oct 25, 2012" "GNUnet" 1.TH GNUNET-GNS-PROXY 1 "October 25, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy 3gnunet\-gns\-proxy \- run a client side GNS SOCKS proxy
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-gns\-proxy 5.B gnunet\-gns\-proxy
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12Most users will want to run this SOCKS proxy. It can be used in 8Most users will want to run this SOCKS proxy. It can be used in
13combination with browsers that support the SOCKS 4a protocol. 9combination with browsers that support the SOCKS 4a protocol.
14 10.PP
15The proxy will perform SSL authentication of GNS names and rewrite GNS 11The proxy will perform SSL authentication of GNS names and rewrite GNS
16enabled HTML content. To assert the validity of GNS names a local root 12enabled HTML content. To assert the validity of GNS names a local root
17CA certificate has to be generated that is used by the proxy. Thus 13CA certificate has to be generated that is used by the proxy. Thus
18"gnunet-gns-proxy-setup-ca" should be executed before the first launch 14"gnunet-gns-proxy-setup-ca" should be executed before the first launch
19of this proxy or the \-\-authority switch is used to specify an 15of this proxy or the \-\-authority switch is used to specify an
20appropriate CA certificate that is already trusted by the browser. 16appropriate CA certificate that is already trusted by the browser.
21
22.SH OPTIONS 17.SH OPTIONS
23.B 18.B
24.IP "\-c FILENAME, \-\-config=FILENAME" 19.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -42,10 +37,29 @@ ERROR.
42.B 37.B
43.IP "\-v, \-\-version" 38.IP "\-v, \-\-version"
44Print GNUnet version number. 39Print GNUnet version number.
45
46
47.SH BUGS 40.SH BUGS
48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> 41Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
49 42electronic mail to <bug\-gnunet@gnu.org>
50.SH SEE ALSO 43.SH SEE ALSO
51gnunet\-gns(1) 44gnunet\-gns(1)
45.PP
46The full documentation for
47.B gnunet
48is maintained as a Texinfo manual.
49If the
50.B info
51and
52.B gnunet
53programs are properly installed at your site, the command
54.IP
55.B info gnunet
56.PP
57should give you access to the complete handbook,
58.IP
59.B info gnunet-c-tutorial
60.PP
61will give you access to a tutorial for developers.
62.PP
63Depending on your installation, this information is also
64available in
65\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1
index 9e4482653..9f7a651a7 100644
--- a/doc/man/gnunet-gns.1
+++ b/doc/man/gnunet-gns.1
@@ -1,57 +1,67 @@
1.TH GNUNET\-GNS 1 "Mar 23, 2018" "GNUnet" 1.TH GNUNET\-GNS 1 "March 23, 2018" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-gns \- Access to GNU Name System 3gnunet\-gns \- Access to GNU Name System
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-gns 5.B gnunet\-gns
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-gns\fP can be used to lookup and process GNU Name Service 8\fBgnunet\-gns\fP can be used to lookup and process GNU Name Service
13names. 9names.
14
15.SH OPTIONS 10.SH OPTIONS
16.B 11.B
17.IP "\-c FILENAME, \-\-config=FILENAME" 12.IP "\-c FILENAME, \-\-config=FILENAME"
18Use the configuration file FILENAME. 13Use the configuration file FILENAME.
19.B 14.B
20.IP "\-r, \-\-raw" 15.IP "\-r, \-\-raw"
21No unneeded output. This is a quiet mode where only important 16No unneeded output.
22information is displayed. For example a lookup for an IP address will 17This is a quiet mode where only important information is displayed.
23only yield the IP address, no descriptive text. 18For example a lookup for an IP address will only yield the IP address,
19no descriptive text.
24.B 20.B
25.IP "\-h, \-\-help" 21.IP "\-h, \-\-help"
26Print short help on options. 22Print short help on options.
27.B 23.B
28.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
29Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 25Use LOGLEVEL for logging.
30ERROR. 26Valid values are DEBUG, INFO, WARNING and ERROR.
31.B 27.B
32.IP "\-u NAME, \-\-lookup=NAME" 28.IP "\-u NAME, \-\-lookup=NAME"
33Name to lookup. Resolve the specified name using the GNU Name System. 29Name to lookup.
30Resolve the specified name using the GNU Name System.
34.B 31.B
35.IP "\-t TYPE, \-\-type=TYPE" 32.IP "\-t TYPE, \-\-type=TYPE"
36Resource Record Type (TYPE) to look for. Supported TYPE's are: A, 33Resource Record Type (TYPE) to look for.
37AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, MX, LEHO, VPN, REV, PTR, 34Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA,
38TXT 35MX, LEHO, VPN, REV, PTR, TXT.
39
40Defaults to "A". 36Defaults to "A".
41.B 37.B
42.IP "\-v, \-\-version" 38.IP "\-v, \-\-version"
43Print GNUnet version number. 39Print GNUnet version number.
44.B
45
46.SH RETURN VALUE 40.SH RETURN VALUE
47
48gnunet\-gns will return 0 on success, 1 on internal failures, 2 on 41gnunet\-gns will return 0 on success, 1 on internal failures, 2 on
49launch failures, 4 if the given name is not configured to use GNS. 42launch failures, 4 if the given name is not configured to use GNS.
50
51
52.SH BUGS 43.SH BUGS
53Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 44Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
54 45electronic mail to <gnunet\-developers@gnu.org>
55 46.SH SEE ALSO
56.SH "SEE ALSO"
57\fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1) 47\fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1)
48.PP
49The full documentation for
50.B gnunet
51is maintained as a Texinfo manual. If the
52.B info
53and
54.B gnunet
55programs are properly installed at your site, the command
56.IP
57.B info gnunet
58.PP
59should give you access to the complete handbook,
60.IP
61.B info gnunet-c-tutorial
62.PP
63will give you access to a tutorial for developers.
64.PP
65Depending on your installation, this information is also
66available in
67\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index 37cf85f45..8d009d07b 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -1,4 +1,4 @@
1.TH GNUNET-IDENTITY "1" "5 Sep 2013" "GNUnet" 1.TH GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-identity \- create, delete or list egos 3gnunet\-identity \- create, delete or list egos
4.SH SYNOPSIS 4.SH SYNOPSIS
@@ -6,58 +6,75 @@ gnunet\-identity \- create, delete or list egos
6[options] 6[options]
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP 8.PP
9gnunet\-identity is a tool for managing egos. An ego is the persona 9gnunet\-identity is a tool for managing egos.
10that controls a namespace. It is identical to a public\-private ECC 10An ego is the persona that controls a namespace.
11key pair. 11It is identical to a public\-private ECC key pair.
12 12.PP
13gnunet\-identity can be used to list all of the egos that were created 13gnunet\-identity can be used to list all of the egos that were created
14locally, to create new egos, and to delete existing egos (the 14locally, to create new egos, and to delete existing egos (the
15namespace will continue to exist, but it will be impossible to add 15namespace will continue to exist, but it will be impossible to add
16additional data to it). 16additional data to it).
17 17.PP
18Creating a new ego requires using the \-C option together with an 18Creating a new ego requires using the \-C option together with an
19identifier (name) that is to be used for the new ego. This identifier 19identifier (name) that is to be used for the new ego.
20is only used locally for this peer and not shared with other peers. 20This identifier is only used locally for this peer and not shared with
21 21other peers.
22.TP 22.TP
23\fB\-C NAME\fR, \fB\-\-create=NAME\fR Creates a new ego with the given 23\fB\-C NAME\fR, \fB\-\-create=NAME\fR
24NAME. 24Creates a new ego with the given NAME.
25 25.TP
26\fB\-D NAME\fR, \fB\-\-delete=NAME\fR
27Delete the ego with the given NAME.
28.TP
29\fB\-e NAME\fR, \fB\-\-ego=NAME\fR
30Perform "set" operation with the respective ego.
31Needs to be used together with option \-s.
32.TP
33\fB\-h\fR, \fB\-\-help\fR
34Print help page.
26.TP 35.TP
27\fB\-D NAME\fR, \fB\-\-delete=NAME\fR Delete the ego with the given 36\fB\-d\fR, \fB\-\-display\fR
37display all of our egos
38.TP
39\fB\-m\fR, \fB\-\-monitor\fR
40Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
41Each ego is listed together with a unique pointer value; if egos are
42renamed, that pointer value remains the same; if egos are deleted,
43they are listed one more time with a name of "<null>".
44.TP
45\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR
46Perform "set" operation for the specified SUBSYSTEM with the
47respective ego.
48Needs to be used together with option \-e.
49After this, the given SUBSYSTEM will use the ego with the specified
28NAME. 50NAME.
29 51This will fail if NAME does not yet exist.
30.TP
31\fB\-e NAME\fR, \fB\-\-ego=NAME\fR Perform "set" operation with the
32respective ego. Needs to be used together with option \-s.
33
34.TP
35\fB\-h\fR, \fB\-\-help\fR Print help page.
36
37.TP
38\fB\-d\fR, \fB\-\-display\fR display all of our egos
39
40.TP
41\fB\-m\fR, \fB\-\-monitor\fR run in monitor mode, listing all ouf our
42egos until CTRL-C is pressed. Each ego is listed together with a
43unique pointer value; if egos are renamed, that pointer value remains
44the same; if egos are deleted, they are listed one more time with a
45name of "<null>".
46
47.TP
48\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR Perform "set" operation
49for the specified SUBSYSTEM with the respective ego. Needs to be used
50together with option \-e. After this, the given SUBSYSTEM will use
51the ego with the specified NAME. This will fail if NAME does not yet
52exist.
53
54
55.SH FILES 52.SH FILES
56.TP 53.TP
57~/.local/share/gnunet/identity/egos 54~/.local/share/gnunet/identity/egos
58Directory where the egos are stored (by default) 55Directory where the egos are stored (by default)
59 56.SH BUGS
60.SH "REPORTING BUGS" 57Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
61Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 58electronic mail to <gnunet\-developers@gnu.org>
62.SH "SEE ALSO" 59.SH SEE ALSO
63\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\fP(1) 60\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\fP(1)
61The full documentation for
62.B gnunet
63is maintained as a Texinfo manual.
64If the
65.B info
66and
67.B gnunet
68programs are properly installed at your site, the command
69.IP
70.B info gnunet
71.PP
72should give you access to the complete handbook,
73.IP
74.B info gnunet-c-tutorial
75.PP
76will give you access to a tutorial for developers.
77.PP
78Depending on your installation, this information is also
79available in
80\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-namecache.1 b/doc/man/gnunet-namecache.1
index ffc315b32..528656218 100644
--- a/doc/man/gnunet-namecache.1
+++ b/doc/man/gnunet-namecache.1
@@ -1,4 +1,4 @@
1.TH GNUNET\-NAMECACHE 1 "Oct 16, 2013" "GNUnet" 1.TH GNUNET\-NAMECACHE 1 "October 16, 2013" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-namecache \- inspect namecache 4gnunet\-namecache \- inspect namecache
@@ -35,8 +35,26 @@ Specifies the public key of the zone to inspect (mandatory option)
35 35
36 36
37.SH BUGS 37.SH BUGS
38Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 38Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
39 39electronic mail to <gnunet\-developers@gnu.org>
40 40.SH SEE ALSO
41.SH "SEE ALSO"
42\fBgnunet\-gns\fP(1) 41\fBgnunet\-gns\fP(1)
42The full documentation for
43.B gnunet
44is maintained as a Texinfo manual. If the
45.B info
46and
47.B gnunet
48programs are properly installed at your site, the command
49.IP
50.B info gnunet
51.PP
52should give you access to the complete handbook,
53.IP
54.B info gnunet-c-tutorial
55.PP
56will give you access to a tutorial for developers.
57.PP
58Depending on your installation, this information is also
59available in
60\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index 88ab72071..3f22145e2 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -1,36 +1,31 @@
1.TH GNUNET\-NAMESTORE-FCFSD 1 "5 Sep 2013" "GNUnet" 1.TH GNUNET-NAMESTORE-FCFSD 1 "September 5, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration 3gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-namestore-fcfsd 5.B gnunet\-namestore-fcfsd
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12Most users will not want to run an FCFS\-zone and thus will not need 8Most users will not want to run an FCFS\-zone and thus will not need
13this program. 9this program.
14 10.PP
15\fBgnunet\-gns-fcfsd\fP runs a web server where users can register 11\fBgnunet\-gns-fcfsd\fP runs a web server where users can register
16names to be mapped to their GNS zone. Names are made available on a 12names to be mapped to their GNS zone. Names are made available on a
17First Come First Served basis (hence fcfs). Registered names do not 13First Come First Served basis (hence fcfs). Registered names do not
18expire. The HTTP server is run on the port that is specified in the 14expire. The HTTP server is run on the port that is specified in the
19configuration file in section "[fcfsd]" under the name "HTTPPORT". 15configuration file in section "[fcfsd]" under the name "HTTPPORT".
20 16.PP
21It is possible to manage gnunet\-gns\-fcfsd using 17It is possible to manage gnunet\-gns\-fcfsd using
22gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i 18gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i
23fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your 19fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your
24configuration and the "-z ZONE" in as the "OPTION". 20configuration and the "-z ZONE" in as the "OPTION".
25 21.PP
26An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are 22An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are
27encouraged to register their zone with the gnunet.org FCFS authority. 23encouraged to register their zone with the gnunet.org FCFS authority.
28 24.PP
29If you want to run your own FCFS registrar, you need to first create a 25If you want to run your own FCFS registrar, you need to first create a
30pseudonym (using "gnunet\-identity \-C NAME"), and use it with the 26pseudonym (using "gnunet\-identity \-C NAME"), and use it with the
31"-z" option. After that, you can start the FCFSD service (possibly using 27"-z" option. After that, you can start the FCFSD service (possibly using
32gnunet\-arm). 28gnunet\-arm).
33
34.SH OPTIONS 29.SH OPTIONS
35.B 30.B
36.IP "\-c FILENAME, \-\-config=FILENAME" 31.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -48,9 +43,29 @@ Print GNUnet version number.
48.B 43.B
49.IP "\-z EGO, \-\-zone=EGO" 44.IP "\-z EGO, \-\-zone=EGO"
50Specifies for which EGO should FCFSD manage the zone. 45Specifies for which EGO should FCFSD manage the zone.
51
52.SH BUGS 46.SH BUGS
53Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> 47Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
54 48electronic mail to <bug\-gnunet@gnu.org>
55.SH SEE ALSO 49.SH SEE ALSO
56gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) 50gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1)
51.PP
52The full documentation for
53.B gnunet
54is maintained as a Texinfo manual.
55If the
56.B info
57and
58.B gnunet
59programs are properly installed at your site, the command
60.IP
61.B info gnunet
62.PP
63should give you access to the complete handbook,
64.IP
65.B info gnunet-c-tutorial
66.PP
67will give you access to a tutorial for developers.
68.PP
69Depending on your installation, this information is also
70available in
71\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index 006c8593b..10577a0d9 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -1,4 +1,4 @@
1.TH GNUNET\-NAMESTORE 1 "Apr 15, 2014" "GNUnet" 1.TH GNUNET\-NAMESTORE 1 "April 15, 2014" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-namestore \- manipulate GNU Name System (GNS) zone data 4gnunet\-namestore \- manipulate GNU Name System (GNS) zone data
@@ -89,8 +89,26 @@ Specifies the name of the ego controlling the private key for the zone
89 89
90 90
91.SH BUGS 91.SH BUGS
92Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 92Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
93 93electronic mail to <gnunet\-developers@gnu.org>
94 94.SH SEE ALSO
95.SH "SEE ALSO"
96\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1) 95\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1)
96The full documentation for
97.B gnunet
98is maintained as a Texinfo manual. If the
99.B info
100and
101.B gnunet
102programs are properly installed at your site, the command
103.IP
104.B info gnunet
105.PP
106should give you access to the complete handbook,
107.IP
108.B info gnunet-c-tutorial
109.PP
110will give you access to a tutorial for developers.
111.PP
112Depending on your installation, this information is also
113available in
114\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
index 3a2631391..bc95972c4 100644
--- a/doc/man/gnunet-nat-auto.1
+++ b/doc/man/gnunet-nat-auto.1
@@ -1,71 +1,72 @@
1.TH GNUNET\-NAT\-AUTO 1 "6 Jan 2017" "GNUnet" 1.TH GNUNET-NAT-AUTO 1 "January 6, 2017" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-nat\-auto \- autoconfigure and test NAT traversal 3gnunet\-nat\-auto \- autoconfigure and test NAT traversal
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-nat\-auto 5.B gnunet\-nat\-auto
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12
13This tool allows testing various NAT traversal functions, as well 8This tool allows testing various NAT traversal functions, as well
14as attempting auto\-configuration. 9as attempting auto\-configuration.
15
16.SH OPTIONS 10.SH OPTIONS
17.B 11.B
18.IP "\-a, \-\-auto" 12.IP "\-a, \-\-auto"
19Attempt auto\-configuration for NAT traversal. 13Attempt auto\-configuration for NAT traversal.
20
21.B 14.B
22.IP "\-c FILENAME, \-\-config=FILENAME" 15.IP "\-c FILENAME, \-\-config=FILENAME"
23Use the configuration file FILENAME. 16Use the configuration file FILENAME.
24
25.B 17.B
26.IP "\-S NAME, \-\-section=NAME" 18.IP "\-S NAME, \-\-section=NAME"
27Name of the configuration section with details about the configuration 19Name of the configuration section with details about the configuration
28to test. For example "transport-tcp". 20to test. For example "transport-tcp".
29
30.IP "\-t, \-\-tcp" 21.IP "\-t, \-\-tcp"
31Use TCP. 22Use TCP.
32
33.B 23.B
34.IP "\-u, \-\-udp" 24.IP "\-u, \-\-udp"
35Use UDP. 25Use UDP.
36
37.B 26.B
38.IP "\-w, \-\-write" 27.IP "\-w, \-\-write"
39Write configuration to configuration file, useful in combination with 28Write configuration to configuration file, useful in combination with
40autoconfiguration (\-a). 29autoconfiguration (\-a).
41
42.SH EXAMPLES 30.SH EXAMPLES
43.PP 31.PP
44
45\fBAutomatic configuration:\fR 32\fBAutomatic configuration:\fR
46 33.TP
47Probe and write result to configuration: 34# gnunet\-nat\-auto \-aw
48 35Probe and write result to configuration
49 # gnunet\-nat\-auto \-aw 36.PP
50
51
52\fBTest configuration:\fR 37\fBTest configuration:\fR
53 38.TP
54Test TCP configuration: 39# gnunet\-nat\-auto -t \-S transport-tcp
55 40Test TCP configuration
56 # gnunet\-nat\-auto -t \-S transport-tcp 41.TP
57 42# gnunet\-nat\-auto -t \-S transport-http
58Test HTTP configuration: 43Test HTTP configuration
59 44.TP
60 # gnunet\-nat\-auto -t \-S transport-http 45# gnunet\-nat\-auto -u \-S transport-udp
61 46Test UDP configuration
62Test UDP configuration:
63
64 # gnunet\-nat\-auto -u \-S transport-udp
65
66
67.SH BUGS 47.SH BUGS
68Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
69 49electronic mail to <gnunet\-developers@gnu.org>
70.SH SEE ALSO 50.SH SEE ALSO
71gnunet\-transport(1) gnunet\-nat(1) 51gnunet\-transport(1) gnunet\-nat(1)
52.PP
53The full documentation for
54.B gnunet
55is maintained as a Texinfo manual.
56If the
57.B info
58and
59.B gnunet
60programs are properly installed at your site, the command
61.IP
62.B info gnunet
63.PP
64should give you access to the complete handbook,
65.IP
66.B info gnunet-c-tutorial
67.PP
68will give you access to a tutorial for developers.
69.PP
70Depending on your installation, this information is also
71available in
72\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index 3d79d5bc5..1fdf1e265 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -1,23 +1,18 @@
1.TH GNUNET\-NAT\-SERVER 1 "25 Feb 2012" "GNUnet" 1.TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-nat\-server \- help GNUnet setup test network setup with NAT 3gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-nat\-server 5.B gnunet\-nat\-server
8.RI [ options ] 6.RI [ options ]
9.RI PORT 7.RI PORT
10.br
11
12.SH DESCRIPTION 8.SH DESCRIPTION
13
14Normal GNUnet end-users should not concern themselves with 9Normal GNUnet end-users should not concern themselves with
15gnunet\-nat\-server. In fact, distributions are encouraged to 10gnunet\-nat\-server. In fact, distributions are encouraged to
16consider not shipping it at all. Running gnunet\-nat\-server's is 11consider not shipping it at all. Running gnunet\-nat\-server's is
17similar to running hostlist servers: it is a special service to the 12similar to running hostlist servers: it is a special service to the
18community with special requirements and no benefit to those running 13community with special requirements and no benefit to those running
19the service. 14the service.
20 15.PP
21This program will listen on the specified PORT for incoming requests 16This program will listen on the specified PORT for incoming requests
22to test a peer's network connectivity. Incoming requests can ask it 17to test a peer's network connectivity. Incoming requests can ask it
23to connect to a given IPv4 address (and port) using TCP or UDP and to 18to connect to a given IPv4 address (and port) using TCP or UDP and to
@@ -25,36 +20,53 @@ send a 2-byte test message using the specified address. The program
25can also be asked to send a "fake" ICMP response message to a given 20can also be asked to send a "fake" ICMP response message to a given
26IPv4 address (for autonomous NAT traversal \-\-\- see the description 21IPv4 address (for autonomous NAT traversal \-\-\- see the description
27in the respective research paper). 22in the respective research paper).
28 23.PP
29The idea is that gnunet\-nat\-server will be run on some trusted hosts 24The idea is that gnunet\-nat\-server will be run on some trusted hosts
30with unrestricted connectivity to allow GNUnet users to test their 25with unrestricted connectivity to allow GNUnet users to test their
31network configuration. As written, the code allows any user on the 26network configuration. As written, the code allows any user on the
32Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary 27Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
33data to any TCP or UDP port at any address. We believe that this is 28data to any TCP or UDP port at any address. We believe that this is
34generally harmless. 29generally harmless.
35 30.PP
36When running gnunet\-nat\-server, make sure to use a configuration 31When running gnunet\-nat\-server, make sure to use a configuration
37that disables most NAT options but enables 'enable_nat_client' and 32that disables most NAT options but enables 'enable_nat_client' and
38sets 'internal_address' to the global IP address of your local host. 33sets 'internal_address' to the global IP address of your local host.
39Also, the gnunet\-helper\-nat\-client should be installed locally and 34Also, the gnunet\-helper\-nat\-client should be installed locally and
40run with root privileges (SUID), otherwise the gnunet\-nat\-server 35run with root privileges (SUID), otherwise the gnunet\-nat\-server
41will not work properly. 36will not work properly.
42 37.PP
43Note that gnunet\-nat\-server could be run via gnunet\-arm but 38Note that gnunet\-nat\-server could be run via gnunet\-arm but
44typically is not. Also, the name of the host and port that 39typically is not. Also, the name of the host and port that
45gnunet\-nat\-server is run on should be specified in the NATSERVER 40gnunet\-nat\-server is run on should be specified in the NATSERVER
46option in the [setup] section of the configuration file of hosts that 41option in the [setup] section of the configuration file of hosts that
47are supposed to autoconfigure with this server. 42are supposed to autoconfigure with this server.
48
49
50.SH OPTIONS 43.SH OPTIONS
51.B 44.B
52.IP "\-c FILENAME, \-\-config=FILENAME" 45.IP "\-c FILENAME, \-\-config=FILENAME"
53Use the configuration file FILENAME. 46Use the configuration file FILENAME.
54
55.SH BUGS 47.SH BUGS
56Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
57 49electronic mail to <gnunet\-developers@gnu.org>
58.SH SEE ALSO 50.SH SEE ALSO
59gnunet\-transport(1) 51gnunet\-transport(1)
60 52.PP
53The full documentation for
54.B gnunet
55is maintained as a Texinfo manual.
56If the
57.B info
58and
59.B gnunet
60programs are properly installed at your site, the command
61.IP
62.B info gnunet
63.PP
64should give you access to the complete handbook,
65.IP
66.B info gnunet-c-tutorial
67.PP
68will give you access to a tutorial for developers.
69.PP
70Depending on your installation, this information is also
71available in
72\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index fe9d8af3e..cf48e1dc6 100644
--- a/doc/man/gnunet-nat.1
+++ b/doc/man/gnunet-nat.1
@@ -1,118 +1,109 @@
1.TH GNUNET\-NAT 1 "27 Nov 2016" "GNUnet" 1.TH GNUNET\-NAT 1 "October 26, 2018" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-nat \- interact with the NAT service 3gnunet\-nat \- interact with the NAT service
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-nat 5.B gnunet\-nat
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12 8This tool allows testing various NAT traversal functions, as well as
13This tool allows testing various NAT traversal functions, as well 9attempting auto\-configuration.
14as attempting auto\-configuration.
15
16.SH OPTIONS 10.SH OPTIONS
17
18.B 11.B
19.IP "\-b ADDRESS, \-\-bind=ADDRESS" 12.IP "\-b ADDRESS, \-\-bind=ADDRESS"
20Assume that the service is (locally) bound to ADDRESS. 13Assume that the service is (locally) bound to ADDRESS.
21
22.B 14.B
23.IP "\-c FILENAME, \-\-config=FILENAME" 15.IP "\-c FILENAME, \-\-config=FILENAME"
24Use the configuration file FILENAME. 16Use the configuration file FILENAME.
25
26.B 17.B
27.IP "\-e ADDRESS, \-\-external=ADDRESS" 18.IP "\-e ADDRESS, \-\-external=ADDRESS"
28Assume that ADDRESS is the globally visible address of the peer. 19Assume that ADDRESS is the globally visible address of the peer.
29
30.B 20.B
31.IP "\-i ADDRESS, \-\-in=ADDRESS" 21.IP "\-i ADDRESS, \-\-in=ADDRESS"
32Assuming we are listening at ADDRESS for connection reversal requests. 22Assuming we are listening at ADDRESS for connection reversal requests.
33
34.B 23.B
35.IP "\-r ADDRESS, \-\-remote=ADDRESS" 24.IP "\-r ADDRESS, \-\-remote=ADDRESS"
36Ask the peer at ADDRESS for connection reversal, using the local 25Ask the peer at ADDRESS for connection reversal, using the local
37address for the target address of the reversal. 26address for the target address of the reversal.
38
39.B 27.B
40.IP "\-S NAME, \-\-section=NAME" 28.IP "\-S NAME, \-\-section=NAME"
41Name of section in configuration file to use for additional options. 29Name of section in configuration file to use for additional options.
42
43.B 30.B
44.IP "\-s, \-\-stun" 31.IP "\-s, \-\-stun"
45Enable processing of STUN requests. Will try to read UDP packets from 32Enable processing of STUN requests.
46the bind address and handle the packets if they are STUN packets. Will 33Will try to read UDP packets from the bind address and handle the
47only work with UDP. 34packets if they are STUN packets.
48 35Will only work with UDP.
49.B 36.B
50.IP "\-t, \-\-tcp" 37.IP "\-t, \-\-tcp"
51Use TCP. 38Use TCP.
52
53.B 39.B
54.IP "\-u, \-\-udp" 40.IP "\-u, \-\-udp"
55Use UDP. 41Use UDP.
56
57.B 42.B
58.IP "\-W, \-\-watch" 43.IP "\-W, \-\-watch"
59Watch for connection reversal requests. 44Watch for connection reversal requests.
60
61.SH EXAMPLES 45.SH EXAMPLES
62.PP 46.PP
63
64\fBBasic examples\fR 47\fBBasic examples\fR
65 48.TP
49# gnunet-nat -i 0.0.0.0:8080 -u
66We are bound to "0.0.0.0:8080" on UDP and want to obtain all 50We are bound to "0.0.0.0:8080" on UDP and want to obtain all
67applicable IP addresses: 51applicable IP addresses.
68 52.TP
69 # gnunet-nat -i 0.0.0.0:8080 -u 53# gnunet-nat -i '[::0]':8080 -t
70
71We are bound to "::0" on port 8080 on TCP and want to obtain all 54We are bound to "::0" on port 8080 on TCP and want to obtain all
72applicable IP addresses: 55applicable IP addresses.
73 56.TP
74 # gnunet-nat -i '[::0]':8080 -t 57# gnunet-nat -i 127.0.0.1:8080 -u
75
76We are bound to "127.0.0.1:8080" on UDP and want to obtain all 58We are bound to "127.0.0.1:8080" on UDP and want to obtain all
77applicable IP addresses: 59applicable IP addresses:
78 60.PP
79 # gnunet-nat -i 127.0.0.1:8080 -u
80
81\fBICMP-based NAT traversal:\fR 61\fBICMP-based NAT traversal:\fR
82 62.TP
63# gnunet-nat -Wt -i 192.168.178.12:8080
83Watch for connection reversal request (you must be bound to NAT range 64Watch for connection reversal request (you must be bound to NAT range
84or to wildcard, 0.0.0.0), only works for IPv4: 65or to wildcard, 0.0.0.0), only works for IPv4:
85 66.TP
86 # gnunet-nat -Wt -i 192.168.178.12:8080 67# gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080
87
88Initiate connection reversal request from peer at external IPv4 68Initiate connection reversal request from peer at external IPv4
89address 1.2.3.4, while we are running ourselves at 2.3.4.5:8080 (must 69address 1.2.3.4, while we are running ourselves at 2.3.4.5:8080 (must
90use IPv4 addresses): 70use IPv4 addresses):
91 71.TP
92 # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080 72# gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080
93
94Initiate connection reversal request from peer at external IPv4 73Initiate connection reversal request from peer at external IPv4
95address 1.2.3.4, and let the kernel fill in whatever IPv4 address we 74address 1.2.3.4, and let the kernel fill in whatever IPv4 address we
96happen to have: 75happen to have:
97 76.PP
98 # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080
99
100\fBManual hole punching:\fR 77\fBManual hole punching:\fR
101 78.TP
79# gnunet-nat -t -p AUTO:8080
102Assume manually punched NAT, but determine external IP automatically: 80Assume manually punched NAT, but determine external IP automatically:
103 81.PP
104 # gnunet-nat -t -p AUTO:8080
105
106\fBSTUN-based XXX:\fR 82\fBSTUN-based XXX:\fR
107 83.TP
108XXX: 84# gnunet-nat FIXME -s
109 85XXX
110 # gnunet-nat FIXME -s
111
112
113.SH BUGS 86.SH BUGS
114Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 87Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
115 88electronic mail to <gnunet\-developers@gnu.org>
116.SH SEE ALSO 89.SH SEE ALSO
117gnunet\-transport(1) 90gnunet\-transport(1)
118 91The full documentation for
92.B gnunet
93is maintained as a Texinfo manual. If the
94.B info
95and
96.B gnunet
97programs are properly installed at your site, the command
98.IP
99.B info gnunet
100.PP
101should give you access to the complete handbook,
102.IP
103.B info gnunet-c-tutorial
104.PP
105will give you access to a tutorial for developers.
106.PP
107Depending on your installation, this information is also
108available in
109\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
index cfb34c36a..03246d968 100644
--- a/doc/man/gnunet-peerinfo.1
+++ b/doc/man/gnunet-peerinfo.1
@@ -1,23 +1,18 @@
1.TH GNUNET\-PEERINFO 1 "Mar 4, 2013" "GNUnet" 1.TH GNUNET-PEERINFO 1 "March 4, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-peerinfo \- Display information about other peers. 3gnunet\-peerinfo \- Display information about other peers.
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-peerinfo 5.B gnunet\-peerinfo
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12.PP 8.PP
13\fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. 9\fBgnunet\-peerinfo\fP display the known addresses and trust of known peers.
14
15.SH OPTIONS 10.SH OPTIONS
16.B 11.B
17.IP "\-c FILENAME, \-\-config=FILENAME" 12.IP "\-c FILENAME, \-\-config=FILENAME"
18Load config file (default: ~/.config/gnunet.conf) 13Load config file (default: ~/.config/gnunet.conf)
19.B 14.B
20.IP "\-g, \-\-get\-hello 15.IP "\-g, \-\-get\-hello"
21Output HELLO uri(s) 16Output HELLO uri(s)
22.B 17.B
23.IP "\-h, \-\-help" 18.IP "\-h, \-\-help"
@@ -35,7 +30,7 @@ Log messages to LOGFILE
35.IP "\-n, \-\-numeric" 30.IP "\-n, \-\-numeric"
36Disable resolution of IPs to hostnames 31Disable resolution of IPs to hostnames
37.B 32.B
38.IP "\-p, \-\-put\-hello=HELLO 33.IP "\-p, \-\-put\-hello=HELLO"
39Add given HELLO uri to the database 34Add given HELLO uri to the database
40.B 35.B
41.IP "\-q, \-\-quiet" 36.IP "\-q, \-\-quiet"
@@ -48,10 +43,29 @@ order to consider this peer one of their friends in F2F mode).
48.B 43.B
49.IP "\-v, \-\-version" 44.IP "\-v, \-\-version"
50Print the version number 45Print the version number
51
52
53.SH BUGS 46.SH BUGS
54Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 47Report bugs by using mantis <https://gnunet.org/bugs/> or by sending
55 48electronic mail to <gnunet\-developers@gnu.org>
56.SH SEE ALSO 49.SH SEE ALSO
57gnunet.conf(5) 50gnunet.conf(5)
51.PP
52The full documentation for
53.B gnunet
54is maintained as a Texinfo manual.
55If the
56.B info
57and
58.B gnunet
59programs are properly installed at your site, the command
60.IP
61.B info gnunet
62.PP
63should give you access to the complete handbook,
64.IP
65.B info gnunet-c-tutorial
66.PP
67will give you access to a tutorial for developers.
68.PP
69Depending on your installation, this information is also
70available in
71\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1
index 28ee163e2..5bc2eec76 100644
--- a/doc/man/gnunet-publish.1
+++ b/doc/man/gnunet-publish.1
@@ -1,4 +1,4 @@
1.TH GNUNET-PUBLISH "1" "16 Nov 2015" "GNUnet" 1.TH GNUNET-PUBLISH "1" "November 16, 2015" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-publish \- a command line interface for publishing new content into GNUnet 3gnunet\-publish \- a command line interface for publishing new content into GNUnet
4.SH SYNOPSIS 4.SH SYNOPSIS
@@ -7,315 +7,341 @@ gnunet\-publish \- a command line interface for publishing new content into GNUn
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP 8.PP
9In order to share files with other GNUnet users, the files must first 9In order to share files with other GNUnet users, the files must first
10be made available to GNUnet. GNUnet does not automatically share all 10be made available to GNUnet.
11files from a certain directory (however, you can do this with the 11GNUnet does not automatically share all files from a certain directory
12gnunet\-auto\-share tool). In fact, even files that are downloaded 12(however, you can do this with the gnunet\-auto\-share tool).
13are not automatically shared. 13In fact, even files that are downloaded are not automatically shared.
14.PP 14.PP
15In order to start sharing files, the files must be added either using 15In order to start sharing files, the files must be added either using
16gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk. The 16gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk.
17command line tool gnunet\-publish is more useful if many files are 17The command line tool gnunet\-publish is more useful if many files are
18supposed to be added. gnunet\-publish can automatically publish 18supposed to be added.
19batches of files, recursively publish directories, create directories 19gnunet\-publish can automatically publish batches of files,
20that can be browsed within GNUnet and publish file lists in a 20recursively publish directories, create directories that can be
21namespace. When run on a directory, gnunet\-publish will always 21browsed within GNUnet and publish file lists in a namespace.
22recursively publish all of the files in the directory. 22When run on a directory, gnunet\-publish will always recursively
23publish all of the files in the directory.
23.PP 24.PP
24gnunet\-publish can automatically extract keywords from the files that 25gnunet\-publish can automatically extract keywords from the files that
25are shared. Users that want to download files from GNUnet use 26are shared.
26keywords to search for the appropriate content. You can disable 27Users that want to download files from GNUnet use keywords to search
27keyword extraction with the \-D option. You can manually add keywords 28for the appropriate content.
28using the \-k option. The keywords are case\-sensitive. 29You can disable keyword extraction with the \-D option.
30You can manually add keywords using the \-k option.
31The keywords are case\-sensitive.
29.PP 32.PP
30In addition to searching for files by keyword, GNUnet allows 33In addition to searching for files by keyword, GNUnet allows
31organizing files into directories. With directories, the user only 34organizing files into directories.
32needs to find the directory in order to be able to download any of the 35With directories, the user only needs to find the directory in order
33files listed in the directory. Directories can contain pointers to 36to be able to download any of the files listed in the directory.
34other directories. 37Directories can contain pointers to other directories.
35.PP 38.PP
36With gnunet\-publish, it is easy to create new directories 39With gnunet\-publish, it is easy to create new directories
37simultaneously when adding the files. Simply pass the name of a 40simultaneously when adding the files.
38directory instead of a file. 41Simply pass the name of a directory instead of a file.
39.PP 42.PP
40Since keywords can be spammed (any user can add any content under any 43Since keywords can be spammed (any user can add any content under any
41keyword), GNUnet supports namespaces. A namespace is a subset of the 44keyword), GNUnet supports namespaces.
42searchspace into which only the holder of a certain pseudonym can add 45A namespace is a subset of the searchspace into which only the holder
43content. Any GNUnet user can create any number of pseudonyms using 46of a certain pseudonym can add content.
44\fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet 47Any GNUnet user can create any number of pseudonyms using
45directory. While pseudonyms are locally identified with an arbitrary 48\fBgnunet\-pseudonym\fR. Pseudonyms are stored in the user's GNUnet
46string that the user selects when the pseudonym is created, the 49directory.
47namespace is globally known only under the hash of the public key of 50While pseudonyms are locally identified with an arbitrary string that
48the pseudonym. Since only the owner of the pseudonym can add content 51the user selects when the pseudonym is created, the namespace is
49to the namespace, it is impossible for other users to pollute the 52globally known only under the hash of the public key of the pseudonym.
50namespace. gnunet\-publish automatically publishes the top\-directory 53Since only the owner of the pseudonym can add content to the
51(or the only file if only one file is specified) into the namespace if 54namespace, it is impossible for other users to pollute the namespace.
52a pseudonym is specified. 55gnunet\-publish automatically publishes the top\-directory (or the
56only file if only one file is specified) into the namespace if a
57pseudonym is specified.
53.PP 58.PP
54It is possible to update content in GNUnet if that content was placed 59It is possible to update content in GNUnet if that content was placed
55and obtained from a particular namespace. Updates are only possible 60and obtained from a particular namespace.
56for content in namespaces since this is the only way to assure that a 61Updates are only possible for content in namespaces since this is the
57malicious party can not supply counterfeited updates. Note that an 62only way to assure that a malicious party can not supply counterfeited
58update with GNUnet does not make the old content unavailable, GNUnet 63updates.
59merely allows the publisher to point users to more recent 64Note that an update with GNUnet does not make the old content
60versions. You can use the \-N option to specify the future identifier 65unavailable, GNUnet merely allows the publisher to point users to more
61of an update. When using this option, a GNUnet client that finds the 66recent versions.
62current (\-t) identifier will automatically begin a search for the 67You can use the \-N option to specify the future identifier of an
63update (\-N) identifier. If you later publish an update under the 68update.
64(\-N) identifier, both results will be given to the user. 69When using this option, a GNUnet client that finds the current (\-t)
70identifier will automatically begin a search for the update (\-N)
71identifier.
72If you later publish an update under the (\-N) identifier, both
73results will be given to the user.
65.PP 74.PP
66You can use automatic meta\-data extraction (based on libextractor) or 75You can use automatic meta\-data extraction (based on libextractor) or
67the command\-line option \-m to specify meta-data. For the \-m option 76the command\-line option \-m to specify meta-data.
68you need to use the form keyword\-type:value. For example, use "\-m 77For the \-m option you need to use the form keyword\-type:value.
69os:Linux" to specify that the operating system is Linux. Common 78For example, use "\-m os:Linux" to specify that the operating system
70meta\-data types are "author", "title" , "mimetype", "filename", 79is Linux.
71"language", "subject" and "keywords". A full list can be obtained 80Common meta\-data types are "author", "title" , "mimetype",
72from the extract tool using the option \-\-list. The meta\-data is 81"filename", "language", "subject" and "keywords".
73used to help users in searching for files on the network. The 82A full list can be obtained from the extract tool using the option
74keywords are case\-sensitive. 83\-\-list.
84The meta\-data is used to help users in searching for files on the
85network.
86The keywords are case\-sensitive.
75.PP 87.PP
76GNUnet supports two styles of publishing files on the 88GNUnet supports two styles of publishing files on the network.
77network. Publishing a file means that a copy of the file is made in 89Publishing a file means that a copy of the file is made in the local
78the local (!) database of the node. Indexing a file means that an 90(!) database of the node.
79index is added to the local (!) database with symbolic links to the 91Indexing a file means that an index is added to the local (!)
80file itself. The links will use the SHA-512 hash of the entire file 92database with symbolic links to the file itself.
81as the filename. Indexing is generally significantly more efficient 93The links will use the SHA-512 hash of the entire file as the
82and the default choice. However, indexing only works if the indexed 94filename.
83file can be read (using the same absolute path) by gnunet-service-fs. 95Indexing is generally significantly more efficient and the default
96choice.
97However, indexing only works if the indexed file can be read (using
98the same absolute path) by gnunet-service-fs.
84If this is not the case, indexing will fail (and gnunet\-publish will 99If this is not the case, indexing will fail (and gnunet\-publish will
85automatically revert to publishing instead). Regardless of which 100automatically revert to publishing instead).
86method is used to publish the file, the file will be slowly (depending 101Regardless of which method is used to publish the file, the file will
87on how often it is requested and on how much bandwidth is available) 102be slowly (depending on how often it is requested and on how much
88dispersed into the network. If you publish or index a file and then 103bandwidth is available) dispersed into the network.
89leave the network, it will almost always NOT be available anymore. 104If you publish or index a file and then leave the network, it will
90 105almost always NOT be available anymore.
91\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR Use alternate config 106.PP
92file (if this option is not specified, the default is 107\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
93~/.config/gnunet.conf). 108Use alternate config file (if this option is not specified, the
94 109default is ~/.config/gnunet.conf).
95.TP 110.TP
96\fB\-D\fR, \fB\-\-disable\-extractor\fR Disable use of GNU 111\fB\-D\fR, \fB\-\-disable\-extractor\fR
97libextractor for finding additional keywords and metadata. 112Disable use of GNU libextractor for finding additional keywords and
98 113metadata.
99.TP 114.TP
100\fB\-d\fR, \fB\-\-disable\-creation\-time\fR Disable use of creation 115\fB\-d\fR, \fB\-\-disable\-creation\-time\fR
101time timestamp in metadata. Useful to make created directories 116Disable use of creation time timestamp in metadata.
102deterministic and to avoid leaking information about the time at which 117Useful to make created directories deterministic and to avoid leaking
103a file was made available. 118information about the time at which a file was made available.
104
105.TP 119.TP
106\fB\-e\fR, \fB\-\-extract\fR Print the list of keywords that will be 120\fB\-e\fR, \fB\-\-extract\fR
107used for each file given the current options. Do not perform any 121Print the list of keywords that will be used for each file given the
108indexing or publishing. 122current options.
109 123Do not perform any indexing or publishing.
110.TP 124.TP
111\fB\-h\fR, \fB\-\-help\fR Print a brief help page with all the 125\fB\-h\fR, \fB\-\-help\fR
112options. 126Print a brief help page with all the options.
113
114.TP 127.TP
115\fB\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR additional key to index 128\fB\-k \fIKEYWORD\fR, \fB\-\-key=KEYWORD\fR
116the content with (to add multiple keys, specify multiple times). Each 129Additional key to index the content with (to add multiple keys,
117additional key is case\-sensitive. Can be specified multiple times. 130specify multiple times).
131Each additional key is case\-sensitive.
132Can be specified multiple times.
118The keyword is only applied to the top\-level file or directory. 133The keyword is only applied to the top\-level file or directory.
119
120.TP 134.TP
121\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR Change the 135\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
122loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and 136Change the loglevel.
123DEBUG. 137Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
124
125.TP 138.TP
126\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR For the main 139\fB\-m \fITYPE:VALUE\fR, \fB\-\-meta=\fITYPE:VALUE\fR
127file (or directory), set the metadata of the given TYPE to the given 140For the main file (or directory), set the metadata of the given TYPE
128VALUE. Note that this will not add the respective VALUE to the set of 141to the given VALUE.
142Note that this will not add the respective VALUE to the set of
129keywords under which the file can be found. 143keywords under which the file can be found.
130
131.TP 144.TP
132\fB\-n\fR, \fB\-\-noindex\fR Executive summary: You probably don't 145\fB\-n\fR, \fB\-\-noindex\fR
133need it. 146Executive summary: You probably don't need it.
134 147Do not index, full publishing.
135Do not index, full publishing. Note that directories, information for 148Note that directories, information for keyword search, namespace
136keyword search, namespace search and indexing data are always 149search and indexing data are always published (even without this
137published (even without this option). With this option, every block 150option).
138of the actual files is stored in encrypted form in the block database 151With this option, every block of the actual files is stored in
139of the local peer. While this adds security if the local node is 152encrypted form in the block database of the local peer.
140compromised (the adversary snags your machine), it is significantly 153While this adds security if the local node is compromised (the
141less efficient compared to on\-demand encryption and is definitely not 154adversary snags your machine), it is significantly less efficient
142recommended for large files. 155compared to on\-demand encryption and is definitely not recommended
143 156for large files.
144.TP 157.TP
145\fB\-N \fIID\fR, \fB\-\-next=\fIID\fR Specifies the next identifier of 158\fB\-N \fIID\fR, \fB\-\-next=\fIID\fR
146a future version of the file to be published under the same pseudonym. 159Specifies the next identifier of a future version of the file to be
147This option is only valid together with the \-P option. This option 160published under the same pseudonym.
148can be used to specify what the identifier of an updated version will 161This option is only valid together with the \-P option.
149look like. Note that specifying \-i and \-N without \-t is not 162This option can be used to specify what the identifier of an updated
150allowed. 163version will look like.
151 164Note that specifying \-i and \-N without \-t is not allowed.
152.TP 165.TP
153\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR Executive summary: 166\fB\-p \fIPRIORITY\fR, \fB\-\-prio=\fIPRIORITY\fR
154You probably don't need it. 167Executive summary: You probably don't need it.
155 168Set the priority of the published content (default: 365).
156Set the priority of the published content (default: 365). If the 169If the local database is full, GNUnet will discard the content with
157local database is full, GNUnet will discard the content with the 170the lowest ranking.
158lowest ranking. Note that ranks change over time depending on 171Note that ranks change over time depending on popularity.
159popularity. The default should be high enough to preserve the locally 172The default should be high enough to preserve the locally published
160published content in favor of content that migrates from other peers. 173content in favor of content that migrates from other peers.
161
162.TP 174.TP
163\fB\-P \fINAME\fR, \fB\-\-pseudonym=\fINAME\fR For the top\-level 175\fB\-P \fINAME\fR, \fB\-\-pseudonym=\fINAME\fR
164directory or file, places the file into the namespace identified by 176For the top\-level directory or file, places the file into the
165the pseudonym NAME. NAME must be a valid pseudonym managed by 177namespace identified by the pseudonym NAME.
166gnunet\-identity. 178NAME must be a valid pseudonym managed by gnunet\-identity.
167
168.TP 179.TP
169\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR Set the desired 180\fB\-r \fILEVEL\fR, \fB\-\-replication=\fILEVEL\fR
170replication level. If CONTENT_PUSHING is set to YES, GNUnet will push 181Set the desired replication level.
171each block (for the file) LEVEL times to other peers before doing 182If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the
172normal "random" replication of all content. This option can be used 183file) LEVEL times to other peers before doing normal "random"
173to push some content out into the network harder. Note that pushing 184replication of all content.
174content LEVEL times into the network does not guarantee that there 185This option can be used to push some content out into the network
175will actually be LEVEL replicas. 186harder.
176 187Note that pushing content LEVEL times into the network does not
188guarantee that there will actually be LEVEL replicas.
177.TP 189.TP
178\fB\-s\fR, \fB\-\-simulate-only\fR When this option is used, 190\fB\-s\fR, \fB\-\-simulate-only\fR
179gnunet\-publish will not actually publish the file but just simulate 191When this option is used, gnunet\-publish will not actually publish
180what would be done. This can be used to compute the GNUnet URI for a 192the file but just simulate what would be done.
181file without actually sharing it. 193This can be used to compute the GNUnet URI for a file without actually
182 194sharing it.
183.TP 195.TP
184\fB\-t \fIID\fR, \fB\-\-this=\fIID\fR Specifies the identifier under 196\fB\-t \fIID\fR, \fB\-\-this=\fIID\fR
185which the file is to be published under a pseudonym. This option is 197Specifies the identifier under which the file is to be published under
186only valid together with the\ \-P option. 198a pseudonym.
187 199This option is only valid together with the\ \-P option.
188.TP 200.TP
189\fB\-u \fIURI\fR, \fB\-\-uri=\fIURI\fR This option can be used to 201\fB\-u \fIURI\fR, \fB\-\-uri=\fIURI\fR
190specify the URI of a file instead of a filename (this is the only case 202This option can be used to specify the URI of a file instead of a
191where the otherwise mandatory filename argument must be omitted). 203filename (this is the only case where the otherwise mandatory filename
204argument must be omitted).
192Instead of publishing a file or directory and using the corresponding 205Instead of publishing a file or directory and using the corresponding
193URI, gnunet\-publish will use this URI and perform the selected 206URI, gnunet\-publish will use this URI and perform the selected
194namespace or keyword operations. This can be used to add additional 207namespace or keyword operations.
195keywords to a file that has already been shared or to add files to a 208This can be used to add additional keywords to a file that has already
196namespace for which the URI is known but the content is not locally 209been shared or to add files to a namespace for which the URI is known
197available. 210but the content is not locally available.
198
199.TP 211.TP
200\fB\-v\fR, \fB\-\-version\fR Print the version number. 212\fB\-v\fR, \fB\-\-version\fR
201 213Print the version number.
202.TP 214.TP
203\fB\-V\fR, \fB\-\-verbose\fR Be verbose. Using this option causes 215\fB\-V\fR, \fB\-\-verbose\fR
204gnunet\-publish to print progress information and at the end the file 216Be verbose.
205identification that can be used to download the file from GNUnet. 217Using this option causes gnunet\-publish to print progress information
206 218and at the end the file identification that can be used to download
207 219the file from GNUnet.
208.SH SETTING ANONYMITY LEVEL 220.SH SETTING ANONYMITY LEVEL
209
210The \fB\-a\fR option can be used to specify additional anonymity 221The \fB\-a\fR option can be used to specify additional anonymity
211constraints. If set to 0, GNUnet will publish the file non-anonymously 222constraints.
212and in fact sign the advertisement for the file using your peer's 223If set to 0, GNUnet will publish the file non-anonymously and in fact
213private key. This will allow other users to download the file as fast 224sign the advertisement for the file using your peer's private key.
214as possible, including using non-anonymous methods (DHT, direct 225This will allow other users to download the file as fast as possible,
215transfer). If you set it to 1 (default), you use the standard 226including using non-anonymous methods (DHT, direct transfer).
216anonymous routing algorithm (which does not explicitly leak your 227If you set it to 1 (default), you use the standard anonymous routing
217identity). However, a powerful adversary may still be able to perform 228algorithm (which does not explicitly leak your identity).
218traffic analysis (statistics) to over time infer data about your 229However, a powerful adversary may still be able to perform traffic
219identity. You can gain better privacy by specifying a higher level of 230analysis (statistics) to over time infer data about your identity.
220anonymity, which increases the amount of cover traffic your own 231You can gain better privacy by specifying a higher level of anonymity,
221traffic will get, at the expense of performance. Note that regardless 232which increases the amount of cover traffic your own traffic will get,
222of the anonymity level you choose, peers that cache content in the 233at the expense of performance.
223network always use anonymity level 1. 234Note that regardless of the anonymity level you choose, peers that
224 235cache content in the network always use anonymity level 1.
225The definition of the ANONYMITY LEVEL is the following. 0 means no 236.PP
226anonymity is required. Otherwise a value of 'v' means that 1 out of v 237The definition of the ANONYMITY LEVEL is the following.
227bytes of "anonymous" traffic can be from the local user, leaving 'v-1' 2380 means no anonymity is required.
228bytes of cover traffic per byte on the wire. Thus, if GNUnet routes n 239Otherwise a value of 'v' means that 1 out of v bytes of "anonymous"
229bytes of messages from foreign peers (using anonymous routing), it may 240traffic can be from the local user, leaving 'v-1' bytes of cover
230originate n/(v-1) bytes of data in the same time\-period. The 241traffic per byte on the wire.
231time\-period is twice the average delay that GNUnet defers forwarded 242Thus, if GNUnet routes n bytes of messages from foreign peers (using
232queries. 243anonymous routing), it may originate n/(v-1) bytes of data in the same
233 244time\-period.
234The default is 1 and this should be fine for most users. Also notice 245The time\-period is twice the average delay that GNUnet defers
235that if you choose very large values, you may end up having no 246forwarded queries.
236throughput at all, especially if many of your fellow GNUnet\-peers all 247.PP
237do the same. 248The default is 1 and this should be fine for most users.
238 249Also notice that if you choose very large values, you may end up
239 250having no throughput at all, especially if many of your fellow
251GNUnet\-peers all do the same.
240.SH EXAMPLES 252.SH EXAMPLES
241.PP 253.PP
242
243\fBBasic examples\fR 254\fBBasic examples\fR
244 255.TP
245Index a file COPYING: 256gnunet\-publish COPYING
246 257Index a file COPYING
247 # gnunet\-publish COPYING 258.TP
248 259gnunet\-publish \-n COPYING
249Publish a file COPYING: 260Publish a file COPYING
250 261.TP
251 # gnunet\-publish \-n COPYING 262gnunet\-publish \-k gpl \-k test COPYING
252 263Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR
253Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR: 264.TP
254 265gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m "mimetype:text/plain" COPYING
255 # gnunet\-publish \-k gpl \-k test COPYING
256
257Index a file COPYING with description "GNU License", mime-type 266Index a file COPYING with description "GNU License", mime-type
258"text/plain" and keywords \fBgpl\fR and \fBtest\fR: 267"text/plain" and keywords \fBgpl\fR and \fBtest\fR
259 268.PP
260 # gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m
261 "mimetype:text/plain" COPYING
262
263\fBUsing directories\fR 269\fBUsing directories\fR
264 270.TP
271mkdir gnu ; mv COPYING AUTHORS gnu/ ; gnunet\-publish \-k test \-k gnu \-D gnu/
265Index the files COPYING and AUTHORS with keyword \fBtest\fR and build 272Index the files COPYING and AUTHORS with keyword \fBtest\fR and build
266a directory containing the two files. Make the directory itself 273a directory containing the two files. Make the directory itself
267available under keyword \fBgnu\fR and disable keyword extraction using 274available under keyword \fBgnu\fR and disable keyword extraction using
268libextractor: 275libextractor
269 276.TP
270 # mkdir gnu mv COPYING AUTHORS gnu/ gnunet\-publish \-k test \-k gnu 277gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens kittendir/
271 # \-D gnu/
272
273Neatly publish an image gallery in \fBkittendir/\fR and its subdirs 278Neatly publish an image gallery in \fBkittendir/\fR and its subdirs
274with keyword \fBkittens\fR for the directory but no keywords for the 279with keyword \fBkittens\fR for the directory but no keywords for the
275individual files or subdirs (\-n). Force description for all files: 280individual files or subdirs (\-n).
276 281Force description for all files.
277 # gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens 282.PP
278 kittendir/
279
280\fBSecure publishing with namespaces\fR 283\fBSecure publishing with namespaces\fR
281 284.TP
285gnunet\-publish \-P RIAA-2 \-t gpl COPYING
282Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier 286Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier
283\fBgpl\fR (\-t) and no updates: 287\fBgpl\fR (\-t) and no updates
284 288.TP
285 # gnunet\-publish \-P RIAA-2 \-t gpl COPYING 289gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg
286
287Recursively index /home/ogg and build a matching directory 290Recursively index /home/ogg and build a matching directory
288structure. Publish the top\-level directory into the namespace under 291structure. Publish the top\-level directory into the namespace under
289the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise 292the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise
290to provide an update with identifier 'VIDEOS' (\-N): 293to provide an update with identifier 'VIDEOS' (\-N):
291 294.TP
292 # gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg 295gnunet\-publish \-nV /var/lib/mysql
293
294Recursively publish (\-n) /var/lib/mysql and build a matching 296Recursively publish (\-n) /var/lib/mysql and build a matching
295directory structure, but disable the use of libextractor to extract 297directory structure, but disable the use of libextractor to extract
296keywords (\-n). Print the file identifiers (\-V) that can be used to 298keywords (\-n).
297retrieve the files. This will store a copy of the MySQL database in 299Print the file identifiers (\-V) that can be used to retrieve the
298GNUnet but without adding any keywords to search for it. Thus only 300files.
299people that have been told the secret file identifiers printed with 301This will store a copy of the MySQL database in GNUnet but without
300the \-V option can retrieve the (secret?) files: 302adding any keywords to search for it.
301 303Thus only people that have been told the secret file identifiers
302 # gnunet\-publish \-nV /var/lib/mysql 304printed with the \-V option can retrieve the (secret?) files:
303 305.TP
306gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3
304Create a namespace entry 'root' in namespace MPAA-1 and announce that 307Create a namespace entry 'root' in namespace MPAA-1 and announce that
305the next update will be called 'next': 308the next update will be called 'next':
306 309.TP
307 # gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3 310gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3
308
309Update the previous entry, do not allow any future updates: 311Update the previous entry, do not allow any future updates:
310
311 # gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3
312
313
314.SH FILES 312.SH FILES
315.TP 313.TP
316~/.config/gnunet.conf 314~/.config/gnunet.conf
317GNUnet configuration file 315GNUnet configuration file
318.SH "REPORTING BUGS" 316.SH BUGS
319Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 317Report bugs to <https://gnunet.org/bugs/> or by sending electronic
320.SH "SEE ALSO" 318mail to <gnunet\-developers@gnu.org>
321\fBgnunet\-auto\-share\fP(1), \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), \fBextract\fP(1), \fBgnunet\-identity\fP(1) 319.SH SEE ALSO
320\fBgnunet\-auto\-share\fP(1)
321\fBgnunet\-fs\-gtk\fP(1)
322\fBgnunet\-search\fP(1)
323\fBgnunet\-download\fP(1)
324\fBgnunet.conf\fP(5)
325\fBextract\fP(1)
326\fBgnunet\-identity\fP(1)
327.PP
328The full documentation for
329.B gnunet
330is maintained as a Texinfo manual.
331If the
332.B info
333and
334.B gnunet
335programs are properly installed at your site, the command
336.IP
337.B info gnunet
338.PP
339should give you access to the complete handbook,
340.IP
341.B info gnunet-c-tutorial
342.PP
343will give you access to a tutorial for developers.
344.PP
345Depending on your installation, this information is also
346available in
347\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-qr.1 b/doc/man/gnunet-qr.1
index f1baf85ac..b80f18bb3 100644
--- a/doc/man/gnunet-qr.1
+++ b/doc/man/gnunet-qr.1
@@ -1,17 +1,13 @@
1.TH GNUNET\-QR 1 "Sep 13, 2014" "GNUnet" 1.TH GNUNET\-QR 1 "September 13, 2014" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-qr \- Scan a QR code using a video device and import. 3gnunet\-qr \- Scan a QR code using a video device and import.
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-qr 5.B gnunet\-qr
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-qr\fP is a command line tool to scan a QR code using a 9\fBgnunet\-qr\fP is a command line tool to scan a QR code using a
13video device and import. 10video device and import.
14
15.SH OPTIONS 11.SH OPTIONS
16.B 12.B
17.IP "\-c FILENAME, \-\-config=FILENAME" 13.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -28,6 +24,26 @@ Do not show preview windows.
28.B 24.B
29.IP "\-v, \-\-verbose" 25.IP "\-v, \-\-verbose"
30Be verbose. 26Be verbose.
31
32.SH BUGS 27.SH BUGS
33Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 28Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
29electronic mail to <gnunet\-developers@gnu.org>
30.SH SEE ALSO
31The full documentation for
32.B gnunet
33is maintained as a Texinfo manual. If the
34.B info
35and
36.B gnunet
37programs are properly installed at your site, the command
38.IP
39.B info gnunet
40.PP
41should give you access to the complete handbook,
42.IP
43.B info gnunet-c-tutorial
44.PP
45will give you access to a tutorial for developers.
46.PP
47Depending on your installation, this information is also
48available in
49\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1
index 7e16932ac..56eef560d 100644
--- a/doc/man/gnunet-resolver.1
+++ b/doc/man/gnunet-resolver.1
@@ -1,16 +1,11 @@
1.TH GNUNET\-RESOLVER 1 "Jan 4, 2012" "GNUnet" 1.TH GNUNET-RESOLVER 1 "January 4, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-resolver \- build-in GNUnet stub resolver 3gnunet\-resolver \- build-in GNUnet stub resolver
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-resolver 5.B gnunet\-resolver
8.RI [ options ] [ hostname ] 6.RI [ options ] [ hostname ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-resolver\fP uses build-in GNUnet stub resolver. 8\fBgnunet\-resolver\fP uses build-in GNUnet stub resolver.
13
14.SH OPTIONS 9.SH OPTIONS
15.B 10.B
16.IP "\-c FILENAME, \-\-config=FILENAME" 11.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -31,6 +26,27 @@ Perform a reverse lookup.
31.B 26.B
32.IP "\-v, \-\-version" 27.IP "\-v, \-\-version"
33Print GNUnet version number. 28Print GNUnet version number.
34
35.SH BUGS 29.SH BUGS
36Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 30Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
31electronic mail to <gnunet\-developers@gnu.org>
32.SH SEE ALSO
33The full documentation for
34.B gnunet
35is maintained as a Texinfo manual.
36If the
37.B info
38and
39.B gnunet
40programs are properly installed at your site, the command
41.IP
42.B info gnunet
43.PP
44should give you access to the complete handbook,
45.IP
46.B info gnunet-c-tutorial
47.PP
48will give you access to a tutorial for developers.
49.PP
50Depending on your installation, this information is also
51available in
52\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1
index b963b2dc0..1afda399c 100644
--- a/doc/man/gnunet-revocation.1
+++ b/doc/man/gnunet-revocation.1
@@ -1,4 +1,4 @@
1.TH GNUNET\-REVOCATION 1 "Mar 15, 2012" "GNUnet" 1.TH GNUNET\-REVOCATION 1 "March 15, 2012" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-revocation \- revoke private keys (of egos) in GNUnet 4gnunet\-revocation \- revoke private keys (of egos) in GNUnet
@@ -68,4 +68,23 @@ Print GNUnet version number.
68 68
69.SH BUGS 69.SH BUGS
70Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 70Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
71 71.SH "SEE ALSO"
72The full documentation for
73.B gnunet
74is maintained as a Texinfo manual. If the
75.B info
76and
77.B gnunet
78programs are properly installed at your site, the command
79.IP
80.B info gnunet
81.PP
82should give you access to the complete handbook,
83.IP
84.B info gnunet-c-tutorial
85.PP
86will give you access to a tutorial for developers.
87.PP
88Depending on your installation, this information is also
89available in
90\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1
index 0159e1eb9..4ccb2a740 100644
--- a/doc/man/gnunet-scalarproduct.1
+++ b/doc/man/gnunet-scalarproduct.1
@@ -1,17 +1,13 @@
1.TH GNUNET\-VECTORPRODUCT 1 "8 Aug 2013" "GNUnet" 1.TH GNUNET-VECTORPRODUCT 1 "August 8, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-vectorproduct \- compute a vectorproduct 3gnunet\-vectorproduct \- compute a vectorproduct
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-vectorproduct 5.B gnunet\-vectorproduct
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct 8\fBgnunet-vectorproduct\fP enables you to compute a vectorproduct
13across two peers \fBAlice\fP and \fBBob\fP. 9across two peers \fBAlice\fP and \fBBob\fP.
14 10.PP
15A client can issue one of two messages to its service: 11A client can issue one of two messages to its service:
16.TS 12.TS
17tab (@); 13tab (@);
@@ -23,17 +19,16 @@ T}
23Elements to support a peer in computing a vectorproduct (\fBBob\fP) 19Elements to support a peer in computing a vectorproduct (\fBBob\fP)
24T} 20T}
25.TE 21.TE
26
27Both requests must share the same SID, which can be an arbitrary 22Both requests must share the same SID, which can be an arbitrary
28string identifying the session. SIDs should be unique, however it is 23string identifying the session. SIDs should be unique, however it is
29sufficient to guarantee the uniqueness of the tupel element count and 24sufficient to guarantee the uniqueness of the tupel element count and
30session ID. 25session ID.
31 26.PP
32\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s 27\fBAlice\fP\'s client must supply the ASCII encoded peer ID of bob\'s
33service, it will internally be checked by the client for 28service, it will internally be checked by the client for
34validity. Invalid values here result in the client or the service 29validity. Invalid values here result in the client or the service
35failing the session. 30failing the session.
36 31.PP
37Elements are handed over as signed decimal integers, the element count 32Elements are handed over as signed decimal integers, the element count
38supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also 33supplied by \fBAlice\fP and \fBBob\fP must match. \fBAlice\fP can also
39supply a mask for these values to her service, which allows partial 34supply a mask for these values to her service, which allows partial
@@ -42,11 +37,10 @@ masked by setting their the corresponding mask element to zero, any
42other value means the element will not be masked. \fBAlice\fP\'s 37other value means the element will not be masked. \fBAlice\fP\'s
43client will also mask all 0-values to avoid information leakage to 38client will also mask all 0-values to avoid information leakage to
44\fBBob\fP. 39\fBBob\fP.
45 40.PP
46The protocol by definition relies on \fBAlice\fP and \fBBob\fP being 41The protocol by definition relies on \fBAlice\fP and \fBBob\fP being
47benign, thus \fBBob\fP can arbitrarily falsify his information. Both 42benign, thus \fBBob\fP can arbitrarily falsify his information. Both
48peers collaborate to achieve a correct result. 43peers collaborate to achieve a correct result.
49
50.SH OPTIONS 44.SH OPTIONS
51.B 45.B
52.IP "\-e ELEMENTS, \-\-elements=ELEMENTS" 46.IP "\-e ELEMENTS, \-\-elements=ELEMENTS"
@@ -78,10 +72,29 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
78.B 72.B
79.IP "\-v, \-\-version" 73.IP "\-v, \-\-version"
80Print GNUnet version number. 74Print GNUnet version number.
81
82
83.SH BUGS 75.SH BUGS
84Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 76Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
85 77electronic mail to <gnunet\-developers@gnu.org>
86.SH SEE ALSO 78.SH SEE ALSO
87gnunet\-peerinfo(1) 79gnunet\-peerinfo(1)
80.PP
81The full documentation for
82.B gnunet
83is maintained as a Texinfo manual.
84If the
85.B info
86and
87.B gnunet
88programs are properly installed at your site, the command
89.IP
90.B info gnunet
91.PP
92should give you access to the complete handbook,
93.IP
94.B info gnunet-c-tutorial
95.PP
96will give you access to a tutorial for developers.
97.PP
98Depending on your installation, this information is also
99available in
100\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1
index 147b18fbe..d156e17e8 100644
--- a/doc/man/gnunet-scrypt.1
+++ b/doc/man/gnunet-scrypt.1
@@ -1,17 +1,12 @@
1.TH GNUNET\-SCRYPT 1 "Sep 13, 2014" "GNUnet" 1.TH GNUNET-SCRYPT 1 "September 13, 2014" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-scrypt \- Manipulate GNUnet proof of work files. 3gnunet\-scrypt \- Manipulate GNUnet proof of work files.
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-scrypt 5.B gnunet\-scrypt
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof 8\fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof
13of work files. 9of work files.
14
15.SH OPTIONS 10.SH OPTIONS
16.B 11.B
17.IP "\-b BITS, \-\-bits=BITS" 12.IP "\-b BITS, \-\-bits=BITS"
@@ -40,6 +35,27 @@ Time to wait between calculations.
40.B 35.B
41.IP "\-v, \-\-version" 36.IP "\-v, \-\-version"
42Print GNUnet version number. 37Print GNUnet version number.
43
44.SH BUGS 38.SH BUGS
45Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 39Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
40electronic mail to <gnunet\-developers@gnu.org>
41.SH SEE ALSO
42The full documentation for
43.B gnunet
44is maintained as a Texinfo manual.
45If the
46.B info
47and
48.B gnunet
49programs are properly installed at your site, the command
50.IP
51.B info gnunet
52.PP
53should give you access to the complete handbook,
54.IP
55.B info gnunet-c-tutorial
56.PP
57will give you access to a tutorial for developers.
58.PP
59Depending on your installation, this information is also
60available in
61\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index 1e0973b63..79991e375 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -1,4 +1,4 @@
1.TH GNUNET-SEARCH "1" "25 Feb 2012" "0.9.6" "GNUnet" 1.TH GNUNET-SEARCH "1" "February 25, 2012" "0.9.6" "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
@@ -117,11 +117,11 @@ Searches for content matching both mandatory keywords "Das" and "Kapital".
117Search results are printed by gnunet\-search like this: 117Search results are printed by gnunet\-search like this:
118.P 118.P
119.ad l 119.ad l
120 gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE 120 gnunet\-download \-o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
121 121
122 Description: The GNU General Public License 122 Description: The GNU General Public License
123 123
124 Mime-type: text/plain 124 Mime-type: text/plain
125.ad b 125.ad b
126 126
127The first line contains the command to run to download the file. The 127The first line contains the command to run to download the file. The
@@ -140,3 +140,22 @@ GNUnet configuration file; specifies the default value for the timeout
140Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 140Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
141.SH "SEE ALSO" 141.SH "SEE ALSO"
142\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5), 142\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5),
143The full documentation for
144.B gnunet
145is maintained as a Texinfo manual. If the
146.B info
147and
148.B gnunet
149programs are properly installed at your site, the command
150.IP
151.B info gnunet
152.PP
153should give you access to the complete handbook,
154.IP
155.B info gnunet-c-tutorial
156.PP
157will give you access to a tutorial for developers.
158.PP
159Depending on your installation, this information is also
160available in
161\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
index 2aa889382..e61a8493c 100644
--- a/doc/man/gnunet-statistics.1
+++ b/doc/man/gnunet-statistics.1
@@ -1,21 +1,16 @@
1.TH GNUNET\-STATISTICS 1 "Jan 4, 2012" "GNUnet" 1.TH GNUNET-STATISTICS 1 "January 4, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-statistics \- Display statistics about your GNUnet system 3gnunet\-statistics \- Display statistics about your GNUnet system
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-statistics 5.B gnunet\-statistics
8.RI [ options ] 6.RI [ options ]
9.RI [ VALUE ] 7.RI [ VALUE ]
10.br
11
12.SH DESCRIPTION 8.SH DESCRIPTION
13\fBgnunet\-statistics\fP is used to display detailed information about 9\fBgnunet\-statistics\fP is used to display detailed information about
14various aspect of GNUnet's operation. This tool only works if the 10various aspect of GNUnet's operation. This tool only works if the
15"statistics" service is available. 11"statistics" service is available.
16gnunet\-statistics can be used to set a value by giving the options 12gnunet\-statistics can be used to set a value by giving the options
17\-n, \-s and also a VALUE. 13\-n, \-s and also a VALUE.
18
19.SH OPTIONS 14.SH OPTIONS
20.B 15.B
21.IP "\-c FILENAME, \-\-config=FILENAME" 16.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -50,10 +45,29 @@ folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /t
50.B 45.B
51.IP "\-v, \-\-version" 46.IP "\-v, \-\-version"
52Print GNUnet version number. 47Print GNUnet version number.
53
54
55.SH BUGS 48.SH BUGS
56Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> 49Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending
57 50electronic mail to <gnunet\-developers@gnu.org>
58.SH SEE ALSO 51.SH SEE ALSO
59gnunet\-service\-statistics(1) 52gnunet\-service\-statistics(1)
53.PP
54The full documentation for
55.B gnunet
56is maintained as a Texinfo manual.
57If the
58.B info
59and
60.B gnunet
61programs are properly installed at your site, the command
62.IP
63.B info gnunet
64.PP
65should give you access to the complete handbook,
66.IP
67.B info gnunet-c-tutorial
68.PP
69will give you access to a tutorial for developers.
70.PP
71Depending on your installation, this information is also
72available in
73\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1
index bc7092e68..cac6e9af7 100644
--- a/doc/man/gnunet-testbed-profiler.1
+++ b/doc/man/gnunet-testbed-profiler.1
@@ -1,16 +1,12 @@
1.TH GNUNET\-TESTBED\-PROFILER 1 "Sep 13, 2014" "GNUnet" 1.TH GNUNET\-TESTBED\-PROFILER 1 "September 13, 2014" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-testbed\-profiler \- Profiling driver for the testbed. 3gnunet\-testbed\-profiler \- Profiling driver for the testbed.
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-testbed\-profiler 5.B gnunet\-testbed\-profiler
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-testbed\-profiler\fP is a command line profiling driver for the testbed. 9\fBgnunet\-testbed\-profiler\fP is a command line profiling driver for the testbed.
13
14.SH OPTIONS 10.SH OPTIONS
15.B 11.B
16.IP "\-c FILENAME, \-\-config=FILENAME" 12.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -41,6 +37,25 @@ Create COUNT number of peers.
41.B 37.B
42.IP "\-v, \-\-version" 38.IP "\-v, \-\-version"
43Print GNUnet version number. 39Print GNUnet version number.
44
45.SH BUGS 40.SH BUGS
46Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 41Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
42.SH "SEE ALSO"
43The full documentation for
44.B gnunet
45is maintained as a Texinfo manual. If the
46.B info
47and
48.B gnunet
49programs are properly installed at your site, the command
50.IP
51.B info gnunet
52.PP
53should give you access to the complete handbook,
54.IP
55.B info gnunet-c-tutorial
56.PP
57will give you access to a tutorial for developers.
58.PP
59Depending on your installation, this information is also
60available in
61\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1
index a6a29d953..60c40bf7f 100644
--- a/doc/man/gnunet-testing-run-service.1
+++ b/doc/man/gnunet-testing-run-service.1
@@ -1,26 +1,21 @@
1.TH GNUNET\-TESTING\-RUN\-SERVICE 1 "Aug 25, 2013" "GNUnet" 1.TH GNUNET-TESTING-RUN-SERVICE 1 "August 25, 2013" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-testing\-run\-service \- Command line tool to start a service for testing. 3gnunet\-testing\-run\-service \- Command line tool to start a service for testing.
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-testing\-run\-service 5.B gnunet\-testing\-run\-service
8.RI [ options ] 6.RI [ options ]
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-testing\-run\-service\fP is a command line tool to start a 8\fBgnunet\-testing\-run\-service\fP is a command line tool to start a
13service for testing. It starts a peer, running only the service 9service for testing. It starts a peer, running only the service
14specified on the command line, outputs the path to the temporary 10specified on the command line, outputs the path to the temporary
15configuration file to stdout. 11configuration file to stdout.
16 12.PP
17The peer will run until this program is killed, or stdin is 13The peer will run until this program is killed, or stdin is
18closed. When reading the character 'r' from stdin, the running service 14closed. When reading the character 'r' from stdin, the running service
19is restarted with the same configuration. 15is restarted with the same configuration.
20 16.PP
21This executable is intended to be used by gnunet-java, in order to 17This executable is intended to be used by gnunet-java, in order to
22reliably start and stop services for test cases. 18reliably start and stop services for test cases.
23
24.SH OPTIONS 19.SH OPTIONS
25.B 20.B
26.IP "\-c FILENAME, \-\-config=FILENAME" 21.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -31,6 +26,27 @@ Print short help on options.
31.B 26.B
32.IP "\-s SERVICE, \-\-service=SERVICE" 27.IP "\-s SERVICE, \-\-service=SERVICE"
33Name of the service to run. 28Name of the service to run.
34
35.SH BUGS 29.SH BUGS
36Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 30Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
31electronic mail to <gnunet\-developers@gnu.org>
32.SH SEE ALSO
33The full documentation for
34.B gnunet
35is maintained as a Texinfo manual.
36If the
37.B info
38and
39.B gnunet
40programs are properly installed at your site, the command
41.IP
42.B info gnunet
43.PP
44should give you access to the complete handbook,
45.IP
46.B info gnunet-c-tutorial
47.PP
48will give you access to a tutorial for developers.
49.PP
50Depending on your installation, this information is also
51available in
52\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1
index 82ea62e71..ff1af50ef 100644
--- a/doc/man/gnunet-testing.1
+++ b/doc/man/gnunet-testing.1
@@ -1,16 +1,13 @@
1.TH GNUNET\-TESTING 1 "Jan 4, 2012" "GNUnet" 1.TH GNUNET\-TESTING 1 "January 4, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-testing \- Command line tool to access the testing library. 3gnunet\-testing \- Command line tool to access the testing library.
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-testing 5.B gnunet\-testing
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-testing\fP is a command line tool to access the testing library. 9\fBgnunet\-testing\fP is a command line tool to access the testing
13 10library.
14.SH OPTIONS 11.SH OPTIONS
15.B 12.B
16.IP "\-C, \-\-cfg" 13.IP "\-C, \-\-cfg"
@@ -42,6 +39,27 @@ Configuration template.
42.B 39.B
43.IP "\-v, \-\-version" 40.IP "\-v, \-\-version"
44Print GNUnet version number. 41Print GNUnet version number.
45
46.SH BUGS 42.SH BUGS
47Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 43Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
44electronic mail to <gnunet\-developers@gnu.org>
45.SH SEE ALSO
46The full documentation for
47.B gnunet
48is maintained as a Texinfo manual.
49If the
50.B info
51and
52.B gnunet
53programs are properly installed at your site, the command
54.IP
55.B info gnunet
56.PP
57should give you access to the complete handbook,
58.IP
59.B info gnunet-c-tutorial
60.PP
61will give you access to a tutorial for developers.
62.PP
63Depending on your installation, this information is also
64available in
65\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1
index e413254f4..8adb85571 100644
--- a/doc/man/gnunet-timeout.1
+++ b/doc/man/gnunet-timeout.1
@@ -1,20 +1,36 @@
1.TH GNUNET\-TIMOUET 1 "Jun 5, 2018" "GNUnet" 1.TH GNUNET-TIMOUET 1 "June 5, 2018" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-timeout \- run process with timeout 3gnunet\-timeout \- run process with timeout
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-timeout 5.B gnunet\-timeout
8.RI TIMEOUT PROGRAM ARGS 6.RI TIMEOUT PROGRAM ARGS
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-timeout\fP can be used to run another process with a 8\fBgnunet\-timeout\fP can be used to run another process with a
13timeout. Provided as the standard "timout" utility may not be 9timeout. Provided as the standard "timout" utility may not be
14available on all platforms. 10available on all platforms.
15
16.SH BUGS 11.SH BUGS
17Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 12Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
18 13electronic mail to <gnunet\-developers@gnu.org>
19.SH SEE 14.SH SEE ALSO
20timeout(1) 15timeout(1)
16.PP
17The full documentation for
18.B gnunet
19is maintained as a Texinfo manual.
20If the
21.B info
22and
23.B gnunet
24programs are properly installed at your site, the command
25.IP
26.B info gnunet
27.PP
28should give you access to the complete handbook,
29.IP
30.B info gnunet-c-tutorial
31.PP
32will give you access to a tutorial for developers.
33.PP
34Depending on your installation, this information is also
35available in
36\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-transport-certificate-creation.1 b/doc/man/gnunet-transport-certificate-creation.1
index 89df87f4b..0e1e681f8 100644
--- a/doc/man/gnunet-transport-certificate-creation.1
+++ b/doc/man/gnunet-transport-certificate-creation.1
@@ -1,19 +1,35 @@
1.TH GNUNET\-TRANSPORT\-CERTIFICATE\-CREATION 1 "Jan 31, 2014" "GNUnet" 1.TH GNUNET\-TRANSPORT-CERTIFICATE-CREATION 1 "January 31, 2014" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport 3gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-transport\-certificate\-creation 5.B gnunet\-transport\-certificate\-creation
8.I privatekey certificate 6.I privatekey certificate
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA 8\fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA
13private key and then a self-signed certificate for HTTPS transport. 9private key and then a self-signed certificate for HTTPS transport.
14
15.SH BUGS 10.SH BUGS
16Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 11Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
17 12electronic mail to <gnunet\-developers@gnu.org>
18.SH SEE ALSO 13.SH SEE ALSO
19gnunet\-transport(1) 14gnunet\-transport(1)
15.PP
16The full documentation for
17.B gnunet
18is maintained as a Texinfo manual.
19If the
20.B info
21and
22.B gnunet
23programs are properly installed at your site, the command
24.IP
25.B info gnunet
26.PP
27should give you access to the complete handbook,
28.IP
29.B info gnunet-c-tutorial
30.PP
31will give you access to a tutorial for developers.
32.PP
33Depending on your installation, this information is also
34available in
35\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
index 3a81c54fe..2aafbb9ab 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -1,20 +1,17 @@
1.TH gnunet\-transport "1" "17 Oct 2015" "GNUnet" 1.TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-transport \- measure and control the transport subsystem 3gnunet\-transport \- measure and control the transport subsystem
4
5.SH SYNOPSIS 4.SH SYNOPSIS
6.B gnunet\-transport 5.B gnunet\-transport
7[\fIOPTIONS\fR] 6[\fIOPTIONS\fR]
8.SH DESCRIPTION 7.SH DESCRIPTION
9.PP 8.PP
10
11gnunet\-transport is a tool to access various functions of GNUnet's 9gnunet\-transport is a tool to access various functions of GNUnet's
12transport subsystem from the command\-line. Most of these are not 10transport subsystem from the command\-line. Most of these are not
13expected to be useful for end-users. gnunet\-transport can be used to 11expected to be useful for end-users. gnunet\-transport can be used to
14evaluate the performance of the transports, force a peer to connect to 12evaluate the performance of the transports, force a peer to connect to
15another peer (if possible). Other functions should be added in the 13another peer (if possible). Other functions should be added in the
16near future. 14near future.
17
18.TP 15.TP
19\fB\-b\fR, \fB\-\-benchmark\fR 16\fB\-b\fR, \fB\-\-benchmark\fR
20measure how fast we are receiving data (from all connections). On 17measure how fast we are receiving data (from all connections). On
@@ -62,11 +59,26 @@ print the version number
62.TP 59.TP
63\fB\-V\fR, \fB\-\-verbose\fR 60\fB\-V\fR, \fB\-\-verbose\fR
64be verbose 61be verbose
65
66.SH NOTES
67
68
69.SH "REPORTING BUGS" 62.SH "REPORTING BUGS"
70Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 63Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
71.SH "SEE ALSO" 64.SH "SEE ALSO"
72\fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1) 65\fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1)
66The full documentation for
67.B gnunet
68is maintained as a Texinfo manual. If the
69.B info
70and
71.B gnunet
72programs are properly installed at your site, the command
73.IP
74.B info gnunet
75.PP
76should give you access to the complete handbook,
77.IP
78.B info gnunet-c-tutorial
79.PP
80will give you access to a tutorial for developers.
81.PP
82Depending on your installation, this information is also
83available in
84\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1
index cf095cc49..1c9d1a58c 100644
--- a/doc/man/gnunet-unindex.1
+++ b/doc/man/gnunet-unindex.1
@@ -1,4 +1,4 @@
1.TH GNUNET-UNINDEX "1" "6 Sep 2009" "GNUnet" 1.TH GNUNET-UNINDEX "1" "September 6, 2009" "GNUnet"
2.SH NAME 2.SH NAME
3gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet 3gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet
4.SH SYNOPSIS 4.SH SYNOPSIS
@@ -17,7 +17,6 @@ print help page
17\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR 17\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
18Change the loglevel. Possible values for LOGLEVEL are NOTHING, 18Change the loglevel. Possible values for LOGLEVEL are NOTHING,
19ERROR, WARNING, INFO and DEBUG. 19ERROR, WARNING, INFO and DEBUG.
20
21.TP 20.TP
22\fB\-v\fR, \fB\-\-version\fR 21\fB\-v\fR, \fB\-\-version\fR
23print the version number 22print the version number
@@ -38,3 +37,22 @@ GNUnet configuration file
38Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 37Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
39.SH "SEE ALSO" 38.SH "SEE ALSO"
40\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5) 39\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5)
40The full documentation for
41.B gnunet
42is maintained as a Texinfo manual. If the
43.B info
44and
45.B gnunet
46programs are properly installed at your site, the command
47.IP
48.B info gnunet
49.PP
50should give you access to the complete handbook,
51.IP
52.B info gnunet-c-tutorial
53.PP
54will give you access to a tutorial for developers.
55.PP
56Depending on your installation, this information is also
57available in
58\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1
index ac8ccf374..72105c4c8 100644
--- a/doc/man/gnunet-uri.1
+++ b/doc/man/gnunet-uri.1
@@ -1,20 +1,15 @@
1.TH GNUNET\-URI 1 "Jun 26, 2012" "GNUnet" 1.TH GNUNET-URI 1 "June 26, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-uri \- invoke default handler for GNUnet URIs 3gnunet\-uri \- invoke default handler for GNUnet URIs
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-uri 5.B gnunet\-uri
8.RI URI 6.RI URI
9.br
10
11.SH DESCRIPTION 7.SH DESCRIPTION
12\fBgnunet\-uri\fP can be used to invoke the correct tool to handle a 8\fBgnunet\-uri\fP can be used to invoke the correct tool to handle a
13GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" 9GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS"
14and thus the specific tool to handle the URI depends on the subsystem. 10and thus the specific tool to handle the URI depends on the subsystem.
15gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM 11gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM
16in the configuration section "uri") and invoke it. 12in the configuration section "uri") and invoke it.
17
18.SH OPTIONS 13.SH OPTIONS
19.B 14.B
20.IP "\-c FILENAME, \-\-config=FILENAME" 15.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -28,7 +23,27 @@ Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
28.B 23.B
29.IP "\-v, \-\-version" 24.IP "\-v, \-\-version"
30Print GNUnet version number. 25Print GNUnet version number.
31
32
33.SH BUGS 26.SH BUGS
34Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 27Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
28electronic mail to <gnunet\-developers@gnu.org>
29.SH SEE ALSO
30The full documentation for
31.B gnunet
32is maintained as a Texinfo manual.
33If the
34.B info
35and
36.B gnunet
37programs are properly installed at your site, the command
38.IP
39.B info gnunet
40.PP
41should give you access to the complete handbook,
42.IP
43.B info gnunet-c-tutorial
44.PP
45will give you access to a tutorial for developers.
46.PP
47Depending on your installation, this information is also
48available in
49\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
index 6b1b11f7b..838624d98 100644
--- a/doc/man/gnunet-vpn.1
+++ b/doc/man/gnunet-vpn.1
@@ -1,29 +1,27 @@
1.TH GNUNET\-VPN 1 "25 Feb 2012" "GNUnet" 1.TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-vpn \- manually setup a GNUnet VPN tunnel 3gnunet\-vpn \- manually setup a GNUnet VPN tunnel
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-vpn 5.B gnunet\-vpn
8.RI [ options ] 6.RI [ options ]
9.br 7.br
10
11.SH DESCRIPTION 8.SH DESCRIPTION
12\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the 9\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the
13GNUnet network. There are two main types of tunnels. Tunnels to an 10GNUnet network.
14exit node which routes the traffic to the global Internet, and tunnels 11There are two main types of tunnels.
15to a node that runs a service only within GNUnet. Depending on the 12Tunnels to an exit node which routes the traffic to the global
16type of tunnel, gnunet\-vpn takes different options. The "\-i" option 13Internet, and tunnels to a node that runs a service only within
17is required for tunnels to an exit node, whereas the "\-p" and "\-s" 14GNUnet.
18options in conjunction with either "\-u" or "\-t" are required for 15Depending on the type of tunnel, gnunet\-vpn takes different options.
19tunnels to services. For exit tunnels, both UDP and TCP traffic will 16The "\-i" option is required for tunnels to an exit node, whereas the
20be redirected. For service tunnels, either UDP ("\-u") or TCP ("\-t") 17"\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are
21traffic will be redirected. 18required for tunnels to services.
22 19For exit tunnels, both UDP and TCP traffic will be redirected.
23The tool will display the IP address for this end of the tunnel. The 20For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will
24address can be displayed as soon as it has been allocated, or only 21be redirected.
22The tool will display the IP address for this end of the tunnel.
23The address can be displayed as soon as it has been allocated, or only
25after ("\-a") the tunnel has been created. 24after ("\-a") the tunnel has been created.
26
27.SH OPTIONS 25.SH OPTIONS
28.B 26.B
29.IP "\-4, \-\-ipv4" 27.IP "\-4, \-\-ipv4"
@@ -36,45 +34,68 @@ Desired IP address on this end of the tunnel should be an IPv6 address.
36Use the configuration file FILENAME. 34Use the configuration file FILENAME.
37.B 35.B
38.IP "\-d TIME, \-\-duration TIME" 36.IP "\-d TIME, \-\-duration TIME"
39The mapping should be established for TIME. The value given must be a 37The mapping should be established for TIME.
40number followed by a space and a time unit, for example "500 ms". 38The value given must be a number followed by a space and a time unit,
41Note that the quotes are required on the shell. Default is 5 minutes. 39for example "500 ms".
40Note that the quotes are required on the shell.
41Default is 5 minutes.
42.B 42.B
43.IP "\-h, \-\-help" 43.IP "\-h, \-\-help"
44Print short help on options. 44Print short help on options.
45.B 45.B
46.IP "\-i IP, \-\-ip IP" 46.IP "\-i IP, \-\-ip IP"
47Tunnel should be to an exit node and connect to the given IPv4 or IPv6 47Tunnel should be to an exit node and connect to the given IPv4 or IPv6
48IP address. Note that you can specify an IPv6 address as the target 48IP address.
49here, even in combination with "\-4" (4to6) and similarly you can 49Note that you can specify an IPv6 address as the target here, even in
50specify an IPv4 address in combination with "\-6" (6to4). 50combination with "\-4" (4to6) and similarly you can specify an IPv4
51address in combination with "\-6" (6to4).
51.B 52.B
52.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 53.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
53Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 54Use LOGLEVEL for logging.
55Valid values are DEBUG, INFO, WARNING and ERROR.
54.B 56.B
55.IP "\-p PEERID, \-\-peer=PEERID" 57.IP "\-p PEERID, \-\-peer=PEERID"
56Name of the peer offering the service to connect to. Cannot be used 58Name of the peer offering the service to connect to.
57in conjunction with "\-i", requires "\-s". 59Cannot be used in conjunction with "\-i", requires "\-s".
58.B 60.B
59.IP "\-s NAME, \-\-service=NAME" 61.IP "\-s NAME, \-\-service=NAME"
60Name of the service running on the target peer. Cannot be used in 62Name of the service running on the target peer.
61conjunction with "\-i", requires "\-p". 63Cannot be used in conjunction with "\-i", requires "\-p".
62.B 64.B
63.IP "\-t, \-\-tcp" 65.IP "\-t, \-\-tcp"
64Service runs TCP. Either "\-t" or "\-u" must be specified when using "\-s". 66Service runs TCP.
67Either "\-t" or "\-u" must be specified when using "\-s".
65.B 68.B
66.IP "\-u, \-\-udp" 69.IP "\-u, \-\-udp"
67Service runs UDP. Either "\-t" or "\-u" must be specified when using "\-s". 70Service runs UDP.
71Either "\-t" or "\-u" must be specified when using "\-s".
68.B 72.B
69.IP "\-V, \-\-verbose" 73.IP "\-V, \-\-verbose"
70Be verbose. 74Be verbose.
71.B 75.B
72.IP "\-v, \-\-version" 76.IP "\-v, \-\-version"
73Print GNUnet version number. 77Print GNUnet version number.
74
75
76.SH BUGS 78.SH BUGS
77Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 79Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
78 80electronic mail to <gnunet\-developers@gnu.org>
79.SH SEE ALSO 81.SH SEE ALSO
80gnunet\-setup(1) 82gnunet\-setup(1)
83The full documentation for
84.B gnunet
85is maintained as a Texinfo manual. If the
86.B info
87and
88.B gnunet
89programs are properly installed at your site, the command
90.IP
91.B info gnunet
92.PP
93should give you access to the complete handbook,
94.IP
95.B info gnunet-c-tutorial
96.PP
97will give you access to a tutorial for developers.
98.PP
99Depending on your installation, this information is also
100available in
101\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1
index cf76b86ee..97d784136 100644
--- a/doc/man/gnunet-zoneimport.1
+++ b/doc/man/gnunet-zoneimport.1
@@ -1,12 +1,8 @@
1.TH GNUNET\-ZONEIMPORT 1 "Apr 23, 2018" "GNUnet" 1.TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-zoneimport \- import DNS zone into GNS zone 3gnunet\-zoneimport \- import DNS zone into GNS zone
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-zoneimport [IP]+ 5.B gnunet\-zoneimport [IP]+
8.br
9
10.SH DESCRIPTION 6.SH DESCRIPTION
11\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from 7\fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from
12stdin and issues DNS queries for each of the domain names given. It 8stdin and issues DNS queries for each of the domain names given. It
@@ -17,29 +13,28 @@ will look for an ego called "com.fr"). If so, it will convert the DNS
17records into GNS records (in particular converting NS records and glue 13records into GNS records (in particular converting NS records and glue
18records to GNS2DNS records) and add them to the namestore under the 14records to GNS2DNS records) and add them to the namestore under the
19label ("example" in the examples above). 15label ("example" in the examples above).
20 16.PP
21The arguments given to gnunet\-zoneimport is a list of IP addresses of 17The arguments given to gnunet\-zoneimport is a list of IP addresses of
22DNS servers to query. 18DNS servers to query.
23 19.PP
24gnunet\-zoneimport will usually never terminate: it will check when 20gnunet\-zoneimport will usually never terminate: it will check when
25DNS records expire, and re-issue requests when the old DNS records 21DNS records expire, and re-issue requests when the old DNS records
26have expired so that GNS always has the latest data. 22have expired so that GNS always has the latest data.
27 23.PP
28gnunet\-zoneimport will issue many DNS queries in parallel, but is 24gnunet\-zoneimport will issue many DNS queries in parallel, but is
29rate-limited in various ways, so most DNS servers should easily handle 25rate-limited in various ways, so most DNS servers should easily handle
30the load. gnunet\-zoneimport will perform a limited number of retries 26the load. gnunet\-zoneimport will perform a limited number of retries
31if queries fail. 27if queries fail.
32 28.PP
33gnunet\-zoneimport operates incrementally. It will check if the 29gnunet\-zoneimport operates incrementally. It will check if the
34namestore already has (non-expired) records stored for a given name in 30namestore already has (non-expired) records stored for a given name in
35the respective zone and not issue those requests again. Thus, it is 31the respective zone and not issue those requests again. Thus, it is
36fine to restart gnunet\-zoneimport whenever the list of domain names 32fine to restart gnunet\-zoneimport whenever the list of domain names
37changes. 33changes.
38 34.PP
39Finally, gnunet\-zoneimport keeps information for each domain name in 35Finally, gnunet\-zoneimport keeps information for each domain name in
40memory. This consumes about 200 bytes per domain name, or 1 GB for 5 36memory. This consumes about 200 bytes per domain name, or 1 GB for 5
41million labels. 37million labels.
42
43.SH OPTIONS 38.SH OPTIONS
44.B 39.B
45.IP "\-c FILENAME, \-\-config=FILENAME" 40.IP "\-c FILENAME, \-\-config=FILENAME"
@@ -55,7 +50,6 @@ is less than RELATIVETIME into the future. RELATIVETIME is a time
55given like "1 week" or "1 h". If DNS returns records with a shorter 50given like "1 week" or "1 h". If DNS returns records with a shorter
56lifetime, gnunet\-zoneimport will simply bump the lifetime to the 51lifetime, gnunet\-zoneimport will simply bump the lifetime to the
57specified value (relative to the time of the import). Default is zero. 52specified value (relative to the time of the import). Default is zero.
58
59.IP "\-s MAPSIZE, \-\-size=MAPSIZE" 53.IP "\-s MAPSIZE, \-\-size=MAPSIZE"
60Specifies the size (in number of entries) to use for the main hash 54Specifies the size (in number of entries) to use for the main hash
61map. The value provided should be at least twice the number of domain 55map. The value provided should be at least twice the number of domain
@@ -64,18 +58,33 @@ large zones where the number of records encountered is too large for
64the automatic growth mechanism to work (that one is limited to at most 58the automatic growth mechanism to work (that one is limited to at most
6516 MB allocations for security reasons). Do not worry about this 5916 MB allocations for security reasons). Do not worry about this
66unless you are importing millions of domain names from a zone. 60unless you are importing millions of domain names from a zone.
67
68.SH NOTES 61.SH NOTES
69 62.TP
70Typical invocaton would be: 63Typical invocaton would be:
71
72$ gnunet\-zoneimport 1.2.3.4 < names.txt 64$ gnunet\-zoneimport 1.2.3.4 < names.txt
73
74
75
76
77.SH BUGS 65.SH BUGS
78Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 66Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
79 67electronic mail to <gnunet\-developers@gnu.org>
80.SH SEE ALSO 68.SH SEE ALSO
81gnunet\-gns(1), gnunet\-namestore(1) 69gnunet\-gns(1), gnunet\-namestore(1)
70.PP
71The full documentation for
72.B gnunet
73is maintained as a Texinfo manual.
74If the
75.B info
76and
77.B gnunet
78programs are properly installed at your site, the command
79.IP
80.B info gnunet
81.PP
82should give you access to the complete handbook,
83.IP
84.B info gnunet-c-tutorial
85.PP
86will give you access to a tutorial for developers.
87.PP
88Depending on your installation, this information is also
89available in
90\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5
index 3dd8c7b62..3c88305ba 100644
--- a/doc/man/gnunet.conf.5
+++ b/doc/man/gnunet.conf.5
@@ -1,11 +1,10 @@
1.TH GNUNET.CONF "5" "05 May 2018" "GNUnet" 1.\" -*- mode: nroff -*-
2.TH GNUNET.CONF "5" "October 26, 2018" "GNUnet"
2.SH NAME 3.SH NAME
3gnunet.conf \- GNUnet configuration file 4gnunet.conf \- GNUnet configuration file
4.SH SYNOPSIS 5.SH SYNOPSIS
5~/.config/gnunet.conf 6~/.config/gnunet.conf
6.SH DESCRIPTION 7.SH DESCRIPTION
7.PP
8
9A GNUnet setup typically consists of a set of service processes run by a user 8A GNUnet setup typically consists of a set of service processes run by a user
10"gnunet" and a set of user-interface processes run by a standard account. 9"gnunet" and a set of user-interface processes run by a standard account.
11The default location for the configuration file for the services is 10The default location for the configuration file for the services is
@@ -16,8 +15,7 @@ gnunet\-setup (part of the GNUnet GTK package) can be used to edit this
16configuration. The parts of GNUnet that are run as a normal user may have 15configuration. The parts of GNUnet that are run as a normal user may have
17config options too and they read from "$HOME/.config/gnunet.conf". 16config options too and they read from "$HOME/.config/gnunet.conf".
18The latter config file can skip any options for the services. 17The latter config file can skip any options for the services.
19 18.PP
20.TP
21The basic structure of the configuration file is the following. The file is 19The basic structure of the configuration file is the following. The file is
22split into sections. Every section begins with "[SECTIONNAME]" and contains 20split into sections. Every section begins with "[SECTIONNAME]" and contains
23a number of options of the form "OPTION=VALUE". 21a number of options of the form "OPTION=VALUE".
@@ -29,9 +27,7 @@ Default values for all of the options can be found in the files in the
29"$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will 27"$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will
30work out of the box with those. See the examples section below for 28work out of the box with those. See the examples section below for
31some common setups on top of that. 29some common setups on top of that.
32
33.SH General OPTIONS 30.SH General OPTIONS
34.PP
35Many options will be common between sections. They can be repeated under 31Many options will be common between sections. They can be repeated under
36each section with different values. The "[PATHS]" section is special. 32each section with different values. The "[PATHS]" section is special.
37Here, it is possible to specify values for variables like "GNUNET_HOME". 33Here, it is possible to specify values for variables like "GNUNET_HOME".
@@ -45,11 +41,8 @@ place of the absolute definition of "/tmp".
45So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo". 41So instead of "/tmp/foo" you would write "$GNUNET_TMP/foo".
46 The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or 42 The usage of "$GNUNET_TMP/foo", will result in "$TMPDIR/gnunet/foo", or
47 "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo". 43 "$TMP/gnunet/foo" and finally, if "TMPDIR" is undefined, "/tmp/gnunet/foo".
48
49.PP 44.PP
50
51The following options are generic and shared by all services: 45The following options are generic and shared by all services:
52
53.IP HOSTNAME 46.IP HOSTNAME
54 The hostname specifies the machine on which the service is running. 47 The hostname specifies the machine on which the service is running.
55 This is usually "localhost". 48 This is usually "localhost".
@@ -92,12 +85,7 @@ The following options are generic and shared by all services:
92 Set to YES if this service should be run per-user, NO if this is a system 85 Set to YES if this service should be run per-user, NO if this is a system
93 service. End-users should never have to change the defaults GNUnet provides 86 service. End-users should never have to change the defaults GNUnet provides
94 for this option. 87 for this option.
95
96
97
98.B
99.SH ATS Options 88.SH ATS Options
100
101.IP UNSPECIFIED_QUOTA_IN 89.IP UNSPECIFIED_QUOTA_IN
102 quotes in KiB or MiB per seconds. Or use the word "unlimited" 90 quotes in KiB or MiB per seconds. Or use the word "unlimited"
103.IP UNSPECIFIED_QUOTA_OUT 91.IP UNSPECIFIED_QUOTA_OUT
@@ -118,9 +106,7 @@ The following options are generic and shared by all services:
118 quotes in KiB or MiB per seconds. Or use the word "unlimited" 106 quotes in KiB or MiB per seconds. Or use the word "unlimited"
119.IP WLAN_QUOTA_OUT 107.IP WLAN_QUOTA_OUT
120 quotes in KiB or MiB per seconds. Or use the word "unlimited" 108 quotes in KiB or MiB per seconds. Or use the word "unlimited"
121
122.SH EXAMPLES 109.SH EXAMPLES
123
124This example is a simple way to get started, using a server that has a known 110This example is a simple way to get started, using a server that has a known
125list of peers to get you started. Most users will be behind a firewall on 111list of peers to get you started. Most users will be behind a firewall on
126IPv4, as such NAT is enabled. Please rememeber to change your IP address 112IPv4, as such NAT is enabled. Please rememeber to change your IP address
@@ -139,13 +125,33 @@ to the actual external address for your usage.
139 [arm] 125 [arm]
140 START_SYSTEM_SERVICES = YES 126 START_SYSTEM_SERVICES = YES
141 START_USER_SERVICES = NO 127 START_USER_SERVICES = NO
142
143.SH FILES 128.SH FILES
144.TP 129.TP
145~/.config/gnunet.conf 130~/.config/gnunet.conf
146GNUnet configuration file 131GNUnet configuration file
147.SH "REPORTING BUGS" 132.SH BUGS
148Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic 133Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
149mail to <bug-gnunet@gnu.org> 134electronic mail to <bug-gnunet@gnu.org>
150.SH "SEE ALSO" 135.SH SEE ALSO
151\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) 136\fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1)
137.PP
138The full documentation for
139.B gnunet
140is maintained as a Texinfo manual.
141If the
142.B info
143and
144.B gnunet
145programs are properly installed at your site, the command
146.IP
147.B info gnunet
148.PP
149should give you access to the complete handbook,
150.IP
151.B info gnunet-c-tutorial
152.PP
153will give you access to a tutorial for developers.
154.PP
155Depending on your installation, this information is also
156available in
157\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).