apcupsd.conf

package: apcupsd

title: apcupsd.conf(5)

summary: apcupsd(8) configuration file

text:
# apcupsd.conf(5)

## NAME
apcupsd.conf — apcupsd(8) configuration file

## DESCRIPTION
apcupsd.conf is the configuration file for the apcupsd(8) program. The file is a plain ASCII text file which comprises a number of configuration directives which control how the apcupsd program behaves when controlling most American Power Conversion Corp (APC) UPSes. The configuration file is also used for the apctest(8) program when bulk programming the EEPROM in a Smart-UPS model.

It will almost certainly be necessary to customise the information in the configuration file to suit your particular configuration and operating requirements.

Note that the apcupsd daemon must be restarted in order for changes to the configuration file to become active.

The configuration file directives are explained in the subsections below.

### GENERAL CONFIGURATION DIRECTIVES
UPSNAME <string>

Specify a name for the UPS for log files, status reports etc.

UPSCABLE [ simple | smart | ether | usb | 940-0119A | 940-0127A | 940-0128A | 940-0020B | 940-0020C | 940-0023A | 940-0024B | 940-0024C | 940-1524C | 940-0024G | 940-0095A | 940-0095B | 940-0095C | 940-0625A | MAM-04-02-2000 ]

The type of cable used to connect the UPS to the computer.

UPSTYPE [ dumb | apcsmart | net | usb | snmp | pcnet | modbus |test ]

The type of APC UPS that you have.

DEVICE <name>

The name of the device used for communication between the UPS and the computer. For a USB UPS, you should leave the DEVICE directive blank and apcupsd will figure out where the device is located.

- apcsmart : /dev/tty** (serial connection)

- usb : leave blank! (USB connection)

- net : hostname:port (NIS connection)

- snmp : hostname:port:vendor:community (SNMP connection)

- dumb : /dev/tty** (serial connection)

- pcnet : ipaddr:username:passphrase (AP9617 SmartSlot card)

- modbus : /dev/tty** (serial connection)

- modbus : leave blank (USB connection)

If you have problems, please see the apcupsd manual for more detailed information and comprehensive troubleshooting advice.

POLLTIME <seconds>

The rate in seconds that the daemon polls the UPS for status. This rate is automatically set to 1 second when the UPS goes on battery and reset to the specified value when the utility power returns. This setting applies both to directly-attached UPSes and networked UPSes. A low setting will improve the daemon's responsiveness to certain events at the cost of higher CPU utilisation. The default of 60 is appropriate for most situations.

LOCKFILE <path>

apcupsd creates a lockfile for the serial or USB port in the specified directory. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

SCRIPTDIR <path>

Directory in which apccontrol and event scripts are located. Defaults to /usr/local/etc/apcupsd. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

PWRFAILDIR <path>

Directory in which apcupsd writes the powerfail flag file created when apcupsd initiates a system shutdown. The directory is checked in halt scripts to determine if turning off the UPS output power is required. Defaults to /var/run. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

NOLOGINDIR <path>

Directory in which apcupsd writes the nologin file which tells the OS to disallow new logins. Defaults to /var/run. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

### NIS CONFIGURATION DIRECTIVES
NETSERVER [ on | off ]

Turns the network information server (NIS) on or off. When on, apcupsd serves status and event information over the network. This information is also used by the web-based CGI monitoring programs. The default is set to on.

NISIP <IP address>

Specifies the IP address of the network interface on which apcupsd will listen for incoming connections. The default value is 0.0.0.0 which means the NIS will listen for connections on all network interfaces. If the computer has more than one interface, you can specify the IP of a single interface to limit connections to that interface. Specifying the loopback address (127.0.0.1) will cause the NIS daemon to accept connections only from the local computer.

NISPORT <port>

Specifies the port to be used by the NIS daemon. The default is 3551 which has been received from IANA as the official apcupsd networking port. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

EVENTSFILE <filename>

If you want NIS to provide the last 10 events via the network, you must specify a file where apcupsd will save these events. The default is: /var/log/apcupsd.events. apcupsd will save at most the last 50 events to this file. When more than 50 events are saved and a network request for the events arrives, apcupsd will truncate the file to the most recent 10 events. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

### LOGGING CONFIGURATION DIRECTIVES
STATTIME <seconds>

Specifies the time interval between writes to the status file. If set to zero, the status file will not be written. The status file will disappear in a future apcupsd version as its functionality has been replaced by the Network Information Server and the apcaccess(8) program.

STATFILE <file>

Specifies the file to be used when writing the status information. The default is /etc/apcupsd/apcupsd.status. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

LOGSTATS [ on | off ]

Activate log file. This generates a lot of output, so if you turn this on, be sure that the file defined in syslog.conf(5) for LOG_NOTICE is a named pipe.

DATATIME <seconds>

Specifies the time interval between writes of the APC PowerChute software-like data information to the log file.

FACILITY <log-facility>

Change the system logging (syslog) facility. The default is daemon. This parameter can be useful if you wish to direct the apcupsd system logging information to other than your system default files. See syslog.conf(5) for details of other possible facilities and general system logging configuration.

### POWER FAILURE CONFIGURATION DIRECTIVES
ONBATTERYDELAY <seconds>

The number of seconds from when a power failure is detected until apcupsd reacts with an onbattery event.

BATTERYLEVEL <percentage>

apcupsd will shutdown the system during a power failure when the remaining battery charge falls below the specified percentage. The default is 5.

MINUTES <minutes>

apcupsd will shutdown the system during a power failure when the remaining runtime on batteries as internally calculated by the UPS falls below the specified minutes. The default is 3.

TIMEOUT <seconds>

After a power failure occurs, apcupsd will shutdown the system after the specified number of seconds have expired. For a Smart-UPS, this should normally be set to zero so that the shutdown time will be determined by the battery level or remaining runtime (see above). This command is, however, useful for a Back-UPS or other simple signalling UPS which does not report battery level or the remaining runtime. It is also useful for testing apcupsd because you can force a rapid shutdown by setting a small value (eg 60) and turning off the power to the UPS.

TIMEOUT, BATTERYLEVEL, and MINUTES can all be set without problems. apcupsd will initiate a shutdown when the first of these conditions becomes valid.

ANNOY <seconds>

Specifies the time in seconds between broadcast messages requesting logged in users to log off from the system. This timer starts only when the UPS is running on battery. The default is 300 seconds (5 minutes).

ANNOYDELAY <seconds>

Specifies the delay time in seconds before broadcast messages requesting logged in users to log off from the system. This timer starts only after the UPS is running on battery power. This timer is reset when the power returns. The default is 60 seconds (ie the first request to log off occurs after 60 seconds on battery power).

NOLOGON [ disable | timeout | percent | minutes | always ]

Specifies when apcupsd should create the nologon file to prevent users from logging on to the system.

"disable" prevents apcupsd from creating the nologin file.

"timeout" specifies a specific wait time before apcupsd creates the nologin file.

"percent" specifies the percentage of battery charge remaining before apcupsd creates the nologin file.

"minutes" specifies the battery runtime remaining before apcupsd creates the nologin file.

"always" specifies that apcupsd should create the nologin file immediately after a power failure occurs.

This directive is important for allowing systems with BIG UPSes to run normally until the system administrator determines the need for dumping users. It also allows the system administrator to hold the "ANNOY" factor until the /etc/nologin file is created.

KILLDELAY <seconds>

Specifies the number of seconds for which apcupsd will continue running after a shutdown has been requested. After the specified time, apcupsd will attempt to put the UPS into hibernate mode and kill the power to the computer. This is for use on operating systems where apcupsd cannot regain control after a shutdown (eg FreeBSD) to issue an apcupsd --killpower command. Setting the delay to 0 disables it.

### SHARE-UPS CONFIGURATION DIRECTIVES
UPSCLASS [ standalone | shareslave | sharemaster ]

The default is "standalone" and should be used for all computers powered by the UPS, with a direct connection to the UPS and where there are no other computers dependent on power from the UPS. This is the "normal" case.

Use "shareslave" if you are using a Share-UPS interface expander and connected to the BASIC port (simple signalling).

Use "sharemaster", if you are using a Share-UPS interface expander and connected to the ADVANCED port (smart signalling).

UPSMODE [ disable | share ]

Set to "disable" for normal standalone operation to indicate that you are disabling the Share-UPS interface expander support.

Set to "share" for two to seven additional simple signalling ports on a Share-UPS interface expander. This code may not be fully tested in every new release.

### APCTEST EEPROM CONFIGURATION DIRECTIVES
These directives have no effect on the operation of apcupsd(8) but are reserved for use by apctest(8) when bulk programming the values of the UPS EEPROM configuration variables in a Smart-UPS model.

UPSNAME <string>

Name of UPS. Maximum of 8 characters.

BATTDATE [ mm/dd/yy | dd/mm/yy ]

Last battery replacement date. Maximum of 8 characters.

SENSITIVITY [ H | M | L ]

- H : High (most sensitive setting)

- M : Medium

- L : Low (least sensitive setting)

WAKEUP [ 000 | 060 | 180 | 300 ]

The time delay in seconds that the UPS waits after the return of utility power before "waking up" and restoring power to the connected equipment.

SLEEP [ 020 | 180 | 300 | 600 ]

The time delay in seconds for which the UPS waits or "sleeps" after it receives a request to power off the connected system.

LOTRANSFER <voltage>

Low line voltage causing transfer to battery power or activation of SmartBoost. Allowable values depend on the last letter of the firmware or APCMODEL. Typical values are:

D 106 103 100 097

M 177 172 168 182

A 092 090 088 086

I 208 204 200 196

where D = domestic (USA), M = Canada, A = Asia and I = International.

HITRANSFER <voltage>

High line voltage causing transfer to battery power or activation of SmartTrim. Allowable values depend on the last letter of the firmware or APCMODEL. Typical values are:

D 127 130 133 136

M 229 234 239 224

A 108 110 112 114

I 253 257 261 265

where D = domestic (USA), M = Canada, A = Asia and I = International.

RETURNCHARGE [ 00 | 15 | 50 | 90 ]

