apachkconfig

package: apachkconfig

title: apachkconfig(8)

text:
# apachkconfig(8)

## NAME
apachkconfig - updates and queries addons config information for different Apache favours

## SYNOPSIS
apachkconfig --list [name]

apachkconfig --add name

apachkconfig --del name

apachkconfig [--favour|--level favours] name <on|off|reset>

apachkconfig [--favour|--level favours] name

## DESCRIPTION
apachkconfig provides a simple command-line tool for maintaining the apache addon configuration (e.g /etc/httpd*/addon.d) directories by relieving system administrators of the task of directly manipulating the numerous symbolic links in those directories.

This implementation (as well as this man page) of apachkconfig was inspired by the chkconfig command used for manipulating SYSV services.

apachkconfig has five distinct functions: adding new addon for management, removing addons from management, listing the current startup information for addons, changing the startup information for addons, and checking the startup state of a particular addon.

When apachkconfig is run without any options, it displays usage information. If only an addon name is given, it checks to see if the service is configured to be loaded by the default apache favour. If it is, apachkconfig returns true; otherwise it returns false. The --favour option may be used to have apachkconfig query an alternative favour rather than the default one.

If one of on, off, or reset is specified after the addon name, apachkconfig changes the startup information for the specified addon. The on and off flags cause the addon to be loaded or ignored, respectively, by the apache favour being changed. The reset flag resets the startup information for the addon to whatever is specified in the config file in question.

By default, the on, off and reset options affect all of the apache favours installed. The --favour option may be used to specify which favours are affected.

## OPTIONS
--favour favours

Specifies the apache favours an operation should pertain to. It is given as an alpha-numeric string. For example, --favour 1p2 specifies favours 1 (Apache-13), p (Apache13-mod_perl) and 2 (Apache2).

--add name

This option adds a new addon for management by apachkconfig. When a new addon is added, apachkconfig ensures that the service has an activate entry in every favour. If any apache favour is missing such an entry, chkconfig creates the appropriate entry as specified by the default values in the addon config file.

--del name

The addon is removed from apachkconfig management, and any symbolic links in apache addon config directories (e.g /etc/httpd*/addon.d) which pertain to it are removed.

--list name

This option lists all of the addons which apachkconfig knows about, and whether they are loaded or ignored by each apache favour. If name is specified, information is only displayed about addon name.

## FAVOUR FILES
Each addon which should be manageable by apachkconfig needs two or more commented lines added to its config file. The first line tells apachkconfig for what favours the addon should be loaded by default, as well as the load priority level and optionally favour restriction list. If the addon should not, by default, be loaded in any favours, a - should be used in place of the favours list. If the addon should never be loaded by any other apache favour, exept some exactly named, add the list of restricted favours after the priority level. The second line contains a description for the service, and may be extended across multiple lines with backslash continuation.

For example, awstats.conf has these three lines:

```
# apachkconfig: 1p2 50
# description: Real-time logfile analyzer to get advanced web statistics \

               AWStats is a short for Advanced Web Statistics. It's a free \
	       tool that generates advanced web (but also ftp, syslog or \
	       mail) server access statistics graphically.
```

This says that the awstats CGI script config should be loaded by apache favours 1, p, and 2, that its start priority should be 50, and that its stop priority should be 80. You should be able to figure out what the description says; the \ causes the line to be continued. The extra space in front of the line is ignored. Second example, webauth.conf make sense only for Apache2:

```
# apachkconfig: - 12 2
# description: A WebAuth (GSS-API) authentication module for Apache2
```

This says that the webauth module config could be loaded only by apache favour 2, that its start priority should be 12 and that it should be disabled by default.

## SEE ALSO
chkconfig(8) httpd(8)

## AUTHOR

```
Yury Konovalov <yurix@altlinux.org>
```


apcaccess

package: apcupsd

title: apcaccess(8)

text:
# apcaccess(8)

## NAME
apcaccess — retrieve status information from apcupsd(8)

## SYNOPSIS
apcaccess

[-f <config-file>] [-h <host>[:<port>]] [-p <parameter-name>] [-u] [<command>] [<host>[:<port>]]

## DESCRIPTION
apcaccess is a program which prints out the complete status of most American Power Conversion Corp. (APC) UPSes provided you have the apcupsd(8) daemon installed, properly configured and running. It can access status information from any APC UPS attached to the localhost or attached to any computer on the network which is running apcuspd in NIS mode.

