[GNUnet-SVN] r24584 - gnunet-gtk/doc

[gnunet]

Author: grothoff
Date: 2012-10-29 00:10:33 +0100 (Mon, 29 Oct 2012)
New Revision: 24584

Added:
   gnunet-gtk/doc/gnunet-peerinfo-gtk.1
   gnunet-gtk/doc/gnunet-setup.1
   gnunet-gtk/doc/gnunet-statistics-gtk.1
Modified:
   gnunet-gtk/doc/Makefile.am
Log:
adding man pages

Modified: gnunet-gtk/doc/Makefile.am
===================================================================
--- gnunet-gtk/doc/Makefile.am  2012-10-28 22:35:32 UTC (rev 24583)
+++ gnunet-gtk/doc/Makefile.am  2012-10-28 23:10:33 UTC (rev 24584)
@@ -1,5 +1,8 @@
 man_MANS = \
-  gnunet-fs-gtk.1
+  gnunet-fs-gtk.1 \
+  gnunet-setup.1 \
+  gnunet-peerinfo-gtk.1 \
+  gnunet-statistics-gtk.1
 
 EXTRA_DIST = $(man_MANS)
 

Added: gnunet-gtk/doc/gnunet-peerinfo-gtk.1
===================================================================
--- gnunet-gtk/doc/gnunet-peerinfo-gtk.1                                (rev 0)
+++ gnunet-gtk/doc/gnunet-peerinfo-gtk.1        2012-10-28 23:10:33 UTC (rev 
24584)
@@ -0,0 +1,29 @@
+.TH GNUNET-PEERINFO-GTK "1" "25 Oct 2012" "GNUnet"
+.SH NAME
+gnunet\-peerinfo\-gtk \- a gtk interface for showing peer information
+.SH SYNOPSIS
+.B gnunet\-peerinfo\-gtk
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+.PP
+gnunet\-peerinfo\-gtk is a gtk+ based GUI for displaying connected peers with 
information about allocated bandwidth and (if available) their hostname.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+load config file (default: ~/.gnunet/gnunet.conf)
+.TP
+\fB\-t, \fB\-\-tray\fR
+start with main window minimized (only put icon in tray)
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+User's GNUnet configuration file
+.SH "REPORTING BUGS"
+Report bugs by using mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
+.SH "SEE ALSO"
+\fBgnunet\-setup\fP(1)

Added: gnunet-gtk/doc/gnunet-setup.1
===================================================================
--- gnunet-gtk/doc/gnunet-setup.1                               (rev 0)
+++ gnunet-gtk/doc/gnunet-setup.1       2012-10-28 23:10:33 UTC (rev 24584)
@@ -0,0 +1,44 @@
+.TH GNUNET-SETUP "1" "25 Oct 2012" "GNUnet"
+.SH NAME
+gnunet\-setup \- a gtk interface for configuring GNUnet
+.SH SYNOPSIS
+.B gnunet\-setup
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+.PP
+gnunet\-setup is a gtk+ based GUI for configuring GNUnet.  
+
+The first time you run gnunet\-setup, the goal will typically be to configure 
the peer, that is, the set of processes that always run in the background.  
Those processes should run as user "gnunet" and thus gnunet\-setup should be 
run as user "gnunet" for this step.  Use the "\-e" option to enable automatic 
priviledge escalation using gksu (if supported by your system).  Alternatively, 
you can of course run gnunet\-setup from the "gnunet" system user account or 
even as "root".  If you see a tab "General", you did start gnunet\-setup 
correctly to configure the peer.  You should now be able to configure which 
subsystems of GNUnet you want to enable, which databases to use and what your 
network configuration looks like.  After these steps are complete, you should 
be able to start your peer using "gnunet\-arm".  
+
+It is recommended that "/etc/gnunet.conf" should be a world\-readable copy of 
the peer's GNUnet configuration.  Note that GNUnet configuration files (as 
generated by gnunet\-setup) only contain those values that differ from the 
defaults.  Also note that "gnunet\-arm" will by default look for a 
configuration in "$HOME/.gnunet/gnunet.conf" (so if your configuration is in 
"/etc/gnunet.conf", you have to pass "\-c /etc/gnunet.conf" to gnunet\-arm).
+
+After your peer is configured, gnunet\-setup can also still be useful to 
configure an individual user's GADS zone (if GNS is enabled).  This restricted 
per-user configuration is automatically run if a user "gnunet" exists on your 
system and you do not run gnunet\-setup as "gnunet" or "root".  Using the "\-f" 
option, normal users can force seeing the full set of options, which only makes 
sense if they intend to run their own GNUnet peer on the system (or move the 
generated configuration file to another location afterwards).
+
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+load config file (default: ~/.gnunet/gnunet.conf)
+.TP
+\fB\-e, \fB\-\-elevate\-priviledges\fR
+Try to elevate priviledges to run gnunet\-setup as user "gnunet".   This 
option is only available if libgksu-support was found on your system.  It is 
ignored if gnunet\-setup is run as user "root" or "gnunet" already.  If "gksu" 
fails, gnunet\]-setup is run as the current user.
+.TP
+\fB\-f, \fB\-\-force\-full\-setup\fR
+Display all of the options for a peer even if a user "gnunet" exists but 
gnunet\-setup is not run as that user.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.SH NOTES
+.PP
+Many options in gnunet\-setup are documented online. Access the online help by 
first selecting the respective widget and then clicking on the link at the 
bottom of the dialog.
+.PP
+Exiting gnunet\-setup (by closing the window or pressing ESCape) always saves 
the current configuration to disk.
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+User's GNUnet configuration file
+.SH "REPORTING BUGS"
+Report bugs by using mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
+.SH "SEE ALSO"
+\fBgnunet\-arm\fP(1), \fBgnunet.conf\fP(5)

Added: gnunet-gtk/doc/gnunet-statistics-gtk.1
===================================================================
--- gnunet-gtk/doc/gnunet-statistics-gtk.1                              (rev 0)
+++ gnunet-gtk/doc/gnunet-statistics-gtk.1      2012-10-28 23:10:33 UTC (rev 
24584)
@@ -0,0 +1,29 @@
+.TH GNUNET-STATISTICS-GTK "1" "25 Oct 2012" "GNUnet"
+.SH NAME
+gnunet\-statistics\-gtk \- a gtk interface for showing peer statistics
+.SH SYNOPSIS
+.B gnunet\-statistics\-gtk
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+.PP
+gnunet\-statistics\-gtk is a gtk+ based GUI for displaying selected statistics 
from a peer.  The x-axis shown is always time.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+load config file (default: ~/.gnunet/gnunet.conf)
+.TP
+\fB\-t, \fB\-\-tray\fR
+start with main window minimized (only put icon in tray)
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.SH FILES
+.TP
+~/.gnunet/gnunet.conf
+User's GNUnet configuration file
+.SH "REPORTING BUGS"
+Report bugs by using mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>
+.SH "SEE ALSO"
+\fBgnunet\-setup\fP(1)