CLAMONACC(8)

✨ clamonacc β€” the Clam On-Access Scanner, bestie edition ✨

okay so real talk, this is the clamonacc(8) manual page from the Clam On-Access Scanner gang, and it's literally the antivirus bouncer that lives at your front door. let's get into it πŸ’…


🌸 NAME 🌸

clamonacc β€” an anti-virus on-access scanning daemon and clamd client. yes she's both. multitasking queen πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

clamonacc [options]

that's it. that's the whole vibe. options only, no positional args, she doesn't want your random extra words πŸ™ˆ


πŸ’– DESCRIPTION πŸ’–

so the clamonacc daemon signs up for file access notifications from the Linux kernel, and every time one of those notifications comes in, she submits scans to the clamd scanning daemon and waits for a verdict. that's the whole loop. it's giving security guard energy 🫢

On-Access is only available on Linux systems. not negotiable, not a suggestion. Linux only. periodt.

and on Linux, On-Access needs a kernel version >= 3.8. why? because it leverages a kernel api called fanotify to block processes from attempting to access malicious files. the blocking happens in kernel-space, which means it's stronger protection than a purely user-space solution could ever be. no cap, kernel-space is just built different πŸ”₯


✨ OPTIONS ✨

  • -h, --help β€” outputs the help info and dips. that's it, that's the job πŸ’«
  • -V, --version β€” prints the version number and exits.
  • -v, --verbose β€” be verbose. give us the details, bestie.
  • -l FILE, --log=FILE β€” saves the scan report to FILE.
  • -F, --foreground β€” runs in the foreground; does not daemonize. she stays right there with you, in the group chat, not lurking in the background.
  • -W FILE, --watch-list=FILE β€” watches the directories listed in FILE πŸ‘€
  • -e FILE, --exclude-list=FILE β€” excludes the directories listed in FILE. not invited to the party, sorry.
  • -p A[:I], --ping A[:I] β€” pings clamd up to [A] times, at an optional interval [I], until it responds. patient and persistent.
  • -w, --wait β€” waits up to 30 seconds for clamd to start. optionally use this alongside ping to set the attempts [A] and interval [I] for checking on clamd. she'll wait for you, but only 30 seconds. she's not that down bad 😭
  • --remove β€” removes infected files. > ⚠️ be careful. for real. that's the entire warning. be careful. files do not come back. πŸ’€
  • --move=DIRECTORY β€” moves infected files into DIRECTORY.
  • --copy=DIRECTORY β€” copies infected files into DIRECTORY.
  • -c FILE, --config-file=FILE β€” reads configuration from FILE.
  • --allmatch β€” keeps scanning within the file after finding a match. no early exit, she's thorough πŸ’…
  • --fdpass β€” passes the file descriptor permissions to clamd. this is useful if clamd is running as a different user, since it's faster than streaming the file to clamd. only available if connected to clamd via local (unix) socket. (iykyk)
  • --stream β€” forces file streaming to clamd. generally you do not need this, because clamdscan detects automatically if streaming is required. this option only exists for debugging and testing purposes, and in all other cases --fdpass is preferred. it's giving "legacy option we keep around for science" 🧚

πŸŽ€ SIGNALS πŸŽ€

ClamOnAcc recognizes the following signals, and honestly she responds to all of them:

  • SIGHUP β€” reopens the logfile. fresh page, new era ✨
  • SIGUSR2 β€” reloads the signature databases. glow-up moment.
  • SIGTERM β€” performs a clean exit. leaving the party politely, no drama, closing the door gently 🫢

🌈 FILES 🌈

  • /etc/clamav/clamd.conf

⭐ CREDITS ⭐

please check the full documentation for credits. the whole squad is in there, we're not listing them twice πŸ’œ


πŸ‘‘ AUTHOR πŸ‘‘

Tomasz Kojm <tkojm@clamav.net> β€” icon, legend, the moment.


πŸ’œ SEE ALSO πŸ’œ


okay bestie that's the whole page, you ate it, no crumbs left 🌸

this was ClamAV 1.5.4, dated July 29, 2020, brought to you by the Clam On-Access Scanner girlies. now go scan something πŸ’…πŸ’–