Percentage of battery charge needed for the UPS to restore power to the connected equipment.

BEEPSTATE [ 0 | T | L | N ]

Alarm delay.

- 0 : Zero delay after power fails.

- T : When power fails plus 30 seconds.

- L : When low battery occurs.

- N : Never.

LOWBATT <minutes>

Low battery warning occurs when the specified number of minutes remains before the UPS estimates battery power will be exhausted. There are four user-changeable settings: 2, 5, 7, or 10 minutes

OUTPUTVOLTS <voltage>

UPS nominal output voltage when running on battery. Allowable values depend on the last letter of the firmware or APCMODEL. Typical values are:

D 115

M 208

A 100

I 230 240 220 225

where D = domestic (USA), M = Canada, A = Asia and I = International.

SELFTEST [ 336 | 168 | ON | OFF ]

Self test interval in hours (336 = 2 weeks, 168 = 1 week, ON = at power on, OFF = never).

## EXAMPLES
Note that in the following examples, the device names assume that you are using Linux. Device names for serial devices in *BSD and other operating systems will be different.

### Minimal USB Configuration for a USB UPS

UPSCABLE usb

UPSTYPE usb

DEVICE

LOCKFILE /var/lock

UPSCLASS standalone

UPSMODE disable

Notice no device name is specified. apcupsd(8) will try all the well known USB ports. Only specify a specific USB device name if you know what you are doing. For detailed information on setting up a USB UPS, refer to the "USB Configuration" section of the apcupsd manual.

### Minimal Serial Configuration for a Smart UPS

UPSCABLE smart

UPSTYPE apcsmart

DEVICE /dev/ttyS0

LOCKFILE /var/lock

UPSCLASS standalone

UPSMODE disable

Normally there would be more configuration directives to completely customise your installation, but this example shows the minimum required.

### Minimal Serial Configuration for a Dumb UPS

UPSCABLE <number of the cable used>

UPSTYPE dumb

DEVICE /dev/ttyS0

LOCKFILE /var/lock

UPSCLASS standalone

UPSMODE disable

If your cable does not have low battery detection (eg such cables include the APC 940-0020B and 940-0023A), you will also need to define the TIMEOUT <seconds> configuration directive to set the number of seconds on battery during a power failure after which apcupsd will do a system shutdown.

Normally there would be more configuration directives to completely customise your installation, but this example shows the minimum required.

## FILES
/etc/apcupsd/apcupsd.conf default configuration file

## SEE ALSO
syslog.conf(5), apcupsd(8), apctest(8).

The HTML apcupsd manual installed on your system or available online at http://www.apcupsd.org/

## AUTHORS
Trevor Roydhouse (current)

Andre M. Hedrick

Christopher J. Reimer


apt.conf

package: apt

title: apt.conf(5)

summary: Configuration file for APT

text:
# apt.conf(5)

## NAME
apt.conf - Configuration file for APT

## DESCRIPTION
apt.conf is the main configuration file for the APT suite of tools, all tools make use of the configuration file and a common command line parser to provide a uniform environment. When an APT tool starts up it will read the configuration specified by the APT_CONFIG environment variable (if any) and then read the files in Dir::Etc::Parts then read the main configuration file specified by Dir::Etc::main then finally apply the command line options to override the configuration directives, possibly loading even more config files.

The configuration file is organized in a tree with options organized into functional groups. Option specification is given with a double colon notation, for instance APT::Get::Assume-Yes is an option within the APT tool group, for the Get tool. Options do not inherit from their parent groups.

Syntacticly the configuration language is modeled after what the ISC tools such as bind and dhcp use. Lines starting with // are treated as comments (ignored). Each line is of the form

```
APT::Get::Assume-Yes "true";
```

The trailing semicolon is required and the quotes are optional. A new scope can be opened with curly braces, like:

```
APT {

  Get {

    Assume-Yes "true";

    Fix-Broken "true";

  };
};
```

with newlines placed to make it more readable. Lists can be created by opening a scope and including a single word enclosed in quotes followed by a semicolon. Multiple entries can be included, each separated by a semicolon.

```
RPM::Allow-Duplicated {"kernel"; "kernel-smp";};
```

In general the sample configuration file in /usr/share/doc/apt/examples/apt.conf /usr/share/doc/apt/examples/configure-index.gz is a good guide for how it should look.

Two specials are allowed, #include and #clear. #include will include the given file, unless the filename ends in a slash, then the whole directory is included. #clear is used to erase a list of names.

All of the APT tools take a -o option which allows an arbitrary configuration directive to be specified on the command line. The syntax is a full option name (APT::Get::Assume-Yes for instance) followed by an equals sign then the new value of the option. Lists can be appended too by adding a trailing :: to the list name.

## THE APT GROUP
This group of options controls general APT behavior as well as holding the options for all of the tools.

Architecture

System Architecture; sets the architecture to use when fetching files and parsing package lists. The internal default is the architecture apt was compiled for.

Ignore-Hold

Ignore Held packages; This global option causes the problem resolver to ignore held packages in its decision making.

Clean-Installed

Defaults to on. When turned on the autoclean feature will remove any packages which can no longer be downloaded from the cache. If turned off then packages that are locally installed are also excluded from cleaning - but note that APT provides no direct means to reinstall them.

Force-LoopBreak

Never Enable this option unless you -really- know what you are doing. It permits APT to temporarily remove an essential package to break a Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option will work if the essential packages are not gzip, libc, rpm, bash or anything that those packages depend on.

Cache-Limit

APT uses a fixed size memory mapped cache file to store the 'available' information. This sets the size of that cache.

Build-Essential

Defines which package(s) are considered essential build dependencies.

Get

The Get subsection controls the apt-get(8) tool, please see its documentation for more information about the options here.

Cache

The Cache subsection controls the apt-cache(8) tool, please see its documentation for more information about the options here.

CDROM

The CDROM subsection controls the apt-cdrom(8) tool, please see its documentation for more information about the options here.

## THE ACQUIRE GROUP
The Acquire group of options controls the download of packages and the URI handlers.

Queue-Mode

Queuing mode; Queue-Mode can be one of host or access which determines how APT parallelizes outgoing connections. host means that one connection per target host will be opened, access means that one connection per URI type will be opened.

Retries

Number of retries to perform. If this is non-zero APT will retry failed files the given number of times.

Source-Symlinks

Use symlinks for source archives. If set to true then source archives will be symlinked when possible instead of copying. True is the default

http

HTTP URIs; http::Proxy is the default http proxy to use. It is in the standard form of http://[[user][:pass]@]host[:port]/. Per host proxies can also be specified by using the form http::Proxy::<host> with the special keyword DIRECT meaning to use no proxies. The http_proxy environment variable will override all settings. Three settings are provided for cache control with HTTP/1.1 compliant proxy caches. No-Cache tells the proxy to not use its cached response under any circumstances, Max-Age is sent only for index files and tells the cache to refresh its object if it is older than the given number of seconds. Debian updates its index files daily so the default is 1 day. No-Store specifies that the cache should never store this request, it is only set for archive files. This may be useful to prevent polluting a proxy cache with very large .deb files. Note: Squid 2.0.2 does not support any of these options.

The option timeout sets the timeout timer used by the method, this applies to all things including connection timeout and data timeout.

One setting is provided to control the pipeline depth in cases where the remote server is not RFC conforming or buggy (such as Squid 2.0.2) Acquire::http::Pipeline-Depth can be a value from 0 to 5 indicating how many outstanding requests APT should send. A value of zero MUST be specified if the remote host does not properly linger on TCP connections - otherwise data corruption will occur. Hosts which require this are in violation of RFC 2068.

https

This method inherits all configuration settings from http method (including proxy settings) and has some additional settings related to TLS configuration. Variable Acquire::https::CaInfo allows setting path to certificate bundle file in PEM format to be used instead of system certificate store.

Variables Acquire::https::SslCert and Acquire::https::SslKey allow specifying path to client certificate and client certificate key files. If such files are specified and present, they'll be used to negotiate connection with server.

Variable Acquire::https::CrlFile allows to specify path to custom certificate revocation list file.

Variable Acquire::https::Verify-Peer allows to disable remote server verification if set to false.

Variable Acquire::https::Verify-Host allows to disable verification of remote host's hostname if set to false.

Variable Acquire::https::PinnedCert allows to specify location of pinned certificate file which will be used to compare with certificate retrieved from server.

ftp

FTP URIs; ftp::Proxy is the default proxy server to use. It is in the standard form of ftp://[[user][:pass]@]host[:port]/ and is overridden by the ftp_proxy environment variable. To use a ftp proxy you will have to set the ftp::ProxyLogin script in the configuration file. This entry specifies the commands to send to tell the proxy server what to connect to. Please see /usr/share/doc/apt/examples/configure-index.gz for an example of how to do this. The subsitution variables available are $(PROXY_USER), $(PROXY_PASS), $(SITE_USER), $(SITE_PASS), $(SITE), and $(SITE_PORT). Each is taken from it's respective URI component. The option timeout sets the timeout timer used by the method, this applies to all things including connection timeout and data timeout.

Several settings are provided to control passive mode. Generally it is safe to leave passive mode on, it works in nearly every environment. However some situations require that passive mode be disabled and port mode ftp used instead. This can be done globally, for connections that go through a proxy or for a specific host (See the sample config file for examples)

It is possible to proxy FTP over HTTP by setting the ftp_proxy environment variable to a http url - see the discussion of the http method above for syntax. You cannot set this in the configuration file and it is not recommended to use FTP over HTTP due to its low efficiency.

The setting ForceExtended controls the use of RFC2428 EPSV and EPRT commands. The defaut is false, which means these commands are only used if the control connection is IPv6. Setting this to true forces their use even on IPv4 connections. Note that most FTP servers do not support RFC2428.

cdrom

CDROM URIs; the only setting for CDROM URIs is the mount point, cdrom::Mount which must be the mount point for the CDROM drive as specified in /etc/fstab. It is possible to provide alternate mount and unmount commands if your mount point cannot be listed in the fstab (such as an SMB mount and old mount packages). The syntax is to put

