[GNUnet-SVN] r1954 - GNUnet/doc/man

[grothoff]

Author: grothoff
Date: 2005-08-27 00:00:00 -0700 (Sat, 27 Aug 2005)
New Revision: 1954

Added:
   GNUnet/doc/man/gnunet-setup.1
Modified:
   GNUnet/doc/man/Makefile.am
   GNUnet/doc/man/gnunetd.1
Log:
man

Modified: GNUnet/doc/man/Makefile.am
===================================================================
--- GNUnet/doc/man/Makefile.am  2005-08-27 06:18:34 UTC (rev 1953)
+++ GNUnet/doc/man/Makefile.am  2005-08-27 07:00:00 UTC (rev 1954)
@@ -8,6 +8,7 @@
 gnunet-download.1 \
 gnunet-insert.1 \
 gnunet-search.1 \
+gnunet-setup.1 \
 gnunet-stats.1 \
 gnunet-tbench.1 \
 gnunet-testbed.1 \

Added: GNUnet/doc/man/gnunet-setup.1
===================================================================
--- GNUnet/doc/man/gnunet-setup.1       2005-08-27 06:18:34 UTC (rev 1953)
+++ GNUnet/doc/man/gnunet-setup.1       2005-08-27 07:00:00 UTC (rev 1954)
@@ -0,0 +1,42 @@
+.TH GNUNET-SETUP "1" "27 Aug 2005" "GNUnet"
+.SH NAME
+gnunet\-setup \- configuring GNUnet
+.SH SYNOPSIS
+.B gnunet-setup
+[\fIOPTIONS\fR] MODE
+.SH DESCRIPTION
+.PP
+gnunet\-setup can be used to generate and edit the configuration files 
(gnunetd.conf and gnunet.conf) for GNUnet.  gnunet\-setup runs in two basic 
modes, one for editing gnunet.conf and one for editing gnunetd.conf.  Depending 
on which libraries were available when gnunet\-setup was build, gnunet\-setup 
will have a curses or GTK user interface.  A text\-only interface is always 
available.  For a quick initial configuration gnunet\-setup offers a wizard 
(curses or GTK only) that can be used to quickly generate a working 
gnunetd.conf file.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
+specify location of the configuration file (default: /etc/gnunetd.conf or 
~/.gnunet/gnunet.conf, depending on the mode)
+.TP
+\fB\-d\fR, \fB\-\-daemon\fR
+generate configuration for gnunetd (gnunetd.conf).  If run without this 
option, gnunet\-setup will generate a configuration for GNUnet clients.
+.TP
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
+change the loglevel. Possible values for LOGLEVEL are NOTHING, FATAL, ERROR, 
FAILURE, WARNING, MESSAGE, INFO, DEBUG, CRON and EVERYTHING..TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+be verbose
+.TP
+.SH NOTES
+Before you can use any GNUnet application you must run gnunet\-setup to 
generate the configuration.  First, run gnunet\-setup with the \-d option to 
generate a configuration for gnunetd.  Later, each user of the system should 
run gnunet\-setup without \-d to generate his personal configuration.
+.TP
+Depending on your system, gnunet\-setup will have a subset of the following 
modes: config (text), menuconfig (curses), gconfig (GTK), wizard-curses (curses 
wizard) and wizard\-gtk (GTK wizard).  The wizards can currently only be used 
in conjunction with the \-d option to configure gnunetd.
+.SH FILES
+.TP
+/etc/gnunetd.conf
+gnunetd configuration file (default location).
+.TP
+~/.gnunet/gnunet.conf
+client configuration file (default location).
+.SH "REPORTING BUGS"
+Report bugs by using mantis <https://gnunet.org/mantis/> or by sending 
electronic mail to <address@hidden>
+.SH "SEE ALSO"
+\fBgnunetd\fP(1), \fBgnunet\-update\fP(1), \fBgnunetd.conf\fP(5), 
\fBgnunet.conf\fP(5)

Modified: GNUnet/doc/man/gnunetd.1
===================================================================
--- GNUnet/doc/man/gnunetd.1    2005-08-27 06:18:34 UTC (rev 1953)
+++ GNUnet/doc/man/gnunetd.1    2005-08-27 07:00:00 UTC (rev 1954)
@@ -18,7 +18,7 @@
 print the version number
 .TP
 \fB\-d\fR, \fB\-\-debug\fR
-do not detach from the console (for debugging); log messages are written to 
stderr instead of the logfile in -d mode.
+do not detach from the console (for debugging); log messages are written to 
stderr instead of the logfile in \-d mode.
 .TP
 \fB\-u \fIUSER\fR, \fB\-\-user=USER\fR
 run as user USER (and if available as group USER). Note that to use this 
option, you will probably have to start gnunetd as
@@ -28,7 +28,7 @@
 change the loglevel. Possible values for LOGLEVEL are NOTHING, FATAL, ERROR, 
FAILURE, WARNING, MESSAGE, INFO, DEBUG, CRON and EVERYTHING.
 .SH NOTES
 Before you can share, search or download files from GNUnet you must start the 
GNUnet server, gnunetd.
-If you start gnunetd as root (which is not required), you can use the -u 
option such that GNUnet runs as a different user. If a group of the same name 
exists, GNUnet will also change to that group. If GNUnet cannot change its UID 
to USER or GID to USER, a warning will be printed and gnunetd will *continue* 
with the rights of the user that invoked gnunetd.
+If you start gnunetd as root (which is not required), you can use the \-u 
option such that GNUnet runs as a different user. If a group of the same name 
exists, GNUnet will also change to that group. If GNUnet cannot change its UID 
to USER or GID to USER, a warning will be printed and gnunetd will *continue* 
with the rights of the user that invoked gnunetd.
 .SH FILES
 .TP
 /etc/gnunet.conf
@@ -46,6 +46,6 @@
 /var/lib/GNUnet/data/credit/
 Trust directory.  GNUnet stores economic information about other nodes here, 
in particular how much useful data we have received from which remote node.
 .SH "REPORTING BUGS"
-Report bugs by using mantis <https://gnunet.org/mantis/> or by sending 
electronic mail to <address@hidden>
+Report bugs by using mantis <https://gnunet.org/mantis/> or by sending 
electronic mail to <address@hidden>
 .SH "SEE ALSO"
 \fBgnunet\-gtk\fP(1), \fBgnunet\-insert\fP(1), \fBgnunet\-search\fP(1), 
\fBgnunet\-download\fP(1), \fBgnunetd.conf\fP(5), \fBgnunetd\fP(1)