The command line options are:

-f

configuration file of apcupsd (default is usually /etc/apcupsd/apcupsd.conf)

-h

hostname and port of apcupsd to communicate with. The default hostname and port are obtained from the configuration file.

-p

Report only the value of the named parameter instead of all parameters and values.

-u

Remove units field for easier parsing by scripts.

<command>

An optional command, unless a hostname is also being specified. The only implemented command is status Shorthand for status localhost:3551. This produces a full printout of the available status information for the associated UPS.

<host>

An optional hostname which may be a bare machine name, fully qualified domain name or IP address.

:<port>

An optional port number where a hostname argument has been specified. The default is 3551, the official port number assigned by IANA for the apcupsd NIS server. The default hostname and port are obtained from the configuration file.

apcaccess uses apcupsd's inbuilt Network Information Server (NIS) -- no relation to Sun's NIS/YP service -- to obtain the current status information from the UPS on the local or remote computer. It is therefore necessary to have the following configuration directives:

-

NETSERVER on

-

NISPORT 3551

in the /etc/apcupsd/apcupsd.conf configuration file so that the Network Information Server will be accessible. Firewall rules for appropriate network access may also be needed.

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

## EXAMPLES
Set out below is a sample of the status output which may be generated for the specified UPS models.

### All models
APC

: version, number of records and number of bytes following

DATE

: Date and time of last update from UPS

HOSTNAME

: hostname of computer running apcupsd

VERSION

: apcupsd version number, date and operating system

UPSNAME

: UPS name from configuration file (dumb) or EEPROM (smart)

CABLE

: Cable type specified in the configuration file

MODEL

: UPS model derived from UPS information

UPSMODE

: Mode in which UPS is operating

STARTTIME

: Date and time apcupsd was started

STATUS

: UPS status. One or more of the following (space-separated): CAL TRIM BOOST ONLINE ONBATT OVERLOAD LOWBATT REPLACEBATT NOBATT SLAVE SLAVEDOWN

or

COMMLOST

or

SHUTTING DOWN

MASTERUPD

: Last time the master sent an update to the slave

ENDAPC

: Date and time of status information was written

### Smart-UPS and Matrix-UPS (Smart Signalling)
LINEV

: Current input line voltage

LOADPCT

: Percentage of UPS load capacity used as estimated by UPS

BCHARGE

: Current battery capacity charge percentage

TIMELEFT

: Remaining runtime left on battery as estimated by the UPS

MBATTCHG

: Min battery charge % (BCHARGE) required for system shutdown

MINTIMEL

: Min battery runtime (MINUTES) required for system shutdown

MAXTIME

: Max battery runtime (TIMEOUT) after which system is shutdown

MAXLINEV

: Maximum input line voltage since apcupsd started

MINLINEV

: Min (observed) input line voltage since apcupsd started

OUTPUTV

: Current UPS output voltage

SENSE

: Current UPS sensitivity setting for voltage fluctuations

DWAKE

: Time UPS waits after power off when the power is restored

DSHUTD

: Delay before UPS powers down after command received

DLOWBATT

: Low battery signal sent when this much runtime remains

LOTRANS

: Input line voltage below which UPS will switch to battery

HITRANS

: Input line voltage above which UPS will switch to battery

RETPCT

: Battery charge % required after power off to restore power

ITEMP

: UPS internal temperature in degrees Celcius

ALARMDEL

: Delay period before UPS starts sounding alarm

BATTV

: Current battery voltage

LINEFREQ

: Current line frequency in Hertz

LASTXFER

: Reason for last transfer to battery since apcupsd startup

NUMXFERS

: Number of transfers to battery since apcupsd startup

XONBATT

: Date, time of last transfer to battery since apcupsd startup

TONBATT

: Seconds currently on battery

CUMONBATT

: Cumulative seconds on battery since apcupsd startup

XOFFBAT

: Date, time of last transfer off battery since apcupsd startup

SELFTEST

: Date and time of last self test since apcupsd startup

STESTI

: Self-test interval

STATFLAG

: UPS status flag in hex

DIPSW

: Current UPS DIP switch settings

REG1

: Fault register 1 in hex

REG2

: Fault register 2 in hex

REG3

: Fault register 3 in hex

MANDATE

