SCROLLZ(1)

πŸ’– SCROLLZ(1) πŸ’– β€” like, the manual page but make it make sense

okay bestie, sit down, hydrate, and let me tell you about ScrollZ β€” an advanced ircII-based IRC client ✨ this is from the General Commands Manual, and yes it's giving very much "your weird older cousin who runs an IRC bouncer" energy, but honestly? iconic. πŸŽ€


✨ SYNOPSIS ✨

scrollz [-4] [-6] [-c chan] [-p portno] [-f] [-F] [-h host] [-H host]
[-C name] [-s] [-S] [-n] [-d] [-q] [-a] [-b] [-l file] [-I file] [-L
file] [nickname] [serverlist]

that's the whole vibe in one breathless run-on, no notes πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

ScrollZ is an advanced IRC client based on ircII code. the way that it literally just takes all the features you'd normally have to dig through ircII scripts for and bakes them straight in?? obsessed. 😭

the main character difference between those scripts and ScrollZ is the code itself. like, ircII scripts eat up a ton of disk and memory space and run slow β€” ScrollZ only takes a couple of extra kilobytes compared to a stock ircII client, yet runs faster than any ircII script. how?? they did it by using C code instead of the ircII scripting language. this reduces memory and CPU usage and code tends to run faster. periodt. πŸ’…

ScrollZ includes features such as a built-in userlist, shitlist, improved scripting, Blowfish based encryption, features for IRC operators, and user friendly features such as completion for nicks and channels. it's giving "swiss army knife but it's an IRC client" 🫢


🌸 OPTIONS 🌸

  • -4 β€” use IPv4 protocol when connecting to a server.
  • -6 β€” use IPv6 protocol when connecting to a server.
  • -c channel β€” joins channel on startup. instant main character energy, you're already in the room bestie πŸšͺ✨
  • -p port β€” default server connection port (usually 6667).
  • -f β€” your terminal uses flow controls (^S/^Q), so ScrollZ shouldn't. (yes that's the whole sentence, no cap.)
  • -F β€” your terminal doesn't use flow control (this is the default).
  • -h, -H host β€” use host as source address (for virtual hosting). two flags, one job, we love a duo 🫢
  • -C name β€” cloak process as name. sneaky little incognito moment πŸ™ˆ
  • -S/-s β€” do/don't use separate server processes (ircio). pick your fighter πŸ₯Š
  • -n β€” do not connect to a server on startup. just vibing, not talking to anyone yet, very relatable πŸ’€
  • -d β€” runs ScrollZ in "dumb" terminal mode.
  • -q β€” does not load .scrollzrc or .scrollzquick. raw-dogging the config, bold move πŸ”₯
  • -a β€” adds default servers and command line servers to server list.
  • -b β€” load .scrollzrc before connecting to a server.
  • -l file β€” loads file in place of your .scrollzrc.
  • -I file β€” loads file in place of your .scrollzquick.
  • -L file β€” loads file in place of your .scrollzrc and expands $ expandos. fancy ✨
  • --help β€” show summary of options. when in doubt, ask for help, we support that πŸŽ€

🌈 ENVIRONMENT 🌈

the env vars, bestie β€” they run the whole show behind the scenes:

  • DCCHOST β€” the hostname to use for the DCC file transfer.
  • HOME β€” set home directory (overrides your home directory in /etc/passwd).
  • IRCHOST β€” the hostname to use.
  • IRCNAME β€” the realname to use (defaults to the /etc/passwd real name field).
  • IRCLIB β€” the path for ScrollZ helpfiles/scripts/translations/docs (defaults to /usr/share/scrollz).
  • IRCNICK β€” the nickname to use (defaults to your username).
  • IRCPATH β€” the path for loading files (defaults to ~/.ScrollZ:/usr/share/scrollz/script:.).
  • IRCRC β€” the initalization file to use (defaults to ~/.scrollzrc). (yes, "initalization" β€” that's the original spelling, we keep the lore intact πŸ’œ)
  • IRCSERVER β€” the IRC server(s) to use.
  • IRCUMODE β€” the user mode to use.
  • IRCUSER β€” the username to use (defaults to your username).
  • MAIL β€” set mail file.
  • TERM β€” the terminal type to use.

πŸŽ€ FILES πŸŽ€

  • /usr/share/scrollz/script/szglobal β€” the global initialization file loaded when connection to a server is established.
  • ~/.scrollzrc β€” the personal initialization file loaded when connection to a server is established.
  • ~/.scrollzquick β€” the personal initialization file loaded when connection to a server is initiated.

(spot the difference: established vs initiated. ScrollZ said "read carefully bestie" πŸ“–βœ¨)


πŸ’€ NOTES πŸ’€

  • the nickname is limited to 9 characters on many IRC networks. nine. that's it. choose wisely 🫠
  • the server list is a whitespace-separated list of server names.
  • > ScrollZ does NOT have the ICB support nor the DCC TALK support that are available in ircII. like, gone. not there. don't go looking for them πŸ’€

πŸ‘‘ AUTHORS πŸ‘‘

this manual page was written by Mike Markley <mike@markley.org>, for the Debian GNU/Linux system (but may be used by others). updated for ScrollZ by Flier <flier@scrollz.org> (the ScrollZ maintainer). icons, both of them 🫢


πŸ”₯ BUG REPORTS πŸ”₯

if you find a bug in ScrollZ you should report it. but first, you should make sure that it really is a bug, and that it appears in the latest version of ScrollZ. (we're not doing "have you tried turning it off and on again" energy, we're doing "have you tried reproducing it on the newest build" energy ✨)

once you have determined that a bug actually exists, report the bug in channel #ScrollZ on Efnet. if you have a fix, you are encouraged to provide that as well! bring the fix, we love a fix 🫢

ALL bug reports should include:

  1. the version number of ScrollZ
  2. the hardware and operating system
  3. the compiler used to compile
  4. a description of the bug behaviour
  5. a short script or recipe which exercises the bug

and that's the whole page bestie!! this one's from way back β€” July 11, 2001 β€” and it's the ScrollZ(1) page from the General Commands Manual, source/version ScrollZ, dated July 11, 2001. vintage but still slaying πŸ’…πŸ’–βœ¨

πŸ“¦ where this page comes from