title: e4rat-preload(8)

summary: Preload files into memory

text:
# e4rat-preload(8)

## NAME
e4rat-prealod - Preload files into memory

## SYNOPSIS
e4rat-preload [ option(s) ] file(s)

## DESCRIPTION
e4rat-preload transfers files into memory to gain a high cache hit rate. The list file(s) must be in a format generated by e4rat-collect. It assumes that all files got reallocated by e4rat-realloc at first.

In order to prevent disk seeks the preloading process is divided into two steps. First, it reads the files' I-Node information. In the second step, it reads the files' content. This can be done in parallel of executing the command specified with --execute. If e4rat-preload is executed as the init process by adding it to the kernel parameters, /sbin/init is called.

## OPTIONS
-V --version

show version information and exit.

-h --help

display usage message and exit.

-v --verbose

increment verbosity level.

-q --quiet

set verbosity level to 0. This means that no messages will be displayed.

-l --loglevel <number>

set loglevel to <number>. All log messages are either send to Kernel log (see dmesg(1)) or syslog(3).

-x --execute <command>

As soon as I-Node preloading is done, execute <command>. Reading file content into the page cache in parallel.

-s --sort

sort files by their physically position. Inserts the device id and I-Node number if they're missing.

-o --output [file]

write sorted file list to output file. If filename is not supplied, it is written to the stdout.

## EXAMPLES

### Accelerate program startup time of Mozilla Firefox:
e4rat-preload /var/lib/e4rat/firefox -x firefox

### Accelerate the boot process:
Run e4rat-preload as early as possible. It is recommended to run it as the init process. To do so, append the following line to the Kernel parameters in grub(8) or lilo(8):

init=/sbin/e4rat-preload

## FILES
/etc/e4rat.conf

E4rat configuration file.

## AUTHOR
Written by Andreas Rid and Gundolf Kiefer.

## REPORTING BUGS
Report bugs to Andreas Rid <conso at users.sf.net>.

## SEE ALSO
e4rat-collect(8), e4rat-realloc(8), e4rat.conf(8)


title: e4rat-realloc(8)

text:
# e4rat-realloc(8)

## NAME
e4rat-realloc - Reallocation and defragmentation of relevant files

## SYNOPSIS
e4rat-realloc [ option(s) ] [ mode ] file(s)

## DESCRIPTION
e4rat-realloc is a relevant file defrag program based on EXT4_IOC_MOVE_EXT ioctl from ext4 filesystems. It physically places files into a sequence of neighbouring blocks on disk. The reallocation process can be done when the filesystem is still mounted. For security reasons write access to each file is needed.

If you want to process files from a program it is recommended to kill them at first. Linux does not allow to open files writable while it is still executed. So it is not possible to process the program executable binary. Those files get excluded automatically.

Add list files to be proceeded either as parameters and/or over stdin. The list file(s) must be in a format generated by e4rat-collect.

## OPTIONS
-V --version

show version information and exit.

-h --help

display usage message and exit.

-v --verbose

increment verbosity level.

-q --quiet

set verbosity level to 0. This means that no messages will be displayed.

-l --loglevel <number>

set loglevel to <number>. All log messages are sent either to the Kernel log (see dmesg(1)) or to syslog(3).

-f --force

force reallocating files even though it will get worse afterwards.

## DEFRAG MODES
-p --use-prealloc

use the pre-allocation ioctl to rearrange files on disk. Furthermore this mode supports to eliminate gaps of unallocated blocks in sparse files. Unfortunately, this ioctl is presently under heavy development by Kazuya Mio and has not yet entered the Linux Kernel. Therefore you have to apply this Kernel patch fist: http://kt1.osuosl.org/mailarchive/linux-fsdevel/2010/12/1/6887724 Do this at your own risk.

-g --use-locality-group

The ext4 filesystem allocates small files in so-called locality groups. Each CPU manages its own group. The "locality-group" method makes use of this feature in order to rearrange the files on disk. In contrast to the "prealloc" method, no kernel patch is required. However, the placement may me suboptimal. While creating donor files is in progress, it is necessary to increase the limit which indicates small files. As a result other allocation requests occurring at the same time will be also satisfied with blocks from the locality group as well. It is the best if you just avoid heavy write access to disk.

-t --use-tld

select the "use-tld" method to rearrange files on disk. With this method, all donor files are created in a new top level directory. The so-called Orlov algorithm put top level directory into an empty block group. As a result, donor files will be allocated near this directory. But there is no guarantee that the donor files are allocated in their access order. Also, ext4's block allocator normalizes every block request to a power of 2. This typically leads to small holes between the files.

## FILES
/etc/e4rat.conf

E4rat configuration file.

## AUTHOR
Written by Andreas Rid and Gundolf Kiefer.

## REPORTING BUGS
Report bugs to Andreas Rid <conso at users.sf.net>.

## SEE ALSO
e4rat-collect(8), e4rat-preload(8), e4rat.conf(8)


ebtables

package: ebtables

title: ebtables(8)

text:
# ebtables(8)

## NAME
ebtables (v2.0.10-4) - Ethernet bridge frame table administration

## SYNOPSIS
ebtables [-t table ] -[ACDI] chain rule specification [match extensions] [watcher extensions] target

ebtables [-t table ] -P chain ACCEPT | DROP | RETURN

ebtables [-t table ] -F [chain]

ebtables [-t table ] -Z [chain]

ebtables [-t table ] -L [-Z] [chain] [ [--Ln] | [--Lx] ] [--Lc] [--Lmac2]

ebtables [-t table ] -N chain [-P ACCEPT | DROP | RETURN]

ebtables [-t table ] -X [chain]

ebtables [-t table ] -E old-chain-name new-chain-name

ebtables [-t table ] --init-table

ebtables [-t table ] [--atomic-file file] --atomic-commit

ebtables [-t table ] [--atomic-file file] --atomic-init

ebtables [-t table ] [--atomic-file file] --atomic-save

## DESCRIPTION
ebtables is an application program used to set up and maintain the tables of rules (inside the Linux kernel) that inspect Ethernet frames. It is analogous to the iptables application, but less complicated, due to the fact that the Ethernet protocol is much simpler than the IP protocol.

### CHAINS
There are three ebtables tables with built-in chains in the Linux kernel. These tables are used to divide functionality into different sets of rules. Each set of rules is called a chain. Each chain is an ordered list of rules that can match Ethernet frames. If a rule matches an Ethernet frame, then a processing specification tells what to do with that matching frame. The processing specification is called a 'target'. However, if the frame does not match the current rule in the chain, then the next rule in the chain is examined and so forth. The user can create new (user-defined) chains that can be used as the 'target' of a rule. User-defined chains are very useful to get better performance over the linear traversal of the rules and are also essential for structuring the filtering rules into well-organized and maintainable sets of rules.

### TARGETS
A firewall rule specifies criteria for an Ethernet frame and a frame processing specification called a target. When a frame matches a rule, then the next action performed by the kernel is specified by the target. The target can be one of these values: ACCEPT, DROP, CONTINUE, RETURN, an 'extension' (see below) or a jump to a user-defined chain.

ACCEPT means to let the frame through. DROP means the frame has to be dropped. In the BROUTING chain however, the ACCEPT and DROP target have different meanings (see the info provided for the -t option). CONTINUE means the next rule has to be checked. This can be handy, f.e., to know how many frames pass a certain point in the chain, to log those frames or to apply multiple targets on a frame. RETURN means stop traversing this chain and resume at the next rule in the previous (calling) chain. For the extension targets please refer to the TARGET EXTENSIONS section of this man page.

### TABLES
As stated earlier, there are three ebtables tables in the Linux kernel. The table names are filter, nat and broute. Of these three tables, the filter table is the default table that the command operates on. If you are working with the filter table, then you can drop the '-t filter' argument to the ebtables command. However, you will need to provide the -t argument for the other two tables. Moreover, the -t argument must be the first argument on the ebtables command line, if used.

-t, --table

filter is the default table and contains three built-in chains: INPUT (for frames destined for the bridge itself, on the level of the MAC destination address), OUTPUT (for locally-generated or (b)routed frames) and FORWARD (for frames being forwarded by the bridge).

nat is mostly used to change the mac addresses and contains three built-in chains: PREROUTING (for altering frames as soon as they come in), OUTPUT (for altering locally generated or (b)routed frames before they are bridged) and POSTROUTING (for altering frames as they are about to go out). A small note on the naming of chains PREROUTING and POSTROUTING: it would be more accurate to call them PREFORWARDING and POSTFORWARDING, but for all those who come from the iptables world to ebtables it is easier to have the same names. Note that you can change the name (-E) if you don't like the default.

