From: Fredrik Tolf <fredrik@dolda2000.com>
Date: Sun, 30 Sep 2007 01:20:34 +0000 (+0200)
Subject: Added manpage for dolcon.
X-Git-Tag: 1.0~33^2~1
X-Git-Url: http://git.dolda2000.com/gitweb/?a=commitdiff_plain;h=4e38a36ebdfaf9d928f08dba7a0d68a844ae7f29;p=doldaconnect.git

Added manpage for dolcon.
---

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index e50bfd3..8a09040 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,5 +1,9 @@
+man_MANS =
 if DAEMON
-man_MANS = doldacond.conf.5 doldacond.8
+man_MANS += doldacond.conf.5 doldacond.8
+endif
+if CLI_GTK2
+man_MANS += dolcon.1
 endif
 BUILT_SOURCES = doldacond.conf.5
 
diff --git a/doc/man/dolcon.1 b/doc/man/dolcon.1
new file mode 100644
index 0000000..d75d6bb
--- /dev/null
+++ b/doc/man/dolcon.1
@@ -0,0 +1,54 @@
+.\"
+.\" Copyright (C) 2007 Fredrik Tolf <fredrik@dolda2000.com>
+.\"
+.\" This is free documentation; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2 of
+.\" the License, or (at your option) any later version.
+.\"
+.\" The GNU General Public License's references to "object code"
+.\" and "executables" are to be interpreted as the output of any
+.\" document formatting or typesetting system, including
+.\" intermediate and printed output.
+.\"
+.\" This manual is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public
+.\" License along with this manual; if not, write to the Free
+.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
+.\" USA.
+.\"
+.TH DOLCON 1 "2007-09-30" "" "Dolda Connect manual"
+.SH NAME
+dolcon \- Graphical user interface for Dolda Connect
+.SH SYNOPSIS
+.B dolcon
+[ \fB-hl\fP ]
+.SH DESCRIPTION
+The \fBdolcon\fP program runs a graphical user interface for Dolda
+Connect. It controls the \fBdoldacond\fP(8) daemon, which is the
+program doing all the actual work (consequently, \fBdoldacond\fP must
+be running to use \fBdolcon\fP). The high-level operations currently
+supported by \fBdolcon\fP include connecting to hubs, chatting on
+hubs, searching for files and request to download them, watching the
+status of currently ongoing file transfers.
+.SH OPTIONS
+.TP
+.B -h
+Displays a brief usage message on stdout and exits.
+.TP
+.B -l
+Directly on startup, automatically connect to the doldacond server
+running locally on the machine (that is, via a Unix socket). This
+option is primarily intended for use by the GUI shell of Dolda
+Connect.
+.SH FILES
+Configuration options for \fBdolcon\fP will be stored in the files
+~/.dolconrc. It is saved when the program exits normally.
+.SH AUTHOR
+Fredrik Tolf <fredrik@dolda2000.com>
+.SH SEE ALSO
+\fBdoldacond\fP(8)
diff --git a/doc/man/doldacond.8 b/doc/man/doldacond.8
index 8619a0c..ecc15b4 100644
--- a/doc/man/doldacond.8
+++ b/doc/man/doldacond.8
@@ -21,7 +21,7 @@
 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
 .\" USA.
 .\"
-.TH DOLDACOND 8 "2007-04-11" "" "Dolda Connect manual"
+.TH DOLDACOND 8 "2007-09-30" "" "Dolda Connect manual"
 .SH NAME
 doldacond \- Dolda Connect daemon
 .SH SYNOPSIS
@@ -31,9 +31,9 @@ doldacond \- Dolda Connect daemon
 .SH DESCRIPTION
 The \fBdoldacond\fP program is the primary part of the collection of
 software that makes up Dolda Connect. It runs in the background and
-carries out all the actual work of filesharing. Other programs connect
-to \fBdoldacond\fP over a socket in order to command it and/or display
-its status to a user.
+carries out all the actual work of filesharing. Other programs, such
+as \fBdolcon\fP(1), connect to \fBdoldacond\fP over a socket in order
+to command it and/or display its status to a user.
 .P
 The configuration of \fBdoldacond\fP is controlled via the
 \fBdoldacond.conf\fP(5) file, which is described in detail in its own
@@ -138,4 +138,4 @@ job is actually running, though.
 .SH AUTHOR
 Fredrik Tolf <fredrik@dolda2000.com>
 .SH SEE ALSO
-\fBdoldacond.conf\fP(5)
+\fBdoldacond.conf\fP(5), \fBdolcon\fP(1)