diff options
Diffstat (limited to 'doc/man')
43 files changed, 1230 insertions, 999 deletions
diff --git a/doc/man/.gitignore b/doc/man/.gitignore index ffd69e11b..38ed67872 100644 --- a/doc/man/.gitignore +++ b/doc/man/.gitignore | |||
@@ -1 +1,5 @@ | |||
1 | gnunet.conf.5 | 1 | gnunet.conf.5 |
2 | groff_lint.log | ||
3 | *.html | ||
4 | gnunet-c-tutorial.7 | ||
5 | gnunet-documentation.7 | ||
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 53d97b6b9..509e33be7 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -5,7 +5,23 @@ do_subst = $(SED) -e 's,[@]SYSCONFDIR[@],$(sysconfdir),g' | |||
5 | gnunet.conf.5: gnunet.conf.5.in Makefile | 5 | gnunet.conf.5: gnunet.conf.5.in Makefile |
6 | $(do_subst) < $(srcdir)/gnunet.conf.5.in > gnunet.conf.5 | 6 | $(do_subst) < $(srcdir)/gnunet.conf.5.in > gnunet.conf.5 |
7 | 7 | ||
8 | CLEANFILES = gnunet.conf.5 | 8 | if TEXI2MDOC_GENERATION |
9 | gnunet-c-tutorial.7: Makefile gnunet-tutorial.7 | ||
10 | @echo generated texi2mdoc output || true | ||
11 | |||
12 | gnunet-tutorial.7: Makefile | ||
13 | $(SH) $(srcdir)/texi2mdoc-generation.sh || true | ||
14 | |||
15 | endif | ||
16 | |||
17 | CLEANFILES = gnunet.conf.5 *.html | ||
18 | |||
19 | if TEXI2MDOC_GENERATION | ||
20 | CLEANFILES += gnunet-documentation.7 gnunet-c-tutorial.7 | ||
21 | endif | ||
22 | |||
23 | html: | ||
24 | $(SH) $(srcdir)/produce_html.sh | ||
9 | 25 | ||
10 | man_MANS = \ | 26 | man_MANS = \ |
11 | gnunet.conf.5 \ | 27 | gnunet.conf.5 \ |
@@ -26,6 +42,7 @@ man_MANS = \ | |||
26 | gnunet-fs.1 \ | 42 | gnunet-fs.1 \ |
27 | gnunet-gns.1 \ | 43 | gnunet-gns.1 \ |
28 | gnunet-gns-proxy.1 \ | 44 | gnunet-gns-proxy.1 \ |
45 | gnunet-gns-proxy-setup-ca.1 \ | ||
29 | gnunet-identity.1 \ | 46 | gnunet-identity.1 \ |
30 | gnunet-cadet.1 \ | 47 | gnunet-cadet.1 \ |
31 | gnunet-namecache.1 \ | 48 | gnunet-namecache.1 \ |
@@ -34,6 +51,7 @@ man_MANS = \ | |||
34 | gnunet-nat.1 \ | 51 | gnunet-nat.1 \ |
35 | gnunet-nat-auto.1 \ | 52 | gnunet-nat-auto.1 \ |
36 | gnunet-nat-server.1 \ | 53 | gnunet-nat-server.1 \ |
54 | gnunet-nse.1 \ | ||
37 | gnunet-peerinfo.1 \ | 55 | gnunet-peerinfo.1 \ |
38 | gnunet-publish.1 \ | 56 | gnunet-publish.1 \ |
39 | gnunet-qr.1 \ | 57 | gnunet-qr.1 \ |
@@ -53,10 +71,15 @@ man_MANS = \ | |||
53 | gnunet-vpn.1 \ | 71 | gnunet-vpn.1 \ |
54 | gnunet-zoneimport.1 | 72 | gnunet-zoneimport.1 |
55 | 73 | ||
74 | if TEXI2MDOC_GENERATION | ||
75 | man_MANS += gnunet-c-tutorial.7 gnunet-documentation.7 | ||
76 | endif | ||
77 | |||
56 | EXTRA_DIST = ${man_MANS} \ | 78 | EXTRA_DIST = ${man_MANS} \ |
57 | gnunet.conf.5.in | 79 | gnunet.conf.5.in \ |
80 | texi2mdoc-generation.sh \ | ||
81 | README | ||
58 | 82 | ||
59 | if TEXI2MDOC_GENERATION | 83 | if TEXI2MDOC_GENERATION |
60 | EXTRA_DIST += gnunet-documentation.7 \ | 84 | EXTRA_DIST += gnunet-documentation.7 gnunet-c-tutorial.7 |
61 | gnunet-c-tutorial.7 | ||
62 | endif | 85 | endif |
diff --git a/doc/man/README b/doc/man/README new file mode 100644 index 000000000..fb95a11f2 --- /dev/null +++ b/doc/man/README | |||
@@ -0,0 +1,8 @@ | |||
1 | Please note that new edits in files which already are in mdoc format | ||
2 | should only be done in mdoc format. | ||
3 | |||
4 | TODO: | ||
5 | |||
6 | * incomplete pages: | ||
7 | - gnunet-timeout | ||
8 | \ No newline at end of file | ||
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1 index b17e74a73..c25b10bb5 100644 --- a/doc/man/gnunet-arm.1 +++ b/doc/man/gnunet-arm.1 | |||
@@ -1,78 +1,134 @@ | |||
1 | .TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" | 1 | .\" This file is part of GNUnet. |
2 | .SH NAME | 2 | .\" Copyright (C) 2001-2019 GNUnet e.V. |
3 | gnunet\-arm \- control GNUnet services | 3 | .\" |
4 | .SH SYNOPSIS | 4 | .\" Permission is granted to copy, distribute and/or modify this document |
5 | .B gnunet\-arm | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
6 | .RI [ options ] | 6 | .\" any later version published by the Free Software Foundation; with no |
7 | .SH DESCRIPTION | 7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
8 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including | 8 | .\" copy of the license is included in the file |
9 | the ARM service itself. The ARM service is a supervisor for GNUnet's | 9 | .\" ``FDL-1.3''. |
10 | service processes. ARM starts services on-demand or as configured and | 10 | .\" |
11 | re-starts them if they crash. | 11 | .\" A copy of the license is also available from the Free Software |
12 | .SH OPTIONS | 12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. |
13 | .B | 13 | .\" |
14 | .IP "\-c FILENAME, \-\-config=FILENAME" | 14 | .\" Alternately, this document is also available under the General |
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" ``GPL3''. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd January 4, 2012 | ||
25 | .Dt GNUNET-ARM 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-arm | ||
29 | .Nd | ||
30 | control GNUnet services | ||
31 | .Sh SYNOPSIS | ||
32 | .Nm | ||
33 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
34 | .Op Fl d | \-delete | ||
35 | .Op Fl e | \-end | ||
36 | .Op Fl E | \-no-stderr | ||
37 | .Op Fl h | \-help | ||
38 | .Op Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE | ||
39 | .Op Fl I | \-info | ||
40 | .Op Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE | ||
41 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME | ||
42 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
43 | .Op Fl m | \-monitor | ||
44 | .Op Fl O | \-no-stdout | ||
45 | .Op Fl q | \-quiet | ||
46 | .Op Fl r | \-restart | ||
47 | .Op Fl s | \-start | ||
48 | .Op Fl T DELAY | \-timeout= Ns Ar TIMEOUT | ||
49 | .Op Fl v | \-version | ||
50 | .Sh DESCRIPTION | ||
51 | .Nm | ||
52 | can be used to start or stop GNUnet services, including the ARM service itself. | ||
53 | The ARM service is a supervisor for GNUnet's service processes. | ||
54 | ARM starts services on-demand or as configured and restarts them if they crash. | ||
55 | .Bl -tag -width Ds | ||
56 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
15 | Use the configuration file FILENAME. | 57 | Use the configuration file FILENAME. |
16 | .B | 58 | .It Fl d | \-delete |
17 | .IP "\-e, \-\-end" | 59 | Delete config file and directory on exit. |
18 | Shutdown all GNUnet services (including ARM itself). Running | 60 | .It Fl e | \-end |
19 | "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. | 61 | Shutdown all GNUnet services (including ARM itself). |
20 | .B | 62 | Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. |
21 | .IP "\-h, \-\-help" | 63 | .It Fl E | \-no-stderr |
64 | Don't let gnunet-arm inherit standard error. | ||
65 | .It Fl h | \-help | ||
22 | Print short help on options. | 66 | Print short help on options. |
23 | .B | 67 | .It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE |
24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 68 | Starts the specified SERVICE if it is not already running. |
25 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 69 | More specifically, this makes the service behave as if it were in the default services list. |
26 | .B | 70 | .It Fl I | \-info |
27 | .IP "\-i SERVICE, \-\-init=SERVICE" | ||
28 | Starts the specified SERVICE if it is not already running. More specifically, | ||
29 | this makes the service behave as if it were in the default services list. | ||
30 | .B | ||
31 | .IP "\-k SERVICE, \-\-kill=SERVICE" | ||
32 | Stop the specified SERVICE if it is running. While this will kill the service | ||
33 | right now, the service may be restarted immediately if other services depend | ||
34 | on it (service is then started 'on-demand'). If the service used to be a 'default' | ||
35 | service, its default-service status will be revoked. If the | ||
36 | service was not a default service, it will just be (temporarily) stopped, | ||
37 | but could be re-started on-demand at any time. | ||
38 | .B | ||
39 | .IP "\-m, \-\-monitor" | ||
40 | Monitor service activity of ARM. In this mode, the command will not terminate | ||
41 | until the user presses CTRL-C. | ||
42 | .B | ||
43 | .IP "\-s, \-\-start" | ||
44 | Start all GNUnet default services on this system (and also ARM). Naturally, | ||
45 | if a service is demanded by a default service, it will then also be started. | ||
46 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. | ||
47 | .B | ||
48 | .IP "\-I, \-\-info" | ||
49 | List all running services. | 71 | List all running services. |
50 | .B | 72 | .It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE |
51 | .IP "\-v, \-\-version" | 73 | Stop the specified SERVICE if it is running. |
74 | While this will kill the service right now, the service may be restarted immediately if other services depend on it (service is then started 'on-demand'). | ||
75 | If the service used to be a 'default' service, its default-service status will be revoked. | ||
76 | If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. | ||
77 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME | ||
78 | Write logs to FILENAME. | ||
79 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
80 | Use LOGLEVEL for logging. | ||
81 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
82 | .It Fl m | \-monitor | ||
83 | Monitor service activity of ARM. | ||
84 | In this mode, the command will not terminate until the user presses CTRL-C. | ||
85 | .It Fl O | \-no-stdout | ||
86 | Don't let gnunet-arm inherit standard output | ||
87 | .It Fl q | \-quiet | ||
88 | Don't print status messages. | ||
89 | .It Fl r | \-restart | ||
90 | Stop and start all GNUnet default services. | ||
91 | .It Fl s | \-start | ||
92 | Start all GNUnet default services on this system (and also ARM). | ||
93 | Naturally, if a service is demanded by a default service, it will then also be started. | ||
94 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. | ||
95 | .It Fl T DELAY | \-timeout= Ns Ar DELAY | ||
96 | Exit with error status if operation does not finish after DELAY | ||
97 | .It Fl v | \-version | ||
52 | Print GNUnet version number. | 98 | Print GNUnet version number. |
53 | .SH BUGS | 99 | .El |
54 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 100 | .Sh EXAMPLES |
55 | electronic mail to <gnunet\-developers@gnu.org> | 101 | Start the gnunet-arm for the user: |
56 | .SH SEE ALSO | 102 | .Pp |
57 | gnunet\-config(1), gnunet\-setup(1) | 103 | .Dl gnunet-arm -s |
58 | .PP | 104 | .Pp |
59 | The full documentation for | 105 | Stop the gnunet-arm for the user: |
60 | .B gnunet | 106 | .Pp |
61 | is maintained as a Texinfo manual. | 107 | .Dl $ gnunet-arm -e |
108 | .Sh SEE ALSO | ||
109 | .Xr gnunet-config 1 , | ||
110 | .Xr gnunet-setup 1 | ||
111 | .sp | ||
112 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
62 | If the | 113 | If the |
63 | .B info | 114 | .Xr info 1 |
64 | and | 115 | and gnunet programs are properly installed at your site, the command |
65 | .B gnunet | 116 | .Pp |
66 | programs are properly installed at your site, the command | 117 | .Dl info gnunet |
67 | .IP | 118 | .Pp |
68 | .B info gnunet | ||
69 | .PP | ||
70 | should give you access to the complete handbook, | 119 | should give you access to the complete handbook, |
71 | .IP | 120 | .Pp |
72 | .B info gnunet-c-tutorial | 121 | .Dl info gnunet-c-tutorial |
73 | .PP | 122 | .Pp |
74 | will give you access to a tutorial for developers. | 123 | will give you access to a tutorial for developers. |
75 | .PP | 124 | .sp |
76 | Depending on your installation, this information is also | 125 | Depending on your installation, this information is also available in |
77 | available in | 126 | .Xr gnunet 7 and |
78 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 127 | .Xr gnunet-c-tutorial 7 . |
128 | .\".Sh HISTORY | ||
129 | .\".Sh AUTHORS | ||
130 | .Sh BUGS | ||
131 | Report bugs by using | ||
132 | .Lk https://bugs.gnunet.org | ||
133 | or by sending electronic mail to | ||
134 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-ats.1 b/doc/man/gnunet-ats.1 index c098ed576..1e7b7731c 100644 --- a/doc/man/gnunet-ats.1 +++ b/doc/man/gnunet-ats.1 | |||
@@ -1,85 +1,110 @@ | |||
1 | .TH GNUNET\-ATS 1 "October 16, 2015" "GNUnet" | 1 | .\" This file is part of GNUnet. |
2 | .SH NAME | 2 | .\" Copyright (C) 2001-2019 GNUnet e.V. |
3 | gnunet\-ats \- display information about transport resource allocation | 3 | .\" |
4 | .SH SYNOPSIS | 4 | .\" Permission is granted to copy, distribute and/or modify this document |
5 | .B gnunet\-ats | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
6 | .RI [ options ] | 6 | .\" any later version published by the Free Software Foundation; with no |
7 | .br | 7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
8 | .SH DESCRIPTION | 8 | .\" copy of the license is included in the file |
9 | \fBgnunet\-ats\fP can be used to display information about the GNUnet's | 9 | .\" ``FDL-1.3''. |
10 | transport selection mechanism. It shows information about the | 10 | .\" |
11 | addresses and the assigned input and output bandwidth. | 11 | .\" A copy of the license is also available from the Free Software |
12 | .SH OPTIONS | 12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. |
13 | .B | 13 | .\" |
14 | .IP "\-a, \-\-aa" | 14 | .\" Alternately, this document is also available under the General |
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" ``GPL3''. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd October 16, 2015 | ||
25 | .Dt GNUNET-ATS 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-ats | ||
29 | .Nd | ||
30 | display information about transport resource allocation | ||
31 | .Sh SYNOPSIS | ||
32 | .Nm | ||
33 | .Op Fl a | \-all | ||
34 | .Op Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID | ||
35 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
36 | .Op Fl h | \-help | ||
37 | .Op Fl i Ar PEERID | Fl \-id= Ns Ar PEERID | ||
38 | .Op Fl k Ar VALUE | Fl \-value= Ns Ar VALUE | ||
39 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
40 | .Op Fl m | \-monitor | ||
41 | .Op Fl n | \-numeric | ||
42 | .Op Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE | ||
43 | .Op Fl q | \-quotas | ||
44 | .Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | ||
45 | .Op Fl u | \-used | ||
46 | .Op Fl V | \-verbose | ||
47 | .Op Fl v | \-version | ||
48 | .Sh DESCRIPTION | ||
49 | .Nm | ||
50 | can be used to display information about the GNUnet's transport selection mechanism. | ||
51 | It shows information about the addresses and the assigned input and output bandwidth. | ||
52 | .Sh OPTIONS | ||
53 | .Bl -tag -width Ds | ||
54 | .It Fl a | \-all | ||
15 | List all addresses currently known to ats. | 55 | List all addresses currently known to ats. |
16 | .B | 56 | .It Fl C Ar PEERID | Fl \-connect= Ns Ar PEERID |
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | 57 | Ask ATS to suggest an address for PEERID to transport to establish a connection. |
58 | Note that you can use the gnunet-transport commandline tool to force disconnects. | ||
59 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
18 | Use the configuration file FILENAME. | 60 | Use the configuration file FILENAME. |
19 | .B | 61 | .It Fl h | \-help |
20 | .IP "\-C, \-\-connect=PEERID" | ||
21 | Ask ATS to suggest an address for PEERID to transport to establish a | ||
22 | connection. | ||
23 | Note that you can use the gnunet\-transport command\-line tool to | ||
24 | force disconnects. | ||
25 | .B | ||
26 | .IP "\-h, \-\-help" | ||
27 | Print short help on options. | 62 | Print short help on options. |
28 | .B | 63 | .It Fl i Ar PEERID | Fl \-id= Ns Ar PEERID |
29 | .IP "\-i, \-\-id=PEERID" | 64 | Print information for a specific peer identity only. |
30 | Print information for a specific peer identity only | 65 | .It Fl k Ar VALUE | Fl \-value= Ns Ar VALUE |
31 | .B | 66 | Value to set for when changing preference values. |
32 | .IP "\-k, \-\-value=VALUE" | 67 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
33 | Value to set for when changing preference values | ||
34 | .B | ||
35 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
36 | Use LOGLEVEL for logging. | 68 | Use LOGLEVEL for logging. |
37 | Valid values are DEBUG, INFO, WARNING and ERROR. | 69 | Valid values are DEBUG, INFO, WARNING and ERROR. |
38 | .B | 70 | .It Fl m | \-monitor |
39 | .IP "\-m, \-\-monitor" | 71 | Monitor changes to the bandwidth assignments continuously. |
40 | Monitor changes to the bandwidth assignments continuously | 72 | .It Fl n | \-numeric |
41 | .B | 73 | Do not resolve IP addresses to hostnames. |
42 | .IP "\-n, \-\-numeric" | 74 | .It Fl p Ar PREFERENCE | Fl \-preference= Ns Ar PREFERENCE |
43 | Do not resolve IP addresses to hostnames | 75 | Set preference values, -i, -k and -t required. |
44 | .B | 76 | .It Fl q | \-quotas |
45 | .IP "\-k, \-\-preference=E" | ||
46 | Set preference values, \-i, \-k and \-t required | ||
47 | .B | ||
48 | .IP "\-q, \-\-quotas" | ||
49 | Print quotas for all network types | 77 | Print quotas for all network types |
50 | .B | 78 | .It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE |
51 | .IP "\-t, \-\-type=VALUE" | ||
52 | Preference type to change: latency | bandwidth | 79 | Preference type to change: latency | bandwidth |
53 | .B | 80 | .It Fl u | \-used |
54 | .IP "\-u, \-\-used" | ||
55 | Print addresses actively used only | 81 | Print addresses actively used only |
56 | .B | 82 | .It Fl V | \-verbose |
57 | .IP "\-V, \-\-verbose" | ||
58 | Print verbose output (include ATS address properties) | 83 | Print verbose output (include ATS address properties) |
59 | .B | 84 | .It v | \-version |
60 | .IP "\-v, \-\-version" | ||
61 | Print GNUnet version number. | 85 | Print GNUnet version number. |
62 | .SH BUGS | 86 | .El |
63 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 87 | .Sh SEE ALSO |
64 | electronic mail to <bug\-gnunet@gnu.org> | 88 | .Xr gnunet-transport 1 |
65 | .SH SEE ALSO | 89 | .sp |
66 | gnunet\-transport(1) | 90 | The full documentation for gnunet is maintained as a Texinfo manual. |
67 | The full documentation for | 91 | If the |
68 | .B gnunet | 92 | .Xr info 1 |
69 | is maintained as a Texinfo manual. If the | 93 | and gnunet programs are properly installed at your site, the command |
70 | .B info | 94 | .Pp |
71 | and | 95 | .Dl info gnunet |
72 | .B gnunet | 96 | .Pp |
73 | programs are properly installed at your site, the command | ||
74 | .IP | ||
75 | .B info gnunet | ||
76 | .PP | ||
77 | should give you access to the complete handbook, | 97 | should give you access to the complete handbook, |
78 | .IP | 98 | .Pp |
79 | .B info gnunet-c-tutorial | 99 | .Dl info gnunet-c-tutorial |
80 | .PP | 100 | .Pp |
81 | will give you access to a tutorial for developers. | 101 | will give you access to a tutorial for developers. |
82 | .PP | 102 | .Pp |
83 | Depending on your installation, this information is also | 103 | Depending on your installation, this information is also available in |
84 | available in | 104 | .Xr gnunet 7 and |
85 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 105 | .Xr gnunet-c-tutorial 7 . |
106 | .Sh BUGS | ||
107 | Report bugs by using | ||
108 | .Lk https://bugs.gnunet.org | ||
109 | or by sending electronic mail to | ||
110 | .Aq Mt bug-gnunet@gnu.org . | ||
diff --git a/doc/man/gnunet-bcd.1 b/doc/man/gnunet-bcd.1 index 02b4397de..9b37a097b 100644 --- a/doc/man/gnunet-bcd.1 +++ b/doc/man/gnunet-bcd.1 | |||
@@ -13,19 +13,14 @@ installed. If it does not work for you, try installing the full | |||
13 | TeXLive distribution first, for example using the package\-manager | 13 | TeXLive distribution first, for example using the package\-manager |
14 | apt: "apt-get install texlive-full". | 14 | apt: "apt-get install texlive-full". |
15 | .SH OPTIONS | 15 | .SH OPTIONS |
16 | .B | ||
17 | .IP "\-p PORT, \-\-port=PORT" | 16 | .IP "\-p PORT, \-\-port=PORT" |
18 | Run the HTTP server on port PORT. | 17 | Run the HTTP server on port PORT. |
19 | .B | ||
20 | .IP "\-c FILENAME, \-\-config=FILENAME" | 18 | .IP "\-c FILENAME, \-\-config=FILENAME" |
21 | Use the configuration file FILENAME. | 19 | Use the configuration file FILENAME. |
22 | .B | ||
23 | .IP "\-h, \-\-help" | 20 | .IP "\-h, \-\-help" |
24 | Print short help on options. | 21 | Print short help on options. |
25 | .B | ||
26 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 22 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
27 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 23 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
28 | .B | ||
29 | .IP "\-v, \-\-version" | 24 | .IP "\-v, \-\-version" |
30 | Print GNUnet version number. | 25 | Print GNUnet version number. |
31 | .SH BUGS | 26 | .SH BUGS |
diff --git a/doc/man/gnunet-cadet.1 b/doc/man/gnunet-cadet.1 index 8404f085c..44d7fffca 100644 --- a/doc/man/gnunet-cadet.1 +++ b/doc/man/gnunet-cadet.1 | |||
@@ -21,42 +21,30 @@ For one\-to\-many communication \fBgnunet\-social\fP may be better | |||
21 | suited, however. | 21 | suited, however. |
22 | 22 | ||
23 | .SH SPECIFIC OPTIONS | 23 | .SH SPECIFIC OPTIONS |
24 | .B | ||
25 | .IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID" | 24 | .IP "\-C CONNECTION_ID, \-\-connection=CONNECTION_ID" |
26 | Provide information about a particular connection. | 25 | Provide information about a particular connection. |
27 | .B | ||
28 | .IP "\-d, \-\-dump" | 26 | .IP "\-d, \-\-dump" |
29 | Dump debug information to STDERR. | 27 | Dump debug information to STDERR. |
30 | .B | ||
31 | .IP "\-e, \-\-echo" | 28 | .IP "\-e, \-\-echo" |
32 | Activate echo mode. | 29 | Activate echo mode. |
33 | .B | ||
34 | .IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET" | 30 | .IP "\-o SHARED_SECRET, \-\-open-port=SHARED_SECRET" |
35 | Listen for connections using a shared secret among sender and recipient. | 31 | Listen for connections using a shared secret among sender and recipient. |
36 | .B | ||
37 | .IP "\-p PEER_ID, \-\-peer=PEER_ID" | 32 | .IP "\-p PEER_ID, \-\-peer=PEER_ID" |
38 | Provide information about a patricular peer. | 33 | Provide information about a patricular peer. |
39 | .B | ||
40 | .IP "\-P, \-\-peers" | 34 | .IP "\-P, \-\-peers" |
41 | Provide information about all peers. | 35 | Provide information about all peers. |
42 | .B | ||
43 | .IP "\-T, \-\-tunnels" | 36 | .IP "\-T, \-\-tunnels" |
44 | Provide information about all tunnels. | 37 | Provide information about all tunnels. |
45 | 38 | ||
46 | .SH STANDARD OPTIONS | 39 | .SH STANDARD OPTIONS |
47 | .B | ||
48 | .IP "\-c FILENAME, \-\-config=FILENAME" | 40 | .IP "\-c FILENAME, \-\-config=FILENAME" |
49 | Use the configuration file FILENAME. | 41 | Use the configuration file FILENAME. |
50 | .B | ||
51 | .IP "\-h, \-\-help" | 42 | .IP "\-h, \-\-help" |
52 | Print short help on options. | 43 | Print short help on options. |
53 | .B | ||
54 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | 44 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" |
55 | Configure logging to write logs to LOGFILE. | 45 | Configure logging to write logs to LOGFILE. |
56 | .B | ||
57 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 46 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
58 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 47 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
59 | .B | ||
60 | .IP "\-v, \-\-version" | 48 | .IP "\-v, \-\-version" |
61 | Print GNUnet version number. | 49 | Print GNUnet version number. |
62 | 50 | ||
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 index f1443283f..8eca8de10 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 | |||
@@ -7,38 +7,28 @@ gnunet\-config \- manipulate GNUnet configuration files | |||
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | \fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. | 8 | \fBgnunet\-config\fP can be used to read or modify GNUnet configuration files. |
9 | .SH OPTIONS | 9 | .SH OPTIONS |
10 | .B | ||
11 | .IP "\-f, \-\-filename" | 10 | .IP "\-f, \-\-filename" |
12 | When accessing a specific option using \-s and \-o, perform expansions as if the | 11 | Try to perform expansions as if the option values represent filenames (will |
13 | value represents a filename. | 12 | also be applied even if the option is not really a filename). |
14 | .B | ||
15 | .IP "\-s SECTION, \-\-section=SECTION" | 13 | .IP "\-s SECTION, \-\-section=SECTION" |
16 | Which configuration section should be accessed or edited. Required option. | 14 | Which configuration section should be accessed or edited. Required option. |
17 | .B | ||
18 | .IP "\-S, \-\-list\-sections" | 15 | .IP "\-S, \-\-list\-sections" |
19 | List available configuration sections for use with \-\-section. | 16 | List available configuration sections for use with \-\-section. |
20 | .B | ||
21 | .IP "\-W, \-\-rewrite" | 17 | .IP "\-W, \-\-rewrite" |
22 | Consider differences to defaults only. | 18 | Consider differences to defaults only. |
23 | .B | ||
24 | .IP "\-o OPTION, \-\-option=OPTION" | 19 | .IP "\-o OPTION, \-\-option=OPTION" |
25 | Which configuration option should be accessed or edited. Required to set a value. | 20 | Which configuration option should be accessed or edited. Required to set a value. |
26 | If not given, all values of a given section will be printed in the | 21 | If not given, all values of a given section will be printed in the |
27 | format "OPTION = VALUE". | 22 | format "OPTION = VALUE". |
28 | .B | ||
29 | .IP "\-V VALUE, \-\-value VALUE" | 23 | .IP "\-V VALUE, \-\-value VALUE" |
30 | Configuration value to store in the given section under the given option. | 24 | Configuration value to store in the given section under the given option. |
31 | Must only be given together with \-s and \-o options. | 25 | Must only be given together with \-s and \-o options. |
32 | .B | ||
33 | .IP "\-c FILENAME, \-\-config=FILENAME" | 26 | .IP "\-c FILENAME, \-\-config=FILENAME" |
34 | Use the configuration file FILENAME. | 27 | Use the configuration file FILENAME. |
35 | .B | ||
36 | .IP "\-h, \-\-help" | 28 | .IP "\-h, \-\-help" |
37 | Print short help on options. | 29 | Print short help on options. |
38 | .B | ||
39 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 30 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
40 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 31 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
41 | .B | ||
42 | .IP "\-v, \-\-version" | 32 | .IP "\-v, \-\-version" |
43 | Print GNUnet version number. | 33 | Print GNUnet version number. |
44 | .SH BUGS | 34 | .SH BUGS |
diff --git a/doc/man/gnunet-conversation-test.1 b/doc/man/gnunet-conversation-test.1 index 5c08d3dab..477da5042 100644 --- a/doc/man/gnunet-conversation-test.1 +++ b/doc/man/gnunet-conversation-test.1 | |||
@@ -17,17 +17,13 @@ known to your computer). | |||
17 | You can use gnunet\-conversation\-test without having a peer running | 17 | You can use gnunet\-conversation\-test without having a peer running |
18 | on your computer. | 18 | on your computer. |
19 | .SH OPTIONS | 19 | .SH OPTIONS |
20 | .B | ||
21 | .IP "\-c FILENAME, \-\-config=FILENAME" | 20 | .IP "\-c FILENAME, \-\-config=FILENAME" |
22 | Use the configuration file FILENAME. | 21 | Use the configuration file FILENAME. |
23 | .B | ||
24 | .IP "\-h, \-\-help" | 22 | .IP "\-h, \-\-help" |
25 | Print short help on options. | 23 | Print short help on options. |
26 | .B | ||
27 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
28 | Use LOGLEVEL for logging. | 25 | Use LOGLEVEL for logging. |
29 | Valid values are DEBUG, INFO, WARNING and ERROR. | 26 | Valid values are DEBUG, INFO, WARNING and ERROR. |
30 | .B | ||
31 | .IP "\-v, \-\-version" | 27 | .IP "\-v, \-\-version" |
32 | Print GNUnet version number. | 28 | Print GNUnet version number. |
33 | .SH BUGS | 29 | .SH BUGS |
diff --git a/doc/man/gnunet-conversation.1 b/doc/man/gnunet-conversation.1 index 5925871da..3815b3887 100644 --- a/doc/man/gnunet-conversation.1 +++ b/doc/man/gnunet-conversation.1 | |||
@@ -15,25 +15,19 @@ your zone in the GNU Name System (using gnunet\-namestore). | |||
15 | gnunet\-conversation has an interactive help system via the /help | 15 | gnunet\-conversation has an interactive help system via the /help |
16 | command. | 16 | command. |
17 | .SH OPTIONS | 17 | .SH OPTIONS |
18 | .B | ||
19 | .IP "\-c FILENAME, \-\-config=FILENAME" | 18 | .IP "\-c FILENAME, \-\-config=FILENAME" |
20 | Use the configuration file FILENAME. | 19 | Use the configuration file FILENAME. |
21 | .B | ||
22 | .IP "\-e NAME, \-\-ego=NAME" | 20 | .IP "\-e NAME, \-\-ego=NAME" |
23 | Specifies the NAME of the ego to use (for caller ID). | 21 | Specifies the NAME of the ego to use (for caller ID). |
24 | .B | ||
25 | .IP "\-h, \-\-help" | 22 | .IP "\-h, \-\-help" |
26 | Print short help on options. | 23 | Print short help on options. |
27 | .B | ||
28 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
29 | Use LOGLEVEL for logging. | 25 | Use LOGLEVEL for logging. |
30 | Valid values are DEBUG, INFO, WARNING and ERROR. | 26 | Valid values are DEBUG, INFO, WARNING and ERROR. |
31 | .B | ||
32 | .IP "\-p LINE, \-\-phone=LINE" | 27 | .IP "\-p LINE, \-\-phone=LINE" |
33 | Optional argument that can be used to specify the phone LINE to be used with | 28 | Optional argument that can be used to specify the phone LINE to be used with |
34 | the conversation service. | 29 | the conversation service. |
35 | The default LINE is zero, which should be fine for most users. | 30 | The default LINE is zero, which should be fine for most users. |
36 | .B | ||
37 | .IP "\-v, \-\-version" | 31 | .IP "\-v, \-\-version" |
38 | Print GNUnet version number. | 32 | Print GNUnet version number. |
39 | .SH BUGS | 33 | .SH BUGS |
diff --git a/doc/man/gnunet-dns2gns.1 b/doc/man/gnunet-dns2gns.1 index 552df25b6..f61a0a8b3 100644 --- a/doc/man/gnunet-dns2gns.1 +++ b/doc/man/gnunet-dns2gns.1 | |||
@@ -1,60 +1,60 @@ | |||
1 | .TH GNUNET\-DNS2GNS 1 "March 5, 2018" "GNUnet" | 1 | .Dd March 5, 2018 |
2 | 2 | .Dt GNUNET-DNS2GNS 1 | |
3 | .SH NAME | 3 | .Os |
4 | gnunet\-dns2gns \- run a DNS-to-GNS proxy | 4 | .Sh NAME |
5 | 5 | .Nm gnunet-dns2gns | |
6 | .SH SYNOPSIS | 6 | .Nd |
7 | .B gnunet\-dns2gns | 7 | run a DNS-to-GNS proxy |
8 | .RI [ options ] | 8 | .Sh SYNOPSIS |
9 | .br | 9 | .Nm |
10 | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | |
11 | .SH DESCRIPTION | 11 | .Op Fl d Ar IP | Fl \-dns= Ns Ar IP |
12 | Most users will not want to run an DNS to GNS proxy/gateway and thus will not | 12 | .Op Fl h | \-help |
13 | need this program. | 13 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
14 | 14 | .Op Fl v | \-version | |
15 | \fBgnunet\-dns2gns\fP runs a DNS resolver which delegates requests GNS if | 15 | .Sh DESCRIPTION |
16 | the TLD matches one configured for GNS. All other requests are forwarded | 16 | .Nm |
17 | to DNS. This DNS proxy is useful for enabling non-personalized | 17 | runs a DNS resolver which delegates requests GNS if the TLD matches one configured for GNS. |
18 | GNS\-resolution to an entire network or to offer GNS\-resolution to DNS users. | 18 | All other requests are forwarded to DNS. |
19 | 19 | This DNS proxy is useful for enabling non-personalized GNS\-resolution to an entire network or to offer GNS\-resolution to DNS users. | |
20 | .SH OPTIONS | 20 | .Bl -tag -width Ds |
21 | .B | 21 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
22 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
23 | Use the configuration file FILENAME. | 22 | Use the configuration file FILENAME. |
24 | .B | 23 | .It Fl d Ar IP | Fl \-dns= Ns Ar IP |
25 | .IP "\-d IP, \-\-dns=IP" | ||
26 | IP address of a recursive DNS resolver that should be used for non-GADS hostnames. | 24 | IP address of a recursive DNS resolver that should be used for non-GADS hostnames. |
27 | .B | 25 | .It Fl h | \-help |
28 | .IP "\-h, \-\-help" | ||
29 | Print short help on options. | 26 | Print short help on options. |
30 | .B | 27 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
31 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 28 | Use LOGLEVEL for logging. |
32 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 29 | Valid values are DEBUG, INFO, WARNING and ERROR. |
33 | .B | 30 | .It Fl v | \-version |
34 | .IP "\-v, \-\-version" | ||
35 | Print GNUnet version number. | 31 | Print GNUnet version number. |
36 | 32 | .El | |
37 | .SH BUGS | 33 | .Sh SEE ALSO |
38 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 34 | .Xr gnunet-gns-fcfs 1 , |
39 | electronic mail to <bug\-gnunet@gnu.org> | 35 | .Xr gnunet-gns 1 , |
40 | .SH SEE ALSO | 36 | .Xr gnunet-identity 1 |
41 | gnunet\-gns\-fcfs(1), gnunet\-gns(1), gnunet\-identity(1) | 37 | .sp |
42 | The full documentation for | 38 | The full documentation for gnunet is maintained as a Texinfo manual. |
43 | .B gnunet | 39 | If the |
44 | is maintained as a Texinfo manual. If the | 40 | .Xr info 1 |
45 | .B info | 41 | and gnunet programs are properly installed at your site, the command |
46 | and | 42 | .Pp |
47 | .B gnunet | 43 | .Dl info gnunet |
48 | programs are properly installed at your site, the command | 44 | .Pp |
49 | .IP | ||
50 | .B info gnunet | ||
51 | .PP | ||
52 | should give you access to the complete handbook, | 45 | should give you access to the complete handbook, |
53 | .IP | 46 | .Pp |
54 | .B info gnunet-c-tutorial | 47 | .Dl info gnunet-c-tutorial |
55 | .PP | 48 | .Pp |
56 | will give you access to a tutorial for developers. | 49 | will give you access to a tutorial for developers. |
57 | .PP | 50 | .sp |
58 | Depending on your installation, this information is also | 51 | Depending on your installation, this information is also available in |
59 | available in | 52 | .Xr gnunet 7 and |
60 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 53 | .Xr gnunet-c-tutorial 7 . |
54 | .\".Sh HISTORY | ||
55 | .\".Sh AUTHORS | ||
56 | .Sh BUGS | ||
57 | Report bugs by using | ||
58 | .Lk https://bugs.gnunet.org | ||
59 | or by sending electronic mail to | ||
60 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-ecc.1 b/doc/man/gnunet-ecc.1 index aedc0bc49..2aa7743b2 100644 --- a/doc/man/gnunet-ecc.1 +++ b/doc/man/gnunet-ecc.1 | |||
@@ -17,33 +17,25 @@ take a while. If the option \-p is given, the corresponding public | |||
17 | key will be printed to the console. | 17 | key will be printed to the console. |
18 | 18 | ||
19 | .SH OPTIONS | 19 | .SH OPTIONS |
20 | .B | ||
21 | .IP "\-g COUNT, \-\-generate-keys=COUNT" | 20 | .IP "\-g COUNT, \-\-generate-keys=COUNT" |
22 | Create COUNT public-private key pairs and write them to FILENAME. | 21 | Create COUNT public-private key pairs and write them to FILENAME. |
23 | Used for creating a file for testing. | 22 | Used for creating a file for testing. |
24 | .B | ||
25 | .IP "\-p, \-\-print-public-key" | 23 | .IP "\-p, \-\-print-public-key" |
26 | Print the corresponding public key to stdout. This is the value used | 24 | Print the corresponding public key to stdout. This is the value used |
27 | for PKEY records in GNS. | 25 | for PKEY records in GNS. |
28 | .B | ||
29 | .IP "\-P, \-\-print-private-key" | 26 | .IP "\-P, \-\-print-private-key" |
30 | Print the corresponding private key to stdout. This is the value used | 27 | Print the corresponding private key to stdout. This is the value used |
31 | for PKEY records in GNS. | 28 | for PKEY records in GNS. |
32 | .B | ||
33 | .IP "\-x, \-\-print-hex" | 29 | .IP "\-x, \-\-print-hex" |
34 | Print the corresponding public key to stdout in HEX format. Useful | 30 | Print the corresponding public key to stdout in HEX format. Useful |
35 | for comparing to Ed25519 keys in X.509 tools. | 31 | for comparing to Ed25519 keys in X.509 tools. |
36 | .B | ||
37 | .IP "\-c FILENAME, \-\-config=FILENAME" | 32 | .IP "\-c FILENAME, \-\-config=FILENAME" |
38 | Use the configuration file FILENAME. | 33 | Use the configuration file FILENAME. |
39 | .B | ||
40 | .IP "\-h, \-\-help" | 34 | .IP "\-h, \-\-help" |
41 | Print short help on options. | 35 | Print short help on options. |
42 | .B | ||
43 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 36 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
44 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 37 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
45 | ERROR. | 38 | ERROR. |
46 | .B | ||
47 | .IP "\-v, \-\-version" | 39 | .IP "\-v, \-\-version" |
48 | Print GNUnet version number. | 40 | Print GNUnet version number. |
49 | 41 | ||
diff --git a/doc/man/gnunet-gns-proxy-setup-ca.1 b/doc/man/gnunet-gns-proxy-setup-ca.1 new file mode 100644 index 000000000..54df856eb --- /dev/null +++ b/doc/man/gnunet-gns-proxy-setup-ca.1 | |||
@@ -0,0 +1,64 @@ | |||
1 | .Dd March 6, 2019 | ||
2 | .Dt GNUNET-GNS-PROXY-SETUP-CA 1 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm gnunet-gns-proxy-setup-ca | ||
6 | .Nd generate an X509 certificate for gnunet-gns-proxy and install it | ||
7 | .Sh SYNOPSIS | ||
8 | .Nm | ||
9 | .Op Fl c Ar FILE | ||
10 | .\".Op Fl f Ar FILE | ||
11 | .Op Fl h | ||
12 | .Op Fl v | ||
13 | .Op Fl V | ||
14 | .Sh DESCRIPTION | ||
15 | .Nm | ||
16 | is a shell script to generate X509 certificates for your gnunet-gns-proxy and to install it for both GNUnet and your web browser. | ||
17 | It currently supports Firefox and Chrome based browsers through the help of external helpers: certutil (nss) is used for the import into webbrowsers, openssl is used to generated the CA. | ||
18 | .Bl -tag -width Ds | ||
19 | .It Fl c Ar FILE | ||
20 | Use the configuration file FILE. | ||
21 | .\" .It Fl f | ||
22 | .\" Perform expansions of the variables used in the config value of gns-proxy. | ||
23 | .\" This will usually expand $GNUNET_DATA_HOME to represents its path. | ||
24 | .It Fl h | ||
25 | Print short help on options | ||
26 | .It Fl v | ||
27 | Print the version | ||
28 | .It Fl V | ||
29 | be verbose | ||
30 | .El | ||
31 | .Sh FILES | ||
32 | .Pa gnunet.conf | ||
33 | .Sh SEE ALSO | ||
34 | .Xr gnunet-gns 1 , | ||
35 | .Xr gnunet-gns-proxy 1 , | ||
36 | .Xr gnunet.conf 5 | ||
37 | .sp | ||
38 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
39 | If the | ||
40 | .Xr info 1 | ||
41 | and gnunet programs are properly installed at your site, the command | ||
42 | .Bd -literal -offset indent -compact | ||
43 | info gnunet | ||
44 | .Ed | ||
45 | should give you access to the complete handbook, | ||
46 | .Bd -literal -offset indent -compact | ||
47 | info gnunet-c-tutorial | ||
48 | .Ed | ||
49 | will give you access to a tutorial for developers. | ||
50 | .sp | ||
51 | Depending on your installation, this information is also | ||
52 | available in | ||
53 | .Xr gnunet 7 and | ||
54 | .Xr gnunet-c-tutorial 7 . | ||
55 | .Sh HISTORY | ||
56 | This man page first appeared in GNUnet 0.11.1. | ||
57 | .Sh AUTHORS | ||
58 | This page was written by | ||
59 | .An ng0 Aq Mt ng0@gnunet.org . | ||
60 | .Sh BUGS | ||
61 | Report bugs by using | ||
62 | .Lk https://bugs.gnunet.org | ||
63 | or by sending electronic mail to | ||
64 | .Aq Mt bug-gnunet@gnu.org . | ||
diff --git a/doc/man/gnunet-gns-proxy.1 b/doc/man/gnunet-gns-proxy.1 index 6c12e2c09..603c5a28c 100644 --- a/doc/man/gnunet-gns-proxy.1 +++ b/doc/man/gnunet-gns-proxy.1 | |||
@@ -15,26 +15,20 @@ CA certificate has to be generated that is used by the proxy. Thus | |||
15 | of this proxy or the \-\-authority switch is used to specify an | 15 | of this proxy or the \-\-authority switch is used to specify an |
16 | appropriate CA certificate that is already trusted by the browser. | 16 | appropriate CA certificate that is already trusted by the browser. |
17 | .SH OPTIONS | 17 | .SH OPTIONS |
18 | .B | ||
19 | .IP "\-c FILENAME, \-\-config=FILENAME" | 18 | .IP "\-c FILENAME, \-\-config=FILENAME" |
20 | Use the configuration file FILENAME. | 19 | Use the configuration file FILENAME. |
21 | .B | ||
22 | .IP "\-a AUTHORITY, \-\-authority=AUTHORITY" | 20 | .IP "\-a AUTHORITY, \-\-authority=AUTHORITY" |
23 | Path to a PEM CA file that contains the certificate and private key of | 21 | Path to a PEM CA file that contains the certificate and private key of |
24 | the CA to use to assert the validity of GNS names. The default port is | 22 | the CA to use to assert the validity of GNS names. The default port is |
25 | specified in the configuration file for the gns service under | 23 | specified in the configuration file for the gns service under |
26 | "[gns-proxy]" PROXY_CACERT. | 24 | "[gns-proxy]" PROXY_CACERT. |
27 | .B | ||
28 | .IP "\-p PORT, \-\-port=PORT" | 25 | .IP "\-p PORT, \-\-port=PORT" |
29 | The port this proxy should listen on. Default is 7777. | 26 | The port this proxy should listen on. Default is 7777. |
30 | .B | ||
31 | .IP "\-h, \-\-help" | 27 | .IP "\-h, \-\-help" |
32 | Print short help on options. | 28 | Print short help on options. |
33 | .B | ||
34 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 29 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
35 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 30 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
36 | ERROR. | 31 | ERROR. |
37 | .B | ||
38 | .IP "\-v, \-\-version" | 32 | .IP "\-v, \-\-version" |
39 | Print GNUnet version number. | 33 | Print GNUnet version number. |
40 | .SH BUGS | 34 | .SH BUGS |
diff --git a/doc/man/gnunet-gns.1 b/doc/man/gnunet-gns.1 index 597297629..750c72d95 100644 --- a/doc/man/gnunet-gns.1 +++ b/doc/man/gnunet-gns.1 | |||
@@ -8,33 +8,26 @@ gnunet\-gns \- Access to GNU Name System | |||
8 | \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 |
9 | names. | 9 | names. |
10 | .SH OPTIONS | 10 | .SH OPTIONS |
11 | .B | ||
12 | .IP "\-c FILENAME, \-\-config=FILENAME" | 11 | .IP "\-c FILENAME, \-\-config=FILENAME" |
13 | Use the configuration file FILENAME. | 12 | Use the configuration file FILENAME. |
14 | .B | ||
15 | .IP "\-r, \-\-raw" | 13 | .IP "\-r, \-\-raw" |
16 | No unneeded output. | 14 | No unneeded output. |
17 | This is a quiet mode where only important information is displayed. | 15 | This is a quiet mode where only important information is displayed. |
18 | For example a lookup for an IP address will only yield the IP address, | 16 | For example a lookup for an IP address will only yield the IP address, |
19 | no descriptive text. | 17 | no descriptive text. |
20 | .B | ||
21 | .IP "\-h, \-\-help" | 18 | .IP "\-h, \-\-help" |
22 | Print short help on options. | 19 | Print short help on options. |
23 | .B | ||
24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 20 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
25 | Use LOGLEVEL for logging. | 21 | Use LOGLEVEL for logging. |
26 | Valid values are DEBUG, INFO, WARNING and ERROR. | 22 | Valid values are DEBUG, INFO, WARNING and ERROR. |
27 | .B | ||
28 | .IP "\-u NAME, \-\-lookup=NAME" | 23 | .IP "\-u NAME, \-\-lookup=NAME" |
29 | Name to lookup. | 24 | Name to lookup. |
30 | Resolve the specified name using the GNU Name System. | 25 | Resolve the specified name using the GNU Name System. |
31 | .B | ||
32 | .IP "\-t TYPE, \-\-type=TYPE" | 26 | .IP "\-t TYPE, \-\-type=TYPE" |
33 | Resource Record Type (TYPE) to look for. | 27 | Resource Record Type (TYPE) to look for. |
34 | Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, | 28 | Supported TYPE's are: A, AAAA, CNAME, NS, PKEY, PSEU, TLSA, SRV, SOA, |
35 | MX, LEHO, VPN, REV, PTR, TXT. | 29 | MX, LEHO, VPN, REV, PTR, TXT. |
36 | Defaults to "A". | 30 | Defaults to "A". |
37 | .B | ||
38 | .IP "\-v, \-\-version" | 31 | .IP "\-v, \-\-version" |
39 | Print GNUnet version number. | 32 | Print GNUnet version number. |
40 | .SH RETURN VALUE | 33 | .SH RETURN VALUE |
diff --git a/doc/man/gnunet-namecache.1 b/doc/man/gnunet-namecache.1 index 78acb017b..06946e387 100644 --- a/doc/man/gnunet-namecache.1 +++ b/doc/man/gnunet-namecache.1 | |||
@@ -13,23 +13,17 @@ gnunet\-namecache \- inspect namecache | |||
13 | namecache. | 13 | namecache. |
14 | 14 | ||
15 | .SH OPTIONS | 15 | .SH OPTIONS |
16 | .B | ||
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | 16 | .IP "\-c FILENAME, \-\-config=FILENAME" |
18 | Use the configuration file FILENAME. | 17 | Use the configuration file FILENAME. |
19 | .B | ||
20 | .IP "\-h, \-\-help" | 18 | .IP "\-h, \-\-help" |
21 | Print short help on options. | 19 | Print short help on options. |
22 | .B | ||
23 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 20 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
24 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 21 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
25 | ERROR. | 22 | ERROR. |
26 | .B | ||
27 | .IP "\-n NAME, \-\-name=NAME" | 23 | .IP "\-n NAME, \-\-name=NAME" |
28 | Name (label) of the record to display (mandatory option) | 24 | Name (label) of the record to display (mandatory option) |
29 | .B | ||
30 | .IP "\-v, \-\-version" | 25 | .IP "\-v, \-\-version" |
31 | Print GNUnet version number. | 26 | Print GNUnet version number. |
32 | .B | ||
33 | .IP "\-z PKEY, \-\-zone=PKEY" | 27 | .IP "\-z PKEY, \-\-zone=PKEY" |
34 | Specifies the public key of the zone to inspect (mandatory option) | 28 | Specifies the public key of the zone to inspect (mandatory option) |
35 | 29 | ||
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1 index a6c9d2b32..c1eca224f 100644 --- a/doc/man/gnunet-namestore-fcfsd.1 +++ b/doc/man/gnunet-namestore-fcfsd.1 | |||
@@ -27,20 +27,15 @@ pseudonym (using "gnunet\-identity \-C NAME"), and use it with the | |||
27 | "-z" option. After that, you can start the FCFSD service (possibly using | 27 | "-z" option. After that, you can start the FCFSD service (possibly using |
28 | gnunet\-arm). | 28 | gnunet\-arm). |
29 | .SH OPTIONS | 29 | .SH OPTIONS |
30 | .B | ||
31 | .IP "\-c FILENAME, \-\-config=FILENAME" | 30 | .IP "\-c FILENAME, \-\-config=FILENAME" |
32 | Use the configuration file FILENAME. | 31 | Use the configuration file FILENAME. |
33 | .B | ||
34 | .IP "\-h, \-\-help" | 32 | .IP "\-h, \-\-help" |
35 | Print short help on options. | 33 | Print short help on options. |
36 | .B | ||
37 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 34 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
38 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 35 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
39 | ERROR. | 36 | ERROR. |
40 | .B | ||
41 | .IP "\-v, \-\-version" | 37 | .IP "\-v, \-\-version" |
42 | Print GNUnet version number. | 38 | Print GNUnet version number. |
43 | .B | ||
44 | .IP "\-z EGO, \-\-zone=EGO" | 39 | .IP "\-z EGO, \-\-zone=EGO" |
45 | Specifies for which EGO should FCFSD manage the zone. | 40 | Specifies for which EGO should FCFSD manage the zone. |
46 | .SH BUGS | 41 | .SH BUGS |
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 7517a4f5e..6a824cc47 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 | |||
@@ -12,13 +12,10 @@ gnunet\-namestore \- manipulate GNU Name System (GNS) zone data | |||
12 | \fBgnunet\-namestore\fP can be used to manipulate records in a GNS zone. | 12 | \fBgnunet\-namestore\fP can be used to manipulate records in a GNS zone. |
13 | 13 | ||
14 | .SH OPTIONS | 14 | .SH OPTIONS |
15 | .B | ||
16 | .IP "\-a, \-\-add" | 15 | .IP "\-a, \-\-add" |
17 | Desired operation is adding a record | 16 | Desired operation is adding a record |
18 | .B | ||
19 | .IP "\-c FILENAME, \-\-config=FILENAME" | 17 | .IP "\-c FILENAME, \-\-config=FILENAME" |
20 | Use the configuration file FILENAME. | 18 | Use the configuration file FILENAME. |
21 | .B | ||
22 | .IP "\-d, \-\-delete" | 19 | .IP "\-d, \-\-delete" |
23 | Desired operation is deleting records under the given name that match | 20 | Desired operation is deleting records under the given name that match |
24 | the specified type (\-t) and value (\-V). If type or value are not | 21 | the specified type (\-t) and value (\-V). If type or value are not |
@@ -26,41 +23,31 @@ specified, it means that all types (or values) should be assumed to | |||
26 | match (and possibly multiple or all values under the given label will | 23 | match (and possibly multiple or all values under the given label will |
27 | be deleted). Specifying a label (\-n) is mandatory. Note that | 24 | be deleted). Specifying a label (\-n) is mandatory. Note that |
28 | matching by expiration time or flags is (currently) not supported. | 25 | matching by expiration time or flags is (currently) not supported. |
29 | .B | ||
30 | .IP "\-D, \-\-display" | 26 | .IP "\-D, \-\-display" |
31 | Desired operation is listing of matching records | 27 | Desired operation is listing of matching records |
32 | .B | ||
33 | .IP "\-e TIME, \-\-expiration=TIME" | 28 | .IP "\-e TIME, \-\-expiration=TIME" |
34 | Specifies expiration time of record to add; format is relative time, | 29 | Specifies expiration time of record to add; format is relative time, |
35 | i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or | 30 | i.e "1 h" or "7 d 30 m". Supported units are "ms", "s", "min" or |
36 | "minutes", "h" (hours), "d" (days) and "a" (years). | 31 | "minutes", "h" (hours), "d" (days) and "a" (years). |
37 | .B | ||
38 | .IP "\-h, \-\-help" | 32 | .IP "\-h, \-\-help" |
39 | Print short help on options. | 33 | Print short help on options. |
40 | .B | ||
41 | .IP "\-i NICKNAME, \-\-nick=NICKNAME" | 34 | .IP "\-i NICKNAME, \-\-nick=NICKNAME" |
42 | Set the desired NICKNAME for the zone. The nickname will be included | 35 | Set the desired NICKNAME for the zone. The nickname will be included |
43 | in all (public) records and used as the suggested name for this zone. | 36 | in all (public) records and used as the suggested name for this zone. |
44 | .B | ||
45 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 37 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
46 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 38 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
47 | ERROR. | 39 | ERROR. |
48 | .B | ||
49 | .IP "\-m, \-\-monitor" | 40 | .IP "\-m, \-\-monitor" |
50 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, | 41 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, |
51 | which merely displays the current records) | 42 | which merely displays the current records) |
52 | .B | ||
53 | .IP "\-n NAME, \-\-name=NAME" | 43 | .IP "\-n NAME, \-\-name=NAME" |
54 | Label or name of the record to add/delete/display | 44 | Label or name of the record to add/delete/display |
55 | .B | ||
56 | .IP "\-p, \-\-public" | 45 | .IP "\-p, \-\-public" |
57 | Create a record that is public (shared with other users that know the | 46 | Create a record that is public (shared with other users that know the |
58 | label) | 47 | label) |
59 | .B | ||
60 | .IP "\-r PKEY, \-\-reverse=PKEY" | 48 | .IP "\-r PKEY, \-\-reverse=PKEY" |
61 | Determine our GNS name for the given public key (reverse lookup of the | 49 | Determine our GNS name for the given public key (reverse lookup of the |
62 | PKEY) in the given zone. | 50 | PKEY) in the given zone. |
63 | .B | ||
64 | .IP "\-R RECORDLINE, \-\-replace=RECORDLINE" | 51 | .IP "\-R RECORDLINE, \-\-replace=RECORDLINE" |
65 | Sets record set to values given in RECORDLINE. This option can be specified multiple | 52 | Sets record set to values given in RECORDLINE. This option can be specified multiple |
66 | times to provide multiple records for the record set. Existing records under the | 53 | times to provide multiple records for the record set. Existing records under the |
@@ -69,29 +56,23 @@ same label will be deleted. The format for the RECORDLINE is | |||
69 | be given explicitly, seconds is always implied), TYPE is the | 56 | be given explicitly, seconds is always implied), TYPE is the |
70 | DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". The VALUE | 57 | DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". The VALUE |
71 | follows the usual human-readable value format(s) of DNS/GNS. | 58 | follows the usual human-readable value format(s) of DNS/GNS. |
72 | .B | ||
73 | .IP "\-s, \-\-shadow" | 59 | .IP "\-s, \-\-shadow" |
74 | Create a record that is a shadow record. Shadow records are only used | 60 | Create a record that is a shadow record. Shadow records are only used |
75 | once all other records of the same type under the same label have | 61 | once all other records of the same type under the same label have |
76 | expired. | 62 | expired. |
77 | .B | ||
78 | .IP "\-t TYPE, \-\-type=TYPE" | 63 | .IP "\-t TYPE, \-\-type=TYPE" |
79 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", | 64 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", |
80 | "PKEY", "MX" etc.) | 65 | "PKEY", "MX" etc.) |
81 | .B | ||
82 | .IP "\-u URI, \-\-uri=URI" | 66 | .IP "\-u URI, \-\-uri=URI" |
83 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is | 67 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is |
84 | always PKEY, if no expiration is given FOREVER is used | 68 | always PKEY, if no expiration is given FOREVER is used |
85 | .B | ||
86 | .IP "\-v, \-\-version" | 69 | .IP "\-v, \-\-version" |
87 | Print GNUnet version number. | 70 | Print GNUnet version number. |
88 | .B | ||
89 | .IP "\-V VALUE, \-\-value=VALUE" | 71 | .IP "\-V VALUE, \-\-value=VALUE" |
90 | Value to store or remove from the GNS zone. Specific format depends | 72 | Value to store or remove from the GNS zone. Specific format depends |
91 | on the record type. A records expect a dotted decimal IPv4 address, | 73 | on the record type. A records expect a dotted decimal IPv4 address, |
92 | AAAA records an IPv6 address, PKEY a public key in GNUnet's printable | 74 | AAAA records an IPv6 address, PKEY a public key in GNUnet's printable |
93 | format, and CNAME and NS records should be a domain name. | 75 | format, and CNAME and NS records should be a domain name. |
94 | .B | ||
95 | .IP "\-z EGO, \-\-zone=EGO" | 76 | .IP "\-z EGO, \-\-zone=EGO" |
96 | Specifies the name of the ego controlling the private key for the zone | 77 | Specifies the name of the ego controlling the private key for the zone |
97 | (mandatory option) | 78 | (mandatory option) |
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1 index 8514a5c99..efd4b5df1 100644 --- a/doc/man/gnunet-nat-auto.1 +++ b/doc/man/gnunet-nat-auto.1 | |||
@@ -8,22 +8,17 @@ gnunet\-nat\-auto \- autoconfigure and test NAT traversal | |||
8 | This tool allows testing various NAT traversal functions, as well | 8 | This tool allows testing various NAT traversal functions, as well |
9 | as attempting auto\-configuration. | 9 | as attempting auto\-configuration. |
10 | .SH OPTIONS | 10 | .SH OPTIONS |
11 | .B | ||
12 | .IP "\-a, \-\-auto" | 11 | .IP "\-a, \-\-auto" |
13 | Attempt auto\-configuration for NAT traversal. | 12 | Attempt auto\-configuration for NAT traversal. |
14 | .B | ||
15 | .IP "\-c FILENAME, \-\-config=FILENAME" | 13 | .IP "\-c FILENAME, \-\-config=FILENAME" |
16 | Use the configuration file FILENAME. | 14 | Use the configuration file FILENAME. |
17 | .B | ||
18 | .IP "\-S NAME, \-\-section=NAME" | 15 | .IP "\-S NAME, \-\-section=NAME" |
19 | Name of the configuration section with details about the configuration | 16 | Name of the configuration section with details about the configuration |
20 | to test. For example "transport-tcp". | 17 | to test. For example "transport-tcp". |
21 | .IP "\-t, \-\-tcp" | 18 | .IP "\-t, \-\-tcp" |
22 | Use TCP. | 19 | Use TCP. |
23 | .B | ||
24 | .IP "\-u, \-\-udp" | 20 | .IP "\-u, \-\-udp" |
25 | Use UDP. | 21 | Use UDP. |
26 | .B | ||
27 | .IP "\-w, \-\-write" | 22 | .IP "\-w, \-\-write" |
28 | Write configuration to configuration file, useful in combination with | 23 | Write configuration to configuration file, useful in combination with |
29 | autoconfiguration (\-a). | 24 | autoconfiguration (\-a). |
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1 index f31e69b26..8cb995f7c 100644 --- a/doc/man/gnunet-nat-server.1 +++ b/doc/man/gnunet-nat-server.1 | |||
@@ -41,7 +41,6 @@ gnunet\-nat\-server is run on should be specified in the NATSERVER | |||
41 | option in the [setup] section of the configuration file of hosts that | 41 | option in the [setup] section of the configuration file of hosts that |
42 | are supposed to autoconfigure with this server. | 42 | are supposed to autoconfigure with this server. |
43 | .SH OPTIONS | 43 | .SH OPTIONS |
44 | .B | ||
45 | .IP "\-c FILENAME, \-\-config=FILENAME" | 44 | .IP "\-c FILENAME, \-\-config=FILENAME" |
46 | Use the configuration file FILENAME. | 45 | Use the configuration file FILENAME. |
47 | .SH BUGS | 46 | .SH BUGS |
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1 index 4a6a56e97..fe9272ea5 100644 --- a/doc/man/gnunet-nat.1 +++ b/doc/man/gnunet-nat.1 | |||
@@ -8,38 +8,28 @@ gnunet\-nat \- interact with the NAT service | |||
8 | This tool allows testing various NAT traversal functions, as well as | 8 | This tool allows testing various NAT traversal functions, as well as |
9 | attempting auto\-configuration. | 9 | attempting auto\-configuration. |
10 | .SH OPTIONS | 10 | .SH OPTIONS |
11 | .B | ||
12 | .IP "\-b ADDRESS, \-\-bind=ADDRESS" | 11 | .IP "\-b ADDRESS, \-\-bind=ADDRESS" |
13 | Assume that the service is (locally) bound to ADDRESS. | 12 | Assume that the service is (locally) bound to ADDRESS. |
14 | .B | ||
15 | .IP "\-c FILENAME, \-\-config=FILENAME" | 13 | .IP "\-c FILENAME, \-\-config=FILENAME" |
16 | Use the configuration file FILENAME. | 14 | Use the configuration file FILENAME. |
17 | .B | ||
18 | .IP "\-e ADDRESS, \-\-external=ADDRESS" | 15 | .IP "\-e ADDRESS, \-\-external=ADDRESS" |
19 | Assume that ADDRESS is the globally visible address of the peer. | 16 | Assume that ADDRESS is the globally visible address of the peer. |
20 | .B | ||
21 | .IP "\-i ADDRESS, \-\-in=ADDRESS" | 17 | .IP "\-i ADDRESS, \-\-in=ADDRESS" |
22 | Assuming we are listening at ADDRESS for connection reversal requests. | 18 | Assuming we are listening at ADDRESS for connection reversal requests. |
23 | .B | ||
24 | .IP "\-r ADDRESS, \-\-remote=ADDRESS" | 19 | .IP "\-r ADDRESS, \-\-remote=ADDRESS" |
25 | Ask the peer at ADDRESS for connection reversal, using the local | 20 | Ask the peer at ADDRESS for connection reversal, using the local |
26 | address for the target address of the reversal. | 21 | address for the target address of the reversal. |
27 | .B | ||
28 | .IP "\-S NAME, \-\-section=NAME" | 22 | .IP "\-S NAME, \-\-section=NAME" |
29 | Name of section in configuration file to use for additional options. | 23 | Name of section in configuration file to use for additional options. |
30 | .B | ||
31 | .IP "\-s, \-\-stun" | 24 | .IP "\-s, \-\-stun" |
32 | Enable processing of STUN requests. | 25 | Enable processing of STUN requests. |
33 | Will try to read UDP packets from the bind address and handle the | 26 | Will try to read UDP packets from the bind address and handle the |
34 | packets if they are STUN packets. | 27 | packets if they are STUN packets. |
35 | Will only work with UDP. | 28 | Will only work with UDP. |
36 | .B | ||
37 | .IP "\-t, \-\-tcp" | 29 | .IP "\-t, \-\-tcp" |
38 | Use TCP. | 30 | Use TCP. |
39 | .B | ||
40 | .IP "\-u, \-\-udp" | 31 | .IP "\-u, \-\-udp" |
41 | Use UDP. | 32 | Use UDP. |
42 | .B | ||
43 | .IP "\-W, \-\-watch" | 33 | .IP "\-W, \-\-watch" |
44 | Watch for connection reversal requests. | 34 | Watch for connection reversal requests. |
45 | .SH EXAMPLES | 35 | .SH EXAMPLES |
diff --git a/doc/man/gnunet-nse.1 b/doc/man/gnunet-nse.1 new file mode 100644 index 000000000..151ba4957 --- /dev/null +++ b/doc/man/gnunet-nse.1 | |||
@@ -0,0 +1,65 @@ | |||
1 | .Dd March 6, 2019 | ||
2 | .Dt GNUNET-NSE 1 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm gnunet-nse | ||
6 | .Nd show network size estimates from NSE service | ||
7 | .Sh SYNOPSIS | ||
8 | .Nm | ||
9 | .Op Fl c Ar file | Fl -config Ns = Ns file | ||
10 | .Op Fl h | \-help | ||
11 | .Op Fl l file | Fl -logfile Ns = Ns file | ||
12 | .Op Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel | ||
13 | .Op Fl v | \-version | ||
14 | .Sh DESCRIPTION | ||
15 | .Nm | ||
16 | is a command line tool to show network size estimates from the NSE service of GNUnet. | ||
17 | .Bl -tag -width Ds | ||
18 | .It Fl c Ar file | Fl -config Ns = Ns file | ||
19 | Use the configuration file FILENAME. | ||
20 | .It Fl h | \-help | ||
21 | Print short help on options. | ||
22 | .It Fl l file | Fl -logfile Ns = Ns file | ||
23 | Configure logging to write logs to LOGFILE. | ||
24 | .It Fl L Ar loglevel | Fl -loglevel Ns = Ns loglevel | ||
25 | Use LOGLEVEL for logging. | ||
26 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
27 | .It Fl v | \-version | ||
28 | Print GNUnet version number. | ||
29 | .El | ||
30 | .Sh FILES | ||
31 | .Pa gnunet.conf | ||
32 | Configuration file for gnunet. | ||
33 | .Sh SEE ALSO | ||
34 | .Xr gnunet.conf 5 | ||
35 | .sp | ||
36 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
37 | If the | ||
38 | .Xr info 1 | ||
39 | gnunet programs are properly installed at your site, the command | ||
40 | .Bd -literal -offset indent -compact | ||
41 | info gnunet | ||
42 | .Ed | ||
43 | should give you access to the complete handbook, | ||
44 | .Bd -literal -offset indent -compact | ||
45 | info gnunet-c-tutorial | ||
46 | .Ed | ||
47 | will give you access to a tutorial for developers. | ||
48 | .sp | ||
49 | Depending on your installation, this information is also | ||
50 | available in | ||
51 | .Xr gnunet 7 and | ||
52 | .Xr gnunet-c-tutorial 7 . | ||
53 | .Sh HISTORY | ||
54 | This man page first appeared in GNUnet 0.11.1. | ||
55 | .Sh AUTHORS | ||
56 | This page was originally written by | ||
57 | .An Bertrand Marc Aq Mt bmarc@debian.org | ||
58 | for Debian's gnunet package (man page date: 2014). | ||
59 | Further edits and conversion to mdoc were done by | ||
60 | .An ng0 Aq Mt ng0@gnunet.org . | ||
61 | .Sh BUGS | ||
62 | Report bugs by using | ||
63 | .Lk https://bugs.gnunet.org | ||
64 | or by sending electronic mail to | ||
65 | .Aq Mt bug-gnunet@gnu.org . | ||
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1 index bd37fa635..88094fa10 100644 --- a/doc/man/gnunet-peerinfo.1 +++ b/doc/man/gnunet-peerinfo.1 | |||
@@ -8,39 +8,28 @@ gnunet\-peerinfo \- Display information about other peers. | |||
8 | .PP | 8 | .PP |
9 | \fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. | 9 | \fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. |
10 | .SH OPTIONS | 10 | .SH OPTIONS |
11 | .B | ||
12 | .IP "\-c FILENAME, \-\-config=FILENAME" | 11 | .IP "\-c FILENAME, \-\-config=FILENAME" |
13 | Load config file (default: ~/.config/gnunet.conf) | 12 | Load config file (default: ~/.config/gnunet.conf) |
14 | .B | ||
15 | .IP "\-g, \-\-get\-hello" | 13 | .IP "\-g, \-\-get\-hello" |
16 | Output HELLO uri(s) | 14 | Output HELLO uri(s) |
17 | .B | ||
18 | .IP "\-h, \-\-help" | 15 | .IP "\-h, \-\-help" |
19 | Print help page | 16 | Print help page |
20 | .B | ||
21 | .IP "\-i, \-\-info" | 17 | .IP "\-i, \-\-info" |
22 | List all known peers (and their addresses) | 18 | List all known peers (and their addresses) |
23 | .B | ||
24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 19 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
25 | Set the loglevel | 20 | Set the loglevel |
26 | .B | ||
27 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | 21 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" |
28 | Log messages to LOGFILE | 22 | Log messages to LOGFILE |
29 | .B | ||
30 | .IP "\-n, \-\-numeric" | 23 | .IP "\-n, \-\-numeric" |
31 | Disable resolution of IPs to hostnames | 24 | Disable resolution of IPs to hostnames |
32 | .B | ||
33 | .IP "\-p, \-\-put\-hello=HELLO" | 25 | .IP "\-p, \-\-put\-hello=HELLO" |
34 | Add given HELLO uri to the database | 26 | Add given HELLO uri to the database |
35 | .B | ||
36 | .IP "\-q, \-\-quiet" | 27 | .IP "\-q, \-\-quiet" |
37 | Do not print anything but the peer identities | 28 | Do not print anything but the peer identities |
38 | .B | ||
39 | .IP "\-s, \-\-self" | 29 | .IP "\-s, \-\-self" |
40 | Print only our own identity (together with "\-q", this is the exact | 30 | Print only our own identity (together with "\-q", this is the exact |
41 | line that other peers would have to put in to their friends file in | 31 | line that other peers would have to put in to their friends file in |
42 | order to consider this peer one of their friends in F2F mode). | 32 | order to consider this peer one of their friends in F2F mode). |
43 | .B | ||
44 | .IP "\-v, \-\-version" | 33 | .IP "\-v, \-\-version" |
45 | Print the version number | 34 | Print the version number |
46 | .SH BUGS | 35 | .SH BUGS |
diff --git a/doc/man/gnunet-publish.1 b/doc/man/gnunet-publish.1 index b07208732..5f774580b 100644 --- a/doc/man/gnunet-publish.1 +++ b/doc/man/gnunet-publish.1 | |||
@@ -112,9 +112,9 @@ default is ~/.config/gnunet.conf). | |||
112 | Disable use of GNU libextractor for finding additional keywords and | 112 | Disable use of GNU libextractor for finding additional keywords and |
113 | metadata. | 113 | metadata. |
114 | .TP | 114 | .TP |
115 | \fB\-d\fR, \fB\-\-disable\-creation\-time\fR | 115 | \fB\-E\fR, \fB\-\-enable\-creation\-time\fR |
116 | Disable use of creation time timestamp in metadata. | 116 | Enable use of creation time timestamp in metadata. |
117 | Useful to make created directories deterministic and to avoid leaking | 117 | Setting this information will leak |
118 | information about the time at which a file was made available. | 118 | information about the time at which a file was made available. |
119 | .TP | 119 | .TP |
120 | \fB\-e\fR, \fB\-\-extract\fR | 120 | \fB\-e\fR, \fB\-\-extract\fR |
diff --git a/doc/man/gnunet-qr.1 b/doc/man/gnunet-qr.1 index 0145a3523..2aabe6b22 100644 --- a/doc/man/gnunet-qr.1 +++ b/doc/man/gnunet-qr.1 | |||
@@ -1,49 +1,53 @@ | |||
1 | .TH GNUNET\-QR 1 "September 13, 2014" "GNUnet" | 1 | .Dd September 13, 2014 |
2 | .SH NAME | 2 | .Dt GNUNET-QR 1 |
3 | gnunet\-qr \- Scan a QR code using a video device and import. | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-qr | 5 | .Nm gnunet-qr |
6 | .RI [ options ] | 6 | .Nd |
7 | .br | 7 | scan a QR code using a video device and import |
8 | .SH DESCRIPTION | 8 | .Sh SYNOPSIS |
9 | \fBgnunet\-qr\fP is a command line tool to scan a QR code using a | 9 | .Nm |
10 | video device and import. | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
11 | .SH OPTIONS | 11 | .Op Fl d Ar DEVICE | Fl \-device= Ns Ar DEVICE |
12 | .B | 12 | .Op Fl h | \-help |
13 | .IP "\-c FILENAME, \-\-config=FILENAME" | 13 | .Op Fl s | \-silent |
14 | .Op Fl v | \-verbose | ||
15 | .Sh DESCRIPTION | ||
16 | .Nm | ||
17 | is a command line tool to scan a QR code using a video device and import. | ||
18 | .Bl -tag -width Ds | ||
19 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
14 | Use the configuration file FILENAME. | 20 | Use the configuration file FILENAME. |
15 | .B | 21 | .It Fl d Ar DEVICE | Fl \-device= Ns Ar DEVICE |
16 | .IP "\-d DEVICE, \-\-device=DEVICE" | ||
17 | Use device DEVICE. | 22 | Use device DEVICE. |
18 | .B | 23 | .It Fl h | \-help |
19 | .IP "\-h, \-\-help" | ||
20 | Print short help on options. | 24 | Print short help on options. |
21 | .B | 25 | .It Fl s | \-silent |
22 | .IP "\-s, \-\-silent" | ||
23 | Do not show preview windows. | 26 | Do not show preview windows. |
24 | .B | 27 | .It Fl v | \-verbose |
25 | .IP "\-v, \-\-verbose" | ||
26 | Be verbose. | 28 | Be verbose. |
27 | .SH BUGS | 29 | .El |
28 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 30 | .Sh SEE ALSO |
29 | electronic mail to <gnunet\-developers@gnu.org> | 31 | The full documentation for gnunet is maintained as a Texinfo manual. |
30 | .SH SEE ALSO | 32 | If the |
31 | The full documentation for | 33 | .Xr info 1 |
32 | .B gnunet | 34 | and gnunet programs are properly installed at your site, the command |
33 | is maintained as a Texinfo manual. If the | 35 | .Pp |
34 | .B info | 36 | .Dl info gnunet |
35 | and | 37 | .Pp |
36 | .B gnunet | ||
37 | programs are properly installed at your site, the command | ||
38 | .IP | ||
39 | .B info gnunet | ||
40 | .PP | ||
41 | should give you access to the complete handbook, | 38 | should give you access to the complete handbook, |
42 | .IP | 39 | .Pp |
43 | .B info gnunet-c-tutorial | 40 | .Dl info gnunet-c-tutorial |
44 | .PP | 41 | .Pp |
45 | will give you access to a tutorial for developers. | 42 | will give you access to a tutorial for developers. |
46 | .PP | 43 | .sp |
47 | Depending on your installation, this information is also | 44 | Depending on your installation, this information is also available in |
48 | available in | 45 | .Xr gnunet 7 and |
49 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 46 | .Xr gnunet-c-tutorial 7 . |
47 | .\".Sh HISTORY | ||
48 | .\".Sh AUTHORS | ||
49 | .Sh BUGS | ||
50 | Report bugs by using | ||
51 | .Lk https://bugs.gnunet.org | ||
52 | or by sending electronic mail to | ||
53 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-resolver.1 b/doc/man/gnunet-resolver.1 index 66f1ba9a8..494131d01 100644 --- a/doc/man/gnunet-resolver.1 +++ b/doc/man/gnunet-resolver.1 | |||
@@ -7,23 +7,17 @@ gnunet\-resolver \- build-in GNUnet stub resolver | |||
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | \fBgnunet\-resolver\fP uses build-in GNUnet stub resolver. | 8 | \fBgnunet\-resolver\fP uses build-in GNUnet stub resolver. |
9 | .SH OPTIONS | 9 | .SH OPTIONS |
10 | .B | ||
11 | .IP "\-c FILENAME, \-\-config=FILENAME" | 10 | .IP "\-c FILENAME, \-\-config=FILENAME" |
12 | Use the configuration file FILENAME. | 11 | Use the configuration file FILENAME. |
13 | .B | ||
14 | .IP "\-h, \-\-help" | 12 | .IP "\-h, \-\-help" |
15 | Print short help on options. | 13 | Print short help on options. |
16 | .B | ||
17 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 14 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
18 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 15 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
19 | ERROR. | 16 | ERROR. |
20 | .B | ||
21 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | 17 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" |
22 | Configure logging to write logs to LOGFILE. | 18 | Configure logging to write logs to LOGFILE. |
23 | .B | ||
24 | .IP "\-r, \-\-reverse" | 19 | .IP "\-r, \-\-reverse" |
25 | Perform a reverse lookup. | 20 | Perform a reverse lookup. |
26 | .B | ||
27 | .IP "\-v, \-\-version" | 21 | .IP "\-v, \-\-version" |
28 | Print GNUnet version number. | 22 | Print GNUnet version number. |
29 | .SH BUGS | 23 | .SH BUGS |
diff --git a/doc/man/gnunet-revocation.1 b/doc/man/gnunet-revocation.1 index f21f82612..6fae373e7 100644 --- a/doc/man/gnunet-revocation.1 +++ b/doc/man/gnunet-revocation.1 | |||
@@ -28,19 +28,15 @@ expensive. Depending on your CPU, the calculation can take days or | |||
28 | weeks. | 28 | weeks. |
29 | 29 | ||
30 | .SH OPTIONS | 30 | .SH OPTIONS |
31 | .B | ||
32 | .IP "\-t KEY, \-\-test=KEY" | 31 | .IP "\-t KEY, \-\-test=KEY" |
33 | Check if the given KEY (ASCII\-encoded public key required) has been | 32 | Check if the given KEY (ASCII\-encoded public key required) has been |
34 | revoked. | 33 | revoked. |
35 | .B | ||
36 | .IP "\-R NAME, \-\-revoke=NAME" | 34 | .IP "\-R NAME, \-\-revoke=NAME" |
37 | Calculate or perform revocation for the ego with the given NAME. | 35 | Calculate or perform revocation for the ego with the given NAME. |
38 | .B | ||
39 | .IP "\-p, \-\-perform" | 36 | .IP "\-p, \-\-perform" |
40 | Actually perform the revocation as soon as possible (do not just | 37 | Actually perform the revocation as soon as possible (do not just |
41 | generate a revocation certificate, use it). Must be supplied to | 38 | generate a revocation certificate, use it). Must be supplied to |
42 | actually perform the revocation. | 39 | actually perform the revocation. |
43 | .B | ||
44 | .IP "\-f NAME, \-\-filename=NAME" | 40 | .IP "\-f NAME, \-\-filename=NAME" |
45 | Use NAME as the name of the file that is to contain the revocation | 41 | Use NAME as the name of the file that is to contain the revocation |
46 | certificate. Intermediate computation results will be stored here, as | 42 | certificate. Intermediate computation results will be stored here, as |
@@ -51,17 +47,13 @@ be performed instantly. If the given file contains anything (a valid | |||
51 | certificate, with or without the completed proof-of-work) there is no | 47 | certificate, with or without the completed proof-of-work) there is no |
52 | need to supply the "\-R" option or to still have the private key of | 48 | need to supply the "\-R" option or to still have the private key of |
53 | the ego to perform the revocation. | 49 | the ego to perform the revocation. |
54 | .B | ||
55 | .IP "\-c FILENAME, \-\-config=FILENAME" | 50 | .IP "\-c FILENAME, \-\-config=FILENAME" |
56 | Use the configuration file FILENAME. | 51 | Use the configuration file FILENAME. |
57 | .B | ||
58 | .IP "\-h, \-\-help" | 52 | .IP "\-h, \-\-help" |
59 | Print short help on options. | 53 | Print short help on options. |
60 | .B | ||
61 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 54 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
62 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and | 55 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and |
63 | ERROR. | 56 | ERROR. |
64 | .B | ||
65 | .IP "\-v, \-\-version" | 57 | .IP "\-v, \-\-version" |
66 | Print GNUnet version number. | 58 | Print GNUnet version number. |
67 | 59 | ||
diff --git a/doc/man/gnunet-scalarproduct.1 b/doc/man/gnunet-scalarproduct.1 index 1c8938daf..34d5e4ef0 100644 --- a/doc/man/gnunet-scalarproduct.1 +++ b/doc/man/gnunet-scalarproduct.1 | |||
@@ -42,34 +42,26 @@ The protocol by definition relies on \fBAlice\fP and \fBBob\fP being | |||
42 | benign, thus \fBBob\fP can arbitrarily falsify his information. Both | 42 | benign, thus \fBBob\fP can arbitrarily falsify his information. Both |
43 | peers collaborate to achieve a correct result. | 43 | peers collaborate to achieve a correct result. |
44 | .SH OPTIONS | 44 | .SH OPTIONS |
45 | .B | ||
46 | .IP "\-e ELEMENTS, \-\-elements=ELEMENTS" | 45 | .IP "\-e ELEMENTS, \-\-elements=ELEMENTS" |
47 | The element-vector the vectorproduct should be computed over in signed | 46 | The element-vector the vectorproduct should be computed over in signed |
48 | decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked. | 47 | decimal form, eg: \"42,1,-3,3,7\". Zero value elements will be automatically masked. |
49 | .B | ||
50 | .IP "\-m MASK, \-\-mask=MASK" | 48 | .IP "\-m MASK, \-\-mask=MASK" |
51 | Elements in the vector can be masked. There must be at least two | 49 | Elements in the vector can be masked. There must be at least two |
52 | elements left in the vector to compute a vectorproduct. Non-Zero | 50 | elements left in the vector to compute a vectorproduct. Non-Zero |
53 | values indicate an element is not maskes. | 51 | values indicate an element is not maskes. |
54 | .B | ||
55 | .IP "\-k KEY, \-\-key=KEY" | 52 | .IP "\-k KEY, \-\-key=KEY" |
56 | The session key, a shared string of arbitrary length from which the | 53 | The session key, a shared string of arbitrary length from which the |
57 | SID will be generated | 54 | SID will be generated |
58 | .B | ||
59 | .IP "\-c FILENAME, \-\-config=FILENAME" | 55 | .IP "\-c FILENAME, \-\-config=FILENAME" |
60 | Use the configuration file FILENAME. | 56 | Use the configuration file FILENAME. |
61 | .B | ||
62 | .IP "\-p PEERID, \-\-peer=PEERID" | 57 | .IP "\-p PEERID, \-\-peer=PEERID" |
63 | The remote peer\'s ASCII-armored gnunet-peer ID as output by | 58 | The remote peer\'s ASCII-armored gnunet-peer ID as output by |
64 | gnunet-peerinfo. If this option is not given, the peer will take the | 59 | gnunet-peerinfo. If this option is not given, the peer will take the |
65 | \fBBob\fP\'s role. | 60 | \fBBob\fP\'s role. |
66 | .B | ||
67 | .IP "\-h, \-\-help" | 61 | .IP "\-h, \-\-help" |
68 | Print short help on options. | 62 | Print short help on options. |
69 | .B | ||
70 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 63 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
71 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 64 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
72 | .B | ||
73 | .IP "\-v, \-\-version" | 65 | .IP "\-v, \-\-version" |
74 | Print GNUnet version number. | 66 | Print GNUnet version number. |
75 | .SH BUGS | 67 | .SH BUGS |
diff --git a/doc/man/gnunet-scrypt.1 b/doc/man/gnunet-scrypt.1 index 01ac4205a..545af37e9 100644 --- a/doc/man/gnunet-scrypt.1 +++ b/doc/man/gnunet-scrypt.1 | |||
@@ -5,34 +5,24 @@ gnunet\-scrypt \- Manipulate GNUnet proof of work files. | |||
5 | .B gnunet\-scrypt | 5 | .B gnunet\-scrypt |
6 | .RI [ options ] | 6 | .RI [ options ] |
7 | .SH DESCRIPTION | 7 | .SH DESCRIPTION |
8 | \fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof | 8 | \fBgnunet\-scrypt\fP is a command line tool to manipulate GNUnet proof of work files. |
9 | of work files. | ||
10 | .SH OPTIONS | 9 | .SH OPTIONS |
11 | .B | ||
12 | .IP "\-b BITS, \-\-bits=BITS" | 10 | .IP "\-b BITS, \-\-bits=BITS" |
13 | Number of bits to require for the proof of work. | 11 | Number of bits to require for the proof of work. |
14 | .B | ||
15 | .IP "\-c FILENAME, \-\-config=FILENAME" | 12 | .IP "\-c FILENAME, \-\-config=FILENAME" |
16 | Use the configuration file FILENAME. | 13 | Use the configuration file FILENAME. |
17 | .B | ||
18 | .IP "\-h, \-\-help" | 14 | .IP "\-h, \-\-help" |
19 | Print short help on options. | 15 | Print short help on options. |
20 | .B | ||
21 | .IP "\-k FILE, \-\-keyfile=FILE" | 16 | .IP "\-k FILE, \-\-keyfile=FILE" |
22 | File with private key, otherwise default is used. | 17 | File with private key, otherwise default is used. |
23 | .B | ||
24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 18 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" |
25 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 19 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
26 | .B | ||
27 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | 20 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" |
28 | Configure logging to write logs to LOGFILE. | 21 | Configure logging to write logs to LOGFILE. |
29 | .B | ||
30 | .IP "\-o FILE, \-\-outfile=FILE" | 22 | .IP "\-o FILE, \-\-outfile=FILE" |
31 | File with proof of work, otherwise default is used. | 23 | File with proof of work, otherwise default is used. |
32 | .B | ||
33 | .IP "\-t TIME, \-\-timeout=TIME" | 24 | .IP "\-t TIME, \-\-timeout=TIME" |
34 | Time to wait between calculations. | 25 | Time to wait between calculations. |
35 | .B | ||
36 | .IP "\-v, \-\-version" | 26 | .IP "\-v, \-\-version" |
37 | Print GNUnet version number. | 27 | Print GNUnet version number. |
38 | .SH BUGS | 28 | .SH BUGS |
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1 index e61a8493c..c0d5e8fe3 100644 --- a/doc/man/gnunet-statistics.1 +++ b/doc/man/gnunet-statistics.1 | |||
@@ -1,73 +1,91 @@ | |||
1 | .TH GNUNET-STATISTICS 1 "January 4, 2012" "GNUnet" | 1 | .Dd January 4, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-STATISTICS 1 |
3 | gnunet\-statistics \- Display statistics about your GNUnet system | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-statistics | 5 | .Nm gnunet-statistics |
6 | .RI [ options ] | 6 | .Nd display statistics about your GNUnet system |
7 | .RI [ VALUE ] | 7 | .Sh SYNOPSIS |
8 | .SH DESCRIPTION | 8 | .Nm |
9 | \fBgnunet\-statistics\fP is used to display detailed information about | 9 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
10 | various aspect of GNUnet's operation. This tool only works if the | 10 | .Op Fl h | \-help |
11 | "statistics" service is available. | 11 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
12 | gnunet\-statistics can be used to set a value by giving the options | 12 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
13 | \-n, \-s and also a VALUE. | 13 | .Op Fl n Ar NAME | Fl \-name= Ns Ar NAME |
14 | .SH OPTIONS | 14 | .Op Fl o Ar PORT | Fl \-port= Ns Ar PORT |
15 | .B | 15 | .Op Fl p | \-persistent |
16 | .IP "\-c FILENAME, \-\-config=FILENAME" | 16 | .Op Fl q | \-quiet |
17 | .Op Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE | ||
18 | .Op Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR | ||
19 | .Op Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM | ||
20 | .Op Fl t Ar PATH | Fl \-testbed= Ns Ar PATH | ||
21 | .Op Fl v | \-version | ||
22 | .Op Fl w | \-watch | ||
23 | .Ao Ar VALUE Ac | ||
24 | .Sh DESCRIPTION | ||
25 | .Nm | ||
26 | is used to display detailed information about various aspect of GNUnet's operation. | ||
27 | This tool only works if the "statistics" service is available. | ||
28 | gnunet-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE. | ||
29 | .Bl -tag -width Ds | ||
30 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
17 | Use the configuration file FILENAME. | 31 | Use the configuration file FILENAME. |
18 | .B | 32 | .It Fl h | \-help |
19 | .IP "\-h, \-\-help" | ||
20 | Print short help on options. | 33 | Print short help on options. |
21 | .B | 34 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
22 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
23 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 35 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
24 | .B | 36 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
25 | .IP "\-n NAME, \-\-name=NAME" | 37 | Configure logging to write logs to FILENAME |
26 | Each statistic has a name that is unique with in its subsystem. With | 38 | .It Fl n Ar NAME | Fl \-name= Ns Ar NAME |
27 | this option, the output can be restricted to statistics that have a | 39 | Each statistic has a NAME that is unique with in its subsystem. |
28 | particular name. | 40 | With this option, the output can be restricted to statistics that have a particular NAME. |
29 | .B | 41 | .It Fl o Ar PORT | Fl \-port= Ns Ar PORT |
30 | .IP "\-p, \-\-persistent" | 42 | PORT for remote host |
31 | When setting a value, make the value persistent. If the value used to | 43 | .It Fl p | \-persistent |
32 | be persistent and this flag is not given, it will be marked as | 44 | When setting a value, make the value persistent. |
33 | non\-persistent. | 45 | If the value used to be persistent and this flag is not given, it will be marked as non-persistent. |
34 | .B | 46 | .It Fl q | \-quiet |
35 | .IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM" | 47 | Just print the statistics value |
36 | Statistics are kept for various subsystems. With this option, the | 48 | .It Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE |
37 | output can be restricted to a particular subsystem only. | 49 | Connect to a remote host given as REMOTE. |
38 | .B | 50 | .It Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR |
39 | .IP "\-S SEPARATOR, \-\-csv-separator=SEPARATOR" | ||
40 | Specify a separator for generating csv-output. | 51 | Specify a separator for generating csv-output. |
41 | .B | 52 | .It Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM |
42 | .IP "\-t TESTBED_PATH, \-\-subsystem=TESTBED_PATH" | 53 | Statistics are kept for various subsystems. |
54 | With this option, the output can be restricted to a particular subsystem only. | ||
55 | .It Fl t Ar PATH | Fl \-testbed= Ns Ar PATH | ||
43 | When running testbed, you can get statistics of all peers with specefying the | 56 | When running testbed, you can get statistics of all peers with specefying the |
44 | folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /tmp/testbedARtmQv\fP. | 57 | folder containing the data of all testbed nodes like |
45 | .B | 58 | .Pp |
46 | .IP "\-v, \-\-version" | 59 | .Dl $ gnunet-statistics -t /tmp/testbedARtmQv |
60 | .Pp | ||
61 | .It Fl v | \-version | ||
47 | Print GNUnet version number. | 62 | Print GNUnet version number. |
48 | .SH BUGS | 63 | .It Fl w | \-watch |
49 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending | 64 | Watch value continuously. |
50 | electronic mail to <gnunet\-developers@gnu.org> | 65 | .El |
51 | .SH SEE ALSO | 66 | .Sh SEE ALSO |
52 | gnunet\-service\-statistics(1) | 67 | .Xr gnunet-service-statistics 1 |
53 | .PP | 68 | .sp |
54 | The full documentation for | 69 | The full documentation for gnunet is maintained as a Texinfo manual. |
55 | .B gnunet | ||
56 | is maintained as a Texinfo manual. | ||
57 | If the | 70 | If the |
58 | .B info | 71 | .Xr info 1 |
59 | and | 72 | and gnunet programs are properly installed at your site, the command |
60 | .B gnunet | 73 | .Pp |
61 | programs are properly installed at your site, the command | 74 | .Dl info gnunet |
62 | .IP | 75 | .Pp |
63 | .B info gnunet | ||
64 | .PP | ||
65 | should give you access to the complete handbook, | 76 | should give you access to the complete handbook, |
66 | .IP | 77 | .Pp |
67 | .B info gnunet-c-tutorial | 78 | .Dl info gnunet-c-tutorial |
68 | .PP | 79 | .Pp |
69 | will give you access to a tutorial for developers. | 80 | will give you access to a tutorial for developers. |
70 | .PP | 81 | .sp |
71 | Depending on your installation, this information is also | 82 | Depending on your installation, this information is also available in |
72 | available in | 83 | .Xr gnunet 7 and |
73 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 84 | .Xr gnunet-c-tutorial 7 . |
85 | .\".Sh HISTORY | ||
86 | .\".Sh AUTHORS | ||
87 | .Sh BUGS | ||
88 | Report bugs by using | ||
89 | .Lk https://bugs.gnunet.org | ||
90 | or by sending electronic mail to | ||
91 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-testbed-profiler.1 b/doc/man/gnunet-testbed-profiler.1 index b1dde99dd..fe9d713b3 100644 --- a/doc/man/gnunet-testbed-profiler.1 +++ b/doc/man/gnunet-testbed-profiler.1 | |||
@@ -1,61 +1,67 @@ | |||
1 | .TH GNUNET\-TESTBED\-PROFILER 1 "September 13, 2014" "GNUnet" | 1 | .Dd September 13, 2014 |
2 | .SH NAME | 2 | .Dt GNUNET-TESTBED-PROFILER 1 |
3 | gnunet\-testbed\-profiler \- Profiling driver for the testbed. | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-testbed\-profiler | 5 | .Nm gnunet-testbed-profiler |
6 | .RI [ options ] | 6 | .Nd |
7 | .br | 7 | profiling driver for the testbed |
8 | .SH DESCRIPTION | 8 | .Sh SYNOPSIS |
9 | \fBgnunet\-testbed\-profiler\fP is a command line profiling driver for the testbed. | 9 | .Nm |
10 | .SH OPTIONS | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
11 | .B | 11 | .Op Fl e Ar COUNT | Fl \-num-errors= Ns Ar COUNT |
12 | .IP "\-c FILENAME, \-\-config=FILENAME" | 12 | .Op Fl H Ar FILENAME | Fl \-hosts= Ns Ar FILENAME |
13 | .Op Fl h | \-help | ||
14 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
15 | .Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE | ||
16 | .Op Fl n | \-non-interactive | ||
17 | .Op Fl p Ar COUNT | Fl \-num-peers= Ns Ar COUNT | ||
18 | .Op Fl v | \-version | ||
19 | .Sh DESCRIPTION | ||
20 | .Nm | ||
21 | is a command line profiling driver for the testbed. | ||
22 | .Sh OPTIONS | ||
23 | .Bl -tag -width Ds | ||
24 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
13 | Use the configuration file FILENAME. | 25 | Use the configuration file FILENAME. |
14 | .B | 26 | .It Fl e Ar COUNT | Fl \-num-errors= Ns Ar COUNT |
15 | .IP "\-e COUNT, \-\-num\-errors=COUNT" | ||
16 | Tolerate COUNT number of continious timeout failures. | 27 | Tolerate COUNT number of continious timeout failures. |
17 | .B | 28 | .It Fl H Ar FILENAME | Fl \-hosts= Ns Ar FILENAME |
18 | .IP "\-H FILENAME, \-\-hosts=FILENAME" | ||
19 | Name of the file with the login information for the testbed. | 29 | Name of the file with the login information for the testbed. |
20 | .B | 30 | .It Fl h | \-help |
21 | .IP "\-h, \-\-help" | ||
22 | Print short help on options. | 31 | Print short help on options. |
23 | .B | 32 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 33 | Use LOGLEVEL for logging. |
25 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 34 | Valid values are DEBUG, INFO, WARNING and ERROR. |
26 | .B | 35 | .It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE |
27 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | ||
28 | Configure logging to write logs to LOGFILE. | 36 | Configure logging to write logs to LOGFILE. |
29 | .B | 37 | .It Fl n | \-non-interactive |
30 | .IP "\-n, \-\-non\-interactive" | 38 | Run profiler in non-interactive mode where upon testbed setup the profiler does not wait for a keystroke but continues to run until a termination signal is received. |
31 | Run profiler in non-interactive mode where upon testbed setup the | 39 | .It Fl p Ar COUNT | Fl \-num-peers= Ns Ar COUNT |
32 | profiler does not wait for a keystroke but continues to run until a | ||
33 | termination signal is received. | ||
34 | .B | ||
35 | .IP "\-p COUNT, \-\-num\-peers=COUNT" | ||
36 | Create COUNT number of peers. | 40 | Create COUNT number of peers. |
37 | .B | 41 | .It Fl v | \-version |
38 | .IP "\-v, \-\-version" | ||
39 | Print GNUnet version number. | 42 | Print GNUnet version number. |
40 | .SH BUGS | 43 | .El |
41 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 44 | .Sh SEE ALSO |
42 | .SH "SEE ALSO" | 45 | The full documentation for gnunet is maintained as a Texinfo manual. |
43 | The full documentation for | 46 | If the |
44 | .B gnunet | 47 | .Xr info 1 |
45 | is maintained as a Texinfo manual. If the | 48 | and gnunet programs are properly installed at your site, the command |
46 | .B info | 49 | .Pp |
47 | and | 50 | .Dl info gnunet |
48 | .B gnunet | 51 | .Pp |
49 | programs are properly installed at your site, the command | ||
50 | .IP | ||
51 | .B info gnunet | ||
52 | .PP | ||
53 | should give you access to the complete handbook, | 52 | should give you access to the complete handbook, |
54 | .IP | 53 | .Pp |
55 | .B info gnunet-c-tutorial | 54 | .Dl info gnunet-c-tutorial |
56 | .PP | 55 | .Pp |
57 | will give you access to a tutorial for developers. | 56 | will give you access to a tutorial for developers. |
58 | .PP | 57 | .sp |
59 | Depending on your installation, this information is also | 58 | Depending on your installation, this information is also available in |
60 | available in | 59 | .Xr gnunet 7 and |
61 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 60 | .Xr gnunet-c-tutorial 7 . |
61 | .\".Sh HISTORY | ||
62 | .\".Sh AUTHORS | ||
63 | .Sh BUGS | ||
64 | Report bugs by using | ||
65 | .Lk https://bugs.gnunet.org | ||
66 | or by sending electronic mail to | ||
67 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-testing-run-service.1 b/doc/man/gnunet-testing-run-service.1 index 43fdb8ecf..903810c7f 100644 --- a/doc/man/gnunet-testing-run-service.1 +++ b/doc/man/gnunet-testing-run-service.1 | |||
@@ -1,52 +1,53 @@ | |||
1 | .TH GNUNET-TESTING-RUN-SERVICE 1 "August 25, 2013" "GNUnet" | 1 | .Dd August 25, 2013 |
2 | .SH NAME | 2 | .Dt GNUNET-TESTING-RUN-SERVICE 1 |
3 | gnunet\-testing\-run\-service \- Command line tool to start a service for testing. | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-testing\-run\-service | 5 | .Nm gnunet-testing-run-service |
6 | .RI [ options ] | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | command line tool to start a service for testing |
8 | \fBgnunet\-testing\-run\-service\fP is a command line tool to start a | 8 | .Sh SYNOPSIS |
9 | service for testing. It starts a peer, running only the service | 9 | .Nm |
10 | specified on the command line, outputs the path to the temporary | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
11 | configuration file to stdout. | 11 | .Op Fl h | \-help |
12 | .PP | 12 | .Op Fl s Ar SERVICE | Fl \-service= Ns Ar SERVICE |
13 | The peer will run until this program is killed, or stdin is | 13 | .Sh DESCRIPTION |
14 | closed. When reading the character 'r' from stdin, the running service | 14 | .Nm |
15 | is restarted with the same configuration. | 15 | is a command line tool to start a service for testing. |
16 | .PP | 16 | It starts a peer, running only the service specified on the command line, outputs the path to the temporary configuration file to stdout. |
17 | This executable is intended to be used by gnunet-java, in order to | 17 | .Pp |
18 | reliably start and stop services for test cases. | 18 | The peer will run until this program is killed, or stdin is closed. |
19 | .SH OPTIONS | 19 | When reading the character 'r' from stdin, the running service is restarted with the same configuration. |
20 | .B | 20 | .Pp |
21 | .IP "\-c FILENAME, \-\-config=FILENAME" | 21 | This executable is intended to be used by gnunet-java, in order to reliably start and stop services for test cases. |
22 | .Bl -tag -width Ds | ||
23 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
22 | Name of the template configuration file to use (optional). | 24 | Name of the template configuration file to use (optional). |
23 | .B | 25 | .It Fl h | \-help |
24 | .IP "\-h, \-\-help" | ||
25 | Print short help on options. | 26 | Print short help on options. |
26 | .B | 27 | .It Fl s Ar SERVICE | Fl \-service= Ns Ar SERVICE |
27 | .IP "\-s SERVICE, \-\-service=SERVICE" | ||
28 | Name of the service to run. | 28 | Name of the service to run. |
29 | .SH BUGS | 29 | .El |
30 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 30 | .Sh SEE ALSO |
31 | electronic mail to <gnunet\-developers@gnu.org> | 31 | The full documentation for gnunet is maintained as a Texinfo manual. |
32 | .SH SEE ALSO | ||
33 | The full documentation for | ||
34 | .B gnunet | ||
35 | is maintained as a Texinfo manual. | ||
36 | If the | 32 | If the |
37 | .B info | 33 | .Xr info 1 |
38 | and | 34 | and gnunet programs are properly installed at your site, the command |
39 | .B gnunet | 35 | .Pp |
40 | programs are properly installed at your site, the command | 36 | .Dl info gnunet |
41 | .IP | 37 | .Pp |
42 | .B info gnunet | ||
43 | .PP | ||
44 | should give you access to the complete handbook, | 38 | should give you access to the complete handbook, |
45 | .IP | 39 | .Pp |
46 | .B info gnunet-c-tutorial | 40 | .Dl info gnunet-c-tutorial |
47 | .PP | 41 | .Pp |
48 | will give you access to a tutorial for developers. | 42 | will give you access to a tutorial for developers. |
49 | .PP | 43 | .sp |
50 | Depending on your installation, this information is also | 44 | Depending on your installation, this information is also available in |
51 | available in | 45 | .Xr gnunet 7 and |
52 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 46 | .Xr gnunet-c-tutorial 7 . |
47 | .\".Sh HISTORY | ||
48 | .\".Sh AUTHORS | ||
49 | .Sh BUGS | ||
50 | Report bugs by using | ||
51 | .Lk https://bugs.gnunet.org | ||
52 | or by sending electronic mail to | ||
53 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-testing.1 b/doc/man/gnunet-testing.1 index 357d0df44..182da613d 100644 --- a/doc/man/gnunet-testing.1 +++ b/doc/man/gnunet-testing.1 | |||
@@ -1,65 +1,69 @@ | |||
1 | .TH GNUNET\-TESTING 1 "January 4, 2012" "GNUnet" | 1 | .Dd January 4, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-TESTING 1 |
3 | gnunet\-testing \- Command line tool to access the testing library. | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-testing | 5 | .Nm gnunet-testing |
6 | .RI [ options ] | 6 | .Nd |
7 | .br | 7 | command line tool to access the testing library |
8 | .SH DESCRIPTION | 8 | .Sh SYNOPSIS |
9 | \fBgnunet\-testing\fP is a command line tool to access the testing | 9 | .Nm |
10 | library. | 10 | .Op Fl C | \-cfg |
11 | .SH OPTIONS | 11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
12 | .B | 12 | .Op Fl H | \-hostkeys |
13 | .IP "\-C, \-\-cfg" | 13 | .Op Fl h | \-help |
14 | .Op Fl k | \-key | ||
15 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
16 | .Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOFILE | ||
17 | .Op Fl n | \-number | ||
18 | .Op Fl t | \-template | ||
19 | .Op Fl v | \-version | ||
20 | .Sh DESCRIPTION | ||
21 | .Nm | ||
22 | is a command line tool to access the testing library. | ||
23 | .Sh OPTIONS | ||
24 | .Bl -tag -width Ds | ||
25 | .It Fl C | \-cfg | ||
14 | Create unique configuration files. | 26 | Create unique configuration files. |
15 | .B | 27 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
16 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
17 | Use the configuration file FILENAME. | 28 | Use the configuration file FILENAME. |
18 | .B | 29 | .It Fl H | \-hostkeys |
19 | .IP "\-H, \-\-hostkeys" | ||
20 | Host key file. | 30 | Host key file. |
21 | .B | 31 | .It Fl h | \-help |
22 | .IP "\-h, \-\-help" | ||
23 | Print short help on options. | 32 | Print short help on options. |
24 | .B | 33 | .It Fl k | \-key |
25 | .IP "\-k, \-\-key" | ||
26 | Create hostkey files from pre-computed hostkey list. | 34 | Create hostkey files from pre-computed hostkey list. |
27 | .B | 35 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
28 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
29 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 36 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. |
30 | .B | 37 | .It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOFILE |
31 | .IP "\-l LOGFILE, \-\-logfile=LOGFILE" | ||
32 | Configure logging to write logs to LOGFILE. | 38 | Configure logging to write logs to LOGFILE. |
33 | .B | 39 | .It Fl n | \-number |
34 | .IP "\-n, \-\-number" | ||
35 | Number of unique configuration files or hostkeys to create. | 40 | Number of unique configuration files or hostkeys to create. |
36 | .B | 41 | .It Fl t | \-template |
37 | .IP "\-t, \-\-template" | ||
38 | Configuration template. | 42 | Configuration template. |
39 | .B | 43 | .It Fl v | \-version |
40 | .IP "\-v, \-\-version" | ||
41 | Print GNUnet version number. | 44 | Print GNUnet version number. |
42 | .SH BUGS | 45 | .El |
43 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 46 | .Sh SEE ALSO |
44 | electronic mail to <gnunet\-developers@gnu.org> | 47 | The full documentation for gnunet is maintained as a Texinfo manual. |
45 | .SH SEE ALSO | ||
46 | The full documentation for | ||
47 | .B gnunet | ||
48 | is maintained as a Texinfo manual. | ||
49 | If the | 48 | If the |
50 | .B info | 49 | .Xr info 1 |
51 | and | 50 | and gnunet programs are properly installed at your site, the command |
52 | .B gnunet | 51 | .Pp |
53 | programs are properly installed at your site, the command | 52 | .Dl info gnunet |
54 | .IP | 53 | .Pp |
55 | .B info gnunet | ||
56 | .PP | ||
57 | should give you access to the complete handbook, | 54 | should give you access to the complete handbook, |
58 | .IP | 55 | .Pp |
59 | .B info gnunet-c-tutorial | 56 | .Dl info gnunet-c-tutorial |
60 | .PP | 57 | .Pp |
61 | will give you access to a tutorial for developers. | 58 | will give you access to a tutorial for developers. |
62 | .PP | 59 | .sp |
63 | Depending on your installation, this information is also | 60 | Depending on your installation, this information is also available in |
64 | available in | 61 | .Xr gnunet 7 and |
65 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 62 | .Xr gnunet-c-tutorial 7 . |
63 | .\".Sh HISTORY | ||
64 | .\".Sh AUTHORS | ||
65 | .Sh BUGS | ||
66 | Report bugs by using | ||
67 | .Lk https://bugs.gnunet.org | ||
68 | or by sending electronic mail to | ||
69 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-timeout.1 b/doc/man/gnunet-timeout.1 index 653f211cd..15abfe351 100644 --- a/doc/man/gnunet-timeout.1 +++ b/doc/man/gnunet-timeout.1 | |||
@@ -1,36 +1,42 @@ | |||
1 | .TH GNUNET-TIMOUET 1 "June 5, 2018" "GNUnet" | 1 | .Dd June 5, 2018 |
2 | .SH NAME | 2 | .Dt GNUNET-TIMEOUT 1 |
3 | gnunet\-timeout \- run process with timeout | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-timeout | 5 | .Nm gnunet-timeout |
6 | .RI TIMEOUT PROGRAM ARGS | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | run process with timeout |
8 | \fBgnunet\-timeout\fP can be used to run another process with a | 8 | .Sh SYNOPSIS |
9 | timeout. Provided as the standard "timout" utility may not be | 9 | .Nm |
10 | available on all platforms. | 10 | .Ao Ar duration Ac |
11 | .SH BUGS | 11 | .Ao Ar command Ac |
12 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 12 | .Ao args ... Ac |
13 | electronic mail to <gnunet\-developers@gnu.org> | 13 | .Sh DESCRIPTION |
14 | .SH SEE ALSO | 14 | .Nm |
15 | timeout(1) | 15 | can be used to run another process with a timeout. |
16 | .PP | 16 | It is provided because the standard "timout" utility may not be available on all platforms. |
17 | The full documentation for | 17 | .Sh SEE ALSO |
18 | .B gnunet | 18 | .Xr timeout 1 |
19 | is maintained as a Texinfo manual. | 19 | .sp |
20 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
20 | If the | 21 | If the |
21 | .B info | 22 | .Xr info 1 |
22 | and | 23 | and gnunet programs are properly installed at your site, the command |
23 | .B gnunet | 24 | .Pp |
24 | programs are properly installed at your site, the command | 25 | .Dl info gnunet |
25 | .IP | 26 | .Pp |
26 | .B info gnunet | ||
27 | .PP | ||
28 | should give you access to the complete handbook, | 27 | should give you access to the complete handbook, |
29 | .IP | 28 | .Pp |
30 | .B info gnunet-c-tutorial | 29 | .Dl info gnunet-c-tutorial |
31 | .PP | 30 | .Pp |
32 | will give you access to a tutorial for developers. | 31 | will give you access to a tutorial for developers. |
33 | .PP | 32 | .sp |
34 | Depending on your installation, this information is also | 33 | Depending on your installation, this information is also available in |
35 | available in | 34 | .Xr gnunet 7 and |
36 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 35 | .Xr gnunet-c-tutorial 7 . |
36 | .\".Sh HISTORY | ||
37 | .\".Sh AUTHORS | ||
38 | .Sh BUGS | ||
39 | Report bugs by using | ||
40 | .Lk https://bugs.gnunet.org | ||
41 | or by sending electronic mail to | ||
42 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-transport-certificate-creation.1 b/doc/man/gnunet-transport-certificate-creation.1 index 9dc572acf..e896363e4 100644 --- a/doc/man/gnunet-transport-certificate-creation.1 +++ b/doc/man/gnunet-transport-certificate-creation.1 | |||
@@ -1,35 +1,40 @@ | |||
1 | .TH GNUNET\-TRANSPORT-CERTIFICATE-CREATION 1 "January 31, 2014" "GNUnet" | 1 | .Dd January 31, 2014 |
2 | .SH NAME | 2 | .Dt GNUNET-TRANSPORT-CERTIFICATE-CREATION 1 |
3 | gnunet\-transport\-certificate\-creation \- create certificate for HTTPS transport | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-transport\-certificate\-creation | 5 | .Nm gnunet-transport-certificate-creation |
6 | .I privatekey certificate | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | create certificate for HTTPS transport |
8 | \fBgnunet\-transport\-certificate\-creation\fP uses openssl to generate a RSA | 8 | .Sh SYNOPSIS |
9 | private key and then a self-signed certificate for HTTPS transport. | 9 | .Nm |
10 | .SH BUGS | 10 | .Op privatekey |
11 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 11 | .Op certificate |
12 | electronic mail to <gnunet\-developers@gnu.org> | 12 | .Sh DESCRIPTION |
13 | .SH SEE ALSO | 13 | .Nm |
14 | gnunet\-transport(1) | 14 | uses openssl to generate a RSA private key and then a self-signed certificate for HTTPS transport. |
15 | .PP | 15 | .Sh SEE ALSO |
16 | The full documentation for | 16 | .Xr gnunet-transport 1 |
17 | .B gnunet | 17 | .sp |
18 | is maintained as a Texinfo manual. | 18 | The full documentation for gnunet is maintained as a Texinfo manual. |
19 | If the | 19 | If the |
20 | .B info | 20 | .Xr info 1 |
21 | and | 21 | and gnunet programs are properly installed at your site, the command |
22 | .B gnunet | 22 | .Pp |
23 | programs are properly installed at your site, the command | 23 | .Dl info gnunet |
24 | .IP | 24 | .Pp |
25 | .B info gnunet | ||
26 | .PP | ||
27 | should give you access to the complete handbook, | 25 | should give you access to the complete handbook, |
28 | .IP | 26 | .Pp |
29 | .B info gnunet-c-tutorial | 27 | .Dl info gnunet-c-tutorial |
30 | .PP | 28 | .Pp |
31 | will give you access to a tutorial for developers. | 29 | will give you access to a tutorial for developers. |
32 | .PP | 30 | .sp |
33 | Depending on your installation, this information is also | 31 | Depending on your installation, this information is also available in |
34 | available in | 32 | .Xr gnunet 7 and |
35 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 33 | .Xr gnunet-c-tutorial 7 . |
34 | .\".Sh HISTORY | ||
35 | .\".Sh AUTHORS | ||
36 | .Sh BUGS | ||
37 | Report bugs by using | ||
38 | .Lk https://bugs.gnunet.org | ||
39 | or by sending electronic mail to | ||
40 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1 index eef762174..f5ed47ad1 100644 --- a/doc/man/gnunet-transport.1 +++ b/doc/man/gnunet-transport.1 | |||
@@ -1,84 +1,92 @@ | |||
1 | .TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet" | 1 | .Dd October 17, 2015 |
2 | .SH NAME | 2 | .Dt GNUNET-TRANSPORT 1 |
3 | gnunet\-transport \- measure and control the transport subsystem | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-transport | 5 | .Nm gnunet-transport |
6 | [\fIOPTIONS\fR] | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | measure and control the transport subsystem |
8 | .PP | 8 | .Sh SYNOPSIS |
9 | gnunet\-transport is a tool to access various functions of GNUnet's | 9 | .Nm |
10 | transport subsystem from the command\-line. Most of these are not | 10 | .Op Fl b | \-benchmark |
11 | expected to be useful for end-users. gnunet\-transport can be used to | 11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
12 | evaluate the performance of the transports, force a peer to connect to | 12 | .Op Fl D | \-disconnect |
13 | another peer (if possible). Other functions should be added in the | 13 | .Op Fl e | \-events |
14 | near future. | 14 | .Op Fl h | \-help |
15 | .TP | 15 | .Op Fl i | \-information |
16 | \fB\-b\fR, \fB\-\-benchmark\fR | 16 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
17 | measure how fast we are receiving data (from all connections). On | 17 | .Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE |
18 | exit, the data rate will be reported. Runs until aborted with CTRL-C. | 18 | .Op Fl m | \-monitor |
19 | .TP | 19 | .Op Fl p Ar PEER | Fl \-peer= Ns Ar PEER |
20 | \fB\-D\fR, \fB\-\-disconnect\fR | 20 | .Op Fl P | \-plugins |
21 | force disconnection from a peer (used in conjunction with \-p). | 21 | .Op Fl s | \-send |
22 | Note that you can use the gnunet\-ats command\-line tool to suggest connects. | 22 | .Op Fl v | \-version |
23 | .TP | 23 | .Op Fl V | \-verbose |
24 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | 24 | .Sh DESCRIPTION |
25 | .Nm | ||
26 | is a tool to access various functions of GNUnet's transport subsystem from the command-line. | ||
27 | Most of these are not expected to be useful for end-users. | ||
28 | gnunet-transport can be used to evaluate the performance of the transports, force a peer to connect to another peer (if possible). | ||
29 | Other functions should be added in the near future. | ||
30 | .Bl -tag -width Ds | ||
31 | .It Fl b | \-benchmark | ||
32 | measure how fast we are receiving data (from all connections). | ||
33 | On exit, the data rate will be reported. | ||
34 | Runs until aborted with CTRL-C. | ||
35 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
25 | configuration file to use | 36 | configuration file to use |
26 | .TP | 37 | .It Fl D | \-disconnect |
27 | \fB\-e \fB\-\-events\fR | 38 | force disconnection from a peer (used in conjunction with \-p). |
39 | Note that you can use the gnunet-ats command-line tool to suggest connects. | ||
40 | .It Fl e | \-events | ||
28 | provide information about all connect and disconnect events (continuously) | 41 | provide information about all connect and disconnect events (continuously) |
29 | .TP | 42 | .It Fl h | \-help |
30 | \fB\-h\fR, \fB\-\-help\fR | ||
31 | print help page | 43 | print help page |
32 | .TP | 44 | .It Fl i | \-information |
33 | \fB\-i\fR, \fB\-\-information\fR | ||
34 | print information about our current connections (once) | 45 | print information about our current connections (once) |
35 | .TP | 46 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
36 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR | ||
37 | Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | 47 | Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. |
38 | .TP | 48 | .It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE |
39 | \fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR | ||
40 | configure logging to write logs to LOGFILE | 49 | configure logging to write logs to LOGFILE |
41 | .TP | 50 | .It Fl m | \-monitor |
42 | \fB\-m\fR, \fB\-\-monitor\fR | ||
43 | print information about our current connections (continuously) | 51 | print information about our current connections (continuously) |
44 | .TP | 52 | .It Fl p Ar PEER | Fl \-peer= Ns Ar PEER |
45 | \fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR | ||
46 | the peer identity to connect to or monitor | 53 | the peer identity to connect to or monitor |
47 | .TP | 54 | .It Fl P | \-plugins |
48 | \fB\-P, \fB\-\-plugins\fR | ||
49 | monitor session state of transport plugins | 55 | monitor session state of transport plugins |
50 | .TP | 56 | .It Fl s | \-send |
51 | \fB\-s\fR, \fB\-\-send\fR | ||
52 | transmit (dummy) traffic as quickly as possible to the peer specified | 57 | transmit (dummy) traffic as quickly as possible to the peer specified |
53 | with the \-p option. The rate will still be limited by the quota(s) | 58 | with the \-p option. The rate will still be limited by the quota(s) |
54 | determined by the peers (ATS subsystem). Will run until CTRL\-C is | 59 | determined by the peers (ATS subsystem). Will run until CTRL\-C is |
55 | pressed or until the connection to the other peer is disrupted. | 60 | pressed or until the connection to the other peer is disrupted. |
56 | .TP | 61 | .It Fl v | \-version |
57 | \fB\-v\fR, \fB\-\-version\fR | ||
58 | print the version number | 62 | print the version number |
59 | .TP | 63 | .It Fl V | \-verbose |
60 | \fB\-V\fR, \fB\-\-verbose\fR | ||
61 | be verbose | 64 | be verbose |
62 | .SH "REPORTING BUGS" | 65 | .El |
63 | Report bugs by using mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 66 | .Sh SEE ALSO |
64 | .SH "SEE ALSO" | 67 | .Xr gnunet-arm 1 , |
65 | \fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1) | 68 | .Xr gnunet-ats 1 |
66 | The full documentation for | 69 | .sp |
67 | .B gnunet | 70 | The full documentation for gnunet is maintained as a Texinfo manual. |
68 | is maintained as a Texinfo manual. If the | 71 | If the |
69 | .B info | 72 | .Xr info 1 |
70 | and | 73 | and gnunet programs are properly installed at your site, the command |
71 | .B gnunet | 74 | .Pp |
72 | programs are properly installed at your site, the command | 75 | .Dl info gnunet |
73 | .IP | 76 | .Pp |
74 | .B info gnunet | ||
75 | .PP | ||
76 | should give you access to the complete handbook, | 77 | should give you access to the complete handbook, |
77 | .IP | 78 | .Pp |
78 | .B info gnunet-c-tutorial | 79 | .Dl info gnunet-c-tutorial |
79 | .PP | 80 | .Pp |
80 | will give you access to a tutorial for developers. | 81 | will give you access to a tutorial for developers. |
81 | .PP | 82 | .sp |
82 | Depending on your installation, this information is also | 83 | Depending on your installation, this information is also available in |
83 | available in | 84 | .Xr gnunet 7 and |
84 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 85 | .Xr gnunet-c-tutorial 7 . |
86 | .\".Sh HISTORY | ||
87 | .\".Sh AUTHORS | ||
88 | .Sh BUGS | ||
89 | Report bugs by using | ||
90 | .Lk https://bugs.gnunet.org | ||
91 | or by sending electronic mail to | ||
92 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-unindex.1 b/doc/man/gnunet-unindex.1 index 6aee4f62e..e953ce23a 100644 --- a/doc/man/gnunet-unindex.1 +++ b/doc/man/gnunet-unindex.1 | |||
@@ -1,58 +1,67 @@ | |||
1 | .TH GNUNET-UNINDEX "1" "September 6, 2009" "GNUnet" | 1 | .Dd September 6, 2009 |
2 | .SH NAME | 2 | .Dt GNUNET-UNINDEX 1 |
3 | gnunet\-unindex \- a command line interface for deleting indexed files from GNUnet | 3 | .Sh NAME |
4 | .SH SYNOPSIS | 4 | .Nm gnunet-unindex |
5 | .B gnunet\-unindex | 5 | .Nd |
6 | [\fIOPTIONS\fR] FILENAME | 6 | a command line interface for deleting indexed files from GNUnet |
7 | .SH DESCRIPTION | 7 | .Sh SYNOPSIS |
8 | .PP | 8 | .Nm |
9 | gnunet\-unindex is used for deleting indexed files from GNUnet. | 9 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
10 | .TP | 10 | .Op Fl h | \-help |
11 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | 11 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
12 | use config file (defaults: ~/.config/gnunet.conf) | 12 | .Op Fl v | \-version |
13 | .TP | 13 | .Op Fl V | \-verbose |
14 | \fB\-h\fR, \fB\-\-help\fR | 14 | FILENAME |
15 | .Sh DESCRIPTION | ||
16 | .Nm | ||
17 | is used for deleting indexed files from GNUnet. | ||
18 | .Bl -tag -width Ds | ||
19 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
20 | Use config file FILENAME as config (default: ~/.config/gnunet.conf). | ||
21 | .It Fl h | \-help | ||
15 | print help page | 22 | print help page |
16 | .TP | 23 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
17 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR | 24 | Change the loglevel. |
18 | Change the loglevel. Possible values for LOGLEVEL are NOTHING, | 25 | Possible values for LOGLEVEL are NOTHING, ERROR, WARNING, INFO and DEBUG. |
19 | ERROR, WARNING, INFO and DEBUG. | 26 | .It Fl v | \-version |
20 | .TP | ||
21 | \fB\-v\fR, \fB\-\-version\fR | ||
22 | print the version number | 27 | print the version number |
23 | .TP | 28 | .It Fl V | \-verbose |
24 | \fB\-V\fR, \fB\-\-verbose\fR | ||
25 | be verbose | 29 | be verbose |
26 | .SH NOTES | 30 | .El |
27 | You can only unindex files that you indexed and that you still have | 31 | .Sh NOTES |
28 | available locally in full. You should use gnunet\-unindex on files | 32 | You can only unindex files that you indexed and that you still have available locally in full. |
29 | that you indexed (not inserted) and that you are going to delete or | 33 | You should use gnunet-unindex on files that you indexed (not inserted) and that you are going to delete or move locally. |
30 | move locally. | 34 | .Sh FILES |
31 | .TP | ||
32 | .SH FILES | ||
33 | .TP | 35 | .TP |
34 | ~/.config/gnunet.conf | 36 | ~/.config/gnunet.conf |
35 | GNUnet configuration file | 37 | GNUnet configuration file |
36 | .SH "REPORTING BUGS" | 38 | .Sh SEE ALSO |
37 | Report bugs to <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 39 | .Xr gnunet-fs-gtk 1 , |
38 | .SH "SEE ALSO" | 40 | .Xr gnunet-publish 1 , |
39 | \fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1), \fBgnunet.conf\fP(5) | 41 | .Xr gnunet-search 1 , |
40 | The full documentation for | 42 | .Xr gnunet-download 1 , |
41 | .B gnunet | 43 | .Xr gnunet.conf 5 |
42 | is maintained as a Texinfo manual. If the | 44 | .sp |
43 | .B info | 45 | The full documentation for gnunet is maintained as a Texinfo manual. |
44 | and | 46 | If the |
45 | .B gnunet | 47 | .Xr info 1 |
46 | programs are properly installed at your site, the command | 48 | and gnunet programs are properly installed at your site, the command |
47 | .IP | 49 | .Pp |
48 | .B info gnunet | 50 | .Dl info gnunet |
49 | .PP | 51 | .Pp |
50 | should give you access to the complete handbook, | 52 | should give you access to the complete handbook, |
51 | .IP | 53 | .Pp |
52 | .B info gnunet-c-tutorial | 54 | .Dl info gnunet-c-tutorial |
53 | .PP | 55 | .Pp |
54 | will give you access to a tutorial for developers. | 56 | will give you access to a tutorial for developers. |
55 | .PP | 57 | .sp |
56 | Depending on your installation, this information is also | 58 | Depending on your installation, this information is also available in |
57 | available in | 59 | .Xr gnunet 7 and |
58 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 60 | .Xr gnunet-c-tutorial 7 . |
61 | .\".Sh HISTORY | ||
62 | .\".Sh AUTHORS | ||
63 | .Sh BUGS | ||
64 | Report bugs by using | ||
65 | .Lk https://bugs.gnunet.org | ||
66 | or by sending electronic mail to | ||
67 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-uri.1 b/doc/man/gnunet-uri.1 index 2fe1a05d2..bb525ef7f 100644 --- a/doc/man/gnunet-uri.1 +++ b/doc/man/gnunet-uri.1 | |||
@@ -1,49 +1,54 @@ | |||
1 | .TH GNUNET-URI 1 "June 26, 2012" "GNUnet" | 1 | .Dd June 26, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-URI 1 |
3 | gnunet\-uri \- invoke default handler for GNUnet URIs | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-uri | 5 | .Nm gnunet-uri |
6 | .RI URI | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | invoke default handler for GNUnet URIs |
8 | \fBgnunet\-uri\fP can be used to invoke the correct tool to handle a | 8 | .Sh SYNOPSIS |
9 | GNUnet URI. GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" | 9 | .Nm |
10 | and thus the specific tool to handle the URI depends on the subsystem. | 10 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
11 | gnunet\-uri will determine the correct tool (by looking for SUBSYSTEM | 11 | .Op Fl h | \-help |
12 | in the configuration section "uri") and invoke it. | 12 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
13 | .SH OPTIONS | 13 | .Op Fl v | \-version |
14 | .B | 14 | URI |
15 | .IP "\-c FILENAME, \-\-config=FILENAME" | 15 | .Sh DESCRIPTION |
16 | .Nm | ||
17 | can be used to invoke the correct tool to handle a GNUnet URI. | ||
18 | GNUnet URIs have the format "gnunet://SUBSYSTEM/DETAILS" and thus the specific tool to handle the URI depends on the subsystem. | ||
19 | gnunet-uri will determine the correct tool (by looking for SUBSYSTEM in the configuration section "uri") and invoke it. | ||
20 | .Bl -tag -width Ds | ||
21 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
16 | Use the configuration file FILENAME. | 22 | Use the configuration file FILENAME. |
17 | .B | 23 | .It Fl h | \-help |
18 | .IP "\-h, \-\-help" | ||
19 | Print short help on options. | 24 | Print short help on options. |
20 | .B | 25 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
21 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 26 | Use LOGLEVEL for logging. |
22 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 27 | Valid values are DEBUG, INFO, WARNING and ERROR. |
23 | .B | 28 | .It Fl v | \-version |
24 | .IP "\-v, \-\-version" | ||
25 | Print GNUnet version number. | 29 | Print GNUnet version number. |
26 | .SH BUGS | 30 | .El |
27 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 31 | .Sh SEE ALSO |
28 | electronic mail to <gnunet\-developers@gnu.org> | 32 | The full documentation for gnunet is maintained as a Texinfo manual. |
29 | .SH SEE ALSO | ||
30 | The full documentation for | ||
31 | .B gnunet | ||
32 | is maintained as a Texinfo manual. | ||
33 | If the | 33 | If the |
34 | .B info | 34 | .Xr info 1 |
35 | and | 35 | and gnunet programs are properly installed at your site, the command |
36 | .B gnunet | 36 | .Pp |
37 | programs are properly installed at your site, the command | 37 | .Dl info gnunet |
38 | .IP | 38 | .Pp |
39 | .B info gnunet | ||
40 | .PP | ||
41 | should give you access to the complete handbook, | 39 | should give you access to the complete handbook, |
42 | .IP | 40 | .Pp |
43 | .B info gnunet-c-tutorial | 41 | .Dl info gnunet-c-tutorial |
44 | .PP | 42 | .Pp |
45 | will give you access to a tutorial for developers. | 43 | will give you access to a tutorial for developers. |
46 | .PP | 44 | .sp |
47 | Depending on your installation, this information is also | 45 | Depending on your installation, this information is also available in |
48 | available in | 46 | .Xr gnunet 7 and |
49 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 47 | .Xr gnunet-c-tutorial 7 . |
48 | .\".Sh HISTORY | ||
49 | .\".Sh AUTHORS | ||
50 | .Sh BUGS | ||
51 | Report bugs by using | ||
52 | .Lk https://bugs.gnunet.org | ||
53 | or by sending electronic mail to | ||
54 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1 index ddb53a7bd..e0fd2b78c 100644 --- a/doc/man/gnunet-vpn.1 +++ b/doc/man/gnunet-vpn.1 | |||
@@ -1,101 +1,98 @@ | |||
1 | .TH GNUNET\-VPN 1 "February 25, 2012" "GNUnet" | 1 | .Dd February 25, 2012 |
2 | .SH NAME | 2 | .Dt GNUNET-VPN 1 |
3 | gnunet\-vpn \- manually setup a GNUnet VPN tunnel | 3 | .Sh NAME |
4 | .SH SYNOPSIS | 4 | .Nm gnunet-vpn |
5 | .B gnunet\-vpn | 5 | .Nd |
6 | .RI [ options ] | 6 | manually setup a GNUnet VPN tunnel |
7 | .br | 7 | .Sh SYNOPSIS |
8 | .SH DESCRIPTION | 8 | .Nm |
9 | \fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the | 9 | .Op Fl 4 | \-ipv4 |
10 | GNUnet network. | 10 | .Op Fl 6 | \-ipv6 |
11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
12 | .Op Fl d Ar TIME | Fl \-duration Ar TIME | ||
13 | .Op Fl h | \-help | ||
14 | .Op Fl i Ar IP | Fl \-ip Ar IP | ||
15 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
16 | .Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID | ||
17 | .Op Fl s Ar NAME | Fl \-service= Ns Ar NAME | ||
18 | .Op Fl t | \-tcp | ||
19 | .Op Fl u | \-udp | ||
20 | .Op Fl V | \-verbose | ||
21 | .Op Fl v | \-version | ||
22 | .Sh DESCRIPTION | ||
23 | .Nm | ||
24 | can be used to manually setup a VPN tunnel via the GNUnet network. | ||
11 | There are two main types of tunnels. | 25 | There are two main types of tunnels. |
12 | Tunnels to an exit node which routes the traffic to the global | 26 | Tunnels to an exit node which routes the traffic to the global Internet, and tunnels to a node that runs a service only within GNUnet. |
13 | Internet, and tunnels to a node that runs a service only within | ||
14 | GNUnet. | ||
15 | Depending on the type of tunnel, gnunet\-vpn takes different options. | 27 | Depending on the type of tunnel, gnunet\-vpn takes different options. |
16 | The "\-i" option is required for tunnels to an exit node, whereas the | 28 | The "\-i" option is required for tunnels to an exit node, whereas the "\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are required for tunnels to services. |
17 | "\-p" and "\-s" options in conjunction with either "\-u" or "\-t" are | ||
18 | required for tunnels to services. | ||
19 | For exit tunnels, both UDP and TCP traffic will be redirected. | 29 | For exit tunnels, both UDP and TCP traffic will be redirected. |
20 | For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will | 30 | For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected. |
21 | be redirected. | ||
22 | The tool will display the IP address for this end of the tunnel. | 31 | 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 | 32 | The address can be displayed as soon as it has been allocated, or only after ("\-a") the tunnel has been created. |
24 | after ("\-a") the tunnel has been created. | 33 | .Bl -tag -width Ds |
25 | .SH OPTIONS | 34 | .It Fl 4 | \-ipv4 |
26 | .B | ||
27 | .IP "\-4, \-\-ipv4" | ||
28 | Desired IP address on this end of the tunnel should be an IPv4 address. | 35 | Desired IP address on this end of the tunnel should be an IPv4 address. |
29 | .B | 36 | .It Fl 6 | \-ipv6 |
30 | .IP "\-6, \-\-ipv6" | ||
31 | Desired IP address on this end of the tunnel should be an IPv6 address. | 37 | Desired IP address on this end of the tunnel should be an IPv6 address. |
32 | .B | 38 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
33 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
34 | Use the configuration file FILENAME. | 39 | Use the configuration file FILENAME. |
35 | .B | 40 | .It Fl d Ar TIME | Fl \-duration Ar TIME |
36 | .IP "\-d TIME, \-\-duration TIME" | ||
37 | The mapping should be established for TIME. | 41 | The mapping should be established for TIME. |
38 | The value given must be a number followed by a space and a time unit, | 42 | The value given must be a number followed by a space and a time unit, for example "500 ms". |
39 | for example "500 ms". | ||
40 | Note that the quotes are required on the shell. | 43 | Note that the quotes are required on the shell. |
41 | Default is 5 minutes. | 44 | Default is 5 minutes. |
42 | .B | 45 | .It Fl h | \-help |
43 | .IP "\-h, \-\-help" | ||
44 | Print short help on options. | 46 | Print short help on options. |
45 | .B | 47 | .It Fl i Ar IP | Fl \-ip Ar IP |
46 | .IP "\-i IP, \-\-ip IP" | ||
47 | Tunnel should be to an exit node and connect to the given IPv4 or IPv6 | 48 | Tunnel should be to an exit node and connect to the given IPv4 or IPv6 |
48 | IP address. | 49 | IP address. |
49 | Note that you can specify an IPv6 address as the target here, even in | 50 | Note that you can specify an IPv6 address as the target here, even in |
50 | combination with "\-4" (4to6) and similarly you can specify an IPv4 | 51 | combination with "\-4" (4to6) and similarly you can specify an IPv4 |
51 | address in combination with "\-6" (6to4). | 52 | address in combination with "\-6" (6to4). |
52 | .B | 53 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
53 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
54 | Use LOGLEVEL for logging. | 54 | Use LOGLEVEL for logging. |
55 | Valid values are DEBUG, INFO, WARNING and ERROR. | 55 | Valid values are DEBUG, INFO, WARNING and ERROR. |
56 | .B | 56 | .It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID |
57 | .IP "\-p PEERID, \-\-peer=PEERID" | ||
58 | Name of the peer offering the service to connect to. | 57 | Name of the peer offering the service to connect to. |
59 | Cannot be used in conjunction with "\-i", requires "\-s". | 58 | Cannot be used in conjunction with "\-i", requires "\-s". |
60 | .B | 59 | .It Fl s Ar NAME | Fl \-service= Ns Ar NAME |
61 | .IP "\-s NAME, \-\-service=NAME" | ||
62 | Name of the service running on the target peer. | 60 | Name of the service running on the target peer. |
63 | Cannot be used in conjunction with "\-i", requires "\-p". | 61 | Cannot be used in conjunction with "\-i", requires "\-p". |
64 | .B | 62 | .It Fl t | \-tcp |
65 | .IP "\-t, \-\-tcp" | ||
66 | Service runs TCP. | 63 | Service runs TCP. |
67 | Either "\-t" or "\-u" must be specified when using "\-s". | 64 | Either "\-t" or "\-u" must be specified when using "\-s". |
68 | .B | 65 | .It Fl u | \-udp |
69 | .IP "\-u, \-\-udp" | ||
70 | Service runs UDP. | 66 | Service runs UDP. |
71 | Either "\-t" or "\-u" must be specified when using "\-s". | 67 | Either "\-t" or "\-u" must be specified when using "\-s". |
72 | .B | 68 | .It Fl V | \-verbose |
73 | .IP "\-V, \-\-verbose" | ||
74 | Be verbose. | 69 | Be verbose. |
75 | .B | 70 | .It Fl v | \-version |
76 | .IP "\-v, \-\-version" | ||
77 | Print GNUnet version number. | 71 | Print GNUnet version number. |
78 | .SH BUGS | 72 | .El |
79 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 73 | .Sh SEE ALSO |
80 | electronic mail to <gnunet\-developers@gnu.org> | 74 | .Xr gnunet-setup 1 |
81 | .SH SEE ALSO | 75 | .sp |
82 | gnunet\-setup(1) | 76 | The full documentation for gnunet is maintained as a Texinfo manual. |
83 | The full documentation for | 77 | If the |
84 | .B gnunet | 78 | .Xr info 1 |
85 | is maintained as a Texinfo manual. If the | 79 | and gnunet programs are properly installed at your site, the command |
86 | .B info | 80 | .Pp |
87 | and | 81 | .Dl info gnunet |
88 | .B gnunet | 82 | .Pp |
89 | programs are properly installed at your site, the command | ||
90 | .IP | ||
91 | .B info gnunet | ||
92 | .PP | ||
93 | should give you access to the complete handbook, | 83 | should give you access to the complete handbook, |
94 | .IP | 84 | .Pp |
95 | .B info gnunet-c-tutorial | 85 | .Dl info gnunet-c-tutorial |
96 | .PP | 86 | .Pp |
97 | will give you access to a tutorial for developers. | 87 | will give you access to a tutorial for developers. |
98 | .PP | 88 | .sp |
99 | Depending on your installation, this information is also | 89 | Depending on your installation, this information is also available in |
100 | available in | 90 | .Xr gnunet 7 and |
101 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 91 | .Xr gnunet-c-tutorial 7 . |
92 | .\".Sh HISTORY | ||
93 | .\".Sh AUTHORS | ||
94 | .Sh BUGS | ||
95 | Report bugs by using | ||
96 | .Lk https://bugs.gnunet.org | ||
97 | or by sending electronic mail to | ||
98 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet-zoneimport.1 b/doc/man/gnunet-zoneimport.1 index 2a67718f9..e99b235b8 100644 --- a/doc/man/gnunet-zoneimport.1 +++ b/doc/man/gnunet-zoneimport.1 | |||
@@ -1,90 +1,106 @@ | |||
1 | .TH GNUNET-ZONEIMPORT 1 "April 23, 2018" "GNUnet" | 1 | .\" This file is part of GNUnet. |
2 | .SH NAME | 2 | .\" Copyright (C) 2018, 2019 GNUnet e.V. |
3 | gnunet\-zoneimport \- import DNS zone into GNS zone | 3 | .\" |
4 | .SH SYNOPSIS | 4 | .\" Permission is granted to copy, distribute and/or modify this document |
5 | .B gnunet\-zoneimport [IP]+ | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
6 | .SH DESCRIPTION | 6 | .\" any later version published by the Free Software Foundation; with no |
7 | \fBgnunet\-zoneimport\fP reads a list of domain names (FQDN) from | 7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
8 | stdin and issues DNS queries for each of the domain names given. It | 8 | .\" copy of the license is included in the file |
9 | then checks if a local ego with a name matching the domain | 9 | .\" ``FDL-1.3''. |
10 | exists. Specifically, if the domain name is "example.fr", it will | 10 | .\" |
11 | check if an ego "fr" exists, while for a domain "example.com.fr" it | 11 | .\" A copy of the license is also available from the Free Software |
12 | will look for an ego called "com.fr"). If so, it will convert the DNS | 12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. |
13 | records into GNS records (in particular converting NS records and glue | 13 | .\" |
14 | records to GNS2DNS records) and add them to the namestore under the | 14 | .\" Alternately, this document is also available under the General |
15 | label ("example" in the examples above). | 15 | .\" Public License, version 3 or later, as published by the Free Software |
16 | .PP | 16 | .\" Foundation. A copy of the license is included in the file |
17 | The arguments given to gnunet\-zoneimport is a list of IP addresses of | 17 | .\" ``GPL3''. |
18 | DNS servers to query. | 18 | .\" |
19 | .PP | 19 | .\" A copy of the license is also available from the Free Software |
20 | gnunet\-zoneimport will usually never terminate: it will check when | 20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. |
21 | DNS records expire, and re-issue requests when the old DNS records | 21 | .\" |
22 | have expired so that GNS always has the latest data. | 22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later |
23 | .PP | 23 | .\" |
24 | gnunet\-zoneimport will issue many DNS queries in parallel, but is | 24 | .Dd April 23, 2018 |
25 | rate-limited in various ways, so most DNS servers should easily handle | 25 | .Dt GNUNET-ZONEIMPORT 1 |
26 | the load. gnunet\-zoneimport will perform a limited number of retries | 26 | .Os |
27 | if queries fail. | 27 | .Sh NAME |
28 | .PP | 28 | .Nm gnunet-zoneimport |
29 | gnunet\-zoneimport operates incrementally. It will check if the | 29 | .Nd |
30 | namestore already has (non-expired) records stored for a given name in | 30 | import DNS zone into GNS zone |
31 | the respective zone and not issue those requests again. Thus, it is | 31 | .Sh SYNOPSIS |
32 | fine to restart gnunet\-zoneimport whenever the list of domain names | 32 | .Nm |
33 | changes. | 33 | .Op Fl c Ar FILENAME | \-config= Ns Ar FILENAME |
34 | .PP | 34 | .Op Fl h | \-help |
35 | Finally, gnunet\-zoneimport keeps information for each domain name in | 35 | .Op Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME |
36 | memory. This consumes about 200 bytes per domain name, or 1 GB for 5 | 36 | .Op Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE |
37 | million labels. | 37 | .Op Ar \IP |
38 | .SH OPTIONS | 38 | .Sh DESCRIPTION |
39 | .B | 39 | .Nm |
40 | .IP "\-c FILENAME, \-\-config=FILENAME" | 40 | reads a list of domain names (FQDN) from stdin and issues DNS queries for each of the domain names given. |
41 | It then checks if a local ego with a name matching the domain exists. | ||
42 | Specifically, if the domain name is "example.fr", it will check if an ego "fr" exists, while for a domain "example.com.fr" it will look for an ego called "com.fr"). | ||
43 | If so, it will convert the DNS records into GNS records (in particular converting NS records and glue records to GNS2DNS records) and add them to the namestore under the label ("example" in the examples above). | ||
44 | .Pp | ||
45 | The arguments given to gnunet-zoneimport is a list of IP addresses of DNS servers to query. | ||
46 | .Pp | ||
47 | gnunet-zoneimport will usually never terminate: it will check when DNS records expire, and re-issue requests when the old DNS records have expired so that GNS always has the latest data. | ||
48 | .Pp | ||
49 | gnunet-zoneimport will issue many DNS queries in parallel, but is rate-limited in various ways, so most DNS servers should easily handle the load. | ||
50 | gnunet-zoneimport will perform a limited number of retries if queries fail. | ||
51 | .Pp | ||
52 | gnunet-zoneimport operates incrementally. | ||
53 | It will check if the namestore already has (non-expired) records stored for a given name in the respective zone and not issue those requests again. | ||
54 | Thus, it is fine to restart gnunet-zoneimport whenever the list of domain names changes. | ||
55 | .Pp | ||
56 | Finally, gnunet-zoneimport keeps information for each domain name in memory. | ||
57 | This consumes about 200 bytes per domain name, or 1 GB for 5 million labels. | ||
58 | .Bl -tag -width Ds | ||
59 | .It Fl c Ar FILENAME | \-config= Ns Ar FILENAME | ||
41 | Use the configuration file FILENAME. | 60 | Use the configuration file FILENAME. |
42 | .B | 61 | .It Fl h | \-help |
43 | .IP "\-h, \-\-help" | ||
44 | Print short help on options. | 62 | Print short help on options. |
45 | .B | 63 | .It Fl m Ar RELATIVETIME | Fl \-minimum-expiration= Ns Ar RELATIVETIME |
46 | .IP "\-m RELATIVETIME, \-\-minimum-expiration=RELATIVETIME" | 64 | Ensure that imported DNS records never have an expiration time that is less than RELATIVETIME into the future. |
47 | .B | 65 | RELATIVETIME is a time given like "1 week" or "1 h". |
48 | Ensure that imported DNS records never have an expiration time that | 66 | If DNS returns records with a shorter lifetime, gnunet\-zoneimport will simply bump the lifetime to the specified value (relative to the time of the import). |
49 | is less than RELATIVETIME into the future. RELATIVETIME is a time | 67 | Default is zero. |
50 | given like "1 week" or "1 h". If DNS returns records with a shorter | 68 | .It Fl s Ar MAPSIZE | Fl \-size= Ns Ar MAPSIZE |
51 | lifetime, gnunet\-zoneimport will simply bump the lifetime to the | 69 | Specifies the size (in number of entries) to use for the main hash map. |
52 | specified value (relative to the time of the import). Default is zero. | 70 | The value provided should be at least twice the number of domain names that will be given to the tool. |
53 | .IP "\-s MAPSIZE, \-\-size=MAPSIZE" | 71 | This option is required for very large zones where the number of records encountered is too large for the automatic growth mechanism to work (that one is limited to at most 16 MB allocations for security reasons). |
54 | Specifies the size (in number of entries) to use for the main hash | 72 | Do not worry about this unless you are importing millions of domain names from a zone. |
55 | map. The value provided should be at least twice the number of domain | 73 | .It Ar \IP |
56 | names that will be given to the tool. This option is required for very | 74 | IP Is the list of IPs given. |
57 | large zones where the number of records encountered is too large for | 75 | .El |
58 | the automatic growth mechanism to work (that one is limited to at most | 76 | .Sh EXAMPLES |
59 | 16 MB allocations for security reasons). Do not worry about this | ||
60 | unless you are importing millions of domain names from a zone. | ||
61 | .SH NOTES | ||
62 | .TP | ||
63 | Typical invocaton would be: | 77 | Typical invocaton would be: |
64 | $ gnunet\-zoneimport 1.2.3.4 < names.txt | 78 | .Pp |
65 | .SH BUGS | 79 | .Dl $ gnunet\-zoneimport 1.2.3.4 < names.txt |
66 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 80 | .Sh SEE ALSO |
67 | electronic mail to <gnunet\-developers@gnu.org> | 81 | .Xr gnunet-gns 1 , |
68 | .SH SEE ALSO | 82 | .Xr gnunet-namestore 1 |
69 | gnunet\-gns(1), gnunet\-namestore(1) | 83 | .sp |
70 | .PP | 84 | The full documentation for gnunet is maintained as a Texinfo manual. |
71 | The full documentation for | ||
72 | .B gnunet | ||
73 | is maintained as a Texinfo manual. | ||
74 | If the | 85 | If the |
75 | .B info | 86 | .Xr info 1 |
76 | and | 87 | and gnunet programs are properly installed at your site, the command |
77 | .B gnunet | 88 | .Pp |
78 | programs are properly installed at your site, the command | 89 | .Dl info gnunet |
79 | .IP | 90 | .Pp |
80 | .B info gnunet | ||
81 | .PP | ||
82 | should give you access to the complete handbook, | 91 | should give you access to the complete handbook, |
83 | .IP | 92 | .Pp |
84 | .B info gnunet-c-tutorial | 93 | .Dl info gnunet-c-tutorial |
85 | .PP | 94 | .Pp |
86 | will give you access to a tutorial for developers. | 95 | will give you access to a tutorial for developers. |
87 | .PP | 96 | .sp |
88 | Depending on your installation, this information is also | 97 | Depending on your installation, this information is also available in |
89 | available in | 98 | .Xr gnunet 7 and |
90 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 99 | .Xr gnunet-c-tutorial 7 . |
100 | .\".Sh HISTORY | ||
101 | .\".Sh AUTHORS | ||
102 | .Sh BUGS | ||
103 | Report bugs by using | ||
104 | .Lk https://bugs.gnunet.org | ||
105 | or by sending electronic mail to | ||
106 | .Aq Mt gnunet-developers@gnu.org . | ||
diff --git a/doc/man/gnunet.conf.5.in b/doc/man/gnunet.conf.5.in index 560704784..82340996a 100644 --- a/doc/man/gnunet.conf.5.in +++ b/doc/man/gnunet.conf.5.in | |||
@@ -1,4 +1,27 @@ | |||
1 | .\" -*- mode: nroff -*- | 1 | .\" -*- mode: nroff -*- |
2 | .\" This file is part of Ascension. | ||
3 | .\" Copyright (C) 2012-2015,2018,2019 GNUnet e.V. | ||
4 | .\" | ||
5 | .\" Permission is granted to copy, distribute and/or modify this document | ||
6 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
7 | .\" any later version published by the Free Software Foundation; with no | ||
8 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
9 | .\" copy of the license is included in the file | ||
10 | .\" ``FDL-1.3''. | ||
11 | .\" | ||
12 | .\" A copy of the license is also available from the Free Software | ||
13 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. | ||
14 | .\" | ||
15 | .\" Alternately, this document is also available under the General | ||
16 | .\" Public License, version 3 or later, as published by the Free Software | ||
17 | .\" Foundation. A copy of the license is included in the file | ||
18 | .\" ``GPL3''. | ||
19 | .\" | ||
20 | .\" A copy of the license is also available from the Free Software | ||
21 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
22 | .\" | ||
23 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
24 | .\" | ||
2 | .TH GNUNET.CONF "5" "October 26, 2018" "GNUnet" | 25 | .TH GNUNET.CONF "5" "October 26, 2018" "GNUnet" |
3 | .SH NAME | 26 | .SH NAME |
4 | gnunet.conf \- GNUnet configuration file | 27 | gnunet.conf \- GNUnet configuration file |
@@ -27,7 +50,7 @@ Default values for all of the options can be found in the files in the | |||
27 | "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will | 50 | "$GNUNET_PREFIX/share/gnunet/config.d/" directory. A typical setup will |
28 | work out of the box with those. See the examples section below for | 51 | work out of the box with those. See the examples section below for |
29 | some common setups on top of that. | 52 | some common setups on top of that. |
30 | .SH General OPTIONS | 53 | .SS GENERAL OPTIONS |
31 | Many options will be common between sections. They can be repeated under | 54 | Many options will be common between sections. They can be repeated under |
32 | each section with different values. The "[PATHS]" section is special. | 55 | each section with different values. The "[PATHS]" section is special. |
33 | Here, it is possible to specify values for variables like "GNUNET_HOME". | 56 | Here, it is possible to specify values for variables like "GNUNET_HOME". |
@@ -85,7 +108,7 @@ The following options are generic and shared by all services: | |||
85 | Set to YES if this service should be run per-user, NO if this is a system | 108 | Set to YES if this service should be run per-user, NO if this is a system |
86 | service. End-users should never have to change the defaults GNUnet provides | 109 | service. End-users should never have to change the defaults GNUnet provides |
87 | for this option. | 110 | for this option. |
88 | .SH ATS Options | 111 | .SS ATS OPTIONS |
89 | .IP UNSPECIFIED_QUOTA_IN | 112 | .IP UNSPECIFIED_QUOTA_IN |
90 | quotes in KiB or MiB per seconds. Or use the word "unlimited" | 113 | quotes in KiB or MiB per seconds. Or use the word "unlimited" |
91 | .IP UNSPECIFIED_QUOTA_OUT | 114 | .IP UNSPECIFIED_QUOTA_OUT |
@@ -109,12 +132,11 @@ The following options are generic and shared by all services: | |||
109 | .SH EXAMPLES | 132 | .SH EXAMPLES |
110 | This example is a simple way to get started, using a server that has a known | 133 | This example is a simple way to get started, using a server that has a known |
111 | list of peers to get you started. Most users will be behind a firewall on | 134 | list of peers to get you started. Most users will be behind a firewall on |
112 | IPv4, as such NAT is enabled. Please rememeber to change your IP address | 135 | IPv4, as such NAT is enabled. Please remember to change your IP address |
113 | to the actual external address for your usage. | 136 | to the actual external address for your usage. |
114 | .PP | 137 | .PP |
115 | [hostlist] | 138 | [hostlist] |
116 | OPTIONS = \-b | 139 | OPTIONS = \-b \-e |
117 | SERVERS = http://v9.gnunet.org:58080/ | ||
118 | 140 | ||
119 | [nat] | 141 | [nat] |
120 | BEHIND_NAT = YES | 142 | BEHIND_NAT = YES |
@@ -129,9 +151,6 @@ to the actual external address for your usage. | |||
129 | .TP | 151 | .TP |
130 | ~/.config/gnunet.conf | 152 | ~/.config/gnunet.conf |
131 | GNUnet configuration file | 153 | GNUnet configuration file |
132 | .SH BUGS | ||
133 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | ||
134 | electronic mail to <bug-gnunet@gnu.org> | ||
135 | .SH SEE ALSO | 154 | .SH SEE ALSO |
136 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) | 155 | \fBgnunet\-setup\fP(1), \fBgnunet\-arm\fP(1) |
137 | .PP | 156 | .PP |
@@ -155,3 +174,9 @@ will give you access to a tutorial for developers. | |||
155 | Depending on your installation, this information is also | 174 | Depending on your installation, this information is also |
156 | available in | 175 | available in |
157 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 176 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). |
177 | .SH HISTORY | ||
178 | .PP | ||
179 | This man page first appeared in October 2012 in GNUnet. | ||
180 | .SH BUGS | ||
181 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | ||
182 | electronic mail to <bug-gnunet@gnu.org> | ||
diff --git a/doc/man/produce_html.sh b/doc/man/produce_html.sh new file mode 100755 index 000000000..ce6dea304 --- /dev/null +++ b/doc/man/produce_html.sh | |||
@@ -0,0 +1,14 @@ | |||
1 | #!/bin/sh | ||
2 | |||
3 | existence() | ||
4 | { | ||
5 | command -v "$1" >/dev/null 2>&1 | ||
6 | } | ||
7 | |||
8 | if existence mandoc; | ||
9 | then | ||
10 | for f in `find . -name \*\.[1-9]`; | ||
11 | do | ||
12 | mandoc -T html $f > $f.html; | ||
13 | done | ||
14 | fi | ||
diff --git a/doc/man/texi2mdoc-generation.sh b/doc/man/texi2mdoc-generation.sh new file mode 100755 index 000000000..b88987cda --- /dev/null +++ b/doc/man/texi2mdoc-generation.sh | |||
@@ -0,0 +1,15 @@ | |||
1 | #!/bin/sh | ||
2 | # This script is in the public-domain. | ||
3 | # GNUnet e.V. 2019 | ||
4 | # | ||
5 | # Commentary: generate texi2mdoc output. This would be easier with | ||
6 | # bmake / BSDmake, oh well. | ||
7 | # | ||
8 | # Excercise for future readers: don't fix this. | ||
9 | |||
10 | # echo $(pwd) | ||
11 | cd ../tutorial | ||
12 | texi2mdoc -I$(pwd):$(pwd)/chapters gnunet-tutorial.texi > ../man/gnunet-c-tutorial.7 | ||
13 | # echo $(pwd) | ||
14 | cd ../handbook | ||
15 | texi2mdoc -I$(pwd):$(pwd)/chapters gnunet.texi > ../man/gnunet-documentation.7 | ||