source: code/icbd.8@ d488e1b

Last change on this file since d488e1b was d488e1b, checked in by Mike Belopuhov <mike@…>, 11 years ago

Document -M modtab

  • Property mode set to 100644
File size: 2.4 KB
Line 
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 46Cdv
26.Oo
27.Fl G Ar group1 Ns Op , Ns Ar ...
28.Oc
29.Op Fl M Ar modtab
30.Op Fl S Ar name
31.Sm off
32.Oo
33.Ar addr Op : Ns Ar port
34.Ar \ ...
35.Oc
36.Sm on
37.Ek
38.Sh DESCRIPTION
39.Nm
40is a Internet Citizen's Band
41.Pq ICB
42protocol daemon which allows peoples to chat online.
43.Pp
44Please refer to the document specified in the
45.Sx SEE ALSO
46section for more information about the ICB protocol.
47.Pp
48The options are as follows:
49.Bl -tag -width "-G group"
50.It Fl 4
51Bind to IPv4 addresses only.
52.It Fl 6
53Bind to IPv6 addresses only.
54.It Fl C
55Allow users to create groups.
56Please note, that everyone creating a new group becomes its moderator.
57.It Fl d
58Do not daemonize.
59If this option is specified,
60.Nm
61will run in the foreground and log to
62.Em stderr .
63.It Fl G Xo
64.Ar group1 Ns Op , Ns Ar ...
65.Xc
66Instruct
67.Nm
68to create specified groups at startup.
69.It Fl M Ar modtab
70Specifies a moderator table that can be used to restrict users who
71can be granted with moderation of any group.
72.Ar modtab
73file contains one nick per line; empty lines and lines starting with
74a hash symbol are ignored.
75.It Fl S Ar name
76Set the server's name to
77.Ar name .
78.It Fl v
79Produce more verbose output.
80.El
81.Pp
82A list of addresses and/or ports to bind to is specified after all arguments.
83By default,
84.Nm
85will try to listen on all interfaces using
86.Em icb
87protocol port number specified in
88.Em /etc/services .
89.Sh SEE ALSO
90.Rs
91.%R ftp://ftp.icb.net/pub/icb/src/icbd/Protocol.html
92.%T ICB Protocol
93.Re
94.Sh AUTHORS
95The
96.Nm
97program was written by Mike Belopuhov.
Note: See TracBrowser for help on using the repository browser.