: UPS date of manufacture

SERIALNO

: UPS serial number

BATTDATE

: Date battery last replaced (if set)

NOMOUTV

: Nominal output voltage to supply when on battery power

NOMBATTV

: Nominal battery voltage

EXTBATTS

: Number of external batteries (for XL models)

BADBATTS

: Number of bad external battery packs (for XL models)

FIRMWARE

: UPS firmware version

APCMODEL

: APC model information

### Newer Back-UPS Pro (Smart Signalling)
LINEV

: Current input line voltage

LOADPCT

: Percentage of UPS load capacity used

MBATTCHG

: Min battery charge % (BCHARGE) required for system shutdown

MINTIMEL

: Min battery runtime (MINUTES) required for system shutdown

MAXTIME

: Max battery runtime (TIMEOUT) after which system is shutdown

MAXLINEV

: Maximum input line voltage since apcupsd startup

MINLINEV

: Minimum input line voltage since apcupsd startup

OUTPUTV

: Current UPS output voltage

BATTV

: Current battery charge voltage

STATFLAG

: UPS status flag in hex

### Back-UPS RS 1500 (USB)
LINEV

: Current input line voltage

LOADPCT

: Percentage of UPS load capacity used

BCHARGE

: Current battery capacity charge percentage

TIMELEFT

: Remaining runtime left on battery as estimated by UPS

MBATTCHG

: Min battery charge % (BCHARGE) required for system shutdown

MINTIMEL

: Min battery runtime (MINUTES) required for system shutdown

MAXTIME

: Max battery runtime (TIMEOUT) after which system is shutdown

*OUTPUTV

: Current UPS output voltage

*DWAKE

: Time UPS waits after power off when the power is restored

*DSHUTD

: Delay before UPS powers down after command received

LOTRANS

: Input line voltage below which UPS will switch to battery

HITRANS

: Input line voltage above which UPS will switch to battery

*RETPCT

: Battery charge % required after power off to restore power

*ITEMP

: UPS internal temperature in degrees Celcius

ALARMDEL

: Delay period before UPS starts sounding alarm

BATTV

: Current battery voltage

*LINEFREQ

: Current line frequency in Hertz

*LASTXFER

: Reason for last transfer to battery since apcupsd startup

NUMXFERS

: Number of transfers to battery since apcupsd startup

XONBATT

: Date, time of last transfer to battery since apcupsd startup

TONBATT

: Seconds currently on battery

CUMONBATT

: Cumulative seconds on battery since apcupsd startup

XOFFBAT

: Date, time of last transfer off battery since apcupsd startup

SELFTEST

: Date and time of last self test since apcupsd startup

STATFLAG

: UPS status flag in hex

MANDATE

: UPS date of manufacture

SERIALNO

: UPS serial number

BATTDATE

: Date battery last replaced (if set)

NOMBATTV

: Nominal battery voltage

FIRMWARE

: UPS firmware version

APCMODEL

: APC model information

* presence dependant on USB firmware version.

### Web/SNMP (AP9716) or PowerNet SNMP (AP9605) SmartSlot Card
LINEV

: Current input line voltage

LOADPCT

: Percentage of UPS load capacity used as estimated by UPS

BCHARGE

: Current battery capacity charge percentage

TIMELEFT

: Remaining runtime left on battery as estimated by UPS

MBATTCHG

: Min battery charge % (BCHARGE) required for system shutdown

MINTIMEL

: Min battery runtime (MINUTES) required for system shutdown

MAXTIME

: Max battery runtime (TIMEOUT) after which system is shutdown

MAXLINEV

: Maximum input line voltage since apcupsd startup

MINLINEV

: Minimum input line voltage since apcupsd startup

OUTPUTV

: UPS output voltage

SENSE

: Current UPS sensitivity setting for voltage fluctuations

DWAKE

: Time UPS waits after power off when the power is restored

DSHUTD

: Delay before UPS powers down after command received

DLOWBATT

: Low battery signal sent when this much runtime remains

LOTRANS

: Input line voltage below which UPS will switch to battery

HITRANS

: Input line voltage above which UPS will switch to battery

RETPCT

: Battery charge % required after power off to restore power

ITEMP

: UPS internal temperature in degrees Celcius

ALARMDEL

: Delay period before UPS starts sounding alarm

LINEFREQ

: Current line frequency in Hertz

