diff options
author | ng0 <ng0@n0.is> | 2019-06-14 18:39:23 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-06-14 18:39:23 +0000 |
commit | cebb6b31b858945b1ef091fac50774012cff986e (patch) | |
tree | 39d18c85fce1a8d6449df661ddf111b5f12ad1d8 /doc | |
parent | ce2f5491241f0fd46ebfb4563b5d020717898613 (diff) | |
download | gnunet-cebb6b31b858945b1ef091fac50774012cff986e.tar.gz gnunet-cebb6b31b858945b1ef091fac50774012cff986e.zip |
gnunet-identity.1,gnunet-namestore.1: unescape dashes where they create
double dashes.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-identity.1 | 38 | ||||
-rw-r--r-- | doc/man/gnunet-namestore.1 | 76 |
2 files changed, 57 insertions, 57 deletions
diff --git a/doc/man/gnunet-identity.1 b/doc/man/gnunet-identity.1 index fba649e8d..9aa48ea4c 100644 --- a/doc/man/gnunet-identity.1 +++ b/doc/man/gnunet-identity.1 | |||
@@ -29,16 +29,16 @@ | |||
29 | .Nd create, delete or list egos | 29 | .Nd create, delete or list 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 |
33 | .Op Fl D Ar NAME | Fl \-delete= Ns Ar NAME | 33 | .Op Fl D Ar NAME | Fl -delete= Ns Ar NAME |
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 m | \-monitor | 37 | .Op Fl m | -monitor |
38 | .Op Fl p | \-private-keys | 38 | .Op Fl p | \-private-keys |
39 | .Op Fl q | \-quiet | 39 | .Op Fl q | -quiet |
40 | .Op Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM | 40 | .Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM |
41 | .Op Fl V | \-verbose | 41 | .Op Fl V | -verbose |
42 | .Sh DESCRIPTION | 42 | .Sh DESCRIPTION |
43 | .Nm | 43 | .Nm |
44 | is a tool for managing egos. | 44 | is a tool for managing egos. |
@@ -58,29 +58,29 @@ This identifier is only used locally for this peer and not shared | |||
58 | with other peers. | 58 | with other peers. |
59 | The options are as follows: | 59 | The options are as follows: |
60 | .Bl -tag -width indent | 60 | .Bl -tag -width indent |
61 | .It Fl C Ar NAME | Fl \-create= Ns Ar NAME | 61 | .It Fl C Ar NAME | Fl -create= Ns Ar NAME |
62 | Creates a new ego with the given | 62 | Creates a new ego with the given |
63 | .Ar NAME . | 63 | .Ar NAME . |
64 | .It Fl D Ar NAME | Fl \-delete= Ns Ar NAME | 64 | .It Fl D Ar NAME | Fl -delete= Ns Ar NAME |
65 | Delete the ego with the given | 65 | Delete the ego with the given |
66 | .Ar NAME . | 66 | .Ar NAME . |
67 | .It Fl d | \-display | 67 | .It Fl d | -display |
68 | Display all of our egos. | 68 | Display all of our egos. |
69 | .It Fl e Ar NAME | Fl \-ego= Ns Ar NAME | 69 | .It Fl e Ar NAME | Fl -ego= Ns Ar NAME |
70 | Perform "set" operation with the respective ego or restrict "display" | 70 | Perform "set" operation with the respective ego or restrict "display" |
71 | operation to the respective ego. | 71 | operation to the respective ego. |
72 | .It Fl h | \-help | 72 | .It Fl h | -help |
73 | Print the help page. | 73 | Print the help page. |
74 | .It Fl m | \-monitor | 74 | .It Fl m | -monitor |
75 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. | 75 | Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. |
76 | Each ego is listed together with a unique pointer value; if | 76 | Each ego is listed together with a unique pointer value; if |
77 | egos are renamed, that pointer value remains the same, | 77 | egos are renamed, that pointer value remains the same, |
78 | if egos are deleted, they are listed one more time with a name of "<null>". | 78 | if egos are deleted, they are listed one more time with a name of "<null>". |
79 | .It Fl p | \-private-keys | 79 | .It Fl p | -private-keys |
80 | Print the private keys (in Crockford Base32 encoding), and not just the public keys. | 80 | Print the private keys (in Crockford Base32 encoding), and not just the public keys. |
81 | .It Fl q | \-quiet | 81 | .It Fl q | -quiet |
82 | Be quiet, in particular outputs only the public key when listing egos. | 82 | Be quiet, in particular outputs only the public key when listing egos. |
83 | .It Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM | 83 | .It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM |
84 | Perform "set" operation for the specified | 84 | Perform "set" operation for the specified |
85 | .Ar SUBSYSTEM | 85 | .Ar SUBSYSTEM |
86 | with the respective ego. | 86 | with the respective ego. |
@@ -90,7 +90,7 @@ After this, the given SUBSYSTEM will use the ego with the specified NAME. | |||
90 | This will fail if | 90 | This will fail if |
91 | .Ar NAME | 91 | .Ar NAME |
92 | does not yet exist. | 92 | does not yet exist. |
93 | .It Fl V | \-verbose | 93 | .It Fl V | -verbose |
94 | Be verbose, in particular outputs the public key of freshly created egos. | 94 | Be verbose, in particular outputs the public key of freshly created egos. |
95 | .El | 95 | .El |
96 | .Sh FILES | 96 | .Sh FILES |
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index 7f6e0bcb6..0fbb6a480 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 | |||
@@ -30,81 +30,81 @@ | |||
30 | manipulate GNU Name System (GNS) zone data | 30 | manipulate GNU Name System (GNS) zone data |
31 | .Sh SYNOPSIS | 31 | .Sh SYNOPSIS |
32 | .Nm | 32 | .Nm |
33 | .Op Fl a | \-add | 33 | .Op Fl a | -add |
34 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 34 | .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
35 | .Op Fl d | \-delete | 35 | .Op Fl d | -delete |
36 | .Op Fl D | \-display | 36 | .Op Fl D | -display |
37 | .Op Fl e Ar TIME | Fl \-expiration= Ns Ar TIME | 37 | .Op Fl e Ar TIME | Fl -expiration= Ns Ar TIME |
38 | .Op Fl h | \-help | 38 | .Op Fl h | -help |
39 | .Op Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME | 39 | .Op Fl i Ar NICKNAME | Fl -nick= Ns Ar NICKNAME |
40 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | 40 | .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
41 | .Op Fl m | \-monitor | 41 | .Op Fl m | -monitor |
42 | .Op Fl n Ar NAME | Fl \-name= Ns Ar NAME | 42 | .Op Fl n Ar NAME | Fl -name= Ns Ar NAME |
43 | .Op Fl p | \-public | 43 | .Op Fl p | -public |
44 | .Op Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY | 44 | .Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY |
45 | .Op Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE | 45 | .Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE |
46 | .Op Fl s | \-shadow | 46 | .Op Fl s | -shadow |
47 | .Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | 47 | .Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE |
48 | .Op Fl u Ar URI | Fl \-uri= Ns Ar URI | 48 | .Op Fl u Ar URI | Fl -uri= Ns Ar URI |
49 | .Op Fl v | \-version | 49 | .Op Fl v | -version |
50 | .Op Fl V Ar VALUE | Fl \-value= Ns Ar VALUE | 50 | .Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE |
51 | .Op Fl z Ar EGO | Fl \-zone= Ns Ar EGO | 51 | .Op Fl z Ar EGO | Fl -zone= Ns Ar EGO |
52 | .Sh DESCRIPTION | 52 | .Sh DESCRIPTION |
53 | .Nm | 53 | .Nm |
54 | can be used to manipulate records in a GNS zone. | 54 | can be used to manipulate records in a GNS zone. |
55 | .Pp | 55 | .Pp |
56 | The options are as follows: | 56 | The options are as follows: |
57 | .Bl -tag -width indent | 57 | .Bl -tag -width indent |
58 | .It Fl a | \-add | 58 | .It Fl a | -add |
59 | Desired operation is adding a record. | 59 | Desired operation is adding a record. |
60 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | 60 | .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME |
61 | Use the configuration file FILENAME. | 61 | Use the configuration file FILENAME. |
62 | .It Fl d | \-delete | 62 | .It Fl d | -delete |
63 | Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V). | 63 | Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V). |
64 | If type or value are not specified, it means that all types (or values) should be assumed to match (and possibly multiple or all values under the given label will be deleted). | 64 | If type or value are not specified, it means that all types (or values) should be assumed to match (and possibly multiple or all values under the given label will be deleted). |
65 | Specifying a label (\-n) is mandatory. | 65 | Specifying a label (\-n) is mandatory. |
66 | Note that matching by expiration time or flags is (currently) not supported. | 66 | Note that matching by expiration time or flags is (currently) not supported. |
67 | .It Fl D | \-display | 67 | .It Fl D | -display |
68 | Desired operation is listing of matching records. | 68 | Desired operation is listing of matching records. |
69 | .It Fl e Ar TIME | Fl \-expiration= Ns Ar TIME | 69 | .It Fl e Ar TIME | Fl -expiration= Ns Ar TIME |
70 | Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". | 70 | Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". |
71 | Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). | 71 | Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). |
72 | .It Fl h | \-help | 72 | .It Fl h | -help |
73 | Print short help on options. | 73 | Print short help on options. |
74 | .It Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME | 74 | .It Fl i Ar NICKNAME | Fl -nick= Ns Ar NICKNAME |
75 | Set the desired NICKNAME for the zone. | 75 | Set the desired NICKNAME for the zone. |
76 | The nickname will be included in all (public) records and used as the suggested name for this zone. | 76 | The nickname will be included in all (public) records and used as the suggested name for this zone. |
77 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | 77 | .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL |
78 | Use LOGLEVEL for logging. | 78 | Use LOGLEVEL for logging. |
79 | Valid values are DEBUG, INFO, WARNING and ERROR. | 79 | Valid values are DEBUG, INFO, WARNING and ERROR. |
80 | .It Fl m | \-monitor | 80 | .It Fl m | -monitor |
81 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records). | 81 | Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records). |
82 | .It Fl n Ar NAME | Fl \-name= Ns Ar NAME | 82 | .It Fl n Ar NAME | Fl -name= Ns Ar NAME |
83 | Label or name of the record to add/delete/display. | 83 | Label or name of the record to add/delete/display. |
84 | .It Fl p | \-public | 84 | .It Fl p | -public |
85 | Create a record that is public (shared with other users that know the label). | 85 | Create a record that is public (shared with other users that know the label). |
86 | .It Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY | 86 | .It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY |
87 | Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone. | 87 | Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone. |
88 | .It Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE | 88 | .It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE |
89 | Sets record set to values given in RECORDLINE. | 89 | Sets record set to values given in RECORDLINE. |
90 | This option can be specified multiple times to provide multiple records for the record set. | 90 | This option can be specified multiple times to provide multiple records for the record set. |
91 | Existing records under the same label will be deleted. | 91 | Existing records under the same label will be deleted. |
92 | The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is the time to live in seconds (unit must not be given explicitly, seconds is always implied), TYPE is the DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". | 92 | The format for the RECORDLINE is "TTL TYPE FLAGS VALUE" where TTL is the time to live in seconds (unit must not be given explicitly, seconds is always implied), TYPE is the DNS/GNS record type, FLAGS is "(N)ORMAL", "(S)HADOW" or "(P)UBLIC". |
93 | The VALUE follows the usual human-readable value format(s) of DNS/GNS. | 93 | The VALUE follows the usual human-readable value format(s) of DNS/GNS. |
94 | .It Fl s | \-shadow | 94 | .It Fl s | -shadow |
95 | Create a record that is a shadow record. | 95 | Create a record that is a shadow record. |
96 | Shadow records are only used once all other records of the same type under the same label have expired. | 96 | Shadow records are only used once all other records of the same type under the same label have expired. |
97 | .It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE | 97 | .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE |
98 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). | 98 | Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). |
99 | .It Fl u Ar URI | Fl \-uri= Ns Ar URI | 99 | .It Fl u Ar URI | Fl -uri= Ns Ar URI |
100 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used | 100 | Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used |
101 | .It Fl v | \-version | 101 | .It Fl v | -version |
102 | Print GNUnet version number. | 102 | Print GNUnet version number. |
103 | .It Fl V Ar VALUE | Fl \-value= Ns Ar VALUE | 103 | .It Fl V Ar VALUE | Fl -value= Ns Ar VALUE |
104 | Value to store or remove from the GNS zone. | 104 | Value to store or remove from the GNS zone. |
105 | Specific format depends on the record type. | 105 | Specific format depends on the record type. |
106 | A records expect a dotted decimal IPv4 address, AAAA records an IPv6 address, PKEY a public key in GNUnet's printable format, and CNAME and NS records should be a domain name. | 106 | A records expect a dotted decimal IPv4 address, AAAA records an IPv6 address, PKEY a public key in GNUnet's printable format, and CNAME and NS records should be a domain name. |
107 | .It Fl z Ar EGO | Fl \-zone= Ns Ar EGO | 107 | .It Fl z Ar EGO | Fl -zone= Ns Ar EGO |
108 | Specifies the name of the ego controlling the private key for the zone. If not provided, we will attempt to use the default identity set for the "namestore". Alternatively, a private key may be passed in Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment variable. The latter is useful to improve performance of tools like Ascension as it allows the command to skip IPC with the identity management subsystem. | 108 | Specifies the name of the ego controlling the private key for the zone. If not provided, we will attempt to use the default identity set for the "namestore". Alternatively, a private key may be passed in Base32-encoding using the GNUNET_NAMESTORE_EGO_PRIVATE_KEY environment variable. The latter is useful to improve performance of tools like Ascension as it allows the command to skip IPC with the identity management subsystem. |
109 | .El | 109 | .El |
110 | .\".Sh EXAMPLES | 110 | .\".Sh EXAMPLES |