aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-identity.139
1 files changed, 24 insertions, 15 deletions
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index e51bbc85d..281f62fb7 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -26,29 +26,35 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-identity 28.Nm gnunet-identity
29.Nd 29.Nd create, delete or list egos
30create, delete or list egos
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl C Ar NAME | Fl \-create= Ns Ar NAME 32.Op Fl C Ar NAME | Fl \-create= Ns Ar NAME
34.Op Fl D Ar NAME | Fl \-delete= 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 35.Op Fl e Ar NAME | Fl \-ego= Ns Ar NAME
36.Op Fl h | \-help 36.Op Fl h | \-help
37.Op Fl d | \-display
38.Op Fl m | \-monitor 37.Op Fl m | \-monitor
38.Op Fl q | \-quiet
39.Op Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM 39.Op Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
40.Op Fl v | \-verbose
40.Sh DESCRIPTION 41.Sh DESCRIPTION
41.Nm 42.Nm
42is a tool for managing egos. 43is a tool for managing egos.
43An ego is the persona that controls a namespace. 44An ego is the persona that controls a namespace.
44It is identical to a public-private ECC key pair. 45It is identical to a public-private ECC key pair.
45.Pp 46.Pp
46gnunet-identity can be used to list all of the egos that were created locally, to create new egos, and to delete existing egos (the namespace will continue to exist, but it will be impossible to add additional data to it). 47gnunet-identity can be used to list all of the egos that were
48created locally, to create new egos, and to delete
49existing egos (the namespace will continue to exist, but it will
50be impossible to add additional data to it).
47.Pp 51.Pp
48Creating a new ego requires using the 52Creating a new ego requires using the
49.Fl C 53.Fl C
50option together with an identifier (name) that is to be used for the new ego. 54option together with an identifier (name) that is to be used for
51This identifier is only used locally for this peer and not shared with other peers. 55the new ego.
56This identifier is only used locally for this peer and not shared
57with other peers.
52The options are as follows: 58The options are as follows:
53.Bl -tag -width Ds 59.Bl -tag -width Ds
54.It Fl C Ar NAME | Fl \-create= Ns Ar NAME 60.It Fl C Ar NAME | Fl \-create= Ns Ar NAME
@@ -57,19 +63,20 @@ Creates a new ego with the given
57.It Fl D Ar NAME | Fl \-delete= Ns Ar NAME 63.It Fl D Ar NAME | Fl \-delete= Ns Ar NAME
58Delete the ego with the given 64Delete the ego with the given
59.Ar NAME . 65.Ar NAME .
66.It Fl d | \-display
67Display all of our egos.
60.It Fl e Ar NAME | Fl \-ego= Ns Ar NAME 68.It Fl e Ar NAME | Fl \-ego= Ns Ar NAME
61Perform "set" operation with the respective ego or restrict "display" operation to the respective ego. 69Perform "set" operation with the respective ego or restrict "display"
70operation to the respective ego.
62.It Fl h | \-help 71.It Fl h | \-help
63Print the help page. 72Print the help page.
64.It d | \-display 73.It Fl m | \-monitor
65Display all of our egos.
66.It q | \-quiet
67Be quiet, in particular outputs only the public key when listing egos.
68.It v | \-verbose
69Be verbose, in particular outputs the public key of freshly created egos.
70.It m | \-monitor
71Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 74Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
72Each ego is listed together with a unique pointer value; if egos are renamed, that pointer value remains the same; if egos are deleted, they are listed one more time with a name of "<null>". 75Each ego is listed together with a unique pointer value; if
76egos are renamed, that pointer value remains the same,
77if egos are deleted, they are listed one more time with a name of "<null>".
78.It Fl q | \-quiet
79Be quiet, in particular outputs only the public key when listing egos.
73.It Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM 80.It Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
74Perform "set" operation for the specified 81Perform "set" operation for the specified
75.Ar SUBSYSTEM 82.Ar SUBSYSTEM
@@ -80,6 +87,8 @@ After this, the given SUBSYSTEM will use the ego with the specified NAME.
80This will fail if 87This will fail if
81.Ar NAME 88.Ar NAME
82does not yet exist. 89does not yet exist.
90.It Fl v | \-verbose
91Be verbose, in particular outputs the public key of freshly created egos.
83.El 92.El
84.Sh FILES 93.Sh FILES
85.Pa ~/.local/share/gnunet/identity/egos 94.Pa ~/.local/share/gnunet/identity/egos