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.135
1 files changed, 24 insertions, 11 deletions
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index 599d3b269..d693d3688 100644
--- a/doc/man/gnunet-identity.1
+++ b/doc/man/gnunet-identity.1
@@ -26,7 +26,7 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-identity 28.Nm gnunet-identity
29.Nd create, delete or list egos 29.Nd maintain (create, delete or list) or perform actions with egos
30.Sh SYNOPSIS 30.Sh SYNOPSIS
31.Nm 31.Nm
32.Op Fl C Ar NAME | Fl -create= Ns Ar NAME 32.Op Fl C Ar NAME | Fl -create= Ns Ar NAME
@@ -34,11 +34,13 @@
34.Op Fl d | -display 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 k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY
37.Op Fl m | -monitor 38.Op Fl m | -monitor
38.Op Fl p | -private-keys 39.Op Fl p | -private-keys
39.Op Fl q | -quiet 40.Op Fl q | -quiet
40.Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM 41.Op Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
41.Op Fl V | -verbose 42.Op Fl V | -verbose
43.Op Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
42.Op Fl X | -eddsa 44.Op Fl X | -eddsa
43.Sh DESCRIPTION 45.Sh DESCRIPTION
44.Nm 46.Nm
@@ -51,6 +53,9 @@ created locally, to create new egos, and to delete
51existing egos (the namespace will continue to exist, but it will 53existing egos (the namespace will continue to exist, but it will
52be impossible to add additional data to it). 54be impossible to add additional data to it).
53.Pp 55.Pp
56In addition, it is possible to encrypt and decrypt messages (arbitrary strings)
57using a given public key (for encryption) or ego (for decryption).
58.Pp
54Creating a new ego requires using the 59Creating a new ego requires using the
55.Fl C 60.Fl C
56option together with an identifier (name) that is to be used for 61option together with an identifier (name) that is to be used for
@@ -72,6 +77,11 @@ Perform "set" operation with the respective ego or restrict "display"
72operation to the respective ego. 77operation to the respective ego.
73.It Fl h | -help 78.It Fl h | -help
74Print the help page. 79Print the help page.
80.It Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY
81The public key to use for a message recipient. Use together with
82.Fl W .
83The recipient can obtain the desired ego's public key using the "display"
84operation.
75.It Fl m | -monitor 85.It Fl m | -monitor
76Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 86Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
77Each ego is listed together with a unique pointer value; if 87Each ego is listed together with a unique pointer value; if
@@ -83,18 +93,21 @@ keys. The second column shows the public key, the third column shows the
83private key. 93private key.
84.It Fl q | -quiet 94.It Fl q | -quiet
85Be quiet, in particular outputs only the public key when listing egos. 95Be quiet, in particular outputs only the public key when listing egos.
86.It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM 96.It Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
87Perform "set" operation for the specified 97Decrypt (read) a message using the respective ego private key. Use together with
88.Ar SUBSYSTEM
89with the respective ego.
90Needs to be used together with option
91.Fl e . 98.Fl e .
92After this, the given SUBSYSTEM will use the ego with the specified NAME. 99The message consists of an ephemeral key and the ciphertext, separated by a dot.
93This will fail if 100Such messages can be created with
94.Ar NAME 101.Fl W .
95does not yet exist.
96.It Fl V | -verbose 102.It Fl V | -verbose
97Be verbose, in particular outputs the public key of freshly created egos. 103Be verbose, in particular outputs the public key of freshly created egos.
104.It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
105Encrypt (write) the given message for the identity given with
106.Fl k .
107The output contains an ephemeral message public key and the message separated
108by a dot. The entire line needs to be transferred to the recipient, who can use
109.Fl R
110to decrypt the message.
98.It Fl X | -eddsa 111.It Fl X | -eddsa
99Use EdDSA instead of ECDSA. 112Use EdDSA instead of ECDSA.
100.El 113.El