aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/handbook/chapters/developer.texi53
-rw-r--r--doc/handbook/chapters/installation.texi19
-rw-r--r--doc/handbook/chapters/user.texi14
-rw-r--r--doc/man/gnunet-config.12
-rw-r--r--doc/man/gnunet-datastore.12
-rw-r--r--doc/man/gnunet-namestore.12
6 files changed, 46 insertions, 46 deletions
diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi
index e7b88a39f..1bf7a7b24 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/handbook/chapters/developer.texi
@@ -392,9 +392,9 @@ etc.).
392@item @file{transport/} --- transport service 392@item @file{transport/} --- transport service
393The transport service is responsible for managing the 393The transport service is responsible for managing the
394basic P2P communication. It uses plugins to support P2P communication 394basic P2P communication. It uses plugins to support P2P communication
395over TCP, UDP, HTTP, HTTPS and other protocols.The transport service 395over TCP, UDP, HTTP, HTTPS and other protocols. The transport service
396validates peer addresses, enforces bandwidth restrictions, limits the 396validates peer addresses, enforces bandwidth restrictions, limits the
397total number of connections and enforces connectivity restrictions (i.e. 397total number of connections and enforces connectivity restrictions (e.g.
398friends-only). 398friends-only).
399@item @file{peerinfo-tool/} --- gnunet-peerinfo 399@item @file{peerinfo-tool/} --- gnunet-peerinfo
400This directory contains the gnunet-peerinfo binary which can be used to 400This directory contains the gnunet-peerinfo binary which can be used to
@@ -746,21 +746,21 @@ Here you can find some rules to help you write code for GNUnet.
746 746
747@itemize @bullet 747@itemize @bullet
748@item services and daemons use their directory name in 748@item services and daemons use their directory name in
749@code{GNUNET_log_setup} (i.e. 'core') and log using 749@code{GNUNET_log_setup} (e.g. 'core') and log using
750plain 'GNUNET_log'. 750plain 'GNUNET_log'.
751@item command-line tools use their full name in 751@item command-line tools use their full name in
752@code{GNUNET_log_setup} (i.e. 'gnunet-publish') and log using 752@code{GNUNET_log_setup} (e.g. 'gnunet-publish') and log using
753plain 'GNUNET_log'. 753plain 'GNUNET_log'.
754@item service access libraries log using 754@item service access libraries log using
755'@code{GNUNET_log_from}' and use '@code{DIRNAME-api}' for the 755'@code{GNUNET_log_from}' and use '@code{DIRNAME-api}' for the
756component (i.e. 'core-api') 756component (e.g. 'core-api')
757@item pure libraries (without associated service) use 757@item pure libraries (without associated service) use
758'@code{GNUNET_log_from}' with the component set to their 758'@code{GNUNET_log_from}' with the component set to their
759library name (without lib or '@file{.so}'), 759library name (without lib or '@file{.so}'),
760which should also be their directory name (i.e. '@file{nat}') 760which should also be their directory name (e.g. '@file{nat}')
761@item plugins should use '@code{GNUNET_log_from}' 761@item plugins should use '@code{GNUNET_log_from}'
762with the directory name and the plugin name combined to produce 762with the directory name and the plugin name combined to produce
763the component name (i.e. 'transport-tcp'). 763the component name (e.g. 'transport-tcp').
764@item logging should be unified per-file by defining a 764@item logging should be unified per-file by defining a
765@code{LOG} macro with the appropriate arguments, 765@code{LOG} macro with the appropriate arguments,
766along these lines: 766along these lines:
@@ -832,14 +832,14 @@ test
832@subsubsection src/ directories 832@subsubsection src/ directories
833 833
834@itemize @bullet 834@itemize @bullet
835@item gnunet-NAME: end-user applications (i.e., gnunet-search, gnunet-arm) 835@item gnunet-NAME: end-user applications (like gnunet-search or gnunet-arm)
836@item gnunet-service-NAME: service processes with accessor library (i.e., 836@item gnunet-service-NAME: service processes with accessor library (e.g.
837gnunet-service-arm) 837gnunet-service-arm)
838@item libgnunetNAME: accessor library (_service.h-header) or standalone 838@item libgnunetNAME: accessor library (_service.h-header) or standalone
839library (_lib.h-header) 839library (_lib.h-header)
840@item gnunet-daemon-NAME: daemon process without accessor library (i.e., 840@item gnunet-daemon-NAME: daemon process without accessor library (e.g.
841gnunet-daemon-hostlist) and no GNUnet management port 841gnunet-daemon-hostlist) and no GNUnet management port
842@item libgnunet_plugin_DIR_NAME: loadable plugins (i.e., 842@item libgnunet_plugin_DIR_NAME: loadable plugins (e.g.
843libgnunet_plugin_transport_tcp) 843libgnunet_plugin_transport_tcp)
844@end itemize 844@end itemize
845 845
@@ -6640,7 +6640,7 @@ The size of an element's data is limited to around 62 KB.
6640Sets created by a local client can be modified and reused for multiple 6640Sets created by a local client can be modified and reused for multiple
6641operations. As each set operation requires potentially expensive special 6641operations. As each set operation requires potentially expensive special
6642auxiliary data to be computed for each element of a set, a set can only 6642auxiliary data to be computed for each element of a set, a set can only
6643participate in one type of set operation (i.e. union or intersection). 6643participate in one type of set operation (either union or intersection).
6644The type of a set is determined upon its creation. 6644The type of a set is determined upon its creation.
6645If a the elements of a set are needed for an operation of a different 6645If a the elements of a set are needed for an operation of a different
6646type, all of the set's element must be copied to a new set of appropriate 6646type, all of the set's element must be copied to a new set of appropriate
@@ -9030,14 +9030,13 @@ particular key has been revoked. The service responds with a
9030@code{QueryResponseMessage} which simply contains a bit that says if the 9030@code{QueryResponseMessage} which simply contains a bit that says if the
9031given public key is still valid, or if it has been revoked. 9031given public key is still valid, or if it has been revoked.
9032 9032
9033The second possible interaction is for a client to revoke a key by 9033The second possible interaction is for a client to revoke a key by passing a
9034passing a @code{RevokeMessage} to the service. The @code{RevokeMessage} 9034@code{RevokeMessage} to the service. The @code{RevokeMessage} contains the
9035contains the ECDSA public key to be revoked, a signature by the 9035ECDSA public key to be revoked, a signature by the corresponding private key
9036corresponding private key and the proof-of-work, The service responds 9036and the proof-of-work. The service responds with a
9037with a @code{RevocationResponseMessage} which can be used to indicate 9037@code{RevocationResponseMessage} which can be used to indicate that the
9038that the @code{RevokeMessage} was invalid (i.e. proof of work incorrect), 9038@code{RevokeMessage} was invalid (e.g. the proof of work is incorrect), or
9039or otherwise indicates that the revocation has been processed 9039otherwise to indicate that the revocation has been processed successfully.
9040successfully.
9041 9040
9042@node The REVOCATION Peer-to-Peer Protocol 9041@node The REVOCATION Peer-to-Peer Protocol
9043@subsection The REVOCATION Peer-to-Peer Protocol 9042@subsection The REVOCATION Peer-to-Peer Protocol
@@ -9615,9 +9614,9 @@ In order to address the above issues, we want to:
9615 TRANSPORT shall create bi-directional channels from this whenever 9614 TRANSPORT shall create bi-directional channels from this whenever
9616 possible. 9615 possible.
9617@item DV should no longer be a plugin, but part of TRANSPORT. 9616@item DV should no longer be a plugin, but part of TRANSPORT.
9618@item TRANSPORT should provide communicators help communicating (i.e. in the 9617@item TRANSPORT should provide communicators help communicating, for example
9619 case of uni-directional communicators or the need for out-of-band 9618 in the case of uni-directional communicators or the need for out-of-band
9620 signalling for NAT traversal). We call this functionality 9619 signalling for NAT traversal. We call this functionality
9621 @emph{backchannels}. 9620 @emph{backchannels}.
9622@item Transport manipulation should be signalled to CORE on a per-message basis 9621@item Transport manipulation should be signalled to CORE on a per-message basis
9623 instead of an approximate bandwidth. 9622 instead of an approximate bandwidth.
@@ -9715,8 +9714,8 @@ by layer. For example, CADET will always strictly implement reliable and
9715in-order delivery of messages, while the same options are only advisory for 9714in-order delivery of messages, while the same options are only advisory for
9716TRANSPORT and CORE: they should try (using ACKs on unreliable communicators, 9715TRANSPORT and CORE: they should try (using ACKs on unreliable communicators,
9717not changing the message order themselves), but if messages are lost anyway 9716not changing the message order themselves), but if messages are lost anyway
9718(i.e. because a TCP is dropped in the middle), or if messages are reordered 9717(e.g. because a TCP is dropped in the middle), or if messages are reordered
9719(i.e. because they took dierent paths over the network and arrived in a 9718(e.g. because they took different paths over the network and arrived in a
9720different order) TRANSPORT and CORE do not have to correct this. Whether a 9719different order) TRANSPORT and CORE do not have to correct this. Whether a
9721preference is strict or loose is thus dened by the respective layer. 9720preference is strict or loose is thus dened by the respective layer.
9722 9721
@@ -9728,8 +9727,8 @@ The API for communicators is defined in
9728Each communicator must specify its (global) communication characteristics, which 9727Each communicator must specify its (global) communication characteristics, which
9729for now only say whether the communication is reliable (e.g. TCP, HTTPS) or 9728for now only say whether the communication is reliable (e.g. TCP, HTTPS) or
9730unreliable (e.g. UDP, WLAN). Each communicator must specify a unique address 9729unreliable (e.g. UDP, WLAN). Each communicator must specify a unique address
9731prex, or NULL if the communicator cannot establish outgoing connections (i.e. 9730prex, or NULL if the communicator cannot establish outgoing connections
9732is only acting as a TCP server). 9731(for example because it is only acting as a TCP server).
9733A communicator must tell TRANSPORT which addresses it is reachable under. 9732A communicator must tell TRANSPORT which addresses it is reachable under.
9734Addresses may be added or removed at any time. A communicator may have zero 9733Addresses may be added or removed at any time. A communicator may have zero
9735addresses (transmission only). 9734addresses (transmission only).
diff --git a/doc/handbook/chapters/installation.texi b/doc/handbook/chapters/installation.texi
index ad939b5b7..24431e20f 100644
--- a/doc/handbook/chapters/installation.texi
+++ b/doc/handbook/chapters/installation.texi
@@ -1355,7 +1355,7 @@ The interface channel depends on the wlan network that the card is
1355connected to. If no connection has been made since the start of the 1355connected to. If no connection has been made since the start of the
1356computer, it is usually the first channel of the card. 1356computer, it is usually the first channel of the card.
1357Peers will only find each other and communicate if they are on the same 1357Peers will only find each other and communicate if they are on the same
1358channel. Channels must be set manually, i.e. using: 1358channel. Channels must be set manually, e.g. by using:
1359 1359
1360@example 1360@example
1361iwconfig wlan0 channel 1 1361iwconfig wlan0 channel 1
@@ -1944,12 +1944,13 @@ Python installation and its dependencies.
1944 1944
1945Another way to install Ascension on Debian is to install the python3-ascension 1945Another way to install Ascension on Debian is to install the python3-ascension
1946package. It can be found within the above mentioned Ascension git repository. 1946package. It can be found within the above mentioned Ascension git repository.
1947This also adds a system user ascension and runs a GNUnet peer in the 1947This also adds a system user called ascension and runs a GNUnet peer in the
1948background. Attention: This only works if a recent version of GNUnet is 1948background. Please note: This only works if a recent version of GNUnet is
1949installed on your system. The version number of Ascension is chosen according 1949installed on your system. The version number of Ascension is chosen according
1950to the required feature level of GNUnet. I.e. Ascension 0.11.5 is only 1950to the required feature level of GNUnet: Ascension 0.11.5 is only
1951compatible with GNUnet 0.11.5 and upwards. As Debian's packages for GNUnet are 1951compatible with GNUnet 0.11.5 or later and so on.
1952outdated even in experimental, you will need to install GNUnet manually 1952As Debian's packages for GNUnet are outdated even in experimental,
1953you will need to install GNUnet manually
1953@xref{Installing GNUnet}. 1954@xref{Installing GNUnet}.
1954 1955
1955Please check @xref{Migrating an existing DNS zone into GNS}, for usage manual 1956Please check @xref{Migrating an existing DNS zone into GNS}, for usage manual
@@ -2034,11 +2035,11 @@ Furthermore, you can serve as a DNS, IPv4 or IPv6 exit to the Internet.
2034Being a DNS exit is usually pretty harmless. However, enabling IPv4 or 2035Being a DNS exit is usually pretty harmless. However, enabling IPv4 or
2035IPv6-exit without further precautions may enable adversaries to access 2036IPv6-exit without further precautions may enable adversaries to access
2036your local network, send spam, attack other systems from your Internet 2037your local network, send spam, attack other systems from your Internet
2037connection and to other mischief that will appear to come from your 2038connection and do other mischiefs that will appear to come from your
2038machine. This may or may not get you into legal trouble. 2039machine. This may or may not get you into legal trouble.
2039If you want to allow IPv4 or IPv6-exit functionality, you should strongly 2040If you want to allow IPv4 or IPv6-exit functionality, you should strongly
2040consider adding additional firewall rules manually to protect your local 2041consider adding additional firewall rules manually to protect your local
2041network and to restrict outgoing TCP traffic (i.e. by not allowing access 2042network and to restrict outgoing TCP traffic (e.g. by not allowing access
2042to port 25). While we plan to improve exit-filtering in the future, 2043to port 25). While we plan to improve exit-filtering in the future,
2043you're currently on your own here. 2044you're currently on your own here.
2044Essentially, be prepared for any kind of IP-traffic to exit the respective 2045Essentially, be prepared for any kind of IP-traffic to exit the respective
@@ -2159,7 +2160,7 @@ run as use "gnunet" (and with option "-c /etc/gnunet.conf" so that it
2159modifies the system configuration). As always, gnunet-setup should be run 2160modifies the system configuration). As always, gnunet-setup should be run
2160after the GNUnet peer was stopped using "gnunet-arm -e". Distributors 2161after the GNUnet peer was stopped using "gnunet-arm -e". Distributors
2161might want to include a wrapper for gnunet-setup that allows the 2162might want to include a wrapper for gnunet-setup that allows the
2162desktop-user to "sudo" (i.e. using gtksudo) to the "gnunet" user account 2163desktop-user to "sudo" (e.g. using gtksudo) to the "gnunet" user account
2163and then runs "gnunet-arm -e", "gnunet-setup" and "gnunet-arm -s" in 2164and then runs "gnunet-arm -e", "gnunet-setup" and "gnunet-arm -s" in
2164sequence. 2165sequence.
2165 2166
diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi
index 911d23526..409a89e47 100644
--- a/doc/handbook/chapters/user.texi
+++ b/doc/handbook/chapters/user.texi
@@ -71,7 +71,7 @@ $ gnunet-arm -e
71``.pin'' is a default zone which points to a zone managed by gnunet.org. 71``.pin'' is a default zone which points to a zone managed by gnunet.org.
72Use @code{gnunet-config -s gns} to view the GNS configuration, including 72Use @code{gnunet-config -s gns} to view the GNS configuration, including
73all configured zones that are operated by other users. The respective 73all configured zones that are operated by other users. The respective
74configuration entry names start with a ``.'', i.e. ``.pin''. 74configuration entry names start with a ``.'', e.g. ``.pin''.
75 75
76You can configure any number of top-level domains, and point them to 76You can configure any number of top-level domains, and point them to
77the respective zones of your friends! For this, simply obtain the 77the respective zones of your friends! For this, simply obtain the
@@ -1620,7 +1620,7 @@ under "*.friend.gnu".
1620BOX records are there to integrate information from TLSA or 1620BOX records are there to integrate information from TLSA or
1621SRV records under the main label. In DNS, TLSA and SRV records 1621SRV records under the main label. In DNS, TLSA and SRV records
1622use special names of the form @code{_port._proto.(label.)*tld} to 1622use special names of the form @code{_port._proto.(label.)*tld} to
1623indicate the port number and protocol (i.e. tcp or udp) for which 1623indicate the port number and protocol (like TCP or UDP) for which
1624the TLSA or SRV record is valid. This causes various problems, and 1624the TLSA or SRV record is valid. This causes various problems, and
1625is elegantly solved in GNS by integrating the protocol and port 1625is elegantly solved in GNS by integrating the protocol and port
1626numbers together with the respective value into a "BOX" record. 1626numbers together with the respective value into a "BOX" record.
@@ -1700,7 +1700,7 @@ be useful if you do not want to start resolution in the DNS root zone
1700(due to issues such as censorship or availability). 1700(due to issues such as censorship or availability).
1701 1701
1702Note that you would typically want to use a relative name for the 1702Note that you would typically want to use a relative name for the
1703nameserver, i.e. 1703nameserver, like so:
1704 1704
1705@example 1705@example
1706Name: pet; RRType: GNS2DNS; Value: gnunet.org@@ns-joker.+@ 1706Name: pet; RRType: GNS2DNS; Value: gnunet.org@@ns-joker.+@
@@ -2244,7 +2244,7 @@ that subnet to the GNUnet exit's TUN interface.
2244 2244
2245When running a local service, you should make sure that the local 2245When running a local service, you should make sure that the local
2246service is (also) bound to the IP address of your EXIT interface 2246service is (also) bound to the IP address of your EXIT interface
2247(i.e. 169.254.86.1). It will NOT work if your local service is 2247(e.g. 169.254.86.1). It will NOT work if your local service is
2248just bound to loopback. You may also want to create a "VPN" record 2248just bound to loopback. You may also want to create a "VPN" record
2249in your zone of the GNU Name System to make it easy for others to 2249in your zone of the GNU Name System to make it easy for others to
2250access your service via a name instead of just the full service 2250access your service via a name instead of just the full service
@@ -2315,7 +2315,7 @@ and restart your peer, your Internet traffic should be tunneled
2315over the GNUnet VPN. 2315over the GNUnet VPN.
2316 2316
2317The GNUnet VPN uses DNS-ALG to hijack your IP traffic. Whenever an 2317The GNUnet VPN uses DNS-ALG to hijack your IP traffic. Whenever an
2318application resolves a hostname (i.e. 'gnunet.org'), the 2318application resolves a hostname (like 'gnunet.org'), the
2319"gnunet-daemon-pt" will instruct the "gnunet-service-dns" to intercept 2319"gnunet-daemon-pt" will instruct the "gnunet-service-dns" to intercept
2320the request (possibly route it over GNUnet as well) and replace the 2320the request (possibly route it over GNUnet as well) and replace the
2321normal answer with an IP in the range of the VPN's interface. 2321normal answer with an IP in the range of the VPN's interface.
@@ -2325,8 +2325,8 @@ destination.
2325 2325
2326For applications that do not use DNS, you can also manually create 2326For applications that do not use DNS, you can also manually create
2327such a mapping using the gnunet-vpn command-line tool. Here, you 2327such a mapping using the gnunet-vpn command-line tool. Here, you
2328specify the desired address family of the result (i.e. "-4"), and the 2328specify the desired address family of the result (e.g. "-4"), and the
2329intended target IP on the Internet ("-i 131.159.74.67") and 2329intended target IP on the Internet (e.g. "-i 131.159.74.67") and
2330"gnunet-vpn" will tell you which IP address in the range of your 2330"gnunet-vpn" will tell you which IP address in the range of your
2331VPN tunnel was mapped. 2331VPN tunnel was mapped.
2332 2332
diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1
index 89bc3d14b..3d243af89 100644
--- a/doc/man/gnunet-config.1
+++ b/doc/man/gnunet-config.1
@@ -45,7 +45,7 @@
45can be used to read or modify GNUnet configuration files. 45can be used to read or modify GNUnet configuration files.
46.Bl -tag -width indent 46.Bl -tag -width indent
47.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND 47.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
48Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, i.e. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error). 48Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, e.g. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error).
49.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 49.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
50Use the configuration file FILENAME. 50Use the configuration file FILENAME.
51.It Fl f | -filename 51.It Fl f | -filename
diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1
index 81347dcae..842ba62a0 100644
--- a/doc/man/gnunet-datastore.1
+++ b/doc/man/gnunet-datastore.1
@@ -41,7 +41,7 @@
41.Nm 41.Nm
42can be used to backup and restore or merge GNUnet datastores. 42can be used to backup and restore or merge GNUnet datastores.
43This is useful if a datastore is to be migrated between 43This is useful if a datastore is to be migrated between
44SQL databases, i.e. from sqlite to postgres or vice versa. 44SQL databases, e.g. from sqlite to postgres or vice versa.
45gnunet-datastore will dump the entire contents of the database 45gnunet-datastore will dump the entire contents of the database
46or insert a dump file into the database. 46or insert a dump file into the database.
47.Bl -tag -width indent 47.Bl -tag -width indent
diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1
index b9bbff027..73bbe5a5c 100644
--- a/doc/man/gnunet-namestore.1
+++ b/doc/man/gnunet-namestore.1
@@ -109,7 +109,7 @@ Create a record that is a shadow record.
109Shadow records are only used once all other records of the same type 109Shadow records are only used once all other records of the same type
110under the same label have expired. 110under the same label have expired.
111.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE 111.It Fl t Ar TYPE | Fl -type= Ns Ar TYPE
112Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). 112Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.).
113.It Fl u Ar URI | Fl -uri= Ns Ar URI 113.It Fl u Ar URI | Fl -uri= Ns Ar URI
114Add PKEY record from gnunet://gns/-URI to our zone; the record type is 114Add PKEY record from gnunet://gns/-URI to our zone; the record type is
115always PKEY, if no expiration is given FOREVER is used 115always PKEY, if no expiration is given FOREVER is used