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