broute is used to make a brouter, it has one built-in chain: BROUTING. The targets DROP and ACCEPT have a special meaning in the broute table (these names are used instead of more descriptive names to keep the implementation generic). DROP actually means the frame has to be routed, while ACCEPT means the frame has to be bridged. The BROUTING chain is traversed very early. However, it is only traversed by frames entering on a bridge port that is in forwarding state. Normally those frames would be bridged, but you can decide otherwise here. The redirect target is very handy here.

## EBTABLES COMMAND LINE ARGUMENTS
After the initial ebtables '-t table' command line argument, the remaining arguments can be divided into several groups. These groups are commands, miscellaneous commands, rule specifications, match extensions, watcher extensions and target extensions.

### COMMANDS
The ebtables command arguments specify the actions to perform on the table defined with the -t argument. If you do not use the -t argument to name a table, the commands apply to the default filter table. Only one command may be used on the command line at a time, except when the commands -L and -Z are combined, the commands -N and -P are combined, or when --atomic-file is used.

-A, --append

Append a rule to the end of the selected chain.

-D, --delete

Delete the specified rule or rules from the selected chain. There are two ways to use this command. The first is by specifying an interval of rule numbers to delete (directly after -D). Syntax: start_nr[:end_nr] (use -L --Ln to list the rules with their rule number). When end_nr is omitted, all rules starting from start_nr are deleted. Using negative numbers is allowed, for more details about using negative numbers, see the -I command. The second usage is by specifying the complete rule as it would have been specified when it was added. Only the first encountered rule that is the same as this specified rule, in other words the matching rule with the lowest (positive) rule number, is deleted.

-C, --change-counters

Change the counters of the specified rule or rules from the selected chain. There are two ways to use this command. The first is by specifying an interval of rule numbers to do the changes on (directly after -C). Syntax: start_nr[:end_nr] (use -L --Ln to list the rules with their rule number). The details are the same as for the -D command. The second usage is by specifying the complete rule as it would have been specified when it was added. Only the counters of the first encountered rule that is the same as this specified rule, in other words the matching rule with the lowest (positive) rule number, are changed. In the first usage, the counters are specified directly after the interval specification, in the second usage directly after -C. First the packet counter is specified, then the byte counter. If the specified counters start with a '+', the counter values are added to the respective current counter values. If the specified counters start with a '-', the counter values are decreased from the respective current counter values. No bounds checking is done. If the counters don't start with '+' or '-', the current counters are changed to the specified counters.

-I, --insert

Insert the specified rule into the selected chain at the specified rule number. If the rule number is not specified, the rule is added at the head of the chain. If the current number of rules equals N, then the specified number can be between -N and N+1. For a positive number i, it holds that i and i-N-1 specify the same place in the chain where the rule should be inserted. The rule number 0 specifies the place past the last rule in the chain and using this number is therefore equivalent to using the -A command. Rule numbers structly smaller than 0 can be useful when more than one rule needs to be inserted in a chain.

-P, --policy

Set the policy for the chain to the given target. The policy can be ACCEPT, DROP or RETURN.

-F, --flush

Flush the selected chain. If no chain is selected, then every chain will be flushed. Flushing a chain does not change the policy of the chain, however.

-Z, --zero

Set the counters of the selected chain to zero. If no chain is selected, all the counters are set to zero. The -Z command can be used in conjunction with the -L command. When both the -Z and -L commands are used together in this way, the rule counters are printed on the screen before they are set to zero.

-L, --list

List all rules in the selected chain. If no chain is selected, all chains are listed.

The following options change the output of the -L command.

--Ln

Places the rule number in front of every rule. This option is incompatible with the --Lx option.

--Lc

Shows the counters at the end of each rule displayed by the -L command. Both a frame counter (pcnt) and a byte counter (bcnt) are displayed. The frame counter shows how many frames have matched the specific rule, the byte counter shows the sum of the frame sizes of these matching frames. Using this option in combination with the --Lx option causes the counters to be written out in the '-c <pcnt> <bcnt>' option format.

--Lx

Changes the output so that it produces a set of ebtables commands that construct the contents of the chain, when specified. If no chain is specified, ebtables commands to construct the contents of the table are given, including commands for creating the user-defined chains (if any). You can use this set of commands in an ebtables boot or reload script. For example the output could be used at system startup. The --Lx option is incompatible with the --Ln listing option. Using the --Lx option together with the --Lc option will cause the counters to be written out in the '-c <pcnt> <bcnt>' option format.

--Lmac2

Shows all MAC addresses with the same length, adding leading zeroes if necessary. The default representation omits leading zeroes in the addresses.

-N, --new-chain

Create a new user-defined chain with the given name. The number of user-defined chains is limited only by the number of possible chain names. A user-defined chain name has a maximum length of 31 characters. The standard policy of the user-defined chain is ACCEPT. The policy of the new chain can be initialized to a different standard target by using the -P command together with the -N command. In this case, the chain name does not have to be specified for the -P command.

-X, --delete-chain

Delete the specified user-defined chain. There must be no remaining references (jumps) to the specified chain, otherwise ebtables will refuse to delete it. If no chain is specified, all user-defined chains that aren't referenced will be removed.

-E, --rename-chain

Rename the specified chain to a new name. Besides renaming a user-defined chain, you can rename a standard chain to a name that suits your taste. For example, if you like PREFORWARDING more than PREROUTING, then you can use the -E command to rename the PREROUTING chain. If you do rename one of the standard ebtables chain names, please be sure to mention this fact should you post a question on the ebtables mailing lists. It would be wise to use the standard name in your post. Renaming a standard ebtables chain in this fashion has no effect on the structure or functioning of the ebtables kernel table.

--init-table

Replace the current table data by the initial table data.

--atomic-init

Copy the kernel's initial data of the table to the specified file. This can be used as the first action, after which rules are added to the file. The file can be specified using the --atomic-file command or through the EBTABLES_ATOMIC_FILE environment variable.

--atomic-save

Copy the kernel's current data of the table to the specified file. This can be used as the first action, after which rules are added to the file. The file can be specified using the --atomic-file command or through the EBTABLES_ATOMIC_FILE environment variable.

--atomic-commit

Replace the kernel table data with the data contained in the specified file. This is a useful command that allows you to load all your rules of a certain table into the kernel at once, saving the kernel a lot of precious time and allowing atomic updates of the tables. The file which contains the table data is constructed by using either the --atomic-init or the --atomic-save command to generate a starting file. After that, using the --atomic-file command when constructing rules or setting the EBTABLES_ATOMIC_FILE environment variable allows you to extend the file and build the complete table before committing it to the kernel. This command can be very useful in boot scripts to populate the ebtables tables in a fast way.

### MISCELLANOUS COMMANDS
-V, --version

Show the version of the ebtables userspace program.

-h, --help [list of module names]

Give a brief description of the command syntax. Here you can also specify names of extensions and ebtables will try to write help about those extensions. E.g. ebtables -h snat log ip arp. Specify list_extensions to list all extensions supported by the userspace utility.

-j, --jump target

The target of the rule. This is one of the following values: ACCEPT, DROP, CONTINUE, RETURN, a target extension (see TARGET EXTENSIONS) or a user-defined chain name.

--atomic-file file

Let the command operate on the specified file. The data of the table to operate on will be extracted from the file and the result of the operation will be saved back into the file. If specified, this option should come before the command specification. An alternative that should be preferred, is setting the EBTABLES_ATOMIC_FILE environment variable.

-M, --modprobe program

When talking to the kernel, use this program to try to automatically load missing kernel modules.

--concurrent

Use a file lock to support concurrent scripts updating the ebtables kernel tables.

### RULE SPECIFICATIONS
The following command line arguments make up a rule specification (as used in the add and delete commands). A "!" option before the specification inverts the test for that specification. Apart from these standard rule specifications there are some other command line arguments of interest. See both the MATCH EXTENSIONS and the WATCHER EXTENSIONS below.

-p, --protocol [!] protocol

The protocol that was responsible for creating the frame. This can be a hexadecimal number, above 0x0600, a name (e.g. ARP ) or LENGTH. The protocol field of the Ethernet frame can be used to denote the length of the header (802.2/802.3 networks). When the value of that field is below or equals 0x0600, the value equals the size of the header and shouldn't be used as a protocol number. Instead, all frames where the protocol field is used as the length field are assumed to be of the same 'protocol'. The protocol name used in ebtables for these frames is LENGTH.

The file /etc/ethertypes can be used to show readable characters instead of hexadecimal numbers for the protocols. For example, 0x0800 will be represented by IPV4. The use of this file is not case sensitive. See that file for more information. The flag --proto is an alias for this option.

-i, --in-interface [!] name

The interface (bridge port) via which a frame is received (this option is useful in the INPUT, FORWARD, PREROUTING and BROUTING chains). If the interface name ends with '+', then any interface name that begins with this name (disregarding '+') will match. The flag --in-if is an alias for this option.

--logical-in [!] name

