doc/man/gnunet-ecc.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 @url{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 @url{http://www.gnu.org/licenses/gpl.html}.
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd June 5, 2017
  25 .Dt GNUNET-ECC 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-ecc
  29 .Nd
  30 manipulate GNUnet ECC key files
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl g Ar COUNT | Fl \-generate-keys= Ns Ar COUNT
  34 .Op Fl p | \-print-public-key
  35 .Op Fl P | \-print-private-key
  36 .Op Fl x | \-print-hex
  37 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  38 .Op Fl h | \-help
  39 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  40 .Op Fl v | \-version
  41 .Ao Ar FILENAME Ac
  42 .sp
  43 .Sh DESCRIPTION
  44 .Nm
  45 can be used to create an ECC private key and to print the corresponding public key.
  46 You must specify a filename containing an ECC private key in GNUnet format as an argument.
  47 If the file does not exist, gnunet-ecc will create a key.
  48 This may then take a while.
  49 If the option
  50 .Fl p
  51 is given, the corresponding public key will be printed to the console.
  52 .Bl -tag -width Ds
  53 .It Fl g Ar COUNT | Fl \-generate-keys= Ns Ar COUNT
  54 Create COUNT public-private key pairs and write them to FILENAME.
  55 Used for creating a file for testing.
  56 .It Fl p | \-print-public-key
  57 Print the corresponding public key to stdout.
  58 This is the value used for PKEY records in GNS.
  59 .It Fl P | \-print-private-key
  60 Print the corresponding private key to stdout.
  61 This is the value used for PKEY records in GNS.
  62 .It Fl x | \-print-hex
  63 Print the corresponding public key to stdout in HEX format.
  64 Useful for comparing to Ed25519 keys in X.509 tools.
  65 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  66 Use the configuration file FILENAME.
  67 .It Fl h | \-help
  68 Print short help on options.
  69 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  70 Use LOGLEVEL for logging.
  71 Valid values are DEBUG, INFO, WARNING and ERROR.
  72 .It Fl v | \-version
  73 Print GNUnet version number.
  74 .El
  75 .Sh SEE ALSO
  76 The full documentation for gnunet is maintained as a Texinfo manual.
  77 If the
  78 .Xr info 1
  79 and gnunet programs are properly installed at your site, the command
  80 .Pp
  81 .Dl info gnunet
  82 .Pp
  83 should give you access to the complete handbook,
  84 .Pp
  85 .Dl info gnunet-c-tutorial
  86 .Pp
  87 will give you access to a tutorial for developers.
  88 .sp
  89 Depending on your installation, this information is also available in
  90 .Xr gnunet 7 and
  91 .Xr gnunet-c-tutorial 7 .
  92 .\".Sh HISTORY
  93 .\".Sh AUTHORS
  94 .Sh BUGS
  95 Report bugs by using
  96 .Lk https://bugs.gnunet.org
  97 or by sending electronic mail to
  98 .Aq Mt gnunet-developers@gnu.org .