summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlessio Vanni <vannilla@firemail.cc>2021-04-24 17:30:45 +0200
committerAlessio Vanni <vannilla@firemail.cc>2021-04-24 17:30:45 +0200
commitb996ba4156678b6a0a551b9a932867b2ade42344 (patch)
treeb03c302dddcccae0c0a3f76898617b83b1157528 /doc
parent8233e282046e27de57de75f175e131a974087618 (diff)
-Fix several incorrect uses of `i.e.'
With some other changes to sentences here and there as I found appropriate.
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.).
@item @file{transport/} --- transport service
The transport service is responsible for managing the
basic P2P communication. It uses plugins to support P2P communication
-over TCP, UDP, HTTP, HTTPS and other protocols.The transport service
+over TCP, UDP, HTTP, HTTPS and other protocols. The transport service
validates peer addresses, enforces bandwidth restrictions, limits the
-total number of connections and enforces connectivity restrictions (i.e.
+total number of connections and enforces connectivity restrictions (e.g.
friends-only).
@item @file{peerinfo-tool/} --- gnunet-peerinfo
This 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.
@itemize @bullet
@item services and daemons use their directory name in
-@code{GNUNET_log_setup} (i.e. 'core') and log using
+@code{GNUNET_log_setup} (e.g. 'core') and log using
plain 'GNUNET_log'.
@item command-line tools use their full name in
-@code{GNUNET_log_setup} (i.e. 'gnunet-publish') and log using
+@code{GNUNET_log_setup} (e.g. 'gnunet-publish') and log using
plain 'GNUNET_log'.
@item service access libraries log using
'@code{GNUNET_log_from}' and use '@code{DIRNAME-api}' for the
-component (i.e. 'core-api')
+component (e.g. 'core-api')
@item pure libraries (without associated service) use
'@code{GNUNET_log_from}' with the component set to their
library name (without lib or '@file{.so}'),
-which should also be their directory name (i.e. '@file{nat}')
+which should also be their directory name (e.g. '@file{nat}')
@item plugins should use '@code{GNUNET_log_from}'
with the directory name and the plugin name combined to produce
-the component name (i.e. 'transport-tcp').
+the component name (e.g. 'transport-tcp').
@item logging should be unified per-file by defining a
@code{LOG} macro with the appropriate arguments,
along these lines:
@@ -832,14 +832,14 @@ test
@subsubsection src/ directories
@itemize @bullet
-@item gnunet-NAME: end-user applications (i.e., gnunet-search, gnunet-arm)
-@item gnunet-service-NAME: service processes with accessor library (i.e.,
+@item gnunet-NAME: end-user applications (like gnunet-search or gnunet-arm)
+@item gnunet-service-NAME: service processes with accessor library (e.g.
gnunet-service-arm)
@item libgnunetNAME: accessor library (_service.h-header) or standalone
library (_lib.h-header)
-@item gnunet-daemon-NAME: daemon process without accessor library (i.e.,
+@item gnunet-daemon-NAME: daemon process without accessor library (e.g.
gnunet-daemon-hostlist) and no GNUnet management port
-@item libgnunet_plugin_DIR_NAME: loadable plugins (i.e.,
+@item libgnunet_plugin_DIR_NAME: loadable plugins (e.g.
libgnunet_plugin_transport_tcp)
@end itemize
@@ -6640,7 +6640,7 @@ The size of an element's data is limited to around 62 KB.
Sets created by a local client can be modified and reused for multiple
operations. As each set operation requires potentially expensive special
auxiliary data to be computed for each element of a set, a set can only
-participate in one type of set operation (i.e. union or intersection).
+participate in one type of set operation (either union or intersection).
The type of a set is determined upon its creation.
If a the elements of a set are needed for an operation of a different
type, 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
@code{QueryResponseMessage} which simply contains a bit that says if the
given public key is still valid, or if it has been revoked.
-The second possible interaction is for a client to revoke a key by
-passing a @code{RevokeMessage} to the service. The @code{RevokeMessage}
-contains the ECDSA public key to be revoked, a signature by the
-corresponding private key and the proof-of-work, The service responds
-with a @code{RevocationResponseMessage} which can be used to indicate
-that the @code{RevokeMessage} was invalid (i.e. proof of work incorrect),
-or otherwise indicates that the revocation has been processed
-successfully.
+The second possible interaction is for a client to revoke a key by passing a
+@code{RevokeMessage} to the service. The @code{RevokeMessage} contains the
+ECDSA public key to be revoked, a signature by the corresponding private key
+and the proof-of-work. The service responds with a
+@code{RevocationResponseMessage} which can be used to indicate that the
+@code{RevokeMessage} was invalid (e.g. the proof of work is incorrect), or
+otherwise to indicate that the revocation has been processed successfully.
@node The REVOCATION Peer-to-Peer Protocol
@subsection The REVOCATION Peer-to-Peer Protocol
@@ -9615,9 +9614,9 @@ In order to address the above issues, we want to:
TRANSPORT shall create bi-directional channels from this whenever
possible.
@item DV should no longer be a plugin, but part of TRANSPORT.
-@item TRANSPORT should provide communicators help communicating (i.e. in the
- case of uni-directional communicators or the need for out-of-band
- signalling for NAT traversal). We call this functionality
+@item TRANSPORT should provide communicators help communicating, for example
+ in the case of uni-directional communicators or the need for out-of-band
+ signalling for NAT traversal. We call this functionality
@emph{backchannels}.
@item Transport manipulation should be signalled to CORE on a per-message basis
instead of an approximate bandwidth.
@@ -9715,8 +9714,8 @@ by layer. For example, CADET will always strictly implement reliable and
in-order delivery of messages, while the same options are only advisory for
TRANSPORT and CORE: they should try (using ACKs on unreliable communicators,
not changing the message order themselves), but if messages are lost anyway
-(i.e. because a TCP is dropped in the middle), or if messages are reordered
-(i.e. because they took dierent paths over the network and arrived in a
+(e.g. because a TCP is dropped in the middle), or if messages are reordered
+(e.g. because they took different paths over the network and arrived in a
different order) TRANSPORT and CORE do not have to correct this. Whether a
preference is strict or loose is thus dened by the respective layer.
@@ -9728,8 +9727,8 @@ The API for communicators is defined in
Each communicator must specify its (global) communication characteristics, which
for now only say whether the communication is reliable (e.g. TCP, HTTPS) or
unreliable (e.g. UDP, WLAN). Each communicator must specify a unique address
-prex, or NULL if the communicator cannot establish outgoing connections (i.e.
-is only acting as a TCP server).
+prex, or NULL if the communicator cannot establish outgoing connections
+(for example because it is only acting as a TCP server).
A communicator must tell TRANSPORT which addresses it is reachable under.
Addresses may be added or removed at any time. A communicator may have zero
addresses (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
connected to. If no connection has been made since the start of the
computer, it is usually the first channel of the card.
Peers will only find each other and communicate if they are on the same
-channel. Channels must be set manually, i.e. using:
+channel. Channels must be set manually, e.g. by using:
@example
iwconfig wlan0 channel 1
@@ -1944,12 +1944,13 @@ Python installation and its dependencies.
Another way to install Ascension on Debian is to install the python3-ascension
package. It can be found within the above mentioned Ascension git repository.
-This also adds a system user ascension and runs a GNUnet peer in the
-background. Attention: This only works if a recent version of GNUnet is
+This also adds a system user called ascension and runs a GNUnet peer in the
+background. Please note: This only works if a recent version of GNUnet is
installed on your system. The version number of Ascension is chosen according
-to the required feature level of GNUnet. I.e. Ascension 0.11.5 is only
-compatible with GNUnet 0.11.5 and upwards. As Debian's packages for GNUnet are
-outdated even in experimental, you will need to install GNUnet manually
+to the required feature level of GNUnet: Ascension 0.11.5 is only
+compatible with GNUnet 0.11.5 or later and so on.
+As Debian's packages for GNUnet are outdated even in experimental,
+you will need to install GNUnet manually
@xref{Installing GNUnet}.
Please 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.
Being a DNS exit is usually pretty harmless. However, enabling IPv4 or
IPv6-exit without further precautions may enable adversaries to access
your local network, send spam, attack other systems from your Internet
-connection and to other mischief that will appear to come from your
+connection and do other mischiefs that will appear to come from your
machine. This may or may not get you into legal trouble.
If you want to allow IPv4 or IPv6-exit functionality, you should strongly
consider adding additional firewall rules manually to protect your local
-network and to restrict outgoing TCP traffic (i.e. by not allowing access
+network and to restrict outgoing TCP traffic (e.g. by not allowing access
to port 25). While we plan to improve exit-filtering in the future,
you're currently on your own here.
Essentially, 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
modifies the system configuration). As always, gnunet-setup should be run
after the GNUnet peer was stopped using "gnunet-arm -e". Distributors
might want to include a wrapper for gnunet-setup that allows the
-desktop-user to "sudo" (i.e. using gtksudo) to the "gnunet" user account
+desktop-user to "sudo" (e.g. using gtksudo) to the "gnunet" user account
and then runs "gnunet-arm -e", "gnunet-setup" and "gnunet-arm -s" in
sequence.
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
``.pin'' is a default zone which points to a zone managed by gnunet.org.
Use @code{gnunet-config -s gns} to view the GNS configuration, including
all configured zones that are operated by other users. The respective
-configuration entry names start with a ``.'', i.e. ``.pin''.
+configuration entry names start with a ``.'', e.g. ``.pin''.
You can configure any number of top-level domains, and point them to
the respective zones of your friends! For this, simply obtain the
@@ -1620,7 +1620,7 @@ under "*.friend.gnu".
BOX records are there to integrate information from TLSA or
SRV records under the main label. In DNS, TLSA and SRV records
use special names of the form @code{_port._proto.(label.)*tld} to
-indicate the port number and protocol (i.e. tcp or udp) for which
+indicate the port number and protocol (like TCP or UDP) for which
the TLSA or SRV record is valid. This causes various problems, and
is elegantly solved in GNS by integrating the protocol and port
numbers 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
(due to issues such as censorship or availability).
Note that you would typically want to use a relative name for the
-nameserver, i.e.
+nameserver, like so:
@example
Name: pet; RRType: GNS2DNS; Value: gnunet.org@@ns-joker.+@
@@ -2244,7 +2244,7 @@ that subnet to the GNUnet exit's TUN interface.
When running a local service, you should make sure that the local
service is (also) bound to the IP address of your EXIT interface
-(i.e. 169.254.86.1). It will NOT work if your local service is
+(e.g. 169.254.86.1). It will NOT work if your local service is
just bound to loopback. You may also want to create a "VPN" record
in your zone of the GNU Name System to make it easy for others to
access 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
over the GNUnet VPN.
The GNUnet VPN uses DNS-ALG to hijack your IP traffic. Whenever an
-application resolves a hostname (i.e. 'gnunet.org'), the
+application resolves a hostname (like 'gnunet.org'), the
"gnunet-daemon-pt" will instruct the "gnunet-service-dns" to intercept
the request (possibly route it over GNUnet as well) and replace the
normal answer with an IP in the range of the VPN's interface.
@@ -2325,8 +2325,8 @@ destination.
For applications that do not use DNS, you can also manually create
such a mapping using the gnunet-vpn command-line tool. Here, you
-specify the desired address family of the result (i.e. "-4"), and the
-intended target IP on the Internet ("-i 131.159.74.67") and
+specify the desired address family of the result (e.g. "-4"), and the
+intended target IP on the Internet (e.g. "-i 131.159.74.67") and
"gnunet-vpn" will tell you which IP address in the range of your
VPN tunnel was mapped.
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 @@
can be used to read or modify GNUnet configuration files.
.Bl -tag -width indent
.It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND
-Tests 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).
+Tests 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).
.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
Use the configuration file FILENAME.
.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 @@
.Nm
can be used to backup and restore or merge GNUnet datastores.
This is useful if a datastore is to be migrated between
-SQL databases, i.e. from sqlite to postgres or vice versa.
+SQL databases, e.g. from sqlite to postgres or vice versa.
gnunet-datastore will dump the entire contents of the database
or insert a dump file into the database.
.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.
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
-Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.).
+Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.).
.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