apctest

title: apctest(8)

summary: apcupsd(8) test program

text:
# apctest(8)

## NAME
apctest — apcupsd(8) test program

## SYNOPSIS
apctest

## DESCRIPTION
apctest is a program that enables the running of certain low-level tests to check the operation of the attached simple signalling American Power Conversion Corp (APC) UPS and to check that your apcupsd(8) configuration is correctly setup and can establish communication with the UPS.

For an APC UPS operating in APC smart protocol mode, apctest enables the reading and programming of the values of the UPS EEPROM configuration variables as well and the performing of a battery runtime calibration. It also provides a simple TTY chat mode which allows direct interaction with the UPS via the APC smart protocol. For details of this protocol and the available commands, refer to the detailed "APC Smart Protocol" section in the apcupsd manual.

IMPORTANT: Before running apctest

- Check that the UPSCABLE, UPSTYPE and DEVICE configuration directives in the apcupsd.conf(5) configuration file have been set appropriately; and

- Shutdown apcupsd if it is running. You cannot run both apcupsd and apctest at the same time.

When run, apctest displays a menu of options which are different depending on whether the UPS is connected to a USB port or to a serial port. For a serial port connection, there are two different menus depending on whether the UPS is operating in APC smart protocol mode or simple signalling mode - this also depends on which cable is used to connect to the UPS. If a simple signalling cable is used to connect to a Smart-UPS, the UPS will only be able to operate in simple signalling mode.

apctest saves a transcript of the session to the file apctest.out in the directory from which the program was called. Its content is useful for debugging purposes.

## USB PORT
When using a UPS connected to a USB port (eg Back-UPS RS 1500), the following menu options will appear:

### Option 1) Test kill UPS power
Performs a power down of the UPS into hibernate mode.

### Option 2) Perform self-test
Performs an immediate self-test (switches to battery power to do so).

### Option 3) Read last self-test result
Displays the last self-test result.

### Option 4) View/Change battery date
Displays the current battery replacement date and optionally allows you to change it - useful when the battery is replaced so that you can accurately keep track of its age.

### Option 5) View manufacturing date
Displays the date the UPS was manufactured.

### Option 6) View/Change alarm behavior
Sets the delay period before the UPS starts sounding its alarm when the utility power is lost.

### Option 7) View/Change sensitivity
Changes how sensitive the UPS is to the utility power quality and voltage fluctuations - (H)igh, (M)edium or (L)ow. The higher the sensitivity, the faster the UPS will switch to battery power or activate SmartBoost/SmartTrim (features that avoid using battery power provided the under/over voltage is within 12% of nominal). This setting should normally be set to High unless the UPS switches to battery power frequently, in which case a less sensitive setting will preserve UPS batteries... if the connected equipment can tolerate the power quality.

### Option 8) View/Change low transfer voltage
Sets the low voltage level at which the UPS switches to battery or activates SmartBoost.

### Option 9) View/Change high transfer voltage
Sets the high voltage level at which the UPS switches to battery or activates SmartTrim.

### Option 10) Perform battery calibration
This performs a battery runtime calibration. This can only be performed if your battery is charged to 100% of capacity. The runtime calibration discharges the UPS battery to approximately 25% of capacity. The exact percentage depends on the UPS model.

The advantage of doing this calibration is that the UPS will recalibrate the remaining runtime counter that it maintains and therefore report a more accurate estimated runtime. As batteries age, they tend to hold less charge, so the UPS's internal runtime counter may not be accurate after several years.

It is recommended that battery runtime calibration be performed annually. Performing it too often shortens the lifetime of the UPS batteries.

### Option 11) Test Alarm
This option will cause the UPS alarm beeper to sound for several seconds.

### Option 12) View/Change self-test interval
This option allows you to change the time interval between automatic UPS self-tests.

### Option Q) Quit
Exits from the program.

## SERIAL PORT (SMART PROTOCOL MODE)
When using a UPS operating in APC smart protocol mode (eg a Smart-UPS) the following menu options will appear:

### Option 1) Query the UPS for all known values
Selecting this option probes the UPS for all EEPROM configuration variable values known to apctest and displays them in rather raw format. This output can be useful for providing technical support if you are having problems with the behaviour of the UPS or apcupsd(8).

### Option 2) Perform a Battery Runtime Calibration
This performs a battery runtime calibration. This can only be performed if your battery is charged to 100% of capacity. The runtime calibration discharges the UPS battery to approximately 25% of capacity. The exact percentage depends on the UPS model. apctest can optionally abort the calibration if it detects that the battery charge is below 10%.

The advantage of doing this calibration is that the UPS will recalibrate the remaining runtime counter that it maintains and therefore report a more accurate estimated runtime. As batteries age, they tend to hold less charge, so the UPS's internal runtime counter may not be accurate after several years.

It is recommended that battery runtime calibration be performed annually. Performing it too often shortens the lifetime of the UPS batteries.

### Option 3) Abort Battery Calibration
This option aborts an in progress battery runtime calibration.

### Option 4) Monitor Battery Calibration progress
Allows restarting of the monitoring of a battery runtime calibration.

### Option 5) Program EEPROM
Allows the programming of the values of a Smart-UPS's EEPROM configuration variables.

Choosing this option presents a sub-menu of programming options which are detailed below.

Option 1) Print EEPROM values

Prints the value of all EEPROM configuration variables known to apctest.

Option 2) Change Battery date

Changes the battery date - useful when the battery is replaced so that you can accurately keep track of its age.

Option 3) Change UPS name

Changes the UPS name - use no more than 8 characters to name the UPS.

Option 4) Change sensitivity

Changes how sensitive the UPS is to the utility power quality and voltage fluctuations - (H)igh, (M)edium or (L)ow. The higher the sensitivity, the faster the UPS will switch to battery power or activate SmartBoost/SmartTrim (features that avoid using battery power provided the under/over voltage is within 12% of nominal). This setting should normally be set to High unless the UPS switches to battery power frequently, in which case a less sensitive setting will preserve UPS batteries... if the connected equipment can tolerate the power quality.

Option 5) Change alarm delay

Changes the delay period before the UPS starts sounding its alarm when the utility power is lost.

Option 6) Change low battery warning delay

Changes the remaining runtime minutes at which the UPS will send the low battery signal. When the UPS internally calculates that the specified number of minutes remains before battery power will be exhausted, it sends the low battery warning.

Option 7) Change wakeup delay

Changes the delay before the UPS restores power to connected equipment when the utility power returns after shutting down in hibernate mode.

Option 8) Change shutdown delay

Changes the delay for which the UPS waits before shutting off power to the connected equipment after being commanded to power down in hibernate mode.

Option 9) Change low transfer voltage

Changes the low voltage level at which the UPS switches to battery or activates SmartBoost.

Option 10) Change high transfer voltage

Changes the high voltage level at which the UPS switches to battery or activates SmartTrim.

Option 11) Change battery return threshold percent

Changes the battery charge percentage required after power down in hibernate mode before to the UPS will restore power to connected equipment on the return of utility power.

Option 12) Change output voltage when on batteries

Changes the nominal voltage output when the UPS is running on battery power.

Option 13) Change the self test interval

Changes or disables the automatic self-test interval.

Option 14) Set EEPROM with configuration file values

This option allows the bulk programming of the EEPROM configuration variables from the values contained in the /etc/apcupsd.conf configuration file. Refer to the "APCTEST EEPROM CONFIGURATION DIRECTIVES" section of the man page for apcupsd.conf(5)

Option 15) Quit

This option exits back to the previous (main) menu.

### Option 6) Enter TTY mode communicating with UPS
This option allows direct interaction with the attached UPS using the APC smart protocol commands.

WARNING: Take special care what commands you enter because it is possible to cause the UPS to suddenly shutdown or, in the worst case, modify the UPS in such a way as to permanently disable it. Do NOT experiment with unknown or unsupported commands. Caveat Utilitor!

### Option 7) Quit
Exits from the program.

## SERIAL PORT (SIMPLE SIGNALLING MODE)
When using an APC UPS operating in simple signalling mode the following menu options will appear:

### Option 1) Test 1 - normal mode
The test result depends on the model of UPS and type of cable being used. Refer to the "Using apctest on Serial-Line UPSses" section in the apcupsd manual for details.

### Option 2) Test 2 - no cable
The test result depends on the model of UPS and type of cable being used. Refer to the "Using apctest on Serial-Line UPSses" section in the apcupsd manual for details.

### Option 3) Test 3 - no power
The test result depends on the model of UPS and type of cable being used. Refer to the "Using apctest on Serial-Line UPSses" section in the apcupsd manual for details.

### Option 4) Test 4 - low battery (requires Test 3 first)
The test result depends on the model of UPS and type of cable being used. Refer to the "Using apctest on Serial-Line UPSses" section in the apcupsd manual for details.

### Option 5) Test 5 - battery exhausted
The test result depends on the model of UPS and type of cable being used. Refer to the "Using apctest on Serial-Line UPSses" section in the apcupsd manual for details.

### Option 6) Test 6 - kill UPS power
The test result depends on the model of UPS and type of cable being used. Refer to the "Using apctest on Serial-Line UPSses" section in the apcupsd manual for details.

### Option 7) Test 7 - run tests 1 through 5
This option has apctest guess which cable should be used with the attached UPS.

### Option 9) Quit
Exits from the program.

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

apctest.out transcript of the apctest session

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

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

## AUTHORS

### This page
Trevor Roydhouse (current)

Robert Huff

### Software

Adam Kropelin (current Project Manager and Code Maintainer)

Kern Sibbald (former Project Manager and Code Maintainer)

Riccardo Facchetti (former Project Manager and Code Maintainer)

Andre M. Hedrick (Project Founder and former Code Maintainer)

### Contributors
An enormous number of users who have devoted their time and energy to this project -- thanks.


apcupsd

package: apcupsd

title: apcupsd(8)

summary: a daemon for controlling most APC UPSes

text:
# apcupsd(8)