NUMXFERS

: Number of transfers to battery since apcupsd startup

TONBATT

: Seconds currently on battery

CUMONBATT

: Cumulative seconds on battery since apcupsd startup

XOFFBATT

: Date, time of last transfer off battery since apcupsd startup

STESTI

: Self-test interval

STATFLAG

: UPS status flag in hex

DIPSW

: Current UPS DIP switch settings

MANDATE

: UPS date of manufacture

SERIALNO

: UPS serial number

BATTDATE

: Date battery last replaced (if set)

NOMOUTV

: Nominal output voltage to supply when on battery power

NOMPOWER

: Nominal power output in watts

EXTBATTS

: Number of external batteries (for XL models)

BADBATTS

: Number of bad external battery packs (for XL models)

FIRMWARE

: UPS firmware version

APCMODEL

: APC model information

### Share-UPS (AP9270) (Basic port)
MBATTCHG

: Min battery charge % (BCHARGE) required for system shutdown

MINTIMEL

: Min battery runtime (MINUTES) required for system shutdown

MAXTIME

: Max battery runtime (TIMEOUT) after which system is shutdown

NUMXFERS

: Number of transfers to battery since apcupsd startup

TONBATT

: Seconds currently on battery

CUMONBATT

: Cumulative seconds on battery since apcupsd startup

XOFFBATT

: Date, time of last transfer off battery since apcupsd startup

STATFLAG

: UPS status flag in hex

### UPS Environmental Monitoring SmartSlot Card (AP9612TH)
HUMIDITY

: Ambient humidity

AMBTEMP

: Ambient temperature

### Back-UPS Pro and Smart-UPS v/s (Smart Signalling)
LINEFAIL

: Input line voltage status.

BATTSTAT

: Battery status.

LASTXFER

: Last (observed) transfer to battery.

### Back-UPS and Net-UPS (Simple Signalling)
LINEFAIL

: Input line voltage status.

BATTSTAT

: Battery status.

STATFLAG

: UPS status flag in hex.

## FILES
/etc/apcupsd/apcupsd.conf

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

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


apccontrol

title: apccontrol(8)

summary: apcupsd(8) event handler script

text:
# apccontrol(8)

## NAME
apccontrol — apcupsd(8) event handler script

## SYNOPSIS
apccontrol

{ <event> <ups-name> <connected> <powered> }

## DESCRIPTION
When apcupsd(8) detects anomalies from the UPS being monitored, it triggers an event which usually results in one or more calls to the apccontrol shell script. Each event causes apccontrol to take a particular action. These actions default to sane behaviour for all the events that apcupsd is likely to encounter. However, you can change the behaviour of every single action.

When apcupsd detects an event, it calls the apccontrol script with the following four arguments:

event

This is the event that occurred. Refer to the list of possible events below.

ups-name

This is the name of the UPS as specified in the /etc/apcupsd/apcupsd.conf configuration file - not the name in the EEPROM of a smart UPS.

connected

This is 1 if apcupsd is connected to the UPS via a serial or USB port. In the case of a slave machine where apcupsd is not directly connected to the UPS, this value will be 0.

powered

This is 1 if the computer on which apcupsd is running is powered by the UPS and 0 if not. This is not currently implemented and always defaults to 0.

Events are sent to the system log and, optionally, to the temporary events file (/etc/apcupsd/apcupsd.events), and they also generate a call to apccontrol which in turn will call any scripts you have placed in the /etc/apcupsd directory.

### LIST OF EVENTS AND DEFAULT ACTIONS
annoyme

apcupsd generates this event when a shutdown is scheduled, and the time specified by the ANNOYME configuration directive in the /etc/apcupsd/apcupsd.conf file has expired. Default action -- sends "Power problems please logoff." to wall(1) and then exits.

battattach

apcupsd generates this event when it detects that the UPS battery has been reconnected after a battdetach event. Default action: does nothing.

battdetach

apcupsd generates this event when it detects that the UPS battery has been disconnected. Default action: does nothing.

changeme

apcupsd generates this event when it detects that the utility power is on, but the battery is not functioning correctly. This is repeated every 9 hours. Default action -- sends "Emergency! UPS batteries have failed Change them NOW" to wall and then exits.

commfailure

