taler-mailbox

commit 91695c06d4b1f860717d1ae693fd95472f64e8c3
parent abe77933198969d0117e8594e892cebf9214ca4c
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date:   Sat, 26 Apr 2025 12:54:00 +0200

add manpage

Diffstat:
M
Makefile.in
 | 
6
+++++-
A
doc/man/taler-mailbox.1
 | 
59
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 64 insertions(+), 1 deletion(-)
diff --git a/Makefile.in b/Makefile.in
@@ -1,9 +1,10 @@
 all: server #cli
 
 VERSION="1:0:0"
+TALER_MAILBOX_HOME=${datadir}/taler-mailbox
 
 server:
-	${GO} build -ldflags "-X main.version=${VERSION} -X main.mailboxdatahome=${datadir}/taler-mailbox" -o taler-mailbox ./cmd/mailbox-server
+	${GO} build -ldflags "-X main.version=${VERSION} -X main.mailboxdatahome=${TALER_MAILBOX_HOME}" -o taler-mailbox ./cmd/mailbox-server
 
 #cli:
 #	go build ./cmd/mailbox-cli
@@ -11,6 +12,9 @@ server:
 install: server #cli
 	mkdir -p ${DESTDIR}${bindir}
 	install ./taler-mailbox ${DESTDIR}${bindir}
+	install mailbox.conf.example ${DESTDIR}${TALER_MAILBOX_HOME}
+	mkdir -p ${DESTDIR}${mandir}/man1
+	install doc/man/taler-mailbox.1 ${DESTDIR}${mandir}/man1/
 
 uninstall:
 	$(RM) ${DESTDIR}${bindir}/taler-mailbox
diff --git a/doc/man/taler-mailbox.1 b/doc/man/taler-mailbox.1
@@ -0,0 +1,59 @@
+.\" This file is part of GNU Taler.
+.\" Copyright (C) 2025 GNU Taler
+.\"
+.\" 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 26, 2025
+.Dt TALER-MAILBOX 1
+.Os
+.Sh NAME
+.Nm taler-mailbox
+.Nd The GNU Taler Mailbox 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 send and receiver payment request messages for P2P payments.
+.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 .