aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-11-23 10:26:38 +0000
committerng0 <ng0@n0.is>2019-11-23 10:26:38 +0000
commitcf2aea7905f9df0599e067a1889d24e113bcdbfd (patch)
tree8b925e7f53f76f271ab4b4ac56ff4cf7d8f52a89 /doc/man
parentd0ce6a748957cbc9389812d14166dcedd9c72405 (diff)
downloadgnunet-cf2aea7905f9df0599e067a1889d24e113bcdbfd.tar.gz
gnunet-cf2aea7905f9df0599e067a1889d24e113bcdbfd.zip
add manpage for gnunet-bugreport as it reached enough complexcity
to maybe require this.
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-bugreport.173
2 files changed, 74 insertions, 0 deletions
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 = \
47 gnunet-ats.1 \ 47 gnunet-ats.1 \
48 gnunet-auto-share.1 \ 48 gnunet-auto-share.1 \
49 gnunet-bcd.1 \ 49 gnunet-bcd.1 \
50 gnunet-bugreport.1 \
50 gnunet-config.1 \ 51 gnunet-config.1 \
51 gnunet-core.1 \ 52 gnunet-core.1 \
52 gnunet-conversation.1 \ 53 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 @@
1.\" This file is part of GNUnet.
2.\" Copyright (C) 2001-2019 GNUnet e.V.
3.\"
4.\" Permission is granted to copy, distribute and/or modify this document
5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.\" any later version published by the Free Software Foundation; with no
7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.\" copy of the license is included in the file
9.\" FDL-1.3.
10.\"
11.\" A copy of the license is also available from the Free Software
12.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
13.\"
14.\" Alternately, this document is also available under the General
15.\" Public License, version 3 or later, as published by the Free Software
16.\" Foundation. A copy of the license is included in the file
17.\" GPL3.
18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd November 23, 2019
25.Dt GNUNET-BUGREPORT 1
26.Os
27.Sh NAME
28.Nm gnunet-bugreport
29.Nd print system details to help with bug reports in gnunet
30.Sh SYNOPSIS
31.Nm
32.Op Fl h | -help
33.Sh DESCRIPTION
34.Nm
35can be used to print details about your system which can
36help debugging issues you may report about gnunet itself.
37It is invoked without arguments, but takes the Environment Variables
38.Ev CPPFLAGS
39and
40.Ev LDFLAGS
41if they exist.
42.Bl -tag -width indent
43.It Fl h | -help
44Print short help on usage.
45.El
46.Sh EXAMPLES
47For a system with pkgsrc installed execute this oneliner:
48.Pp
49.Dl CPPFLAGS='-I/usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' gnunet-bugreport
50.Sh SEE ALSO
51The full documentation for gnunet is maintained as a Texinfo manual.
52If the
53.Xr info 1
54and gnunet programs are properly installed at your site, the command
55.Pp
56.Dl info gnunet
57.Pp
58should give you access to the complete handbook,
59.Pp
60.Dl info gnunet-c-tutorial
61.Pp
62will give you access to a tutorial for developers.
63.Pp
64Depending on your installation, this information is also available in
65.Xr gnunet 7 and
66.Xr gnunet-c-tutorial 7 .
67.\".Sh HISTORY
68.\".Sh AUTHORS
69.Sh BUGS
70Report bugs by using
71.Lk https://bugs.gnunet.org
72or by sending electronic mail to
73.Aq Mt gnunet-developers@gnu.org .