apcupsd generates this event each time it loses communication with the monitored UPS. This event is not detected on simple signalling UPSes like the Back-UPS 650. Default action -- sends "Communications with UPS lost." to wall and then exits.

commok

apcupsd generates this event after a commfailure event when communication with the UPS is re-established. Default action -- sends "Communications with UPS restored." to wall and then exits.

doreboot

This event is deprecated and should not be used. Default action -- sends "Beginning Reboot Sequence" to wall and then calls shutdown(8) with the "-r now" command line arguments to reboot the computer.

doshutdown

apcupsd generates this event to shutdown the computer when the UPS is running on battery power and one of the limits (time, run, load) is reached. Default action -- sends "Beginning Shutdown Sequence" to wall and then calls shutdown(8) with the command line arguments "-h now" to shutdown the computer.

emergency

apcupsd generates this event when the UPS is on battery power, the battery is low and the utility power is on: a sure sign of battery failure! Default action -- sends "Emergency Shutdown. Possible UPS battery failure." to wall. Immediately after this, apcupsd generates a doshutdown event to shutdown the system.

failing

apcupsd generates this event when the UPS is running on batteries and the UPS sets the low battery signal indicating that battery power is nearly exhausted. After this event, apcupsd will immediately generate a doshutdown event. Default action -- sends "UPS battery power exhausted. Doing shutdown." to wall and then exits.

killpower

apcupsd does not normally generate this event. Instead, it is invoked directly from the system halt script as 'apccontrol killpower' because the killpower event needs to be performed as late in system shutdown as possible. Default action -- sends "UPS now committed to shut down" to wall, waits for 10 seconds and then issues the command "apcupsd --killpower" to put the UPS into hibernate mode and shut off power to the connected equipment. In the case of a smart UPS, the UPS will then wait for the expiry of any configured shutdown time delay specified by the SLEEP configuration directive. In hibernate mode, the UPS will restore utility power to the connected equipment subject to the values specified for the RETURNCHARGE and WAKEUP configuration directives.

loadlimit

apcupsd generates this event when the battery discharge limit specified by the BATTERYLEVEL configuration directive has been reached. Default action -- sends "UPS battery discharge limit reached. Doing shutdown" to wall and then exits. After this event, apcupsd will immediately generate a doshutdown event.

mainsback

apcupsd generates this event when the utility power returns after a powerout event. The doshutdown event may or may not have been generated depending on the parameters you have defined and the length of the power outage. Attempting cancellation of a doshutdown event should never be tried as it is very unlikely to succeed and will almost certainly leave your computer in an indeterminate state. Default action -- if the file /var/run/powerfail exists, sends "Continuing with shutdown." to wall and then exits. Otherwise, does nothing.

onbattery

apcupsd generates this event if a power failure has been detected and the UPS is still on battery power at the expiry of the delay specified by the ONBATTERYDELAY configuration directive. Default action -- sends "Power failure. Running on UPS batteries." to wall and then exits.

offbattery

apcupsd generates this event when the utility power returns if, and only if, the onbattery event has been generated. Default -- sends ""Power has returned..." to wall and then exits.

powerout

apcupsd generates this event as soon as apcupsd detects that the UPS has switched to battery power and it is not a self-test. Default action -- does nothing.

remotedown

apcupsd generates this event on a slave machine when it detects either (1) that the master has shutdown, or (2) that an onbattery event has occurred and communication with the master has been lost. Default action: sends "Remote Shutdown. Beginning Shutdown Sequence." to wall and exits. Immediately after this, apcupsd generates a doshutdown event to shutdown the system.

runlimit

apcupsd generates this event when the remaining runtime limit specified by the MINUTES configuration directive expires while the UPS is on battery power as the result of a utility power outage. The remaining runtime is internally calculated by the UPS and monitored by apcuspd. Default action -- sends "UPS battery runtime percent reached. Doing shutdown." to wall and then exits. After this event, apcupsd will immediately generate a doshutdown event.

timeout

apcupsd generates this event when the time specified by the TIMEOUT configuration directive expires while the UPS is on battery power as the result of a utility power outage. This configuration directive is not normally used with smart UPSes which would instead rely on the more reliable remaining runtime (MINUTES) or the battery level (BATTERYLEVEL) configuration directives. Default action -- send "UPS battery runtime limit exceeded. Doing shutdown." to wall and then exits. After this event, apcupsd will immediately generate a doshutdown event.

startselftest

