source: code/icbd.8@ 9a2a703

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

Add a logging switch toggle and a prefix for a nicer chroot

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