diff options
author | ng0 <ng0@infotropique.org> | 2017-08-17 12:31:40 +0000 |
---|---|---|
committer | ng0 <ng0@infotropique.org> | 2017-08-17 12:31:40 +0000 |
commit | 0aecb9fb029fc58bce4e124b26b6bb2d8ee007c9 (patch) | |
tree | baac69f14cebdd2b2c5ac09e442dc30bb84fe039 /doc | |
parent | 2f511cee1b712d8382ab11bc1968a79db94a8aa9 (diff) | |
download | gnunet-0aecb9fb029fc58bce4e124b26b6bb2d8ee007c9.tar.gz gnunet-0aecb9fb029fc58bce4e124b26b6bb2d8ee007c9.zip |
guix-env.scm: add texinfo.
doc: fixes.
Signed-off-by: ng0 <ng0@infotropique.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/chapters/developer.texi | 48 | ||||
-rw-r--r-- | doc/chapters/installation.texi | 33 | ||||
-rw-r--r-- | doc/chapters/user.texi | 28 |
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.) | |||
2049 | @menu | 2049 | @menu |
2050 | * Define new message types:: | 2050 | * Define new message types:: |
2051 | * Define message struct:: | 2051 | * Define message struct:: |
2052 | * Client: Establish connection:: | 2052 | * Client - Establish connection:: |
2053 | * Client: Initialize request message:: | 2053 | * Client - Initialize request message:: |
2054 | * Client: Send request and receive response:: | 2054 | * Client - Send request and receive response:: |
2055 | * Server: Startup service:: | 2055 | * Server - Startup service:: |
2056 | * Server: Add new handles for specified messages:: | 2056 | * Server - Add new handles for specified messages:: |
2057 | * Server: Process request message:: | 2057 | * Server - Process request message:: |
2058 | * Server: Response to client:: | 2058 | * Server - Response to client:: |
2059 | * Server: Notification of clients:: | 2059 | * Server - Notification of clients:: |
2060 | * Conversion between Network Byte Order (Big Endian) and Host Byte Order:: | 2060 | * Conversion between Network Byte Order (Big Endian) and Host Byte Order:: |
2061 | @end menu | 2061 | @end menu |
2062 | 2062 | ||
@@ -2097,8 +2097,8 @@ both ensure correct alignment when sending structs over the network | |||
2097 | @end menu | 2097 | @end menu |
2098 | 2098 | ||
2099 | @c *************************************************************************** | 2099 | @c *************************************************************************** |
2100 | @node Client: Establish connection | 2100 | @node Client - Establish connection |
2101 | @subsubsection Client: Establish connection | 2101 | @subsubsection Client - Establish connection |
2102 | @c %**end of header | 2102 | @c %**end of header |
2103 | 2103 | ||
2104 | 2104 | ||
@@ -2111,8 +2111,8 @@ GNUNET_CLIENT_connect ("transport", cfg); | |||
2111 | @end example | 2111 | @end example |
2112 | 2112 | ||
2113 | @c *************************************************************************** | 2113 | @c *************************************************************************** |
2114 | @node Client: Initialize request message | 2114 | @node Client - Initialize request message |
2115 | @subsubsection Client: Initialize request message | 2115 | @subsubsection Client - Initialize request message |
2116 | @c %**end of header | 2116 | @c %**end of header |
2117 | 2117 | ||
2118 | When the connection is ready, we initialize the message. In this step, all the | 2118 | 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 | |||
2136 | Endian. | 2136 | Endian. |
2137 | 2137 | ||
2138 | @c *************************************************************************** | 2138 | @c *************************************************************************** |
2139 | @node Client: Send request and receive response | 2139 | @node Client - Send request and receive response |
2140 | @subsubsection Client: Send request and receive response | 2140 | @subsubsection Client - Send request and receive response |
2141 | @c %**end of header | 2141 | @c %**end of header |
2142 | 2142 | ||
2143 | FIXME: This is very outdated, see the tutorial for the | 2143 | FIXME: This is very outdated, see the tutorial for the |
@@ -2158,8 +2158,8 @@ the argument @code{address_response_processor} is a function with | |||
2158 | @code{GNUNET_CLIENT_MessageHandler} type, which is used to process the reply | 2158 | @code{GNUNET_CLIENT_MessageHandler} type, which is used to process the reply |
2159 | message from the service. | 2159 | message from the service. |
2160 | 2160 | ||
2161 | @node Server: Startup service | 2161 | @node Server - Startup service |
2162 | @subsubsection Server: Startup service | 2162 | @subsubsection Server - Startup service |
2163 | 2163 | ||
2164 | After receiving the request message, we run a standard GNUnet service startup | 2164 | After receiving the request message, we run a standard GNUnet service startup |
2165 | sequence using @code{GNUNET_SERVICE_run}, as follows, | 2165 | sequence using @code{GNUNET_SERVICE_run}, as follows, |
@@ -2170,8 +2170,8 @@ GNUNET_SERVICE_OPTION_NONE, &run, NULL)); @} | |||
2170 | @end example | 2170 | @end example |
2171 | 2171 | ||
2172 | @c *************************************************************************** | 2172 | @c *************************************************************************** |
2173 | @node Server: Add new handles for specified messages | 2173 | @node Server - Add new handles for specified messages |
2174 | @subsubsection Server: Add new handles for specified messages | 2174 | @subsubsection Server - Add new handles for specified messages |
2175 | @c %**end of header | 2175 | @c %**end of header |
2176 | 2176 | ||
2177 | in the function above the argument @code{run} is used to initiate transport | 2177 | 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, | |||
2208 | 0@}} is set in the last aera. | 2208 | 0@}} is set in the last aera. |
2209 | 2209 | ||
2210 | @c *************************************************************************** | 2210 | @c *************************************************************************** |
2211 | @node Server: Process request message | 2211 | @node Server - Process request message |
2212 | @subsubsection Server: Process request message | 2212 | @subsubsection Server - Process request message |
2213 | @c %**end of header | 2213 | @c %**end of header |
2214 | 2214 | ||
2215 | After the initialization of transport service, the request message would be | 2215 | 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 | |||
2249 | @code{GNUNET_OK}, the service would continue to process the requst message. | 2249 | @code{GNUNET_OK}, the service would continue to process the requst message. |
2250 | 2250 | ||
2251 | @c *************************************************************************** | 2251 | @c *************************************************************************** |
2252 | @node Server: Response to client | 2252 | @node Server - Response to client |
2253 | @subsubsection Server: Response to client | 2253 | @subsubsection Server - Response to client |
2254 | @c %**end of header | 2254 | @c %**end of header |
2255 | 2255 | ||
2256 | Once the processing of current request is done, the server should give the | 2256 | 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 | |||
2279 | send the message. | 2279 | send the message. |
2280 | 2280 | ||
2281 | @c *************************************************************************** | 2281 | @c *************************************************************************** |
2282 | @node Server: Notification of clients | 2282 | @node Server - Notification of clients |
2283 | @subsubsection Server: Notification of clients | 2283 | @subsubsection Server - Notification of clients |
2284 | @c %**end of header | 2284 | @c %**end of header |
2285 | 2285 | ||
2286 | Often a service needs to (repeatedly) transmit notifications to a client or a | 2286 | 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. | |||
21 | * Build instructions for Debian 8:: | 21 | * Build instructions for Debian 8:: |
22 | * Outdated build instructions for previous revisions:: | 22 | * Outdated build instructions for previous revisions:: |
23 | * Portable GNUnet:: | 23 | * Portable GNUnet:: |
24 | * The grapical configuration interface:: | 24 | * The graphical configuration interface:: |
25 | * How to start and stop a GNUnet peer:: | 25 | * How to start and stop a GNUnet peer:: |
26 | @end menu | 26 | @end menu |
27 | 27 | ||
@@ -1275,7 +1275,6 @@ instructions and should not be expected to work for GNUnet 0.10.x. | |||
1275 | * Basic Installation for Fedora/PlanetLab nodes running Fedora 8 .:: | 1275 | * Basic Installation for Fedora/PlanetLab nodes running Fedora 8 .:: |
1276 | * Build instructions for Gentoo:: | 1276 | * Build instructions for Gentoo:: |
1277 | * Building GLPK for MinGW:: | 1277 | * Building GLPK for MinGW:: |
1278 | * Compiling libgnurl for GNUnet cannot find data type for curl_off_t.:: | ||
1279 | * GUI build instructions for Ubuntu 12.04 using Subversion:: | 1278 | * GUI build instructions for Ubuntu 12.04 using Subversion:: |
1280 | * Installation with gnunet-update:: | 1279 | * Installation with gnunet-update:: |
1281 | * Instructions for Microsoft Windows Platforms (Old):: | 1280 | * Instructions for Microsoft Windows Platforms (Old):: |
@@ -4118,16 +4117,16 @@ helpers must be tightly controlled. | |||
4118 | @end table | 4117 | @end table |
4119 | 4118 | ||
4120 | @menu | 4119 | @menu |
4121 | * Recommendation: Disable access to services via TCP:: | 4120 | * Recommendation - Disable access to services via TCP:: |
4122 | * Recommendation: Run most services as system user "gnunet":: | 4121 | * Recommendation - Run most services as system user "gnunet":: |
4123 | * Recommendation: Control access to services using group "gnunet":: | 4122 | * Recommendation - Control access to services using group "gnunet":: |
4124 | * Recommendation: Limit access to certain SUID binaries by group "gnunet":: | 4123 | * Recommendation - Limit access to certain SUID binaries by group "gnunet":: |
4125 | * Recommendation: Limit access to critical gnunet-helper-dns to group "gnunetdns":: | 4124 | * Recommendation - Limit access to critical gnunet-helper-dns to group "gnunetdns":: |
4126 | * Differences between "make install" and these recommendations:: | 4125 | * Differences between "make install" and these recommendations:: |
4127 | @end menu | 4126 | @end menu |
4128 | 4127 | ||
4129 | @node Recommendation: Disable access to services via TCP | 4128 | @node Recommendation - Disable access to services via TCP |
4130 | @subsubsection Recommendation: Disable access to services via TCP | 4129 | @subsubsection Recommendation - Disable access to services via TCP |
4131 | 4130 | ||
4132 | GNUnet services allow two types of access: via TCP socket or via UNIX domain | 4131 | GNUnet services allow two types of access: via TCP socket or via UNIX domain |
4133 | socket. If the service is available via TCP, access control can only be | 4132 | 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 | |||
4143 | service. | 4142 | service. |
4144 | 4143 | ||
4145 | 4144 | ||
4146 | @node Recommendation: Run most services as system user "gnunet" | 4145 | @node Recommendation - Run most services as system user "gnunet" |
4147 | @subsubsection Recommendation: Run most services as system user "gnunet" | 4146 | @subsubsection Recommendation - Run most services as system user "gnunet" |
4148 | 4147 | ||
4149 | GNUnet's main services should be run as a separate user "gnunet" in a special | 4148 | GNUnet's main services should be run as a separate user "gnunet" in a special |
4150 | group "gnunet". The user "gnunet" should start the peer using "gnunet-arm -s" | 4149 | 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 | |||
4153 | the "gnunet" user should have the right to access "/var/lib/gnunet" (mode: | 4152 | the "gnunet" user should have the right to access "/var/lib/gnunet" (mode: |
4154 | 700). | 4153 | 700). |
4155 | 4154 | ||
4156 | @node Recommendation: Control access to services using group "gnunet" | 4155 | @node Recommendation - Control access to services using group "gnunet" |
4157 | @subsubsection Recommendation: Control access to services using group "gnunet" | 4156 | @subsubsection Recommendation - Control access to services using group "gnunet" |
4158 | 4157 | ||
4159 | Users that should be allowed to use the GNUnet peer should be added to the | 4158 | Users that should be allowed to use the GNUnet peer should be added to the |
4160 | group "gnunet". Using GNUnet's access control mechanism for UNIX domain | 4159 | 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 | |||
4166 | accessible to the "gnunet" group (and should thus only be accessible to the | 4165 | accessible to the "gnunet" group (and should thus only be accessible to the |
4167 | "gnunet" user and services running with this UID). | 4166 | "gnunet" user and services running with this UID). |
4168 | 4167 | ||
4169 | @node Recommendation: Limit access to certain SUID binaries by group "gnunet" | 4168 | @node Recommendation - Limit access to certain SUID binaries by group "gnunet" |
4170 | @subsubsection Recommendation: Limit access to certain SUID binaries by group "gnunet" | 4169 | @subsubsection Recommendation - Limit access to certain SUID binaries by group "gnunet" |
4171 | 4170 | ||
4172 | Most of GNUnet's SUID binaries should be safe even if executed by normal users. | 4171 | Most of GNUnet's SUID binaries should be safe even if executed by normal users. |
4173 | However, it is possible to reduce the risk a little bit more by making these | 4172 | However, it is possible to reduce the risk a little bit more by making these |
4174 | binaries owned by the group "gnunet" and restricting their execution to user of | 4173 | binaries owned by the group "gnunet" and restricting their execution to user of |
4175 | the group "gnunet" as well (4750). | 4174 | the group "gnunet" as well (4750). |
4176 | 4175 | ||
4177 | @node Recommendation: Limit access to critical gnunet-helper-dns to group "gnunetdns" | 4176 | @node Recommendation - Limit access to critical gnunet-helper-dns to group "gnunetdns" |
4178 | @subsubsection Recommendation: Limit access to critical gnunet-helper-dns to group "gnunetdns" | 4177 | @subsubsection Recommendation - Limit access to critical gnunet-helper-dns to group "gnunetdns" |
4179 | 4178 | ||
4180 | A special group "gnunetdns" should be created for controlling access to the | 4179 | A special group "gnunetdns" should be created for controlling access to the |
4181 | "gnunet-helper-dns". The binary should then be owned by root and be in group | 4180 | "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. | |||
15 | 15 | ||
16 | @menu | 16 | @menu |
17 | * Checking the Installation:: | 17 | * Checking the Installation:: |
18 | * First steps: File-sharing:: | 18 | * First steps - File-sharing:: |
19 | * First steps: Using the GNU Name System:: | 19 | * First steps - Using the GNU Name System:: |
20 | * First steps: Using GNUnet Conversation:: | 20 | * First steps - Using GNUnet Conversation:: |
21 | * First steps: Using the GNUnet VPN:: | 21 | * First steps - Using the GNUnet VPN:: |
22 | * File-sharing:: | 22 | * File-sharing:: |
23 | * The GNU Name System:: | 23 | * The GNU Name System:: |
24 | * Using the Virtual Public Network:: | 24 | * Using the Virtual Public Network:: |
@@ -206,15 +206,15 @@ respective download and selecting "Abort download" from the menu. | |||
206 | 206 | ||
207 | That's it, you now know the basics for file-sharing with GNUnet! | 207 | That's it, you now know the basics for file-sharing with GNUnet! |
208 | 208 | ||
209 | @node First steps: Using the GNU Name System | 209 | @node First steps - Using the GNU Name System |
210 | @section First steps: Using the GNU Name System | 210 | @section First steps - Using the GNU Name System |
211 | @c %**end of header | 211 | @c %**end of header |
212 | 212 | ||
213 | 213 | ||
214 | 214 | ||
215 | @menu | 215 | @menu |
216 | * Preliminaries:: | 216 | * Preliminaries:: |
217 | * Managing egos:: | 217 | * Managing Egos:: |
218 | * The GNS Tab:: | 218 | * The GNS Tab:: |
219 | * Creating a Record:: | 219 | * Creating a Record:: |
220 | * Creating a Business Card:: | 220 | * Creating a Business Card:: |
@@ -529,8 +529,8 @@ to use GNS to have a private conversation with your friend. Finally, help us | |||
529 | with the next GNUnet release for even more applications using this new | 529 | with the next GNUnet release for even more applications using this new |
530 | public key infrastructure. | 530 | public key infrastructure. |
531 | 531 | ||
532 | @node First steps: Using GNUnet Conversation | 532 | @node First steps - Using GNUnet Conversation |
533 | @section First steps: Using GNUnet Conversation | 533 | @section First steps - Using GNUnet Conversation |
534 | @c %**end of header | 534 | @c %**end of header |
535 | 535 | ||
536 | Before starting the tutorial, you should be aware that | 536 | 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 | |||
645 | forever. We will write a graphical user interface, and that GUI will | 645 | forever. We will write a graphical user interface, and that GUI will |
646 | automatically create the necessary records in the respective zone. | 646 | automatically create the necessary records in the respective zone. |
647 | 647 | ||
648 | @node First steps: Using the GNUnet VPN | 648 | @node First steps - Using the GNUnet VPN |
649 | @section First steps: Using the GNUnet VPN | 649 | @section First steps - Using the GNUnet VPN |
650 | @c %**end of header | 650 | @c %**end of header |
651 | 651 | ||
652 | 652 | ||
653 | @menu | 653 | @menu |
654 | * Preliminaries2:: | 654 | * VPN Preliminaries:: |
655 | * Exit configuration:: | 655 | * Exit configuration:: |
656 | * GNS configuration:: | 656 | * GNS configuration:: |
657 | * Accessing the service:: | 657 | * Accessing the service:: |
658 | * Using a Browser:: | 658 | * Using a Browser:: |
659 | @end menu | 659 | @end menu |
660 | 660 | ||
661 | @node Preliminaries2 | 661 | @node VPN Preliminaries |
662 | @subsection Preliminaries2 | 662 | @subsection VPN Preliminaries |
663 | @c %**end of header | 663 | @c %**end of header |
664 | 664 | ||
665 | To test the GNUnet VPN, we should first run a web server. The easiest way to do | 665 | To test the GNUnet VPN, we should first run a web server. The easiest way to do |