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 privileges.
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.  DO  NOT  do
61              this very often, things can break badly!
62
63       SIGUSR1
64              Rewrite znc.conf. This is equivalent to /znc saveconfig
65

FILES

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

SEE ALSO

105       znc-buildmod(1)
106
107       Full documentation at: https://znc.in/
108
109
110
111ZNC                               2010-05-10                            ZNC(1)
Impressum