AVScan - Command Line

Contents->Command Line

Usage
Options
GUI Options
Environment Variables
Return Values

Usage

avscan <path(s)...> [options] [GUI_options]
avscan --scan <path(s)...> [options]

The <path(s)...> specifies the full paths to the file(s) and/or directory(ies) to scan at startup.

The --scan argument specifies to run in scanner mode. This mode is used by this program when calling itself to perform a scan process and is therefore not intended to be specified by the user.

The [options]can be any of the following:

`[options]`	Description
`--recursive`	Recurse into subdirectories.
`-r`	Same as `--recursive`.
`--executables-only`	Scan executable files only.
`-x`	Same as `--executables-only`.
`--ignore-links`	Do not scan links.
`-l`	Same as `--ignore-links`.
`--database <path>`	Set the virus database to `<path>` (`<path>` may be either a file or a directory).
`-db <path>`	Same as `--database`.
`--cpu-priority <priority>`	Sets the CPU priority, valid values are; `highest`, `high`, `medium`, `low`, `lowest`.
`--report-all-objects`	Specifies to report all objects that have been scanned to the Results List.
`--no-report-all-objects`	Specifies to only report objects that have problems or viruses (opposite of `--report-all-objects`).
`--max-files <n>`	Sets the maximum number of files in an archive to scan.
`--max-file-size <n>`	Sets the maximum size of a file in an archive to scan.
`--max-recursions <n>`	Sets the maximum archive recursions.
`--max-mail-recursions <n>`	Sets the maximum mail recursions.
`--max-compression-ratio <n>`	Set the maximum archive compression ratio to scan.
`--help`	Prints the help screen and exits.
`--version`	Prints the version and exits.

[GUI_options] can be any of the following:

`[GUI_options]`	Description
`--geometry <WxH+X+Y>`	Specifies the geometry of the windows
`--fn <font>`	Specifies the font to be used for the lists
`--fg <color>`	Specifies the foreground color for the lists
`--bg <color>`	Specifies the background color for the lists
`--sfg <color>`	Specifies the selected foreground & text color for the lists
`--sbg <color>`	Specifies the selected background & base color for the lists
`--cfg <color>`	Specifies the pointer cursor's foreground color
`--cbg <color>`	Specifies the pointer cursor's background color
`--bg-pixmap <path>`	Specifies the background pixmap for the lists
`--sbg-pixmap <path>`	Specifies the selected background pixmap for the lists
`--name <name>`	Specifies the WM window name
`--class <class>`	Specifies the WM class name
`--title <title>`	Specifies the title to be displayed on the title bars

[GUI_options] can be any options standard to your GUI, consult your GUI's manual for available options.

Command line options override any options in the configuration file.

Back to the top.

Environment Variables

Environment Variable	Description
`DISPLAY`	Specifies the host address, display number, and screen number to connect to the X server
`PATH`	Specifies the search path, a string containing a list of paths separated by `;` characters
`USERNAME`	Specifies the user's name
`USER`	Fallback for `USERNAME`
`HOME`	Specifies the absolute path to the user's home directory
`EDITOR`	Specifies the command to execute the prefered text editor
`EDIT`	Fallback for `EDITOR`
`VIEWER`	Specifies the command to execute the prefered file viewer
`VIEW`	Fallback for `VIEWER`
`BROWSER`	Specifies the command to execute the prefered web browser
`HELPBROWSER`	Specifies the command to execute the prefered help browser (if this is not set then it will fallback to `BROWSER`)
`TMPDIR`	Specifies the path to the tempory files directory (default value is `/tmp`)

Back to the top.

Return Values

Return Value	Description
`0`	Success.
`1`	Virus detected or general error.
`2`	Invalid value.
`3`	Systems error or memory allocation error.
`4`	User aborted (otherwise no other error).
`5`	User responded with "no" to a query (otherwise no other error).
`6`	An identical operation is already in progress.
`7`	Reserved.
`8`	Segmentation fault.
`50`	Unable to load or initialize the virus database.
`51`	An input file has a corrupt format or a format not consistent with its extension.
`52`	Unsupported object type.
`53`	Unable to open an input directory.
`54`	Unable to open an input file.
`55`	An error occured while reading an input file.
`56`	Unable to `stat()` or `lstat()` an input file.
`57`	Scan of object was incomplete because it would otherwise exceed a specified limit.
`58`	Reserved.
`59`	Scanner subsystem or plugin is unable to scan an input file.
`99`	No virus scanner support compiled.

Back to the top.