aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-namestore-fcfsd.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-namestore-fcfsd.1')
-rw-r--r--doc/man/gnunet-namestore-fcfsd.1158
1 files changed, 98 insertions, 60 deletions
diff --git a/doc/man/gnunet-namestore-fcfsd.1 b/doc/man/gnunet-namestore-fcfsd.1
index c1eca224f..cbfe39719 100644
--- a/doc/man/gnunet-namestore-fcfsd.1
+++ b/doc/man/gnunet-namestore-fcfsd.1
@@ -1,66 +1,104 @@
1.TH GNUNET-NAMESTORE-FCFSD 1 "September 5, 2013" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-namestore-fcfsd \- HTTP server for GNU Name System First-Come-First-Served name registration 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-namestore-fcfsd 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
8Most users will not want to run an FCFS\-zone and thus will not need 8.\" copy of the license is included in the file
9this program. 9.\" ``FDL-1.3''.
10.PP 10.\"
11\fBgnunet\-gns-fcfsd\fP runs a web server where users can register 11.\" A copy of the license is also available from the Free Software
12names to be mapped to their GNS zone. Names are made available on a 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13First Come First Served basis (hence fcfs). Registered names do not 13.\"
14expire. The HTTP server is run on the port that is specified in the 14.\" Alternately, this document is also available under the General
15configuration file in section "[fcfsd]" under the name "HTTPPORT". 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
17It is possible to manage gnunet\-gns\-fcfsd using 17.\" ``GPL3''.
18gnunet\-(service\-arm) by starting the daemon using "gnunet\-arm \-i 18.\"
19fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your 19.\" A copy of the license is also available from the Free Software
20configuration and the "-z ZONE" in as the "OPTION". 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.PP 21.\"
22An FCFS\-zone is run at http://gnunet.org/fcfs/. GNS users are 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23encouraged to register their zone with the gnunet.org FCFS authority. 23.\"
24.PP 24.Dd September 5, 2013
25If you want to run your own FCFS registrar, you need to first create a 25.Dt GNUNET-NAMESTORE-FCFSD 1
26pseudonym (using "gnunet\-identity \-C NAME"), and use it with the 26.Os
27"-z" option. After that, you can start the FCFSD service (possibly using 27.Sh NAME
28gnunet\-arm). 28.Nm gnunet-namestore-fcfsd
29.SH OPTIONS 29.Nd
30.IP "\-c FILENAME, \-\-config=FILENAME" 30HTTP server for GNU Name System First-Come-First-Served name registration
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl h | \-help
35.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
36.Op Fl v | \-version
37.Op Fl z Ar EGO | \-zone= Ns Ar EGO
38.Sh DESCRIPTION
39Most users will not want to run an FCFS-zone and thus will not need this program.
40.Pp
41.Nm
42runs a web server where users can register names to be mapped to their GNS zone.
43Names are made available on a First Come First Served basis (hence fcfs).
44Registered names do not expire.
45The HTTP server is run on the port that is specified in the configuration file in section "[fcfsd]" under the name "HTTPPORT".
46.Pp
47It is possible to manage gnunet-gns-fcfsd using gnunet-(service-arm) by starting the daemon using "gnunet-arm -i fcfsd" or by setting "IMMEDIATE_START=YES" in the "fcfds" section of your configuration and the "-z ZONE" in as the "OPTION".
48.Pp
49An FCFS-zone is run at
50.Lk http://gnunet.org/fcfs/ .
51GNS users are encouraged to register their zone with the gnunet.org FCFS authority.
52.Pp
53If you want to run your own FCFS registrar, you need to first create a pseudonym (using "gnunet-identity -C NAME"), and use it with the
54.Fl z
55option.
56After that, you can start the FCFSD service (possibly using
57.Xr gnunet-arm 1 Ns ).
58.Pp
59The options are as follows:
60.Bl -tag -width Ds
61.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
31Use the configuration file FILENAME. 62Use the configuration file FILENAME.
32.IP "\-h, \-\-help" 63.It Fl h | \-help
33Print short help on options. 64Print short help on options.
34.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 65.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
35Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and 66Use LOGLEVEL for logging.
36ERROR. 67Valid values are DEBUG, INFO, WARNING and ERROR.
37.IP "\-v, \-\-version" 68.It Fl v | \-version
38Print GNUnet version number. 69Print GNUnet version number.
39.IP "\-z EGO, \-\-zone=EGO" 70.It Fl z Ar EGO | \-zone= Ns Ar EGO
40Specifies for which EGO should FCFSD manage the zone. 71Specifies for which
41.SH BUGS 72.Ar EGO
42Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 73FCFSD should manage the zone.
43electronic mail to <bug\-gnunet@gnu.org> 74.El
44.SH SEE ALSO 75.\".Sh EXAMPLES
45gnunet\-identity(1), gnunet\-gns(1), gnunet\-gns\-proxy(1) 76.\".Sh FILES
46.PP 77.Sh SEE ALSO
47The full documentation for 78.Xr gnunet-identity 1 ,
48.B gnunet 79.Xr gnunet-gns 1 ,
49is maintained as a Texinfo manual. 80.Xr gnunet-gns-proxy 1
81.sp
82The full documentation for gnunet is maintained as a Texinfo manual.
50If the 83If the
51.B info 84.Xr info 1
52and 85and gnunet programs are properly installed at your site, the command
53.B gnunet 86.Pp
54programs are properly installed at your site, the command 87.Dl info gnunet
55.IP 88.Pp
56.B info gnunet
57.PP
58should give you access to the complete handbook, 89should give you access to the complete handbook,
59.IP 90.Pp
60.B info gnunet-c-tutorial 91.Dl info gnunet-c-tutorial
61.PP 92.Pp
62will give you access to a tutorial for developers. 93will give you access to a tutorial for developers.
63.PP 94.sp
64Depending on your installation, this information is also 95Depending on your installation, this information is also available in
65available in 96.Xr gnunet 7 and
66\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 97.Xr gnunet-c-tutorial 7 .
98.\".Sh HISTORY
99.\".Sh AUTHORS
100.Sh BUGS
101Report bugs by using
102.Lk https://bugs.gnunet.org
103or by sending electronic mail to
104.Aq Mt gnunet-developers@gnu.org .