doc/man/gnunet-identity.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 September 5, 2013
  25 .Dt GNUNET-IDENTITY 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-identity
  29 .Nd create, delete or list egos
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl C Ar NAME | Fl -create= Ns Ar NAME
  33 .Op Fl D Ar NAME | Fl -delete= Ns Ar NAME
  34 .Op Fl d | -display
  35 .Op Fl e Ar NAME | Fl -ego= Ns Ar NAME
  36 .Op Fl h | -help
  37 .Op Fl m | -monitor
  38 .Op Fl p | \-private-keys
  39 .Op Fl q | -quiet
  40 .Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
  41 .Op Fl V | -verbose
  42 .Sh DESCRIPTION
  43 .Nm
  44 is a tool for managing egos.
  45 An ego is the persona that controls a namespace.
  46 It is identical to a public-private ECC key pair.
  47 .Pp
  48 gnunet-identity can be used to list all of the egos that were
  49 created locally, to create new egos, and to delete
  50 existing egos (the namespace will continue to exist, but it will
  51 be impossible to add additional data to it).
  52 .Pp
  53 Creating a new ego requires using the
  54 .Fl C
  55 option together with an identifier (name) that is to be used for
  56 the new ego.
  57 This identifier is only used locally for this peer and not shared
  58 with other peers.
  59 The options are as follows:
  60 .Bl -tag -width indent
  61 .It Fl C Ar NAME | Fl -create= Ns Ar NAME
  62 Creates a new ego with the given
  63 .Ar NAME .
  64 .It Fl D Ar NAME | Fl -delete= Ns Ar NAME
  65 Delete the ego with the given
  66 .Ar NAME .
  67 .It Fl d | -display
  68 Display all of our egos.
  69 .It Fl e Ar NAME | Fl -ego= Ns Ar NAME
  70 Perform "set" operation with the respective ego or restrict "display"
  71 operation to the respective ego.
  72 .It Fl h | -help
  73 Print the help page.
  74 .It Fl m | -monitor
  75 Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
  76 Each ego is listed together with a unique pointer value; if
  77 egos are renamed, that pointer value remains the same,
  78 if egos are deleted, they are listed one more time with a name of "<null>".
  79 .It Fl p | -private-keys
  80 Print the private keys (in Crockford Base32 encoding), and not just the public
  81 keys. The second column shows the public key, the third column shows the
  82 private key.
  83 .It Fl q | -quiet
  84 Be quiet, in particular outputs only the public key when listing egos.
  85 .It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
  86 Perform "set" operation for the specified
  87 .Ar SUBSYSTEM
  88 with the respective ego.
  89 Needs to be used together with option
  90 .Fl e .
  91 After this, the given SUBSYSTEM will use the ego with the specified NAME.
  92 This will fail if
  93 .Ar NAME
  94 does not yet exist.
  95 .It Fl V | -verbose
  96 Be verbose, in particular outputs the public key of freshly created egos.
  97 .El
  98 .Sh FILES
  99 .Pa ~/.local/share/gnunet/identity/egos
 100 Directory where the egos are stored by default
 101 .\".Sh EXAMPLES
 102 .Sh SEE ALSO
 103 .Xr gnunet-gns 1 ,
 104 .Xr gnunet-namestore 1
 105 .sp
 106 The full documentation for gnunet is maintained as a Texinfo manual.
 107 If the
 108 .Xr info 1
 109 and gnunet programs are properly installed at your site, the command
 110 .Pp
 111 .Dl info gnunet
 112 .Pp
 113 should give you access to the complete handbook,
 114 .Pp
 115 .Dl info gnunet-c-tutorial
 116 .Pp
 117 will give you access to a tutorial for developers.
 118 .sp
 119 Depending on your installation, this information is also available in
 120 .Xr gnunet 7 and
 121 .Xr gnunet-c-tutorial 7 .
 122 .\".Sh HISTORY
 123 .\".Sh AUTHORS
 124 .Sh BUGS
 125 Report bugs by using
 126 .Lk https://bugs.gnunet.org
 127 or by sending electronic mail to
 128 .Aq Mt gnunet-developers@gnu.org .