aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-identity.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-identity.1')
-rw-r--r--doc/man/gnunet-identity.1180
1 files changed, 106 insertions, 74 deletions
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index ca4acfebe..79004bab5 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -1,80 +1,112 @@
1.TH GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-identity \- create, delete or list egos 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-identity 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6[options] 6.\" any later version published by the Free Software Foundation; with no
7.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.PP 8.\" copy of the license is included in the file
9gnunet\-identity is a tool for managing egos. 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
25.Dt GNUNET-IDENTITY "1" "September 5, 2013" "GNUnet"
26.Os
27.Sh NAME
28.Nm gnunet-identity
29.Nd
30create, delete or list egos
31.Sh SYNOPSIS
32.Nm
33.Op Fl C Ar NAME | Fl \-create= Ns Ar NAME
34.Op Fl D Ar NAME | Fl \-delete= Ns Ar NAME
35.Op Fl e Ar NAME | Fl \-ego= Ns Ar NAME
36.Op Fl h | \-help
37.Op Fl d | \-display
38.Op Fl m | \-monitor
39.Op Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
40.Sh DESCRIPTION
41.Nm
42is a tool for managing egos.
10An ego is the persona that controls a namespace. 43An ego is the persona that controls a namespace.
11It is identical to a public\-private ECC key pair. 44It is identical to a public-private ECC key pair.
12.PP 45.Pp
13gnunet\-identity can be used to list all of the egos that were created 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).
14locally, to create new egos, and to delete existing egos (the 47.Pp
15namespace will continue to exist, but it will be impossible to add 48Creating a new ego requires using the
16additional data to it). 49.Fl C
17.PP 50option together with an identifier (name) that is to be used for the new ego.
18Creating a new ego requires using the \-C option together with an 51This identifier is only used locally for this peer and not shared with other peers.
19identifier (name) that is to be used for the new ego. 52The options are as follows:
20This identifier is only used locally for this peer and not shared with 53.Bl -tag -width Ds
21other peers. 54.It Fl C Ar NAME | Fl \-create= Ns Ar NAME
22.TP 55Creates a new ego with the given
23\fB\-C NAME\fR, \fB\-\-create=NAME\fR 56.Ar NAME .
24Creates a new ego with the given NAME. 57.It Fl D Ar NAME | Fl \-delete= Ns Ar NAME
25.TP 58Delete the ego with the given
26\fB\-D NAME\fR, \fB\-\-delete=NAME\fR 59.Ar NAME .
27Delete the ego with the given NAME. 60.It Fl e Ar NAME | Fl \-ego= Ns Ar NAME
28.TP
29\fB\-e NAME\fR, \fB\-\-ego=NAME\fR
30Perform "set" operation with the respective ego. 61Perform "set" operation with the respective ego.
31Needs to be used together with option \-s. 62Needs to be used together with option
32.TP 63.Fl s .
33\fB\-h\fR, \fB\-\-help\fR 64.It Fl h | \-help
34Print help page. 65Print the help page.
35.TP 66.It d | \-display
36\fB\-d\fR, \fB\-\-display\fR 67Display all of our egos.
37display all of our egos 68.It m | \-monitor
38.TP
39\fB\-m\fR, \fB\-\-monitor\fR
40Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 69Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
41Each ego is listed together with a unique pointer value; if egos are 70Each 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>".
42renamed, that pointer value remains the same; if egos are deleted, 71.It Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
43they are listed one more time with a name of "<null>". 72Perform "set" operation for the specified
44.TP 73.Ar SUBSYSTEM
45\fB\-s SUBSYSTEM\fR, \fB\-\-set=SUBSYSTEM\fR 74with the respective ego.
46Perform "set" operation for the specified SUBSYSTEM with the 75Needs to be used together with option
47respective ego. 76.Fl e .
48Needs to be used together with option \-e. 77After this, the given SUBSYSTEM will use the ego with the specified NAME.
49After this, the given SUBSYSTEM will use the ego with the specified 78This will fail if
50NAME. 79.Ar NAME
51This will fail if NAME does not yet exist. 80does not yet exist.
52.SH FILES 81.El
53.TP 82.Sh FILES
54~/.local/share/gnunet/identity/egos 83.Pa ~/.local/share/gnunet/identity/egos
55Directory where the egos are stored (by default) 84Directory where the egos are stored by default
56.SH BUGS 85.\".Sh EXAMPLES
57Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 86.Sh SEE ALSO
58electronic mail to <gnunet\-developers@gnu.org> 87.Xr gnunet-gns 1 ,
59.SH SEE ALSO 88.Xr gnunet-namestore 1
60\fBgnunet\-gns\fP(1), \fBgnunet\-namestore\fP(1) 89.sp
61The full documentation for 90The full documentation for gnunet is maintained as a Texinfo manual.
62.B gnunet
63is maintained as a Texinfo manual.
64If the 91If the
65.B info 92.Xr info 1
66and 93and gnunet programs are properly installed at your site, the command
67.B gnunet 94.Pp
68programs are properly installed at your site, the command 95.Dl info gnunet
69.IP 96.Pp
70.B info gnunet
71.PP
72should give you access to the complete handbook, 97should give you access to the complete handbook,
73.IP 98.Pp
74.B info gnunet-c-tutorial 99.Dl info gnunet-c-tutorial
75.PP 100.Pp
76will give you access to a tutorial for developers. 101will give you access to a tutorial for developers.
77.PP 102.sp
78Depending on your installation, this information is also 103Depending on your installation, this information is also available in
79available in 104.Xr gnunet 7 and
80\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 105.Xr gnunet-c-tutorial 7 .
106.\".Sh HISTORY
107.\".Sh AUTHORS
108.Sh BUGS
109Report bugs by using
110.Lk https://bugs.gnunet.org
111or by sending electronic mail to
112.Aq Mt gnunet-developers@gnu.org .
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-19 03:00:19 +0000