airodump-ng

title: airodump-ng(8)

text:
# airodump-ng(8)

## NAME
airodump-ng - a wireless packet capture tool for aircrack-ng

## SYNOPSIS
airodump-ng [options] <interface name>

## DESCRIPTION
airodump-ng is used for packet capturing of raw 802.11 frames for the intent of using them with aircrack-ng. If you have a GPS receiver connected to the computer, airodump-ng is capable of logging the coordinates of the found access points. Additionally, airodump-ng writes out a text file containing the details of all access points and clients seen.

## OPTIONS
-H, --help

Shows the help screen.

-i, --ivs

It only saves IVs (only useful for cracking). If this option is specified, you have to give a dump prefix (--write option)

-g, --gpsd

Indicate that airodump-ng should try to use GPSd to get coordinates.

-w <prefix>, --write <prefix>

Is the dump file prefix to use. If this option is not given, it will only show data on the screen. Beside this file a CSV file with the same filename as the capture will be created.

-e, --beacons

It will record all beacons into the cap file. By default it only records one beacon for each network.

-u <secs>, --update <secs>

Delay <secs> seconds delay between display updates (default: 1 second). Useful for slow CPU.

--showack

Prints ACK/CTS/RTS statistics. Helps in debugging and general injection optimization. It is indication if you inject, inject too fast, reach the AP, the frames are valid encrypted frames. Allows one to detect "hidden" stations, which are too far away to capture high bitrate frames, as ACK frames are sent at 1Mbps.

-h

Hides known stations for --showack.

--berlin <secs>

Time before removing the AP/client from the screen when no more packets are received (Default: 120 seconds). See airodump-ng source for the history behind this option ;).

-c <channel>[,<channel>[,...]], --channel <channel>[,<channel>[,...]]

Indicate the channel(s) to listen to. By default airodump-ng hops on all 2.4GHz channels.

-C <freq>[,<freq>[,...]]

Indicates the frequencies to listen to. By default airodump-ng hops on all 2.4GHz channels.

-b <abg>, --band <abg>

Indicate the band on which airodump-ng should hop. It can be a combination of 'a', 'b' and 'g' letters ('b' and 'g' uses 2.4GHz and 'a' uses 5GHz). Incompatible with --channel option.

-s <method>, --cswitch <method>

Defines the way airodump-ng sets the channels when using more than one card. Valid values: 0 (FIFO, default value), 1 (Round Robin) or 2 (Hop on last).

-2, --ht20

Set the channel to be in HT20 (802.11n).

-3, --ht40+

Set the channel to be in HT40+ (802.11n). It requires the frequency 20MHz above to be available (4 channels above) and thus some channels are not usable in HT40+. Only channels up to 7 are available in HT40+ in the US (and 9 in most of Europe).

-5, --ht40-

Set the channel to be in HT40- (802.11n). It requires the frequency 20MHz below to be available (4 channels be)low and thus some channels are not usable in HT40-. In 2.4GHz, HT40- channels start at channel 5.

-r <file>

Reads packet from a file.

-T, --real-time

While reading packets from a file specified with '-r <file>', simulate the arrival rate of them, as if they were "live".

-x <msecs>

Active Scanning Simulation (send probe requests and parse the probe responses).

-M, --manufacturer

Display a manufacturer column with the information obtained from the IEEE OUI list. See airodump-ng-oui-update(8)

-U, --uptime

Display APs uptime obtained from its beacon timestamp.

-W, --wps

Display a WPS column with WPS version, config method(s), AP Setup Locked obtained from APs beacon or probe response (if any).

--output-format <formats>

Define the formats to use (separated by a comma). Possible values are: pcap, ivs, csv, gps, kismet, netxml. The default values are: pcap, csv, kismet, kismet-newcore. 'pcap' is for recording a capture in pcap format, 'ivs' is for ivs format (it is a shortcut for --ivs). 'csv' will create an airodump-ng CSV file, 'kismet' will create a kismet csv file and 'kismet-newcore' will create the kismet netxml file. 'gps' is a shortcut for --gps.

Theses values can be combined with the exception of ivs and pcap.

-I <seconds>, --write-interval <seconds>

Output file(s) write interval for CSV, Kismet CSV and Kismet NetXML in seconds (minimum: 1 second). By default: 5 seconds. Note that an interval too small might slow down airodump-ng.

-K <enable>, --background <enable>

Override automatic background detection. Use "0" to force foreground settings and "1" to force background settings. It will not make airodump-ng run as a daemon, it will skip background autodetection and force enable/disable of interactive mode and display updates.

--ignore-negative-one

Removes the message that says 'fixed channel <interface>: -1'.

Filter options:

-t <OPN|WEP|WPA|WPA1|WPA2>, --encrypt <OPN|WEP|WPA|WPA1|WPA2>

It will only show networks matching the given encryption. May be specified more than once: '-t OPN -t WPA2'

-d <bssid>, --bssid <bssid>

It will only show networks, matching the given bssid.

-m <mask>, --netmask <mask>

It will only show networks, matching the given bssid ^ netmask combination. Need --bssid (or -d) to be specified.

-a

It will only show associated clients.

-n <int>, --min-packets <int>

The minimum number of packets received by an AP before displaying it.

-N, --essid

Filter APs by ESSID. Can be used several times to match a set of ESSID.

-R, --essid-regex

Filter APs by ESSID using a regular expression.

## INTERACTION
airodump-ng can receive and interpret key strokes while running. The following list describes the currently assigned keys and supposed actions:

a

Select active areas by cycling through these display options: AP+STA; AP+STA+ACK; AP only; STA only

d

Reset sorting to defaults (Power)

i

Invert sorting algorithm

m

Mark the selected AP or cycle through different colors if the selected AP is already marked

o

Enable colored display of APs and their stations.

p

Disable colored display.

q

Quit program.

r

(De-)Activate realtime sorting - applies sorting algorithm every time the display will be redrawn

s

Change column to sort by, which currently includes: First seen; BSSID; PWR level; Beacons; Data packets; Packet rate; Channel; Max. data rate; Encryption; Strongest Ciphersuite; Strongest Authentication; ESSID

SPACE

Pause display redrawing/ Resume redrawing

TAB

Enable/Disable scrolling through AP list

UP

Select the AP prior to the currently marked AP in the displayed list if available

DOWN

Select the AP after the currently marked AP if available

If an AP is selected or marked, all the connected stations will also be selected or marked with the same color as the corresponding Access Point.

## EXAMPLES
airodump-ng -c 9 wlan0mon

Here is an example screenshot:

-----------------------------------------------------------------------

