ZNC(1)

💖 ZNC — the manual page, but make it slay 💖

okay bestie, welcome to the znc(1) page. yes it's a General Commands Manual, yes it's from the ZNC crew, and yes we're gonna get through all of it together. grab a snack 🍓

✨ NAME ✨

znc — an advanced IRC bouncer. that's the whole vibe. 💅

🌈 SYNOPSIS 🌈

znc --help
znc --version
znc --makepass
znc [-n] [-d datadir] [-D] [-f]
znc [-n] [-d datadir] [-D] [-f] --makeconf
znc [-n] [-d datadir] [-D] [-f] --makepem

🦋 DESCRIPTION 🦋

so znc is an IRC proxy, right? it runs as a daemon, connects out to an IRC server, and then — this is the iconic part — it lets you connect from your workstation and work as the user that's logged in to the IRC server. 👑

you disconnect? doesn't matter. it keeps the connection to the server alive for you. it acts like any normal IRC server, so literally any IRC client you want can connect to it. main character energy fr fr.

🎀 OPTIONS 🎀

• -h, --help — spits out a brief help message. short, sweet, helpful. 🫶
• -v, --version — shows the full version number. no guessing.
• -n, --no-color — don't use any color escape sequences. (sad, but sometimes necessary 😭)
• -f, --foreground — don't fork the ZNC process into the background. it stays right there with you.
• -D, --debug — print debug output to the console. this one implies --foreground, so heads up.
• -d DATADIR, --datadir=DATADIR — specify another datadir. this is where znc saves everything, so pick wisely. 🗂️
• -c, --makeconf — interactively create a new configuration. it walks you through it, very demure.
• -s, --makepass — hash a password for use in znc.conf. 🔐
• -p, --makepem — generate znc.pem. this is the server certificate znc uses, and you need this for SSL. no pem, no SSL, periodt.
• -r, --allow-root — don't complain if ZNC is run with root privileges.

💀 SIGNALS 💀

okay so this section explains how znc reacts to different signals:

• SIGINT — Exit ZNC. this is equivalent to /znc shutdown.
• SIGHUP — Reload znc.conf. this is equivalent to /znc rehash. > ⚠️ DO NOT do this very often, things can break badly! like, badly badly. 😭
• SIGUSR1 — Rewrite znc.conf. this is equivalent to /znc saveconfig.

🌸 FILES 🌸

• /usr/local/share/znc/ — static module data like webadmin skins. ✨
• /usr/local/lib/znc/ — znc installs its modules to this directory.
• /usr/local/include/znc/ — these are the headers needed for compiling own modules.
• ~/.znc — this is the default datadir. the following paths assume that you use this. if you change this via --datadir then the following lines are relative to that dir.
• ~/.znc/znc.pem — this is the server certificate znc uses for listening on SSL ports. you can generate this via --makepem, and you may replace this with your own certificate, if you want to. 💅
• ~/.znc/modules/ — if you compile your own modules, you can save them here.
• ~/.znc/configs/znc.conf — this is the path to znc.conf. use --makeconf for an easy way to generate it.
• ~/.znc/users/USERNAME/ — the data for every user is saved in this dir. USERNAME refers to the user name of that user.
• ~/.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 znc.conf.
• ~/.znc/moddata/MODULENAME/ — this is where global modules may save their settings.

👑 SEE ALSO 👑

• znc-buildmod(1)
• Full documentation at: https://znc.in/

and that's the whole page, bestie 🫶 this one's from the ZNC crew, dated 2010-05-10 — yeah, it's been iconic for a minute — and it lives in section 1 of the manual as ZNC(1). go forth and bounce those IRC connections. 💖✨🎀