gnunet-gns-registrar

commit b021850c126eab49505b5d44eaffab3d71b16b93
parent 6e93151e493ff620f61cbd7ef3b008a13b4fa321
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date:   Tue, 29 Apr 2025 11:06:19 +0200

add manpage

Diffstat:
M
Makefile.in
 | 
18
++++++++++--------
A
doc/man/gnunet-gns-registrar.1
 | 
59
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 69 insertions(+), 8 deletions(-)
diff --git a/Makefile.in b/Makefile.in
@@ -1,23 +1,25 @@
 all: server
 
 SCRIPT_TARGET:=$(shell dirname $(shell go list -f '{{.Target}}' ./cmd/gns-registrar))
-GNUNET_DATA_HOME=${datadir}/gnunet
+GNSR_DATA_HOME=${datadir}/gnunet-gns-registrar
 VERSION=`git describe --tags`
 
 server:
-	${GO} build -o gnunet-gns-registrar -ldflags "-X main.version=${VERSION} -X main.taldirdatahome=${GNUNET_DATA_HOME}"  ./cmd/gns-registrar
+	${GO} build -o gnunet-gns-registrar -ldflags "-X main.version=${VERSION} -X main.taldirdatahome=${GNSR_DATA_HOME}"  ./cmd/gns-registrar
 
 install: server
-	mkdir -p ${DESTDIR}${bindir}
-	mkdir -p ${DESTDIR}${GNUNET_DATA_HOME}
+	-mkdir -p ${DESTDIR}${bindir}
+	-mkdir -p ${DESTDIR}${GNSR_DATA_HOME}
 	install ./gnunet-gns-registrar ${DESTDIR}${bindir}
-	mkdir -p ${DESTDIR}${mandir}/man1
-	install doc/man/gnunet-gns-registrar.1 ${DESTDIR}${mandir}/man1/
-	install gns-registrar.conf.example ${DESTDIR}${GNUNET_DATA_HOME}
+	cp -r ./web ${DESTDIR}${GNSR_DATA_HOME}/
+	cp -r ./static ${DESTDIR}${GNSR_DATA_HOME}/
+	-mkdir -p ${DESTDIR}${mandir}/man1
+	cp doc/man/gnunet-gns-registrar.1 ${DESTDIR}${mandir}/man1/
+	cp gns-registrar.conf.example ${DESTDIR}${GNSR_DATA_HOME}
 
 uninstall:
 	${RM} ${DESTDIR}${bindir}/gnunet-gns-registrar
-	${RM} ${DESTDIR}${GNUNET_DATA_HOME}/gns-registrar.conf.example
+	${RM} ${DESTDIR}${GNSR_DATA_HOME}/gns-registrar.conf.example
 
 format:
 	${GO} fmt ./cmd/gns-registrar/*.go
diff --git a/doc/man/gnunet-gns-registrar.1 b/doc/man/gnunet-gns-registrar.1
@@ -0,0 +1,59 @@
+.\" This file is part of GNUnet.
+.\" Copyright (C) 2025 GNUnet e.V.
+.\"
+.\" Permission is granted to copy, distribute and/or modify this document
+.\" under the terms of the GNU Free Documentation License, Version 1.3 or
+.\" any later version published by the Free Software Foundation; with no
+.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
+.\" copy of the license is included in the file
+.\" FDL-1.3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
+.\"
+.\" Alternately, this document is also available under the General
+.\" Public License, version 3 or later, as published by the Free Software
+.\" Foundation.  A copy of the license is included in the file
+.\" GPL3.
+.\"
+.\" A copy of the license is also available from the Free Software
+.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
+.\"
+.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
+.\"
+.Dd April 29, 2025
+.Dt GNUNET-GNS-REGISTRAR 1
+.Os
+.Sh NAME
+.Nm gnunet-gns-registrar
+.Nd The GNUnet GNS Registrar service
+.Sh SYNOPSIS
+.Nm
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl h | -help
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl v | -version
+.Sh DESCRIPTION
+.Nm
+is used to register and lookup GNS domain registrations.
+.Bl -tag -width indent
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+Use the configuration file FILENAME.
+.It Fl h | -help
+Print short help on options.
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+Use LOGLEVEL for logging.
+Valid values are DEBUG, INFO, WARNING and ERROR.
+.It Fl v | -version
+Print version number.
+.El
+.Sh DIAGNOSTICS
+.Nm
+will return 0 on success.
+.\".Sh HISTORY
+.\".Sh AUTHORS
+.Sh BUGS
+Report bugs by using
+.Lk https://bugs.gnunet.org
+or by sending electronic mail to
+.Aq Mt gnunet-developers@gnu.org .