diff options
author | Nils Gillmann <ng0@n0.is> | 2018-10-26 16:08:14 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-10-26 16:08:14 +0000 |
commit | 4be442739c7f6745848a2f5544a59592f06a6cb3 (patch) | |
tree | f8ef204dd70d64d4fc8349551f584fb75323abd9 /doc/man | |
parent | 19fe19822004e33b89d2f71c154c28f8eff1c936 (diff) | |
download | gnunet-4be442739c7f6745848a2f5544a59592f06a6cb3.tar.gz gnunet-4be442739c7f6745848a2f5544a59592f06a6cb3.zip |
Start fixing the man pages via linting and style.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man')
36 files changed, 596 insertions, 628 deletions
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1 index 5f933d621..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,11 +59,9 @@ 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) |
70 | The full documentation for | 67 | The full documentation for |
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1 index 89c8bd6b3..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,38 +77,34 @@ 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) | ||
124 | The full documentation for | 108 | The full documentation for |
125 | .B gnunet | 109 | .B gnunet |
126 | is maintained as a Texinfo manual. If the | 110 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1 index 4a9fe08f6..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,11 +28,10 @@ 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> | |
39 | .SH "SEE ALSO" | 34 | .SH SEE ALSO |
40 | The full documentation for | 35 | The full documentation for |
41 | .B gnunet | 36 | .B gnunet |
42 | is maintained as a Texinfo manual. If the | 37 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1 index 9414c14eb..3551a335d 100644 --- a/doc/man/gnunet-cadet.1 +++ b/doc/man/gnunet-cadet.1 | |||
@@ -64,9 +64,9 @@ 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 | 68 | electronic mail to <gnunet\-developers@gnu.org> | |
69 | .SH "SEE ALSO" | 69 | .SH SEE ALSO |
70 | The full documentation for | 70 | The full documentation for |
71 | .B gnunet | 71 | .B gnunet |
72 | is maintained as a Texinfo manual. If the | 72 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 index d0fc50ecd..43e7a011b 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 | |||
@@ -49,9 +49,9 @@ 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 | 53 | electronic mail to <gnunet\-developers@gnu.org> | |
54 | .SH "SEE ALSO" | 54 | .SH SEE ALSO |
55 | The full documentation for | 55 | The full documentation for |
56 | .B gnunet | 56 | .B gnunet |
57 | is maintained as a Texinfo manual. If the | 57 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-conversation-test.1 b/doc/man/gnunet-conversation-test.1 index 6ceca61e2..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,20 +25,20 @@ 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 | 35 | electronic mail to <gnunet\-developers@gnu.org> | |
39 | .SH "SEE ALSO" | 36 | .SH SEE ALSO |
40 | \fBgnunet\-conversation\fP(1) | 37 | \fBgnunet\-conversation\fP(1) |
41 | The full documentation for | 38 | The full documentation for |
42 | .B gnunet | 39 | .B gnunet |
43 | is maintained as a Texinfo manual. If the | 40 | is maintained as a Texinfo manual. |
41 | If the | ||
44 | .B info | 42 | .B info |
45 | and | 43 | and |
46 | .B gnunet | 44 | .B gnunet |
diff --git a/doc/man/gnunet-conversation.1 b/doc/man/gnunet-conversation.1 index 2440c48a7..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,21 +26,20 @@ 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 | 41 | electronic mail to <gnunet\-developers@gnu.org> | |
44 | .SH "SEE ALSO" | 42 | .SH SEE ALSO |
45 | \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) |
46 | The full documentation for | 44 | The full documentation for |
47 | .B gnunet | 45 | .B gnunet |
diff --git a/doc/man/gnunet-core.1 b/doc/man/gnunet-core.1 index 382d1b152..12d936f7a 100644 --- a/doc/man/gnunet-core.1 +++ b/doc/man/gnunet-core.1 | |||
@@ -35,10 +35,10 @@ be verbose | |||
35 | .SH NOTES | 35 | .SH NOTES |
36 | 36 | ||
37 | 37 | ||
38 | .SH "REPORTING BUGS" | 38 | .SH BUGS |
39 | 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 | 40 | electronic mail to <gnunet\-developers@gnu.org> | |
41 | .SH "SEE ALSO" | 41 | .SH SEE ALSO |
42 | \fBgnunet\-transport\fP(1) | 42 | \fBgnunet\-transport\fP(1) |
43 | The full documentation for | 43 | The full documentation for |
44 | .B gnunet | 44 | .B gnunet |
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1 index f97363e64..535aedbf5 100644 --- a/doc/man/gnunet-datastore.1 +++ b/doc/man/gnunet-datastore.1 | |||
@@ -1,18 +1,17 @@ | |||
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 | .PP |
10 | 9 | gnunet\-datastore can be used to backup and restore or merge GNUnet | |
11 | gnunet\-datastore can be used to backup and restore or merge GNUnet datastores. | 10 | datastores. |
12 | This is useful if a datastore is to be migrated between SQL databases, i.e. | 11 | This is useful if a datastore is to be migrated between SQL databases, |
13 | from sqlite to postgres or vice versa. gnunet\-datastore will dump the | 12 | i.e. from sqlite to postgres or vice versa. |
14 | entire contents of the database or insert a dump file into the database. | 13 | gnunet\-datastore will dump the entire contents of the database or |
15 | 14 | insert a dump file into the database. | |
16 | .TP | 15 | .TP |
17 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | 16 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR |
18 | configuration file to use | 17 | configuration file to use |
@@ -37,14 +36,15 @@ configure logging to write logs to FILENAME | |||
37 | .TP | 36 | .TP |
38 | \fB\-v\fR, \fB\-\-version\fR | 37 | \fB\-v\fR, \fB\-\-version\fR |
39 | print the version number | 38 | print the version number |
40 | 39 | .SH BUGS | |
41 | .SH "REPORTING BUGS" | 40 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending |
42 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 41 | electronic mail to <gnunet\-developers@gnu.org> |
43 | .SH "SEE ALSO" | 42 | .SH SEE ALSO |
44 | \fBgnunet\-publish\fP(1) | 43 | \fBgnunet\-publish\fP(1) |
45 | The full documentation for | 44 | The full documentation for |
46 | .B gnunet | 45 | .B gnunet |
47 | is maintained as a Texinfo manual. If the | 46 | is maintained as a Texinfo manual. |
47 | If the | ||
48 | .B info | 48 | .B info |
49 | and | 49 | and |
50 | .B gnunet | 50 | .B gnunet |
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1 index 7bed13f4d..a8aa515e4 100644 --- a/doc/man/gnunet-directory.1 +++ b/doc/man/gnunet-directory.1 | |||
@@ -56,10 +56,12 @@ search results. The directory file can be downloaded to disk | |||
56 | by \fBgnunet\-download\fP(1) for later processing or be handled more directly | 56 | by \fBgnunet\-download\fP(1) for later processing or be handled more directly |
57 | by \fBgnunet\-fs\-gtk\fP(1). | 57 | by \fBgnunet\-fs\-gtk\fP(1). |
58 | 58 | ||
59 | .SH "REPORTING BUGS" | 59 | .SH BUGS |
60 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 60 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending |
61 | .SH "SEE ALSO" | 61 | 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) | 62 | .SH SEE ALSO |
63 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), | ||
64 | \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1) | ||
63 | The full documentation for | 65 | The full documentation for |
64 | .B gnunet | 66 | .B gnunet |
65 | is maintained as a Texinfo manual. If the | 67 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1 index 8a3c83218..6ecad3c42 100644 --- a/doc/man/gnunet-dns2gns.1 +++ b/doc/man/gnunet-dns2gns.1 | |||
@@ -35,7 +35,8 @@ 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 | electronic mail to <bug\-gnunet@gnu.org> | ||
39 | .SH SEE ALSO | 40 | .SH SEE ALSO |
40 | gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1) | 41 | gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1) |
41 | The full documentation for | 42 | The full documentation for |
diff --git a/doc/man/gnunet-download-manager.1 b/doc/man/gnunet-download-manager.1 index 797afa8c0..7cc6dbffb 100644 --- a/doc/man/gnunet-download-manager.1 +++ b/doc/man/gnunet-download-manager.1 | |||
@@ -1,36 +1,64 @@ | |||
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) |
31 | The full documentation for | 58 | The full documentation for |
32 | .B gnunet | 59 | .B gnunet |
33 | is maintained as a Texinfo manual. If the | 60 | is maintained as a Texinfo manual. |
61 | If the | ||
34 | .B info | 62 | .B info |
35 | and | 63 | and |
36 | .B gnunet | 64 | .B gnunet |
@@ -47,3 +75,6 @@ will give you access to a tutorial for developers. | |||
47 | Depending on your installation, this information is also | 75 | Depending on your installation, this information is also |
48 | available in | 76 | available in |
49 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 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 d787a7aba..aa1328c00 100644 --- a/doc/man/gnunet-download.1 +++ b/doc/man/gnunet-download.1 | |||
@@ -147,10 +147,13 @@ do the same. | |||
147 | .TP | 147 | .TP |
148 | ~/.config/gnunet.conf | 148 | ~/.config/gnunet.conf |
149 | GNUnet configuration file | 149 | GNUnet configuration file |
150 | .SH "REPORTING BUGS" | 150 | .SH BUGS |
151 | Report bugs to <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 151 | Report bugs to <https://gnunet.org/bugs/> or by sending electronic |
152 | .SH "SEE ALSO" | 152 | 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) | 153 | .SH SEE ALSO |
154 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), | ||
155 | \fBgnunet\-search\fP(1), \fBgnunet.conf\fP(5), | ||
156 | \fBgnunet\-service\-fs\fP(1) | ||
154 | The full documentation for | 157 | The full documentation for |
155 | .B gnunet | 158 | .B gnunet |
156 | is maintained as a Texinfo manual. If the | 159 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-ecc.1 b/doc/man/gnunet-ecc.1 index f0de83865..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,7 +49,9 @@ 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 | ||
53 | The full documentation for | 55 | The full documentation for |
54 | .B gnunet | 56 | .B gnunet |
55 | is maintained as a Texinfo manual. If the | 57 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-fs.1 b/doc/man/gnunet-fs.1 index e3837cb9d..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,21 +19,22 @@ 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) |
41 | The full documentation for | 40 | The full documentation for |
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1 index 3a6cc004f..ccb0f7206 100644 --- a/doc/man/gnunet-gns-proxy.1 +++ b/doc/man/gnunet-gns-proxy.1 | |||
@@ -45,8 +45,8 @@ Print GNUnet version number. | |||
45 | 45 | ||
46 | 46 | ||
47 | .SH BUGS | 47 | .SH BUGS |
48 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> | 48 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
49 | 49 | electronic mail to <bug\-gnunet@gnu.org> | |
50 | .SH SEE ALSO | 50 | .SH SEE ALSO |
51 | gnunet\-gns(1) | 51 | gnunet\-gns(1) |
52 | The full documentation for | 52 | The full documentation for |
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index f19c4fc4d..9f7a651a7 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 | |||
@@ -1,58 +1,51 @@ | |||
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 | .SH "SEE ALSO" | 45 | electronic mail to <gnunet\-developers@gnu.org> |
46 | .SH SEE ALSO | ||
55 | \fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1) | 47 | \fBgnunet\-namestore\fP(1), \fBgnunet\-identity\fP(1) |
48 | .PP | ||
56 | The full documentation for | 49 | The full documentation for |
57 | .B gnunet | 50 | .B gnunet |
58 | is maintained as a Texinfo manual. If the | 51 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1 index d20c3a0fa..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,64 +6,62 @@ 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 | |||
26 | .TP | 25 | .TP |
27 | \fB\-D NAME\fR, \fB\-\-delete=NAME\fR Delete the ego with the given | 26 | \fB\-D NAME\fR, \fB\-\-delete=NAME\fR |
28 | NAME. | 27 | Delete the ego with the given NAME. |
29 | |||
30 | .TP | 28 | .TP |
31 | \fB\-e NAME\fR, \fB\-\-ego=NAME\fR Perform "set" operation with the | 29 | \fB\-e NAME\fR, \fB\-\-ego=NAME\fR |
32 | respective ego. Needs to be used together with option \-s. | 30 | Perform "set" operation with the respective ego. |
33 | 31 | Needs to be used together with option \-s. | |
34 | .TP | 32 | .TP |
35 | \fB\-h\fR, \fB\-\-help\fR Print help page. | 33 | \fB\-h\fR, \fB\-\-help\fR |
36 | 34 | Print help page. | |
37 | .TP | 35 | .TP |
38 | \fB\-d\fR, \fB\-\-display\fR display all of our egos | 36 | \fB\-d\fR, \fB\-\-display\fR |
39 | 37 | display all of our egos | |
40 | .TP | 38 | .TP |
41 | \fB\-m\fR, \fB\-\-monitor\fR run in monitor mode, listing all ouf our | 39 | \fB\-m\fR, \fB\-\-monitor\fR |
42 | egos until CTRL-C is pressed. Each ego is listed together with a | 40 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. |
43 | unique pointer value; if egos are renamed, that pointer value remains | 41 | Each ego is listed together with a unique pointer value; if egos are |
44 | the same; if egos are deleted, they are listed one more time with a | 42 | renamed, that pointer value remains the same; if egos are deleted, |
45 | name of "<null>". | 43 | they are listed one more time with a name of "<null>". |
46 | |||
47 | .TP | 44 | .TP |
48 | \fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR Perform "set" operation | 45 | \fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR |
49 | for the specified SUBSYSTEM with the respective ego. Needs to be used | 46 | Perform "set" operation for the specified SUBSYSTEM with the |
50 | together with option \-e. After this, the given SUBSYSTEM will use | 47 | respective ego. |
51 | the ego with the specified NAME. This will fail if NAME does not yet | 48 | Needs to be used together with option \-e. |
52 | exist. | 49 | After this, the given SUBSYSTEM will use the ego with the specified |
53 | 50 | NAME. | |
54 | 51 | This will fail if NAME does not yet exist. | |
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) |
64 | The full documentation for | 61 | The full documentation for |
65 | .B gnunet | 62 | .B gnunet |
66 | is maintained as a Texinfo manual. If the | 63 | is maintained as a Texinfo manual. |
64 | If the | ||
67 | .B info | 65 | .B info |
68 | and | 66 | and |
69 | .B gnunet | 67 | .B gnunet |
diff --git a/doc/man/gnunet-namecache.1 b/doc/man/gnunet-namecache.1 index 8b610d119..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,9 @@ 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 | .SH "SEE ALSO" | 39 | electronic mail to <gnunet\-developers@gnu.org> |
40 | .SH SEE ALSO | ||
40 | \fBgnunet\-gns\fP(1) | 41 | \fBgnunet\-gns\fP(1) |
41 | The full documentation for | 42 | The full documentation for |
42 | .B gnunet | 43 | .B gnunet |
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1 index 2c2960d86..fc0f40eef 100644 --- a/doc/man/gnunet-namestore-fcfsd.1 +++ b/doc/man/gnunet-namestore-fcfsd.1 | |||
@@ -50,7 +50,8 @@ Print GNUnet version number. | |||
50 | Specifies for which EGO should FCFSD manage the zone. | 50 | Specifies for which EGO should FCFSD manage the zone. |
51 | 51 | ||
52 | .SH BUGS | 52 | .SH BUGS |
53 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <bug\-gnunet@gnu.org> | 53 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
54 | electronic mail to <bug\-gnunet@gnu.org> | ||
54 | .SH SEE ALSO | 55 | .SH SEE ALSO |
55 | gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) | 56 | gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) |
56 | The full documentation for | 57 | The full documentation for |
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 7b06b7fce..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,9 @@ 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 | .SH "SEE ALSO" | 93 | electronic mail to <gnunet\-developers@gnu.org> |
94 | .SH SEE ALSO | ||
94 | \fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1) | 95 | \fBgnunet\-gns\fP(1), \fBgnunet\-namestore\-gtk\fP(1) |
95 | The full documentation for | 96 | The full documentation for |
96 | .B gnunet | 97 | .B gnunet |
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1 index 17de488ce..ca50d76fc 100644 --- a/doc/man/gnunet-nat-auto.1 +++ b/doc/man/gnunet-nat-auto.1 | |||
@@ -65,8 +65,8 @@ Test UDP configuration: | |||
65 | 65 | ||
66 | 66 | ||
67 | .SH BUGS | 67 | .SH BUGS |
68 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 68 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
69 | 69 | electronic mail to <gnunet\-developers@gnu.org> | |
70 | .SH SEE ALSO | 70 | .SH SEE ALSO |
71 | gnunet\-transport(1) gnunet\-nat(1) | 71 | gnunet\-transport(1) gnunet\-nat(1) |
72 | The full documentation for | 72 | The full documentation for |
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1 index 68cbefe5d..a97768340 100644 --- a/doc/man/gnunet-nat-server.1 +++ b/doc/man/gnunet-nat-server.1 | |||
@@ -53,8 +53,8 @@ are supposed to autoconfigure with this server. | |||
53 | Use the configuration file FILENAME. | 53 | Use the configuration file FILENAME. |
54 | 54 | ||
55 | .SH BUGS | 55 | .SH BUGS |
56 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 56 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
57 | 57 | electronic mail to <gnunet\-developers@gnu.org> | |
58 | .SH SEE ALSO | 58 | .SH SEE ALSO |
59 | gnunet\-transport(1) | 59 | gnunet\-transport(1) |
60 | The full documentation for | 60 | The full documentation for |
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1 index a7f8526b4..cf48e1dc6 100644 --- a/doc/man/gnunet-nat.1 +++ b/doc/man/gnunet-nat.1 | |||
@@ -1,118 +1,91 @@ | |||
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 | The full documentation for | 91 | The full documentation for |
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1 index a0226f25b..5c610b59f 100644 --- a/doc/man/gnunet-peerinfo.1 +++ b/doc/man/gnunet-peerinfo.1 | |||
@@ -51,8 +51,8 @@ Print the version number | |||
51 | 51 | ||
52 | 52 | ||
53 | .SH BUGS | 53 | .SH BUGS |
54 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 54 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending |
55 | 55 | electronic mail to <gnunet\-developers@gnu.org> | |
56 | .SH SEE ALSO | 56 | .SH SEE ALSO |
57 | gnunet.conf(5) | 57 | gnunet.conf(5) |
58 | The full documentation for | 58 | The full documentation for |
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index 8811ad6e2..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,321 +7,328 @@ 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 | ||
322 | The full documentation for | 328 | The full documentation for |
323 | .B gnunet | 329 | .B gnunet |
324 | is maintained as a Texinfo manual. If the | 330 | is maintained as a Texinfo manual. |
331 | If the | ||
325 | .B info | 332 | .B info |
326 | and | 333 | and |
327 | .B gnunet | 334 | .B gnunet |
diff --git a/doc/man/gnunet-qr.1 b/doc/man/gnunet-qr.1 index 01c05084c..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,10 +24,10 @@ 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 |
34 | .SH "SEE ALSO" | 29 | electronic mail to <gnunet\-developers@gnu.org> |
30 | .SH SEE ALSO | ||
35 | The full documentation for | 31 | The full documentation for |
36 | .B gnunet | 32 | .B gnunet |
37 | is maintained as a Texinfo manual. If the | 33 | is maintained as a Texinfo manual. If the |
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1 index 467eb4bcf..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 |
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1 index d79dd620c..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 |
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1 index a5f7ea70d..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,7 +37,6 @@ 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> |
47 | .SH "SEE ALSO" | 42 | .SH "SEE ALSO" |
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1 index 47aa4a411..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,13 +39,14 @@ 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 |
48 | .SH "SEE ALSO" | 44 | electronic mail to <gnunet\-developers@gnu.org> |
45 | .SH SEE ALSO | ||
49 | The full documentation for | 46 | The full documentation for |
50 | .B gnunet | 47 | .B gnunet |
51 | is maintained as a Texinfo manual. If the | 48 | is maintained as a Texinfo manual. |
49 | If the | ||
52 | .B info | 50 | .B info |
53 | and | 51 | and |
54 | .B gnunet | 52 | .B gnunet |
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1 index e05f451b5..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,10 +59,6 @@ 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" |
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1 index bc6a23f6a..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 |
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1 index f4e445c21..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,46 +34,50 @@ 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) |
81 | The full documentation for | 83 | The full documentation for |
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1 index 57f5e70e2..0b3f44fff 100644 --- a/doc/man/gnunet-zoneimport.1 +++ b/doc/man/gnunet-zoneimport.1 | |||
@@ -75,8 +75,8 @@ $ gnunet\-zoneimport 1.2.3.4 < names.txt | |||
75 | 75 | ||
76 | 76 | ||
77 | .SH BUGS | 77 | .SH BUGS |
78 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 78 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
79 | 79 | electronic mail to <gnunet\-developers@gnu.org> | |
80 | .SH SEE ALSO | 80 | .SH SEE ALSO |
81 | gnunet\-gns(1), gnunet\-namestore(1) | 81 | gnunet\-gns(1), gnunet\-namestore(1) |
82 | The full documentation for | 82 | The full documentation for |
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5 index ec6a089d7..3aee4ed71 100644 --- a/doc/man/gnunet.conf.5 +++ b/doc/man/gnunet.conf.5 | |||
@@ -1,3 +1,4 @@ | |||
1 | .\" -*- mode: nroff -*- | ||
1 | .TH GNUNET.CONF "5" "26 October 2018" "GNUnet" | 2 | .TH GNUNET.CONF "5" "26 October 2018" "GNUnet" |
2 | .SH NAME | 3 | .SH NAME |
3 | gnunet.conf \- GNUnet configuration file | 4 | gnunet.conf \- GNUnet configuration file |
@@ -144,10 +145,10 @@ to the actual external address for your usage. | |||
144 | .TP | 145 | .TP |
145 | ~/.config/gnunet.conf | 146 | ~/.config/gnunet.conf |
146 | GNUnet configuration file | 147 | GNUnet configuration file |
147 | .SH "REPORTING BUGS" | 148 | .SH BUGS |
148 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic | 149 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending |
149 | mail to <bug-gnunet@gnu.org> | 150 | electronic mail to <bug-gnunet@gnu.org> |
150 | .SH "SEE ALSO" | 151 | .SH SEE ALSO |
151 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) | 152 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) |
152 | The full documentation for | 153 | The full documentation for |
153 | .B gnunet | 154 | .B gnunet |