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