.TH ZNC 1 2010\-05\-10 ZNC
.SH NAME
znc \- An advanced IRC bouncer
.SH SYNOPSIS
.B znc \-\-help
.br
.B znc \-\-version
.br
.B znc \-\-makepass
.br
.B znc
.RB [ \-n ]
.RB [ \-d
.IR datadir ]
.RB [ \-D ]
.RB [ \-f ]
.br
.B znc
.RB [ \-n ]
.RB [ \-d
.IR datadir ]
.RB [ \-D ]
.RB [ \-f ]
.B \-\-makeconf
.br
.B znc
.RB [ \-n ]
.RB [ \-d
.IR datadir ]
.RB [ \-D ]
.RB [ \-f ]
.B \-\-makepem
.SH DESCRIPTION
.B znc
is an IRC proxy.
It runs as a daemon and connects to IRC server, then allows you to connect
from a workstation and work as the user that is logged in to the IRC
server.
After you disconnect, it maintains the connection to the server.
It acts like any normal IRC server, so you can use any IRC client to
connect to it.
.SH OPTIONS
.TP
.BR \-h ", " \-\-help
Output a brief help message.
.TP
.BR \-v ", " \-\-version
Show the full version number.
.TP
.BR \-n ", " \-\-no-color
Don't use any color escape sequences.
.TP
.BR \-f ", " \-\-foreground
Don't fork the ZNC process into the background.
.TP
.BR \-D ", " \-\-debug
Print debug output to the console. Implies
.BR --foreground .
.TP
.BI \-d " DATADIR" "\fR,\fP \-\-datadir=" DATADIR
Specify another datadir.
This is where
.B znc
saves everything.
.TP
.BR \-c ", " \-\-makeconf
Interactively create a new configuration.
.TP
.BR \-s ", " \-\-makepass
Hash a password for use in
.IR znc.conf .
.TP
.BR \-p ", " \-\-makepem
Generate
.IR znc.pem .
This is the server certificate
.B znc
uses.
You need this for SSL.
.TP
.BR \-r ", " \-\-allow-root
Don't complain if ZNC is run with root privileges.
.SH SIGNALS
This section explains how
.B znc
reacts to different signals:
.TP
.B SIGINT
Exit ZNC. This is equivalent to
.I /znc shutdown
.TP
.B SIGHUP
Reload znc.conf. This is equivalent to
.I /znc rehash.
.B DO NOT
do this very often, things can break badly!
.TP
.B SIGUSR1
Rewrite znc.conf. This is equivalent to
.I /znc saveconfig
.SH FILES
.TP
.I /usr/local/share/znc/
Static module data like webadmin skins
.TP
.I /usr/local/lib/znc/
.B znc
installs its modules to this directory.
.TP
.I /usr/local/include/znc/
These are the headers needed for compiling own modules.
.TP
.I ~/.znc
This is the default datadir. The following paths assume that you use this.
If you change this via
.I \-\-datadir
then the following lines are relative to that dir.
.TP
.I ~/.znc/znc.pem
This is the server certificate
.B znc
uses for listening on SSL ports.
You can generate this via
.I --makepem
and you may replace this with your own certificate, if you want to.
.TP
.I ~/.znc/modules/
If you compile your own modules, you can save them here.
.TP
.I ~/.znc/configs/znc.conf
This is the path to
.IR znc.conf .
Use
.I \-\-makeconf
for an easy way to generate it.
.TP
.IB ~/.znc/users/ USERNAME /
The data for every user is saved in this dir.
.B USERNAME
refers to the user name of that user.
.TP
.IB ~/.znc/users/ USERNAME /moddata/ MODULENAME /
This is where each module can save some stuff. This is mainly used
for remembering module settings that are not part of
.IR znc.conf .
.TP
.IB ~/.znc/moddata/ MODULENAME /
This is where global modules may save their settings.
.SH SEE ALSO
.BR znc-buildmod (1)
.PP
Full documentation at:
.I https://znc.in/