```
"/cdrom/"::Mount "foo";

```

within the cdrom block. It is important to have the trailing slash. Unmount commands can be specified using UMount.

## DIRECTORIES
The Dir::State section has directories that pertain to local state information. lists is the directory to place downloaded package lists in. preferences is the name of the APT preferences file. Dir::State contains the default directory to prefix on all sub items if they do not start with / or ./.

Dir::Cache contains locations pertaining to local cache information, such as the two package caches srcpkgcache and pkgcache as well as the location to place downloaded archives, Dir::Cache::archives. Generation of caches can be turned off by setting their names to be blank. This will slow down startup but save disk space. It is probably prefered to turn off the pkgcache rather than the srcpkgcache. Like Dir::State the default directory is contained in Dir::Cache

Dir::Etc contains the location of configuration files, sourcelist gives the location of the sourcelist and main is the default configuration file (setting has no effect, unless it is done from the config file specified by APT_CONFIG).

The Dir::Parts setting reads in all the config fragments in lexical order from the directory specified. After this is done then the main config file is loaded.

Binary programs are pointed to by Dir::Bin. Dir::Bin::Methods specifies the location of the method handlers and gzip, rpm, apt-get, rpmbuild and apt-cache specify the location of the respective programs.

## HOW APT CALLS RPM
Several configuration directives control how APT invokes rpm(8). These are in the RPM section.

Options

This is a list of options to pass to rpm for all install, upgrade and remove operations. The options must be specified using the list notation and each list item is passed as a single argument to rpm(8).

Install-Options

This is a list of options to pass to rpm during install and upgrade operations. The options must be specified using the list notation and each list item is passed as a single argument to rpm(8).

Erase-Options

This is a list of options to pass to rpm during remove operations. The options must be specified using the list notation and each list item is passed as a single argument to rpm(8).

Pre-Invoke

Post-Invoke

This is a list of shell commands to run before/after invoking rpm(8). Like Options this must be specified in list notation. The commands are invoked in order using /bin/sh, should any fail APT will abort.

Pre-Install-Pkgs

This is a list of shell commands to run before invoking rpm. Like Options this must be specified in list notation. The commands are invoked in order using /bin/sh, should any fail APT will abort. APT will pass to the commands on standard input the filenames of all .rpm files it is going to install, one per line. Version 2 of this protocol dumps more information, including the protocol version, the APT configuration space and the packages, files and versions being changed. Version 2 is enabled by setting DPkg::Tools::Options::cmd::Version to 2. cmd is a command given to Pre-Install-Pkgs.

Run-Directory

APT chdirs to this directory before invoking rpm, the default is /.

Build-Options

These options are passed to rpmbuild(1) when compiling packages.

## OPTIONS RELATED TO AUTOREMOVE
Autoremove depends on packages having been marked as either 'auto' or 'manual' (i.e., either automatically installed by APT to resolve a dependency or manually selected for installation). There are a few options which configure the marking behaviour.

APT::Get::ReInstall::MarkManual

This is a boolean option with default value true. If it's set to true then, when APT reinstalls a package (by a user's request), it marks this package as manually installed.

APT::Get::Obsoletes::AptMarkInheritanceAuto

A string option which allows to define the rules of setting the value of flag auto when a package is obsoleting and replacing another package. Possible values are: obsoleted - if the obsoleted package is marked 'auto', the replacing package will be marked 'auto' too, otherwise marked 'manual';

replacing - the replacing package gets its mark as usual (i.e., if the replacing package is to be marked 'auto', it gets this mark without taking the mark of the replaced package into account; similarly for 'manual');

at_least_one - if the obsoleted package or the replacing package is marked 'auto', the replacing package will be marked 'auto', otherwise marked 'manual';

all - if the obsoleted package and the replacing package are both marked 'auto', the replacing package will be marked 'auto', otherwise marked 'manual';

never - the replacing package is always marked 'manual';

always - the replacing package is always marked 'auto';

if some other value is used or if the value is missing, it acts as if all was set.

There is an option which helps to debug the autoremove algorithm

Debug::pkgAutoremove::resolveVirtuals

This is a boolean option with default value false. If it's set to true, when autoremove is checking package dependencies, it'll output the information about the process of resolving virtual dependencies.

## DEBUG OPTIONS
Most of the options in the debug section are not interesting to the normal user, however Debug::pkgProblemResolver shows interesting output about the decisions dist-upgrade makes. Debug::NoLocking disables file locking so APT can do some operations as non-root and Debug::pkgRPMPM will print out the command line for each rpm invokation. Debug::IdentCdrom will disable the inclusion of statfs data in CDROM IDs.

## EXAMPLES
/usr/share/doc/apt/examples/configure-index.gz contains a sample configuration file showing the default values for all possible options.

## FILES
/etc/apt/apt.conf

## SEE ALSO
apt-cache(8), apt-config(8), apt_preferences(5).

## BUGS
Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>.

## AUTHOR
Maintainer and contributor information can be found in the credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.


title: apt_preferences(5)

summary: Preference control file for APT

text:
# apt_preferences(5)

## NAME
apt_preferences - Preference control file for APT

## DESCRIPTION
The APT preferences file /etc/apt/preferences can be used to control which versions of packages will be selected for installation.

Several versions of a package may be available for installation when the sources.list(5) file contains references to more than one distribution (for example, stable and testing). APT assigns a priority to each version that is available. Subject to dependency constraints, apt-get selects the version with the highest priority for installation. The APT preferences file overrides the priorities that APT assigns to package versions by default, thus giving the user control over which one is selected for installation.

Several instances of the same version of a package may be available when the sources.list(5) file contains references to more than one source. In this case apt-get downloads the instance listed earliest in the sources.list(5) file. The APT preferences file does not affect the choice of instance, only the choice of version.

### APT'S DEFAULT PRIORITY ASSIGNMENTS
If there is no preferences file or if there is no entry in the file that applies to a particular version then the priority assigned to that version is the priority of the distribution to which that version belongs. It is possible to single out a distribution, "the target release", which receives a higher priority than other distributions do by default. The target release can be set on the apt-get command line or in the APT configuration file /etc/apt/apt.conf. For example,

```
apt-get install -t testing some-package
```

```
APT::Default-Release "stable";
```

If the target release has been specified then APT uses the following algorithm to set the priorities of the versions of a package. Assign:

priority 100

to the version that is already installed (if any).

priority 500

to the versions that are not installed and do not belong to the target release.

priority 990

to the versions that are not installed and belong to the target release.

If the target release has not been specified then APT simply assigns priority 100 to all installed package versions and priority 500 to all uninstalled package versions.

APT then applies the following rules, listed in order of precedence, to determine which version of a package to install.

•

