aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet.conf.5.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet.conf.5.in')
-rw-r--r--doc/man/gnunet.conf.5.in41
1 files changed, 33 insertions, 8 deletions
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
4gnunet.conf \- GNUnet configuration file 27gnunet.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
28work out of the box with those. See the examples section below for 51work out of the box with those. See the examples section below for
29some common setups on top of that. 52some common setups on top of that.
30.SH General OPTIONS 53.SS GENERAL OPTIONS
31Many options will be common between sections. They can be repeated under 54Many options will be common between sections. They can be repeated under
32each section with different values. The "[PATHS]" section is special. 55each section with different values. The "[PATHS]" section is special.
33Here, it is possible to specify values for variables like "GNUNET_HOME". 56Here, 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
110This example is a simple way to get started, using a server that has a known 133This example is a simple way to get started, using a server that has a known
111list of peers to get you started. Most users will be behind a firewall on 134list of peers to get you started. Most users will be behind a firewall on
112IPv4, as such NAT is enabled. Please rememeber to change your IP address 135IPv4, as such NAT is enabled. Please remember to change your IP address
113to the actual external address for your usage. 136to 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
131GNUnet configuration file 153GNUnet configuration file
132.SH BUGS
133Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
134electronic 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.
155Depending on your installation, this information is also 174Depending on your installation, this information is also
156available in 175available 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
179This man page first appeared in October 2012 in GNUnet.
180.SH BUGS
181Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
182electronic mail to <bug-gnunet@gnu.org>