CH 9 ][ Elapsed: 1 min ][ 2007-04-26 17:41 ][ BAT: 2 hours 10 mins ][ WPA handshake: 00:14:6C:7E:40:80

BSSID PWR RXQ Beacons #Data, #/s CH MB ENC CIPHER AUTH ESSID

00:09:5B:1C:AA:1D 11 16 10 0 0 11 54. OPN <length: 7>

00:14:6C:7A:41:81 34 100 57 14 1 9 11 WEP WEP bigbear

00:14:6C:7E:40:80 32 100 752 73 2 9 54 WPA TKIP PSK teddy

BSSID STATION PWR Rate Lost Frames Notes Probes

00:14:6C:7A:41:81 00:0F:B5:32:31:31 51 11-11 2 14 bigbear

(not associated) 00:14:A4:3F:8D:13 19 11-11 0 4 mossy

00:14:6C:7A:41:81 00:0C:41:52:D1:D1 -1 11-2 0 5 bigbear

00:14:6C:7E:40:80 00:0F:B5:FD:FB:C2 35 36-24 0 99 teddy

-----------------------------------------------------------------------

BSSID

MAC address of the access point. In the Client section, a BSSID of "(not associated)" means that the client is not associated with any AP. In this unassociated state, it is searching for an AP to connect with.

PWR

Signal level reported by the card. Its signification depends on the driver, but as the signal gets higher you get closer to the AP or the station. If the BSSID PWR is -1, then the driver doesn't support signal level reporting. If the PWR is -1 for a limited number of stations then this is for a packet which came from the AP to the client but the client transmissions are out of range for your card. Meaning you are hearing only 1/2 of the communication. If all clients have PWR as -1 then the driver doesn't support signal level reporting.

RXQ

Only shown when on a fixed channel. Receive Quality as measured by the percentage of packets (management and data frames) successfully received over the last 10 seconds. It's measured over all management and data frames. That's the clue, this allows you to read more things out of this value. Lets say you got 100 percent RXQ and all 10 (or whatever the rate) beacons per second coming in. Now all of a sudden the RXQ drops below 90, but you still capture all sent beacons. Thus you know that the AP is sending frames to a client but you can't hear the client nor the AP sending to the client (need to get closer). Another thing would be, that you got a 11MB card to monitor and capture frames (say a prism2.5) and you have a very good position to the AP. The AP is set to 54MBit and then again the RXQ drops, so you know that there is at least one 54MBit client connected to the AP.

Beacons

Number of beacons sent by the AP. Each access point sends about ten beacons per second at the lowest rate (1M), so they can usually be picked up from very far.

\#Data

Number of captured data packets (if WEP, unique IV count), including data broadcast packets.

\#/s

Number of data packets per second measure over the last 10 seconds.

CH

Channel number (taken from beacon packets). Note: sometimes packets from other channels are captured even if airodump-ng is not hopping, because of radio interference.

MB

Maximum speed supported by the AP. If MB = 11, it's 802.11b, if MB = 22 it's 802.11b+ and higher rates are 802.11g. The dot (after 54 above) indicates short preamble is supported. 'e' indicates that the network has QoS (802.11e) enabled.

ENC

Encryption algorithm in use. OPN = no encryption,"WEP?" = WEP or higher (not enough data to choose between WEP and WPA/WPA2), WEP (without the question mark) indicates static or dynamic WEP, and WPA or WPA2 if TKIP or CCMP or MGT is present.

CIPHER

The cipher detected. One of CCMP, WRAP, TKIP, WEP, WEP40, or WEP104. Not mandatory, but TKIP is typically used with WPA and CCMP is typically used with WPA2. WEP40 is displayed when the key index is greater than 0. The standard states that the index can be 0-3 for 40bit and should be 0 for 104 bit.

AUTH

The authentication protocol used. One of MGT (WPA/WPA2 using a separate authentication server), SKA (shared key for WEP), PSK (pre-shared key for WPA/WPA2), or OPN (open for WEP).

WPS

This is only displayed when --wps (or -W) is specified. If the AP supports WPS, the first field of the column indicates version supported. The second field indicates WPS config methods (can be more than one method, separated by comma): USB = USB method, ETHER = Ethernet, LAB = Label, DISP = Display, EXTNFC = External NFC, INTNFC = Internal NFC, NFCINTF = NFC Interface, PBC = Push Button, KPAD = Keypad. Locked is displayed when AP setup is locked.

ESSID

The so-called "SSID", which can be empty if SSID hiding is activated. In this case, airodump-ng will try to recover the SSID from probe responses and association requests.

STATION

MAC address of each associated station or stations searching for an AP to connect with. Clients not currently associated with an AP have a BSSID of "(not associated)".

Rate

This is only displayed when using a single channel. The first number is the last data rate from the AP (BSSID) to the Client (STATION). The second number is the last data rate from Client (STATION) to the AP (BSSID).

Lost

It means lost packets coming from the client. To determine the number of packets lost, there is a sequence field on every non-control frame, so you can subtract the second last sequence number from the last sequence number and you know how many packets you have lost.

Notes

Additional information about the client, such as captured EAPOL or PMKID.

Packets

The number of data packets sent by the client.

Probes

The ESSIDs probed by the client. These are the networks the client is trying to connect to if it is not currently connected.

The first part is the detected access points. The second part is a list of detected wireless clients, stations. By relying on the signal power, one can even physically pinpoint the location of a given station.

## AUTHOR
This manual page was written by Adam Cecile <gandalf@le-vert.net> for the Debian system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

airtun-ng(8)

besside-ng(8)

easside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


airodump-ng-oui-update

package: aircrack-ng

title: airodump-ng-oui-update(8)

text:
# airodump-ng-oui-update(8)

## NAME
airodump-ng-oui-updater - IEEE oui list updater for airodump-ng

## SYNOPSIS
airodump-ng-oui-updater

## DESCRIPTION
airodump-ng-oui-updater downloads and parses IEEE OUI list.

## AUTHOR
This manual page was written by David Francos Cuartero. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airserv-ng(8)

airtun-ng(8)

besside-ng(8)

easside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


airserv-ng

title: airserv-ng(8)

text:
# airserv-ng(8)

## NAME
airserv-ng - a wireless card server

## SYNOPSIS
airserv-ng <options>

## DESCRIPTION
airserv-ng is a wireless card server which allows multiple wireless application programs to independently use a wireless card via a client-server TCP network connection. All operating system and wireless card driver specific code is incorporated into the server. This eliminates the need for each wireless application to contain the complex wireless card and driver logic. It is also supports multiple operating systems.

## OPTIONS
-h

Shows the help screen.

-p <port>

TCP port to listen on (by default: 666).

-d <iface>

Wifi interface to use.

-c <chan>

Lock interface to this channel.

-v <level>

Debug level. There are 3 debug levels. Debug level of 1 shows client connection/disconnection (default). Debug level of 2 shows channel change requests and invalid client command requests in addition to the debug level 1 messages. Debug level of 3 displays a message each time a packet (and its length) is sent to the client. It also include messages from level 2 (and 1).

## AUTHOR
This manual page was written by Thomas d'Otreppe. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airtun-ng(8)

besside-ng(8)

easside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


airtun-ng

title: airtun-ng(8)

text:
# airtun-ng(8)

## NAME
airtun-ng - a virtual tunnel interface creator for aircrack-ng

## SYNOPSIS
airtun-ng [options] <interface name>

## DESCRIPTION
airtun-ng creates a virtual tunnel interface (atX) for sending arbitrary IP packets by using raw ieee802.11 packet injection.

## OPTIONS
-H, --help

Shows the help screen.

-x <pps>

Sets maximum number of packets per second.

-a <BSSID>

Specifies the BSSID for the iee802.11 header. In WDS Mode this sets the Receiver.

-h <SMAC>

Specifies the source MAC for the iee802.11 header.

-i <iface>

Sets the capture interface.

-r <file>

Specifies a file to read 802.11 frames.

-y <PRGA-file>

Is the name of the file, which provides the keystream for WEP encoding. (No receiving, just transmitting of IP packets.)

-w <WEP-key>

This is the WEP key to en-/decrypt all traffic going through the tunnel.

-e <ESSID>

Sets the target network SSID (use with -p).

-p <passphrase>

Use this WPA passphrase to decrypt packets (use with -a and -e).

-t <tods>

Defines the ToDS and FromDS bit in the ieee802.11 header. For tods=1, the ToDS bit is set to 1 and FromDS to 0, while tods=0 sets them the other way around. If set to 2, it will be tunneled in a WDS/bridge.

-m <netmask>, --netmask <netmask>

Filters networks based on bssid ^ netmask combination. Needs -d, used in replay mode.

-d <BSSID>, --bssid <BSSID>

Filters networks based on the <BSSID>. Used in replay mode.

-f, --repeat

Enables replay mode. All read frames, filtered by bssid and netmask (if specified), will be replayed.

-s <transmitter>

Set Transmitter MAC address for WDS Mode.

-b

Bidirectional mode. This enables communication in Transmitter's AND Receiver's networks. Works only if you can see both stations.

## EXAMPLES
airtun-ng -a 00:14:22:56:F3:4E -t 0 -y keystream.xor wlan0

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

besside-ng(8)

easside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


airventriloquist-ng

title: airventriloquist-ng(8)

text:
# airventriloquist-ng(8)

## NAME
airventriloquist-ng - encrypted WiFi packet injection

## SYNOPSIS
airventriloquist-ng [options]

## DESCRIPTION
airventriloquist-ng injects on encrypted WiFi packet and circumvents wireless intrusion prevention systems.

## OPTIONS
--help

Shows the help screen.

-i <replay interface>

Interface to capture and inject. Mandatory option.

-d, --deauth

Sends active deauthentications frames to encrypted stations.

-e <value>, --essid <value>

ESSID of target network. For SSID containing special characters, see https://www.aircrack-ng.org/doku.php?id=faq#how_to_use_spaces_double_quote_and_single_quote_etc_in_ap_names

-p <value>, --passphrase <value>

WPA Passphrase of the target network. Passphrase is between 8 and 63 characters long.

-c, --icmp

Respond to all ICMP frames (Debug).

-n, --dns

IP to resolve all DNS queries to.

-s <URL>, --hijack <URL>

URL to look for in HTTP requests when hijacking connections. The URL can have wildcards characters. Example: *jquery*.js*

-r <URL>, --redirect <URL>

URL to redirect hijacked connections to.

-v, --verbose

Verbose output.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

besside-ng(8)

easside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airtun-ng(8)


besside-ng

title: besside-ng(8)

text:
# besside-ng(8)

## NAME
besside-ng - crack a WEP or WPA key without user intervention and collaborate with WPA cracking statistics

## SYNOPSIS
besside-ng [options] <interface>

## DESCRIPTION
besside-ng is a tool which will crack all the WEP networks in range and log all the WPA handshakes. WPA handshakes can be uploaded to the online cracking service at wpa.darkircop.org. Wpa.darkircop.com also provides useful statistics based on user-submitted capture files about the feasibility of WPA cracking.

-b <target mac>

Specifies the target's BSSID

-s <WPA server>

Where to upload capture file for cracking. A good choice is wpa.darkircop.org

-c <chan>

Channel lock

-p <pps>

Packages per second to send (flood rate).

-W

Crack only WPA networks

-v

Verbose mode. Use -vv for more verbose, -vv for even more and so on.

-h

Help screen

## AUTHOR
This manual page was written by David Francos Cuartero. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

airtun-ng(8)

easside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


easside-ng

title: easside-ng(8)

text:
# easside-ng(8)

## NAME
easside-ng - an auto-magic tool which allows you to communicate via an WEP-encrypted AP without knowing the key

## SYNOPSIS
easside-ng <options>

## DESCRIPTION
easside-ng is an auto-magic tool which allows you to communicate via an WEP-encrypted access point (AP) without knowing the WEP key. It first identifies a network, then proceeds to associate with it, obtain PRGA (pseudo random generation algorithm) xor data, determine the network IP scheme and then setup a TAP interface so that you can communicate with the AP without requiring the WEP key. All this is done without your intervention.

## OPTIONS
-h

Shows the help screen.

-v <victim mac>

Victim BSSID (Optional).

-m <src mac>

Source MAC address to be used (Optional).

-i <ip>

Source IP address to be used on the wireless LAN. Defaults to the decoded network plus '.123' (Optional).

-r <router ip>

IP address of the AP router. This could be the WAN IP of the AP or an actual router IP depending on the topology. Defaults to the decoded network plus '.1' (Optional).

-s <buddy ip>

IP address of Buddy-ng server (Mandatory)

-f <iface>

Wireless interface to use (Mandatory)

-c <channel>

Lock interface to this channel (Optional).

-n

Determine Internet IP only.

## AUTHOR
This manual page was written by Thomas d'Otreppe. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

airtun-ng(8)

besside-ng(8)

tkiptun-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


tkiptun-ng

title: tkiptun-ng(8)

text:
# tkiptun-ng(8)

## NAME
tkiptun-ng - inject a few frames into a WPA TKIP network with QoS

## SYNOPSIS
tkiptun-ng [options] <replay interface>

## DESCRIPTION
tkiptun-ng is a tool created by Martin Beck aka hirte, a member of aircrack-ng team. This tool is able to inject a few frames into a WPA TKIP network with QoS. He worked with Erik Tews (who created PTW attack) for a conference in PacSec 2008: "Gone in 900 Seconds, Some Crypto Issues with WPA".

## OPERATION
-H, --help

Shows the help screen.

Filter options:

-d <dmac>

MAC address of destination.

-s <smac>

MAC address of source.

-m <len>

Minimum packet length.

-n <len>

Maximum packet length.

-t <tods>

Frame control, "To" DS bit.

-f <fromds>

Frame control, "From" DS bit.

-D

Disable AP Detection.

Replay options:

-x <nbpps>

Number of packets per second.

-p <fctrl>

Set frame control word (hex).

-a <bssid>

Set Access Point MAC address.

-c <dmac>

Set destination MAC address.

-h <smac>

Set source MAC address.

-e <essid>

Set target SSID.

-M <sec>

MIC error timeout in seconds. Default: 60 seconds

Debug options:

-K <prga>

Keystream for continuation.

-y <file>

Keystream file for continuation.

-j

Inject FromFS packets.

-P <PMK>

Pairwise Master key (PMK) for verification or vulnerability testing.

-p <PSK>

Preshared key (PSK) to calculate PMK with essid.

Source options:

-i <iface>

Capture packets from this interface.

-r <file>

Extract packets from this pcap file.

## AUTHOR
This manual page was written by Thomas d'Otreppe. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

airtun-ng(8)

besside-ng(8)

easside-ng(8)

wesside-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


wesside-ng

title: wesside-ng(8)

text:
# wesside-ng(8)

## NAME
wesside-ng - crack a WEP key of an open network without user intervention

## SYNOPSIS
wesside-ng <options>

## DESCRIPTION
wesside-ng is an auto-magic tool which incorporates a number of techniques to seamlessly obtain a WEP key in minutes. It first identifies a network, then proceeds to associate with it, obtain PRGA (pseudo random generation algorithm) xor data, determine the network IP scheme, reinject ARP requests and finally determine the WEP key. All this is done without your intervention.

## OPTIONS
-h

Shows the help screen.

-i <iface>

Wireless interface name. (Mandatory)

-n <network ip>

Network IP as in 'who has destination IP (netip) tell source IP (myip)'. Defaults to the source IP on the ARP request which is captured and decrypted. (Optional)

-m <my ip>

'who has destination IP (netip) tell source IP (myip)'. Defaults to the network.123 on the ARP request captured (Optional).

-a <source mac>

Source MAC address (Optional)

-c

Do not crack the key. Simply capture the packets until control-C is hit to stop the program! (Optional)

-p <min PRGA>

Determines the minimum number of bytes of PRGA which is gathered. Defaults to 128 bytes. (Optional).

-v <victim MAC>

Wireless access point MAC address (Optional).

-t <threshold>

For each number of IVs specified, restart the airecrack-ng PTW engine (Optional). It will restart PTW every <threshold> IVs.

-f <channel>

Allows the highest channel for scanning to be defined. Defaults to channel 11 (Optional).

## AUTHOR
This manual page was written by Thomas d'Otreppe. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

## SEE ALSO
airbase-ng(8)

aireplay-ng(8)

airmon-ng(8)

airodump-ng(8)

airodump-ng-oui-update(8)

airserv-ng(8)

airtun-ng(8)

besside-ng(8)

easside-ng(8)

tkiptun-ng(8)

aircrack-ng(1)

airdecap-ng(1)

airdecloak-ng(1)

airolib-ng(1)

besside-ng-crawler(1)

buddy-ng(1)

ivstools(1)

kstats(1)

makeivs-ng(1)

packetforge-ng(1)

wpaclean(1)

airventriloquist(8)


alterator-cmdline

package: alterator

title: alterator-cmdline(8)

summary: command line interface to alteratord.

text:
# alterator-cmdline(8)

## NAME
alterator-cmdline - command line interface to alteratord.

## SYNOPSIS
alterator-cmdline [-ld] [-k name] command

## DESCRIPTION
This is an utility to create a single request to system configuration backend from command line. Query result will be sent to stdout. Errors, e.g., exceptions from backends, will be sent to stderr.

Command format is:

backend arg1 value arg2 value2 ...

Backend typically returns one or more answers. Each answer is a set of attributes and values.

Output format is:

<empty line>

arg1:value1

arg2:value2

<empty line>

arg1:value3

arg2:value4

...

Each answer starts with an empty line.

alterator-cmdline prints all attributes and their values by default. You can use -k option to print specified attribute's value only. This is useful in shell scripts.

Output format in this case is:

value1

value3

...

Multiple answers are not separated.

There are two possible modes: basic and local.

In basic mode utility will try to connect to already running alteratord.

Local mode is designed for development. alterator-cmdline will try to stop already running alteratord and start it as its own subprocess; in its turn, alteratord's subprocess will work in local mode too and exit when alterator-cmdline exits. Because command line interface exits after receiving an answer from backend, you can only work with stateless backends in this mode.

## EXAMPLE
alterator-cmdline -k name /users action list

alterator-cmdline /users name "test" action write gecos "test user"

## EXIT CODE
On success zero is returned, otherwise non-zero status indicates request failure (backend exception or some internal error).

## OPTIONS
-l, --local

Work in local mode.

-d, --debug

Turn on additional debug in Scheme interpreter. This is useful for debugging alterator-cmdline itself.

-k, --key <name>

Print values for the specified attribute only.

## AUTHOR
Stanislav Ievlev <inger@altlinux.org>

## SEE ALSO
alteratord(8)


alteratord

title: alteratord(8)

text:
# alteratord(8)

## NAME
alteratord - a daemon to interact with alterator backends.

## SYNOPSIS
alteratord [ -ld ] [ -t <sec> ]

## DESCRIPTION
alteratord process waits for incoming configuration requests and sends them to appropriate backends. Loaded backends are resident in memory for possible reuse. After 5 hours of inactivity a backend will be unloaded. Please note that unloading will not take place asynchronously but at nearest incoming request only. All backends will automatically receive SIGHUP signal when alteratord exits. You can trap this signal in a backend to perform some cleanup actions.

The process communicates using local domain socket. You should be superuser (root) or member of group _alteratord to have access to this socket.

Attention: Current implementation is NOT reenterable (doesn't support multiple requests at the same time), so you cannot call alteratord (other backends) inside backend code.

alteratord supports different execution schemas.

1. Start every time at system boot. Please note that alteratord service is turned off by default.

2. Start as a subprocess and exit when main process exits. This mode is used in acc, alterator-standalone, and in local mode of all interface frameworks (ahttpd, alterator-cmdline, and alterator-standalone).

3. Start on demand (using special helper) and exit automatically after 1 minute of inactivity. All interfaces will try to execute alteratord in this mode if it's is unavailable.

Please note that some backends can lock system resources, e.g. RPM package database.

## OPTIONS
-l,--local

Local mode. This is a special mode for developers. alteratord will try to use backends and guile modules from local project directory. In this mode ALTERATOR_DEBUG environment variable is exported with value 1. Some libraries use this variable, e.g. alterator-sh-functions for write_debug().

-d,--debug

Turn on additional debug in Scheme interpreter. This is useful for debugging alteratord itself.

-t,--timeout <sec>

Exit automatically after specified number of seconds of inactivity.

## ENVIRONMENT VARIABLES
alteratord and backends can use some environment variables. Multiple values are separated by a colon.

ALTERATOR_DATADIR

Directories with platfrom independent data. Some backends, e.g. help and menu can also use this variable. Default value is /usr/share/alterator.

ALTERATOR_LIBDIR

Directories with scripts and binary programs (not libraries). There are various backends and hooks for communications between backends. Default value is /usr/lib/alterator.

## FILES
/usr/lib/alterator/interfaces/guile

Scheme libraries.

/usr/lib/alterator/backend3

Directory for backends.

/usr/lib/alteratord/control

Helper utility to run alteratord on demand. This program is SUID root and is available to members of _alteratord group only.

/run/alteratord/.socket

Local domain socket to communicate with alteratord.

/var/log/alteratord.log

Backends' stderr gets stored here. This file is recreated at every restart. If alteratord is staying in foreground this file is not used.

## AUTHOR
Stanislav Ievlev <inger@altlinux.org>

## SEE ALSO
ahttpd(8), alterator-cmdline(8)


ahttpd

package: alterator-fbi

title: ahttpd(8)

text:
# ahttpd(8)

## NAME
ahttpd - special HTTP server for alterator's web interface.

## SYNOPSIS
ahttpd [ -ld ] [ -c <config file> ]

## DESCRIPTION
ahttpd is a minimalistic HTTP server written in Scheme scripting language to serve alterator's web interface. It was created specifically for alterator and can't be used as a generic web server. This server processes incoming connections only via HTTPS and will automatically answer HTTP requests with redirects to use HTTPS protocol.

Server runs with unpriveledged user and group permissions. Server's user account should be member of _alteratord group to have access to alteratord socket.

## OPTIONS
-l --local

Run in local mode. This mode is designed specifically for alterator module development. Server will stay in foreground and also run alteratord subprocess in local mode too. It means that both alterator and alteratord servers will try to use files (backends, interface descriptions, and scheme modules) from your local project directory.

-d --debug

Enable additional debug in Scheme interpreter. It's useful for debugging ahttpd itself.

-c --config

Use alternate configuration file

## FILES
/etc/ahttpd/ahttpd.conf - main configuration

/etc/ahttpd/acl.conf - ACL configuration

/etc/ahttpd/openssl.cnf - SSL configuration (for OpenSSL, the syntax is the same as for /etc/openssl/openssl.cnf)

/var/log/ahttpd/access.log - server access log

/usr/share/alterator/ui/ - module interfaces

/usr/share/alterator/applications/ - descriptions of modules

/usr/share/alterator/desktop-directories/ - descriptions of module groups

## AUTHOR
Stanislav Ievlev <inger@altlinux.org>

## SEE ALSO
ahttpd.conf(5), ahttpd.acl.conf(5), alteratord(8)


acc

package: alterator-standalone

title: acc(8)

text:
# acc(8)

## NAME
acc - graphical user interface to alteratord, system management center.

## SYNOPSIS
acc [-ld]

## DESCRIPTION
acc opens a window with system management center GUI.

The utility will always try to stop currently running alteratord, if any, and (re-)run it as its own subprocess.

In local mode acc will try to use interface definitions from local project directory and start alteratord in local mode too.

## OPTIONS
-l, --local

Work in local mode.

-d, --debug

Turn on additional debug in Scheme interpreter. This is useful for debugging acc itself.

## FILES
/usr/share/alterator/ui/ - module interfaces

/usr/share/alterator/applications/ - descriptions of modules

/usr/share/alterator/desktop-directories/ - descriptions of module groups

## AUTHOR
Stanislav Ievlev <inger@altlinux.org>

## SEE ALSO
alteratord(8)


alterator-standalone

title: alterator-standalone(8)

text:
# alterator-standalone(8)

## NAME
alterator-standalone - graphical user interface to alteratord, single-module version

## SYNOPSIS
alterator-standalone [-ld] [module]

## DESCRIPTION
alterator-standalone opens a window containing the interface of a single module.

Single parameter is a name of the module description file without extension, e.g., if module description is in file /usr/share/alterator/applications/foo.desktop you should start alterator-standalone with parameter foo.

If module name is omitted all available module names will be displayed.

Utility will always try to stop running alteratord and run it as its own subprocess.

In local mode it will try to use interface definitions and module description file from local project directory and will start alteratord in local mode too.

## OPTIONS
-l, --local

Work in local mode.

-d, --debug

Turn on additional debug in Scheme interpreter. This is useful for debugging alterator-standalone itself.

## EXAMPLE
/usr/sbin/alterator-standalone datetime

## FILES
/usr/share/alterator/ui/ - interface definitions.

/usr/share/alterator/applications/ - descriptions of modules.

/usr/share/alterator/desktop-directories/ - descriptions of module groups.

## AUTHOR
Stanislav Ievlev <inger@altlinux.org>

## SEE ALSO
alteratord(8)


amorad

package: amora

title: amorad(8)

text:
# amorad(8)

## NAME
amorad - Amora (A Remote Mobile Assistant) daemon

## SYNOPSIS
amorad [options]

## DESCRIPTION
Amora is an application that enables you to control your PC desktop using a cellphone. It uses bluetooth to send mouse and keyboard events to the graphical session. With it you can control your slides in OpenOffice.org, movies or any other application. Amora also has a screenshot feature, where you can see a thumbnail in the cellphone screen of the currently focused window in your desktop.

The server (amorad) is written in C using Xlib and XTest to send events for X session and the POSIX socket API for I/O. It must be started by the user, inside a valid X session.

## OPTIONS
-h

Help (usage) message

-l

Set a specific path for the log file

-v

Show program version and exit

## AMORA CLIENT
In order to use amora, you need a mobile phone with amora-client installed and running. The current client is implemented in Python for S60 (Nokia cellphones).

## BUGS
See the current bugs and open new ones in the project website.

## CREDITS
Author: Adenilson Cavalcanti da Silva

Contributions from: Ademar de Souza Reis Jr., Alexis Younes, Thiago Marcos Santos, Wilson Prata and others;

## SEE ALSO
http://code.google.com/p/amora/


anacron

package: anacron

title: anacron(8)

summary: runs commands periodically

text:
# anacron(8)

## NAME
anacron - runs commands periodically

## SYNOPSIS
anacron [-s] [-f] [-n] [-d] [-q] [-t anacrontab] [job] ...

anacron -u [-t anacrontab] [job] ...

anacron [-V|-h]

## DESCRIPTION
Anacron can be used to execute commands periodically, with a frequency specified in days. Unlike cron(8), it does not assume that the machine is running continuously. Hence, it can be used on machines that aren't running 24 hours a day, to control daily, weekly, and monthly jobs that are usually controlled by cron.

When executed, Anacron reads a list of jobs from a configuration file, normally /etc/anacrontab (see anacrontab(5)). This file contains the list of jobs that Anacron controls. Each job entry specifies a period in days, a delay in minutes, a unique job identifier, and a shell command.

For each job, Anacron checks whether this job has been executed in the last n days, where n is the period specified for that job. If not, Anacron runs the job's shell command, after waiting for the number of minutes specified as the delay parameter.

After the command exits, Anacron records the date in a special timestamp file for that job, so it can know when to execute it again. Only the date is used for the time calculations. The hour is not used.

When there are no more jobs to be run, Anacron exits.

Anacron only considers jobs whose identifier, as specified in the anacrontab matches any of the job command-line arguments. The job arguments can be shell wildcard patterns (be sure to protect them from your shell with adequate quoting). Specifying no job arguments, is equivalent to specifying "*" (That is, all jobs will be considered).

Unless the -d option is given (see below), Anacron forks to the background when it starts, and the parent process exits immediately.

Unless the -s or -n options are given, Anacron starts jobs immediately when their delay is over. The execution of different jobs is completely independent.

If a job generates any output on its standard output or standard error, the output is mailed to the user running Anacron (usually root).

Informative messages about what Anacron is doing are sent to syslogd(8) under facility cron, priority notice. Error messages are sent at priority error.

"Active" jobs (i.e. jobs that Anacron already decided to run and now wait for their delay to pass, and jobs that are currently being executed by Anacron), are "locked", so that other copies of Anacron won't run them at the same time.

## OPTIONS
-f

Force execution of the jobs, ignoring the timestamps.

-u

Only update the timestamps of the jobs, to the current date, but don't run anything.

-s

Serialize execution of jobs. Anacron will not start a new job before the previous one finished.

-n

Run jobs now. Ignore the delay specifications in the /etc/anacrontab file. This options implies -s.

-d

Don't fork to the background. In this mode, Anacron will output informational messages to standard error, as well as to syslog. The output of jobs is mailed as usual.

-q

Suppress messages to standard error. Only applicable with -d.

-t anacrontab

Use specified anacrontab, rather than the default

-V

Print version information, and exit.

-h

Print short usage message, and exit.

## SIGNALS
After receiving a SIGUSR1 signal, Anacron waits for running jobs, if any, to finish and then exits. This can be used to stop Anacron cleanly.

## NOTES
Make sure that the time-zone is set correctly before Anacron is started. (The time-zone affects the date). This is usually accomplished by setting the TZ environment variable, or by installing a /usr/lib/zoneinfo/localtime file. See tzset(3) for more information.

## FILES
/etc/anacrontab

Contains specifications of jobs. See anacrontab(5) for a complete description.

/var/spool/anacron

This directory is used by Anacron for storing timestamp files.

## SEE ALSO
anacrontab(5), cron(8), tzset(3)

The Anacron README file.

## BUGS
Anacron never removes timestamp files. Remove unused files manually.

Anacron uses up to two file descriptors for each active job. It may run out of descriptors if there are more than about 125 active jobs (on normal kernels).

Mail comments, suggestions and bug reports to Sean 'Shaleh' Perry <shaleh@(debian.org|valinux.com)>.

## AUTHOR
Anacron was originally conceived and implemented by Christian Schwarz <schwarz@monet.m.isar.de>.

The current implementation is a complete rewrite by Itai Tzur <itzur@actcom.co.il>.

The code base is currently maintained by Sean 'Shaleh' Perry <shaleh@(debian.org|valinux.com)>.


and

package: and

title: and(8)

summary: auto nice daemon

text:
# and(8)

## NAME
and - auto nice daemon

## SYNOPSIS
and [-htvsx] [-i interval] [-c /path/to/and.conf] [-d /path/to/and.priorities]

## VERSION
This manual page documents and version 1.2.2.

## DESCRIPTION
The auto nice daemon activates itself in certain intervals and renices and even kills jobs according to their priority and CPU usage.

Renice levels and kill signals can be defined in terms of users, groups, and commands. Wildcards can be specified for any of these. In addition, commands can be specified using POSIX regular expressions. To allow for network-wide configuration and priority files, a mechanism for hostname-based evaluation is provided, again supporting regular expressions for specifying host names.

Jobs owned by root are left alone. Jobs are never increased in their priority.

Here are some real-world examples:

A certain user is notorious for wasting CPU with next-to-irrelevant jobs. One line is sufficient to renice all of his jobs to about 19. This is a typical situation for a LART (Luser's Attitude Readjustment Tool) like and.

A CPU server is dedicated to a certain group, but others may also use it when it's idle. Just define default nice levels of e.g. 18 and a lower nice level for the privilegued group, say nice level 12.

A certain web browser who shall remain unnamed tends to go berserk once in a while. You can configure and to kill -9 it after e.g. 20 CPU minutes.

## COMMAND-LINE OPTIONS
-c /path/to/and.conf

Specifies the configuration file. If this flag is omitted, /etc/and/and.conf is used instead.

-d /path/to/and.priorities

Specifies the priority database file. If this flag is omitted, /etc/and/and.priorities is used instead.

-h

Produces a short help text.

-i interval

Sets the interval between nice level checks. This flag overrides the interval specified in the configuration file, if any. The default interval of 60 seconds is used if neither -i nor an interval directive in the configuration file is given.

-s

Log to stdout. Without this switch, logging goes to syslog (normal operations) or ./debug.and (test mode). Useful for debugging config files.

-t

Run in test mode only, i.e. don't really renice or kill anything. In this mode, logging goes into ./debug.and instead of syslog.

-v

Increase verbosity. For maximum verbosity, this flag can be specified multiple times. Be warned that this will blow up your log files, so you should use it in test mode only.

-x

Run in full operational mode, i.e. really renice or kill things. This is the default.

## SIGNALS
On kill -HUP the auto nice daemon will reload its configuration file and priority database.

## FILES
/etc/and/and.conf

General configuration file. Stores default nice level, default interval, the "time zones" and the database lookup affinity.

/etc/and/and.priorities

The priority database (in plain text). Contains the (user, group, command, nicelevels) tuples.

Both files have their own manual pages.

./debug.and

Contains logging and status information for debugging purposes. Used in test mode only.

## SEE ALSO
and.conf(5), and.priorities(5), kill(1), regex(7), renice(8)

## INTERNET
http://and.sourceforge.net/

## AUTHOR
The auto nice daemon and this manual page were written by Patrick Schemitz <schemitz@users.sourceforge.net>


aoe-discover

package: aoetools

title: aoe-discover(8)

summary: tell aoe driver to discover AoE devices

text:
# aoe-discover(8)

## NAME
aoe-discover - tell aoe driver to discover AoE devices

## SYNOPSIS

```
aoe-discover
```

## DESCRIPTION
The aoe-discover command tells the aoe driver to discover ATA over Ethernet (AoE) devices on the network. All network interfaces will be probed with a AoE config query broadcast.

If the aoe-interfaces command has limited the allowable network interfaces, only devices discovered via allowable interfaces will become available. The default is to make available all AoE devices found on all accessible ethernet networks.

It's good to run the aoe-discover command after running aoe-interfaces.

## EXAMPLE
In this example, the root user on a host named nai loads the aoe module with only eth0 allowable for AoE traffic. After remembering that shelf 7 is on eth3, this sysadmin uses aoe-interfaces to add eth3 to the list of allowable network interfaces and then calls aoe-discover to ask the aoe driver to look for new AoE devices.

```
nai:~# modprobe aoe aoe_iflist="eth0"
nai:~# aoe-stat

   e10.9            eth0              up
nai:~# aoe-interfaces eth0 eth3
nai:~# aoe-discover
nai:~# aoe-stat

    e7.0            eth3              up

    e7.1            eth3              up

    e7.2            eth3              up

    e7.3            eth3              up

    e7.4            eth3              up

    e7.5            eth3              up

    e7.6            eth3              up

    e7.7            eth3              up

    e7.8            eth3              up

    e7.9            eth3              up

   e10.9            eth0              up
```

## SEE ALSO
aoe-interfaces(8), aoe-stat(8), aoetools(8).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


aoe-flush

title: aoe-flush(8)

text:
# aoe-flush(8)

## NAME
aoe-flush - flush the down devices out of the aoe driver

## SYNOPSIS

```
aoe-flush [-a]
aoe-flush dev1 [dev2 ...]
```

## DESCRIPTION
The aoe-flush command tells the aoe driver to remove devices from the system and forget about them. Normally the aoe driver will remember all devices it has seen until the module is unloaded. By default, aoe-flush will only flush downed devices. With the -a flag all devices are candidates for removal.

aoe-flush will not remove devices that are in use. This includes devices in the closewait state or those in the process of being installed.

By specifying a series of specific aoe devices, e.g., e7.0 e3.2, it is possible to ask the aoe driver to forget these devices. This feature may be convenient after a temporary AoE target is no longer being used.

## OPTIONS
-a

The -a option tells the aoe driver to forget all unused devices.

## EXAMPLE

```
nai# aoe-stat | grep e12.0

     e12.0         0.000GB   eth1 down
nai# aoe-flush
nai# aoe-stat | grep e12.0
```

## BUGS
Flushed devices may reappear when they are discovered by the periodic discovery beacon. aoe-discover may be used to force this behaviour.

## SEE ALSO
aoe-stat(8), aoe-discover(8), aoetools(8).

## AUTHOR
Sam Hopkins (sah@coraid.com)


aoe-interfaces

title: aoe-interfaces(8)

text:
# aoe-interfaces(8)

## NAME
aoe-interfaces - restrict aoe driver to specified network interfaces

## SYNOPSIS

```
aoe-interfaces [dev1] [dev2 ...]
aoe-interfaces -c
```

## DESCRIPTION
The aoe-interfaces command tells the aoe driver to ignore ATA over Ethernet (AoE) traffic on all but the specified network interfaces. It is analogous to the aoe_iflist module load option.

If neither the aoe_iflist module load option nor the aoe-interfaces command are used, the aoe driver will use any network interface for AoE traffic. Using aoe-interfaces to limit AoE to only trusted networks prevents the case where a rogue AoE target appears on a public network, diverting data from the legitimate AoE target. Such an imposter target effectively corrupts the data on the legitimate target.

If the aoe driver is a module, then calling aoe-interfaces without arguments will display the current interfaces list. If it hasn't been set then the output will be blank.

It's good to run the aoe-discover command after setting the AoE interfaces list.

## OPTIONS
-c

The -c flag will clear the interface access list, permitting any interface to be used.

## EXAMPLE
In this example, the root user on a host named nai loads the aoe module with only eth0 allowable for AoE traffic. After remembering that shelf 7 is on eth3, this sysadmin uses aoe-interfaces to add eth3 to the list of allowable network interfaces and then calls aoe-discover to ask the aoe driver to look for new AoE devices.

```
nai:~# modprobe aoe aoe_iflist="eth0"
nai:~# aoe-stat

   e10.9            eth0              up
nai:~# aoe-interfaces eth0 eth3
nai:~# aoe-discover
nai:~# aoe-stat

    e7.0            eth3              up

    e7.1            eth3              up

    e7.2            eth3              up

    e7.3            eth3              up

    e7.4            eth3              up

    e7.5            eth3              up

    e7.6            eth3              up

    e7.7            eth3              up

    e7.8            eth3              up

    e7.9            eth3              up

   e10.9            eth0              up
nai:~# aoe-interfaces
eth0 eth3
```

## SEE ALSO
aoe-discover(8), aoe-stat(8), aoetools(8).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


aoe-mkdevs

title: aoe-mkdevs(8)

text:
# aoe-mkdevs(8)

## NAME
aoe-mkdevs - create special device files for aoe driver

## SYNOPSIS

```
aoe-mkdevs {device-dir}
env n_partitions=1 aoe-mkdevs {device-dir}
```

## DESCRIPTION
The aoe-mkdevs command is deprecated in favor of udev. Systems with udev do not need to use the aoe-mkdevs or aoe-mkself commands, because udev will create device nodes as needed.

Systems without udev use aoe-mkdevs to create the character special files necessary to control the aoe driver. The aoe-mkdevs command uses aoe-mkshelf to also create block special files.

The aoe drivers after version 49 support dynamic minor device numbers so that a greater number of devices can be supported. The aoe-mkdevs command is incompatible with dynamic device numbers. If your system lacks udev, and you are using an aoe driver version 50 or above, use the aoe_dyndevs=0 module option to force the aoe driver to use static device numbers.

If you are not using dynamic device numbers, and you built your aoe driver to support only one partition per device (whole-disk partitions), then the device files must match, and you should use the n_partitions environment variable described below.

### Arguments
device-dir

This should be the name of the directory where the special device files will be created.

## ENVIRONMENT VARIABLES
If the n_partitions variable is set in the environment, it will override the default number of partitions per aoe disk, namely 16.

## EXAMPLE
In this example, the root user on a host named nai creates special files for using the aoe disks in shelf 7. After remembering that the driver doesn't have partition support, this sysadmin gets rid of the mismatching device nodes and calls aoe-mkdevs again with n_partitions set to 1.

```
nai:~# rm -rf /dev/etherd
nai:~# aoe-mkdevs /dev/etherd
nai:~# ls /dev/etherd | wc -l
1603
nai:~# rm -rf /dev/etherd
nai:~# n_partitions=1 aoe-mkdevs /dev/etherd
nai:~# ls /dev/etherd | wc -l
103
```

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoe-mkshelf(8), aoe-stat(8), aoetools(8), udev(7).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


aoe-mkshelf

title: aoe-mkshelf(8)

text:
# aoe-mkshelf(8)

## NAME
aoe-mkshelf - create special device files for one shelf address

## SYNOPSIS

```
aoe-mkshelf {device-dir} {shelf-address}
env n_partitions=1 aoe-mkshelf {device-dir} {shelf-address}
```

## DESCRIPTION
The aoe-mkshelf command is not needed on systems that have udev installed and is incompatible with aoe drivers that have the aoe_dyndevs module parameter set to 1.

Systems lacking udev and having an aoe driver that uses static minor device numbers can use aoe-mkshelf to create the block special files necessary to access the AoE devices with the given shelf address.

All aoe drivers prior to aoe6-50 use static minor device numbers. Versions 50 and up use dynamic minor device numbers when the module parameter aoe_dyndevs=1 is set.

If you are using static minor device numbers and your aoe driver supports only one partition per device (whole-disk partitions), then the device files must match, and you should use the n_partitions environment variable described below.

### Arguments
device-dir

This should be the name of the directory where the block device files will be created.

shelf-address

This is the AoE major address, or shelf address, for which to create device nodes. For example, specifying a shelf address of 1 means that the e1.* device nodes will be created in device-dir.

## ENVIRONMENT VARIABLES
If the n_partitions variable is set in the environment, it will override the default number of partitions per aoe disk, namely 16.

## EXAMPLE
In this example, the root user on a host named nai creates special files for using the aoe disks in shelf 7. Then he remembers that the driver doesn't have partition support, so the command is called again with n_partitions set to 1.

```
nai:~# aoe-mkshelf /dev/etherd 7
nai:~# ls /dev/etherd/e7.* | wc -l
160
nai:~# rm /dev/etherd/e7.*
nai:~# n_partitions=1 aoe-mkshelf /dev/etherd 7
nai:~# ls /dev/etherd/e7.* | wc -l
10
nai:~#
```

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoe-mkdevs(8), aoe-stat(8), aoetools(8), udev(7).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


aoe-revalidate

title: aoe-revalidate(8)

text:
# aoe-revalidate(8)

## NAME
aoe-revalidate - revalidate the disk size of an aoe device

## SYNOPSIS

```
aoe-revalidate e{major}.{minor}
```

## DESCRIPTION
The aoe-revalidate command tells the aoe driver to revalidate the disk size of an open aoe device. Normally the aoe driver will only acknowledge changes in an aoe device's disk size when the aoe device is not open.

It should be noted that if an aoe device's disk size shrinks in revalidation any users may become hopelessly confused when their resumed I/O starts to fail.

## EXAMPLE

```
nai# aoe-stat | grep e1.9

     e1.9        82.348GB   eth0 up
nai# < /dev/etherd/e1.9 sleep 600 &
[1] 13006
nai# aoe-revalidate e1.9
nai# aoe-stat | grep e1.9

     e1.9       164.696GB   eth0 up
```

## SEE ALSO
aoe-stat(8), aoetools(8).

## AUTHOR
Sam Hopkins (sah@coraid.com)


aoe-sancheck

title: aoe-sancheck(8)

summary: verify storage network capabilities

text:
# aoe-sancheck(8)

## NAME
aoe-sancheck - verify storage network capabilities

## SYNOPSIS

```
aoe-sancheck [-v]
```

## DESCRIPTION
The aoe-sancheck command collects information about the local interfaces and probes the network for ATA over Ethernet devices, validating the paths for each device. It does not use the aoe kernel module but rather the bpf interface to evaluate the network. As such, the aoe module does not need to be loaded to perform the test.

The output of the command is divided into two sections: information about the local interfaces followed by a list of detected AoE devices. The first section displays the local interfaces, if the interface is up or down, its configured MTU, and the PCI ID for the interface.

The second section lists detected AoE devices, one per line, with the following information:

Device

The device name of the form eX.Y where X is the AoE device shelf address, and Y is the AoE device slot address.

Macs

The number of mac addresses detected for this device.

Payload

The number of bytes of data the device can handle in a single AoE request. This number does not represent the total frame size as it does not include bytes from ethernet or AoE headers.

Local Interfaces

The list of local interfaces from which the device is visible.

### Options
-v

Prints out additional raw information.

## DIAGNOSIS
For each device, aoe-sancheck may print out additional lines of suggestions or warnings. The following checks are made:

The MTU of the local interfaces is set high enough to handle the AoE device's reported payload.

Depending on the host NIC's capabilities and storage network switch's capabilities, best performance may or may not be with local interface MTU set higher than a device's payload size.

The number of local interfaces matches the number of interfaces on the device.

Best performance comes from having a host and device with comparable bandwidth. Aoe-sancheck simply counts the number of interfaces involved and does not figure link bandwidth in its comparison.

All local interfaces for an AoE device have the same MTU.

If one interface for a device has a smaller MTU than the others, the AoE driver must use the smaller payload size for all interfaces.

Each path to the device is capable of the configured payload size.

This check detects the situation where a local interface is configured for jumbo frames and the AoE device is capable of jumbo frames, but some aspect of the network is incapable of passing frames that size, for example, a misconfigured switch. Aoe-sancheck reports the maximum payload size the path is capable of if less than the configured payload size.

## BUGS
The program may sometimes display inconsistent results between runs showing that a path is capable of a smaller frame size than it actually is. If you see this behavior, please email one of the authors with your verbose output.

## SEE ALSO
aoeping(8), aoetools(8)

## AUTHORS
Justin Sanders (justin@coraid.com), Sam Hopkins (sah@coraid.com)


aoe-stat

title: aoe-stat(8)

summary: print aoe device status report

text:
# aoe-stat(8)

## NAME
aoe-stat - print aoe device status report

## SYNOPSIS

```
modprobe aoe
aoe-stat
env sysfs_dir=/sys aoe-stat
```

## DESCRIPTION
The aoe-stat script collects information on ATA over Ethernet devices from sysfs.

For each AoE device the kernel has discovered, there is one row in the script's output. Each row has the following columns.

devicename

The device name is of the form eX.Y,

with X being the AoE device shelf address, and Y being the AoE slot address.

size

The size of the AoE device is in gigabytes (billions of bytes).

ifname

The network interface name is printed in the third column.

payload

The number of bytes read from or written to the storage target in each AoE packet appears in the fourth column, unless the aoe driver does not export this information.

status

The device status is in the last column. Possible values are up, down, and down,closewait. The "up" status means the aoe driver considers this device ready for I/O. The "down" status means the opposite. The "down,closewait" status means that some software still has the device open, and when this straggler closes the device, it will enter the "down" state.

## ENVIRONMENT VARIABLES
If the sysfs_dir variable is set in the environment, it will override the default location where aoe-stat will look for sysfs, namely /sys.

## WARNINGS
If the minor device number of a device node does not match that of its namesake, aoe-stat will print a warning as shown below.

```
nai:~# aoe-stat

      e0.3         0.104GB   eth0 up

      e0.4      4398.046GB   eth0 up

     e20.0      1000.215GB   eth0 up

     e42.0      2000.431GB   eth0 up
aoe-stat Warning: device node /dev/etherd/e45.1 has wrong minor device number

     e45.1      1152.874GB   eth0 up
```

Using such a device node is dangerous, because its name doesn't match the actual device that you would be reading from and writing to. Such a broken device node should be removed. Device nodes are created by udev or (on systems without udev) by aoe-mkdevs.

## EXAMPLE
In this example, the root user on a host named nai loads the aoe driver module and then prints a list of all the available aoe devices. Then he remembers to bring up the storage network interfaces, does an AoE discovery, and prints the list again. This time the list shows all the devices in shelf seven.

```
nai:~# modprobe aoe
nai:~# aoe-stat
nai:~# ifconfig eth3 up
nai:~# aoe-discover
nai:~# aoe-stat

      e0.0     10995.116GB   eth0 up

      e0.1     10995.116GB   eth0 up

      e0.2     10995.116GB   eth0 up

      e1.0      1152.874GB   eth0 up

      e7.0       370.566GB   eth0 up
nai:~#
```

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoe-mkdevs(8), aoe-mkshelf(8), aoetools(8), udev(7).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


aoe-version

title: aoe-version(8)

text:
# aoe-version(8)

## NAME
aoe-version - print AoE-related software version information

## SYNOPSIS

```
aoe-version
```

## DESCRIPTION
The aoe-version script collects information on running and installed ATA over Ethernet software, displaying a summary.

## EXAMPLE

```
ellijay:~# aoe-version

              aoetools: 17

  installed aoe driver: 50

    running aoe driver: 50
```

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoetools(8), aoe-stat(8).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


aoecfg

title: aoecfg(8)

summary: manipulate AoE configuration strings

text:
# aoecfg(8)

## NAME
aoecfg - manipulate AoE configuration strings

## SYNOPSIS
aoecfg [-c cmd] [-s cfgstr] [-t timeout] [shelf slot] [netif]

## DESCRIPTION
Aoecfg(8) sends AoE configuration commands that control the retrivial, conditional or unconditional setting of AoE configuration strings. Since configuration happens before the MAC address of the target is known, the packet is broadcast. AoE targets with a matching shelf and slot respond. Since the default shelf and slot are the wildcard values 0xffff and 0xff, with no arguments aoecfg(8) will return configuration strings from all targets visible on the default interface, eth0.

## OPTIONS
-c cmd

specify the AoE configuration command. The default is read. The available commands are

read Read the server config string without performing any test and respond.

test Respond only if the specified string exactly matches the server configuration string.

prefix Respond only if the specified string is a prefix of the server configuration string.

set If the current server config string is empty, set the server config string to the argument string and respond. If the current server config string is not empty, return a response with Flags bit E set and Error set to 4.

fset Force set the server config string to the argument string and respond.

-s cfgstr

specify the config string.

-t timeout

specify the timeout in seconds. The default is no timeout. If neither the shelf nor the slot are specified, aoecfg(8) will exit after the first result. Otherwise, aoecfg(8) will exit only after the timeout has expired since it does not know how many responses to expect.

shelf slot

specify the shelf and slot used in the query. If unspecified, they default to broadcast.

netif

specifiy the network interface. The default is eth0.

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoe-mkdevs(8), aoe-mkshelf(8), aoe-stat(8), aoeping(8), AoE (ATA over Ethernet): http://support.coraid.com/documents/AoEr10.txt, ATA specification

## AUTHOR
Erik Quanstrom (quanstro@coraid.com)


aoeping

title: aoeping(8)

summary: simple communication with AoE device

text:
# aoeping(8)

## NAME
aoeping - simple communication with AoE device

## SYNOPSIS
aoeping [options] {shelf} {slot} {netif}

## DESCRIPTION
The aoeping(8) program performs simple one or two-round-trip communication with an ATA over Ethernet (AoE) device. It creates and receives AoE packets directly, using raw network sockets.

Running aoeping(8) without command line arguments will result in a short usage summary being displayed.

The aoeping(8) program will wait forever if it doesn't receive an expected response. The caller should use a time out to catch this situation.

### Arguments
shelf

This should be the shelf address (major AoE address) of the AoE device to communicate with.

slot

This should be the slot address (minor AoE address) of the AoE device to communicate with.

netif

The name of the ethernet network interface to use for AoE communications, e.g., eth1.

### Options
-i

Issue an ATA "identify device" command after receiving the AoE device's Config Query response. The "ident" response will be printed on standard output as a hexidecimal dump.

-I

Issue an ATA "identify device" command after receiving the AoE device's Config Query response. The "ident" response will be pretty-printed on standard output as selected human-readable fields.

-v

Turn on more copious output, including a hexidecimal dump of the Config Query response from the AoE device (see AoE spec at URL below).

-s

This option takes an argument. The argument is a decimal integer that specifies the number of seconds that aoeping(8) will wait for a response before timing out and exiting with a non-zero status.

-S

This option takes an argument. The argument is the name of a SMART command to send to the disk. The SMART commands in the list below are supported. If the command requires data transfer, one sector (512 bytes) of data is always the amount transfered. If the command takes a parameter (for the Low LBA register), then the name of the SMART command is immediately followed by a colon and then a number, the value of the parameter, e.g., "-S read_log:1".

read_data

offline_immediate

read_log

write_log

enable

disable

return_status For write_log, aoeping(8) reads from standard input the one sector of data to be written to the specified log.

If the AoE device does not support SMART commands or if the command is aborted, an error message is printed to standard error and aoeping(8) exits with a non-zero status. A command may be aborted if SMART is disabled on the device.

The aoeping(8) command just sends and receives SMART commands, without interpreting them. See the ATA specification for more information on using SMART.

-t

(This is an advanced feature.) This option has an argument. The argument is a decimal integer that is used as the initial tag, with the highest bit set, as the first tag in ATA commands. Tags for subsequent ATA commands will be incremented by one.

-h

Show a usage summary.

## EXAMPLE
In this example, the root user uses aoeping(8) to check for the presence of aoe device e10.9 on network interface eth0.

```
bash# aoeping -v 10 9 eth0 | head
tag: 80000000
eth: eth0
shelf: 10
slot: 9
config query response:
00 0d 87 aa c9 00 00 10 04 00 11 1f 88 a2 18 00
00 0a 09 01 00 00 00 00 00 03 30 08 00 10 00 04
66 6f 6f 0a 00 ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff
```

The next example shows root making sure the disk on the e10.9 is still responsive by issuing an ATA device identify command with a 20-second timeout.

```
bash# aoeping -i -s 20 \

  10 9 eth0 > /dev/null \

  && echo ok
ok
```

The next example uses SMART to determine whether the disk on e10.9 thinks it has exceeded its error threshold. The ATA spec says that the LBA Mid register will be 0x4f when the disk has not exceeded its error threshold.

```
bash# aoeping -S return_status \

  10 9 eth0 | grep 'LBA Mid: 0x4f' \

  > /dev/null \

  && echo ok
ok
```

Note that in a script, it would be prudent to specify and handle a timeout. Also, a good script would make sure the Status register does not have the error bit (bit zero) or the device fault bit (bit 5) set.

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoe-mkdevs(8), aoe-mkshelf(8), aoe-stat(8),

AoE (ATA over Ethernet): http://support.coraid.com/documents/AoEr10.txt,

ATA specification

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


coraid-update

title: coraid-update(8)

text:
# coraid-update(8)

## NAME
coraid-update - upload an update file to a CORAID appliance

## SYNOPSIS

```
coraid-update {update file} {AoE device}
```

## DESCRIPTION
The coraid-update script performs a few sanity checks before copying the local update file to the remote update AoE target on the CORAID appliance.

Two arguments are provided: 1) the name of the update file to be uploaded, and 2) the special block device file corresponding to the update target, e.g., /dev/etherd/e100.40.

It generates no output and exits with a zero status when the update file has been successfully uploaded to the update target on the appliance. Otherwise, an error message is printed to standard error and coraid-update exits with a non-zero status.

## SEE ALSO
aoe-discover(8), aoe-interfaces(8), aoe-stat(8), aoetools(8), udev(7).

## AUTHOR
Ed L. Cashin (ecashin@coraid.com)


title: a2chkconfig(8)

text:
# a2chkconfig(8)

## NAME
a2chkconfig is an utility for apache2 autostart modification.

## SYNOPSIS
a2chkconfig

## SUMMARY
a2chkconfig reads configuration files from conf/*-start.d/* and creates or removes symbolic links in corresponding /etc/httpd2/conf/*-enabled.

Syntax of configuration files in directories conf/*-start.d:

NAME={yes,no}

where NAME is a filename in corresponding conf/*-available.

## EXAMPLE
If you want to disable mod_alias you have to edit file /etc/httpd2/conf/mods-start.d/000-default.conf and change parameter alias to "no". You can see that symbolic link "alias.load" removed from directory /etc/httpd2/conf/mods-enabled.d

## BUGS
Configuration files in conf/*-start.d/* must have new line at the end of file.

## AUTHOR
Written by Andrew Avramenko with help of Aleksey Avdeev.

## COPYRIGHT
Copyright © 2007. ALT Linux TEAM.

This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

## SEE ALSO
a2enmod(8) a2dismod(8) a2enextra(8) a2disextra(8) a2ensite(8) a2dissite(8) apachectl(8)


title: a2enmod(8)

summary: enable or disable an apache2 module

text:
# a2enmod(8)

## NAME
a2enmod, a2dismod - enable or disable an apache2 module

## SYNOPSIS
a2enmod [module]

a2dismod [module]

## DESCRIPTION
This manual page documents briefly the a2enmod and a2dismod commands.

a2enmod is a script that enables the specified module within the apache2 configuration. It does this by creating symlinks within /etc/apache2/mods-enabled. Likewise, a2dismod disables a module by removing those symlinks. It is not an error to enable a module which is already enabled, or to disable one which is already disabled.

## NOTE
a2enmod also enables the module in the conf/mods-start.d/* files to prevent the module explicitly enabled from being disabled after update. a2dismod disables module in conf/mods-start.d/* for the same reason.

## EXAMPLES
a2enmod imagemap

a2dismod mime_magic

Enables the mod_imagemap module, and disables the mod_mime_magic module.

## FILES
/etc/apache2/mods-available

Directory with files giving information on available modules.

/etc/apache2/mods-enabled

Directory with links to the files in mods-available for enabled modules.

## SEE ALSO
apache2ctl(8).

## AUTHOR
This manual page was written by Daniel Stone <daniel@sfarc.net> for the Debian GNU/Linux distribution, as it is a Debian-specific script with the package.


apachectl

title: apachectl(8)

summary: Apache HTTP Server Control Interface

text:
# apachectl(8)

## NAME
apachectl - Apache HTTP Server Control Interface

## SYNOPSIS
When acting in pass-through mode, apachectl can take all the arguments available for the httpd binary.

apachectl [ httpd-argument ]

When acting in SysV init mode, apachectl takes simple, one-word commands, defined below.

apachectl command

## SUMMARY
apachectl is a front end to the Apache HyperText Transfer Protocol (HTTP) server. It is designed to help the administrator control the functioning of the Apache httpd daemon.

The apachectl script can operate in two modes. First, it can act as a simple front-end to the httpd command that simply sets any necessary environment variables and then invokes httpd, passing through any command line arguments. Second, apachectl can act as a SysV init script, taking simple one-word arguments like start, restart, and stop, and translating them into appropriate signals to httpd.

If your Apache installation uses non-standard paths, you will need to edit the apachectl script to set the appropriate paths to the httpd binary. You can also specify any necessary httpd command line arguments. See the comments in the script for details.

The apachectl script returns a 0 exit value on success, and >0 if an error occurs. For more details, view the comments in the script.

## OPTIONS
Only the SysV init-style options are defined here. Other arguments are defined on the httpd manual page.

start

Start the Apache httpd daemon. Gives an error if it is already running. This is equivalent to apachectl -k start.

stop

Stops the Apache httpd daemon. This is equivalent to apachectl -k stop.

restart

Restarts the Apache httpd daemon. If the daemon is not running, it is started. This command automatically checks the configuration files as in configtest before initiating the restart to make sure the daemon doesn't die. This is equivalent to apachectl -k restart.

fullstatus

Displays a full status report from mod_status. For this to work, you need to have mod_status enabled on your server and a text-based browser such as lynx available on your system. The URL used to access the status report can be set by editing the STATUSURL variable in the script.

status

Displays a brief status report. Similar to the fullstatus option, except that the list of requests currently being served is omitted.

graceful

Gracefully restarts the Apache httpd daemon. If the daemon is not running, it is started. This differs from a normal restart in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them. This command automatically checks the configuration files as in configtest before initiating the restart to make sure Apache doesn't die. This is equivalent to apachectl -k graceful.

graceful-stop

Gracefully stops the Apache httpd daemon. This differs from a normal stop in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This is equivalent to apachectl -k graceful-stop.

configtest

Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. This is equivalent to apachectl -t.

The following option was available in earlier versions but has been removed.

startssl

To start httpd with SSL support, you should edit your configuration file to include the relevant directives and then use the normal apachectl start.

## FILES
The default paths listed below may be changed at compile time. Consult your local installation for the actual locations.

/usr/local/apache2/bin/envvars

Environment variable settings sourced at startup.

/usr/local/apache2/bin/httpd

The httpd binary invoked by apachectl.


title: check_forensic(8)

text:
# check_forensic(8)

## NAME
check_forensic - tool to extract mod_log_forensic output from apache log files

## SYNOPSIS
check_forensic <log_file>

## DESCRIPTION
chech_forensic is a simple shell script designed to help apache administrators to extract mod_log_forensic output from apache, apache-ssl and apache-perl log files.

## AUTHOR
This manual page was written by Fabio M. Di Nitto <fabbione@fabbione.net>, for the Debian GNU/Linux system (but may be used by others).


checkgid

title: checkgid(8)

summary: checks the gid

text:
# checkgid(8)

## NAME
checkgid - checks the gid

## SYNOPSIS
checkgid group

## DESCRIPTION
This manual page documents briefly the checkgid command.

checkgid is a program that checks whether it can setgid to the group specified. This is to see if it is a valid group for apache2 to use at runtime. If the user (should be run as superuser) is in that group, or can setgid to it, it will return 0.

## AUTHOR
This manual page was written by Daniel Stone <daniel@sfarc.net> for the Debian GNU/Linux distribution, as the original did not have a manpage.


fcgistarter

title: fcgistarter(8)

summary: Start a FastCGI program

text:
# fcgistarter(8)

## NAME
fcgistarter - Start a FastCGI program

## SYNOPSIS
fcgistarter -c command -p port [ -i interface ] -N num

## NOTE
Currently only works on Unix systems.

## OPTIONS
-c command

Absolute path of the FastCGI program

-p port

Port which the program will listen on

-i interface

Interface which the program will listen on

-N num

Number of instances of the program


httpd

title: httpd(8)

text:
# httpd(8)

## NAME
httpd - Apache Hypertext Transfer Protocol Server

## SYNOPSIS
httpd [ -d serverroot ] [ -f config ] [ -C directive ] [ -c directive ] [ -D parameter ] [ -e level ] [ -E file ] [ -k start|restart|graceful|stop|graceful-stop ] [ -h ] [ -l ] [ -L ] [ -S ] [ -t ] [ -v ] [ -V ] [ -X ] [ -M ] [ -T ]

On Windows systems, the following additional arguments are available:

httpd [ -k install|config|uninstall ] [ -n name ] [ -w ]

## SUMMARY
httpd is the Apache HyperText Transfer Protocol (HTTP) server program. It is designed to be run as a standalone daemon process. When used like this it will create a pool of child processes or threads to handle requests.

In general, httpd should not be invoked directly, but rather should be invoked via apachectl on Unix-based systems or as a service on Windows NT, 2000 and XP and as a console application on Windows 9x and ME.

## OPTIONS
-d serverroot

Set the initial value for the ServerRoot directive to serverroot. This can be overridden by the ServerRoot directive in the configuration file. The default is /usr/local/apache2.

-f config

Uses the directives in the file config on startup. If config does not begin with a /, then it is taken to be a path relative to the ServerRoot. The default is conf/httpd.conf.

-k start|restart|graceful|stop|graceful-stop

Signals httpd to start, restart, or stop. See Stopping Apache httpd for more information.

-C directive

Process the configuration directive before reading config files.

-c directive

Process the configuration directive after reading config files.

-D parameter

Sets a configuration parameter which can be used with <IfDefine> sections in the configuration files to conditionally skip or process commands at server startup and restart. Also can be used to set certain less-common startup parameters including -DNO_DETACH (prevent the parent from forking) and -DFOREGROUND (prevent the parent from calling setsid() et al).

-e level

Sets the LogLevel to level during server startup. This is useful for temporarily increasing the verbosity of the error messages to find problems during startup.

-E file

Send error messages during server startup to file.

-h

Output a short summary of available command line options.

-l

Output a list of modules compiled into the server. This will not list dynamically loaded modules included using the LoadModule directive.

-L

Output a list of directives provided by static modules, together with expected arguments and places where the directive is valid. Directives provided by shared modules are not listed.

-M

Dump a list of loaded Static and Shared Modules.

-S

Show the settings as parsed from the config file (currently only shows the virtualhost settings).

-T (Available in 2.3.8 and later)

Skip document root check at startup/restart.

-t

Run syntax tests for configuration files only. The program immediately exits after these syntax parsing tests with either a return code of 0 (Syntax OK) or return code not equal to 0 (Syntax Error). If -D DUMP_VHOSTS is also set, details of the virtual host configuration will be printed. If -D DUMP_MODULES is set, all loaded modules will be printed.

-v

Print the version of httpd, and then exit.

-V

Print the version and build parameters of httpd, and then exit.

-X

Run httpd in debug mode. Only one worker will be started and the server will not detach from the console.

## FILES
The default paths listed below may be changed at compile time or with various command-line and configuration directives. Consult your local installation for the actual locations.

/usr/local/apache2/conf/httpd.conf

Main server configuration file.

/usr/local/apache2/conf/mime.types

Default MIME type mappings.

/usr/local/apache2/logs/error_log

Error log file.

/usr/local/apache2/logs/access_log

Access log file.

/usr/local/apache2/logs/httpd.pid

File containing the process ID of the running daemon.

The following arguments are available only on the Windows platform:

-k install|config|uninstall

Install Apache httpd as a Windows NT service; change startup options for the Apache httpd service; and uninstall the Apache httpd service.

-n name

The name of the Apache httpd service to signal.

-w

Keep the console window open on error so that the error message can be read.


rotatelogs

title: rotatelogs(8)

text:
# rotatelogs(8)

## NAME
rotatelogs - Piped logging program to rotate Apache logs

## SYNOPSIS
rotatelogs [ -l ] [ -L linkname ] [ -p program ] [ -f ] [ -D ] [ -t ] [ -v ] [ -e ] [ -c ] [ -n number-of-files ] logfile rotationtime|filesize(B|K|M|G) [ offset ]

## SUMMARY
rotatelogs is a simple program for use in conjunction with Apache's piped logfile feature. It supports rotation based on a time interval or maximum size of the log.

## OPTIONS
-l

Causes the use of local time rather than GMT as the base for the interval or for strftime(3) formatting with size-based rotation.

-L linkname

-p program

If given, rotatelogs will execute the specified program every time a new log file is opened. The filename of the newly opened file is passed as the first argument to the program. If executing after a rotation, the old log file is passed as the second argument. rotatelogs does not wait for the specified program to terminate before continuing to operate, and will not log any error code returned on termination. The spawned program uses the same stdin, stdout, and stderr as rotatelogs itself, and also inherits the environment.

-f

Causes the logfile to be opened immediately, as soon as rotatelogs starts, instead of waiting for the first logfile entry to be read (for non-busy sites, there may be a substantial delay between when the server is started and when the first request is handled, meaning that the associated logfile does not "exist" until then, which causes problems from some automated logging tools)

-D

Creates the parent directories of the path that the log file will be placed in if they do not already exist. This allows strftime(3) formatting to be used in the path and not just the filename.

-t

Causes the logfile to be truncated instead of rotated. This is useful when a log is processed in real time by a command like tail, and there is no need for archived data. No suffix will be added to the filename, however format strings containing '%' characters will be respected.

-T

Causes all but the initial logfile to be truncated when opened. This is useful when the format string contains something that will loop around, such as the day of the month. Available in 2.4.56 and later.

-v

Produce verbose output on STDERR. The output contains the result of the configuration parsing, and all file open and close actions.

-e

Echo logs through to stdout. Useful when logs need to be further processed in real time by a further tool in the chain.

-c

Create log file for each interval, even if empty.

-n number-of-files

Use a circular list of filenames without timestamps. This option overwrites log files at startup and during rotation. With -n 3, the series of log files opened would be "logfile", "logfile.1", "logfile.2", then overwriting "logfile". When this program first opens "logfile", the file will only be truncated if -t is also provided. Every subsequent rotation will always begin with truncation of the target file. For size based rotation without -t and existing log files in place, this option may result in unintuitive behavior such as initial log entries being sent to "logfile.1", and entries in "logfile.1" not being preserved even if later "logfile.n" have not yet been used. Available in 2.4.5 and later.

logfile

rotationtime

The time between log file rotations in seconds. The rotation occurs at the beginning of this interval. For example, if the rotation time is 3600, the log file will be rotated at the beginning of every hour; if the rotation time is 86400, the log file will be rotated every night at midnight. (If no data is logged during an interval, no file will be created.)

filesize(B|K|M|G)

The maximum file size in followed by exactly one of the letters B (Bytes), K (KBytes), M (MBytes) or G (GBytes). .PP When time and size are specified, the size must be given after the time. Rotation will occur whenever either time or size limits are reached.

offset

The number of minutes offset from UTC. If omitted, zero is assumed and UTC is used. For example, to use local time in the zone UTC -5 hours, specify a value of -300 for this argument. In most cases, -l should be used instead of specifying an offset.

## EXAMPLES

```

     CustomLog "|bin/rotatelogs /var/log/logfile 86400" common

```

This creates the files /var/log/logfile.nnnn where nnnn is the system time at which the log nominally starts (this time will always be a multiple of the rotation time, so you can synchronize cron scripts with it). At the end of each rotation time (here after 24 hours) a new log is started.

```

     CustomLog "|bin/rotatelogs -l /var/log/logfile.%Y.%m.%d 86400" common

```

This creates the files /var/log/logfile.yyyy.mm.dd where yyyy is the year, mm is the month, and dd is the day of the month. Logging will switch to a new file every day at midnight, local time.

```

     CustomLog "|bin/rotatelogs /var/log/logfile 5M" common

```

This configuration will rotate the logfile whenever it reaches a size of 5 megabytes.

```

     ErrorLog "|bin/rotatelogs /var/log/errorlog.%Y-%m-%d-%H_%M_%S 5M"

```

This configuration will rotate the error logfile whenever it reaches a size of 5 megabytes, and the suffix to the logfile name will be created of the form errorlog.YYYY-mm-dd-HH_MM_SS.

```

     CustomLog "|bin/rotatelogs -t /var/log/logfile 86400" common

```

This creates the file /var/log/logfile, truncating the file at startup and then truncating the file once per day. It is expected in this scenario that a separate process (such as tail) would process the file in real time.

```

     CustomLog "|bin/rotatelogs -T /var/log/logfile.%d 86400" common

```

If the server is started (or restarted) on the first of the month, this appends to /var/log/logfile.01. When a log entry is written on the second of the month, /var/log/logfile.02 is truncated and new entries will be added to the top. This example keeps approximately 1 months worth of logs without external maintenance.

## PORTABILITY
The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions.

• %A - full weekday name (localized)

• %a - 3-character weekday name (localized)

• %B - full month name (localized)

• %b - 3-character month name (localized)

• %c - date and time (localized)

• %d - 2-digit day of month

• %H - 2-digit hour (24 hour clock)

• %I - 2-digit hour (12 hour clock)

• %j - 3-digit day of year

• %M - 2-digit minute

• %m - 2-digit month

• %p - am/pm of 12 hour clock (localized)

• %S - 2-digit second

• %U - 2-digit week of year (Sunday first day of week)

• %W - 2-digit week of year (Monday first day of week)

• %w - 1-digit weekday (Sunday first day of week)

• %X - time (localized)

• %x - date (localized)

• %Y - 4-digit year

• %y - 2-digit year

• %Z - time zone name

• %% - literal `%'


htcacheclean

title: htcacheclean(8)

summary: Clean up the disk cache

text:
# htcacheclean(8)

## NAME
htcacheclean - Clean up the disk cache

## SYNOPSIS
htcacheclean [ -D ] [ -v ] [ -t ] [ -r ] [ -n ] [ -Rround ] -ppath [ -llimit ] [ -Llimit ]

htcacheclean [ -n ] [ -t ] [ -i ] [ -Ppidfile ] [ -Rround ] -dinterval -ppath [ -llimit ] [ -Llimit ]

htcacheclean [ -v ] [ -Rround ] -ppath [ -a ] [ -A ]

htcacheclean [ -D ] [ -v ] [ -t ] [ -Rround ] -ppath url

## SUMMARY
htcacheclean is used to keep the size of mod_cache_disk's storage within a given size limit, or limit on inodes in use. This tool can run either manually or in daemon mode. When running in daemon mode, it sleeps in the background and checks the cache directory at regular intervals for cached content to be removed. You can stop the daemon cleanly by sending it a TERM or INT signal. When run manually, a once off check of the cache directory is made for cached content to be removed. If one or more URLs are specified, each URL will be deleted from the cache, if present.

## OPTIONS
-dinterval

Daemonize and repeat cache cleaning every interval minutes. This option is mutually exclusive with the -D, -v and -r options. To shutdown the daemon cleanly, just send it a SIGTERM or SIGINT.

-D

Do a dry run and don't delete anything. This option is mutually exclusive with the -d option. When doing a dry run and deleting directories with -t, the inodes reported deleted in the stats cannot take into account the directories deleted, and will be marked as an estimate.

-v

Be verbose and print statistics. This option is mutually exclusive with the -d option.

-r

Clean thoroughly. This assumes that the Apache web server is not running (otherwise you may get garbage in the cache). This option is mutually exclusive with the -d option and implies the -t option.

-n

Be nice. This causes slower processing in favor of other processes. htcacheclean will sleep from time to time so that (a) the disk IO will be delayed and (b) the kernel can schedule other processes in the meantime.

-t

Delete all empty directories. By default only cache files are removed, however with some configurations the large number of directories created may require attention. If your configuration requires a very large number of directories, to the point that inode or file allocation table exhaustion may become an issue, use of this option is advised.

-ppath

Specify path as the root directory of the disk cache. This should be the same value as specified with the CacheRoot directive.

-Ppidfile

Specify pidfile as the name of the file to write the process ID to when daemonized.

-Rround

Specify round as the amount to round sizes up to, to compensate for disk block sizes. Set to the block size of the cache partition.

-llimit

Specify limit as the total disk cache size limit. The value is expressed in bytes by default (or attaching B to the number). Attach K for Kbytes, M for MBytes or G for Gbytes.

-Llimit

Specify limit as the total disk cache inode limit. K, M or G suffix can also be used.

-i

Be intelligent and run only when there was a modification of the disk cache. This option is only possible together with the -d option.

-a

List the URLs currently stored in the cache. Variants of the same URL will be listed once for each variant.

-A

List the URLs currently stored in the cache, along with their attributes in the following order: url, header size, body size, status, entity version, date, expiry, request time, response time, body present, head request.

## DELETING A SPECIFIC URL
If htcacheclean is passed one or more URLs, each URL will be deleted from the cache. If multiple variants of an URL exists, all variants would be deleted.

When a reverse proxied URL is to be deleted, the effective URL is constructed from the Host header, the port, the path and the query. Note the '?' in the URL must always be specified explicitly, whether a query string is present or not. For example, an attempt to delete the path / from the server localhost, the URL to delete would be http://localhost:80/?.

## LISTING URLS IN THE CACHE
By passing the -a or -A options to htcacheclean, the URLs within the cache will be listed as they are found, one URL per line. The -A option dumps the full cache entry after the URL, with fields in the following order:

url

The URL of the entry.

header size

The size of the header in bytes.

body size

The size of the body in bytes.

status

Status of the cached response.

entity version

The number of times this entry has been revalidated without being deleted.

date

Date of the response.

expiry

Expiry date of the response.

request time

Time of the start of the request.

response time

Time of the end of the request.

body present

If 0, no body is stored with this request, 1 otherwise.

head request

If 1, the entry contains a cached HEAD request with no body, 0 otherwise.

## EXIT STATUS
htcacheclean returns a zero status ("true") if all operations were successful, 1 otherwise. If an URL is specified, and the URL was cached and successfully removed, 0 is returned, 2 otherwise. If an error occurred during URL removal, 1 is returned.

## FILES
The cache root directory is specified as an argument on the command line and should match the CacheRoot directive in the server configuration.

path

The root directory of the disk cache to be cleaned.


suexec

title: suexec(8)

text:
# suexec(8)

## NAME
suexec - Switch user before executing external programs

## SYNOPSIS
suexec -V

## SUMMARY
suexec is used by the Apache HTTP Server to switch to another user before executing CGI programs. In order to achieve this, it must run as root. Since the HTTP daemon normally doesn't run as root, the suexec executable needs the setuid bit set and must be owned by root. It should never be writable for any other person than root.

For further information about the concepts and the security model of suexec please refer to the suexec documentation (http://httpd.apache.org/docs/2.4/suexec.html).

## OPTIONS
-V

If you are root, this option displays the compile options of suexec. For security reasons all configuration options are changeable only at compile time.