diff options
Diffstat (limited to 'doc/man/gnunet-identity.1')
-rw-r--r-- | doc/man/gnunet-identity.1 | 35 |
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 | |||
51 | existing egos (the namespace will continue to exist, but it will | 53 | existing egos (the namespace will continue to exist, but it will |
52 | be impossible to add additional data to it). | 54 | be impossible to add additional data to it). |
53 | .Pp | 55 | .Pp |
56 | In addition, it is possible to encrypt and decrypt messages (arbitrary strings) | ||
57 | using a given public key (for encryption) or ego (for decryption). | ||
58 | .Pp | ||
54 | Creating a new ego requires using the | 59 | Creating a new ego requires using the |
55 | .Fl C | 60 | .Fl C |
56 | option together with an identifier (name) that is to be used for | 61 | option 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" | |||
72 | operation to the respective ego. | 77 | operation to the respective ego. |
73 | .It Fl h | -help | 78 | .It Fl h | -help |
74 | Print the help page. | 79 | Print the help page. |
80 | .It Fl k Ar PUBLIC_KEY | Fl -key= Ns Ar PUBLIC_KEY | ||
81 | The public key to use for a message recipient. Use together with | ||
82 | .Fl W . | ||
83 | The recipient can obtain the desired ego's public key using the "display" | ||
84 | operation. | ||
75 | .It Fl m | -monitor | 85 | .It Fl m | -monitor |
76 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. | 86 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. |
77 | Each ego is listed together with a unique pointer value; if | 87 | Each 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 | |||
83 | private key. | 93 | private key. |
84 | .It Fl q | -quiet | 94 | .It Fl q | -quiet |
85 | Be quiet, in particular outputs only the public key when listing egos. | 95 | Be 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 |
87 | Perform "set" operation for the specified | 97 | Decrypt (read) a message using the respective ego private key. Use together with |
88 | .Ar SUBSYSTEM | ||
89 | with the respective ego. | ||
90 | Needs to be used together with option | ||
91 | .Fl e . | 98 | .Fl e . |
92 | After this, the given SUBSYSTEM will use the ego with the specified NAME. | 99 | The message consists of an ephemeral key and the ciphertext, separated by a dot. |
93 | This will fail if | 100 | Such messages can be created with |
94 | .Ar NAME | 101 | .Fl W . |
95 | does not yet exist. | ||
96 | .It Fl V | -verbose | 102 | .It Fl V | -verbose |
97 | Be verbose, in particular outputs the public key of freshly created egos. | 103 | Be verbose, in particular outputs the public key of freshly created egos. |
104 | .It Fl W Ar MESSAGE | Fl -write= Ns Ar MESSAGE | ||
105 | Encrypt (write) the given message for the identity given with | ||
106 | .Fl k . | ||
107 | The output contains an ephemeral message public key and the message separated | ||
108 | by a dot. The entire line needs to be transferred to the recipient, who can use | ||
109 | .Fl R | ||
110 | to decrypt the message. | ||
98 | .It Fl X | -eddsa | 111 | .It Fl X | -eddsa |
99 | Use EdDSA instead of ECDSA. | 112 | Use EdDSA instead of ECDSA. |
100 | .El | 113 | .El |