summaryrefslogtreecommitdiff
path: root/doc/chapters
diff options
context:
space:
mode:
authorng0 <ng0@infotropique.org>2017-08-17 12:31:40 +0000
committerng0 <ng0@infotropique.org>2017-08-17 12:31:40 +0000
commit0aecb9fb029fc58bce4e124b26b6bb2d8ee007c9 (patch)
treebaac69f14cebdd2b2c5ac09e442dc30bb84fe039 /doc/chapters
parent2f511cee1b712d8382ab11bc1968a79db94a8aa9 (diff)
guix-env.scm: add texinfo.
doc: fixes. Signed-off-by: ng0 <ng0@infotropique.org>
Diffstat (limited to 'doc/chapters')
-rw-r--r--doc/chapters/developer.texi48
-rw-r--r--doc/chapters/installation.texi33
-rw-r--r--doc/chapters/user.texi28
3 files changed, 54 insertions, 55 deletions
diff --git a/doc/chapters/developer.texi b/doc/chapters/developer.texi
index ce6b16087..8b7954836 100644
--- a/doc/chapters/developer.texi
+++ b/doc/chapters/developer.texi
@@ -2049,14 +2049,14 @@ any other peer connecting to the service.)
@menu
* Define new message types::
* Define message struct::
-* Client: Establish connection::
-* Client: Initialize request message::
-* Client: Send request and receive response::
-* Server: Startup service::
-* Server: Add new handles for specified messages::
-* Server: Process request message::
-* Server: Response to client::
-* Server: Notification of clients::
+* Client - Establish connection::
+* Client - Initialize request message::
+* Client - Send request and receive response::
+* Server - Startup service::
+* Server - Add new handles for specified messages::
+* Server - Process request message::
+* Server - Response to client::
+* Server - Notification of clients::
* Conversion between Network Byte Order (Big Endian) and Host Byte Order::
@end menu
@@ -2097,8 +2097,8 @@ both ensure correct alignment when sending structs over the network
@end menu
@c ***************************************************************************
-@node Client: Establish connection
-@subsubsection Client: Establish connection
+@node Client - Establish connection
+@subsubsection Client - Establish connection
@c %**end of header
@@ -2111,8 +2111,8 @@ GNUNET_CLIENT_connect ("transport", cfg);
@end example
@c ***************************************************************************
-@node Client: Initialize request message
-@subsubsection Client: Initialize request message
+@node Client - Initialize request message
+@subsubsection Client - Initialize request message
@c %**end of header
When the connection is ready, we initialize the message. In this step, all the
@@ -2136,8 +2136,8 @@ conversion function please refer to Introduction of Big Endian and Little
Endian.
@c ***************************************************************************
-@node Client: Send request and receive response
-@subsubsection Client: Send request and receive response
+@node Client - Send request and receive response
+@subsubsection Client - Send request and receive response
@c %**end of header
FIXME: This is very outdated, see the tutorial for the
@@ -2158,8 +2158,8 @@ the argument @code{address_response_processor} is a function with
@code{GNUNET_CLIENT_MessageHandler} type, which is used to process the reply
message from the service.
-@node Server: Startup service
-@subsubsection Server: Startup service
+@node Server - Startup service
+@subsubsection Server - Startup service
After receiving the request message, we run a standard GNUnet service startup
sequence using @code{GNUNET_SERVICE_run}, as follows,
@@ -2170,8 +2170,8 @@ GNUNET_SERVICE_OPTION_NONE, &run, NULL)); @}
@end example
@c ***************************************************************************
-@node Server: Add new handles for specified messages
-@subsubsection Server: Add new handles for specified messages
+@node Server - Add new handles for specified messages
+@subsubsection Server - Add new handles for specified messages
@c %**end of header
in the function above the argument @code{run} is used to initiate transport
@@ -2208,8 +2208,8 @@ can be set. In addition, the terminator sign depicted as @code{@{NULL, NULL, 0,
0@}} is set in the last aera.
@c ***************************************************************************
-@node Server: Process request message
-@subsubsection Server: Process request message
+@node Server - Process request message
+@subsubsection Server - Process request message
@c %**end of header
After the initialization of transport service, the request message would be
@@ -2249,8 +2249,8 @@ In comparison to the aforementioned situation, when the argument is equal to
@code{GNUNET_OK}, the service would continue to process the requst message.
@c ***************************************************************************
-@node Server: Response to client
-@subsubsection Server: Response to client
+@node Server - Response to client
+@subsubsection Server - Response to client
@c %**end of header
Once the processing of current request is done, the server should give the
@@ -2279,8 +2279,8 @@ Note that, there are also a number of other APIs provided to the service to
send the message.
@c ***************************************************************************
-@node Server: Notification of clients
-@subsubsection Server: Notification of clients
+@node Server - Notification of clients
+@subsubsection Server - Notification of clients
@c %**end of header
Often a service needs to (repeatedly) transmit notifications to a client or a
diff --git a/doc/chapters/installation.texi b/doc/chapters/installation.texi
index ea949cdc0..69c50b5b6 100644
--- a/doc/chapters/installation.texi
+++ b/doc/chapters/installation.texi
@@ -21,7 +21,7 @@ in the form of new chapters or insightful comments.
* Build instructions for Debian 8::
* Outdated build instructions for previous revisions::
* Portable GNUnet::
-* The grapical configuration interface::
+* The graphical configuration interface::
* How to start and stop a GNUnet peer::
@end menu
@@ -1275,7 +1275,6 @@ instructions and should not be expected to work for GNUnet 0.10.x.
* Basic Installation for Fedora/PlanetLab nodes running Fedora 8 .::
* Build instructions for Gentoo::
* Building GLPK for MinGW::
-* Compiling libgnurl for GNUnet cannot find data type for curl_off_t.::
* GUI build instructions for Ubuntu 12.04 using Subversion::
* Installation with gnunet-update::
* Instructions for Microsoft Windows Platforms (Old)::
@@ -4118,16 +4117,16 @@ helpers must be tightly controlled.
@end table
@menu
-* Recommendation: Disable access to services via TCP::
-* Recommendation: Run most services as system user "gnunet"::
-* Recommendation: Control access to services using group "gnunet"::
-* Recommendation: Limit access to certain SUID binaries by group "gnunet"::
-* Recommendation: Limit access to critical gnunet-helper-dns to group "gnunetdns"::
+* Recommendation - Disable access to services via TCP::
+* Recommendation - Run most services as system user "gnunet"::
+* Recommendation - Control access to services using group "gnunet"::
+* Recommendation - Limit access to certain SUID binaries by group "gnunet"::
+* Recommendation - Limit access to critical gnunet-helper-dns to group "gnunetdns"::
* Differences between "make install" and these recommendations::
@end menu
-@node Recommendation: Disable access to services via TCP
-@subsubsection Recommendation: Disable access to services via TCP
+@node Recommendation - Disable access to services via TCP
+@subsubsection Recommendation - Disable access to services via TCP
GNUnet services allow two types of access: via TCP socket or via UNIX domain
socket. If the service is available via TCP, access control can only be
@@ -4143,8 +4142,8 @@ simply by specifying a non-zero port number in the section of the respective
service.
-@node Recommendation: Run most services as system user "gnunet"
-@subsubsection Recommendation: Run most services as system user "gnunet"
+@node Recommendation - Run most services as system user "gnunet"
+@subsubsection Recommendation - Run most services as system user "gnunet"
GNUnet's main services should be run as a separate user "gnunet" in a special
group "gnunet". The user "gnunet" should start the peer using "gnunet-arm -s"
@@ -4153,8 +4152,8 @@ during system startup. The home directory for this user should be
the "gnunet" user should have the right to access "/var/lib/gnunet" (mode:
700).
-@node Recommendation: Control access to services using group "gnunet"
-@subsubsection Recommendation: Control access to services using group "gnunet"
+@node Recommendation - Control access to services using group "gnunet"
+@subsubsection Recommendation - Control access to services using group "gnunet"
Users that should be allowed to use the GNUnet peer should be added to the
group "gnunet". Using GNUnet's access control mechanism for UNIX domain
@@ -4166,16 +4165,16 @@ causing security concerns. Some services, such as DNS, must NOT be made
accessible to the "gnunet" group (and should thus only be accessible to the
"gnunet" user and services running with this UID).
-@node Recommendation: Limit access to certain SUID binaries by group "gnunet"
-@subsubsection Recommendation: Limit access to certain SUID binaries by group "gnunet"
+@node Recommendation - Limit access to certain SUID binaries by group "gnunet"
+@subsubsection Recommendation - Limit access to certain SUID binaries by group "gnunet"
Most of GNUnet's SUID binaries should be safe even if executed by normal users.
However, it is possible to reduce the risk a little bit more by making these
binaries owned by the group "gnunet" and restricting their execution to user of
the group "gnunet" as well (4750).
-@node Recommendation: Limit access to critical gnunet-helper-dns to group "gnunetdns"
-@subsubsection Recommendation: Limit access to critical gnunet-helper-dns to group "gnunetdns"
+@node Recommendation - Limit access to critical gnunet-helper-dns to group "gnunetdns"
+@subsubsection Recommendation - Limit access to critical gnunet-helper-dns to group "gnunetdns"
A special group "gnunetdns" should be created for controlling access to the
"gnunet-helper-dns". The binary should then be owned by root and be in group
diff --git a/doc/chapters/user.texi b/doc/chapters/user.texi
index f9d0f8a66..b700eb6a1 100644
--- a/doc/chapters/user.texi
+++ b/doc/chapters/user.texi
@@ -15,10 +15,10 @@ applications that are being created. Comments and extensions are always welcome.
@menu
* Checking the Installation::
-* First steps: File-sharing::
-* First steps: Using the GNU Name System::
-* First steps: Using GNUnet Conversation::
-* First steps: Using the GNUnet VPN::
+* First steps - File-sharing::
+* First steps - Using the GNU Name System::
+* First steps - Using GNUnet Conversation::
+* First steps - Using the GNUnet VPN::
* File-sharing::
* The GNU Name System::
* Using the Virtual Public Network::
@@ -206,15 +206,15 @@ respective download and selecting "Abort download" from the menu.
That's it, you now know the basics for file-sharing with GNUnet!
-@node First steps: Using the GNU Name System
-@section First steps: Using the GNU Name System
+@node First steps - Using the GNU Name System
+@section First steps - Using the GNU Name System
@c %**end of header
@menu
* Preliminaries::
-* Managing egos::
+* Managing Egos::
* The GNS Tab::
* Creating a Record::
* Creating a Business Card::
@@ -529,8 +529,8 @@ to use GNS to have a private conversation with your friend. Finally, help us
with the next GNUnet release for even more applications using this new
public key infrastructure.
-@node First steps: Using GNUnet Conversation
-@section First steps: Using GNUnet Conversation
+@node First steps - Using GNUnet Conversation
+@section First steps - Using GNUnet Conversation
@c %**end of header
Before starting the tutorial, you should be aware that
@@ -645,21 +645,21 @@ Note that we do not envision people to use gnunet-conversation like this
forever. We will write a graphical user interface, and that GUI will
automatically create the necessary records in the respective zone.
-@node First steps: Using the GNUnet VPN
-@section First steps: Using the GNUnet VPN
+@node First steps - Using the GNUnet VPN
+@section First steps - Using the GNUnet VPN
@c %**end of header
@menu
-* Preliminaries2::
+* VPN Preliminaries::
* Exit configuration::
* GNS configuration::
* Accessing the service::
* Using a Browser::
@end menu
-@node Preliminaries2
-@subsection Preliminaries2
+@node VPN Preliminaries
+@subsection VPN Preliminaries
@c %**end of header
To test the GNUnet VPN, we should first run a web server. The easiest way to do