summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-06-14 18:39:23 +0000
committerng0 <ng0@n0.is>2019-06-14 18:39:23 +0000
commitcebb6b31b858945b1ef091fac50774012cff986e (patch)
tree39d18c85fce1a8d6449df661ddf111b5f12ad1d8 /doc
parentce2f5491241f0fd46ebfb4563b5d020717898613 (diff)
gnunet-identity.1,gnunet-namestore.1: unescape dashes where they create
double dashes.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-identity.138
-rw-r--r--doc/man/gnunet-namestore.176
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 @@
.Nd create, delete or list egos
.Sh SYNOPSIS
.Nm
-.Op Fl C Ar NAME | Fl \-create= Ns Ar NAME
-.Op Fl D Ar NAME | Fl \-delete= Ns Ar NAME
-.Op Fl d | \-display
-.Op Fl e Ar NAME | Fl \-ego= Ns Ar NAME
-.Op Fl h | \-help
-.Op Fl m | \-monitor
+.Op Fl C Ar NAME | Fl -create= Ns Ar NAME
+.Op Fl D Ar NAME | Fl -delete= Ns Ar NAME
+.Op Fl d | -display
+.Op Fl e Ar NAME | Fl -ego= Ns Ar NAME
+.Op Fl h | -help
+.Op Fl m | -monitor
.Op Fl p | \-private-keys
-.Op Fl q | \-quiet
-.Op Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
-.Op Fl V | \-verbose
+.Op Fl q | -quiet
+.Op Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
+.Op Fl V | -verbose
.Sh DESCRIPTION
.Nm
is a tool for managing egos.
@@ -58,29 +58,29 @@ This identifier is only used locally for this peer and not shared
with other peers.
The options are as follows:
.Bl -tag -width indent
-.It Fl C Ar NAME | Fl \-create= Ns Ar NAME
+.It Fl C Ar NAME | Fl -create= Ns Ar NAME
Creates a new ego with the given
.Ar NAME .
-.It Fl D Ar NAME | Fl \-delete= Ns Ar NAME
+.It Fl D Ar NAME | Fl -delete= Ns Ar NAME
Delete the ego with the given
.Ar NAME .
-.It Fl d | \-display
+.It Fl d | -display
Display all of our egos.
-.It Fl e Ar NAME | Fl \-ego= Ns Ar NAME
+.It Fl e Ar NAME | Fl -ego= Ns Ar NAME
Perform "set" operation with the respective ego or restrict "display"
operation to the respective ego.
-.It Fl h | \-help
+.It Fl h | -help
Print the help page.
-.It Fl m | \-monitor
+.It Fl m | -monitor
Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
Each ego is listed together with a unique pointer value; if
egos are renamed, that pointer value remains the same,
if egos are deleted, they are listed one more time with a name of "<null>".
-.It Fl p | \-private-keys
+.It Fl p | -private-keys
Print the private keys (in Crockford Base32 encoding), and not just the public keys.
-.It Fl q | \-quiet
+.It Fl q | -quiet
Be quiet, in particular outputs only the public key when listing egos.
-.It Fl s Ar SUBSYSTEM | Fl \-set= Ns Ar SUBSYSTEM
+.It Fl s Ar SUBSYSTEM | Fl -set= Ns Ar SUBSYSTEM
Perform "set" operation for the specified
.Ar SUBSYSTEM
with the respective ego.
@@ -90,7 +90,7 @@ After this, the given SUBSYSTEM will use the ego with the specified NAME.
This will fail if
.Ar NAME
does not yet exist.
-.It Fl V | \-verbose
+.It Fl V | -verbose
Be verbose, in particular outputs the public key of freshly created egos.
.El
.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 @@
manipulate GNU Name System (GNS) zone data
.Sh SYNOPSIS
.Nm
-.Op Fl a | \-add
-.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
-.Op Fl d | \-delete
-.Op Fl D | \-display
-.Op Fl e Ar TIME | Fl \-expiration= Ns Ar TIME
-.Op Fl h | \-help
-.Op Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME
-.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
-.Op Fl m | \-monitor
-.Op Fl n Ar NAME | Fl \-name= Ns Ar NAME
-.Op Fl p | \-public
-.Op Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY
-.Op Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE
-.Op Fl s | \-shadow
-.Op Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
-.Op Fl u Ar URI | Fl \-uri= Ns Ar URI
-.Op Fl v | \-version
-.Op Fl V Ar VALUE | Fl \-value= Ns Ar VALUE
-.Op Fl z Ar EGO | Fl \-zone= Ns Ar EGO
+.Op Fl a | -add
+.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
+.Op Fl d | -delete
+.Op Fl D | -display
+.Op Fl e Ar TIME | Fl -expiration= Ns Ar TIME
+.Op Fl h | -help
+.Op Fl i Ar NICKNAME | Fl -nick= Ns Ar NICKNAME
+.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
+.Op Fl m | -monitor
+.Op Fl n Ar NAME | Fl -name= Ns Ar NAME
+.Op Fl p | -public
+.Op Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
+.Op Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
+.Op Fl s | -shadow
+.Op Fl t Ar TYPE | Fl -type= Ns Ar TYPE
+.Op Fl u Ar URI | Fl -uri= Ns Ar URI
+.Op Fl v | -version
+.Op Fl V Ar VALUE | Fl -value= Ns Ar VALUE
+.Op Fl z Ar EGO | Fl -zone= Ns Ar EGO
.Sh DESCRIPTION
.Nm
can be used to manipulate records in a GNS zone.
.Pp
The options are as follows:
.Bl -tag -width indent
-.It Fl a | \-add
+.It Fl a | -add
Desired operation is adding a record.
-.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
+.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
Use the configuration file FILENAME.
-.It Fl d | \-delete
+.It Fl d | -delete
Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V).
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).
Specifying a label (\-n) is mandatory.
Note that matching by expiration time or flags is (currently) not supported.
-.It Fl D | \-display
+.It Fl D | -display
Desired operation is listing of matching records.
-.It Fl e Ar TIME | Fl \-expiration= Ns Ar TIME
+.It Fl e Ar TIME | Fl -expiration= Ns Ar TIME
Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m".
Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years).
-.It Fl h | \-help
+.It Fl h | -help
Print short help on options.
-.It Fl i Ar NICKNAME | Fl \-nick= Ns Ar NICKNAME
+.It Fl i Ar NICKNAME | Fl -nick= Ns Ar NICKNAME
Set the desired NICKNAME for the zone.
The nickname will be included in all (public) records and used as the suggested name for this zone.
-.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
+.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
Use LOGLEVEL for logging.
Valid values are DEBUG, INFO, WARNING and ERROR.
-.It Fl m | \-monitor
+.It Fl m | -monitor
Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records).
-.It Fl n Ar NAME | Fl \-name= Ns Ar NAME
+.It Fl n Ar NAME | Fl -name= Ns Ar NAME
Label or name of the record to add/delete/display.
-.It Fl p | \-public
+.It Fl p | -public
Create a record that is public (shared with other users that know the label).
-.It Fl r Ar PKEY | Fl \-reverse= Ns Ar PKEY
+.It Fl r Ar PKEY | Fl -reverse= Ns Ar PKEY
Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone.
-.It Fl R Ar RECORDLINE | Fl \-replace= Ns Ar RECORDLINE
+.It Fl R Ar RECORDLINE | Fl -replace= Ns Ar RECORDLINE
Sets record set to values given in RECORDLINE.
This option can be specified multiple times to provide multiple records for the record set.
Existing records under the same label will be deleted.
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".
The VALUE follows the usual human-readable value format(s) of DNS/GNS.
-.It Fl s | \-shadow
+.It Fl s | -shadow
Create a record that is a shadow record.
Shadow records are only used once all other records of the same type under the same label have expired.
-.It Fl t Ar TYPE | Fl \-type= Ns Ar TYPE
+.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.).
-.It Fl u Ar URI | Fl \-uri= Ns Ar URI
+.It Fl u Ar URI | Fl -uri= Ns Ar URI
Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used
-.It Fl v | \-version
+.It Fl v | -version
Print GNUnet version number.
-.It Fl V Ar VALUE | Fl \-value= Ns Ar VALUE
+.It Fl V Ar VALUE | Fl -value= Ns Ar VALUE
Value to store or remove from the GNS zone.
Specific format depends on the record type.
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.
-.It Fl z Ar EGO | Fl \-zone= Ns Ar EGO
+.It Fl z Ar EGO | Fl -zone= Ns Ar EGO
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.
.El
.\".Sh EXAMPLES