Never downgrade unless the priority of an available version exceeds 1000. ("Downgrading" is installing a less recent version of a package in place of a more recent version. Note that none of APT's default priorities exceeds 1000; such high priorities can only be set in the preferences file. Note also that downgrading a package can be risky.)

•

Install the highest priority version.

•

If two or more versions have the same priority, install the most recent one (that is, the one with the higher version number).

•

If two or more versions have the same priority and version number but either the packages differ in some of their metadata or the --reinstall option is given, install the uninstalled one.

In a typical situation, the installed version of a package (priority 100) is not as recent as one of the versions available from the sources listed in the sources.list(5) file (priority 500 or 990). Then the package will be upgraded when apt-get install some-package or apt-get upgrade is executed.

More rarely, the installed version of a package is more recent than any of the other available versions. The package will not be downgraded when apt-get install some-package or apt-get upgrade is executed.

Sometimes the installed version of a package is more recent than the version belonging to the target release, but not as recent as a version belonging to some other distribution. Such a package will indeed be upgraded when apt-get install some-package or apt-get upgrade is executed, because at least one of the available versions has a higher priority than the installed version.

### THE EFFECT OF APT PREFERENCES
The APT preferences file allows the system administrator to control the assignment of priorities. The file consists of one or more multi-line records separated by blank lines. Records can have one of two forms, a specific form and a general form.

•

The specific form assigns a priority (a "Pin-Priority") to a specified package and specified version or version range. For example, the following record assigns a high priority to all versions of the perl package whose version number begins with "5.8".

```
Package: perl
Pin: version 5.8*
Pin-Priority: 1001

```

•

The general form assigns a priority to all of the package versions in a given distribution (that is, to all the versions of packages that are listed in a certain Release file) or to all of the package versions coming from a particular Internet site, as identified by the site's fully qualified domain name. This general-form entry in the APT preferences file applies only to groups of packages. For example, the following record assigns a high priority to all package versions available from the local site.

```
Package: *
Pin: origin ""
Pin-Priority: 999

```

A note of caution: the keyword used here is "origin". This should not be confused with the Origin of a distribution as specified in a Release file. What follows the "Origin:" tag in a Release file is not an Internet address but an author or vendor name, such as "Debian" or "Ximian".

The following record assigns a low priority to all package versions belonging to any distribution whose Archive name is "unstable".

```
Package: *
Pin: release a=unstable
Pin-Priority: 50

```

The following record assigns a high priority to all package versions belonging to any release whose Archive name is "stable" and whose release Version number is "3.0".

```
Package: *
Pin: release a=unstable, v=3.0
Pin-Priority: 50

```

### HOW APT INTERPRETS PRIORITIES
Priorities (P) assigned in the APT preferences file must be positive or negative integers. They are interpreted as follows (roughly speaking):

P > 1000

causes a version to be installed even if this constitutes a downgrade of the package

990 < P <=1000

causes a version to be installed even if it does not come from the target release, unless the installed version is more recent

500 < P <=990

causes a version to be installed unless there is a version available belonging to the target release or the installed version is more recent

100 < P <=500

causes a version to be installed unless there is a version available belonging to some other distribution or the installed version is more recent

0 < P <=100

causes a version to be installed only if there is no installed version of the package

P < 0

prevents the version from being installed

If any specific-form records match an available package version then the first such record determines the priority of the package version. Failing that, if any general-form records match an available package version then the first such record determines the priority of the package version.

For example, suppose the APT preferences file contains the three records presented earlier:

```
Package: perl
Pin: version 5.8*
Pin-Priority: 1001
Package: *
Pin: origin ""
Pin-Priority: 999
Package: *
Pin: release unstable
Pin-Priority: 50
```

Then: •

The most recent available version of the perl package will be installed, so long as that version's version number begins with "5.8". If any 5.8* version of perl is available and the installed version is 5.9*, then perl will be downgraded.

•

A version of any package other than perl that is available from the local system has priority over other versions, even versions belonging to the target release.

•

A version of a package whose origin is not the local system but some other site listed in sources.list(5) and which belongs to an unstable distribution is only installed if it is selected for installation and no version of the package is already installed.

### DETERMINATION OF PACKAGE VERSION AND DISTRIBUTION PROPERTIES
The locations listed in the sources.list(5) file should provide Packages and Release files to describe the packages available at that location.

The Packages file is normally found in the directory .../dists/dist-name/component/arch: for example, .../dists/stable/main/binary-i386/Packages. It consists of a series of multi-line records, one for each package available in that directory. Only two lines in each record are relevant for setting APT priorities:

the Package: line

gives the package name

the Version: line

gives the version number for the named package

The Release file is normally found in the directory .../dists/dist-name: for example, .../dists/stable/Release, or .../dists/woody/Release. It consists of a single multi-line record which applies to all of the packages in the directory tree below its parent. Unlike the Packages file, nearly all of the lines in a Release file are relevant for setting APT priorities:

the Archive: line

names the archive to which all the packages in the directory tree belong. For example, the line "Archive: stable" specifies that all of the packages in the directory tree below the parent of the Release file are in a stable archive. Specifying this value in the APT preferences file would require the line:

```
Pin: release a=stable

```

the Version: line

names the release version. For example, the packages in the tree might belong to Debian GNU/Linux release version 3.0. Note that there is normally no version number for the testing and unstable distributions because they have not been released yet. Specifying this in the APT preferences file would require one of the following lines.

```
Pin: release v=3.0
Pin: release a=stable, v=3.0
Pin: release 3.0

```

the Component: line

names the licensing component associated with the packages in the directory tree of the Release file. For example, the line "Component: main" specifies that all the packages in the directory tree are from the main component, which entails that they are licensed under terms listed in the Debian Free Software Guidelines. Specifying this component in the APT preferences file would require the line:

```
Pin: release c=main

```

the Origin: line

names the originator of the packages in the directory tree of the Release file. Most commonly, this is Debian. Specifying this origin in the APT preferences file would require the line:

```
Pin: release o=Debian

```

the Label: line

names the label of the packages in the directory tree of the Release file. Most commonly, this is Debian. Specifying this label in the APT preferences file would require the line:

```
Pin: release l=Debian

```

All of the Packages and Release files retrieved from locations listed in the sources.list(5) file are stored in the directory /var/lib/apt/lists, or in the file named by the variable Dir::State::Lists in the apt.conf file. For example, the file debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release contains the Release file retrieved from the site debian.lcs.mit.edu for binary-i386 architecture files from the contrib component of the unstable distribution.

### OPTIONAL LINES IN AN APT PREFERENCES RECORD
Each record in the APT preferences file can optionally begin with one or more lines beginning with the word Explanation:. This provides a place for comments.

The Pin-Priority: line in each APT preferences record is optional. If omitted, APT assigs a priority of 1 less than the last value specified on a line beginning with Pin-Priority: release ....

## EXAMPLES

### TRACKING STABLE
The following APT preferences file will cause APT to assign a priority higher than the default (500) to all package versions belonging to a stable distribution and a prohibitively low priority to package versions belonging to other Debian distributions.

```
Explanation: Uninstall or do not install any Debian-originated
Explanation: package versions other than those in the stable distro
Package: *
Pin: release a=stable
Pin-Priority: 900
Package: *
Pin: release o=Debian
Pin-Priority: -10
```

With a suitable sources.list(5) file and the above preferences file, any of the following commands will cause APT to upgrade to the latest stable version(s).

```
apt-get install package-name
apt-get upgrade
apt-get dist-upgrade
```

The following command will cause APT to upgrade the specified package to the latest version from the testing distribution; the package will not be upgraded again unless this command is given again.

```
apt-get install package/testing
```

### TRACKING TESTING OR UNSTABLE
The following APT preferences file will cause APT to assign a high priority to package versions from the testing distribution, a lower priority to package versions from the unstable distribution, and a prohibitively low priority to package versions from other Debian distributions.

```
Package: *
Pin: release a=testing
Pin-Priority: 900
Package: *
Pin: release a=unstable
Pin-Priority: 800
Package: *
Pin: release o=Debian
Pin-Priority: -10
```

With a suitable sources.list(5) file and the above preferences file, any of the following commands will cause APT to upgrade to the latest testing version(s).

```
apt-get install package-name
apt-get upgrade
apt-get dist-upgrade
```

The following command will cause APT to upgrade the specified package to the latest version from the unstable distribution. Thereafter, apt-get upgrade will upgrade the package to the most recent testing version if that is more recent than the installed version, otherwise, to the most recent unstable version if that is more recent than the installed version.

```
apt-get install package/unstable
```

## SEE ALSO
apt-get(8) apt-cache(8) apt.conf(5) sources.list(5)

## BUGS
Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>.

## AUTHOR
Maintainer and contributor information can be found in the credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.


sources.list

title: sources.list(5)

summary: Package resource list for APT

text:
# sources.list(5)

## NAME
sources.list - Package resource list for APT

## DESCRIPTION
The package resource list is used to locate archives of the package distribution system in use on the system. At this time, this manual page documents only the packaging system used by the Debian GNU/Linux system. This control file is located in /etc/apt/sources.list

The source list is designed to support any number of active sources and a variety of source media. The file lists one source per line, with the most preferred source listed first. The format of each line is: type uri args. The first item, type, determines the format for args. uri is a Universal Resource Identifier (URI), which is a superset of the more specific and well-known Universal Resource Locator, or URL. The rest of the line can be marked as a comment by using a #.

## THE DEB AND DEB-SRC TYPES
The deb type describes a typical two-level Debian archive, distribution/component. Typically, distribution is generally one of stable, unstable, or testing, while component is one of main, contrib, non-free, or non-us. The deb-src type describes a debian distribution's source code in the same form as the deb type. A deb-src line is required to fetch source indexes.

The format for a sources.list entry using the deb and deb-src types are:

```
deb uri distribution [component1] [component2] [...]
```

The URI for the deb type must specify the base of the Debian distribution, from which APT will find the information it needs. distribution can specify an exact path, in which case the components must be omitted and distribution must end with a slash (/). This is useful for when only a particular sub-section of the archive denoted by the URI is of interest. If distribution does not specify an exact path, at least one component must be present.

distribution may also contain a variable, $(ARCH), which expands to the Debian architecture (i386, m68k, powerpc, ...) used on the system. This permits architecture-independent sources.list files to be used. In general this is only of interest when specifying an exact path, APT will automatically generate a URI with the current architecture otherwise.

Since only one distribution can be specified per line it may be necessary to have multiple lines for the same URI, if a subset of all available distributions or components at that location is desired. APT will sort the URI list after it has generated a complete set internally, and will collapse multiple references to the same Internet host, for instance, into a single connection, so that it does not inefficiently establish an FTP connection, close it, do something else, and then re-establish a connection to that same host. This feature is useful for accessing busy FTP sites with limits on the number of simultaneous anonymous users. APT also parallelizes connections to different hosts to more effectively deal with sites with low bandwidth.

It is important to list sources in order of preference, with the most preferred source listed first. Typically this will result in sorting by speed from fastest to slowest (CD-ROM followed by hosts on a local network, followed by distant Internet hosts, for example).

Some examples:

```
deb http://http.us.debian.org/debian stable main contrib non-free
deb http://http.us.debian.org/debian dists/stable-updates/

```

## URI SPECIFICATION
The currently recognized URI types are cdrom, file, http, and ftp.

file

The file scheme allows an arbitrary directory in the file system to be considered an archive. This is useful for NFS mounts and local mirrors or archives.

cdrom

The cdrom scheme allows APT to use a local CDROM drive with media swapping. Use the apt-cdrom(8) program to create cdrom entries in the source list.

http

The http scheme specifies an HTTP server for the archive. If an environment variable http_proxy is set with the format http://server:port/, the proxy server specified in http_proxy will be used. Users of authenticated HTTP/1.1 proxies may use a string of the format http://user:pass@server:port/ Note that this is an insecure method of authentication.

ftp

The ftp scheme specifies an FTP server for the archive. APT's FTP behavior is highly configurable; for more information see the apt.conf(5) manual page. Please note that a ftp proxy can be specified by using the ftp_proxy environment variable. It is possible to specify a http proxy (http proxy servers often understand ftp urls) using this method and ONLY this method. ftp proxies using http specified in the configuration file will be ignored.

copy

The copy scheme is identical to the file scheme except that packages are copied into the cache directory instead of used directly at their location. This is useful for people using a zip disk to copy files around with APT.

rsh

ssh

The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given user and access the files. No password authentication is possible, prior arrangements with RSA keys or rhosts must have been made. Access to files on the remote uses standard find and dd commands to perform the file transfers from the remote.

## EXAMPLES
Uses the archive stored locally (or NFS mounted) at /home/jason/debian for stable/main, stable/contrib, and stable/non-free.

```
deb file:/home/jason/debian stable main contrib non-free
```

As above, except this uses the unstable (development) distribution.

```
deb file:/home/jason/debian unstable main contrib non-free
```

Source line for the above

```
deb-src file:/home/jason/debian unstable main contrib non-free
```

Uses HTTP to access the archive at archive.debian.org, and uses only the hamm/main area.

```
deb http://archive.debian.org/debian-archive hamm main
```

Uses FTP to access the archive at ftp.debian.org, under the debian directory, and uses only the stable/contrib area.

```
deb ftp://ftp.debian.org/debian stable contrib
```

Uses FTP to access the archive at ftp.debian.org, under the debian directory, and uses only the unstable/contrib area. If this line appears as well as the one in the previous example in sources.list, a single FTP session will be used for both resource lines.

```
deb ftp://ftp.debian.org/debian unstable contrib
```

Uses HTTP to access the archive at nonus.debian.org, under the debian-non-US directory.

```
deb http://nonus.debian.org/debian-non-US stable/non-US main contrib non-free
```

Uses HTTP to access the archive at nonus.debian.org, under the debian-non-US directory, and uses only files found under unstable/binary-i386 on i386 machines, unstable/binary-m68k on m68k, and so forth for other supported architectures. [Note this example only illustrates how to use the substitution variable; non-us is no longer structured like this]

```
deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/
```

## SEE ALSO
apt-cache(8) apt.conf(5)

## BUGS
Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>.

## AUTHOR
Maintainer and contributor information can be found in the credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.


vendors.list

title: vendors.list(5)

summary: Security key configuration for APT

text:
# vendors.list(5)

## NAME
vendors.list - Security key configuration for APT

## DESCRIPTION
The package vendor list contains a list of all vendors from whom you wish to authenticate downloaded packages. For each vendor listed, it must contain the corresponding PGP key fingerprint, so that APT can perform signature verification of the release file and subsequent checking of the checksums of each downloaded package. To have authentication enabled, you must add the vendor identification string (see below) enclosed in square braces to the sources.list line for all sites that mirror the repository provided by that vendor.

The format of this file is similar to the one used by apt.conf. It consists of an arbitrary number of blocks of vendors, where each block starts with a string telling the key_type and the vendor_id.

Some vendors may have multiple blocks that define different security policies for their distributions. Debian for instance uses a different signing methodology for stable and unstable releases.

key_type is the type of the check required. Currently, there is only one type available which is simple-key.

vendor_id is the vendor identification string. It is an arbitrary string you must supply to uniquely identifify a vendor that's listed in this file. Example:

```
simple-key "joe"
{

   Fingerprint "0987AB4378FSD872343298787ACC";

   Name "Joe Shmoe <joe@shmoe.com>";
}
```

## THE SIMPLE-KEY TYPE
This type of verification is used when the vendor has a single secured key that must be used to sign the Release file. The following items should be present

Fingerprint

The PGP fingerprint for the key. The fingerprint should be expressed in the standard notion with or without spaces. The --fingerprint option for gpg(1) will show the fingerprint for the selected keys(s).

Name

A string containing a description of the owner of the key or vendor. You may put the vendor name and it's email. The string must be quoted with ".

## FILES
/etc/apt/vendors.list

## SEE ALSO
sources.list(5)

## BUGS
Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>.

## AUTHOR
Maintainer and contributor information can be found in the credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.


aoxsuper.conf

package: archiveopteryx

title: aoxsuper.conf(5)

text:
# aoxsuper.conf(5)

## NAME
aoxsuper.conf - configuration file for Archiveopteryx.

## SYNOPSIS
/etc/archiveopteryx/aoxsuper.conf

## DESCRIPTION
The aoxsuper.conf file contains a few configuration settings for Archiveopteryx. It is read by aox(8) at startup. Syntax errors, unknown variables, and other errors are logged on stderr.

aoxsuper.conf is usually created at installation time, by running /usr/lib64/archiveopteryx/installer.

There is only one required variable, namely db-owner-password.

## SECURITY NOTE
Anyone who can read aoxsuper.conf can see the database owner password, and use this password to read all mail, or even to damage or destroy the mail database.

By default, aoxsuper.conf is readable only by root.

## SETTINGS
The format is as for archiveopteryx.conf(5):

name = value # comment

All variables in archiveopteryx.conf(5) may be overridden in aoxsuper.conf, if it is necessary that aox(8) sees a different value than the servers see.

### Database Access
db-owner

The name of the Postgres user that owns the database and is used to perform privileged operations (such as deleting mail). The default is aoxsuper.

db-owner-password

The database password used for the db-owner. The default is an empty string.

Unless a password is specified, the Archiveopteryx installer sets up a randomly-chosen password and writes it to the configuration file.

## AUTHOR
The Archiveopteryx Developers, info@aox.org.

## VERSION
This man page covers Archiveopteryx version 3.1.3, released 2010-03-10, http://archiveopteryx.org/3.1.3

## SEE ALSO
archiveopteryx.conf(5), archiveopteryx(8), deliver(8), logd(8), http://archiveopteryx.org


archiveopteryx.conf

title: archiveopteryx.conf(5)

text:
# archiveopteryx.conf(5)

## NAME
archiveopteryx.conf - configuration file for Archiveopteryx.

## SYNOPSIS
/etc/archiveopteryx/archiveopteryx.conf

## DESCRIPTION
The archiveopteryx.conf file contains most global configuration settings for Archiveopteryx. It is read by each server at startup. Syntax errors, unknown variables, and other errors are logged via logd(8).

archiveopteryx.conf and its sibling aoxsuper.conf(5) are usually created at installation time, by running /usr/lib64/archiveopteryx/installer.

There is only one required variable, namely db-password.

## SECURITY NOTE
Anyone who can read archiveopteryx.conf can see the database user password, and use this password to read all mail and in many cases even delete mail.

By default, archiveopteryx.conf is readable only by root.

## SETTINGS
All settings share a common format:

name = value # comment

For the *-address variables, the value may be either a hostname, an IPv4 or IPv6 address, the fully-qualified path to a Unix socket. For imap-address and a few other variables, the empty string is also allowed, meaning "all IPv4/6 addresses of this host".

### General Settings
hostname

Most of the servers need to know the fully-qualified hostname. The default is computed at runtime and is normally acceptable.

Note that if the name is "localhost", there may be problems with TLS. An IMAP/POP/SMTP client may refuse a server certificate for "localhost" if it already has seen a different certificate for "localhost". We strongly suggest using a different hostname.

use-ipv4

decides whether the various servers accept IPv4 connections. true by default.

use-ipv6

decides whether the various servers accept IPv6 connections. true by default.

undelete-time

is the number of days a message can be undeleted after being deleted, 49 by default.

server-processes

is the number of processes started to serve IMAP/POP clients. This is 1 by default. 1 is suitable for a small server.

The server-processes setting should be about as large as the number of CPUs available, perhaps a little larger. We advise asking info@aox.org in unusual cases.

### Database Access
db

The type of database. The default, postgres, is currently the only supported value.

db-address

The address of the database server. The default is 127.0.0.1.

db-port

The port number of the database server. The default is 5432.

db-name

The name of the database to use. The default is archiveopteryx.

db-schema

The name of the schema in the database where the database objects are installed. The default is public. It is safe to ignore this setting.

db-user

The name of the unprivileged Postgres user that the servers ordinarily use. The default is aox.

db-password

The database password used for the db-user. The default is an empty string.

Unless a password is specified, Archiveopteryx sets up a randomly-chosen password and writes it to the configuration file during installation.

db-max-handles

The maximum number of database handles that Archiveopteryx may open. The default is 4.

The server creates one handle at startup, and may create others if the load justifies it (and as controlled by db-handle-interval). Note, however, that when running with security=on, new database handles can be created only if you connect to the server using TCP/IP, not via Unix sockets. In the latter case, the server must use the first handle throughout its lifetime, since the socket is no longer accessible after chroot.

db-handle-interval

The minimum interval (in seconds) between the creation of new database handles. The default is 120.

### Logging
log-address

The address of the log server. The default is 127.0.0.1.

log-port

The port number at which logd(8) listens, and to which the other servers connect. The default is 2054.

logfile

tells logd(8) where to write log events. It may be set to an absolute file name (starting with '/'), or to "syslog/category" (e.g. "syslog/local2"), which logs via syslog(2), or to -, which causes everything to be logged to stdout. The default is to log to syslog/mail.

logfile-mode

is 400 by default and controls the permissions used by logd(8) if it creates logfile. The format (three octal digits) is the same as that used by chmod(1).

log-level

may be set to debug, info, significant, or error, in increasing order of severity (it is significant by default). If a message is logged with this severity or above, the log server writes it to the logfile immediately. Messages with lower severity are discarded.

### Security
security

is enabled by default, and should be enabled whenever Archiveopteryx is used in production. It causes the servers to lock themselves into a chroot jail and run with very limited unix and database privileges. Most notably, they cannot open files or delete messages.

Turning security off has exactly one advantage: it simplifies debugging.

allow-plaintext-access

controls whether it is possible to read mail via an unencrypted connection. The default value is always. If this is changed to localhost, plaintext connections are permitted only from the host itself. If it is changed to never, TLS is necessary to read mail.

jail-directory

is /var/lib/archiveopteryx by default. On startup, each secure server uses chroot(2) to jail themselves into this directory, to which the jail-user should have minimal rights (only o+x permissions).

jail-user

is the user name under which the servers run, and is aox by default. On startup, the servers change UID to this user. This user should not have read or write access to the jail directory.

jail-group

is the group name under which the servers run, and is aox by default. On startup, the servers change GID to this user.

entropy-source

is the fully-qualified name of a file that acts as a source for random bytes, whenever they are needed (e.g. SASL challenges). Set to /dev/urandom by default. If this is instead set to /dev/random, Archiveopteryx never uses anything less than perfectly random numbers. In this case, make sure that there's enough entropy, or else a series of rapid login attempts can block the entire server.

### User Authentication
http://archiveopteryx.org/sasl describes SASL and authentication in more detail.

allow-plaintext-passwords

controls whether the servers permit plaintext passwords, and how such passwords are handled. May be set to always (which is the default) or never. (Future versions of Archiveopteryx will offer more settings.)

auth-digest-md5

controls whether the servers offer the digest-md5 SASL mechanism. Disabled by default due to interoperability problems.

auth-cram-md5

controls whether the servers offer the cram-md5 SASL mechanism. Enabled by default.

auth-plain

controls whether the servers offer the plain-text SASL mechanism. Enabled by default.

Note that disabling auth-plain doesn't disable all plaintext passwords, since SASL isn't always used. To disable plaintext passwords, use the allow-plaintext-passwords variable above.

auth-anonymous

controls whether the servers offer anonymous login, disabled by default.

### Mail delivery
use-lmtp

controls whether archiveopteryx(8) should accept mail via LMTP (RFC 2033). The default is enabled.

lmtp-address

specifies the address where archiveopteryx(8) should listen for LMTP connections, and to which deliver(8) should connect. The default is 127.0.0.1.

lmtp-port

specifies which port archiveopteryx(8) should listen to, and which port deliver(8) should connect to. The default is 2026.

use-smtp

controls whether archiveopteryx(8) should accept mail via SMTP/ESMTP (RFC 2821/1869). SMTP is disabled by default.

smtp-address

specifies the address where archiveopteryx(8) should listen for SMTP connections The default is an empty string, which means all available IPv4 and IPv6 interfaces.

smtp-port

specifies which port archiveopteryx(8) should listen to. The default is 25.

use-subaddressing

controls whether messages addressed to user+tag@example.org are accepted for delivery to user@example.org (if the latter is a valid recipient address). The default is false.

address-separator

is the character that separates the username from the subaddress in a localpart, e.g. the + in user+tag@example.org. The default, which you should not need to change, is +. This setting is relevant only if use-subaddressing is true.

soft-bounce

specifies whether a delivery problem causes a message to be rejected permanently (soft-bounce disabled) or queued at the MTA (soft-bounce enabled). This is enabled by default. We recommend disabling it when you are confident that mail delivery works.

message-copy

specifies whether or not to keep filesystem copies of incoming messages, e.g. to burn a mail log to CD/DVD regularly. The default value of none means that no copies are ever made.

Setting it to delivered keeps copies of all delivered messages, a value of errors keeps only those messages that could not be delivered because of errors, and all keeps copies of all messages.

message-copy-directory

specifies a directory to which mail delivered via LMTP/SMTP is copied, if message-copy is set. Its default value is /var/lib/archiveopteryx/messages. If you set use-security, message-copy-directory must be a subdirectory of jail-directory.

If message-copy-directory does not exist or is not writable, Archiveopteryx logs an error at startup and exits.

Each file in message-copy-directory contains one or more header lines, namely Error, From and To, then an empty line, then the verbatim received mail message. If there is an Error line, the message was not delivered, and the rest of the line describes the problem.

The file's name is a unique string of numbers and hyphens. It ends with "-err" if there was an error injecting the message into the database.

### SMTP Submission
use-smtp-submit

controls whether archiveopteryx(8) should accept mail via SMTP-Submit (RFC 4409). The default is enabled.

check-sender-addresses

controls whether archiveopteryx(8) should check whether the sender is authorised to use the addresses in the message. From, Sender, Return-Path (SMTP Mail From) and Reply-To are all checked. The default is disabled.

submit-copy-to-sender

controls whether archiveopteryx(8) should ensure that the sender receives a copy of outgoing mail. The default is disabled. This can be used to ensure that all outgoing mail is archived.

If the sender already receives a copy of the message, submit-copy-to-sender has no effect. Senders will not receive two copies. The copy is always sent to the user who sends the message, even if the From and/or Return-Path is different. The sender's copy will be delivered through the configured smarthost, as with any other outgoing message.

smtp-submit-address

specifies the address where archiveopteryx(8) should listen for Submit connections. The default, an empty string, means to listen on all available IPv4 and IPv6 addresses. 127.0.0.1.

smtp-submit-port

specifies which port archiveopteryx(8) should listen to. The default is 587.

smarthost-address

specifies the address of the SMTP server which is used to relay mail to remote recipients. The default is 127.0.0.1.

smarthost-port

specifies the port to use when forwarding mail to a smarthost. The default is 25. (These defaults thus conflict with the default values of smtp-address and smtp-port when use-smtp is enabled.)

use-smtps

controls whether archiveopteryx(8) should accept SSL-wrapped SMTP connections. The default is false (and the use of STARTTLS with SMTP Submit is strongly recommended instead).

smtps-address

is the address where archiveopteryx(8) listens for new SSL-wrapped SMTP connections. As for smtp-address, the default is an empty string, which means all available IPv4 and IPv6 addresses.

smtps-port

is the port where archiveopteryx(8) accepts SSL-wrapped SMTP connections, 465 by default.

### IMAP
use-imap

must be enabled for archiveopteryx(8) to accept IMAP connections. The default is true.

imap-address

is the address where archiveopteryx(8) listens for new connections. The default, an empty string, means to listen on all available IPv4 and IPv6 addresses.

imap-port

is the port where archiveopteryx(8) accepts connections, 143 by default.

use-imaps

controls whether archiveopteryx(8) should also accept SSL-wrapped IMAP connections. The default is false (and the use of STARTTLS over the standard IMAP port is strongly recommended instead).

imaps-address

is the address where archiveopteryx(8) listens for new SSL-wrapped connections. As with imap-address, the default is an empty string, which means all available IPv4 and IPv6 addresses.

imaps-port

is the port where archiveopteryx(8) accepts SSL-wrapped connections, 993 by default.

### POP
use-pop

must be enabled for archiveopteryx(8) to accept POP3 connections. The default is false.

pop-address

is the address where archiveopteryx(8) listens for new connections. The default, an empty string, means to listen on all available IPv4 and IPv6 addresses.

pop-port

is the port where archiveopteryx(8) accepts connections, 110 by default.

use-pops

controls whether archiveopteryx(8) should also accept SSL-wrapped POP connections. The default is false (and the use of STARTTLS over the standard POP port is strongly recommended instead).

pops-address

is the address where archiveopteryx(8) listens for new SSL-wrapped connections. As with pop-address, the default is an empty string, which means all available IPv4 and IPv6 addresses.

pops-port

is the port where archiveopteryx(8) accepts SSL-wrapped connections, 995 by default.

### SIEVE
use-sieve

controls whether or not the managesieve server is started. The default is enabled.

managesieve-address

specifies the address where archiveopteryx(8) should listen for connections. The default is an empty string, which means to listen on all available IPv4 and IPv6 addresses. anempt

managesieve-port

specifies which port archiveopteryx(8) should listen to. The default is 2000.

### TLS
use-tls

regulates whether Archiveopteryx supports TLS at all. The default is enabled.

tls-certificate

is the absolute file name of the TLS private key and signed certificate, e.g. /etc/archiveopteryx/imap.p15. If tls-certificate is not specified, tlsproxy generates a private key and a self-signed certificate at runtime and stores both in /etc/archiveopteryx/automatic-key.pem.

tls-certificate-label

is not used in 3.1.4.

## SYNTAX
The name is case insensitive, as shown:

hostname = test1.example.com

HOSTNAME = mailserver.example.org

The value is case insensitive wherever possible. (Exceptions include logfile, db-user and db-password.)

There are three datatypes: Strings, numbers and toggles.

Strings may be written as a single unquoted word or quoted with either single or double quotes, as shown in these three examples:

db-password = single.word

db-password = "rock'n'roll" # a 12-character password

db-password = 'two words, quoted' # a 17-character one

Only single-line strings can be used. Single-word strings may contain the characters a-z, A-Z, 0-9, dot, hyphen and slash.

Numbers are integers not smaller than 0 and not larger than 2147483647 (ie. 31-bit unsigned integers).

Toggles are written as a single word. Yes, true, on, 1, and enabled all mean that the toggle is enabled, while no, false, off, 0, and disabled unsurprisingly mean disabled. Toggles are case-insensitive.

use-lmtp = yes

crash-and-delete-all-the-mail = off

Spaces are allowed at the start of the line, before and after '=', and after the value. Comments extend from '#' to the end of the line.

\# this is a comment

hostname=stuff.nonsense.example.com # also a comment

logfile = /dev/null# and this is a comment

\# empty lines are ignored

## AUTHOR
The Archiveopteryx Developers, info@aox.org.

## VERSION
This man page covers Archiveopteryx version 3.1.3, released 2010-03-10, http://archiveopteryx.org/3.1.3

## SEE ALSO
archiveopteryx(8), deliver(8), logd(8), http://archiveopteryx.org


mac-vendor

package: arp-scan

title: mac-vendor(5)

summary: Ethernet vendor file for arp-scan

text:
# mac-vendor(5)

## NAME
mac-vendor - Ethernet vendor file for arp-scan

## SYNOPSIS
mac-vendor.txt

## DESCRIPTION
The mac-vendor.txt contains Ethernet MAC to vendor string mappings for arp-scan. It is used in addition to the IEEE OUI listings in ieee-oui.txt. It is for MAC-vendor mappings that are not covered by the IEEE manufacturer listings.

Each line in the mac-vendor.txt file contains a MAC-vendor mapping in the form:

```
<MAC-Prefix><TAB><Vendor>
```

Where <MAC-Prefix> is the prefix of the MAC address in hex, and <Vendor> is the name of the vendor. The prefix can be of any length from two hex digits (one octet) to twelve hex digits (six octets, the entire Ethernet hardware address).

Alphabetic hex characters [A-F] may use either upper or lower case, and seperator symbols such as ":", "-" and "." are ignored. This permits the use of standard format MAC addresses in this file.

For example:

01:23:45 matches 01:23:45:xx:xx:xx, where xx represents any value;

01:23:45:6 matches 01:23:45:6x:xx:xx; and

01:23:45:67 matches 01:23:45:67:xx:xx.

Do not include entries from the IEEE OUI listings, as these are already in the file ieee-oui.txt, which is automatically used by arp-scan. See get-oui(1) for details of how to update the OUI listings.

The order of entries in the file is not important.

Blank lines and lines beginning with "#" are ignored. arp-scan will attempt to match larger prefixes before trying to match smaller ones, and will stop at the first match.

## FILES
/usr/local/share/arp-scan/mac-vendor.txt

## EXAMPLE

```
# From nmap Debian bug report #369681 dated 31 May 2006
52:54:00        QEMU
b0:c4:20        Bochs
# From RFC 2338: 00-00-5E-00-01-{VRID}
00:00:5e:00:01  VRRP (last octet is VRID)
# Microsoft WLBS (Windows NT Load Balancing Service)
# http://www.microsoft.com/technet/prodtechnol/acs/reskit/acrkappb.mspx
02:bf   Microsoft WLBS (last four octets are IP address)
# Cisco HSRP (Hot Standby Routing Protocol)
# 00-00-0c-07-ac-XX, where XX is the HSRP group number (0 to 255)
00:00:0c:07:ac  HSRP (last octet is group number)
```

## SEE ALSO
arp-scan(1)

get-oui(1)

arp-fingerprint(1)


atoprc

package: atop

title: atoprc(5)

text:
# atoprc(5)

## NAME
atoprc - atop/atopsar related rcfile

## DESCRIPTION
This manual page documents the rcfile of the atop and atopsar commands. These commands can be used to monitor the system and process load on a Linux system.

The atoprc file contains the default settings. These settings are read during startup, first from the system-wide rcfile /etc/atoprc and after that from the user-specific rcfile ~/.atoprc (so system-wide settings can be overruled by an individual user). The options in both rcfiles are identical.

## OPTIONS
The rcfile contains keyword-value pairs, one on every line (blank lines and lines starting with a #-sign are ignored).

The following keywords can be specified:

flags

A list of default flags for atop can be defined here. The flags which are allowed are 't', 'B', 'H', 'G', '2' till '9', 'g', 'm', 'd', 'n', 'u', 'p', 's', 'c', 'v', 'C', 'M', 'D', 'N', 'A', 'a', 'y', 'Y', 'f', 'F', 'R', '1', 'e', 'E' and 'x'.

twindir

The default absolute path name of the temporary directory in which the twin file should be allocated.

interval

The default interval value in seconds.

linelen

The length of a screen line when sending output to a file or pipe (default 80).

username

The default regular expression for the users for which active processes will be shown.

procname

The default regular expression for the process names to be shown.

maxlinecpu

The maximum number of active CPUs that will be shown.

maxlinegpu

The maximum number of active GPUs that will be shown.

maxlinelvm

The maximum number of active logical volumes that will be shown.

maxlinemdd

The maximum number of active multiple devices that will be shown.

maxlinedisk

The maximum number of active disks that will be shown.

maxlinenfsm

The maximum number of NFS mounts that will be shown on an NFS client.

maxlineintf

The maximum number of active network interfaces that will be shown.

maxlinecont

The maximum number of active containers that will be shown.

cpucritperc

The busy percentage considered critical for a processor (see section COLORS in the man-page of the atop command). This percentage is used to determine a weighted percentage for line coloring and sorting of active processes in text mode. When this value is zero, no line coloring or automatic sorting is performed for this resource.

dskcritperc

The busy percentage considered critical for a disk (see section COLORS in the man-page of the atop command). This percentage is used to determine a weighted percentage for line coloring and sorting of active processes in text mode. When this value is zero, no line coloring or automatic sorting is performed for this resource.

netcritperc

The busy percentage considered critical for a network interface (see section COLORS in the man-page of the atop command). This percentage is used to determine a weighted percentage for line coloring and sorting of active processes in text mode. When this value is zero, no line coloring or automatic sorting is performed for this resource.

memcritperc

The percentage considered critical for memory utilization (see section COLORS in the man-page of the atop command). This percentage is used to determine a weighted percentage for line coloring and sorting of active processes in text mode. When this value is zero, no line coloring or automatic sorting is performed for this resource.

swpcritperc

The occupation percentage considered critical for swap space (see section COLORS in the man-page of the atop command). This percentage is used to determine a weighted percentage for line coloring and sorting of active processes in text mode. When this value is zero, no line coloring or automatic sorting is performed for this resource.

swoutcritsec

The number of pages swapped out per second considered critical for for memory utilization (see section COLORS in the man-page of the atop command). This threshold is used in combination with 'memcritperc' to determine a weighted percentage for line coloring and sorting of active processes in text mode. When this value is zero, no line coloring or automatic sorting is performed for this resource.

almostcrit

A percentage of the critical percentage to determine if the resource is almost critical (see section COLORS in the man-page of the atop command). When this value is zero, no line coloring for `almost critical' is performed.

cpubarwidth

Number of columns used per bar in the processor bar graph. The default value is 0 which means that the bar width will be scaled automatically (the wider the terminal, the more columns per bar up to a maximum of three). With the value 1, 2 or 3 the number of bars can be statically pinned to that number of columns, with one column of white space in between the bars.

colorinfo

Definition of color name for information messages (default: green) in text mode.

Allowed colors are: red green yellow blue magenta cyan black white.

colorthread

Definition of color name for thread-specific lines when using the 'y' option (default: yellow).

Allowed colors are: red green yellow blue magenta cyan black white.

coloralmost

Definition of color name for almost critical resources (default: cyan) in text mode.

Allowed colors are: red green yellow blue magenta cyan black white.

colorcritical

Definition of color name for critical resources (default: red) in text mode.

Allowed colors are: red green yellow blue magenta cyan black white.

atopsarflags

A list of default flags for atopsar can be defined here. The flags that are allowed are 'S', 'x', 'C', 'M', 'H', 'a', 'A' and the flags to select one or more specific reports.

perfevents

Defines whether or not the CPU cycle counter should be retrieved by atop via the 'perf' counters. The values 'auto' (default), 'enable' or 'disable' can be specified. In case of 'auto', the CPU cycle counter will not be retrieved on virtual machines due to the overhead of reading this counter in a guest.

pacctdir

The name of the topdirectory used by the atopacctd daemon. In this directory, the daemon creates a subdirectory pacct_shadow.d in which files will be written containing the process accounting records. The default topdirectory is /var/run and this option only has to be specified when the atopacctd daemon is started with an alternative topdirectory as command line argument.

This option can only be specified in the /etc/atoprc file (on system level)!

An example of the /etc/atoprc or ~/.atoprc file:

flags Aaf

interval 5

username

procname

maxlinecpu 4

maxlinedisk 10

maxlineintf 5

cpucritperc 80

almostcrit 90

atopsarflags CMH

ownprocline PID:50 VGROW:40 RGROW:45 COMMAND-LINE:50

ownpagline PAGSCAN:3 BLANKBOX:0 PAGSWIN:3 PAGSWOUT:7

The keywords 'ownprocline' and 'ownpagline' are explained in the subsequent section.

## OWN DEFINITION OF OUTPUT LINE
Via the rcfile it is possible to define the layout of the output lines yourself, i.e. you can define the layout of one line with process information with the keyword 'ownprocline' (to be selected with the key 'o' or the flag -o) and you can redefine all lines with system information.

The layout of an output-line can be defined as follows (notice that this should be specified as one line in the rcfile):

keyword <columnid>:<prio> [<columnid>:<prio> ...]

The columnid is the symbolic name of a column that should shown at this position in the output line.

The prio is a positive integer value that determines which columns have precedence whenever not all specified columns fit into the current screen-width. The higher value, the higher priority.

The column-specifications should be separated by a space. The order in which columns have been specified is the order in which they will be shown, with respect to their priority (columns that do not fit, will be dropped dynamically).

A special columnid for system lines is 'BLANKBOX'. This indicates that an empty column is required at this position. Also this special columnid is followed by a priority (usually low).

The following definition can be specified for process information:

ownprocline

The columnids are the names of the columns that are shown in the normal output of the process-related lines that are shown by atop such as 'PID', 'CMD', 'S', .... The only exception is the special columnid 'SORTITEM' that is used to show one of the columns CPU%/DSK%/MEM%/NET%, depending on the chosen sort-criterium.

An example of a user-defined process line:

ownprocline PID:20 PPID:10 SYSCPU:15 USRCPU:15 VGROW:14 VSIZE:12 RGROW:14 RSIZE:12 ST:8 EXC:7 S:11 SORTITEM:18 CMD:20

The following definitions are used internally by atop as the default system lines (you can redefine each of them in the rcfile as one line):

ownsysprcline

Redefinition of line labeled with 'PRC':

ownsysprcline PRCSYS:8 PRCUSER:8 BLANKBOX:0 PRCNPROC:7 PRCNZOMBIE:5 PRCCLONES:4 BLANKBOX:0 PRCNNEXIT:6

ownallcpuline

Redefinition of line labeled with 'CPU' for total CPU-utilization:

ownallcpuline CPUSYS:8 CPUUSER:7 CPUIRQ:4 BLANKBOX:0 CPUIDLE:5 CPUWAIT:6 BLANKBOX:0 CPUSTEAL:1 CPUGUEST:3

ownonecpuline

Redefinition of line labeled with 'CPU' for utilization of one CPU:

ownonecpuline CPUISYS:8 CPUIUSER:7 CPUIIRQ:4 BLANKBOX:0 CPUIIDLE:5 CPUIWAIT:6 BLANKBOX:0 CPUISTEAL:1 CPUIGUEST:3

owncplline

Redefinition of line labeled with 'CPL':

owncplline CPLAVG1:4 CPLAVG5:3 CPLAVG15:2 BLANKBOX:0 CPLCSW:6 CPLINTR:5 BLANKBOX:0 CPLNUMCPU:1

ownmemline

Redefinition of line labeled with 'MEM':

ownmemline MEMTOT:2 MEMFREE:5 MEMCACHE:3 MEMDIRTY:1 MEMBUFFER:3 MEMSLAB:3 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0

ownswpline

Redefinition of line labeled with 'SWP':

ownswpline SWPTOT:3 SWPFREE:4 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 SWPCOMMITTED:5 SWPCOMMITLIM:6

ownpagline

Redefinition of line labeled with 'PAG':

ownpagline PAGSCAN:3 PAGSTALL:1 BLANKBOX:0 PAGSWIN:4 PAGSWOUT:3

owndskline

Redefinition of lines labeled with 'LVM', 'MDD' and 'DSK':

owndskline DSKNAME:8 DSKBUSY:7 DSKNREAD:6 DSKNWRITE:6 DSKKBPERRD:4 DSKKBPERWR:4 DSKMBPERSECRD:5 DSKMBPERSECWR:5 DSKAVQUEUE:1 DSKAVIO:5

ownnettrline

Redefinition of line labeled with 'NET' for transport:

ownnettrline NETTRANSPORT:9 NETTCPI:8 NETTCPO:8 NETUDPI:8 NETUDPO:8 NETTCPACTOPEN:6 NETTCPPASVOPEN:5 NETTCPRETRANS:4 NETTCPINERR:3 NETTCPORESET:20 NETUDPNOPORT:1 NETUDPINERR:3

ownnetnetline

Redefinition of line labeled with 'NET' for network:

ownnetnetline NETNETWORK:5 NETIPI:4 NETIPO:4 NETIPFRW:4 NETIPDELIV:4 BLANKBOX:0 BLANKBOX:0 BLANKBOX:0 NETICMPIN:1 NETICMPOUT:1

ownnetifline

Redefinition of line labeled with 'NET' for interfaces:

ownnetifline NETNAME:8 NETPCKI:7 NETPCKO:7 NETSPEEDIN:6 NETSPEEDOUT:6 NETCOLLIS:3 NETMULTICASTIN:2 NETRCVERR:5 NETSNDERR:5 NETRCVDROP:4 NETSNDDROP:4

The lines above are shown in the order as shown by atop in combination with the -f flag (in a very wide window you should be able to see all of the columns).

## SEE ALSO
atop(1), atopsar(1), atopacctd(8), netatop(4), netatopd(8), logrotate(8)

https://www.atoptool.nl

## AUTHOR
Gerlof Langeveld (gerlof.langeveld@atoptool.nl)

JC van Winkel


audisp-remote.conf

package: audit

title: audisp-remote.conf(5)

summary: the audisp-remote configuration file

text:
# audisp-remote.conf(5)

## NAME
audisp-remote.conf - the audisp-remote configuration file

## DESCRIPTION
audisp-remote.conf is the file that controls the configuration of the audit remote logging subsystem. The options that are available are as follows:

remote_server

This is a one word character string that is the remote server hostname or address that this plugin will send log information to. This can be the numeric address or a resolvable hostname.

port

This option is an unsigned integer that indicates what port to connect to on the remote machine.

local_port

This option is an unsigned integer that indicates what local port to connect from on the local machine. If unspecified (the default) or set to the word any then any available unprivileged port is used. This is a security mechanism to prevent untrusted user space apps from injecting events into the audit daemon. You should set it to an unused port < 1024 to ensure that only privileged users can bind to that port. Then also set the tcp_client_ports in the aggregating auditd.conf file to match the ports that clients are sending from.

transport

This parameter tells the remote logging app how to send events to the remote system. The valid options are TCP, and KRB5. If set to TCP, the remote logging app will just make a normal clear text connection to the remote system. If its set to KRB5, then Kerberos 5 will be used for authentication and encryption. The default value is TCP.

mode

This parameter tells the remote logging app what strategy to use getting records to the remote system. Valid values are immediate, and forward . If set to immediate, the remote logging app will attempt to send events immediately after getting them. forward means that it will store the events to disk and then attempt to send the records. If the connection cannot be made, it will queue records until it can connect to the remote system. The depth of the queue is controlled by the queue_depth option.

queue_file

Path of a file used for the event queue if mode is set to forward. The default is /var/spool/audit/remote.log.

queue_depth

This option is an unsigned integer that determines how many records can be buffered to disk or in memory before considering it to be a failure sending. This parameter affects the forward mode of the mode option and internal queueing for temporary network outages. The default depth is 2048.

format

This parameter tells the remote logging app what data format will be used for the messages sent over the network. The default is managed which adds some overhead to ensure each message is properly handled on the remote end, and to receive status messages from the remote server. If ascii is given instead, each message is a simple ASCII text line with no overhead at all. The ascii format is a very simplistic protocol. If there are any network problems, it will cause audisp-remote to exit. Auditd may or may not restart it on next event. If something more robust is needed, use the managed format. If mode is set to forward, format must be managed.

network_retry_time

The time, in seconds, between retries when a network error is detected. Note that this pause applies starting after the second attempt, so as to avoid unneeded delays if a reconnect is sufficient to fix the problem. The default is 1 second.

max_tries_per_record

The maximum number of times an attempt is made to deliver each message. The minimum value is one, as even a completely successful delivery requires at least one try. If too many attempts are made, the network_failure_action action is performed. The default is 3.

max_time_per_record

The maximum amount of time, in seconds, spent attempting to deliver each message. Note that both this and max_tries_per_record should be set, as each try may take a long time to time out. The default value is 5 seconds. If too much time is used on a message, the network_failure_action action is performed.

heartbeat_timeout

This parameter determines how often in seconds the client should send a heartbeat event to the remote server. This is used to let both the client and server know that each end is alive and has not terminated in a way that it did not shutdown the connection uncleanly. This value must be coordinated with the server's tcp_client_max_idle setting. The default value is 0 which disables sending a heartbeat.

network_failure_action

This parameter tells the system what action to take whenever there is an error detected when sending audit events to the remote system. Valid values are ignore, syslog, exec, warn_once, suspend, single, halt, and stop. If set to ignore, the remote logging app does nothing. If an event was sent, its dequeued. Syslog means that it will issue a warning to syslog. If an event was sent, its dequeued. This is the default. exec /path-to-script will execute the script. You cannot pass parameters to the script. If an event was sent, its dequeued. warn_once_continue is like syslog except that only one message is put in syslog until an event is successfully transferred. warn_once is like warn_once_continue except that the event is not dequeued. Suspend will cause the remote logging app to stop sending records to the remote system. The logging app will still be alive. If an event was sent, it is not dequeued. The single option will cause the remote logging app to put the computer system in single user mode. If an event was sent, it is not dequeued. The stop option will cause the remote logging app to exit, but leave other plugins running. If an event was sent, it is not dequeued. The halt option will cause the remote logging app to shutdown the computer system. If an event was sent, it is not dequeued. The default is to stop.

disk_low_action

Likewise, this parameter tells the system what action to take if the remote end signals a disk low error. The default is ignore.

disk_full_action

Likewise, this parameter tells the system what action to take if the remote end signals a disk full error. The default is warn_once.

disk_error_action

Likewise, this parameter tells the system what action to take if the remote end signals a disk error. The default is warn_once.

remote_ending_action

Likewise, this parameter tells the system what action to take if the network connection is lost. This action has one additional option, reconnect which tells the remote plugin to attempt to reconnect to the server upon receipt of the next audit record. If an event was being sent when something triggered this action, it is not dequeued. If it is unsuccessful in reconnecting, the audit record could be lost. The default is to reconnect.

generic_error_action

Likewise, this parameter tells the system what action to take if the remote end signals an error we don't recognize. The default is to log it to syslog.

generic_warning_action

Likewise, this parameter tells the system what action to take if the remote end signals a warning we don't recognize. The default is to log it to syslog.

queue_error_action

Likewise, this parameter tells the system what action to take if there is a problem working with a local record queue. The default is stop.

overflow_action

This parameter tells the system what action to take if the internal event queue overflows. Valid values are ignore, syslog, suspend, single, and halt . If set to ignore, the remote logging app does nothing. Syslog means that it will issue a warning to syslog. This is the default. Suspend will cause the remote logging app to stop sending records to the remote system. The logging app will still be alive. The single option will cause the remote logging app to put the computer system in single user mode. The halt option will cause the remote logging app to shutdown the computer system.

startup_failure_action

This parameter tells the system what action to take whenever there is an error connecting to the remote system during startup. Typically, this is benign as the plugin's default behavior is to attempt reconnecting until it succeeds. But there may be times when you want to do something different. Valid values are ignore, syslog, exec, warn_once, and warn_once_continue . If set to ignore, the remote logging app does nothing. Syslog means that it will issue a warning to syslog. exec /path-to-script will execute the script. You cannot pass parameters to the script. warn_once is like syslog except that only one message is put in syslog until an event is successfully transferred. warn_once_continue is like warn_once except it ignores the problem. This is the default.

enable_krb5

This option is deprecated. Use the transport option to enable Kerberos support. If this option follows the transport configuration option, it will override the transport setting. This would be the normal expected behavior for backwards compatibility. If set to yes, Kerberos 5 will be used for authentication and encryption. Default is no. Note that encryption can only be used with managed connections, not plain ASCII.

krb5_principal

If specified, This is the expected principal for the server. The client and server will use the specified principal to negotiate the encryption. The format for the krb5_principal is like somename/hostname, see the auditd.conf man page for details. If not specified, the krb5_client_name and remote_server values are used.

krb5_client_name

This specifies the name portion of the client's own principal. If unspecified, the default is "auditd". The remainder of the principal will consist of the host's fully qualified domain name and the default Kerberos realm, like this: auditd/host14.example.com@EXAMPLE.COM (assuming you gave "auditd" as the krb_client_name). Note that the client and server must have the same principal name and realm.

krb5_key_file

Location of the key for this client's principal. Note that the key file must be owned by root and mode 0400. The default is /etc/audisp/audisp-remote.key

## NOTES
Specifying a local port may make it difficult to restart the audit subsystem due to the previous connection being in a TIME_WAIT state, if you're reconnecting to and from the same hosts and ports as before.

The network failure logic works as follows: The first attempt to deliver normally "just works". If it doesn't, a second attempt is immediately made, perhaps after reconnecting to the server. If the second attempt also fails, audispd-remote pauses for the configured time and tries again. It continues to pause and retry until either too many attempts have been made or the allowed time expires. Note that these times govern the maximum amount of time the remote server is allowed in order to reboot, if you want to maintain logging across a reboot.

It is recommended to set a large q_depth in auditd.conf if using this plugin. Also set an even bigger q_depth in audisp-remote.conf. Also set the heartbeat_timeout to something non-zero but coordinate it with the server so that it's half the size of the server's tcp_client_max_idle setting. This is required to get retries in a reasonable time if the network has a problem.

## SEE ALSO
audisp-remote(8), auditd.conf(5).

## AUTHOR
Steve Grubb