diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2023-01-05 21:56:50 +0900 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2023-01-05 21:56:50 +0900 |
commit | d80b327532ac94df153f6a6c6d826d931d5deac6 (patch) | |
tree | dbdbf955577f25127324db4b8d4aff9549abb682 | |
parent | cff5551703e0296d6db0fe7853dba02efa6b7def (diff) | |
download | gnunet-d80b327532ac94df153f6a6c6d826d931d5deac6.tar.gz gnunet-d80b327532ac94df153f6a6c6d826d931d5deac6.zip |
DOC: Add gnunet-did manpage. Issue #7543
-rw-r--r-- | doc/man/Makefile.am | 1 | ||||
-rw-r--r-- | doc/man/gnunet-did.1 | 108 |
2 files changed, 109 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 2cbe158c6..44d99e7e4 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -51,6 +51,7 @@ man_MANS = \ | |||
51 | gnunet-dns2gns.1 \ | 51 | gnunet-dns2gns.1 \ |
52 | gnunet-datastore.1 \ | 52 | gnunet-datastore.1 \ |
53 | gnunet-download.1 \ | 53 | gnunet-download.1 \ |
54 | gnunet-did.1 \ | ||
54 | gnunet-ecc.1 \ | 55 | gnunet-ecc.1 \ |
55 | gnunet-fs.1 \ | 56 | gnunet-fs.1 \ |
56 | gnunet-gns.1 \ | 57 | gnunet-gns.1 \ |
diff --git a/doc/man/gnunet-did.1 b/doc/man/gnunet-did.1 new file mode 100644 index 000000000..283561920 --- /dev/null +++ b/doc/man/gnunet-did.1 | |||
@@ -0,0 +1,108 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2023 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" FDL-1.3. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at 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 http://www.gnu.org/licenses/gpl.html | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd January 5, 2023 | ||
25 | .Dt GNUNET-DID 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-did | ||
29 | .Nd command line tool to create and manage gnunet identity DIDs. | ||
30 | .Sh SYNOPSIS | ||
31 | .Nm | ||
32 | .Op Fl A | -show-all | ||
33 | .Op Fl C | -create | ||
34 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
35 | .Op Fl d Ar DID | Fl -did= Ns Ar DID | ||
36 | .Op Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT | ||
37 | .Op Fl e Ar EGO | Fl -ego= Ns Ar EGO | ||
38 | .Op Fl g | -get | ||
39 | .Op Fl h | -help | ||
40 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
41 | .Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
42 | .Op Fl r | -remove | ||
43 | .Op Fl R | -replace | ||
44 | .Op Fl s | -show | ||
45 | .Op Fl t Ar TIME | Fl -expiration-time= Ns Ar TIME | ||
46 | .Op Fl v | -version | ||
47 | .Sh DESCRIPTION | ||
48 | .Nm | ||
49 | is a command line tool to create and manage gnunet identity DIDs. | ||
50 | .Sh OPTIONS | ||
51 | .Bl -tag -width indent | ||
52 | .It Fl A | -show-all | ||
53 | List all DIDs for all egos. | ||
54 | .It Fl C | -create | ||
55 | Create a DID Document and display the DID. | ||
56 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME | ||
57 | Use the specified configuration file | ||
58 | .Ar FILENAME . | ||
59 | .It Fl d Ar DID | Fl -did= Ns Ar DID | ||
60 | The to use for the operation is | ||
61 | .Ar DID . | ||
62 | .It Fl D Ar DID_DOCUMENT | Fl -did-document= Ns Ar DID_DOCUMENT | ||
63 | The DID Document to use is | ||
64 | .Ar DID_DOCUMENT . | ||
65 | .It Fl e Ar EGO | Fl -ego= Ns Ar EGO | ||
66 | The ego to use is | ||
67 | .Ar EGO . | ||
68 | .It Fl g | -get | ||
69 | Get the DID Document associated with the DID given in | ||
70 | .Ar DID . | ||
71 | .It Fl h | -help | ||
72 | Print short help on options. | ||
73 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL | ||
74 | Use LOGLEVEL for logging. | ||
75 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
76 | .It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE | ||
77 | Configure logging to write logs to | ||
78 | .Ar LOGFILE . | ||
79 | .It Fl r | -remove | ||
80 | Remove the DID given in --did. | ||
81 | .It Fl R | -replace | ||
82 | Replace the DID Docuemnt given in --did-document for the DID given in | ||
83 | .Ar DID . | ||
84 | .It Fl s | -show | ||
85 | Show the DID for the ego given in --ego. | ||
86 | .It Fl t | -expiration-time | ||
87 | The expiration time to use in the GNS record for the DID Document given in | ||
88 | Ar. DID_DOCUMENT . | ||
89 | .It Fl v | -version | ||
90 | Print GNUnet version number. | ||
91 | .El | ||
92 | .Sh SEE ALSO | ||
93 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
94 | If the | ||
95 | .Xr info 1 | ||
96 | and gnunet programs are properly installed at your site, the command | ||
97 | .Pp | ||
98 | .Dl info gnunet | ||
99 | .Pp | ||
100 | should give you access to the complete handbook. | ||
101 | .sp | ||
102 | .\".Sh HISTORY | ||
103 | .\".Sh AUTHORS | ||
104 | .Sh BUGS | ||
105 | Report bugs by using | ||
106 | .Lk https://bugs.gnunet.org | ||
107 | or by sending electronic mail to | ||
108 | .Aq Mt gnunet-developers@gnu.org . | ||