.TH "SBNC" "1"
.SH "NAME"
sbnc \- an modular IRC proxy.
.SH "SYNOPSIS"
\fBsbnc\fR
.SH "DESCRIPTION"
This manual page documents briefly the
\fBsbnc\fR commandline
parameters.
\fBsbnc\fR is an modular IRC proxy with extension support.
It gives you an easy control over about more than 2000 users.
You are able to use OpenSSL encrypted connections also like
connections about the IPv6 protocol.
\fBsbnc\fR comes with two modules. The bnctcl extension, which
gives your IRC proxy a powerful TCL scripting support and the
bncmysql extension, which stores all your users depend data in
an MySQL table.
.SH "BINARY PARAMETERS"
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
.TP
.B \-\-config
Location of the configuration directory.
.TP
.B \-\-data
Location of the data directory (defaults to the config directory).
.TP
.B \-\-foreground
Run in the foreground instead of a daemon.
.TP
.B \-\-help
Displays the help and exits.
.TP
.B \-\-log
Location of the log directory (defaults to the data directory
if given, else the config directory).
.TP
.B \-\-lpc
Don't start child processes.
.TP
.B \-\-pid
Location of the PID file (defaults to <data dir>/sbnc.pid).
.SH "FILES AND DIRECTORIES"
.TP
.B /etc/sbnc/
Configuration files for sbnc. The most
important configuration files are:
.RS
.br
.BI /etc/sbnc/sbnc.conf
.RE
.RS
.br
.BI /etc/sbnc/sbnc.ipc
.RE
.RS
.br
.BI /etc/sbnc/sbnc.tcl
.RS
.RE
.RE
.PP
.B /etc/default/sbnc
Default file of shroudBNC. You can decide
in this file, if shroudBNC should start on
boot time.
.br
.TP
.B /etc/logrotate.d/sbnc
Configuration for log rotating.
.br
.TP
.B /etc/init.d/sbnc
Start and stop script of shroudBNC.
.br
.TP
.B /usr/lib/sbnc/
Path for all libraries of shroudBNC. Also all
Tcl scripts from the sbnc\-tcl extension could
be found in the scripts subfolder.
.br
.TP
.B /etc/sbnc/users/
Path where all user depend data will be saved.
.br
.TP
.BI /var/log/sbnc/
Path where the logfiles of sbnc will be saved.
.br
.SH "AUTHOR"
This manual page was written by Patrick Matth\[:a]i <patrick.matthaei@web.de>
for sbnc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License, Version 2 any
later version published by the Free Software Foundation.