doc/man/hubmgr.1

   1 .\"
   2 .\" Copyright (C) 2007 Fredrik Tolf <fredrik@dolda2000.com>
   3 .\"
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\"
   9 .\" The GNU General Public License's references to "object code"
  10 .\" and "executables" are to be interpreted as the output of any
  11 .\" document formatting or typesetting system, including
  12 .\" intermediate and printed output.
  13 .\"
  14 .\" This manual is distributed in the hope that it will be useful,
  15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 .\" GNU General Public License for more details.
  18 .\"
  19 .\" You should have received a copy of the GNU General Public
  20 .\" License along with this manual; if not, write to the Free
  21 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  22 .\" USA.
  23 .\"
  24 .TH HUBMGR 1 "2008-03-03" "" "Dolda Connect manual"
  25 .SH NAME
  26 hubmgr \- Automatic hub manager for Dolda Connect
  27 .SH SYNOPSIS
  28 .B hubmgr
  29 [ \fB-dq\fP ] [ \fB-s\fP \fIserver\fP ]
  30 .SH DESCRIPTION
  31 The \fBhubmgr\fP program will read a list of Direct Connect hubs, and
  32 try to ensure that they are connected to at all times. That involves
  33 both connecting to them initially, and reconnecting to them, should
  34 they later disconnect for any reason. If a hub is unreachable,
  35 \fBhubmgr\fP will keep trying to connect to it in intervals until
  36 successful.
  37 .P
  38 \fBhubmgr\fP handles the SIGINT, SIGHUP and SIGTERM signals and exit
  39 upon receipt of either one of them. It will also listen for messages
  40 on the name \fBhubmgr\fP and exit if it receives a message with the
  41 first token being \fBexit\fP. Upon exit, it will disconnect all
  42 managed hubs.
  43 .P
  44 \fBhubmgr\fP will check its configuration file (which is described
  45 below in the FILES section) for updates on a regular basis. If the
  46 file has changed, it will be reread and \fBhubmgr\fP will connect to
  47 any new hubs encountered, as well as disconnect from hubs that have
  48 been removed from the file.
  49 .SH OPTIONS
  50 .TP
  51 .B -d
  52 Normally, \fBhubmgr\fP will daemonize after it has connected and
  53 authenticated to the daemon successfully. Giving the -d option will
  54 cause it to continue running in the foreground instead.
  55 .TP
  56 .B -q
  57 Signals more quiet operation. Only error messages will be displayed.
  58 .TP
  59 .BI -s " server"
  60 Connect to \fIserver\fP instead of the default server.
  61 .SH FILES
  62 The configuration file for \fBhubmgr\fP is named ~/.hublist. It needs
  63 to be formatted as follows:
  64 .P
  65 The file format is line oriented. A line may be empty, causing it to
  66 be ignored. There is no syntax for comments. Each non-empty line will
  67 be divided into words, separated by spaces. Spaces within a word may
  68 be quoted by enclosing the word in citation marks. The first word on
  69 each line is the protocol the hub uses. Currently, only the \fBdc\fP
  70 protocol is supported, signalling a normal Direct Connect hub. The
  71 second word is the address to the hub, using either a domain name or
  72 an IP address, followed by a colon, followed by the port number of the
  73 hub. The port number must always be specified.
  74 .P
  75 After the protocol and address words, an arbitrary number of optional
  76 arguments may follow, to specify such things as the nickname to use,
  77 or a password to supply to the hub. An argument is two words; one word
  78 to specify what argument it is, and another for the actual value. The
  79 following arguments are currently available:
  80 .TP
  81 .BI nick " nickname"
  82 Use \fInickname\fP instead of the server-wide default nickname when
  83 connecting to the hub.
  84 .TP
  85 .BI password " password"
  86 If the hub requests a password when connecting, use the given
  87 \fIpassword\fP for that purpose.
  88 .TP
  89 .BI charset " charset"
  90 Use the given charset when communicating with the hub. If this
  91 argument is not given, the Microsoft CP1252 charset will be used. Most
  92 hubs will expect the default charset. This option is somewhat
  93 experimental, and, due to the inherent non-internationalized nature of
  94 the Direct Connect protocol, may not work quite as one would expect.
  95 .TP
  96 .BI dcppemu " emulation"
  97 Override the \fBdc.dcppemu\fP option configured in the daemon for this
  98 specific hub, if \fIemulation\fP is \fBy\fP or \fBn\fP. See the
  99 \fBdoldacond.conf\fP(5) manual page for further information about
 100 \fBdc.dcppemu\fP.
 101 .SS Examples
 102 The following example, if copied into the ~/.hublist file, will
 103 connect to three hubs. The first one will be connected to normally,
 104 without any special processing. The second one requires a
 105 password. The third one requires both a special nickname and a
 106 password, which contains a space.
 107 .P
 108 .nf
 109 dc hub1.somenet.org:411
 110 dc dc.someother.net:555 password s3cr3t
 111 dc a.thirdnet.com:411 nick Cooldude password "Very Secret"
 112 .fi
 113 .SH AUTHOR
 114 Fredrik Tolf <fredrik@dolda2000.com>
 115 .SH SEE ALSO
 116 \fBdoldacond.conf\fP(5), \fBdoldacond\fP(8)