The (logical) bridge interface via which a frame is received (this option is useful in the INPUT, FORWARD, PREROUTING and BROUTING chains). If the interface name ends with '+', then any interface name that begins with this name (disregarding '+') will match.

-o, --out-interface [!] name

The interface (bridge port) via which a frame is going to be sent (this option is useful in the OUTPUT, FORWARD and POSTROUTING chains). If the interface name ends with '+', then any interface name that begins with this name (disregarding '+') will match. The flag --out-if is an alias for this option.

--logical-out [!] name

The (logical) bridge interface via which a frame is going to be sent (this option is useful in the OUTPUT, FORWARD and POSTROUTING chains). If the interface name ends with '+', then any interface name that begins with this name (disregarding '+') will match.

-s, --source [!] address[/mask]

The source MAC address. Both mask and address are written as 6 hexadecimal numbers separated by colons. Alternatively one can specify Unicast, Multicast, Broadcast or BGA (Bridge Group Address):

Unicast=00:00:00:00:00:00/01:00:00:00:00:00, Multicast=01:00:00:00:00:00/01:00:00:00:00:00, Broadcast=ff:ff:ff:ff:ff:ff/ff:ff:ff:ff:ff:ff or BGA=01:80:c2:00:00:00/ff:ff:ff:ff:ff:ff. Note that a broadcast address will also match the multicast specification. The flag --src is an alias for this option.

-d, --destination [!] address[/mask]

The destination MAC address. See -s (above) for more details on MAC addresses. The flag --dst is an alias for this option.

-c, --set-counter pcnt bcnt

If used with -A or -I, then the packet and byte counters of the new rule will be set to pcnt, resp. bcnt. If used with the -C or -D commands, only rules with a packet and byte count equal to pcnt, resp. bcnt will match.

### MATCH EXTENSIONS
Ebtables extensions are dynamically loaded into the userspace tool, there is therefore no need to explicitly load them with a -m option like is done in iptables. These extensions deal with functionality supported by kernel modules supplemental to the core ebtables code.

### 802_3
Specify 802.3 DSAP/SSAP fields or SNAP type. The protocol must be specified as LENGTH (see the option -p above).

--802_3-sap [!] sap

DSAP and SSAP are two one byte 802.3 fields. The bytes are always equal, so only one byte (hexadecimal) is needed as an argument.

--802_3-type [!] type

If the 802.3 DSAP and SSAP values are 0xaa then the SNAP type field must be consulted to determine the payload protocol. This is a two byte (hexadecimal) argument. Only 802.3 frames with DSAP/SSAP 0xaa are checked for type.

### among
Match a MAC address or MAC/IP address pair versus a list of MAC addresses and MAC/IP address pairs. A list entry has the following format: xx:xx:xx:xx:xx:xx[=ip.ip.ip.ip][,]. Multiple list entries are separated by a comma, specifying an IP address corresponding to the MAC address is optional. Multiple MAC/IP address pairs with the same MAC address but different IP address (and vice versa) can be specified. If the MAC address doesn't match any entry from the list, the frame doesn't match the rule (unless "!" was used).

--among-dst [!] list

Compare the MAC destination to the given list. If the Ethernet frame has type IPv4 or ARP, then comparison with MAC/IP destination address pairs from the list is possible.

--among-src [!] list

Compare the MAC source to the given list. If the Ethernet frame has type IPv4 or ARP, then comparison with MAC/IP source address pairs from the list is possible.

--among-dst-file [!] file

Same as --among-dst but the list is read in from the specified file.

--among-src-file [!] file

Same as --among-src but the list is read in from the specified file.

### arp
Specify (R)ARP fields. The protocol must be specified as ARP or RARP.

--arp-opcode [!] opcode

The (R)ARP opcode (decimal or a string, for more details see ebtables -h arp).

--arp-htype [!] hardware type

The hardware type, this can be a decimal or the string Ethernet (which sets type to 1). Most (R)ARP packets have Eternet as hardware type.

--arp-ptype [!] protocol type

The protocol type for which the (r)arp is used (hexadecimal or the string IPv4, denoting 0x0800). Most (R)ARP packets have protocol type IPv4.

--arp-ip-src [!] address[/mask]

The (R)ARP IP source address specification.

--arp-ip-dst [!] address[/mask]

The (R)ARP IP destination address specification.

--arp-mac-src [!] address[/mask]

The (R)ARP MAC source address specification.

--arp-mac-dst [!] address[/mask]

The (R)ARP MAC destination address specification.

[!] --arp-gratuitous

Checks for ARP gratuitous packets: checks equality of IPv4 source address and IPv4 destination address inside the ARP header.

### ip
Specify IPv4 fields. The protocol must be specified as IPv4.

--ip-source [!] address[/mask]

The source IP address. The flag --ip-src is an alias for this option.

--ip-destination [!] address[/mask]

The destination IP address. The flag --ip-dst is an alias for this option.

--ip-tos [!] tos

The IP type of service, in hexadecimal numbers. IPv4.

--ip-protocol [!] protocol

The IP protocol. The flag --ip-proto is an alias for this option.

--ip-source-port [!] port1[:port2]

The source port or port range for the IP protocols 6 (TCP), 17 (UDP), 33 (DCCP) or 132 (SCTP). The --ip-protocol option must be specified as TCP, UDP, DCCP or SCTP. If port1 is omitted, 0:port2 is used; if port2 is omitted but a colon is specified, port1:65535 is used. The flag --ip-sport is an alias for this option.

--ip-destination-port [!] port1[:port2]

The destination port or port range for ip protocols 6 (TCP), 17 (UDP), 33 (DCCP) or 132 (SCTP). The --ip-protocol option must be specified as TCP, UDP, DCCP or SCTP. If port1 is omitted, 0:port2 is used; if port2 is omitted but a colon is specified, port1:65535 is used. The flag --ip-dport is an alias for this option.

### ip6
Specify IPv6 fields. The protocol must be specified as IPv6.

--ip6-source [!] address[/mask]

The source IPv6 address. The flag --ip6-src is an alias for this option.

--ip6-destination [!] address[/mask]

The destination IPv6 address. The flag --ip6-dst is an alias for this option.

--ip6-tclass [!] tclass

The IPv6 traffic class, in hexadecimal numbers.

--ip6-protocol [!] protocol

The IP protocol. The flag --ip6-proto is an alias for this option.

--ip6-source-port [!] port1[:port2]

The source port or port range for the IPv6 protocols 6 (TCP), 17 (UDP), 33 (DCCP) or 132 (SCTP). The --ip6-protocol option must be specified as TCP, UDP, DCCP or SCTP. If port1 is omitted, 0:port2 is used; if port2 is omitted but a colon is specified, port1:65535 is used. The flag --ip6-sport is an alias for this option.

--ip6-destination-port [!] port1[:port2]

The destination port or port range for IPv6 protocols 6 (TCP), 17 (UDP), 33 (DCCP) or 132 (SCTP). The --ip6-protocol option must be specified as TCP, UDP, DCCP or SCTP. If port1 is omitted, 0:port2 is used; if port2 is omitted but a colon is specified, port1:65535 is used. The flag --ip6-dport is an alias for this option.

--ip6-icmp-type [!] {type[:type]/code[:code]|typename}

Specify ipv6-icmp type and code to match. Ranges for both type and code are supported. Type and code are separated by a slash. Valid numbers for type and range are 0 to 255. To match a single type including all valid codes, symbolic names can be used instead of numbers. The list of known type names is shown by the command

```
  ebtables --help ip6
```

This option is only valid for --ip6-prococol ipv6-icmp.

### limit
This module matches at a limited rate using a token bucket filter. A rule using this extension will match until this limit is reached. It can be used with the --log watcher to give limited logging, for example. Its use is the same as the limit match of iptables.

--limit [value]

Maximum average matching rate: specified as a number, with an optional /second, /minute, /hour, or /day suffix; the default is 3/hour.

--limit-burst [number]

Maximum initial number of packets to match: this number gets recharged by one every time the limit specified above is not reached, up to this number; the default is 5.

### mark_m
--mark [!] [value][/mask]

Matches frames with the given unsigned mark value. If a value and mask are specified, the logical AND of the mark value of the frame and the user-specified mask is taken before comparing it with the user-specified mark value. When only a mark value is specified, the packet only matches when the mark value of the frame equals the user-specified mark value. If only a mask is specified, the logical AND of the mark value of the frame and the user-specified mask is taken and the frame matches when the result of this logical AND is non-zero. Only specifying a mask is useful to match multiple mark values.

### pkttype
--pkttype-type [!] type

Matches on the Ethernet "class" of the frame, which is determined by the generic networking code. Possible values: broadcast (MAC destination is the broadcast address), multicast (MAC destination is a multicast address), host (MAC destination is the receiving network device), or otherhost (none of the above).

