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