diff options
author | Nils Gillmann <ng0@n0.is> | 2018-06-13 08:01:51 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-06-13 08:01:51 +0000 |
commit | 1f7a2dd68d1e6260fad4af042878c0a07d39bc12 (patch) | |
tree | d1ee8aedc75dfc7689d6e165d1ac936d1644044a /doc/documentation/chapters | |
parent | 01b37d9db39d96fc05dcdea8c35a3d62408cda59 (diff) | |
download | gnunet-1f7a2dd68d1e6260fad4af042878c0a07d39bc12.tar.gz gnunet-1f7a2dd68d1e6260fad4af042878c0a07d39bc12.zip |
some changes and work in user handbook.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/documentation/chapters')
-rw-r--r-- | doc/documentation/chapters/user.texi | 48 |
1 files changed, 27 insertions, 21 deletions
diff --git a/doc/documentation/chapters/user.texi b/doc/documentation/chapters/user.texi index 48fcc04c3..b5457cf15 100644 --- a/doc/documentation/chapters/user.texi +++ b/doc/documentation/chapters/user.texi | |||
@@ -2,20 +2,21 @@ | |||
2 | @chapter Using GNUnet | 2 | @chapter Using GNUnet |
3 | @c %**end of header | 3 | @c %**end of header |
4 | 4 | ||
5 | This tutorial is supposed to give a first introduction for end-users | 5 | This tutorial is supposed to give a first introduction for users |
6 | trying to do something "real" with GNUnet. Installation and | 6 | trying to do something real with GNUnet. Installation and |
7 | configuration are specifically outside of the scope of this tutorial. | 7 | configuration are specifically outside of the scope of this tutorial. |
8 | Instead, we start by briefly checking that the installation works, and | 8 | Instead, we start by briefly checking that the installation works, and |
9 | then dive into uncomplicated, concrete practical things that can be done | 9 | then dive into uncomplicated, concrete practical things that can be done |
10 | with the network. | 10 | with the framework provided by GNUnet. |
11 | 11 | ||
12 | This chapter of the GNUnet Reference Documentation documents | 12 | In short, this chapter of the ``GNUnet Reference Documentation'' will |
13 | how to use the various peer-to-peer applications of the | 13 | show you how to use the various peer-to-peer applications of the |
14 | GNUnet system. | 14 | GNUnet system. |
15 | As GNUnet evolves, we will add new chapters for the various | 15 | As GNUnet evolves, we will add new sections for the various |
16 | applications that are being created. | 16 | applications that are being created. |
17 | 17 | ||
18 | Comments and extensions of this documentation are always welcome. | 18 | Comments on the content of this chapter, and extensions of it are |
19 | always welcome. | ||
19 | 20 | ||
20 | 21 | ||
21 | @menu | 22 | @menu |
@@ -35,10 +36,11 @@ Comments and extensions of this documentation are always welcome. | |||
35 | @section Checking the Installation | 36 | @section Checking the Installation |
36 | @c %**end of header | 37 | @c %**end of header |
37 | 38 | ||
38 | This section describes a quick casual way to check if your GNUnet | 39 | This section describes a quick, casual way to check if your GNUnet |
39 | installation works. However, if it does not, we do not cover | 40 | installation works. However, if it does not, we do not cover |
40 | steps for recovery --- for this, please study the installation and | 41 | steps for recovery --- for this, please study the instructions |
41 | configuration handbooks. | 42 | provided in the developer handbook as well as the system-specific |
43 | instruction in the source code repository@footnote{The system specific instructions are not provided as part of this handbook!}. | ||
42 | 44 | ||
43 | 45 | ||
44 | @menu | 46 | @menu |
@@ -47,13 +49,16 @@ configuration handbooks. | |||
47 | * Peer Information:: | 49 | * Peer Information:: |
48 | @end menu | 50 | @end menu |
49 | 51 | ||
52 | @cindex GNUnet GTK | ||
53 | @cindex GTK | ||
54 | @cindex GTK user interface | ||
50 | @node gnunet-gtk | 55 | @node gnunet-gtk |
51 | @subsection gnunet-gtk | 56 | @subsection gnunet-gtk |
52 | @c %**end of header | 57 | @c %**end of header |
53 | 58 | ||
54 | The @command{gnunet-gtk} package contains several graphical | 59 | The @command{gnunet-gtk} package contains several graphical |
55 | user interfaces for the respective GNUnet applications. | 60 | user interfaces for the respective GNUnet applications. |
56 | Those currently are: | 61 | Currently these interfaces cover: |
57 | 62 | ||
58 | @itemize @bullet | 63 | @itemize @bullet |
59 | @item Statistics | 64 | @item Statistics |
@@ -68,20 +73,21 @@ Those currently are: | |||
68 | @subsection Statistics | 73 | @subsection Statistics |
69 | @c %**end of header | 74 | @c %**end of header |
70 | 75 | ||
71 | First, you should launch the graphical user interface. You can do | 76 | First, you should launch GNUnet gtk@footnote{Obviously you should also start gnunet, via gnunet-arm or the system provided method}. |
72 | this from the command-line by typing | 77 | You can do this from the command-line by typing |
73 | 78 | ||
74 | @example | 79 | @example |
75 | $ gnunet-statistics-gtk | 80 | gnunet-statistics-gtk |
76 | @end example | 81 | @end example |
77 | 82 | ||
78 | If your peer is running correctly, you should see a bunch of | 83 | If your peer@footnote{The term ``peer'' is a common word used in federated and distributed networks to describe a participating device which is connected to the network. Thus, your Personal Computer or whatever it is you are looking at the Gtk+ interface describes a ``Peer'' or a ``Node''.} |
79 | lines, all of which should be "significantly" above zero (at least if your | 84 | is running correctly, you should see a bunch of lines, |
80 | peer has been running for a few seconds). The lines indicate how many | 85 | all of which should be ``significantly'' above zero (at least if your |
81 | other | 86 | peer has been running for more than a few seconds). The lines indicate |
82 | peers your peer is connected to (via different mechanisms) and how large | 87 | how many other peers your peer is connected to (via different |
83 | the overall overlay network is currently estimated to be. The X-axis | 88 | mechanisms) and how large the entire overlay network is currently |
84 | represents time (in seconds since the start of @command{gnunet-gtk}). | 89 | estimated to be. The X-axis represents time (in seconds since the |
90 | start of @command{gnunet-gtk}). | ||
85 | 91 | ||
86 | You can click on "Traffic" to see information about the amount of | 92 | You can click on "Traffic" to see information about the amount of |
87 | bandwidth your peer has consumed, and on "Storage" to check the amount | 93 | bandwidth your peer has consumed, and on "Storage" to check the amount |