diff options
author | ng0 <ng0@infotropique.org> | 2017-09-06 09:58:41 +0000 |
---|---|---|
committer | ng0 <ng0@infotropique.org> | 2017-09-06 09:58:41 +0000 |
commit | 292cc51b35bcb727fa80b7c95730dae02e41a7d4 (patch) | |
tree | 5af5bac1862db591f669c04a815a9d6626feb0e8 /doc | |
parent | ade2178e2ddf11aaf7911b3da40906e2ed753710 (diff) | |
download | gnunet-292cc51b35bcb727fa80b7c95730dae02e41a7d4.tar.gz gnunet-292cc51b35bcb727fa80b7c95730dae02e41a7d4.zip |
doc: gnunet-c-tutorial: add @chapter's.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gnunet-c-tutorial.texi | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/gnunet-c-tutorial.texi b/doc/gnunet-c-tutorial.texi index 7c52260a4..2e4bd9a45 100644 --- a/doc/gnunet-c-tutorial.texi +++ b/doc/gnunet-c-tutorial.texi | |||
@@ -59,7 +59,7 @@ any questions or problems! Check here how to contact the GNUnet | |||
59 | team: @uref{https://gnunet.org/contact_information} | 59 | team: @uref{https://gnunet.org/contact_information} |
60 | 60 | ||
61 | @node Installing GNUnet | 61 | @node Installing GNUnet |
62 | @section Installing GNUnet | 62 | @chapter Installing GNUnet |
63 | 63 | ||
64 | First of all you have to install a current version of GNUnet. You can download a | 64 | First of all you have to install a current version of GNUnet. You can download a |
65 | tarball of a stable version from GNU FTP mirrors or obtain the latest development | 65 | tarball of a stable version from GNU FTP mirrors or obtain the latest development |
@@ -71,7 +71,7 @@ can fail. You should only use the development version if you know that you requi | |||
71 | certain feature or a certain issue has been fixed since the last release. | 71 | certain feature or a certain issue has been fixed since the last release. |
72 | 72 | ||
73 | @node Obtaining a stable version | 73 | @node Obtaining a stable version |
74 | @subsection Obtaining a stable version | 74 | @section Obtaining a stable version |
75 | 75 | ||
76 | You can download the latest stable version of GNUnet from GNU FTP mirrors: | 76 | You can download the latest stable version of GNUnet from GNU FTP mirrors: |
77 | @uref{https://ftp.gnu.org/gnu/gnunet/gnunet-0.10.x.tar.gz} | 77 | @uref{https://ftp.gnu.org/gnu/gnunet/gnunet-0.10.x.tar.gz} |
@@ -97,7 +97,7 @@ However, please note that stable versions can be very outdated, as a developer | |||
97 | you are strongly encouraged to use the version from @uref{https://gnunet.org/git/}. | 97 | you are strongly encouraged to use the version from @uref{https://gnunet.org/git/}. |
98 | 98 | ||
99 | @node Installing Build Tool Chain and Dependencies | 99 | @node Installing Build Tool Chain and Dependencies |
100 | @subsection Installing Build Tool Chain and Dependencies | 100 | @section Installing Build Tool Chain and Dependencies |
101 | 101 | ||
102 | To successfully compile GNUnet you need the tools to build GNUnet and the required dependencies. | 102 | To successfully compile GNUnet you need the tools to build GNUnet and the required dependencies. |
103 | Please have a look at @uref{https://gnunet.org/dependencies} for a list of required dependencies | 103 | Please have a look at @uref{https://gnunet.org/dependencies} for a list of required dependencies |
@@ -110,7 +110,7 @@ For the filesharing service you should install at least one of the datastore bac | |||
110 | sqlite or postgresql. | 110 | sqlite or postgresql. |
111 | 111 | ||
112 | @node Obtaining the latest version from Git | 112 | @node Obtaining the latest version from Git |
113 | @subsection Obtaining the latest version from Git | 113 | @section Obtaining the latest version from Git |
114 | 114 | ||
115 | The latest development version can obtained from our Git repository. To obtain | 115 | The latest development version can obtained from our Git repository. To obtain |
116 | the code you need Git installed and checkout the repository using: | 116 | the code you need Git installed and checkout the repository using: |
@@ -126,7 +126,7 @@ $ ./bootstrap | |||
126 | The remainder of this tutorial assumes that you have Git branch ``master'' checked out. | 126 | The remainder of this tutorial assumes that you have Git branch ``master'' checked out. |
127 | 127 | ||
128 | @node Compiling and Installing GNUnet | 128 | @node Compiling and Installing GNUnet |
129 | @subsection Compiling and Installing GNUnet | 129 | @section Compiling and Installing GNUnet |
130 | 130 | ||
131 | First, you need to install at least libgnupgerror version 1.27 | 131 | First, you need to install at least libgnupgerror version 1.27 |
132 | @uref{https://www.gnupg.org/ftp/gcrypt/libgpg-error/libgpg-error-1.27.tar.bz2} | 132 | @uref{https://www.gnupg.org/ftp/gcrypt/libgpg-error/libgpg-error-1.27.tar.bz2} |
@@ -151,7 +151,7 @@ $ cd .. | |||
151 | @end example | 151 | @end example |
152 | 152 | ||
153 | @node Installation | 153 | @node Installation |
154 | @subsubsection Installation | 154 | @subsection Installation |
155 | Assuming all dependencies are installed, the following commands will | 155 | Assuming all dependencies are installed, the following commands will |
156 | compile and install GNUnet in your home directory. You can specify the | 156 | compile and install GNUnet in your home directory. You can specify the |
157 | directory where GNUnet will be installed by changing the | 157 | directory where GNUnet will be installed by changing the |
@@ -179,7 +179,7 @@ $ touch ~/.config/gnunet.conf | |||
179 | @end example | 179 | @end example |
180 | 180 | ||
181 | @node Common Issues - Check your GNUnet installation | 181 | @node Common Issues - Check your GNUnet installation |
182 | @subsection Common Issues - Check your GNUnet installation | 182 | @section Common Issues - Check your GNUnet installation |
183 | 183 | ||
184 | You should check your installation to ensure that installing GNUnet | 184 | You should check your installation to ensure that installing GNUnet |
185 | was successful up to this point. You should be able to access GNUnet's | 185 | was successful up to this point. You should be able to access GNUnet's |
@@ -211,7 +211,7 @@ PASS: test_gnunet_prefix | |||
211 | @end example | 211 | @end example |
212 | 212 | ||
213 | @node Background: GNUnet Architecture | 213 | @node Background: GNUnet Architecture |
214 | @section Background: GNUnet Architecture | 214 | @chapter Background: GNUnet Architecture |
215 | 215 | ||
216 | GNUnet is organized in layers and services. Each service is composed of a | 216 | GNUnet is organized in layers and services. Each service is composed of a |
217 | main service implementation and a client library for other programs to use | 217 | main service implementation and a client library for other programs to use |
@@ -255,10 +255,10 @@ clients communicate via a message protocol to be defined and implemented by | |||
255 | the programmer. | 255 | the programmer. |
256 | 256 | ||
257 | @node First Steps with GNUnet | 257 | @node First Steps with GNUnet |
258 | @section First Steps with GNUnet | 258 | @chapter First Steps with GNUnet |
259 | 259 | ||
260 | @node Configure your peer | 260 | @node Configure your peer |
261 | @subsection Configure your peer | 261 | @section Configure your peer |
262 | 262 | ||
263 | First of all we need to configure your peer. Each peer is started with a configuration | 263 | First of all we need to configure your peer. Each peer is started with a configuration |
264 | containing settings for GNUnet itself and its services. This configuration is based on the | 264 | containing settings for GNUnet itself and its services. This configuration is based on the |
@@ -289,7 +289,7 @@ SERVERS = # prevent bootstrapping | |||
289 | @end example | 289 | @end example |
290 | 290 | ||
291 | @node Start a peer | 291 | @node Start a peer |
292 | @subsection Start a peer | 292 | @section Start a peer |
293 | Each GNUnet instance (called peer) has an identity (peer ID) based on a | 293 | Each GNUnet instance (called peer) has an identity (peer ID) based on a |
294 | cryptographic public private key pair. The peer ID is the printable hash of the | 294 | cryptographic public private key pair. The peer ID is the printable hash of the |
295 | public key. | 295 | public key. |
@@ -314,7 +314,7 @@ I am peer `0PA02UVRKQTS2C .. JL5Q78F6H0B1ACPV1CJI59MEQUMQCC5G'. | |||
314 | @end example | 314 | @end example |
315 | 315 | ||
316 | @node Monitor a peer | 316 | @node Monitor a peer |
317 | @subsection Monitor a peer | 317 | @section Monitor a peer |
318 | 318 | ||
319 | In this section, we will monitor the behaviour of our peer's DHT service with respect to a | 319 | In this section, we will monitor the behaviour of our peer's DHT service with respect to a |
320 | specific key. First we will start GNUnet and then start the DHT service and use the DHT monitor tool | 320 | specific key. First we will start GNUnet and then start the DHT service and use the DHT monitor tool |
@@ -338,7 +338,7 @@ $ gnunet-statistics -c ~/peer1.conf -s dht # print statistics about DHT service | |||
338 | @end example | 338 | @end example |
339 | 339 | ||
340 | @node Starting Two Peers by Hand | 340 | @node Starting Two Peers by Hand |
341 | @subsection Starting Two Peers by Hand | 341 | @section Starting Two Peers by Hand |
342 | 342 | ||
343 | This section describes how to start two peers on the same machine by hand. | 343 | This section describes how to start two peers on the same machine by hand. |
344 | The process is rather painful, but the description is somewhat instructive. | 344 | The process is rather painful, but the description is somewhat instructive. |
@@ -346,7 +346,7 @@ In practice, you might prefer the automated method | |||
346 | (@pxref{Starting Peers Using the Testbed Service}). | 346 | (@pxref{Starting Peers Using the Testbed Service}). |
347 | 347 | ||
348 | @node Setup a second peer | 348 | @node Setup a second peer |
349 | @subsubsection Setup a second peer | 349 | @subsection Setup a second peer |
350 | We will now start a second peer on your machine. | 350 | We will now start a second peer on your machine. |
351 | For the second peer, you will need to manually create a modified | 351 | For the second peer, you will need to manually create a modified |
352 | configuration file to avoid conflicts with ports and directories. | 352 | configuration file to avoid conflicts with ports and directories. |
@@ -386,7 +386,7 @@ gnunet-peerinfo output for the first peer (otherwise you made an | |||
386 | error in the configuration). | 386 | error in the configuration). |
387 | 387 | ||
388 | @node Start the second peer and connect the peers | 388 | @node Start the second peer and connect the peers |
389 | @subsubsection Start the second peer and connect the peers | 389 | @subsection Start the second peer and connect the peers |
390 | 390 | ||
391 | Then, you can start a second peer using: | 391 | Then, you can start a second peer using: |
392 | @example | 392 | @example |
@@ -425,7 +425,7 @@ likely observe traffic and behaviors that are not explicitly controlled | |||
425 | by you. | 425 | by you. |
426 | 426 | ||
427 | @node How to connect manually | 427 | @node How to connect manually |
428 | @subsubsection How to connect manually | 428 | @subsection How to connect manually |
429 | 429 | ||
430 | If you want to use the @code{peerinfo} tool to connect your peers, you should: | 430 | If you want to use the @code{peerinfo} tool to connect your peers, you should: |
431 | @itemize | 431 | @itemize |
@@ -443,7 +443,7 @@ Peer `9TVUCS8P5A7ILLBGO6 [...shortened...] 1KNBJ4NGCHP3JPVULDG' | |||
443 | @end example | 443 | @end example |
444 | 444 | ||
445 | @node Starting Peers Using the Testbed Service | 445 | @node Starting Peers Using the Testbed Service |
446 | @subsection Starting Peers Using the Testbed Service | 446 | @section Starting Peers Using the Testbed Service |
447 | @c \label{sec:testbed} | 447 | @c \label{sec:testbed} |
448 | 448 | ||
449 | GNUnet's testbed service is used for testing scenarios where a number of peers | 449 | GNUnet's testbed service is used for testing scenarios where a number of peers |
@@ -532,10 +532,10 @@ Then use the DHT API to store and retrieve values in the | |||
532 | network. | 532 | network. |
533 | 533 | ||
534 | @node Developing Applications | 534 | @node Developing Applications |
535 | @section Developing Applications | 535 | @chapter Developing Applications |
536 | 536 | ||
537 | @node gnunet-ext | 537 | @node gnunet-ext |
538 | @subsection gnunet-ext | 538 | @section gnunet-ext |
539 | To develop a new peer-to-peer application or to extend GNUnet we provide | 539 | To develop a new peer-to-peer application or to extend GNUnet we provide |
540 | a template build system for writing GNUnet extensions in C. It can be | 540 | a template build system for writing GNUnet extensions in C. It can be |
541 | obtained as follows: | 541 | obtained as follows: |
@@ -575,7 +575,7 @@ In addition the ext systems provides: | |||
575 | @end itemize | 575 | @end itemize |
576 | 576 | ||
577 | @node Adapting the Template | 577 | @node Adapting the Template |
578 | @subsection Adapting the Template | 578 | @section Adapting the Template |
579 | 579 | ||
580 | The first step for writing any extension with a new service is to | 580 | The first step for writing any extension with a new service is to |
581 | ensure that the @file{ext.conf.in} file contains entries for the | 581 | ensure that the @file{ext.conf.in} file contains entries for the |