1ZNC(1)                      General Commands Manual                     ZNC(1)
2
3
4

NAME

6       znc - An advanced IRC bouncer
7

SYNOPSIS

9       znc --help
10       znc --version
11       znc --makepass
12       znc [-n] [-d datadir] [-D] [-f]
13       znc [-n] [-d datadir] [-D] [-f] --makeconf
14       znc [-n] [-d datadir] [-D] [-f] --makepem
15

DESCRIPTION

17       znc  is  an IRC proxy.  It runs as a daemon and connects to IRC server,
18       then allows you to connect from a workstation and work as the user that
19       is logged in to the IRC server.  After you disconnect, it maintains the
20       connection to the server.  It acts like any normal IRC server,  so  you
21       can use any IRC client to connect to it.
22

OPTIONS

24       -h, --help
25              Output a brief help message.
26
27       -v, --version
28              Show the full version number.
29
30       -n, --no-color
31              Don't use any color escape sequences.
32
33       -f, --foreground
34              Don't fork the ZNC process into the background.
35
36       -D, --debug
37              Print debug output to the console. Implies --foreground.
38
39       -d DATADIR, --datadir=DATADIR
40              Specify another datadir.  This is where znc saves everything.
41
42       -c, --makeconf
43              Interactively create a new configuration.
44
45       -s, --makepass
46              Hash a password for use in znc.conf.
47
48       -p, --makepem
49              Generate znc.pem.  This is the server certificate znc uses.  You
50              need this for SSL.
51
52       -r, --allow-root
53              Don't complain if ZNC is run with root privilegies.
54

SIGNALS

56       This section explains how znc reacts to different signals:
57
58       SIGINT Exit ZNC. This is equivalent to /znc shutdown
59
60       SIGHUP Reload znc.conf. This is equivalent to /znc rehash
61
62       SIGUSR1
63              Rewrite znc.conf. This is equivalent to /znc saveconfig
64

FILES

66       /usr/local/share/znc/
67              Static module data like webadmin skins
68
69       /usr/local/lib/znc/
70              znc installs its modules to this directory.
71
72       /usr/local/include/znc/
73              These are the headers needed for compiling own modules.
74
75       ~/.znc This is the default datadir. The following paths assume that you
76              use  this.   If you change this via --datadir then the following
77              lines are relative to that dir.
78
79       ~/.znc/znc.pem
80              This is the server certificate znc uses  for  listening  on  SSL
81              ports.   You can generate this via --makepem and you may replace
82              this with your own certificate, if you want to.
83
84       ~/.znc/modules/
85              If you compile your own modules, you can save them here.
86
87       ~/.znc/configs/znc.conf
88              This is the path to znc.conf.  Use --makeconf for an easy way to
89              generate it.
90
91       ~/.znc/users/USERNAME/
92              The  data  for every user is saved in this dir.  USERNAME refers
93              to the user name of that user.
94
95       ~/.znc/users/USERNAME/moddata/MODULENAME/
96              This is where each module can save some stuff.  This  is  mainly
97              used  for  remembering  module  settings  that  are  not part of
98              znc.conf.
99
100       ~/.znc/moddata/MODULENAME/
101              This is where global modules may save their settings.
102
103
104
105ZNC                               2010-05-10                            ZNC(1)