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 "2007-11-18" "" "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 .SH OPTIONS
  44 .TP
  45 .B -d
  46 Normally, \fBhubmgr\fP will daemonize after it has connected and
  47 authenticated to the daemon successfully. Giving the -d option will
  48 cause it to continue running in the foreground instead.
  49 .TP
  50 .B -q
  51 Signals more quiet operation. Only error messages will be displayed.
  52 .TP
  53 .BI -s " server"
  54 Connect to \fIserver\fP instead of the default server.
  55 .SH FILES
  56 The configuration file for \fBhubmgr\fP is named ~/.hublist. It needs
  57 to be formatted as follows:
  58 .P
  59 The file format is line oriented. A line may be empty, causing it to
  60 be ignored. There is no syntax for comments. Each non-empty line will
  61 be divided into words, separated by spaces. Spaces within a word may
  62 be quoted by enclosing the word in citation marks. The first word on
  63 each line is the protocol the hub uses. Currently, only the \fBdc\fP
  64 protocol is supported, signalling a normal Direct Connect hub. The
  65 second word is the address to the hub, using either a domain name or
  66 an IP address, followed by a colon, followed by the port number of the
  67 hub. The port number must always be specified.
  68 .P
  69 After the protocol and address words, an arbitrary number of optional
  70 arguments may follow, to specify such things as the nickname to use,
  71 or a password to supply to the hub. An argument is two words; one word
  72 to specify what argument it is, and another for the actual value. The
  73 following arguments are currently available:
  74 .TP
  75 .BI nick " nickname"
  76 Use \fInickname\fP instead of the server-wide default nickname when
  77 connecting to the hub.
  78 .TP
  79 .BI password " password"
  80 If the hub requests a password when connecting, use the given
  81 \fIpassword\fP for that purpose.
  82 .TP
  83 .BI charset " charset"
  84 Use the given charset when communicating with the hub. If this
  85 argument is not given, the Microsoft CP1252 charset will be used. Most
  86 hubs will expect the default charset. This option is somewhat
  87 experimental, and, due to the inherent non-internationalized nature of
  88 the Direct Connect protocol, may not work quite as one would expect.
  89 .TP
  90 .BI dcppemu " emulation"
  91 Override the \fBdc.dcppemu\fP option configured in the daemon for this
  92 specific hub, if \fIemulation\fP is \fBy\fP or \fBn\fP. See the
  93 \fBdoldacond.conf\fP(5) manual page for further information about
  94 \fBdc.dcppemu\fP.
  95 .SS Examples
  96 The following example, if copied into the ~/.hublist file, will
  97 connect to three hubs. The first one will be connected to normally,
  98 without any special processing. The second one requires a
  99 password. The third one requires both a special nickname and a
 100 password, which contains a space.
 101 .P
 102 .nf
 103 dc hub1.somenet.org:411
 104 dc dc.someother.net:555 password s3cr3t
 105 dc a.thirdnet.com:411 nick Cooldude password "Very Secret"
 106 .fi
 107 .SH AUTHOR
 108 Fredrik Tolf <fredrik@dolda2000.com>
 109 .SH SEE ALSO
 110 \fBdoldacond.conf\fP(5), \fBdoldacond\fP(8)