Start fixing the man pages via linting and style.
[oweals/gnunet.git] / doc / man / gnunet-ecc.1
1 .TH GNUNET\-ECC 1 "June 5, 2017" "GNUnet"
2
3 .SH NAME
4 gnunet\-ecc \- manipulate GNUnet ECC key files
5
6 .SH SYNOPSIS
7 .B gnunet\-ecc
8 .RI [ options ] FILENAME
9 .br
10
11 .SH DESCRIPTION
12 \fBgnunet\-ecc\fP can be used to create an ECC private key and to
13 print the corresponding public key.  You must specify a filename
14 containing an ECC private key in GNUnet format as an argument.  If the
15 file does not exist, gnunet\-ecc will create a key.  This may then
16 take a while.  If the option \-p is given, the corresponding public
17 key will be printed to the console.
18
19 .SH OPTIONS
20 .B
21 .IP "\-g COUNT, \-\-generate-keys=COUNT"
22 Create COUNT public-private key pairs and write them to FILENAME.
23 Used for creating a file for testing.
24 .B
25 .IP "\-p, \-\-print-public-key"
26 Print the corresponding public key to stdout.  This is the value used
27 for PKEY records in GNS.
28 .B
29 .IP "\-P, \-\-print-private-key"
30 Print the corresponding private key to stdout.  This is the value used
31 for PKEY records in GNS.
32 .B
33 .IP "\-x, \-\-print-hex"
34 Print the corresponding public key to stdout in HEX format.  Useful
35 for comparing to Ed25519 keys in X.509 tools.
36 .B
37 .IP "\-c FILENAME,  \-\-config=FILENAME"
38 Use the configuration file FILENAME.
39 .B
40 .IP "\-h, \-\-help"
41 Print short help on options.
42 .B
43 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
44 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and
45 ERROR.
46 .B
47 .IP "\-v, \-\-version"
48 Print GNUnet version number.
49
50
51 .SH BUGS
52 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
53 electronic mail to <gnunet\-developers@gnu.org>
54 .SH SEE ALSO
55 The full documentation for
56 .B gnunet
57 is maintained as a Texinfo manual.  If the
58 .B info
59 and
60 .B gnunet
61 programs are properly installed at your site, the command
62 .IP
63 .B info gnunet
64 .PP
65 should give you access to the complete handbook,
66 .IP
67 .B info gnunet-c-tutorial
68 .PP
69 will give you access to a tutorial for developers.
70 .PP
71 Depending on your installation, this information is also
72 available in
73 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).