make html in doc/man using mandoc (sans Toc feature)
[oweals/gnunet.git] / doc / man / gnunet-identity.1
1 .TH GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet"
2 .SH NAME
3 gnunet\-identity \- create, delete or list egos
4 .SH SYNOPSIS
5 .B gnunet\-identity
6 [options]
7 .SH DESCRIPTION
8 .PP
9 gnunet\-identity is a tool for managing egos.
10 An ego is the persona that controls a namespace.
11 It is identical to a public\-private ECC key pair.
12 .PP
13 gnunet\-identity can be used to list all of the egos that were created
14 locally, to create new egos, and to delete existing egos (the
15 namespace will continue to exist, but it will be impossible to add
16 additional data to it).
17 .PP
18 Creating a new ego requires using the \-C option together with an
19 identifier (name) that is to be used for the new ego.
20 This identifier is only used locally for this peer and not shared with
21 other peers.
22 .TP
23 \fB\-C NAME\fR, \fB\-\-create=NAME\fR
24 Creates a new ego with the given NAME.
25 .TP
26 \fB\-D NAME\fR, \fB\-\-delete=NAME\fR
27 Delete the ego with the given NAME.
28 .TP
29 \fB\-e NAME\fR, \fB\-\-ego=NAME\fR
30 Perform "set" operation with the respective ego.
31 Needs to be used together with option \-s.
32 .TP
33 \fB\-h\fR, \fB\-\-help\fR
34 Print help page.
35 .TP
36 \fB\-d\fR, \fB\-\-display\fR
37 display all of our egos
38 .TP
39 \fB\-m\fR, \fB\-\-monitor\fR
40 Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
41 Each ego is listed together with a unique pointer value; if egos are
42 renamed, that pointer value remains the same; if egos are deleted,
43 they are listed one more time with a name of "<null>".
44 .TP
45 \fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR
46 Perform "set" operation for the specified SUBSYSTEM with the
47 respective ego.
48 Needs to be used together with option \-e.
49 After this, the given SUBSYSTEM will use the ego with the specified
50 NAME.
51 This will fail if NAME does not yet exist.
52 .SH FILES
53 .TP
54 ~/.local/share/gnunet/identity/egos
55 Directory where the egos are stored (by default)
56 .SH BUGS
57 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
58 electronic mail to <gnunet\-developers@gnu.org>
59 .SH SEE ALSO
60 \fBgnunet\-gns\fP(1),  \fBgnunet\-namestore\fP(1)
61 The full documentation for
62 .B gnunet
63 is maintained as a Texinfo manual.
64 If the
65 .B info
66 and
67 .B gnunet
68 programs are properly installed at your site, the command
69 .IP
70 .B info gnunet
71 .PP
72 should give you access to the complete handbook,
73 .IP
74 .B info gnunet-c-tutorial
75 .PP
76 will give you access to a tutorial for developers.
77 .PP
78 Depending on your installation, this information is also
79 available in
80 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).