### stp
Specify stp BPDU (bridge protocol data unit) fields. The destination address (-d) must be specified as the bridge group address (BGA). For all options for which a range of values can be specified, it holds that if the lower bound is omitted (but the colon is not), then the lowest possible lower bound for that option is used, while if the upper bound is omitted (but the colon again is not), the highest possible upper bound for that option is used.

--stp-type [!] type

The BPDU type (0-255), recognized non-numerical types are config, denoting a configuration BPDU (=0), and tcn, denothing a topology change notification BPDU (=128).

--stp-flags [!] flag

The BPDU flag (0-255), recognized non-numerical flags are topology-change, denoting the topology change flag (=1), and topology-change-ack, denoting the topology change acknowledgement flag (=128).

--stp-root-prio [!] [prio][:prio]

The root priority (0-65535) range.

--stp-root-addr [!] [address][/mask]

The root mac address, see the option -s for more details.

--stp-root-cost [!] [cost][:cost]

The root path cost (0-4294967295) range.

--stp-sender-prio [!] [prio][:prio]

The BPDU's sender priority (0-65535) range.

--stp-sender-addr [!] [address][/mask]

The BPDU's sender mac address, see the option -s for more details.

--stp-port [!] [port][:port]

The port identifier (0-65535) range.

--stp-msg-age [!] [age][:age]

The message age timer (0-65535) range.

--stp-max-age [!] [age][:age]

The max age timer (0-65535) range.

--stp-hello-time [!] [time][:time]

The hello time timer (0-65535) range.

--stp-forward-delay [!] [delay][:delay]

The forward delay timer (0-65535) range.

### vlan
Specify 802.1Q Tag Control Information fields. The protocol must be specified as 802_1Q (0x8100).

--vlan-id [!] id

The VLAN identifier field (VID). Decimal number from 0 to 4095.

--vlan-prio [!] prio

The user priority field, a decimal number from 0 to 7. The VID should be set to 0 ("null VID") or unspecified (in the latter case the VID is deliberately set to 0).

--vlan-encap [!] type

The encapsulated Ethernet frame type/length. Specified as a hexadecimal number from 0x0000 to 0xFFFF or as a symbolic name from /etc/ethertypes.

### WATCHER EXTENSIONS
Watchers only look at frames passing by, they don't modify them nor decide to accept the frames or not. These watchers only see the frame if the frame matches the rule, and they see it before the target is executed.

### log
The log watcher writes descriptive data about a frame to the syslog.

--log

Log with the default loggin options: log-level= info, log-prefix="", no ip logging, no arp logging.

--log-level level

Defines the logging level. For the possible values, see ebtables -h log. The default level is info.

--log-prefix text

Defines the prefix text to be printed at the beginning of the line with the logging information.

--log-ip

Will log the ip information when a frame made by the ip protocol matches the rule. The default is no ip information logging.

--log-ip6

Will log the ipv6 information when a frame made by the ipv6 protocol matches the rule. The default is no ipv6 information logging.

--log-arp

Will log the (r)arp information when a frame made by the (r)arp protocols matches the rule. The default is no (r)arp information logging.

### nflog
The nflog watcher passes the packet to the loaded logging backend in order to log the packet. This is usually used in combination with nfnetlink_log as logging backend, which will multicast the packet through a netlink socket to the specified multicast group. One or more userspace processes may subscribe to the group to receive the packets.

--nflog

Log with the default logging options

--nflog-group nlgroup

The netlink group (1 - 2^32-1) to which packets are (only applicable for nfnetlink_log). The default value is 1.

--nflog-prefix prefix

A prefix string to include in the log message, up to 30 characters long, useful for distinguishing messages in the logs.

--nflog-range size

The number of bytes to be copied to userspace (only applicable for nfnetlink_log). nfnetlink_log instances may specify their own range, this option overrides it.

--nflog-threshold size

Number of packets to queue inside the kernel before sending them to userspace (only applicable for nfnetlink_log). Higher values result in less overhead per packet, but increase delay until the packets reach userspace. The default value is 1.

### ulog
The ulog watcher passes the packet to a userspace logging daemon using netlink multicast sockets. This differs from the log watcher in the sense that the complete packet is sent to userspace instead of a descriptive text and that netlink multicast sockets are used instead of the syslog. This watcher enables parsing of packets with userspace programs, the physical bridge in and out ports are also included in the netlink messages. The ulog watcher module accepts 2 parameters when the module is loaded into the kernel (e.g. with modprobe): nlbufsiz specifies how big the buffer for each netlink multicast group is. If you say nlbufsiz=8192, for example, up to eight kB of packets will get accumulated in the kernel until they are sent to userspace. It is not possible to allocate more than 128kB. Please also keep in mind that this buffer size is allocated for each nlgroup you are using, so the total kernel memory usage increases by that factor. The default is 4096. flushtimeout specifies after how many hundredths of a second the queue should be flushed, even if it is not full yet. The default is 10 (one tenth of a second).

--ulog

Use the default settings: ulog-prefix="", ulog-nlgroup=1, ulog-cprange=4096, ulog-qthreshold=1.

--ulog-prefix text

Defines the prefix included with the packets sent to userspace.

--ulog-nlgroup group

Defines which netlink group number to use (a number from 1 to 32). Make sure the netlink group numbers used for the iptables ULOG target differ from those used for the ebtables ulog watcher. The default group number is 1.

--ulog-cprange range

Defines the maximum copy range to userspace, for packets matching the rule. The default range is 0, which means the maximum copy range is given by nlbufsiz. A maximum copy range larger than 128*1024 is meaningless as the packets sent to userspace have an upper size limit of 128*1024.

--ulog-qthreshold threshold

Queue at most threshold number of packets before sending them to userspace with a netlink socket. Note that packets can be sent to userspace before the queue is full, this happens when the ulog kernel timer goes off (the frequency of this timer depends on flushtimeout).

### arpreply
The arpreply target can be used in the PREROUTING chain of the nat table. If this target sees an ARP request it will automatically reply with an ARP reply. The used MAC address for the reply can be specified. The protocol must be specified as ARP. When the ARP message is not an ARP request or when the ARP request isn't for an IP address on an Ethernet network, it is ignored by this target (CONTINUE). When the ARP request is malformed, it is dropped (DROP).

--arpreply-mac address

Specifies the MAC address to reply with: the Ethernet source MAC and the ARP payload source MAC will be filled in with this address.

--arpreply-target target

Specifies the standard target. After sending the ARP reply, the rule still has to give a standard target so ebtables knows what to do with the ARP request. The default target is DROP.

### dnat
The dnat target can only be used in the BROUTING chain of the broute table and the PREROUTING and OUTPUT chains of the nat table. It specifies that the destination MAC address has to be changed.

--to-destination address

Change the destination MAC address to the specified address. The flag --to-dst is an alias for this option.

--dnat-target target

Specifies the standard target. After doing the dnat, the rule still has to give a standard target so ebtables knows what to do with the dnated frame. The default target is ACCEPT. Making it CONTINUE could let you use multiple target extensions on the same frame. Making it DROP only makes sense in the BROUTING chain but using the redirect target is more logical there. RETURN is also allowed. Note that using RETURN in a base chain is not allowed (for obvious reasons).

### mark
The mark target can be used in every chain of every table. It is possible to use the marking of a frame/packet in both ebtables and iptables, if the bridge-nf code is compiled into the kernel. Both put the marking at the same place. This allows for a form of communication between ebtables and iptables.

--mark-set value

Mark the frame with the specified non-negative value.

--mark-or value

Or the frame with the specified non-negative value.

--mark-and value

And the frame with the specified non-negative value.

--mark-xor value

Xor the frame with the specified non-negative value.

--mark-target target

Specifies the standard target. After marking the frame, the rule still has to give a standard target so ebtables knows what to do. The default target is ACCEPT. Making it CONTINUE can let you do other things with the frame in subsequent rules of the chain.

### redirect
The redirect target will change the MAC target address to that of the bridge device the frame arrived on. This target can only be used in the BROUTING chain of the broute table and the PREROUTING chain of the nat table. In the BROUTING chain, the MAC address of the bridge port is used as destination address, in the PREROUTING chain, the MAC address of the bridge is used.

--redirect-target target

Specifies the standard target. After doing the MAC redirect, the rule still has to give a standard target so ebtables knows what to do. The default target is ACCEPT. Making it CONTINUE could let you use multiple target extensions on the same frame. Making it DROP in the BROUTING chain will let the frames be routed. RETURN is also allowed. Note that using RETURN in a base chain is not allowed.

### snat
The snat target can only be used in the POSTROUTING chain of the nat table. It specifies that the source MAC address has to be changed.

--to-source address

Changes the source MAC address to the specified address. The flag --to-src is an alias for this option.

--snat-target target

