aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-identity.126
1 files changed, 25 insertions, 1 deletions
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1
index 599d3b269..835dfb225 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,14 @@
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
41.Op Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
40.Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM 42.Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
41.Op Fl V | -verbose 43.Op Fl V | -verbose
44.Op Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
42.Op Fl X | -eddsa 45.Op Fl X | -eddsa
43.Sh DESCRIPTION 46.Sh DESCRIPTION
44.Nm 47.Nm
@@ -51,6 +54,9 @@ created locally, to create new egos, and to delete
51existing egos (the namespace will continue to exist, but it will 54existing egos (the namespace will continue to exist, but it will
52be impossible to add additional data to it). 55be impossible to add additional data to it).
53.Pp 56.Pp
57In addition, it is possible to encrypt and decrypt messages (arbitrary strings)
58using a given public key (for encryption) or ego (for decryption).
59.Pp
54Creating a new ego requires using the 60Creating a new ego requires using the
55.Fl C 61.Fl C
56option together with an identifier (name) that is to be used for 62option together with an identifier (name) that is to be used for
@@ -72,6 +78,11 @@ Perform "set" operation with the respective ego or restrict "display"
72operation to the respective ego. 78operation to the respective ego.
73.It Fl h | -help 79.It Fl h | -help
74Print the help page. 80Print the help page.
81.It Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY
82The public key to use for a message recipient. Use together with
83.Fl W .
84The recipient can obtain the desired ego's public key using the "display"
85operation.
75.It Fl m | -monitor 86.It Fl m | -monitor
76Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 87Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
77Each ego is listed together with a unique pointer value; if 88Each ego is listed together with a unique pointer value; if
@@ -83,6 +94,12 @@ keys. The second column shows the public key, the third column shows the
83private key. 94private key.
84.It Fl q | -quiet 95.It Fl q | -quiet
85Be quiet, in particular outputs only the public key when listing egos. 96Be quiet, in particular outputs only the public key when listing egos.
97.It Fl R Ar MESSAGE | Fl -read= Ns Ar MESSAGE
98Decrypt (read) a message using the respective ego private key. Use together with
99.Fl e .
100The message consists of an ephemeral key and the ciphertext, separated by a dot.
101Such messages can be created with
102.Fl W .
86.It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM 103.It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
87Perform "set" operation for the specified 104Perform "set" operation for the specified
88.Ar SUBSYSTEM 105.Ar SUBSYSTEM
@@ -95,6 +112,13 @@ This will fail if
95does not yet exist. 112does not yet exist.
96.It Fl V | -verbose 113.It Fl V | -verbose
97Be verbose, in particular outputs the public key of freshly created egos. 114Be verbose, in particular outputs the public key of freshly created egos.
115.It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE
116Encrypt (write) the given message for the identity given with
117.Fl k .
118The output contains an ephemeral message public key and the message separated
119by a dot. The entire line needs to be transferred to the recipient, who can use
120.Fl R
121to decrypt the message.
98.It Fl X | -eddsa 122.It Fl X | -eddsa
99Use EdDSA instead of ECDSA. 123Use EdDSA instead of ECDSA.
100.El 124.El