## NAME
apcupsd — a daemon for controlling most APC UPSes

## SYNOPSIS
apcupsd

[-b] [-d level | --debug level] [-f file | --config-file file] [-P file | --pid-file file] [-p | --kill-on-powerfail | -t | --term-on-powerfail] [-R]

apcupsd

[-k | --killpower | --hibernate | -o | --power-off]

apcupsd

[-h | --help]

apcupsd

[-V | --version]

## DESCRIPTION
The apcupsd daemon controls the operation of most American Power Conversion Corp (APC) UPSes. During a power failure, apcupsd informs users about the loss of utility power and that a shutdown may occur. If utility power is not restored, a system shutdown will follow when the battery is exhausted, a specified timeout expires, a specified battery charge percentage is reached, or a specified battery runtime (based on internal UPS calculations and determined by power consumption rates) expires. If the utility power is restored before one of the these shutdown conditions is met, apcupsd will inform users of this and the shutdown will generally be cancelled. Refer to the Implementation Notes section below for situations in which the shutdown may not be cancelled.

The meaning of the command line options is as follows:

-b

Run in the foreground, do not detach and become a daemon.

-d level --debug level

Set debugging output level where level is a number greater than zero.

-f file --config-file file

Load the specified configuration file. The default configuration file is /etc/apcupsd/apcupsd.conf. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

-k | --killpower | --hibernate

Power down the UPS in hibernate mode after a 10 second delay. This option is normally only used by apcupsd itself to power down the UPS after a system shutdown has almost completed. In hibernate mode, the UPS will again supply power to the system when the utility power returns.

-o | --power-off

Power down UPS completely. The UPS will not supply power to the system when the utility power returns.

-P file --pid-file file

Create the specified process ID file. The default is /var/run/apcupsd.pid. It must be changed when running more than one copy of apcupsd on the same computer to control multiple UPSes.

-p --kill-on-powerfail

apcupsd commands the UPS to power down in hibernate mode just before apcupsd starts the system shutdown. This relies on the grace shutdown delay of a Smart-UPS being long enough to allow the system to shutdown completely before the UPS shuts off the power to the system and goes into hibernate mode. This shutdown grace delay is a programmable value stored in a Smart-UPS EEPROM which can be changed using apctest(8). In hibernate mode, the UPS will again supply power to the system when the utility power returns. Refer to apcupsd.conf(5) for an alternative method using the KILLDELAY configuration directive and the only method available when using a Back-UPS or other UPS operating in simple signalling mode.

-t --term-on-powerfail

apcupsd exits immediately when it issues the system shutdown command. This behaviour is useful for those systems where it is not possible to insert apcupsd commands in a halt script to issue the killpower command. Without this option, apcupsd will wait for the SIGTERM signal from the system shutdown process before exiting.

-R

Put a UPS which runs in smart signalling mode by default (eg a Smart-UPS) into simple signalling mode.

-v --version

Prints the apcupsd version number and the program help.

-h --help

Prints the program help.

The apcupsd daemon supports a networking mode called Network Information Server (NIS) -- not related to Sun's NIS/YP -- in which the daemon serves status and event information to clients over a network. See the "Running The Network Information Server" section of the apcupsd manual for more information and configuration details on this mode.

The apcupsd daemon also supports a Smart-UPS in SNMP mode provided an APC Web/SNMP or APC PowerNet SNMP card is installed in the UPS's SmartSlot. For more information and configuration details on this mode, refer to the "Support for SNMP UPSes" section of the apcupsd manual.

## IMPLEMENTATION NOTES
The shutdown is made by calls to the script /etc/apcupsd/apccontrol by the apcupsd daemon. Consequently, no changes to /etc/inittab are necessary on Linux as there is no communication between the daemon and the init(1) process. Installation of the daemon modifies the halt script so that at the end of the shutdown process, the daemon will be re-executed to power off the UPS in hibernate mode.

On some operating systems (eg FreeBSD) there is no halt script so apccontrol must be modified to cause the daemon to power off the UPS after a delay. Alternatives are to use the --kill-on-powerfail command on the apcupsd command line or refer to apcupsd.conf(5) for details of the KILLDELAY configuration directive.

## CONFIGURATION
It will almost certainly be necessary to customise the configuration information in the /etc/apcupsd/apcupsd.conf configuration file to suit your configuration and desired UPS behaviour.

For information on the configuration directives and the format of the configuration file, refer to apcupsd.conf(5).

## EVENTS
apcupsd generates events when certain conditions occur. These events are sent to the system log and, optionally, to the temporary events file (/var/log/apcupsd.events). They also generate a call to the /etc/apcupsd/apccontrol script which in turn will call any custom scripts placed in the /etc/apcupsd directory which may override apccontrol's default behaviour. For details of the events and customising apccontrol's behaviour, refer to apccontrol(8).

## DATA FILE FORMAT
If the DATATIME configuration directive is set to non-zero, apcupsd will log a data record at the interval defined by the DATATIME directive. This data record is in a format similar to the APC PowerChute software data file format.

## STATUS REPORT FORMAT
The status report output format is simple ASCII. Generally there is a single piece of information on each line of output. The content varies based on the model of UPS being used and, in some cases, the firmware version. This status report is also optionally written the the /etc/apcupsd/apcupsd.status file. Refer to apcaccess(8) for full details of the status report output.

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

/var/run/apcupsd.pid default process ID file

/var/log/apcupsd.status optional status file

/var/log/apcupsd.events default events file

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

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

## AUTHORS

### This page
Trevor Roydhouse (current)

Andre M. Hedrick

Christopher J. Reimer

### Software

Adam Kropelin (current Project Manager and Code Maintainer)

Kern Sibbald (former Project Manager and Code Maintainer)

Riccardo Facchetti (former Project Manager and Code Maintainer)

Andre M. Hedrick (Project Founder and former Code Maintainer)

### Contributors
An enormous number of users who have devoted their time and energy to this project -- thanks.


apgd

package: apg-daemon

title: apgd(8)

text:
# apgd(8)

## NAME
apgd - server that generates several random passwords

## SYNOPSIS
apgd [-a algorithm] [-M mode] [-E char_string] [-n num_of_pass] [-m min_pass_len] [-x max_pass_len] [-r dictfile] [-b filter_file] [-p min_substr_len] [-t] [-l]

## DESCRIPTION
apgd program is a server that supports Password Generation Protocol described in RFC972. It uses several password generation algorithms (currently two) and a built-in pseudo random number generator.

apgd is normally invoked by the Internet superserver (see inetd (8)) for requests to connect to the pwdgen port (pwdgen port is 129 according to RFC1700 ) as indicated by the /etc/services file (see services (5)).

Default algorithm is pronounceable password generation algorithm designed by Morrie Gasser and described in "A Random Word Generator For Pronounceable Passwords" National Technical Information Service (NTIS) AD-A-017676. The original paper is very old and had never been put online, so I have to use NIST implementation described in FIPS-181.