Specifies the standard target. After doing the snat, the rule still has to give a standard target so ebtables knows what to do. The default target is ACCEPT. Making it CONTINUE could let you use multiple target extensions on the same frame. Making it DROP doesn't make sense, but you could do that too. RETURN is also allowed. Note that using RETURN in a base chain is not allowed.

--snat-arp

Also change the hardware source address inside the arp header if the packet is an arp message and the hardware address length in the arp header is 6 bytes.

## FILES
/etc/ethertypes /var/lib/ebtables/lock

## ENVIRONMENT VARIABLES
EBTABLES_ATOMIC_FILE

## MAILINGLISTS
See http://netfilter.org/mailinglists.html

## SEE ALSO
iptables(8), brctl(8), ifconfig(8), route(8)

See http://ebtables.sf.net


edac-ctl

package: edac-utils

title: edac-ctl(8)

summary: EDAC admin utility

text:
# edac-ctl(8)

## NAME
edac-ctl - EDAC admin utility

## SYNOPSIS
edac-ctl [OPTION]...

## DESCRIPTION
The edac-ctl program is a perl(1) script which performs some useful administration tasks for EDAC (Error Detection and Correction) drivers.

## OPTIONS
--help

Display a brief usage message.

--mainboard

Print mainboard vendor and model for this hardware, if available. This option requires that the dmidecode(8) utility be installed, and must be run as root.

--status

Print the status of EDAC drivers (loaded or unloaded).

--register-labels

