aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-10-07 14:41:38 +0000
committerChristian Grothoff <christian@grothoff.org>2013-10-07 14:41:38 +0000
commitd876ad6a74d4e3675a99def096d9234c401f51cf (patch)
treef6bb6a088b7a966dbcc5959db1916ea45f3bd344 /doc
parent5de2318135df2087a60c591628e7cc6414149bdd (diff)
downloadgnunet-gtk-d876ad6a74d4e3675a99def096d9234c401f51cf.tar.gz
gnunet-gtk-d876ad6a74d4e3675a99def096d9234c401f51cf.zip
add manpage for gnunet-namestore-gtk, update gnunet-setup man page
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/gnunet-namestore-gtk.129
-rw-r--r--doc/gnunet-setup.111
3 files changed, 33 insertions, 8 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 5d163430..17167f69 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -3,6 +3,7 @@ SUBDIRS = . doxygen
3man_MANS = \ 3man_MANS = \
4 gnunet-fs-gtk.1 \ 4 gnunet-fs-gtk.1 \
5 gnunet-identity-gtk.1 \ 5 gnunet-identity-gtk.1 \
6 gnunet-namestore-gtk.1 \
6 gnunet-setup.1 \ 7 gnunet-setup.1 \
7 gnunet-peerinfo-gtk.1 \ 8 gnunet-peerinfo-gtk.1 \
8 gnunet-statistics-gtk.1 9 gnunet-statistics-gtk.1
diff --git a/doc/gnunet-namestore-gtk.1 b/doc/gnunet-namestore-gtk.1
new file mode 100644
index 00000000..4f024753
--- /dev/null
+++ b/doc/gnunet-namestore-gtk.1
@@ -0,0 +1,29 @@
1.TH GNUNET-NAMESTORE-GTK "1" "7 Oct 2013" "GNUnet"
2.SH NAME
3gnunet\-namestore\-gtk \- a gtk interface for editing GNS zones
4.SH SYNOPSIS
5.B gnunet\-namestore\-gtk
6[\fIOPTIONS\fR]
7.SH DESCRIPTION
8.PP
9gnunet\-namestore\-gtk is a gtk+ based GUI for editing zones in the GNU Name System. It should work just like your typical DNS zone editor. In addition, if built with libqrencode, it will display (and offer to export) a QR code image of the public key for the current zone.
10.TP
11\fB\-h\fR, \fB\-\-help\fR
12print help page
13.TP
14\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
15load config file (default: ~/.gnunet/gnunet.conf)
16.TP
17\fB\-t, \fB\-\-tray\fR
18start with main window minimized (only put icon in tray)
19.TP
20\fB\-v\fR, \fB\-\-version\fR
21print the version number
22.SH FILES
23.TP
24~/.gnunet/gnunet.conf
25User's GNUnet configuration file
26.SH "REPORTING BUGS"
27Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet-developers@gnu.org>
28.SH "SEE ALSO"
29\fBgnunet\-setup\fP(1)
diff --git a/doc/gnunet-setup.1 b/doc/gnunet-setup.1
index 90275bc6..9dddf77e 100644
--- a/doc/gnunet-setup.1
+++ b/doc/gnunet-setup.1
@@ -6,14 +6,12 @@ gnunet\-setup \- a gtk interface for configuring GNUnet
6[\fIOPTIONS\fR] 6[\fIOPTIONS\fR]
7.SH DESCRIPTION 7.SH DESCRIPTION
8.PP 8.PP
9gnunet\-setup is a gtk+ based GUI for configuring GNUnet. 9gnunet\-setup is a gtk+ based GUI for configuring GNUnet.
10 10
11The 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". 11The 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".
12 12
13It 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). 13It 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).
14 14
15After 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).
16
17.TP 15.TP
18\fB\-a\fR, \fB\-\-autoconfig\fR 16\fB\-a\fR, \fB\-\-autoconfig\fR
19try to automatically configure networking for the peer without starting the interactive GUI 17try to automatically configure networking for the peer without starting the interactive GUI
@@ -22,10 +20,7 @@ try to automatically configure networking for the peer without starting the inte
22load config file (default: ~/.gnunet/gnunet.conf) 20load config file (default: ~/.gnunet/gnunet.conf)
23.TP 21.TP
24\fB\-e, \fB\-\-elevate\-priviledges\fR 22\fB\-e, \fB\-\-elevate\-priviledges\fR
25Try 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. 23Try 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.
26.TP
27\fB\-f, \fB\-\-force\-full\-setup\fR
28Display all of the options for a peer even if a user "gnunet" exists but gnunet\-setup is not run as that user.
29.TP 24.TP
30\fB\-h\fR, \fB\-\-help\fR 25\fB\-h\fR, \fB\-\-help\fR
31print help page 26print help page