apcupsd generates this event when it detects the start of a UPS self test. Default action: does nothing.

endselftest

apcupsd generates this event when it detects the end of a UPS self test. Default action: does nothing.

### CUSTOMISING EVENT ACTIONS
Do not modify apccontrol directly as it will be overwritten the next time you upgrade to a new release of apcupsd.

The recommended way to customise an event action is simply to create an executable program or script file with the same name as the event and put that file in the /etc/apcupsd directory. Now, when the selected event occurs, apccontrol will execute your program or script.

If you want apccontrol to also execute its default action for the selected event, your program or script should exit with an exit status of 0 (zero).

If you do not want apccontrol to also execute its default action for the selected event, your program or script must exit with an exit status of 99. Be aware that if you completely override the default action, you must ensure the proper shutdown of your computer if this is necessary.

Some sample scripts (changeme, commfailure, commok, offbattery and onbattery) that email messages to root instead of broadcasting messages to all logged-in users may be found in /etc/apcupsd after an installation and also in the platforms/etc directory of the apcupsd source code.

## FILES
/etc/apcupsd/apccontrol

## SEE ALSO
wall(1), apcupsd.conf(5), apcupsd(8), shutdown(8).

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

## AUTHORS

### This page
Trevor Roydhouse

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


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

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/


apmd

package: apmd

title: apmd(8)

summary: Advanced Power Management (APM) daemon

text:
# apmd(8)

## NAME
apmd - Advanced Power Management (APM) daemon

## SYNOPSIS
apmd [ -TVWciqv ] [ -P program ] [ -T seconds ] [ -c seconds ] [ -p percent ] [ -v level ] [ -w percent ]

## DESCRIPTION
apmd is an monitoring daemon for the Advanced Power Management (APM) subsystem. The APM subsystem consists of power-management hardware, firmware usually referred to as the APM BIOS and a driver in the operating system kernel. The daemon can execute a program (usually a shell script) when events are reported by the APM subsystem, and will log, via syslogd(8), certain changes in power status. When the available battery power becomes very low it can alert the user.

When the APM subsystem notifies the daemon of a pending suspend or standby request, apmd will run a proxy program, log the event, sync(2) data to the disk and then tell the APM subsystem to continue its operation.

Preparations for power management events are made mainly by the proxy program specified using the -P option. The proxy program is invoked with one or two arguments:

start

Invoked when the daemon starts.

stop

Invoked when the daemon stops.

standby ( system | user )

Invoked when the APM subsystem reports that standby has been initiated. The second parameter indicates whether firmware ("system") or software ("user") was the originator of the event. The "standby" mode conserves power but leaves the machine able to respond almost immediately to user activity. Most laptops can't stay in standby mode on battery power for more than a few hours or a day. Normally, nothing special needs to be done to prepare for "standing by".

suspend ( system | user )

Invoked when the APM subsystem reports that suspension has been initiated. The second parameter indicates whether firmware ("system") or software ("user") was the originator of the event. The "suspend" mode aggressively conserves power. Usually this involves shutting off power to all devices except the CPU core and memory, which are put into a very low power mode. Most laptops can stay suspended, using battery power alone, for several days. ("Hibernation" is a kind of super-suspend, where all that state is written to disk and the machine uses no power. Hibernation is treated like suspension by the APM subsystem.)

Before suspending, PCMCIA devices may need to be disabled using cardctl(8), and some modular device drivers may need to be unloaded if they have not been designed to support power management.

resume ( suspend | standby | critical )

Invoked when the APM subsystem reports that computer has resumed normal operation. The second parameter indicates the kind of event from which the system is resuming. (A "critical" suspend is a suspension that the APM subsystem performs in an emergency. Some kernels do not pass this event to user space. If apmd receives the event, it acknowledges the event and exits immediately without logging or running the proxy program.) When resuming, PCMCIA devices may need to be re-enabled using cardctl(8), and some modular drivers may need to be reloaded. Note that in the case of a critical suspend, the system state may not have been completely saved.

change power

Invoked when the APM subsystem reports a change in power status, such as a switch from mains to battery power.

change battery

Invoked when the APM subsystem reports that the charge of one or more batteries is low. A few minutes of battery power may remain.

change capability

Invoked when the APM subsystem reports some change in power management capabilities. It may have been caused by operation of a setup utility, or by the installation or removal of devices.

