summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-12-10 17:11:06 +0000
committerChristian Grothoff <christian@grothoff.org>2014-12-10 17:11:06 +0000
commitb8fc68d6cb81adb3803186359b3a30b1a4bb7b5a (patch)
treebe6defbdf18e3af9bdcc979cf27b253fe0b4d5f9 /doc
parent3871fc32bbd05da817d94f4188023a4edebc367a (diff)
moving away from DEFAULTSERVICES to per-section FORCESTART, thus addressing #3565 indirectly
Diffstat (limited to 'doc')
-rw-r--r--doc/gnunet-c-tutorial.tex4
-rw-r--r--doc/man/gnunet-auto-share.15
-rw-r--r--doc/man/gnunet-namestore-fcfsd.12
-rw-r--r--doc/man/gnunet.conf.510
4 files changed, 7 insertions, 14 deletions
diff --git a/doc/gnunet-c-tutorial.tex b/doc/gnunet-c-tutorial.tex
index debfa8477..83a740c99 100644
--- a/doc/gnunet-c-tutorial.tex
+++ b/doc/gnunet-c-tutorial.tex
@@ -402,7 +402,7 @@ by you.
If you want to use the \texttt{peerinfo} tool to connect your peers, you should:
\begin{itemize}
\itemsep0em
- \item{Remove {\tt hostlist} from {\tt DEFAULTSERVICES} (to not connect to the global GNUnet)}
+ \item{Set {\tt FORCESTART = NO} in section {\tt hostlist} (to not connect to the global GNUnet)}
\item{Start both peers running {\tt gnunet-arm -c peer1.conf -s} and {\tt gnunet-arm -c peer2.conf -s}}
\item{Get \texttt{HELLO} message of the first peer running {\tt gnunet-peerinfo -c peer1.conf -g}}
\item{Give the output to the second peer by running {\tt gnunet-peerinfo -c peer2.conf -p '<output>'}}
@@ -1120,7 +1120,7 @@ Each data record stored with PEERSTORE contains the following fields:
\begin{itemize}
\itemsep0em
- \item subsystem: Name of the subsystem responsible for the record.
+ \item subsystem: Name of the subsystem responsible for the record.
\item peerid: Identity of the peer this record is related to.
\item key: a key string identifying the record.
\item value: binary record value.
diff --git a/doc/man/gnunet-auto-share.1 b/doc/man/gnunet-auto-share.1
index 24adf905a..dd3d93611 100644
--- a/doc/man/gnunet-auto-share.1
+++ b/doc/man/gnunet-auto-share.1
@@ -69,12 +69,9 @@ Share a directory "$HOME/gnunet\-share/":
Share a directory "$HOME/gnunet\-share/":
- [ARM]
- DEFAULTSERVICES = gnunet-auto-share # other default services here
-
[gnunet-auto-share]
OPTIONS = $HOME/gnunet\-share
-
+ FORCESTART = YES # start this service when the peer starts
.SH FILES
.TP
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index 403813ae0..3160910d4 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -11,7 +11,7 @@ gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Serv
.SH DESCRIPTION
Most users will not want to run an FCFS\-zone and thus will not need this program.
-\fBgnunet\-gns-fcfsd\fP runs a web server where users can register names to be mapped to their GNS zone. Names are made available on a First Come First Served basis (hence fcfs). Registered names do not expire. The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". The key of the zone in which the names are registered must be specified under the name "ZONEKEY" in the same section. It is possible to manage gnunet\-gns\-fcfsd using gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i fcfsd" or by adding "fcfds" to the "DEFAULTSERVICES" option.
+\fBgnunet\-gns-fcfsd\fP runs a web server where users can register names to be mapped to their GNS zone. Names are made available on a First Come First Served basis (hence fcfs). Registered names do not expire. The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT". The key of the zone in which the names are registered must be specified under the name "ZONEKEY" in the same section. It is possible to manage gnunet\-gns\-fcfsd using gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i fcfsd" or by setting "FORCESTART=YES" in the "fcfds" section of your configuration.
An FCFS\-zone is run at http://gnunet.org/fcfs/. The respective zone key can be imported into an individual user's zone using "gnunet-gns-import.sh". GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
diff --git a/doc/man/gnunet.conf.5 b/doc/man/gnunet.conf.5
index 1e759c6b1..d668c81fa 100644
--- a/doc/man/gnunet.conf.5
+++ b/doc/man/gnunet.conf.5
@@ -24,8 +24,10 @@ The following options are generic and shared by all services:
The hostname specifies the machine on which the service is running. This is usually "localhost".
.IP BINARY
The filename that implements the service. For example "gnunet-service-ats".
+.IP FORCESTART
+ Start the service always when the peer starts. Set to YES for services that should always be launched, even if no other service explicitly needs them.
.IP AUTOSTART
- This defines the section it is defined in, which should be a service, will be started by the ARM service if the value is set to YES.
+ Set to YES to automatically start the service when it is requested by another service. YES for most GNUnet services.
.IP ACCEPT_FROM
A semi-column separated list of IPv4 addresses that are allowed to use the service; usually 127.0.0.1.
.IP ACCEPT_FROM6
@@ -41,12 +43,6 @@ The following options are generic and shared by all services:
-.SH ARM Options
-
-This section is configuration for the automatic restart manager which is responsible for launching services.
-
-.IP DEFAULTSERVICES
- list of services that ARM should always start by default. AUTOSTART services are only started when the service is needed by some other service. The services listed here will always be started, not just on-demand. "topology" and "hostlist" should virtually always be listed here, and most users will want to specify high-level applications like "fs", "gns" or "pt" here as well.
.B
.SH ATS Options