| 1 | .\"
|
|---|
| 2 | .\" Copyright (c) 2009 Mike Belopuhov
|
|---|
| 3 | .\"
|
|---|
| 4 | .\" Permission to use, copy, modify, and distribute this software for any
|
|---|
| 5 | .\" purpose with or without fee is hereby granted, provided that the above
|
|---|
| 6 | .\" copyright notice and this permission notice appear in all copies.
|
|---|
| 7 | .\"
|
|---|
| 8 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|---|
| 9 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|---|
| 10 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|---|
| 11 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|---|
| 12 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|---|
| 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|---|
| 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|---|
| 15 | .\"
|
|---|
| 16 | .Dd $Mdocdate: April 27 2009 $
|
|---|
| 17 | .Dt ICBD 8
|
|---|
| 18 | .Os
|
|---|
| 19 | .Sh NAME
|
|---|
| 20 | .Nm icbd
|
|---|
| 21 | .Nd "Internet Citizen's Band protocol daemon"
|
|---|
| 22 | .Sh SYNOPSIS
|
|---|
| 23 | .Nm icbd
|
|---|
| 24 | .Bk -words
|
|---|
| 25 | .Op Fl 46Cdnv
|
|---|
| 26 | .Oo
|
|---|
| 27 | .Fl G Ar group1 Ns Op , Ns Ar ...
|
|---|
| 28 | .Oc
|
|---|
| 29 | .Op Fl L Ar prefix
|
|---|
| 30 | .Op Fl M Ar modtab
|
|---|
| 31 | .Op Fl S Ar name
|
|---|
| 32 | .Sm off
|
|---|
| 33 | .Oo
|
|---|
| 34 | .Ar addr Op : Ns Ar port
|
|---|
| 35 | .Ar \ ...
|
|---|
| 36 | .Oc
|
|---|
| 37 | .Sm on
|
|---|
| 38 | .Ek
|
|---|
| 39 | .Sh DESCRIPTION
|
|---|
| 40 | .Nm
|
|---|
| 41 | is an Internet Citizen's Band
|
|---|
| 42 | .Pq ICB
|
|---|
| 43 | protocol daemon which allows peoples to chat online.
|
|---|
| 44 | .Pp
|
|---|
| 45 | Please refer to the document specified in the
|
|---|
| 46 | .Sx SEE ALSO
|
|---|
| 47 | section for more information about the ICB protocol.
|
|---|
| 48 | .Pp
|
|---|
| 49 | The options are as follows:
|
|---|
| 50 | .Bl -tag -width "-G group"
|
|---|
| 51 | .It Fl 4
|
|---|
| 52 | Bind to IPv4 addresses only.
|
|---|
| 53 | .It Fl 6
|
|---|
| 54 | Bind to IPv6 addresses only.
|
|---|
| 55 | .It Fl C
|
|---|
| 56 | Allow users to create groups.
|
|---|
| 57 | Please note, that everyone creating a new group becomes its moderator.
|
|---|
| 58 | .It Fl d
|
|---|
| 59 | Do not daemonize.
|
|---|
| 60 | If this option is specified,
|
|---|
| 61 | .Nm
|
|---|
| 62 | will run in the foreground and log to
|
|---|
| 63 | .Dv stderr .
|
|---|
| 64 | .It Fl G Xo
|
|---|
| 65 | .Ar group1 Ns Op , Ns Ar ...
|
|---|
| 66 | .Xc
|
|---|
| 67 | Instruct
|
|---|
| 68 | .Nm
|
|---|
| 69 | to create specified groups on startup.
|
|---|
| 70 | .It Fl L Ar prefix
|
|---|
| 71 | Enables logging of all public messages in all groups and specifies a
|
|---|
| 72 | directory inside the chroot that is owned and is writable by the
|
|---|
| 73 | .Nm
|
|---|
| 74 | user.
|
|---|
| 75 | The server will create subdirectories matching those of the group names
|
|---|
| 76 | and place log files inside one file per month.
|
|---|
| 77 | .It Fl M Ar modtab
|
|---|
| 78 | Specifies a moderator table that can be used to restrict users who
|
|---|
| 79 | can be granted with moderation of any group.
|
|---|
| 80 | The
|
|---|
| 81 | .Ar modtab
|
|---|
| 82 | file contains one nick per line; empty lines and lines starting with
|
|---|
| 83 | a hash symbol are ignored.
|
|---|
| 84 | It's located inside the chroot and read on startup and whenever a
|
|---|
| 85 | hangup signal is received.
|
|---|
| 86 | Every time a moderator check is performed,
|
|---|
| 87 | .Nm
|
|---|
| 88 | checks the modification time of the file and reloads the table if
|
|---|
| 89 | any changes have taken place since the last call.
|
|---|
| 90 | .It Fl n
|
|---|
| 91 | Disable DNS resolver.
|
|---|
| 92 | .It Fl S Ar name
|
|---|
| 93 | Set the server's name to
|
|---|
| 94 | .Ar name .
|
|---|
| 95 | .It Fl v
|
|---|
| 96 | Produce more verbose output.
|
|---|
| 97 | .El
|
|---|
| 98 | .Pp
|
|---|
| 99 | A list of addresses and/or ports to bind to is specified after all arguments.
|
|---|
| 100 | By default,
|
|---|
| 101 | .Nm
|
|---|
| 102 | will try to listen on all interfaces using
|
|---|
| 103 | .Em icb
|
|---|
| 104 | protocol port number specified in
|
|---|
| 105 | .Pa /etc/services .
|
|---|
| 106 | .Sh SEE ALSO
|
|---|
| 107 | .Rs
|
|---|
| 108 | .%T ICB Protocol
|
|---|
| 109 | .%U ftp://ftp.icb.net/pub/icb/src/icbd/Protocol.html
|
|---|
| 110 | .Re
|
|---|
| 111 | .Sh AUTHORS
|
|---|
| 112 | The
|
|---|
| 113 | .Nm
|
|---|
| 114 | program was written by Mike Belopuhov.
|
|---|