Another algorithm is simple random character generation algorithm, but it uses four user-defined symbol sets to produce random password. It means that user can choose type of symbols that should appear in password. Symbol sets are: numeric symbol set (0,...,9) , capital letters symbol set (A,...,Z) , small letters symbol set (a,...,z) and special symbols symbol set (#,@,!,...).

Built-in pseudo random number generator is an implementation of algorithm described in Appendix C of ANSI X9.17 or RFC1750 with exception that it uses CAST or SHA-1 instead of Triple DES. It uses local time with precision of microseconds (see gettimeofday(2)) and /dev/random (if available) to produce initial random seed.

apgd also have the ability to check generated password quality using dictionary. You can use this ability if you specify command-line option -r dictfile or -b filtername where dictfile is dictionary file name and filtername is the name of Bloom filter file. In that dictionary you may place words (one per line) that should not appear as generated passwords. For example: user names common words, etc. You even can use one of the dictionaries that come with dictionary password crackers. Bloom filter file should be created with apgbfm(1) utility included in apg distribution. In future releases I plan to implement some other techniques to check passwords just to make life easier.

apgd has the ability log user password generation activity and internal debug information. It does this using

facility = daemon

priority = info for user password generation activity logging

priority = debug for internal debug information

See the syslogd(8) and syslog.conf(5) man pages for information on how to configure your syslog daemon.

## OPTIONS

### Password generation modes options
-a algorithm

use algorithm for password generation.

0 - (default) pronounceable password generation

1 - random character password generation

-n num_of_pass

generate num_of_pass number of passwords. Default is 6.

-m min_pass_len

generate password with minimum length min_pass_len. If min_pass_len > max_pass_len then max_pass_len = min_pass_len. Default minimum password length is 8.

-x max_pass_len

generate password with maximum length max_pass_len If min_pass_len > max_pass_len then max_pass_len = min_pass_len. Default maximum password length is 10.

-M mode

Use symbolsets specified with mode for password generation. mode is a text string consisting of characters S, s, N, n, C, c, L, l. Where:

S

generator must use special symbol set for every generated password.

s

generator should use special symbol set for password generation.

N

generator must use numeral symbol set for every generated password.

n

generator should use numeral symbol set for password generation.

C

generator must use capital symbol set for every generated password.

c

generator should use capital symbol set for password generation.

L

generator must use small letters symbol set for every generated password (always present if pronounceable password generation algorithm is used).

l

generator should use small letters symbol set for password generation.

R,r

not supported any more. Use -E char_string option instead.

mode can not be more than 4 characters in length. Note:

Usage of L, M, N, C will slow down password generation process.

Examples:

-M sncl or -M SNCL or -M Cn

-E char_string

exclude characters in char_string from password generation process (in pronounceable password generation mode you can not exclude small letters). To include special symbols that can be recognized by shell (apostrophe, quotes, dollar sign, etc.) in char_string use the backslashed versions.

Examples:

Command apgd -a 1 -M n -n 3 -m 8 -e 23456789 will generate a set of passwords that will look like this

10100110

01111000

11011101

Command apgd -a 1 -M nc -n 3 -m 26 -e GHIJKLMNOPQRSTUVWXYZ will generate a set of passwords that will look like this

16A1653CD4DE5E7BD9584A3476

C8F78E06944AFD57FB9CB882BC

8C8DF37CD792D36D056BBD5002

### Password quality control options
-r dictfile

check generated passwords for their appearance in dictfile

-b filter_file

check generated passwords for their appearance in filter_file. filter_file should be created with apgbfm(1) utility.

-p min_substr_len

this option tells apg(1) to check every substring of the generated password for appearance in filter_file. If any of such substrings would be found in the filter_file then generated password would be rejected and apg(1) will generate another one. min_substr_len is specifies minimum substring length to check. This option is active only if -b option is defined.

### Password output options
-l

spell genetated passwords. Useful when you want to read generated password by telephone.

WARNING: Think twice before read your password by phone.

-t

print pronunciation for generated pronounceable password

## DEFAULT OPTIONS
apgd -a 0 -M sncl -n 6 -x 10 -m 8 (new style)

## EXIT CODE
On successful completion of its task, apgd will complete with exit code 0. An exit code of -1 indicates an error occurred. Textual errors are written to the syslogd (8).

## DIAGNOSTICS
All textual info is written to the syslogd(8).

## FILES
None.

## BUGS
None. If you've found one, please send bug description to the author.

## SEE ALSO
apg(1), apgbfm(1)

## AUTHOR
Adel I. Mirzazhanov, <a-del@iname.com>

Project home page: http://www.adel.nursat.kz/apg/


apt

package: apt

title: apt(8)

summary: Advanced Package Tool

text:
# apt(8)

## NAME
apt - Advanced Package Tool

## SYNOPSIS
apt

## DESCRIPTION
APT is a management system for software packages. It is still under development; the snazzy front ends are not yet available. In the meantime, please see apt-get(8).

## OPTIONS
None.

## FILES
None.

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

## DIAGNOSTICS
apt returns zero on normal operation, decimal 100 on error.

## BUGS
This manpage isn't even started.

See <http://bugs.debian.org/apt>. If you wish to report a bug in apt, please see /usr/share/doc/debian/bug-reporting.txt or the bug(1) command.

## AUTHOR
apt was written by the APT team <apt@packages.debian.org>.


apt-cache

title: apt-cache(8)

text:
# apt-cache(8)

## NAME
apt-cache - APT package handling utility -- cache manipulator

## SYNOPSIS
apt-cache [ -hvsn ] [ -o=config string ] [ -c=file ] [ add file... ] [ gencaches ] [ showpkg pkg... ] [ showsrc pkg... ] [ stats ] [ dump ] [ dumpavail ] [ unmet ] [ search regex ] [ show pkg... ] [ depends pkg... ] [ whatdepends pkg... ] [ pkgnames prefix ] [ dotty pkg... ] [ policy pkgs... ]

## DESCRIPTION
apt-cache performs a variety of operations on APT's package cache. apt-cache does not manipulate the state of the system but does provide operations to search and generate interesting output from the package metadata.

Unless the -h, or --help option is given, one of the commands below must be present.

add file(s)

add adds the named package index files to the package cache. This is for debugging only.

gencaches

gencaches performs the same operation as apt-get check. It builds the source and package caches from the sources in sources.list(5) and from /var/lib/dpkg/status.

showpkg pkg(s)

showpkg displays information about the packages listed on the command line. Remaining arguments are package names. The available versions and reverse dependencies of each package listed are listed, as well as forward dependencies for each version. Forward (normal) dependencies are those packages upon which the package in question depends; reverse dependencies are those packages that depend upon the package in question. Thus, forward dependencies must be satisfied for a package, but reverse dependencies need not be. For instance, apt-cache showpkg libreadline2 would produce output similar to the following:

```
Package: libreadline2
Versions: 2.1-12(/var/lib/apt/lists/foo_Packages),
Reverse Depends:

  libreadlineg2,libreadline2

  libreadline2-altdev,libreadline2
Dependencies:
2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))
Provides:
2.1-12 -
Reverse Provides:

```

Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and ncurses3.0 which must be installed for libreadline2 to work. In turn, libreadlineg2 and libreadline2-altdev depend on libreadline2. If libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be installed; libreadlineg2 and libreadline2-altdev do not have to be installed. For the specific meaning of the remainder of the output it is best to consult the apt source code.

stats

stats displays some statistics about the cache. No further arguments are expected. Statistics reported are:

•

Total package names is the number of package names found in the cache.

•

Normal packages is the number of regular, ordinary package names; these are packages that bear a one-to-one correspondence between their names and the names used by other packages for them in dependencies. The majority of packages fall into this category.

•

Pure virtual packages is the number of packages that exist only as a virtual package name; that is, packages only "provide" the virtual package name, and no package actually uses the name. For instance, "mail-transport-agent" in the Debian GNU/Linux system is a pure virtual package; several packages provide "mail-transport-agent", but there is no package named "mail-transport-agent".

•

Single virtual packages is the number of packages with only one package providing a particular virtual package. For example, in the Debian GNU/Linux system, "X11-text-viewer" is a virtual package, but only one package, xless, provides "X11-text-viewer".

•

Mixed virtual packages is the number of packages that either provide a particular virtual package or have the virtual package name as the package name. For instance, in the Debian GNU/Linux system, "debconf" is both an actual package, and provided by the debconf-tiny package.

•

Missing is the number of package names that were referenced in a dependency but were not provided by any package. Missing packages may be in evidence if a full distribution is not accessed, or if a package (real or virtual) has been dropped from the distribution. Usually they are referenced from Conflicts statements.

•

Total distinct versions is the number of package versions found in the cache; this value is therefore at least equal to the number of total package names. If more than one distribution (both "stable" and "unstable", for instance), is being accessed, this value can be considerably larger than the number of total package names.

•

Total dependencies is the number of dependency relationships claimed by all of the packages in the cache.

showsrc pkg(s)

showsrc displays all the source package records that match the given package names. All versions are shown, as well as all records that declare the name to be a Binary.

dump

dump shows a short listing of every package in the cache. It is primarily for debugging.

dumpavail

dumpavail prints out an available list to stdout. This is suitable for use with and is used by the dselect(8) method.

unmet

unmet displays a summary of all unmet dependencies in the package cache.

show pkg(s)

show performs a function similar to dpkg --print-availi; it displays the package records for the named packages.

search regex [ regex ... ]

search performs a full text search on all available package lists for the regex pattern given. It searches the package names and the descriptions for an occurrence of the regular expression and prints out the package name and the short description. If --full is given then output identical to show is produced for each matched package, and if --names-only is given then the long description is not searched, only the package name is. Separate arguments can be used to specify multiple search patterns that are and'ed together.

depends pkg(s)

depends shows a listing of each dependency a package has and all the possible other packages that can fulfill that dependency.

whatdepends pkg(s)

whatdepends shows a listing of what depends on a package.

pkgnames [ prefix ]

This command prints the name of each package in the system. The optional argument is a prefix match to filter the name list. The output is suitable for use in a shell tab complete function and the output is generated extremely quickly. This command is best used with the --generate option.

dotty pkg(s)

dotty takes a list of packages on the command line and generates output suitable for use by dotty from the GraphViz <URL:http://www.research.att.com/sw/tools/graphviz/> package. The result will be a set of nodes and edges representing the relationships between the packages. By default the given packages will trace out all dependent packages; this can produce a very large graph. To limit the output to only the packages listed on the command line, set the APT::Cache::GivenOnly option. The resulting nodes will have several shapes; normal packages are boxes, pure provides are triangles, mixed provides are diamonds, missing packages are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue lines are pre-depends, green lines are conflicts.

Caution, dotty cannot graph larger sets of packages.

policy [ pkg(s) ]

policy is ment to help debug issues relating to the preferences file. With no arguments it will print out the priorities of each source. Otherwise it prints out detailed information about the priority selection of the named package.

## OPTIONS
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like -f-,--no-f, -f=no or several other variations.

-p

--pkg-cache

Select the file to store the package cache. The package cache is the primary cache used by all operations. Configuration Item: Dir::Cache::pkgcache.

-s

--src-cache

Select the file to store the source cache. The source is used only by gencaches and it stores a parsed version of the package information from remote sources. When building the package cache the source cache is used to advoid reparsing all of the package files. Configuration Item: Dir::Cache::srcpkgcache.

-q

--quiet

Quiet; produces output suitable for logging, omitting progress indicators. More q's will produce more quietness up to a maximum of 2. You can also use -q=# to set the quietness level, overriding the configuration file. Configuration Item: quiet.

-i

--important

Print only important dependencies; for use with unmet. Causes only Depends and Pre-Depends relations to be printed. Configuration Item: APT::Cache::Important.

-f

--full

Print full package records when searching. Configuration Item: APT::Cache::ShowFull.

-a

--all-versions

Print full records for all available versions. This is the default; to turn it off, use --no-all-versions. If --no-all-versions is specified, only the candidate version will displayed (the one which would be selected for installation). This option is only applicable to the show command. Configuration Item: APT::Cache::AllVersions.

-g

--generate

Perform automatic package cache regeneration, rather than use the cache as it is. This is the default; to turn it off, use --no-generate. Configuration Item: APT::Cache::Generate.

--names-only

-n

Only search on the package names, not the long descriptions. Configuration Item: APT::Cache::NamesOnly.

--all-names

Make pkgnames print all names, including virtual packages and missing dependencies. Configuration Item: APT::Cache::AllNames.

--recurse

Make depends recursive so that all packages mentioned are printed once. Configuration Item: APT::Cache::RecurseDepends.

-h

--help

Show a short usage summary.

-v

--version

Show the program version.

-c

--config-file

Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. If configuration settings need to be set before the default configuration files are parsed specify a file with the APT_CONFIG environment variable. See apt.conf(5) for syntax information.

-o

--option

Set a Configuration Option; This will set an arbitrary configuration option. The syntax is -o Foo::Bar=bar.

## FILES
/etc/apt/sources.list

Locations to fetch packages from. Configuration Item: Dir::Etc::SourceList.

/var/lib/apt/lists/

Storage area for state information for each package resource specified in sources.list(5) Configuration Item: Dir::State::Lists.

/var/lib/apt/lists/partial/

Storage area for state information in transit. Configuration Item: Dir::State::Lists (implicit partial).

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

## DIAGNOSTICS
apt-cache returns zero on normal operation, decimal 100 on error.

## 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.


apt-cdrom

title: apt-cdrom(8)

summary: APT CDROM management utility

text:
# apt-cdrom(8)

## NAME
apt-cdrom - APT CDROM management utility

## SYNOPSIS
apt-cdrom [ -hvrmfan ] [ -d=cdrom mount point ] [ -o=config string ] [ -c=file ] [ add ] [ ident ]

## DESCRIPTION
apt-cdrom is used to add a new CDROM to APTs list of available sources. apt-cdrom takes care of determining the structure of the disc as well as correcting for several possible mis-burns and verifying the index files.

It is necessary to use apt-cdrom to add CDs to the APT system, it cannot be done by hand. Furthermore each disk in a multi-cd set must be inserted and scanned separately to account for possible mis-burns.

Unless the -h, or --help option is given one of the commands below must be present.

add

add is used to add a new disc to the source list. It will unmount the CDROM device, prompt for a disk to be inserted and then procceed to scan it and copy the index files. If the disc does not have a proper .disk/ directory you will be prompted for a descriptive title. APT uses a CDROM ID to track which disc is currently in the drive and maintains a database of these IDs in /var/lib/apt/cdroms.list

ident

A debugging tool to report the identity of the current disc as well as the stored file name

## OPTIONS
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like -f-,--no-f, -f=no or several other variations.

-d

--cdrom

Mount point; specify the location to mount the cdrom. This mount point must be listed in /etc/fstab and properly configured. Configuration Item: Acquire::cdrom::mount.

-r

--rename

Rename a disc; change the label of a disk or override the disks given label. This option will cause apt-cdrom to prompt for a new label. Configuration Item: APT::CDROM::Rename.

-m

--no-mount

No mounting; prevent apt-cdrom from mounting and unmounting the mount point. Configuration Item: APT::CDROM::NoMount.

-f

--fast

Fast Copy; Assume the package files are valid and do not check every package. This option should be used only if apt-cdrom has been run on this disc before and did not detect any errors. Configuration Item: APT::CDROM::Fast.

-a

--thorough

Thorough Package Scan; This option may be needed with some old Debian 1.1/1.2 discs that have Package files in strange places. It takes much longer to scan the CD but will pick them all up.

-n

--just-print

--recon

--no-act

No Changes; Do not change the sources.list(5) file and do not write index files. Everything is still checked however. Configuration Item: APT::CDROM::NoAct.

-h

--help

Show a short usage summary.

-v

--version

Show the program version.

-c

--config-file

Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. If configuration settings need to be set before the default configuration files are parsed specify a file with the APT_CONFIG environment variable. See apt.conf(5) for syntax information.

-o

--option

Set a Configuration Option; This will set an arbitrary configuration option. The syntax is -o Foo::Bar=bar.

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

## DIAGNOSTICS
apt-cdrom returns zero on normal operation, decimal 100 on error.

## 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.


apt-config

title: apt-config(8)

summary: APT Configuration Query program

text:
# apt-config(8)

## NAME
apt-config - APT Configuration Query program

## SYNOPSIS
apt-config [ -hv ] [ -o=config string ] [ -c=file ] [ shell ] [ dump ]

## DESCRIPTION
apt-config is an internal program used by various portions of the APT suite to provide consistent configurability. It accesses the main configuration file /etc/apt/apt.conf in a manner that is easy to use by scripted applications.

Unless the -h, or --help option is given one of the commands below must be present.

shell

shell is used to access the configuration information from a shell script. It is given pairs of arguments, the first being a shell variable and the second the configuration value to query. As output it lists a series of shell assignments commands for each present value. In a shell script it should be used like:

```
OPTS="-f"
RES=`apt-config shell OPTS MyApp::Options`
eval $RES

```

This will set the shell environment variable $OPTS to the value of MyApp::Options with a default of -f.

The configuration item may be postfixed with a /[fdbi]. f returns file names, d returns directories, b returns true or false and i returns an integer. Each of the returns is normalized and verified internally.

dump

Just show the contents of the configuration space.

## OPTIONS
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like -f-,--no-f, -f=no or several other variations.

-h

--help

Show a short usage summary.

-v

--version

Show the program version.

-c

--config-file

Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. If configuration settings need to be set before the default configuration files are parsed specify a file with the APT_CONFIG environment variable. See apt.conf(5) for syntax information.

-o

--option

Set a Configuration Option; This will set an arbitrary configuration option. The syntax is -o Foo::Bar=bar.

## SEE ALSO
apt.conf(5)

## DIAGNOSTICS
apt-config returns zero on normal operation, decimal 100 on error.

## 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.


apt-get

title: apt-get(8)

text:
# apt-get(8)

## NAME
apt-get - APT package handling utility -- command-line interface

## SYNOPSIS
apt-get [ -hvs ] [ -o=config string ] [ -c=file ] [ update ] [ upgrade ] [ dselect-upgrade ] [ install pkg... ] [ remove pkg... ] [ autoremove ] [ source pkg... ] [ build-dep pkg... ] [ check ] [ clean ] [ autoclean ]

## DESCRIPTION
apt-get is the command-line tool for handling packages, and may be considered the user's "back-end" to other tools using the APT library. Several "front-end" interfaces exist, such as dselect(8), aptitude, synaptic, gnome-apt and wajig.

Unless the -h, or --help option is given, one of the commands below must be present.

update

update is used to resynchronize the package index files from their sources. The indexes of available packages are fetched from the location(s) specified in /etc/apt/sources.list. For example, when using a Debian archive, this command retrieves and scans the Packages.gz files, so that information about new and updated packages is available. An update should always be performed before an upgrade or dist-upgrade. Please be aware that the overall progress meter will be incorrect as the size of the package files cannot be known in advance.

upgrade

upgrade is used to install the newest versions of all packages currently installed on the system from the sources enumerated in /etc/apt/sources.list. Packages currently installed with new versions available are retrieved and upgraded; under no circumstances are currently installed packages removed, or packages not already installed retrieved and installed. New versions of currently installed packages that cannot be upgraded without changing the install status of another package will be left at their current version. An update must be performed first so that apt-get knows that new versions of packages are available.

dselect-upgrade

dselect-upgrade is used in conjunction with the traditional Debian packaging front-end, dselect(8). dselect-upgrade follows the changes made by dselect(8) to the Status field of available packages, and performs the actions necessary to realize that state (for instance, the removal of old and the installation of new packages).

dist-upgrade

dist-upgrade, in addition to performing the function of upgrade, also intelligently handles changing dependencies with new versions of packages; apt-get has a "smart" conflict resolution system, and it will attempt to upgrade the most important packages at the expense of less important ones if necessary. The /etc/apt/sources.list file contains a list of locations from which to retrieve desired package files. See also apt_preferences(5) for a mechanism for overriding the general settings for individual packages.

install

install is followed by one or more packages desired for installation. Each package is a package name, not a fully qualified filename (for instance, in a Debian GNU/Linux system, libc6 would be the argument provided, not libc6_1.9.6-2.deb). All packages required by the package(s) specified for installation will also be retrieved and installed. The /etc/apt/sources.list file is used to locate the desired packages. If a hyphen is appended to the package name (with no intervening space), the identified package will be removed if it is installed. Similarly a plus sign can be used to designate a package to install. These latter features may be used to override decisions made by apt-get's conflict resolution system. A specific version of a package can be selected for installation by following the package name with an equals and the version of the package to select. This will cause that version to be located and selected for install. Alternatively a specific distribution can be selected by following the package name with a slash and the version of the distribution or the Archive name (stable, testing, unstable).

Both of the version selection mechanisms can downgrade packages and must be used with care.

Finally, the apt_preferences(5) mechanism allows you to create an alternative installation policy for individual packages.

If no package matches the given expression and the expression contains one of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and it is applied to all package names in the database. Any matches are then installed (or removed). Note that matching is done by substring so 'lo.*' matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular expression with a '^' or '$' character, or create a more specific regular expression.

remove

remove is identical to install except that packages are removed instead of installed. If a plus sign is appended to the package name (with no intervening space), the identified package will be installed instead of removed.

autoremove

autoremove is used to remove packages that were automatically installed to satisfy dependencies for other packages and are now no longer needed as dependencies changed or the package(s) needing them were removed in the meantime.

source

source causes apt-get to fetch source packages. APT will examine the available packages to decide which source package to fetch. It will then find and download into the current directory the newest available version of that source package. Source packages are tracked separately from binary packages via deb-src type lines in the sources.list(5) file. This probably will mean that you will not get the same source as the package you have installed or as you could install. If the --compile options is specified then the package will be compiled to a binary .deb using dpkg-buildpackage, if --download-only is specified then the source package will not be unpacked. A specific source version can be retrieved by postfixing the source name with an equals and then the version to fetch, similar to the mechanism used for the package files. This enables exact matching of the source package name and version, implicitly enabling the APT::Get::Only-Source option.

Note that source packages are not tracked like binary packages, they exist only in the current directory and are similar to downloading source tar balls.

build-dep

build-dep causes apt-get to install/remove packages in an attempt to satisfy the build dependencies for a source package.

check

check is a diagnostic tool; it updates the package cache and checks for broken dependencies.

clean

clean clears out the local repository of retrieved package files. It removes everything but the lock file from /var/cache/apt/archives/ and /var/cache/apt/archives/partial/. When APT is used as a dselect(8) method, clean is run automatically. Those who do not use dselect will likely want to run apt-get clean from time to time to free up disk space.

autoclean

Like clean, autoclean clears out the local repository of retrieved package files. The difference is that it only removes package files that can no longer be downloaded, and are largely useless. This allows a cache to be maintained over a long period without it growing out of control. The configuration option APT::Clean-Installed will prevent installed packages from being erased if it is set to off.

## OPTIONS
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like -f-,--no-f, -f=no or several other variations.

-d

--download-only

Download only; package files are only retrieved, not unpacked or installed. Configuration Item: APT::Get::Download-Only.

-f

--fix-broken

Fix; attempt to correct a system with broken dependencies in place. This option, when used with install/remove, can omit any packages to permit APT to deduce a likely solution. Any Package that are specified must completely correct the problem. The option is sometimes necessary when running APT for the first time; APT itself does not allow broken package dependencies to exist on a system. It is possible that a system's dependency structure can be so corrupt as to require manual intervention (which usually means using dselect(8) or dpkg --remove to eliminate some of the offending packages). Use of this option together with -m may produce an error in some situations. Configuration Item: APT::Get::Fix-Broken.

-m

--ignore-missing

--fix-missing

Ignore missing packages; If packages cannot be retrieved or fail the integrity check after retrieval (corrupted package files), hold back those packages and handle the result. Use of this option together with -f may produce an error in some situations. If a package is selected for installation (particularly if it is mentioned on the command line) and it could not be downloaded then it will be silently held back. Configuration Item: APT::Get::Fix-Missing.

--no-download

Disables downloading of packages. This is best used with --ignore-missing to force APT to use only the .debs it has already downloaded. Configuration Item: APT::Get::Download.

-q

--quiet

Quiet; produces output suitable for logging, omitting progress indicators. More q's will produce more quiet up to a maximum of 2. You can also use -q=# to set the quiet level, overriding the configuration file. Note that quiet level 2 implies -y, you should never use -qq without a no-action modifier such as -d, --print-uris or -s as APT may decided to do something you did not expect. Configuration Item: quiet.

-s

--simulate

--just-print

--dry-run

--recon

--no-act

No action; perform a simulation of events that would occur but do not actually change the system. Configuration Item: APT::Get::Simulate. Simulate prints out a series of lines each one representing a dpkg operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with and empty set of square brackets meaning breaks that are of no consequence (rare).

-y

--yes

--assume-yes

Automatic yes to prompts; assume "yes" as answer to all prompts and run non-interactively. If an undesirable situation, such as changing a held package or removing an essential package occurs then apt-get will abort. Configuration Item: APT::Get::Assume-Yes.

-u

--show-upgraded

Show upgraded packages; Print out a list of all packages that are to be upgraded. Configuration Item: APT::Get::Show-Upgraded.

-V

--verbose-versions

Show full versions for upgraded and installed packages. Configuration Item: APT::Get::Show-Versions.

--no-list-columns

Display package lists without arranging them in columns. By default, package lists are printed in the style of the "ls" command. Configuration Item: APT::Get::List-Columns.

-b

--compile

--build

Compile source packages after downloading them. Configuration Item: APT::Get::Compile.

--ignore-hold

Ignore package Holds; This causes apt-get to ignore a hold placed on a package. This may be useful in conjunction with dist-upgrade to override a large number of undesired holds. Configuration Item: APT::Ignore-Hold.

--no-upgrade

Do not upgrade packages; When used in conjunction with install no-upgrade will prevent packages listed from being upgraded if they are already installed. Configuration Item: APT::Get::Upgrade.

--force-yes

Force yes; This is a dangerous option that will cause apt to continue without prompting if it is doing something potentially harmful. It should not be used except in very special situations. Using force-yes can potentially destroy your system! Configuration Item: APT::Get::force-yes.

--print-uris

Instead of fetching the files to install their URIs are printed. Each URI will have the path, the destination file name, the size and the expected md5 hash. Note that the file name to write to will not always match the file name on the remote site! This also works with the source and update commands. When used with the update command the MD5 and size are not included, and it is up to the user to decompress any compressed files. Configuration Item: APT::Get::Print-URIs.

--purge

Use purge instead of remove for anything that would be removed. An asterisk ("*") will be displayed next to packages which are scheduled to be purged. Configuration Item: APT::Get::Purge.

--reinstall

Re-Install packages that are already installed and at the newest version. Configuration Item: APT::Get::ReInstall.

--list-cleanup

This option defaults to on, use --no-list-cleanup to turn it off. When on apt-get will automatically manage the contents of /var/lib/apt/lists to ensure that obsolete files are erased. The only reason to turn it off is if you frequently change your source list. Configuration Item: APT::Get::List-Cleanup.

--autoremove

--auto-remove

Remove packages that were automatically installed to satisfy dependencies for other packages and are now no longer needed. Configuration Item: APT::Get::AutomaticRemove.

-t

--target-release

--default-release

This option controls the default input to the policy engine, it creates a default pin at priority 990 using the specified release string. The preferences file may further override this setting. In short, this option lets you have simple control over which distribution packages will be retrieved from. Some common examples might be -t '2.1*' or -t unstable. Configuration Item: APT::Default-Release; see also the apt_preferences(5) manual page.

--trivial-only

Only perform operations that are 'trivial'. Logically this can be considered related to --assume-yes, where --assume-yes will answer yes to any prompt, --trivial-only will answer no. Configuration Item: APT::Get::Trivial-Only.

--no-remove

If any packages are to be removed apt-get immediately aborts without prompting. Configuration Item: APT::Get::Remove

--only-source

Only has meaning for the source command. Indicates that the given source names are not to be mapped through the binary table. This means that if this option is specified, the source command will only accept source package names as arguments, rather than accepting binary package names and looking up the corresponding source package. Configuration Item: APT::Get::Only-Source

--diff-only

--tar-only

Download only the diff or tar file of a source archive. Configuration Item: APT::Get::Diff-Only and APT::Get::Tar-Only

--arch-only

Only process architecture-dependent build-dependencies. Configuration Item: APT::Get::Arch-Only

--enable-upgrade

Enables 'upgrade' action with old behaviour: upgrading only installed packages. 'upgrade' should be used with caution since it can leave system in a broken state. It is advised to use 'dist-upgrade' action instead of 'upgrade' action. Configuration Item: APT::Get::EnableUpgrade.

-h

--help

Show a short usage summary.

-v

--version

Show the program version.

-c

--config-file

Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. If configuration settings need to be set before the default configuration files are parsed specify a file with the APT_CONFIG environment variable. See apt.conf(5) for syntax information.

-o

--option

Set a Configuration Option; This will set an arbitrary configuration option. The syntax is -o Foo::Bar=bar.

## FILES
/etc/apt/sources.list

Locations to fetch packages from. Configuration Item: Dir::Etc::SourceList.

/etc/apt/apt.conf

APT configuration file. Configuration Item: Dir::Etc::Main.

/etc/apt/apt.conf.d/

APT configuration file fragments Configuration Item: Dir::Etc::Parts.

/etc/apt/preferences

Version preferences file. This is where you would specify "pinning", i.e. a preference to get certain packages from a separate source or from a different version of a distribution. Configuration Item: Dir::Etc::Preferences.

/var/cache/apt/archives/

Storage area for retrieved package files. Configuration Item: Dir::Cache::Archives.

/var/cache/apt/archives/partial/

Storage area for package files in transit. Configuration Item: Dir::Cache::Archives (implicit partial).

/var/lib/apt/lists/

Storage area for state information for each package resource specified in sources.list(5) Configuration Item: Dir::State::Lists.

/var/lib/apt/lists/partial/

Storage area for state information in transit. Configuration Item: Dir::State::Lists (implicit partial).

## SEE ALSO
apt-cache(8), apt-cdrom(8), , dselect(8), sources.list(5), apt.conf(5), apt-config(8), The APT User's guide in /usr/share/doc/apt/, apt_preferences(5), the APT Howto.

## DIAGNOSTICS
apt-get returns zero on normal operation, decimal 100 on error.

## 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.


acngfs

package: apt-cacher-ng

title: acngfs(8)

text:
# acngfs(8)

## NAME
acngfs - Virtual file system for use with apt-cacher-ng

## SYNOPSIS

```
acngfs BaseURL ProxyHost [CachePath] MountPoint [-o FUSE Mount Options]
```

## DESCRIPTION
acngfs is a FUSE based filesystem which represents files downloadable via HTTP as part of a local filesystem. It has been developed for very specific purposes and is not intended to be a general purpose HTTP filesystem.

The main use case for acngfs is a situation where:

•

The files must not be stored on extra space on the user's system (e.g. because of insufficient disk space to make a temporary copy of downloaded files)

•

Local programs (e.g. apt, dpkg) need to read the packages from a local filesystem

•

When reading, certain files might need to be fetched in background (or updated) and this process needs to be triggered somehow

•

Network latency and speed are not relevant, e.g. accessing apt-cacher-ng via localhost connection

•

The proxy service can work efficiently with many requests for small data ranges (apt-cacher-ng, for example)

•

Pattern matching on paths is sufficient to distinguish file and directory names

If the apt-cacher-ng instance happens to run on the same system as acngfs or its cache repository is mounted via fast remote file system, this cache repository can be optionally specified as alternative source path. In this cache, acngfs will attempt to read files directly from this filesystem where possible, reducing network latency and avoiding additional load of apt-cacher-ng server. The directory levels of BaseURL and CachePath should match.

## EXAMPLES
Typical use may be to let apt/dpkg use package file like they are present on the local filesystem so there is no need to download them. In sources.list, the source appears as a file:/ type URL, like:

deb file:/var/local/acngfs_debian unstable main contrib

and the filesystem backend is prepared with a command like:

/usr/lib/apt-cacher-ng/acngfs http://ftp.uni-kl.de/debian cacheBox:3142 /var/local/acngfs_debian -o allow_root

or for a locally installed apt-cacher-ng with common Debian cache repository stored in /var/cache/apt-cacher-ng/debrep:

/usr/lib/apt-cacher-ng/acngfs http://ftp.uni-kl.de/debian localhost:3142 /var/cache/apt-cacher-ng/debrep /var/local/acngfs_debian -o allow_root

## OPTIONS
The command-line options supported by acngfs are:

BaseURL

Remote mirror to be used as real source, like http://ftp2.de.debian.org/debian. NOTE: the mirror subdirectory part (like debian) should be added either to BaseURL or to the path in sources.list, not to both.

ProxyURL

Complete or simplified host and port specification of the proxy server, http://localhost:3142.

CachePath

Optional hint, a directory path pointing to the internal cache subdirectory of apt-cacher-ng where it stores data downloaded from BaseURL. For more details see apt-cacher-ng manual, chapter "Advanced configuration".

mountpoint

Directory representing the URL in the local filesytem.

--help

Print a help summary and additional FUSE application options

FuseOptions

Various options for the FUSE subsystem to control filesystem behaviour. See --help output and FUSE documentation for more details.

## FILES
/usr/lib/apt-cacher-ng/acngfs

Executable binary documented in this manual page

## NOTES
Permissions of the files are important when using mounting when sharing data with other users (including root!). To mount as user and let root use the package management tools (apt, dpkg), one may need to use FUSE options like in the following example:

acngfs http://ftp.uni-kl.de/debian http://localhost:3142 /mnt/misc -o allow_root

See FUSE documentation for details about file permissions representation.

## BUGS
Software is still experimental, use at your own risk!

There are natural limitations on capabilities of the FS: no directory browsing is allowed (only blind descending), permissions of files are inherited from the mount point as well as other properties of the filesystem.

Should be used with apt-cacher-ng version 0.2pre2 or newer; otherwise it could flood log files with many requests from small file chunks.

## SEE ALSO
apt-cacher-ng(8), fusermount(1)

For more information on Apt-Cacher NG, read the User Manual which can be found either in the doc/pdf directory of the software source package or installed in the documentation directory of apt-cacher-ng by your distribution.


apt-cacher-ng

title: apt-cacher-ng(8)

text:
# apt-cacher-ng(8)

## NAME
apt-cacher-ng - caching proxy for software package downloads

## SYNOPSIS

```
apt-cacher-ng [-c confdir] [-h] [optname=optvalue ...]
```

## DESCRIPTION
Apt-Cacher NG is a caching proxy for software packages which are downloaded by Unix/Linux system distribution mechanisms from mirror servers accessible via HTTP.

## OPTIONS
The command-line options supported by apt-cacher-ng are:

-c confdir

Scan the specified configuration directory and interpret configuration files find there.

-h

Short option summary

varname=varopt

The options from the configuration can be passed on the command line as key=value pairs.

## SIGNALS
Only few signals are handled in non-default ways.

SIGUSR1 closes and reopens log files.

SIGTERM and SIGINT close log files and stop the daemon.

## MORE INFORMATION
For more information on Apt-Cacher NG, read the User Manual which can be found either in the doc/pdf directory of the software source package or installed in the documentation directory of apt-cacher-ng by your distribution.


apt-repo

package: apt-repo

title: apt-repo(8)

summary: Manipulate APT repository list

text:
# apt-repo(8)

## NAME
apt-repo — Manipulate APT repository list

## SYNOPSIS
apt-repo

[list] [-a]

apt-repo

list [task] id

apt-repo

add source

apt-repo

rm source|all [type]

apt-repo

set branch

apt-repo

clean

apt-repo

update

apt-repo

test [task] id

apt-repo

upgrade [id]

apt-repo

[-h] [-v]

## DESCRIPTION
The apt-repo script allows to show, add, and remove APT repositories specified by a source in sources.list(5) format, an URL with optional component, a branch name, or a task number.

Since apt-repo relies internally on apt-config(8) to find the files which contain the repository lists, it can be asked to manipulate arbitrary non-system APT sources.list by setting APT_CONFIG, which is a standard environment variable looked into by APT to find its configuration. Example:

APT_CONFIG=~/.hasher/apt-extra.conf apt-repo add p7

will manipulate the repository lists in the files defined (if any) in ~/.hasher/apt-extra.conf. This can be useful, for example, to manipulate a user's local hasher(7) configuration. (Such configurations are described in more detail at https://www.altlinux.org/Hasher/Tips.)

If --dry-run is defined in command line changes only shown, is not performed.

## OPTIONS
list

Show active repositories in sources.list(5) format. If -a is specified, all available repositories are displayed (inactive ones are commented by ‘#’).

list [task] id

Show names of all available packages (except *-devel*, *-checkinstall and *-debuginfo) in a task repository specified by id.

add source

Add source to the list of active repositories.

rm source [<type>]

Remove or comment source if it is active. Special keyword all removes all active sources. The all keyword followed by optional <type> removes all sources of specified type: ‘branch’ or ‘branches’ removes all branch sources, ‘task’ or ‘tasks’ removes all tasks sources, ‘cdrom’ or ‘cdroms’ removes all cdrom sources.

set branch

Removes all exising sources and adds branch branch

clean

Removes all cdrom and task sources.

update

Run apt-get update

to update the APT cache from the active repositories.

test [task] id

Install all available packages (except *-devel*, *-checkinstall and *-debuginfo) from the task repository specified by id.

test [task] id pkg1 pkg2

Install the given packages from the task repository specified by id.

test [task] '' pkg1 pkg2

Install the given packages (without modifying APT repos).

upgrade [id [id]]

Upgrade all packages (including specified task(s) by id ).

-h --help

Print usage information and quit.

-v --version

Print version and quit.

## SOURCE FORMAT

### APT Source
Source can be specified in sources.list(5) format:

apt-repo add "rpm http://git.altlinux.org/repo/39115/ i586 task"

Recognized repository types: rpm, rpm-dir and rpm-src. It is allowed to specify source as separate words. If trailing architecture and component are missing, two lines will be added (current system architecture and ‘noarch’) with component ‘classic’.

### URL
APT supports file://, copy://, http://, ftp://, rsync:// and cdrom:// protocols. URL with required protocol may be followed by an optional architecture and one or more components. If architecture and component are missing, two lines will be added (current system architecture and ‘noarch’) with component ‘classic’. This form is useful to add a branch on a mirror server.

Example:

apt-repo add ftp://mirror.yandex.ru/altlinux/p7/branch

### Absolute Path
Local directory beginning with ‘/’ added as a hasher(7) repository: with current system architecture and ‘hasher’ component.

apt-repo add /opt/repo

### Branch
Branch is a named repository consisting of two parts (current system architecture and 'noarch'). By default, the official server is used. Full form:

apt-repo add branch <name of branch> [<archive_date>]

Keyword ‘branch’ may be omitted. Example:

apt-repo add p7

Running

apt-repo add branch

without the name of a branch displays all available branch names. ‘archive_date’ allows to add archive of branch. Date of archive should be in form YYYYMMDD or YYYY/MM/DD.

### Task
Task is a small repository for one or more subtasks built in http://git.altlinux.org infrastructure. This source is used to install software for test purposes. Any task has a unique number. Full form:

apt-repo add task <number of task>

Keyword ‘task’ may be omitted. Example:

apt-repo add 39115

## FILES
/etc/apt/sources.list

The main list of repositories which APT reads. New repositiories are added here (and, in this case, if it doesn't exist, then it is created).

/etc/apt/sources.list.d/*.list

The additional lists which APT reads.

/etc/apt/apt.conf

/etc/apt/apt.conf.d/*.conf

The system APT configuration which may override the above default paths for sources.list(.d).

## ENVIRONMENT VARIABLES
APT_CONFIG

This value overrides the default place where APT looks for apt.conf. Setting it allows one to manipulate arbitrary user's non-system sources.list by preparing a custom apt.conf (e.g., for hasher).

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

## AUTHORS
Andrey Cherepanov cas@altlinux.org


aptitude

package: aptitude

title: aptitude(8)

summary: high\-level interface to the package manager

text:
# aptitude(8)

## NAME
aptitude - high-level interface to the package manager

## SYNOPSIS
aptitude [<options>...] {autoclean | clean | forget-new | keep-all | update | safe-upgrade}

aptitude [<options>...] {changelog | full-upgrade | download | forbid-version | hold | install | keep-all | markauto | purge | reinstall | remove | show | unhold | unmarkauto} <packages>...

aptitude [<options>...] search <patterns>...

aptitude [-S <fname>] [-i]

aptitude help

## DESCRIPTION
aptitude is a text-based interface to the Debian GNU/Linux package system.

It allows the user to view the list of packages and to perform package management tasks such as installing, upgrading, and removing packages. Actions may be performed from a visual interface or from the command-line.

## COMMAND-LINE ACTIONS
The first argument which does not begin with a hyphen (“-”) is considered to be an action that the program should perform. If an action is not specified on the command-line, aptitude will start up in visual mode.

The following actions are available:

install

Install one or more packages. The packages should be listed after the “install” command; if a package name contains a tilde character (“~”), it will be treated as a search pattern and every package matching the pattern will be installed (see the section “Search Patterns” in the aptitude reference manual). To select a particular version of the package, append “=version” to the package name: for instance, “aptitude install apt=0.3.1”. Similarly, to select a package from a particular archive, append “/archive” to the package name: for instance, “aptitude install apt/experimental”.

Not every package listed on the command line has to be installed; you can tell aptitude to do something different with a package by appending an “override specifier” to the name of the package. For example, aptitude remove wesnoth+ will install wesnoth, not remove it. The following override specifiers are available:

<package>+

Install <package>.

<package>+M

Install <package> and immediately mark it as automatically installed (note that if nothing depends on <package>, this will cause it to be immediately removed).

<package>-

Remove <package>.

<package>_

Purge <package>: remove it and all its associated configuration and data files.

<package>=

Place <package> on hold: cancel any active installation, upgrade, or removal, and prevent this package from being automatically upgraded in the future.

<package>:

Keep <package> at its current version: cancel any installation, removal, or upgrade. Unlike “hold” (above) this does not prevent automatic upgrades in the future.

<package>&M

Mark <package> as having been automatically installed.

<package>&m

Mark <package> as having been manually installed.

As a special case, “install” with no arguments will act on any stored/pending actions.

Note

Once you enter Y at the final confirmation prompt, the “install” command will modify aptitude's stored information about what actions to perform. Therefore, if you issue (e.g.) the command “aptitude install foo bar” and then abort the installation once aptitude has started downloading and installing packages, you will need to run “aptitude remove foo bar” to cancel that order.

remove, purge, hold, unhold, keep, reinstall

These commands are the same as “install”, but apply the named action to all packages given on the command line for which it is not overridden. The difference between hold and keep is that hold will cause a package to be ignored by future safe-upgrade or full-upgrade commands, while keep merely cancels any scheduled actions on the package. unhold will allow a package to be upgraded by future safe-upgrade or full-upgrade commands, without otherwise altering its state. For instance, “aptitude remove '~ndeity'” will remove all packages whose name contains “deity”.

markauto, unmarkauto

Mark packages as automatically installed or manually installed, respectively. Packages are specified in exactly the same way as for the “install” command. For instance, “aptitude markauto '~slibs'” will mark all packages in the “libs” section as having been automatically installed. For more information on automatically installed packages, see the section “Managing Automatically Installed Packages” in the aptitude reference manual.

forbid-version

Forbid a package from being upgraded to a particular version. This will prevent aptitude from automatically upgrading to this version, but will allow automatic upgrades to future versions. By default, aptitude will select the version to which the package would normally be upgraded; you may override this selection by appending “=version” to the package name: for instance, “aptitude forbid-version vim=1.2.3.broken-4”. This command is useful for avoiding broken versions of packages without having to set and clear manual holds. If you decide you really want the forbidden version after all, the “install” command will remove the ban.

update

Updates the list of available packages from the apt sources (this is equivalent to “apt-get update”)

safe-upgrade

Upgrades installed packages to their most recent version. Installed packages will not be removed unless they are unused (see the section “Managing Automatically Installed Packages” in the aptitude reference manual); packages which are not currently installed will not be installed. It is sometimes necessary to remove or install one package in order to upgrade another; this command is not able to upgrade packages in such situations. Use the full-upgrade command to upgrade as many packages as possible.

full-upgrade

Upgrades installed packages to their most recent version, removing or installing packages as necessary. This command is less conservative than safe-upgrade and thus more likely to perform unwanted actions. However, it is capable of upgrading packages that safe-upgrade cannot upgrade.

Note

This command was originally named dist-upgrade for historical reasons, and aptitude still recognizes dist-upgrade as a synonym for full-upgrade.

keep-all

Cancels all scheduled actions on all packages; any packages whose sticky state indicates an installation, removal, or upgrade will have this sticky state cleared.

forget-new

Forgets all internal information about what packages are “new” (equivalent to pressing “f” when in visual mode).

search

Searches for packages matching one of the patterns supplied on the command line. All packages which match any of the given patterns will be displayed; for instance, “aptitude search '~N' edit” will list all “new” packages and all packages whose name contains “edit”. For more information on search patterns, see the section “Search Patterns” in the aptitude reference manual. Unless you pass the -F option, the output of aptitude search will look something like this:

```
i   apt                             - Advanced front-end for dpkg
pi  apt-build                       - frontend to apt to build, optimize and in
cp  apt-file                        - APT package searching utility -- command-
ihA raptor-utils                    - Raptor RDF Parser utilities
```

Each search result is listed on a separate line. The first character of each line indicates the current state of the package: the most common states are p, meaning that no trace of the package exists on the system, c, meaning that the package was deleted but its configuration files remain on the system, i, meaning that the package is installed, and v, meaning that the package is virtual. The second character indicates the stored action (if any; otherwise a blank space is displayed) to be performed on the package, with the most common actions being i, meaning that the package will be installed, d, meaning that the package will be deleted, and p, meaning that the package and its configuration files will be removed. If the third character is A, the package was automatically installed.

For a complete list of the possible state and action flags, see the section “Accessing Package Information” in the aptitude reference guide.

show

Displays detailed information about one or more packages, listed following the search command. If a package name contains a tilde character (“~”), it will be treated as a search pattern and all matching packages will be displayed (see the section “Search Patterns” in the aptitude reference manual). If the verbosity level is 1 or greater (i.e., at least one -v is present on the command-line), information about all versions of the package is displayed. Otherwise, information about the “candidate version” (the version that “aptitude install” would download) is displayed.

You can display information about a different version of the package by appending =version to the package name; you can display the version from a particular archive by appending /archive to the package name. If either of these is present, then only the version you request will be displayed, regardless of the verbosity level.

If the verbosity level is 1 or greater, the package's architecture, compressed size, filename, and md5sum fields will be displayed. If the verbosity level is 2 or greater, the select version or versions will be displayed once for each archive in which they are found.

clean

Removes all previously downloaded files from the package cache directory (usually /var/cache/apt/archives).

autoclean

Removes any cached packages which can no longer be downloaded. This allows you to prevent a cache from growing out of control over time without completely emptying it.

changelog

Downloads and displays the Debian changelog for each of the given source or binary packages. By default, the changelog for the version which would be installed with “aptitude install” is downloaded. You can select a particular version of a package by appending =version to the package name; you can select the version from a particular archive by appending /archive to the package name.

download

Downloads the file for the given package to the current directory. By default, the version which would be installed with “aptitude install” is downloaded. You can select a particular version of a package by appending =version to the package name; you can select the version from a particular archive by appending /archive to the package name.

help

Displays a brief summary of the available commands and options.

## OPTIONS
The following options may be used to modify the behavior of the actions described above. Note that while all options will be accepted for all commands, some options don't apply to particular commands and will be ignored by those commands.

-D, --show-deps

For commands that will install or remove packages (install, full-upgrade, etc), show brief explanations of automatic installations and removals. This corresponds to the configuration option Aptitude::CmdLine::Show-Deps.

-d, --download-only

Download packages to the package cache as necessary, but do not install or remove anything. By default, the package cache is stored in /var/cache/apt/archives. This corresponds to the configuration option Aptitude::CmdLine::Download-Only.

-F <format>, --display-format <format>

Specify the format which should be used to display output from the search command. For instance, passing “%p %V %v” for <format> will display a package's name, followed by its currently installed version and its available version (see the section “Customizing how packages are displayed” in the aptitude reference manual for more information). This corresponds to the configuration option Aptitude::CmdLine::Package-Display-Format.

-f

Try hard to fix the dependencies of broken packages, even if it means ignoring the actions requested on the command line. This corresponds to the configuration item Aptitude::CmdLine::Fix-Broken.

-h, --help

Display a brief help message. Identical to the help action.

--purge-unused

Purge packages that are no longer required by any installed package. This is equivalent to passing “-o Aptitude::Purge-Unused=true” as a command-line argument.

-P, --prompt

Always display a prompt, even when no actions other than those explicitly requested will be performed. This corresponds to the configuration option Aptitude::CmdLine::Always-Prompt.

-R, --without-recommends

Do not treat recommendations as dependencies when installing new packages (this overrides settings in /etc/apt/apt.conf and ~/.aptitude/config). Packages previously installed due to recommendations will not be removed. This corresponds to the pair of configuration options Aptitude::Recommends-Important and Aptitude::Keep-Recommends.

-r, --with-recommends

Treat recommendations as dependencies when installing new packages (this overrides settings in /etc/apt/apt.conf and ~/.aptitude/config). This corresponds to the configuration option Aptitude::Recommends-Important

-s, --simulate

In command-line mode, print the actions that would normally be performed, but don't actually perform them. This does not require root privileges. In the visual interface, always open the cache in read-only mode regardless of whether you are root. This corresponds to the configuration option Aptitude::Simulate.

--schedule-only

For commands that modify package states, schedule operations to be performed in the future, but don't perform them. You can execute scheduled actions by running aptitude install with no arguments. This is equivalent to making the corresponding selections in visual mode, then exiting the program normally. For instance, aptitude --schedule-only install evolution will schedule the evolution package for later installation.

-t <release>, --target-release <release>

Set the release from which packages should be installed. For instance, “aptitude -t experimental ...” will install packages from the experimental distribution unless you specify otherwise. For the command-line actions “changelog”, “download”, and “show”, this is equivalent to appending /release to each package named on the command-line; for other commands, this will affect the default candidate version of packages according to the rules described in apt_preferences(5). This corresponds to the configuration item APT::Default-Release.

-O <order>, --sort <order>

Specify the order in which output from the search command should be displayed. For instance, passing “installsize” for <order> will list packages in order according to their size when installed (see the section “Customizing how packages are sorted” in the aptitude reference manual for more information).

-o <key>=<value>

Set a configuration file option directly; for instance, use -o Aptitude::Log=/tmp/my-log to log aptitude's actions to /tmp/my-log. For more information on configuration file options, see the section “Configuration file reference” in the aptitude reference manual.

-q=n, --quiet=n

Suppress all incremental progress indicators, thus making the output loggable. This may be supplied multiple times to make the program quieter, but unlike apt-get, aptitude does not enable -y when -q is supplied more than once. The optional =n may be used to directly set the amount of quietness (for instance, to override a setting in /etc/apt/apt.conf); it causes the program to behave as if -q had been passed exactly <n> times.

-V, --show-versions

Show which versions of packages will be installed. This corresponds to the configuration option Aptitude::CmdLine::Show-Versions.

-v, --verbose

Causes some commands (for instance, show) to display extra information. This may be supplied multiple times to get more and more information. This corresponds to the configuration option Aptitude::CmdLine::Verbose.

--version

Display the version of aptitude and some information about how it was compiled.

--visual-preview

When installing or removing packages from the command line, instead of displaying the usual prompt, start up the visual interface and display its preview screen.

-w <width>, --width <width>

Specify the display width which should be used for output from the search command (by default, the terminal width is used). This corresponds to the configuration option Aptitude::CmdLine::Package-Display-Width

-y, --assume-yes

When a yes/no prompt would be presented, assume that the user entered “yes”. In particular, suppresses the prompt that appears when installing, upgrading, or removing packages. Prompts for “dangerous” actions, such as removing essential packages, will still be displayed. This option overrides -P. This corresponds to the configuration option Aptitude::CmdLine::Assume-Yes.

-Z

Show how much disk space will be used or freed by the individual packages being installed, upgraded, or removed. This corresponds to the configuration option Aptitude::CmdLine::Show-Size-Changes.

The following options apply to the visual mode of the program, but are primarily for internal use; you generally won't need to use them yourself.

-S <fname>

Loads the extended state information from <fname> instead of the standard state file.

-i

Displays a download preview when the program starts (equivalent to starting the program and immediately pressing “g”).

## ENVIRONMENT
HOME

If $HOME/.aptitude exists, aptitude will store its configuration file in $HOME/.aptitude/config. Otherwise, it will look up the current user's home directory using getpwuid(2) and place its configuration file there.

PAGER

If this environment variable is set, aptitude will use it to display changelogs when “aptitude changelog” is invoked. If not set, it defaults to more.

TMP

If TMPDIR is unset, aptitude will store its temporary files in TMP if that variable is set. Otherwise, it will store them in /tmp.

TMPDIR

aptitude will store its temporary files in the directory indicated by this environment variable. If TMPDIR is not set, then TMP will be used; if TMP is also unset, then aptitude will use /tmp.

## SEE ALSO
apt-get(8), apt(8), /usr/share/doc/aptitude/html/<lang>/index.html from the package aptitude-doc-<lang>

## AUTHOR
Daniel Burrows <dburrows@debian.org>

Author.

## COPYRIGHT
This manual page is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This manual page is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


aox

package: archiveopteryx

title: aox(8)

text:
# aox(8)

## NAME
aox - management tool for Archiveopteryx.

## SYNOPSIS
/usr/bin/aox verb noun [ options ] [ arguments ]

aox help commands

aox help command

## DESCRIPTION
aox is a command-line program to perform various system administration tasks for Archiveopteryx.

Examples of such tasks are adding users, changing the access control for mailboxes, etc. In principle, everything one would want to do using a shell script should be doable using aox.

## COMMANDS
aox start [-v]

Starts the Archiveopteryx servers in the correct order.

aox stop [-v]

Stops the running Archiveopteryx servers in the correct order.

aox restart [-v]

Restarts the servers in the correct order (currently equivalent to start && stop).

aox show status [-v]

Displays a summary of the running Archiveopteryx servers.

aox show configuration [-p -v] [variable-name]

Displays variables configured in archiveopteryx.conf.

If a variable-name is specified, only that variable is displayed.

The -v flag displays only the value of the variable.

The -p flag restricts the results to variables whose value has been changed from the default.

configuration may be abbreviated as cf.

aox show build

Displays the build settings used for this installation (as configured in Jamsettings).

aox show counts [-f]

Displays the number of rows in the most important tables, as well as the total size of the mail stored.

The -f flag causes it to collect slow-but-accurate statistics. Without it, by default, you get quick estimates (more accurate after VACUUM ANALYSE).

aox show queue

Displays a list of all mail queued for delivery to a smarthost.

aox show schema

Displays the revision of the existing database schema.

aox upgrade schema [-n]

Checks that the database schema is one that this version of Archiveopteryx is compatible with, and updates it if needed.

The -n flag causes aox to perform the SQL statements for the schema upgrade and report on their status without COMMITing the transaction (i.e. see what the upgrade would do, without doing anything).

aox update database

Performs any updates to the database contents which are too slow for inclusion in aox upgrade schema. This command is meant to be used while the server is running. It does its work in small chunks, so it can be restarted at any time, and is tolerant of interruptions.

aox tune database <mostly-writing|mostly-reading|advanced-reading>

Adjusts the database indices and configuration to suit expected usage patterns.

aox list mailboxes [-d] [-o username] [pattern]

Displays a list of mailboxes matching the specified shell glob pattern. Without a pattern, all mailboxes are listed.

The -d flag includes deleted mailboxes in the list.

The "-o username" flag restricts the list to mailboxes owned by the specified user.

The -s flag shows a count of messages and the total size of the messages in each mailbox.

ls is an acceptable abbreviation for list.

aox list users [pattern]

Displays a list of users matching the specified shell glob pattern. Without a pattern, all users are listed.

aox list aliases [pattern]

Displays a list of aliases where either the address or the target mailbox matches the specified shell glob pattern. Without a pattern, all aliases are listed.

aox list rights <mailbox> [username]

Displays a list of users and the rights they have been granted to the specified mailbox. If a username is given, only that user's rights are displayed.

aox add user <username> <password> <email-address>

aox add user -p <username> <email-address>

Creates a new Archiveopteryx user with the specified username, password, and email address. If the -p flag is specified, the password is read interactively, instead of from the command-line.

create and new are acceptable abbreviations for add.

aox delete user [-f] <username>

Deletes the specified Archiveopteryx user. If -f is specified, any mailboxes owned by the user are also deleted.

del and remove are acceptable abbreviations for delete.

aox change password <username> <new-password>

aox change password -p <username>

Changes the specified user's password. If the -p flag is specified, the password is read interactively, instead of from the command-line.

aox change username <username> <new-username>

Renames the specified user.

aox change address <username> <new-address>

Changes the specified user's email address.

aox add mailbox <name> [username]

Creates a new mailbox with the specified name and, if a username is specified, owned by that user.

The mailbox name must be fully-qualified (begin with /), unless a username is specified, in which case unqualified names are assumed to be under the user's home directory.

aox delete mailbox [-f] <name>

Deletes the specified mailbox.

If -f is specified, the mailbox and any messages it contains are permanently deleted. Otherwise, only empty mailboxes are deleted.

aox add view <name> <source> <owner> <search>

Creates a new view mailbox which applies the specified search on the specified source mailbox. When a new message is added to the source, and it matches the search, it will automatically be added to the view as well.

aox add alias <address> <mailbox>

Creates an alias that instructs the server to accept mail to the given address and deliver it to the specified mailbox.

aox delete alias <address>

Deletes an alias, if one exists, for the given address.

aox setacl [-d] <mailbox> <identifier> <rights>

Assigns the specified rights to the given identifier on the mailbox. If the rights begin with + or -, the specified rights are added to or subtracted from the existing rights; otherwise, the rights are set to exactly those given.

With -d, the identifier's rights are deleted altogether.

A summary of the changes made is displayed when the operation completes.

aox undelete <mailbox> <search>

Searches for deleted messages in the specified mailbox and restores those that match the search.

Messages can be restored after an IMAP EXPUNGE or POP3 DELE until aox vacuum permanently removes them after the configured undelete-time.

Example: aox undelete /users/fred/inbox from example.com

aox vacuum

Permanently deletes messages that were marked for deletion more than undelete-time days ago, and removes any bodyparts that are no longer used.

This is not a replacement for running VACUUM ANALYSE on the database (either with vacuumdb or via autovacuum).

This command should be run (we suggest daily) via crontab.

aox anonymise <file>

Reads a mail message from the named file, obscures most or all content and prints the result on stdout. The output resembles the original closely enough to be used in a bug report.

aox reparse

Looks for messages that "arrived but could not be stored" and tries to parse them using workarounds that have been added more recently. If it succeeds, the new message is injected and the old one deleted.

aox grant privileges <username>

makes sure that the named user has all the permissions needed for the db-user (i.e., and unprivileged user), and no more.

aox check config

reads the configuration files and reports any problems that it finds.

## OPTIONS
The -v flag enables (slightly) more verbose diagnostic output wherever it is supported (see the descriptions of each command above).

## EXAMPLES
To add a user called "nirmala", whose password is "angstskrik" and whose main email address is "nirmala@example.com":

aox add user nirmala angstskrik nirmala@example.com

To change Nirmala's password to "temmelig hemmelig":

aox change password nirmala 'temmelig hemmelig'

To remove that user:

aox remove user nirmala

## DIAGNOSTICS
The return code of aox is zero if all goes well, and a non-zero in case of errors.

Diagnostics are logged using Archiveopteryx's logd(8), just like the servers do. Disasters are also logged via stderr.

## BUGS
There is no command-line option to set 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(8), archiveopteryx.conf(5), http://archiveopteryx.org


aoximport

title: aoximport(8)

text:
# aoximport(8)

## NAME
aoximport - import messages into Archiveopteryx.

## SYNOPSIS
/usr/bin/aoximport [-vqe] mailbox type source-file [ source-file ... ]

## DESCRIPTION
aoximport is used to import messages into Archiveopteryx en masse from other mailboxes (mbox, MH, maildir and Cyrus mailboxes are currently supported).

## OPTIONS
-v

enables more verbose output. Can be repeated.

-q

sets the verbosity to zero.

-e

makes aoximport write problem messages to the errors subdirectory. If a message has parse problems, aoximport writes a copy of the message to errors/anonymised if anonymisation preserves the error, and to errors/plaintext else. The message is also written to the target mailbox, as an attachment to a special error message.

The messages in the errors directory may be sent to info@aox.org, and we'll try to find out what the problem is. Please delete personal/confidential messages from errors/plaintext first.

## SYNTAX
In the synopsis above, mailbox is the fully-qualified name of the destination mailbox (which must exist) into which messages are imported. type may be mbox, maildir, mh, or cyrus. The remaining arguments are interpreted as mailbox filenames of the specified type.

## EXAMPLES
To import messages from the mbox files in ~/Mail/imap/* to a mailbox named /users/nirmala/imap:

aoximport /users/nirmala/imap mbox ~/Mail/imap/*

After a large import, it's a good idea to run aox vacuum.

## 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
aox(8), archiveopteryx(8), http://archiveopteryx.org