followup
[oweals/gnunet.git] / doc / man / gnunet-bcd.1
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 December 5, 2013
25 .Dt GNUNET-BCD 1
26 .Os
27 .Sh NAME
28 .Nm gnunet-bcd
29 .Nd run HTTP server to create GNS business cards
30 .Sh SYNOPSIS
31 .Nm
32 .Op Fl p Ar PORT | Fl -port= Ns Ar PORT
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 .Sh DESCRIPTION
38 .Nm
39 can be used to create an business card with a QR code containing the public key of a zone from the GNU Name System.
40 gnunet-bcd requires LaTeX (
41 .Xr pdflatex 1
42 ) with various packages to be installed.
43 If it does not work for you, try installing the full TeXLive distribution first, for example if you are using the package-manager
44 .Xr apt 1
45 execute "apt-get install texlive-full".
46 .Bl -tag -width indent
47 .It Fl p Ar PORT | Fl -port= Ns Ar PORT
48 Run the HTTP server on port PORT.
49 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
50 Use the configuration file FILENAME.
51 .It Fl h | -help
52 Print short help on options.
53 .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
54 Use LOGLEVEL for logging.
55 Valid values are DEBUG, INFO, WARNING and ERROR.
56 .It Fl v | -version
57 Print GNUnet version number.
58 .El
59 .Sh SEE ALSO
60 The full documentation for gnunet is maintained as a Texinfo manual.
61 If the
62 .Xr info 1
63 and gnunet programs are properly installed at your site, the command
64 .Pp
65 .Dl info gnunet
66 .Pp
67 should give you access to the complete handbook,
68 .Pp
69 .Dl info gnunet-c-tutorial
70 .Pp
71 will give you access to a tutorial for developers.
72 .sp
73 Depending on your installation, this information is also available in
74 .Xr gnunet 7 and
75 .Xr gnunet-c-tutorial 7 .
76 .\".Sh HISTORY
77 .\".Sh AUTHORS
78 .Sh BUGS
79 Report bugs by using
80 .Lk https://bugs.gnunet.org
81 or by sending electronic mail to
82 .Aq Mt gnunet-developers@gnu.org .