OS Manuals

/usr/bin/clamscan

ClamAV command-line scanner and utils

From clamav-1.4-scanner 1.4.6-r7 (enterprise-packages), captured 2026-11-08 by running clamscan --help (exit 0). permalink

                       Clam AntiVirus: Scanner 1.4.6
           By The ClamAV Team: https://www.clamav.net/about.html#credits
           (C) 2024 Cisco Systems, Inc.

    clamscan [options] [file/directory/-]

    --help                -h             Show this help
    --version             -V             Print version number
    --verbose             -v             Be verbose
    --archive-verbose     -a             Show filenames inside scanned archives
    --debug                              Enable libclamav's debug messages
    --quiet                              Only output error messages
    --stdout                             Write to stdout instead of stderr. Does not affect 'debug' messages.
    --no-summary                         Disable summary at end of scanning
    --infected            -i             Only print infected files
    --suppress-ok-results -o             Skip printing OK files
    --bell                               Sound bell on virus detection

    --tempdir=DIRECTORY                  Create temporary files in DIRECTORY
    --leave-temps[=yes/no(*)]            Do not remove temporary files
    --force-to-disk[=yes/no(*)]          Create temporary files for nested file scans that would otherwise be in-memory only
    --gen-json[=yes/no(*)]               Generate JSON metadata for the scanned file(s). For testing & development use ONLY.
                                         JSON will be printed if --debug is enabled.
                                         A JSON file will dropped to the temp directory if --leave-temps is enabled.
    --database=FILE/DIR   -d FILE/DIR    Load virus database from FILE or load all supported db files from DIR
    --official-db-only[=yes/no(*)]       Only load official signatures
    --fail-if-cvd-older-than=days        Return with a nonzero error code if virus database outdated.
    --log=FILE            -l FILE        Save scan report to FILE
    --recursive[=yes/no(*)]  -r          Scan subdirectories recursively
    --allmatch[=yes/no(*)]   -z          Continue scanning within file after finding a match
    --cross-fs[=yes(*)/no]               Scan files and directories on other filesystems
    --follow-dir-symlinks[=0/1(*)/2]     Follow directory symlinks (0 = never, 1 = direct, 2 = always)
    --follow-file-symlinks[=0/1(*)/2]    Follow file symlinks (0 = never, 1 = direct, 2 = always)
    --file-list=FILE      -f FILE        Scan files from FILE
    --remove[=yes/no(*)]                 Remove infected files. Be careful!
    --move=DIRECTORY                     Move infected files into DIRECTORY
    --copy=DIRECTORY                     Copy infected files into DIRECTORY
    --exclude=REGEX                      Don't scan file names matching REGEX
    --exclude-dir=REGEX                  Don't scan directories matching REGEX
    --include=REGEX                      Only scan file names matching REGEX
    --include-dir=REGEX                  Only scan directories matching REGEX

    --bytecode[=yes(*)/no]               Load bytecode from the database
    --bytecode-unsigned[=yes/no(*)]      Load unsigned bytecode
                                         **Caution**: You should NEVER run bytecode signatures from untrusted sources.
                                         Doing so may result in arbitrary code execution.
    --bytecode-timeout=N                 Set bytecode timeout (in milliseconds)
    --statistics[=none(*)/bytecode/pcre] Collect and print execution statistics
    --detect-pua[=yes/no(*)]             Detect Possibly Unwanted Applications
    --exclude-pua=CAT                    Skip PUA sigs of category CAT
    --include-pua=CAT                    Load PUA sigs of category CAT
    --detect-structured[=yes/no(*)]      Detect structured data (SSN, Credit Card)
    --structured-ssn-format=X            SSN format (0=normal,1=stripped,2=both)
    --structured-ssn-count=N             Min SSN count to generate a detect
    --structured-cc-count=N              Min CC count to generate a detect
    --structured-cc-mode=X               CC mode (0=credit debit and private label, 1=credit cards only
    --scan-mail[=yes(*)/no]              Scan mail files
    --phishing-sigs[=yes(*)/no]          Enable email signature-based phishing detection
    --phishing-scan-urls[=yes(*)/no]     Enable URL signature-based phishing detection
    --heuristic-alerts[=yes(*)/no]       Heuristic alerts
    --heuristic-scan-precedence[=yes/no(*)] Stop scanning as soon as a heuristic match is found
    --normalize[=yes(*)/no]              Normalize html, script, and text files. Use normalize=no for yara compatibility
    --scan-pe[=yes(*)/no]                Scan PE files
    --scan-elf[=yes(*)/no]               Scan ELF files
    --scan-ole2[=yes(*)/no]              Scan OLE2 containers
    --scan-pdf[=yes(*)/no]               Scan PDF files
    --scan-swf[=yes(*)/no]               Scan SWF files
    --scan-html[=yes(*)/no]              Scan HTML files
    --scan-xmldocs[=yes(*)/no]           Scan xml-based document files
    --scan-hwp3[=yes(*)/no]              Scan HWP3 files
    --scan-onenote[=yes(*)/no]           Scan OneNote files
    --scan-archive[=yes(*)/no]           Scan archive files (supported by libclamav)
    --scan-image[=yes(*)/no]             Scan image (graphics) files
    --scan-image-fuzzy-hash[=yes(*)/no]  Detect files by calculating image (graphics) fuzzy hashes
    --alert-broken[=yes/no(*)]           Alert on broken executable files (PE & ELF)
    --alert-broken-media[=yes/no(*)]     Alert on broken graphics files (JPEG, TIFF, PNG, GIF)
    --alert-encrypted[=yes/no(*)]        Alert on encrypted archives and documents
    --alert-encrypted-archive[=yes/no(*)] Alert on encrypted archives
    --alert-encrypted-doc[=yes/no(*)]    Alert on encrypted documents
    --alert-macros[=yes/no(*)]           Alert on OLE2 files containing VBA macros
    --alert-exceeds-max[=yes/no(*)]      Alert on files that exceed max file size, max scan size, or max recursion limit
    --alert-phishing-ssl[=yes/no(*)]     Alert on emails containing SSL mismatches in URLs
    --alert-phishing-cloak[=yes/no(*)]   Alert on emails containing cloaked URLs
    --alert-partition-intersection[=yes/no(*)] Alert on raw DMG image files containing partition intersections
    --nocerts                            Disable authenticode certificate chain verification in PE files
    --dumpcerts                          Dump authenticode certificate chain in PE files

    --max-scantime=#n                    Scan time longer than this will be skipped and assumed clean (milliseconds)
    --max-filesize=#n                    Files larger than this will be skipped and assumed clean
    --max-scansize=#n                    The maximum amount of data to scan for each container file (**)
    --max-files=#n                       The maximum number of files to scan for each container file (**)
    --max-recursion=#n                   Maximum archive recursion level for container file (**)
    --max-dir-recursion=#n               Maximum directory recursion level
    --max-embeddedpe=#n                  Maximum size file to check for embedded PE
    --max-htmlnormalize=#n               Maximum size of HTML file to normalize
    --max-htmlnotags=#n                  Maximum size of normalized HTML file to scan
    --max-scriptnormalize=#n             Maximum size of script file to normalize
    --max-ziptypercg=#n                  Maximum size zip to type reanalyze
    --max-partitions=#n                  Maximum number of partitions in disk image to be scanned
    --max-iconspe=#n                     Maximum number of icons in PE file to be scanned
    --max-rechwp3=#n                     Maximum recursive calls to HWP3 parsing function
    --pcre-match-limit=#n                Maximum calls to the PCRE match function.
    --pcre-recmatch-limit=#n             Maximum recursive calls to the PCRE match function.
    --pcre-max-filesize=#n               Maximum size file to perform PCRE subsig matching.
    --disable-cache                      Disable caching and cache checks for hash sums of scanned files.

Pass in - as the filename for stdin.

(*) Default scan settings
(**) Certain files (e.g. documents, archives, etc.) may in turn contain other
   files inside. The above options ensure safe processing of this kind of data.
Options (88)
OptionDescriptionSource
--help, -hPrint help information and exit.help + man
--version, -VPrint version number and exit.help + man
--verbose, -v-v Be verbosehelp + man
--archive-verbose, -a-a Show filenames inside scanned archiveshelp + man
--debugDisplay debug messages from libclamav.help + man
--quietBe quiet (only print error messages).help + man
--stdoutWrite all messages (except for libclamav output) to the standard output (stdout).help + man
--no-summaryDo not display summary at the end of scanning.help + man
--infected, -i-i Only print infected fileshelp + man
--suppress-ok-results, -o -oSkip printing OK fileshelp + man
--bellSound bell on virus detection.help + man
--tempdir DIRECTORYCreate temporary files in DIRECTORY.help + man
--leave-temps yes/no(*)Do not remove temporary files.help + man
--force-to-disk yes/no(*)Create temporary files for nested file scans that would otherwise be in-memory onlyhelp + man
--gen-json yes/no(*)Generate JSON metadata for the scanned file(s).help + man
--database, -d FILE/DIR-d FILE/DIR Load virus database from FILE or load all supported db files from DIRhelp + man
--official-db-only yes/no(*)Only load official signatureshelp
--fail-if-cvd-older-than daysReturn with a nonzero error code if the virus database is older than the specified number of days.help + man
--log, -l FILE-l FILE Save scan report to FILEhelp + man
--recursive, -r yes/no(*)-r Scan subdirectories recursivelyhelp + man
--allmatch, -z yes/no(*)After a match, continue scanning within the file for additional matches.help + man
--cross-fs yes(*)/noScan files and directories on other filesystemshelp
--follow-dir-symlinks 0/1(*)/2Follow directory symlinks (0 = never, 1 = direct, 2 = always)help
--follow-file-symlinks 0/1(*)/2Follow file symlinks (0 = never, 1 = direct, 2 = always)help
--file-list, -f FILEScan files listed line by line in FILE.help + man
--remove yes/no(*)Remove infected files.help
--move DIRECTORYMove infected files into DIRECTORY.help + man
--copy DIRECTORYCopy infected files into DIRECTORY.help + man
--exclude REGEXDon't scan file/directory names matching regular expression.help + man
--exclude-dir REGEXDon't scan directories matching REGEXhelp
--include REGEXOnly scan file/directory matching regular expression.help + man
--include-dir REGEXOnly scan directories matching REGEXhelp
--bytecode yes(*)/noLoad bytecode from the databasehelp
--bytecode-unsigned yes/no(*)Load unsigned bytecode **Caution**: You should NEVER run bytecode signatures from untrusted sources.help
--bytecode-timeout NSet bytecode timeout in milliseconds (default: 10000 = 10s)help + man
--detect-pua yes/no(*)Detect Possibly Unwanted Applicationshelp
--exclude-pua CATExclude a specific PUA category.help + man
--include-pua CATOnly include a specific PUA category.help + man
--detect-structured yes/no(*)Detect structured data (SSN, Credit Card)help
--structured-ssn-format XX=0: search for valid SSNs formatted as xxx-yy-zzzz (normal);help + man
--structured-ssn-count NThis option sets the lowest number of Social Security Numbers found in a file to generate a detect (default: 3).help + man
--structured-cc-count NThis option sets the lowest number of Credit Card numbers found in a file to generate a detect (default: 3).help + man
--structured-cc-mode XCC mode (0=credit debit and private label, 1=credit cards onlyhelp
--scan-mail yes(*)/noScan mail fileshelp
--phishing-sigs yes(*)/noEnable email signature-based phishing detectionhelp
--phishing-scan-urls yes(*)/noEnable URL signature-based phishing detectionhelp
--heuristic-alerts yes(*)/noHeuristic alertshelp
--normalize yes(*)/noNormalize html, script, and text files.help
--scan-pe yes(*)/noScan PE fileshelp
--scan-elf yes(*)/noScan ELF fileshelp
--scan-ole2 yes(*)/noScan OLE2 containershelp
--scan-pdf yes(*)/noScan PDF fileshelp
--scan-swf yes(*)/noScan SWF fileshelp
--scan-html yes(*)/noScan HTML fileshelp
--scan-xmldocs yes(*)/noScan xml-based document fileshelp
--scan-hwp3 yes(*)/noScan HWP3 fileshelp
--scan-onenote yes(*)/noScan OneNote fileshelp
--scan-archive yes(*)/noScan archive files (supported by libclamav)help
--scan-image yes(*)/noScan image (graphics) fileshelp
--scan-image-fuzzy-hash yes(*)/noDetect files by calculating image (graphics) fuzzy hasheshelp
--alert-broken yes/no(*)Alert on broken executable files (PE & ELF)help
--alert-broken-media yes/no(*)Alert on broken graphics files (JPEG, TIFF, PNG, GIF)help
--alert-encrypted yes/no(*)Alert on encrypted archives and documentshelp
--alert-encrypted-doc yes/no(*)Alert on encrypted documentshelp
--alert-macros yes/no(*)Alert on OLE2 files containing VBA macroshelp
--alert-exceeds-max yes/no(*)Alert on files that exceed max file size, max scan size, or max recursion limithelp
--alert-phishing-ssl yes/no(*)Alert on emails containing SSL mismatches in URLshelp
--alert-phishing-cloak yes/no(*)Alert on emails containing cloaked URLshelp
--nocertsDisable authenticode certificate chain verification in PE files.help + man
--dumpcertsDump authenticode certificate chain in PE files.help + man
--max-scantime #nScan time longer than this will be skipped and assumed clean (milliseconds)help + man
--max-filesize #nFiles larger than this will be skipped and assumed cleanhelp + man
--max-scansize #nThe maximum amount of data to scan for each container file (**)help + man
--max-files #nExtract at most #n files from each scanned file (when this is an archive, a document or another kind of container).help + man
--max-recursion #nMaximum archive recursion level for container file (**)help + man
--max-dir-recursion #nMaximum depth directories are scanned at (default: 15).help + man
--max-embeddedpe #nMaximum size file to check for embedded PE.help + man
--max-htmlnormalize #nMaximum size of HTML file to normalize.help + man
--max-htmlnotags #nMaximum size of normalized HTML file to scan.help + man
--max-scriptnormalize #nMaximum size of script file to normalize.help + man
--max-ziptypercg #nMaximum size zip to type reanalyze.help + man
--max-partitions #nThis option sets the maximum number of partitions of a raw disk image to be scanned.help + man
--max-iconspe #nThis option sets the maximum number of icons within a PE to be scanned.help + man
--max-rechwp3 #nThis option sets the maximum recursive calls to HWP3 parsing function (default: 16).help + man
--pcre-match-limit #nMaximum calls to the PCRE match function (default: 100000).help + man
--pcre-recmatch-limit #nMaximum recursive calls to the PCRE match function (default: 2000).help + man
--pcre-max-filesize #nMaximum size file to perform PCRE subsig matching (default: 100 MB).help + man
--disable-cacheDisable caching and cache checks for hash sums of scanned files.help + man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.