PYZORD(1)

πŸ‘‘ PYZORD(1) β€” User Commands, bestie edition πŸ’–

okay so welcome to PYZORD(1), a page for the User Commands girlies πŸ’… this is pyzord, and she is a spam-catcher using a collaborative filtering network. no cap.


🌸 NAME 🌸

pyzord β€” spam-catcher using a collaborative filtering network πŸ¦‹


✨ SYNOPSIS ✨

pyzord [options]

πŸ’– DESCRIPTION πŸ’–

Listen for and process incoming Pyzor connections. that's the whole vibe. she just sits there, ears perked up, catching those Pyzor connections as they roll in 🌈


πŸŽ€ OPTIONS πŸŽ€

  • -h, --help β€” show this help message and exit. the "wait what does this do again" button, we love her 🫢
  • -n NICE, --nice=NICE β€” the 'nice' level. yes it's in quotes, yes that's how the original said it, slay.
  • -d, --debug β€” enable debugging output. turn this on when you wanna see everything, main character energy πŸ”
  • --homedir=HOMEDIR β€” configuration directory. where all her little configs live πŸ’œ
  • -a LISTENADDRESS, --address=LISTENADDRESS β€” listen on this IP. pick your address, bestie πŸ“
  • -p PORT, --port=PORT β€” listen on this port. the door she's answering πŸšͺ
  • -e ENGINE, --database-engine=ENGINE β€” select database backend. choose your fighter βš”οΈ
  • --dsn=DIGESTDB β€” data source name (filename for gdbm, host,user,password,database,table for MySQL). so like, for gdbm it's just a filename, but for MySQL it's the whole host,user,password,database,table lineup. iconic πŸ“
  • --gevent=GEVENT β€” set to true to use the gevent library 🌱
  • --threads=THREADS β€” set to true if multi-threading should be used (this may not apply to all engines). heads up: not every engine plays along πŸ™ˆ
  • --max-threads=MAXTHREADS β€” the maximum number of concurrent threads (defaults to 0 which is unlimited). zero means go feral, no limit 🧚
  • --processes=PROCESSES β€” set to true if multi-processing should be used (this may not apply to all engines). same warning as threads, ngl πŸ’€
  • --max-processes=MAXPROCESSES β€” the maximum number of concurrent processes (defaults to 40). forty is the ceiling, periodt βœ‹
  • --db-connections=DBCONNECTIONS β€” the number of db connections that will be kept by the server. This only applies if threads are used. Defaults to 0 which means a new connection is used for every thread. (this may not apply all engines) πŸ”Œ
  • --pre-fork=PREFORK β€” (that's it, that's all the original said, so that's all I'm saying, we do not invent lore here bestie) πŸ’…
  • --password-file=PASSWDFILE β€” name of password file. keep it secret, keep it safe πŸ”
  • --access-file=ACCESSFILE β€” name of ACL file. who's allowed in the group chat, basically 🎟️
  • --cleanup-age=CLEANUPAGE β€” time before digests expire (in seconds). everything gets a shelf life, even digests ⏳
  • --log-file=LOGFILE β€” name of the log file πŸ““
  • --usage-log-file=USAGELOGFILE β€” name of the usage log file πŸ“Š
  • --pid-file=PIDFILE β€” save the pid in this file after the server is daemonized 🐣
  • --forward-client-homedir=FORWARDCLIENTHOMEDIR β€” Specify a pyzor client configuration directory to forward received digests to a remote pyzor server. so she catches 'em and then passes 'em along, like a good friend forwarding the tea β˜•
  • --detach=DETACH β€” daemonizes the server and redirects any output to the specified file. she leaves the room but leaves a note behind πŸ‘‹
  • -V, --version β€” print version and exit. quick vibe check on which version you got ⭐

okay real talk bestie: a couple of these options literally warn that they "may not apply to all engines" β€” that's not me being vague, that's the manual being vague. respect the ambiguity πŸ’–

🌈 SEE ALSO 🌈

(nothing else listed in the original, so nothing else here β€” we keep it 100 fr fr)


that's the whole page!! written for pyzord 1.0.0, dated June 2016 β€” yeah she's an elder, but she's still serving πŸ’œβœ¨ thanks for reading, mwah 🫢