Register motherboard DIMM labels into EDAC driver sysfs files. This option uses the detected mainboard manufacturer and model number in combination with a "labels database" found in any of the files under /etc/edac/labels.d/* or in the labels.db file at /etc/edac/labels.db. An entry for the current hardware must exist in the labels database for this option to do anything.

--print-labels

Display the configured labels for the current hardware, as well as the current labels registered with EDAC.

--labeldb=DB

Specify an alternate location for the labels database.

## SEE ALSO
edac(3), edac-util(1)


efibootdump

package: efibootmgr

title: efibootdump(8)

text:
# efibootdump(8)

## NAME
efibootdump - dump a boot entries from a variable or a file

## SYNOPSIS
efibootdump [-?|--help] [--usage]

[-f <file1> [... -f <fileN>]]

[[-g {guid}] <name0> [... [<nameN>]]]

## DESCRIPTION
efibootdump is a userspace application used to display individual UEFI boot options, from a file or a UEFI variable. This allows e.g. saved files from efivarfs to be displayed, as well as variables on the running machine.

## OPTIONS
The following is a list of options accepted by efibootmgr:

-g | --guid {guid}

Any variables specified by name have the specified GUID.

-f | --file <file>

Read a single boot variable from the specified file.

<nameN>

Display the specified variable on the local machine. If no GUID is specified, EFI Global Variable is the default.

## BUGS
Please direct any bugs, features, patches, etc. to the Red Hat bootloader team at https://github.com/rhboot/efibootmgr .

## SEE ALSO
efibootmgr(8)


efibootmgr

title: efibootmgr(8)

text:
# efibootmgr(8)

## NAME
efibootmgr - change the UEFI Boot Manager configuration

## SYNOPSIS
efibootmgr [ -a ] [ -A ] [ -b XXXX ] [ -B ] [ -c ] [ -d DISK ] [ -D ] [ -e 1|3|-1 ] [ -E NUM ] [ --full-dev-path | --file-dev-path ] [ -f ] [ -F ] [ -g ] [ -i NAME ] [ -l NAME ] [ -L LABEL ] [ -m t|f ] [ -M X ] [ -n XXXX ] [ -N ] [ -o XXXX,YYYY,ZZZZ ... ] [ -O ] [ -p PART ] [ -q ] [ -r | -y ] [ -t seconds ] [ -T ] [ -u ] [ -v ] [ -V ] [ -w ] [ -@ file ]

## DESCRIPTION
efibootmgr is a userspace application used to modify the UEFI Boot Manager. This application can create and destroy boot entries, change the boot order, change the next running boot option, and more.

Details on the UEFI Boot Manager are available from the UEFI Specification, v1.02 or later, available from: http://www.uefi.org

Note: efibootmgr requires that the kernel support access to EFI non-volatile variables through /sys/firmware/efi/vars or /sys/firmware/efi/efivars/.

## OPTIONS
The following is a list of options accepted by efibootmgr:

-a | --active

Set bootnum active.

-A | --inactive

Set bootnum inactive.

-b | --bootnum XXXX

Modify BootXXXX (hex).

-B | --delete-bootnum

Delete bootnum.

-c | --create

Create new variable bootnum and add to bootorder.

-C | --create-only

Create new variable bootnum and and do not add to bootorder.

-d | --disk DISK

The disk containing the loader (defaults to /dev/sda).

-D | --remove-dups

Remove duplicated entries from BootOrder.

-e | --edd 1|3

Force EDD 1.0 or 3.0 creation variables. Use -e 1 together with -E if you are using a very old system which uses UEFI to boot, but requires legacy CSM (BIOS) device drivers for storage devices.

-e 3 is now deprecated, and is an alias for --full-dev-path.

-E | --edd-device NUM

EDD 1.0 device number (defaults to 0x80). See --edd.

--full-dev-path

Force creation of boot entries use a full UEFI device path, starting at the PCIe root or equivalent on the current platform. The default is to use a hard disk based HD() abbreviated path. You shouldn't need to use this option unless the system firmware won't boot off of your device using an abbreviated HD() device path.

Note that forcing a full path will fail if we don't know what the system device root is, how the specified device is connected to it, or how to encode any one of those.

--file-dev-path

Force creation of boot entries use an abbreviated UEFI device path which starts with the File() portion of the path. The default is to use a hard disk based HD() abbreviated path.

-f | --reconnect

Re-connect devices after driver is loaded. Only applicable for driver entries.

-F | --do-not-reconnect

Do not reconnect devices after driver is loaded. Only applicable for driver entries.

-g | --gpt

Force disk with invalid PMBR to be treated as GPT.

-i | --iface NAME

Create a netboot entry for the named interface.

-k | --keep NAME

Keep old entries when adjusting order.

-l | --loader NAME

Specify a loader (defaults to \EFI\altlinux\grub.efi).

-L | --label LABEL

Boot manager display label (defaults to "Linux").

-m | --mirror-below-4G t|f

Set t if you want to mirror memory below 4GB.

-M | --mirror-above-4G X

X percentage memory to mirror above 4GB. Floating-point value with up to 2 decimal places is accepted.

-n | --bootnext XXXX

Set BootNext to XXXX (hex).

-N | --delete-bootnext

Delete BootNext.

-o | --bootorder XXXX,YYYY,ZZZZ

Explicitly set BootOrder (hex). Any value from 0 to FFFF is accepted so long as it corresponds to an existing Boot#### variable, and zero padding is not required.

-O | --delete-bootorder

Delete BootOrder.

-p | --part PART

Partition number containing the bootloader (defaults to 1).

-q | --quiet

Quiet mode - suppresses output.

-r | --driver

Operate on Driver#### variables instead of Boot#### variables.

-t | --timeout seconds

Boot Manager timeout, in seconds.

-T | --delete-timeout

Delete Timeout variable.

-u | --unicode | --UCS-2

Handle extra command line arguments as UCS-2 (default is ASCII).

-v | --verbose

Verbose mode - prints additional information.

-V | --version

Just print version string and exit.

-w | --write-signature

Write unique signature to the MBR if needed.

-y | --sysprep

Operate on SysPrep#### variables instead of Boot#### variables.

-@ | --append-binary-args

Append extra variable args from file (use - to read from stdin). Data in file is appended as command line arguments to the boot loader command, with no modification to the data, so you can pass any binary or text data necessary.

## EXAMPLES

### Displaying the current settings (must be root):

```
[root@localhost ~]# efibootmgr
BootCurrent: 0004
BootNext: 0003
BootOrder: 0004,0000,0001,0002,0003
Timeout: 30 seconds
Boot0000* Diskette Drive(device:0)
Boot0001* CD-ROM Drive(device:FF)
Boot0002* Hard Drive(Device:80)/HD(Part1,Sig00112233)
Boot0003* PXE Boot: MAC(00D0B7C15D91)
Boot0004* Linux
```

Each of the above are boot variables, which are defined as follows:

•

BootCurrent - the boot entry used to start the currently running system

•

BootOrder - the boot order as would appear in the boot manager. The boot manager tries to boot the first active entry in this list. If unsuccessful, it tries the next entry, and so on.

•

BootNext - the boot entry which is scheduled to be run on next boot. This supersedes BootOrder for one boot only, and is deleted by the boot manager after first use. This allows you to change the next boot behavior without changing BootOrder.

•

Timeout - the time in seconds between when the boot manager appears on the screen until when it automatically chooses the startup value from BootNext or BootOrder.

•

Five boot entries (0000 - 0004), along with the active/inactive flag (* means active) and the name displayed on the screen.

### Creating a new boot option
An OS installer would call efibootmgr -c. This assumes that /dev/sda1 is your EFI System Partition, and is mounted at /boot/efi. This creates a new boot option, called "Linux", and puts it at the top of the boot order list. Options may be passed to modify the default behavior. The default OS Loader is \EFI\altlinux\grub.efi.

### Changing the boot order
Assuming the configuration in the first example, efibootmgr -o 3,4 could be called to specify PXE boot first, then Linux boot.

### Changing the boot order for the next boot only
Assuming the configuration in the first example, efibootmgr -n 4 could be called to specify that the Linux entry be taken on next boot.

### Deleting a boot option
Assuming the configuration in the first example, efibootmgr -b 4 -B could be called to delete entry 4 and remove it from the BootOrder.

### Creating network boot entries
A system administrator wants to create a boot option to network boot. You create the boot entry with: efibootmgr -c -i eth0 -L netboot [ -l '\filename.efi' ]

## BUGS
Please direct any bugs, features, patches, etc. to the Red Hat bootloader team at https://github.com/rhboot/efibootmgr .

## AUTHOR
This man page was generated by dann frazier <dannf@debian.org> for the Debian GNU/Linux operating system and updated by Robert Bisewski <contact@ibiscybernetics.com>, but may be used by others.

It has subsequently been modified by Robbie Harwood <rharwood@redhat.com> for the efibootmgr project.


ejabberdctl

package: ejabberd

title: ejabberdctl(8)

text:
# ejabberdctl(8)

## NAME
ejabberd Jabber/XMPP server control interface

## SYNOPSIS
ejabberdctl command [options]

## DESCRIPTION
ejabberdctl is a front end to the Apache ejabberd Jabber/XMPP server. It is designed to help the administrator control the functioning of the ejabberd daemon.

## OPTIONS
The command can be any one of the following options:

stop

Stops the ejabberd server.

restart

Restarts the ejabberd server.

reopen-log

Force the ejabberd server to reopen its log file.

register user password

Register user user with password password at the ejabberd server.

unregister user

Unregister user user at the ejabberd server.

backup filepath

Backup user database of the ejabberd server to file filepath.

restore filepath

Restore user database of the ejabberd server from backup file filepath.

install-fallback filepath

Install a backup to filepath as fallback. The fallback will be used to restore the database at the next start-up.

dump filepath

Dump user database of the ejabberd server to text file filepath.

load filepath

Restore user database of the ejabberd server from text file filepath.

registered-users

List all registered at the ejabberd server users.

## SEE ALSO
erl(1), ejabberd(8), mnesia(3).

The program documentation is available at http://ejabberd.jabberstudio.org/. A copy of the documentation can be found at /usr/share/doc/ejabberd/html/guide.html.

## AUTHORS
This manual page was adapted by Sergei Golovan <sgolovan@nes.ru> for the Debian system (but may be used by others) from the ejabberd documentation written by Alexey Shchepin <alexey@sevcom.net>.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 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.


encled

package: encled

title: encled(8)

text:
# encled(8)

## NAME
encled - SCSI Enclosure indicators (SES LED) control

## SYNOPSIS
encled [--help] [enslosure/slot|disk name|ALL] [locate|fault|off]

## DESCRIPTION
Encled uses information in sysfs from ses.ko module to enumerate and control enclosure indication for disks.

SES is SCSI Enclosure Services, specialized protocol between enclosure (backplane) and HBA (controller). It allows to enable/disable indication on hot-swap slots for disks.

## INDICATION TYPES
There is two types of indication: fault and locate. Third indication (activity) unavailable for control from host. If one indicator is enabled, other is automatically disabled. Keywords used: 'fault', 'locate' and 'off'.

## ENUMERATION
Enclosure enumeration is based on /sys/class/enclosure, and slot number is reconstructed from 'Slot' name of enclosure. Usually it looks like this: 6:0:23:0/14, where: 6:0:23:0 is enclosure address, and '/14' is 14th slot. Note: Enumeration in encled may differ from sas2ircu or labels on the actual backplane. Don't rely on the slot numbers!

## DISK NAME
There is two ways to indicate disk in encled: by using drive name (/dev/sdaz) or by using slot number (6:0:24:0/20). Special word 'all' is reserved for controlling all indication (command 'encled all off' clears all indication).

## EXAMPLES
encled /dev/sda fault - enable fault indication for /dev/sda

encled /dev/sdfa locate - enable locate indication for /dev/sdfa

encled /dev/sdz off - clear indication for /dev/sdz

encled /dev/sdg - view status of indication for /dev/sdg

encled 3:0:23:0/1 fault - enable fault indication for the Slot 1 in enclosure 3:0:23:0

encled 3:0:23:0/2 locate - enable locate indication for the Slot 2 in enclosure 3:0:23:0

encled 3:0:23:0/3 off - clear inication for the Slot 3 in enclosure 3:0:23:0

encled 3:0:23:0/4 - view status of indication for the Slot 4 in enclosure 3:0:23:0

encled all fault - enable fault inidcation for all slots in all enclosures

encled - view status of all slots in all enclosures.

Example of the output:

ENCLOSURE/SLOT DEV FAULT_LED LOCATION_LED

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

6:0:23:0/1 sdd fault_off locate_off

6:0:23:0/2 sde fault_off locate_off

6:0:23:0/3 sdf fault_off LOCATE_ON

6:0:23:0/4 sdg FAULT_ON locate_off

## NOTES
Encled supports only enclosure based devices (SAS/SATA). Desktop SATA controllers (AHCI), and direct-attach disks in SCSI are not supported.

Older name for encled was sdled.

## AUTHOR
Written by George Shuklin

## REPORTING BUGS
Report bugs to https://github.com/amarao/sdled

## COPYRIGHT
Copyright © 2012-2015 George Shuklin

This software is distributed under the GPL version 2 or 3. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


espeakup

package: espeakup

title: espeakup(8)

summary: connect Speakup to the espeak\-ng TTS engine

text:
# espeakup(8)

## NAME
espeakup - connect Speakup to the espeak-ng TTS engine

## SYNOPSIS
espeakup [--pid-path=path] [--alsa-volume] [--default-voice=[voicename]] [--debug] [--help] [--version]

## OPTIONS
-P path, --pid-path=path

Set the full path for the pid file espeakup uses when in daemon mode.

--alsa-volume

Drive the ALSA volume. useful for live environments where volume adjustments maybe impossible.

-V voicename, --default-voice=voicename

Set the espeak-ng voice to be used by default.

-d, --debug

run in the foreground, rather than becoming a daemon process.

-h, --help

display a brief help message and exit.

-v, --version

output version information and exit.

## DESCRIPTION
espeakup bridges the gap between two tools: the Speakup screen review system and the espeak-ng text-to-speech engine. Each of these tools performs a well-defined task.

Speakup is a kernel-based screen reader for the Linux console. It extracts and processes the text that is displayed on the foreground virtual console. It supports several hardware based speech synthesizers directly. However, since it is in kernel space, it cannot support a software speech synthesizer directly since these are in user space.

espeak-ng is a popular software speech synthesizer. It is small, light weight, very responsive, and supports multiple languages. espeakup is a connector which will read text sent to it by speakup and forward it to espeak-ng. This allows Speakup to use espeak-ng as its speech synthesizer.

espeakup is a daemon. Typically, it is started at boot time, and it terminates when the system is halted or rebooted. It should be started by the system´s init scripts. This process varies among Linux distributions, but the details are usually managed by the person who packaged espeakup for your distribution. From the perspective of an average user, espeakup´s operation is invisible.

## BUGS
If you find a bug, please create a github issue https://github.com/linux-speakup/espeakup/issues You might also consider mentioning it on the mailing list for the Speakup screenreader. Visit list page https://linux-speakup.org/cgi-bin/mailman/listinfo/speakup to learn more about the mailing list.

## SEE ALSO
For more information about Speakup, visit its homepage https://linux-speakup.org.

espeak-ng can be found at github https://github.com/espeak-ng/espeak-ng

## AUTHOR
William Hubbs w.d.hubbs@gmail.com is the author of espeakup.

This manual page was written by Chris Brannon cmbrannon79@gmail.com.

current authors and maintainers can be found at github https://github.com/linux-speakup/espeakup/graphs/contributors


etckeeper

package: etckeeper

title: etckeeper(8)

text:
# etckeeper(8)

## NAME
etckeeper - store /etc in git, mercurial, bazaar, or darcs

## SYNOPSIS
etckeeper command [-d directory]

## DESCRIPTION
etckeeper manages /etc be stored in a git, mercurial, bazaar, or darcs repository. By default each of the commands operates on /etc, but a different directory can be specified to operate on a clone of the /etc repository located elsewhere.

## COMMANDS
init

This initialises and sets up a git, mercurial, bazaar, or darcs repository (depending on the VCS setting in /etc/etckeeper/etckeeper.conf). Typically this is run in /etc once when starting to use etckeeper on a machine. It can also be used to initialise a clone of the /etc repository located elsewhere.

commit [message]

Commits all changes in /etc to the repository. A commit message can be specified. You may also use the underlying VCS to commit manually. (Note that etckeeper commit will notice if a user has used sudo or su to become root, and record the original username in the commit.)

pre-commit

This is called as a pre-commit hook. It stores metadata and does sanity checks.

pre-install

This is called by apt's RPM::Pre-Install-Pkgs hook, or by equivilant hooks of other package managers. It allows committing any uncommitted changes before packages are installed, upgraded, etc.

post-install

This is called by apt's RPM::Post-Invoke hook, or by equivilant hooks of other package managers. It commits changes made by packages into the repository. (You can also call this by hand after running apt/rpm by hand.)

unclean

This returns true if the directory contains uncommitted changes.

update-ignore [-a]

This updates the VCS ignore file. Content outside a "managed by etckeeper" block is not touched. This is generally run when upgrading to a new version of etckeeper. (The -a switch will add a "managed by etckeeper" block if one is not present.)

vcs subcommand [options ...]

You can use this to run any subcommand of the VCS that etckeeper is configured to run. It will be run in /etc. For example, "etckeeper vcs diff" will run "git diff", etc.

uninit [-f]

This command DESTROYS DATA! It is the inverse of the init command, removing VCS information and etckeeper's own bookkeeping information from the directory. Use with caution. A typical use case would be to run etckeeper uninit, then modify etckeeper.conf to use a different VCS, and then run etckeeper init. (The -f switch can be used to force uninit without prompting.)

## FILES
/etc/etckeeper/etckeeper.conf is the configuration file.

/etc/etckeeper also contains directories containing the programs that are run for each of the above commands.

## ENVIRONMENT VARIABLES
ETCKEEPER_CONF_DIR path to configuration directory instead of default /etc/etckeeper.

## SEE ALSO
/usr/share/doc/etckeeper/README.md.gz

## AUTHOR
Joey Hess <id@joeyh.name>


etcnet

package: etcnet

title: etcnet(8)

text:
# etcnet(8)

## NAME
/etc/net - basic and advanced network configuration in Linux

## SYNOPSIS
ifup <interface>

ifdown <interface>

service network <start|stop|restart|reload...>

## DESCRIPTION
/etc/net is a network configuration system. It should be both simple to use for a beginner and powerful for expert. First of all you have to describe your network options and interfaces in a set of configuration files. Once you are done, you should be able to control state of your host with 3 scripts: ifup, ifdown, network.init.

## SYSTEM CONFIGURATION
/etc/net ships in default configuration, which is suitable for many cases. Linux distributions can customize default installation even further, but there are things that only you can configure. /etc/net keeps its configuration in files, most of which reside in /etc/net (literally) directory.

/etc/net/options.d

This directory by default keeps 00-default file. There can be other files here, they will be read in alphabet order.

/etc/net/sysctl.conf

sysctl startup file

/etc/net/ipv4rule ???

ip rules startup table ('ip -4 rule add' args)

/etc/net/vlantab

VLAN mass-configuration table. If you need to configure lots of simple VLAN interfaces, this is the right place. See VLANTAB SYNTAX for details.

/etc/net/hosttab

This optional file can be used during MULTIHOST CONFIGURATION.

/etc/net/ifup-pre-local

If exists and is executable, is run before ANY interface is up, but after it is created.

/etc/net/ifup-post-local

If exists and is executable, is run after ANY interface is completely up and running.

/etc/net/ifdown-pre-local

If exists and is executable, is run before ANY interface is going to be shutdown.

/etc/net/ifdown-post-local

If exists and is executable, is run after ANY interface is completely gone.

/etc/net/netup-pre

If exists and is executable, is run before starting network.

/etc/net/netup-post

If exists and is executable, is run after starting network.

/etc/net/netdown-pre

If exists and is executable, is run before stopping network.

/etc/net/netdown-post

If exists and is executable, is run after stopping network.

## INTERFACE CONFIGURATION
To complete interface configuration one should perform the following steps for each network interface found at Linux host:

Create interface configuration directory /etc/net/ifaces/<NAME>

Fill it with configuration files accordingly to INTERFACE DIRECTORY LAYOUT.

## INTERFACE GROUPS
There are 5 interface groups in /etc/net model:

virtual

Self-consistent interfaces, currently loopback and dummy. They very seldom require other interfaces and require no hardware, therefore chances are high to bring them up.

real physical

Interfaces, corresponding to real hardware: pure Ethernet, PLIP, USB Ethernet adapters and DVB. You cannot bring them up, if there is no hardware present.

hosted physical

Something between physical and logical type. This group includes: VLAN, bonding, bridges and traffic equalizers. These interfaces don't directly use hardware, but are built from one ore more 'host' real physical interfaces. If host interface is missing, hosted interfaces can't be brought up.

independent logical

This group includes IP and IPSec tunnels. Tunnels are stateless, they are much like virtual group, but sometimes they depend on lower-level interfaces indirectly.

dependent logical

This group currently consists of PPP interfaces, including PPPoE/PPtP ones. Their well known property is to disconnect on timeouts, so this group has the most chances to fail.

When network is being started, /etc/net puts interfaces in appropriate group and processes groups from virtual to dependent logical. When network is being stopped, groups are processed in reverse order. This order results in less failures, than simple processing from A to Z. You don't have to specify interface group anywhere, it is computed from interface type.

## INTERFACE DIRECTORY LAYOUT
Unless explicitly stated, each configuration file contains 1 item per line (options, addresses, routes etc.). You have to create files for each feature you want to use. If file is missing, the feature will not be configured.

options

Main options file. This file is required. See etcnet-options manpage for list of options available.

iplink

List of 'ip link' commands. If you need to change interface MTU or PROMISC flag, this is the right place to do it. If you want to to have a specific MAC address on the board, you can place "address xx:xx:xx:xx:xx:xx" into this file. This file is not required.

ipneigh

List of 'ip ne' commands, can be used to control ARP table, e.g. add static ARP entries. This file is not required.

ipv4address

List of IPv4 addresses for current interface. This file is not required, but often used.

ipv4route

List of IPv4 routes for current interface. This file is not required, but often used.

ipv4rule

List of IPv4 routing rules for current interface. You will need this file only if you install routes into multiple routing tables. This file is not required.

ipv6address

List of IPv6 addresses for current interface. This file is not required.

ipv6route

List of IPv6 routes for current interface. This file is not required.

iwconfig

List of iwconfig commands. This file is only required for WiFi WEP.

wpa_supplicant.conf

wpa_supplicant configuration file. This file is only required for WiFi WPA.

bridge

List of bridge commands. This file is only used by bridges and is not required.

ethtool

List of ethtool commands. This file is only useful for Ethernet interfaces and is not required.

ipxinterface

List of 'ipx_interface add' arguments. This file is required for IPX interfaces.

sysctl.conf

List of sysctl options, which will be processed after interface is up. Lookup SMART SYSCTL SUPPORT. This file is optional.

resolv.conf

Resolver configuration. This file will be copied to /etc/resolv.conf after interface is up. This file is optional.

ifup-pre

If exists and is executable, is run before CURRENT interface is up, but after it is created.

ifup-post

If exists and is executable, is run after CURRENT interface is completely up and running.

ifdown-pre

If exists and is executable, is run before CURRENT interface is going to be shutdown.

ifdown-post

If exists and is executable, is run after CURRENT interface is completely gone.

pppoptions

This optional file contains additional pppd options for PPP interfaces.

pppinit

This optional file contains chat (not shell) script for modem initialization.

pppconnect

This optional file contains chat (not shell) script to connect to remote node (e.g. dial a number).

pppdisconnect

This optional file contains chat (not shell) script to disconnect from remote node (e.g. hang up).

l2tptunnel

This file contains options to establish L2TP tunnel. This options are directly passed to l2tpconfig command.

l2tpsession

This file contains options to establish L2TP session. This options are directly passed to l2tpconfig command.

The interface directory can contain 2 special directories: 'fw' and 'qos'. They are used for firewall and QoS configuration respectively. For QoS configuration manual see etcnet-qos(8).

## SPECIAL INTERFACES
/etc/net is shipped with 3 existing interfaces:

lo

This is a must for a Linux host. Loopback interface comes in configuration, suitable for most cases.

default

This is really not an interface, but interface template. 'default' interface forms initial set of options for all interfaces and it doesn't belong to any interface group. This interface allows placing an additional options file into configuration directory: options-<TYPE>. This optional file has effect ONLY for 'default' interface, it allows to override default options with type-specific options. It is not recommended to change options for 'default' interface. Each interface can add extra options or override existing options, if needed.

unknown

This is a special interface, which is used each time /etc/net can't find a suitable configuration, but is requested to do. This interface's purpose is to help configure hotplug interfaces, which don't yet have a configuration.

## SMART SYSCTL SUPPORT
/etc/net handles several sysctl.conf files:

/etc/net/sysctl.conf

Processed at startup, no autoprefix.

/etc/net/ifaces/default/sysctl.conf

Processed at ifup, no autoprefix.

/etc/net/ifaces/default/sysctl.conf-$TYPE

Processed at ifup, with autoprefix.

/etc/net/ifaces/XXXXXX/sysctl.conf

Processed at ifup, with autoprefix.

Autoprefix means that if fully specified variables (like in a traditional /etc/sysctl.conf file) is met, it will be processed as is, but for single word variables like rp_filter or forwarding appropriate prefix will be tried to find. Autoprefix works only for interface sysctl.conf and type-specific sysctl.conf.

## RECURSION AND DEPENDENCIES
Some interfaces require other interfaces to be up for proper initialization. Some dependencies are calculated automaticaly, but some need to be configured manually. If interface A has REQUIRES=B in it's options file, A is the child, B is the parent. There are 6 options to control dependencies resolution:

HOST=<interface>

REQUIRES='<interface> [<interface> [<interface>...]]'

IFUP_PARENTS=<boolean>

IFDOWN_PARENTS=<boolean>

IFUP_CHILDREN=<boolean>

IFDOWN_CHILDREN=<boolean>

Those options are described in etcnet-options(5) manpage. NOTE: Interfaces from vlantab bypass traditional logic, they can't cause parent/child interface to become up/down. If parent interface is down at the moment of vlantab processing (ONBOOT=no or misconfiguration), all child VLAN interfaces will be just skipped.

In most cases (if ever) the task will be done by proper REQUIRES option.

## VLANTAB SYNTAX
vlantab provides a way to bulk-configure VLAN interfaces with only IPv4 address at each interface. For each VLAN interface you have to place a line:

<host interface> <VLAN ID>

Create VLAN interface and automatically name it according to VLAN_NAMETYPE option value.

<host interface> <VLAN ID> <VLAN interface name>

Create VLAN interface with specified name.

<host interface> <VLAN ID> <VLAN interface name> <'ip address' arguments>

Create VLAN interface with specified name and run 'ip address' with specified arguments.

## HOSTTAB SYNTAX
This file holds aliases for hostnames. If your hostname is long or unconvinient, you can define an alias here. This alias can be used for tagging files. One hostname should be referenced by one alias only. File format:

```
<hostname1><space><alias1>
<hostname2><space><alias2>
<hostname3><space><alias3>
<hostname4><space><alias4>
<hostname5><space><alias5>
```

## FILENAMES (FIXME)
/etc/net scripts implement support for separate namespaces in a single configuration tree. This is achieved though special suffixes, which are used depending on current values of network profile and network host.

## CONFIGURATION PROFILES
A profile is a configuration superset. E.g. when a notebook boots up in several different networks, it's desirable to select current configuration by just one parameter. Current profile name can be set via:

1. environment variable NETPROFILE (not a good idea I guess)

2. file /etc/net/profile (file should contain just one word, e.g. "office" w/o quotes)

3. kernel boot parameter "netprofile", e.g. "LILO: linux netprofile=home"

Specifying a profile does nothing by default. But if etcnet scripts know the current profile name (e.g. "home") and look for a configuration file (e.g. "options") and "options#home" exists, then "options#home" will be used instead of "options". The same for ipv4address, ipv4route, ipv4rule, ipv6address, iplink and so on).

Now if you want to boot the same host in two different networks, you will most probably have to create additional ipv4address#yourprofilename for another address and ipv4route#yourprofilename for another default route. Same for resolv.conf, I guess.

Next example: booting two different hosts from the same HDD (root fs). The same as previous, but additional options#yourprofilename for the different network card.

To switch between configurations without editing /etc/net/profile one can use:

\# service network startwith office

\# service network restartwith home

If 'selectprofile' executable script exists in iface directory, it will be run with a single argument, which defines current stage of (de)configuration sequence. If you want to override current profile name during runtime, you should perform required actions in this script and print profile name to stdout. Since this script will be run several times and runtime detection can take certain time to complete, it is advised that the script should perform actions only at certain stages. 'selectprofile' will always get calling script name as the first parameter, so you can skip trying to detect wireless AP before the kernel module is even loaded, for example. See /etc/net/ifaces/default/selectprofile for sample implementation.

As of /etc/net-0.5.3 init_netprofile is called only from {ifup,ifdown}.*, {setup,shutdown}-.* and network.init scripts.

## MULTIHOST CONFIGURATION (FIXME)
You can create a single configuration tree and distribute it across multiple hosts. If you mark

## ENVIRONMENT
NETHOST

This variable can hold host ID in multi-host configuration, which should be used instead of automatically detected.

NETPROFILE

This variable can hold configuration profile name, which should be used instead of automatically detected.

## BUGS
Some kernels have problems with many VLAN interfaces.

teql interfaces can't be safely renamed.

VLAN interfaces sometimes are initialized into wrong state.

ppp interfaces can only be named ppp%d.

SkyStar DVB interfaces can only be named dvb*.

DHCP does not work for bonding.

ppp option 'demand' can hang /etc/net startup forever

CONFIG_IPV6 must be on to configure 6-to-4 (TYPE=iptun, TUNTYPE=sit) tunnels correctly

If you configure dummy interfaces, 'dummy0' interface name must be always unused.

Bonding interface name can't be same as another kernel module name.

## SEE ALSO
ip(8), tc(8), etcnet-options(5), etcnet-qos(8), etcnet-fw(8),


etcnet-qos

title: etcnet-qos(8)

text:
# etcnet-qos(8)

## NAME
/etc/net QoS support manual

## DESCRIPTION
General rules:

1. Classes and qdiscs can contain each other. Typically a class contains a qdisc or one or more subclasses. A qdisc typically contains one ore more classes.

2. Containment is represented by directory tree.

3. Directory must contain one of two files: either 'class' or 'qdisc' so that /etc/net knows the type of each node. The file contains current node parameters.

4. Qdisc handle is it's directory name with ':'.

5. Class classid is the last qdisc seen in the tree plus ':' plus current class's directory name.

6. If current directory contains file 'extra', it's contents will be used when creating children (usually classes). This does not apply to childrens' children.

7. Class dir can contain 'filter' file with filter statements. The filters will belong to parent qdisc and will point to current dir (class), you don't have to specify parent and flowid keywords. If 'extra.filter' file exists, it's contents will be prefixed to each line of 'filter' file.

## SEE ALSO
/etc/net QoS examples: http://etcnet.org/examples/

tc manpage

google://linux+qos

## FILES
qos/1 - root qdisc


etherwake

package: etherwake

title: etherwake(8)

summary: A tool to send a Wake-On-LAN Magic Packet

text:
# etherwake(8)

## NAME
etherwake - A tool to send a Wake-On-LAN "Magic Packet"

## SYNOPSIS
etherwake [options] Host-ID

## DESCRIPTION
This manual page documents the usage of the ether-wake command.

etherwake is a program that generates and transmits a Wake-On-LAN (WOL) "Magic Packet", used for restarting machines that have been soft-powered-down (ACPI D3-warm state). It generates the standard AMD Magic Packet format, optionally with a password included. The single required parameter is a station (MAC) address or a host ID that can be translated to a MAC address by an ethers(5) database specified in nsswitch.conf(5)

## OPTIONS
etherwake needs a single dash ('-') in front of options. A summary of options is included below.

-b

Send the wake-up packet to the broadcast address.

-D

Increase the Debug Level.

-i ifname

Use interface ifname instead of the default "eth0".

-p passwd

Append a four or six byte password to the packet. Only a few adapters need or support this. A six byte password may be specified in Ethernet hex format (00:22:44:66:88:aa) or four byte dotted decimal (192.168.1.1) format. A four byte password must use the dotted decimal format.

-V

Show the program version information.

## EXIT STATUS
This program returns 0 on success. A permission failures (e.g. run as a non-root user) results in an exit status of 2. Unrecognized or invalid parameters result in an exit status of 3. Failure to retrieve network interface information or send a packet will result in an exit status of 1.

## SEE ALSO
arp(8).

## SECURITY
On some non-Linux systems dropping root capability allows the process to be dumped, traced or debugged. If someone traces this program, they get control of a raw socket. Linux handles this safely, but beware when porting this program.

## AUTHOR
The etherwake program was written by Donald Becker at Scyld Computing Corporation for use with the Scyld((Tm)) Beowulf System.