[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [gnunet] 05/07: guix-env.scm: add texinfo. doc: fixes.
From: |
gnunet |
Subject: |
[GNUnet-SVN] [gnunet] 05/07: guix-env.scm: add texinfo. doc: fixes. |
Date: |
Thu, 17 Aug 2017 15:20:08 +0200 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a commit to branch master
in repository gnunet.
commit 0aecb9fb029fc58bce4e124b26b6bb2d8ee007c9
Author: ng0 <address@hidden>
AuthorDate: Thu Aug 17 12:31:40 2017 +0000
guix-env.scm: add texinfo.
doc: fixes.
Signed-off-by: ng0 <address@hidden>
---
doc/chapters/developer.texi | 48 +++++++++++++++++++++---------------------
doc/chapters/installation.texi | 33 ++++++++++++++---------------
doc/chapters/user.texi | 28 ++++++++++++------------
guix-env.scm | 2 ++
4 files changed, 56 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 ***************************************************************************
address@hidden Client: Establish connection
address@hidden Client: Establish connection
address@hidden Client - Establish connection
address@hidden Client - Establish connection
@c %**end of header
@@ -2111,8 +2111,8 @@ GNUNET_CLIENT_connect ("transport", cfg);
@end example
@c ***************************************************************************
address@hidden Client: Initialize request message
address@hidden Client: Initialize request message
address@hidden Client - Initialize request message
address@hidden 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 ***************************************************************************
address@hidden Client: Send request and receive response
address@hidden Client: Send request and receive response
address@hidden Client - Send request and receive response
address@hidden 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.
address@hidden Server: Startup service
address@hidden Server: Startup service
address@hidden Server - Startup service
address@hidden 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 ***************************************************************************
address@hidden Server: Add new handles for specified messages
address@hidden Server: Add new handles for specified messages
address@hidden Server - Add new handles for specified messages
address@hidden 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
@address@hidden, NULL, 0,
address@hidden is set in the last aera.
@c ***************************************************************************
address@hidden Server: Process request message
address@hidden Server: Process request message
address@hidden Server - Process request message
address@hidden 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 ***************************************************************************
address@hidden Server: Response to client
address@hidden Server: Response to client
address@hidden Server - Response to client
address@hidden 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 ***************************************************************************
address@hidden Server: Notification of clients
address@hidden Server: Notification of clients
address@hidden Server - Notification of clients
address@hidden 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
address@hidden Recommendation: Disable access to services via TCP
address@hidden Recommendation: Disable access to services via TCP
address@hidden Recommendation - Disable access to services via TCP
address@hidden 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.
address@hidden Recommendation: Run most services as system user "gnunet"
address@hidden Recommendation: Run most services as system user "gnunet"
address@hidden Recommendation - Run most services as system user "gnunet"
address@hidden 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).
address@hidden Recommendation: Control access to services using group "gnunet"
address@hidden Recommendation: Control access to services using group "gnunet"
address@hidden Recommendation - Control access to services using group "gnunet"
address@hidden 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).
address@hidden Recommendation: Limit access to certain SUID binaries by group
"gnunet"
address@hidden Recommendation: Limit access to certain SUID binaries by group
"gnunet"
address@hidden Recommendation - Limit access to certain SUID binaries by group
"gnunet"
address@hidden 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).
address@hidden Recommendation: Limit access to critical gnunet-helper-dns to
group "gnunetdns"
address@hidden Recommendation: Limit access to critical gnunet-helper-dns to
group "gnunetdns"
address@hidden Recommendation - Limit access to critical gnunet-helper-dns to
group "gnunetdns"
address@hidden 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!
address@hidden First steps: Using the GNU Name System
address@hidden First steps: Using the GNU Name System
address@hidden First steps - Using the GNU Name System
address@hidden 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.
address@hidden First steps: Using GNUnet Conversation
address@hidden First steps: Using GNUnet Conversation
address@hidden First steps - Using GNUnet Conversation
address@hidden 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.
address@hidden First steps: Using the GNUnet VPN
address@hidden First steps: Using the GNUnet VPN
address@hidden First steps - Using the GNUnet VPN
address@hidden 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
address@hidden Preliminaries2
address@hidden Preliminaries2
address@hidden VPN Preliminaries
address@hidden VPN Preliminaries
@c %**end of header
To test the GNUnet VPN, we should first run a web server. The easiest way to do
diff --git a/guix-env.scm b/guix-env.scm
index 9d4430097..54731858e 100644
--- a/guix-env.scm
+++ b/guix-env.scm
@@ -81,6 +81,7 @@
(gnu packages pulseaudio)
(gnu packages python)
(gnu packages tex)
+ (gnu packages texinfo)
(gnu packages tls)
(gnu packages video)
(gnu packages web)
@@ -133,6 +134,7 @@
("autoconf" ,autoconf)
("automake" ,automake)
("gnu-gettext" ,gnu-gettext)
+ ("texinfo" ,texinfo)
("libtool" ,libtool)))
;; TODO: To make use of out:debug, which carries the symbols,
;; this file needs to fixed.
--
To stop receiving notification emails like this one, please contact
address@hidden
- [GNUnet-SVN] [gnunet] branch master updated (6bcc73a1c -> 5561372be), gnunet, 2017/08/17
- [GNUnet-SVN] [gnunet] 02/07: guix-env.scm: Small adjustments., gnunet, 2017/08/17
- [GNUnet-SVN] [gnunet] 06/07: doc: further fixes., gnunet, 2017/08/17
- [GNUnet-SVN] [gnunet] 07/07: +, gnunet, 2017/08/17
- [GNUnet-SVN] [gnunet] 03/07: doc: Makefile.am: += -> =, gnunet, 2017/08/17
- [GNUnet-SVN] [gnunet] 04/07: doc: Makefile: exclude gnunet-c-tutorial.tex from build., gnunet, 2017/08/17
- [GNUnet-SVN] [gnunet] 05/07: guix-env.scm: add texinfo. doc: fixes.,
gnunet <=
- [GNUnet-SVN] [gnunet] 01/07: doc: Merge 'gnunet-texinfo' repository into 'doc' folder of gnunet., gnunet, 2017/08/17