From cf2aea7905f9df0599e067a1889d24e113bcdbfd Mon Sep 17 00:00:00 2001 From: ng0 Date: Sat, 23 Nov 2019 10:26:38 +0000 Subject: [PATCH] add manpage for gnunet-bugreport as it reached enough complexcity to maybe require this. --- doc/man/Makefile.am | 1 + doc/man/gnunet-bugreport.1 | 73 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 doc/man/gnunet-bugreport.1 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index aca26bde4..e60d11413 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -47,6 +47,7 @@ man_MANS = \ gnunet-ats.1 \ gnunet-auto-share.1 \ gnunet-bcd.1 \ + gnunet-bugreport.1 \ gnunet-config.1 \ gnunet-core.1 \ gnunet-conversation.1 \ diff --git a/doc/man/gnunet-bugreport.1 b/doc/man/gnunet-bugreport.1 new file mode 100644 index 000000000..58e538b6a --- /dev/null +++ b/doc/man/gnunet-bugreport.1 @@ -0,0 +1,73 @@ +.\" This file is part of GNUnet. +.\" Copyright (C) 2001-2019 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 November 23, 2019 +.Dt GNUNET-BUGREPORT 1 +.Os +.Sh NAME +.Nm gnunet-bugreport +.Nd print system details to help with bug reports in gnunet +.Sh SYNOPSIS +.Nm +.Op Fl h | -help +.Sh DESCRIPTION +.Nm +can be used to print details about your system which can +help debugging issues you may report about gnunet itself. +It is invoked without arguments, but takes the Environment Variables +.Ev CPPFLAGS +and +.Ev LDFLAGS +if they exist. +.Bl -tag -width indent +.It Fl h | -help +Print short help on usage. +.El +.Sh EXAMPLES +For a system with pkgsrc installed execute this oneliner: +.Pp +.Dl CPPFLAGS='-I/usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' gnunet-bugreport +.Sh SEE ALSO +The full documentation for gnunet is maintained as a Texinfo manual. +If the +.Xr info 1 +and gnunet programs are properly installed at your site, the command +.Pp +.Dl info gnunet +.Pp +should give you access to the complete handbook, +.Pp +.Dl info gnunet-c-tutorial +.Pp +will give you access to a tutorial for developers. +.Pp +Depending on your installation, this information is also available in +.Xr gnunet 7 and +.Xr gnunet-c-tutorial 7 . +.\".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 . -- 2.25.1