aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
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 @@
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
44is a tool for managing egos. 44is a tool for managing egos.
@@ -58,29 +58,29 @@ This identifier is only used locally for this peer and not shared
58with other peers. 58with other peers.
59The options are as follows: 59The 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
62Creates a new ego with the given 62Creates 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
65Delete the ego with the given 65Delete the ego with the given
66.Ar NAME . 66.Ar NAME .
67.It Fl d | \-display 67.It Fl d | -display
68Display all of our egos. 68Display 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
70Perform "set" operation with the respective ego or restrict "display" 70Perform "set" operation with the respective ego or restrict "display"
71operation to the respective ego. 71operation to the respective ego.
72.It Fl h | \-help 72.It Fl h | -help
73Print the help page. 73Print the help page.
74.It Fl m | \-monitor 74.It Fl m | -monitor
75Run in monitor mode, listing all ouf our egos until CTRL-C is pressed. 75Run in monitor mode, listing all ouf our egos until CTRL-C is pressed.
76Each ego is listed together with a unique pointer value; if 76Each ego is listed together with a unique pointer value; if
77egos are renamed, that pointer value remains the same, 77egos are renamed, that pointer value remains the same,
78if egos are deleted, they are listed one more time with a name of "<null>". 78if 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
80Print the private keys (in Crockford Base32 encoding), and not just the public keys. 80Print the private keys (in Crockford Base32 encoding), and not just the public keys.
81.It Fl q | \-quiet 81.It Fl q | -quiet
82Be quiet, in particular outputs only the public key when listing egos. 82Be 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
84Perform "set" operation for the specified 84Perform "set" operation for the specified
85.Ar SUBSYSTEM 85.Ar SUBSYSTEM
86with the respective ego. 86with the respective ego.
@@ -90,7 +90,7 @@ After this, the given SUBSYSTEM will use the ego with the specified NAME.
90This will fail if 90This will fail if
91.Ar NAME 91.Ar NAME
92does not yet exist. 92does not yet exist.
93.It Fl V | \-verbose 93.It Fl V | -verbose
94Be verbose, in particular outputs the public key of freshly created egos. 94Be 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 @@
30manipulate GNU Name System (GNS) zone data 30manipulate 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
54can be used to manipulate records in a GNS zone. 54can be used to manipulate records in a GNS zone.
55.Pp 55.Pp
56The options are as follows: 56The options are as follows:
57.Bl -tag -width indent 57.Bl -tag -width indent
58.It Fl a | \-add 58.It Fl a | -add
59Desired operation is adding a record. 59Desired 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
61Use the configuration file FILENAME. 61Use the configuration file FILENAME.
62.It Fl d | \-delete 62.It Fl d | -delete
63Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V). 63Desired operation is deleting records under the given name that match the specified type (\-t) and value (\-V).
64If 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). 64If 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).
65Specifying a label (\-n) is mandatory. 65Specifying a label (\-n) is mandatory.
66Note that matching by expiration time or flags is (currently) not supported. 66Note that matching by expiration time or flags is (currently) not supported.
67.It Fl D | \-display 67.It Fl D | -display
68Desired operation is listing of matching records. 68Desired 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
70Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m". 70Specifies expiration time of record to add; format is relative time, i.e "1 h" or "7 d 30 m".
71Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years). 71Supported units are "ms", "s", "min" or "minutes", "h" (hours), "d" (days) and "a" (years).
72.It Fl h | \-help 72.It Fl h | -help
73Print short help on options. 73Print 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
75Set the desired NICKNAME for the zone. 75Set the desired NICKNAME for the zone.
76The nickname will be included in all (public) records and used as the suggested name for this zone. 76The 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
78Use LOGLEVEL for logging. 78Use LOGLEVEL for logging.
79Valid values are DEBUG, INFO, WARNING and ERROR. 79Valid values are DEBUG, INFO, WARNING and ERROR.
80.It Fl m | \-monitor 80.It Fl m | -monitor
81Monitor changes to the zone on an ongoing basis (in contrast to \-D, which merely displays the current records). 81Monitor 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
83Label or name of the record to add/delete/display. 83Label or name of the record to add/delete/display.
84.It Fl p | \-public 84.It Fl p | -public
85Create a record that is public (shared with other users that know the label). 85Create 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
87Determine our GNS name for the given public key (reverse lookup of the PKEY) in the given zone. 87Determine 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
89Sets record set to values given in RECORDLINE. 89Sets record set to values given in RECORDLINE.
90This option can be specified multiple times to provide multiple records for the record set. 90This option can be specified multiple times to provide multiple records for the record set.
91Existing records under the same label will be deleted. 91Existing records under the same label will be deleted.
92The 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". 92The 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".
93The VALUE follows the usual human-readable value format(s) of DNS/GNS. 93The VALUE follows the usual human-readable value format(s) of DNS/GNS.
94.It Fl s | \-shadow 94.It Fl s | -shadow
95Create a record that is a shadow record. 95Create a record that is a shadow record.
96Shadow records are only used once all other records of the same type under the same label have expired. 96Shadow 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
98Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). 98Type 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
100Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used 100Add 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
102Print GNUnet version number. 102Print 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
104Value to store or remove from the GNS zone. 104Value to store or remove from the GNS zone.
105Specific format depends on the record type. 105Specific format depends on the record type.
106A 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. 106A 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
108Specifies 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. 108Specifies 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