apmd emits various messages, most of which are self-explanatory. Battery status log entries contain three fields, separated by commas. The first field indicates how full the battery is as a percentage of its capacity. The second field indicates whether the battery is charging, not charging, or discharging. When possible, apmd adds in parentheses its estimate of the rate of charging or discharging. The third field indicates how much time the battery can or could be used to power the computer. This information is provided by the APM subsystem. When possible, apmd adds in parentheses its own estimate of the battery life (if discharging) or of the time required to charge the battery fully (if charging).

## OPTIONS
-P program, --proxy program

Specifies the proxy program to execute when events are received. See above for information about the arguments supplied to this program.

-T [seconds] , --proxy-timeout [seconds]

Sets a time-out for the proxy. Without this option (or with this option and a negative argument) apmd waits indefinitely for the proxy to finish. If the proxy enters an infinite loop or wait then the machine may appear to have crashed. If this option is given a positive integer argument then apmd will wait only that many seconds for the proxy to finish, after which it will log a warning, kill the proxy, and continue processing the event. The default is 30 seconds.

-V, --version

Prints the version of the apmd program.

-W, --wall

In addition to logging low battery status (as determined either by the -w level or by the firmware) using syslog(2), apmd will, given this option, also use wall(1) to alert all users. This is most useful if syslogd(8) is not set up to write ALERT messages to all users. If both methods are used, more warnings will be made during the critical time period.

-c [seconds] , --check [seconds]

Controls how many seconds to wait for an event. Without this option (or with this option and a negative argument) apmd waits indefinitely for an event. If this option is given a positive integer argument then apmd will wait only that many seconds before checking the battery level and possibly sending out a warning, calling the proxy or making an entry in the log. The default is 30 seconds.

-i, --ignore-bios-battery-low

Causes apmd to ignore a LOW BATTERY signal sent by the APM subsystem. Some firmware signals a low battery at the wrong time. Note that LOW BATTERY events may still be generated by apmd itself based on the warning level.

-p percent, --percentage percent

Controls how often the battery status is logged. A new line is printed each time the battery content changes by percent_change if logging is enabled. The default is 5. Use a value greater than 100 to disable periodic logging of the battery level.

-q, --quiet-bios-battery-low

Causes apmd not to generate a warning when a LOW BATTERY signal is received from the APM subsystem. The firmware on some machines produces an audible warning when power is about to be used up, so an extra warning may not be needed.

-v [level] , --verbose [level]

The daemon can generate messages of varying degrees of unimportance. Each message is assigned one of the priority levels defined for the syslogd(8) subsystem, ranging from 0 (EMERG, least unimportant) to 7 (DEBUG, most unimportant). This option sets the threshold level above which messages are suppressed. Without an argument it increments the threshold by 1, thus making apmd more verbose. The default is 5 (NOTICE).

-w percent, --warn percent

When the battery is not being charged and the battery content falls below the specified percent of capacity, and no such event has yet occurred in the current discharge cycle, apmd will log a warning at the ALERT log level to syslog(2) and generate a LOW BATTERY event. If the -W or --wall option was given, the daemon will also use wall(1) to alert all users of impending doom. The default warning level is 10. Use a negative value to disable this feature.

-h, --help

Causes apmd to print a brief command summary and exit.

## BUGS
This daemon supports all APM events described in the APM BIOS specification version 1.2; however it fails to support some of the advanced features of APM 1.2, such as reporting the conditions of multiple batteries. (Multiple batteries are currently treated as if they were just one large one.)

Estimates of charge and discharge rates and times can be very inaccurate.

There is no interaction yet with ACPI support as found in newer PC hardware.

## FILES
/dev/apm_bios

Device through which apmd communicates with the Linux APM driver.

/proc/apm

APM driver status information

/etc/apm/apmd_proxy

Proxy program that is run if none is specified.

## AUTHOR
This program was written by Rik Faith (faith@cs.unc.edu) and may be freely distributed under the terms of the GNU General Public License. There is ABSOLUTELY NO WARRANTY for this program. The current maintainer is Avery Pennarun (apenwarr@worldvisions.ca).

## SEE ALSO
apm(1), xapm(1), cardctl(8), syslogd(8).


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.

--list-columns

Print package lists in the style of the "ls" command. By default, package lists are displayed without arranging them in columns. 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.