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