aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2018-05-07 20:24:05 +0200
committerChristian Grothoff <christian@grothoff.org>2018-05-07 20:24:05 +0200
commitbe4754c02fdbefc4fbf5046973c7c1ab44f8e92f (patch)
tree38d92a9b9274cde2d178df9d4401baa7b2b04426 /doc/documentation
parent49aaa695ff123e2e708addb00f2959e56372c9af (diff)
downloadgnunet-be4754c02fdbefc4fbf5046973c7c1ab44f8e92f.tar.gz
gnunet-be4754c02fdbefc4fbf5046973c7c1ab44f8e92f.zip
update gtk documentation a bit
Diffstat (limited to 'doc/documentation')
-rw-r--r--doc/documentation/chapters/installation.texi6
-rw-r--r--doc/documentation/chapters/user.texi85
-rw-r--r--doc/documentation/images/gnunet-gtk-0-10.pngbin72897 -> 0 bytes
3 files changed, 38 insertions, 53 deletions
diff --git a/doc/documentation/chapters/installation.texi b/doc/documentation/chapters/installation.texi
index 6eb1a88a0..f2042033e 100644
--- a/doc/documentation/chapters/installation.texi
+++ b/doc/documentation/chapters/installation.texi
@@ -102,7 +102,7 @@ recommended for first-time users)}
102 102
103These applications must be installed for various experimental or otherwise 103These applications must be installed for various experimental or otherwise
104optional features such as @command{gnunet-conversation}, 104optional features such as @command{gnunet-conversation},
105and @command{gnunet-gtk} (most of these features are only build if you 105and @command{gnunet-conversation-gtk} (most of these features are only build if you
106configure GNUnet with @command{--enable-experimental}): 106configure GNUnet with @command{--enable-experimental}):
107 107
108@itemize @bullet 108@itemize @bullet
@@ -1992,7 +1992,7 @@ to your PATH or GNUnet's @file{bin} directory
1992 1992
1993 1993
1994@item @strong{GTK+}@ 1994@item @strong{GTK+}@
1995@command{gnunet-gtk} and @command{libextractor} depend on GTK. 1995@command{gnunet-fs-gtk} and @command{libextractor} depend on GTK.
1996Get the the binary and developer packages of @command{atk}, 1996Get the the binary and developer packages of @command{atk},
1997@command{glib}, @command{gtk}, @command{iconv}, 1997@command{glib}, @command{gtk}, @command{iconv},
1998@command{gettext-runtime}, @command{pango} from 1998@command{gettext-runtime}, @command{pango} from
@@ -2007,7 +2007,7 @@ Here is an all-in-one package for the
2007. Do not overwrite any existing files! 2007. Do not overwrite any existing files!
2008 2008
2009@item @strong{Glade}@ 2009@item @strong{Glade}@
2010@command{gnunet-gtk} and @command{gnunet-setup} were created using 2010@command{gnunet-*-gtk} and @command{gnunet-setup} were created using
2011this interface builder 2011this interface builder
2012 2012
2013@itemize @bullet 2013@itemize @bullet
diff --git a/doc/documentation/chapters/user.texi b/doc/documentation/chapters/user.texi
index db96585ec..91b983be2 100644
--- a/doc/documentation/chapters/user.texi
+++ b/doc/documentation/chapters/user.texi
@@ -49,24 +49,9 @@ configuration handbooks.
49@subsection gnunet-gtk 49@subsection gnunet-gtk
50@c %**end of header 50@c %**end of header
51 51
52First, you should launch @command{gnunet-gtk}, the graphical user 52The @command{gnunet-gtk} package contains several graphical
53interface for GNUnet which will be used for most of the tutorial. 53user interfaces for the respective GNUnet applications.
54You can do this from the command-line by typing 54Those currently are:
55
56@example
57$ gnunet-gtk
58@end example
59
60(note that @code{$} represents the prompt of the shell for a normal user).
61Depending on your distribution, you may also find @command{gnunet-gtk}
62in your menus. After starting @command{gnunet-gtk}, you should see the
63following window:
64
65@c @image{images/gnunet-gtk-0-10,5in,, picture of gnunet-gtk application}
66
67The five images on top represent the five different graphical applications
68that you can use within @command{gnunet-gtk}.
69They are (from left to right):
70 55
71@itemize @bullet 56@itemize @bullet
72@item Statistics 57@item Statistics
@@ -74,14 +59,20 @@ They are (from left to right):
74@item GNU Name System 59@item GNU Name System
75@item File Sharing 60@item File Sharing
76@item Identity Management 61@item Identity Management
62@item Conversation
77@end itemize 63@end itemize
78 64
79@node Statistics 65@node Statistics
80@subsection Statistics 66@subsection Statistics
81@c %**end of header 67@c %**end of header
82 68
83When @command{gnunet-gtk} is started, the statistics area should be 69First, you should launch the graphical user interface. You can do
84selected at first. 70this from the command-line by typing
71
72@example
73$ gnunet-statistics-gtk
74@end example
75
85If your peer is running correctly, you should see a bunch of 76If your peer is running correctly, you should see a bunch of
86lines, all of which should be "significantly" above zero (at least if your 77lines, all of which should be "significantly" above zero (at least if your
87peer has been running for a few seconds). The lines indicate how many 78peer has been running for a few seconds). The lines indicate how many
@@ -100,23 +91,28 @@ traffic.
100@subsection Peer Information 91@subsection Peer Information
101@c %**end of header 92@c %**end of header
102 93
103You should now click on the Australian Aboriginal Flag. Once you have 94First, you should launch the graphical user interface. You can do
104done this, you will see a list of known peers (by the first four 95this from the command-line by typing
105characters of their public key), their friend status (all should be 96
106marked as not-friends initially), their connectivity (green is 97@example
107connected, red is disconnected), assigned bandwidth, 98$ gnunet-peerinfo-gtk
108country of origin (if determined) and address information. If hardly 99@end example
109any peers are listed and/or if there are very few peers with a green light 100
110for connectivity, there is likely a problem with your 101Once you have done this, you will see a list of known peers (by the
111network configuration. 102first four characters of their public key), their friend status (all
103should be marked as not-friends initially), their connectivity (green
104is connected, red is disconnected), assigned bandwidth, country of
105origin (if determined) and address information. If hardly any peers
106are listed and/or if there are very few peers with a green light for
107connectivity, there is likely a problem with your network
108configuration.
112 109
113@node First steps - File-sharing 110@node First steps - File-sharing
114@section First steps - File-sharing 111@section First steps - File-sharing
115@c %**end of header 112@c %**end of header
116 113
117This chapter describes first steps for file-sharing with GNUnet. 114This chapter describes first steps for file-sharing with GNUnet.
118To start, you should launch @command{gnunet-gtk} and select the 115To start, you should launch @command{gnunet-fs-gtk}.
119file-sharing tab (the one with the arrows between the three circles).
120 116
121As we want to be sure that the network contains the data that we are 117As we want to be sure that the network contains the data that we are
122looking for for testing, we need to begin by publishing a file. 118looking for for testing, we need to begin by publishing a file.
@@ -246,8 +242,6 @@ That's it, you now know the basics for file-sharing with GNUnet!
246@section First steps - Using the GNU Name System 242@section First steps - Using the GNU Name System
247@c %**end of header 243@c %**end of header
248 244
249
250
251@menu 245@menu
252* Preliminaries:: 246* Preliminaries::
253* Managing Egos:: 247* Managing Egos::
@@ -310,7 +304,7 @@ rules - GO0T87F9BPMF8NKD5A54L2AH1T0GRML539TPFSRMCEA98182QD30
310Maintaing your zones is through the NAMESTORE service and is discussed 304Maintaing your zones is through the NAMESTORE service and is discussed
311here. You can manage your zone using @command{gnunet-identity} and 305here. You can manage your zone using @command{gnunet-identity} and
312@command{gnunet-namestore}, or most conveniently using 306@command{gnunet-namestore}, or most conveniently using
313@command{gnunet-gtk} (or @command{gnunet-namestore-gtk}). 307@command{gnunet-namestore-gtk}.
314 308
315We will use the GTK+ interface in this introduction. Please start 309We will use the GTK+ interface in this introduction. Please start
316@command{gnunet-gkt} and switch to the GNS tab, which is the tab in 310@command{gnunet-gkt} and switch to the GNS tab, which is the tab in
@@ -638,14 +632,12 @@ using this new public key infrastructure.
638@section First steps - Using GNUnet Conversation 632@section First steps - Using GNUnet Conversation
639@c %**end of header 633@c %**end of header
640 634
641Before starting the tutorial, you should be aware that 635First, you should launch the graphical user interface. You can do
642@code{gnunet-conversation} is currently only available 636this from the command-line by typing
643as an interactive shell tool and that the call quality
644tends to be abysmal. There are also some awkward
645steps necessary to use it. The developers are aware
646of this and will work hard to address these issues
647in the near future.
648 637
638@example
639$ gnunet-conversation-gtk
640@end example
649 641
650@menu 642@menu
651* Testing your Audio Equipment:: 643* Testing your Audio Equipment::
@@ -743,11 +735,11 @@ Now you can call a buddy. Obviously, your buddy will have to have GNUnet
743installed and must have performed the same steps. Also, you must have 735installed and must have performed the same steps. Also, you must have
744your buddy in your GNS master zone, for example by having imported 736your buddy in your GNS master zone, for example by having imported
745your buddy's public key using @code{gnunet-qr}. Suppose your buddy 737your buddy's public key using @code{gnunet-qr}. Suppose your buddy
746is in your zone as @code{buddy.gnu} and they also created their 738is in your zone as @code{buddy.mytld} and they also created their
747phone using a label "home-phone". Then you can initiate a call using: 739phone using a label "home-phone". Then you can initiate a call using:
748 740
749@example 741@example
750/call home-phone.buddy.gnu 742/call home-phone.buddy.mytld
751@end example 743@end example
752 744
753It may take some time for GNUnet to resolve the name and to establish 745It may take some time for GNUnet to resolve the name and to establish
@@ -760,13 +752,6 @@ that, (encrypted) voice data should be relayed between your two peers.
760Either of you can end the call using @command{/cancel}. You can exit 752Either of you can end the call using @command{/cancel}. You can exit
761@code{gnunet-converation} using @command{/quit}. 753@code{gnunet-converation} using @command{/quit}.
762 754
763@node Future Directions
764@subsection Future Directions
765@c %**end of header
766
767Note that we do not envision people to use gnunet-conversation like this
768forever. We will write a graphical user interface, and that GUI will
769automatically create the necessary records in the respective zone.
770 755
771@node First steps - Using the GNUnet VPN 756@node First steps - Using the GNUnet VPN
772@section First steps - Using the GNUnet VPN 757@section First steps - Using the GNUnet VPN
diff --git a/doc/documentation/images/gnunet-gtk-0-10.png b/doc/documentation/images/gnunet-gtk-0-10.png
deleted file mode 100644
index 3615849a7..000000000
--- a/doc/documentation/images/gnunet-gtk-0-10.png
+++ /dev/null
Binary files differ