AVScan - Command Line

Contents->Command Line

Usage
Options
GUI Options
Environment Variables
WM Class Names
Widget Names
Selection Target Names
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 or dereference links.
`-l`	Same as `--ignore-links`.
`--database <path>`	Specifies the virus database as <path>, which may be either a virus database file or a virus database directory).
`-db <path>`	Same as `--database`.
`--cpu-priority <priority>`	Specifies the CPU priority, one of: `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-scan-size <bytes>`	Specifies the maximum number of bytes to scan in each file or `0` for no maximum (the default value is `100000000`).
`--max-directory-recursions <level>`	Specifies the maximum level of subdirectories to recurse into or `0` for no maximum (the default value is `16`).
`--max-archive-files <n>`	Specifies the maximum number of files to scan in each archive or `0 for no maximum (the default value is 10000).`
`--max-archive-file-size <bytes>`	Specifies the maximum number of bytes to scan in each archive or `0 for no maximum (the default value is 25000000).`
`--max-archive-recursions <level>`	Specifies the maximum archive recursion level or `0` for no maximum (the default value is `16`).
`--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

Command line options override any options set 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.

WM Class Names

WM Class Names are used to identify the toplevel windows when specifying special attrbutes/behaviors to those toplevel windows in WM (Window Manager) configurations.

To refer to a particular toplevel window, use the format:

<window_name>.<class_name>.<attribute>: <value>

For example, to have your WM (Window Manager) make all of this program's dialogs stay on top:

dialog.AVScan.layer: OnTop

WM Class Name	Description
`AVScan`	Class name
`scanner`	Scanner Window name.
`dialog`	All Dialogs name.
`fileselection`	File Selection Dialog name.

Back to the top

Widget Names

Widget Names are used to identify particular GtkWidgets in Gtk RC Files so that user-specified GtkStyle values can be applied to them.

Widget Name	Description
`avscan-scanner`	Scanner toplevel GtkWindow.
`menu-bar`	GtkMenuBar.
`tool-bar`	Tool Bar.
`animation-icon`	Animation Icon.
`notebook`	Main GtkNotebook.
`scan-page-toplevel`	Scan Page toplevel GtkContainer.
`scan-list`	Scan List GtkCList.
`results-page-toplevel`	Results Page toplevel GtkContainer.
`results-list`	Results List GtkCList.
`database-page-toplevel`	Database Page toplevel GtkContainer.
`status-bar`	Status Bar.
`file-selection`	File Selection Dialog toplevel GtkWindow.
`list-headings`	List Headings.
`contents-list`	Contents List.

Back to the top.

Selection Target Names

Selection Target Names are names for data being used in selections (such as copy & paste and drag & drop). Data being exchanged between programs using selections have target names in order to allow programs to recognize and handle the data appropriately.

Unless otherwise noted, the data is typically in the format of a series of null-terminated strings (be sure to check the data's length in order to handle all of the strings).

Target	Type	Description
`text/plain`	`STRING`	VFS object path in URL format (example: `file:///directory/file.ext`).
`text/uri-list`	`STRING`	Same as `text/plain`.
`STRING`	`STRING`	Same as `text/plain`.
`AVScan/ScanItem`	`STRING`	Scan Item, format is: <string_path> <string_name> <guint_options> <gulong_last_runned_time>

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`	I/O error.
`59`	Scanner subsystem or plugin error.
`60`	Unsupported file format.
`61`	Unable to lock the virus database directory.
`63`	Unable to create a tempory file or directory.
`99`	No virus scanner support compiled.

Back to the top.