ipcad.conf

package: ipcad

title: ipcad.conf(5)

summary: ipcad configuration file

text:
# ipcad.conf(5)

## NAME
ipcad.conf — ipcad configuration file

## SYNOPSIS
/usr/local/etc/ipcad.conf

## DESCRIPTION
The file /usr/local/etc/ipcad.conf contains configuration information for the ipcad(8) daemon. The ipcad.conf file consists of a series of configuration options describing the interfaces on which ipcad should be listening and other configuration data.

### Global configuration
capture-ports { enable | disable };

Make ipcad account for UDP/TCP ports, IP protocol and ICMP types on a per-interface basis. This setting is relevant for RSH and interactive export methods only. Capturing UDP and TCP is disabled by default to maintain historic RSH output format compatibility. To selectively enable capturing ports on certain interfaces, specify the capture-ports between the appropriate interface configuration statements.

buffers = <number> [{ k | m }] ;

Defines a buffer size to use for transferring the data from the kernel. Using larger buffers may increase the performance by lowering the number of expensive context switches, whereas using smaller values improves responsiveness. NOTE: This option has no effect on NetFlow operation.

### Interface configuration
interface <face> [promisc] [input-only] [netflow-sampled] [netflow-disable] [filter "<pcap_filter>"] ;

Listen on specified interface using BPF or PCAP packet source. (Please refer to the Interface options section below).

interface ulog group <group> [, group <group> ...] [netflow-sampled] [netflow-disable] ;

Use Linux iptables' ULOG interface for packet capturing. You should configure the iptables to forward the packets into the appropriate group:

```
iptables -A OUTPUT -j ULOG --ulog-nlgroup <group>
```

### Interface options:
promisc: Put interface into promiscuous mode. This enables listening for the packets which are not destined for this host and thus ipcad will count and display all the traffic within the local network. Note that the interface might be in promiscuous mode for some other reason.

input-only: Use kernel feature of counting only incoming packets.

NOTE: "input-only" directive must be supported by kernel. Probably, you were noticed about it during the compilation process if it was not supported. FreeBSD 3.x and elder kernels do not support this feature.

netflow-sampled: If the NetFlow export mechanism is used, this option instructs the interface to supply only one out of N packets to the NetFlow accounting code, thus lowering the CPU and memory requirements. The value of N is configured explicitly in a NetFlow configuration section.

NOTE: This option is NOT used to enable NetFlow on the interface, it just modifies the NetFlow behavior on this interface.

netflow-disable: By default, all interfaces are included into NetFlow accounting. This option is used to disable NetFlow accounting on a particular interface.

filter: Install a custom filter on packets instead of basic IP protocol filter. Requires libpcap (even if BPF is being used). May be employed to eliminate CPU overhead on passing unnecessary data between the kernel and user space (by installing the filter directly into the kernel).

### IP aggregation
aggregate <ip>/<masklen> strip <maskbits>;

Aggregate addresses from the specified network (<ip>/<masklen>), by AND'ing with specified mask (<maskbits>). Use of aggregation helps to save memory space and recomendeed for efficiency.

aggregate <port_from>-<port_to> into <port>;

aggregate <port> into <port>;

Aggregate specified UDP/TCP ports range into a given port number. Use of aggregation helps to save memory space and recomendeed for efficiency.

### RSH server configuration
rsh { enable | disable } [at <listen_ip>];

Enable/disable RSH server (disabled by default). Optionally, a server's IP address may be specified.

rsh [[<user>@]<host_addr>] [access] ;

Specifies an rsh access list entry. access values are: admin Can shutdown ipcad

backup Can dump/restore/import accounting tables

default Can view and modify accounting tables

view-only Can view accounting tables

deny Deny all activity

rsh ttl = <ttl>;

Keep the IP time to live (TTL) value reasonably low to lower the possibility of remote attacks. Default is 3. This means that if you are trying to gather IP accounting from a distant (a few network "hops", see traceroute(1)) ipcad server using RSH, such attempts may fail.

rsh timeout = <seconds>;

Set rsh timeout for the same purpose.

dumpfile = <filename>;

Dump memory table to this file on exit and read on startup (refer to ipcad(8) and read about -s and -r options). NOTE: This setting has no effect on NetFlow operation. The contents of the flow cache are flushed to the collector upon ipcad termination.

### NetFlow export configuration
netflow export destination <collector-ip> <collector-port>;

Enable NetFlow information export to the specified destination. By default, ipcad does not export NetFlow information.

netflow export version { 1 | 5 };

Specify the NetFlow export format version. By default, version 5 is used.

netflow export timeout active <time-minutes>;

Configure the timer to expire active flows after the given value in minutes.

netflow export timeout inactive <time-seconds>;

Configure the timer to expire inactive flows after the given value in seconds.

### Other options:
memory_limit = <number> [{ k | m | e }] ;

Defines a memory limit for storing the per-stream associations. Shortcuts are for kilobytes, megabytes or entries respectively.

chroot = </path>;

Chroot to this directory before processing.

uid = <number>;

Set this uid to be safe in the long run. Please change it if you're aware of the consequences. RSH service will NOT work if process is not privileged. Default is to not to change privileges.

gid = <number>;

Set this gid to be safe in the long run. Default is not to change privileges.

pidfile = <filename>;

File to keep the process PID in it. ipcad will also hold a lock. Creation of the PID file is done after chroot()'ing.

## SEE ALSO
ipcad(8).

## AUTHORS
Lev Walkin <vlm@lionet.info>


package: ir-keytable

title: rc_keymap(5)

text:
# rc_keymap(5)

## NAME
rc_keymap - toml file describing remote control keymap

## DESCRIPTION
An rc_keymap describes a remote control. It list the protocols used, and the mapping from decoded IR to linux input keycodes. This file is used by ir-keytable(1) for IR decoding, and by ir-ctl(1) for sending IR.

The file format is toml. Since a remote control can use multiple protocols, the top level is an array of protocols. The vast majority of remotes only use one protocol.

## KEYMAP PROTOCOL ENTRY
For each protocol the remote uses, there should be one entry in the top level protocols array.

### Name Field
Each protocols entry has a name field. The name is not used by ir-keytable or ir-ctl, but can be used to give the remote control a more descriptive name than the file name, e.g. the model number.

### Protocol Field
The protocol field specifies the protocol. This can either be one of the linux kernel decoders, in which case it is nec, rc-5, rc-6, jvc, sony, sanyo, rc-5-sz, sharp, mce-kbd, xmp, imon, rc-mm, other or unknown. If it does not match any of these entries, then it is assumed to be a BPF based decoder. The unknown and other are protocols decoded by specific RC devices where the protocol is either unknown or proprietary, respectively.

There are some pre-defined BPF protocol decoders, which are listed below. See https://lwn.net/Articles/759188/ for how to write your own.

### Variant Field
The variant field specifies which variant a particular protocol uses. The sony, rc-5, rc-6 protocols have different bit length variants, for example. This field is used by ir-ctl when sending IR.

The following variants are currently defined:

Protocol rc-5 has variants rc-5, rc-5x-20, rc-5-sz.

Protocol nec has variants nec, nec-x, nec-32.

Protocol sony has variants sony-12, sony-15, sony-20.

Protocol rc-6 has variants rc-6-0, rc-6-6a-20, rc-6-6a-24, rc-6-6a-32, rc-6-mce.

Protocol rc-mm has variants rc-mm-12, rc-mm-24, and rc-mm-32.

### Scancodes field
The scancodes table list the scancodes and the mapping to linux input keycode. Multiple scancodes can map to the same keycode. The scancodes field is not present for raw protocols.

If the scancode start with 0x, it is interpreted as a hexadecimal number. If it starts with a 0, it is interpreted as an octal number.

Valid keycodes are listed in the input-event-codes.h header file. Examples are KEY_ENTER, KEY_ESC or BTN_LEFT for the left mouse button. Note that if the keymap is only used for sending IR, then the key does not have to be a valid linux keycode. It can be any string without whitespace.

### Raw field
If the protocol is raw, the raw field is an array of keycode to raw mapping. For each entry, there is a keycode field and raw field. The keycode is a linux input keycode, as explained in the scancodes field above.

The raw field is an string, which lists pulse and space values, separated by whitespace. The first is a pulse value microseconds, and the second a space, third pulse, etc. The space values can be preceded by a - sign and the pulse value can be preceded by a +sign. There should be an odd number of value so that the last entry is a pulse.

### Remaining fields (BPF parameters)
If the protocol is a BPF based decoder, it may have any number of numeric parameters. These parameters are used to support protocols with non-standard signaling lengths for standard IR protocols. Any other field specified here which is required by the selected BPF decoder will be used. All other fields are ignored.

Kernel based non-BPF protocol decoders do not have any parameters.

## BPF PROTOCOLS
Some of the BPF protocol decoders are generic and will need parameters to work. Other are for specific remotes and should work without any parameters. The timing parameters are all in microseconds (µs).

### raw
This decoder must be used when the keymap is raw; for each key, there is an entry in raw array with the pulse and space values for that key. No decoding is done, the incoming IR is simply matched against the different pulse and space values.

### imon_rsc
This decoder is specifically for the iMON RSC remote, which was packaged with the iMON Station (amongst others). The decoder is for the directional stick in the middle; it will decode them into mouse movements. The buttons are all encoded using nec-x so the keymap needs two protocols to work correctly.

This is unrelated to the imon protocol.

margin

Define how much tolerance there is for message length. Default 200.

### grundig
This decoder is specifically for old grundig remotes.

header_pulse

Length of first pulse, default 900.

header_space

Length of following space, default 2900.

leader_pulse

Length of second pulse, default 1300.

### xbox
This decoder is specifically for the XBox Remote DVD, which is for the first generation XBox.

margin

Define how much tolerance there is for message length. Default 200.

### manchester
Most manchester encoded remote controls are either rc-5, rc-6, or rc-mm. Some remote use a different variant (e.g. they might have a header pulse) and that is what the decoder is for. Some parameters must be specified, by default it is set up for rc-5.

margin

Define how much tolerance there is for message length. Default 200.

header_pulse

Define how long a leading pulse is. This is not always present. Default 0.

header_space

Define how long the space is after the leading pulse. Must be set if header_pulse is set.

zero_pulse, zero_space, one_pulse, one_space

Signally lengths for bits. See https://clearwater.com.au/code/rc5 for these are defined.

bits

Number of bits. Default 14.

scancode_mask

Bits to mask out of resulting scancode.

toggle_bit

Bit that specifies the toggle. If this value is greater than the number of bits, no toggle is defined.

### pulse_distance
This is a generic decoder for protocols that define bits by distance between pulses, and the pulses are always of the same length. The most well known protocol like this is nec. This decoder is cases where nec is not used. The parameters must be set.

margin

Define how much tolerance there is for message length. Default 200.

header_pulse

Length of the first leading pulse. Default 2125.

header_space

Length of the space after the leading pulse. Default 1875.

repeat_pulse

Length of the leading pulse for key repeat. Default 0.

repeat_space

Length of the space after the leading pulse for key repeat. Default 0.

bit_pulse

Length of the pulse for each bit. Default 625.

bit_0_space

Length of the space for a zero bit. Default 375.

bit_1_space

Length of the space for a one bit. Default 1625.

trailer_pulse

Length of the pulse after the last bit. Needed to bookend the last bit. Default 625.

bits

Number of bits. Default 4.

reverse

Should the bits be read in least significant bit first. Set to non-zero to enable. Default 0.

header_optional

Some remotes do not send the header pulse and space for key repeats, so set this to non-zero to make the header optional. Default 0. An alternative implementation might only allow missing headers for repeat messages, but this would fail to decode key presses if the first message with the header did not decode correctly to due interference.

### pulse_length
This is a generic decoder for protocols that define bits by length of pulses, and the spaces are always the same. The sony protocol is the most well-known protocol, but this decoder is for protocols which are not sony.

margin

Define how much tolerance there is for message length. Default 200.

header_pulse

Length of the first leading pulse. Default 2125.

header_space

Length of the space after the leading pulse. Default 1875.

repeat_pulse

Length of the leading pulse for key repeat. Default 0.

repeat_space

Length of the space after the leading pulse for key repeat. Default 0.

bit_space

Length of the space for each bit. Default 625.

bit_0_pulse

Length of the pulse for a zero bit. Default 375.

bit_1_pulse

Length of the pulse for a one bit. Default 1625.

trailer_pulse

Length of the pulse after the last bit. Optional. Default 0.

bits

Number of bits. Default 4.

reverse

Should the bits be read in least significant bit first. Set to non-zero to enable. Default 0.

header_optional

Some remotes do not send the header pulse and space for key repeats, so set this to non-zero to make the header optional. Default 0. An alternative implementation might only allow missing headers for repeat messages, but this would fail to decode key presses if only the first message did not decode correctly to due interference.

## EXAMPLE

```
[[protocols]]
name = "iMON Station RSC"
protocol = "nec"
variant = "necx"
[protocols.scancodes]
0x801010 = "KEY_EXIT"
0x80102f = "KEY_POWER"
0x80104a = "KEY_SCREENSAVER"
0x801049 = "KEY_TIME"
0x801054 = "KEY_NUMERIC_1"
0x801055 = "KEY_NUMERIC_2"
0x801056 = "KEY_NUMERIC_3"
0x801057 = "KEY_NUMERIC_4"
0x801058 = "KEY_NUMERIC_5"
0x801059 = "KEY_NUMERIC_6"
0x80105a = "KEY_NUMERIC_7"
0x80105b = "KEY_NUMERIC_8"
0x80105c = "KEY_NUMERIC_9"
0x801081 = "KEY_SCREEN"
0x80105d = "KEY_NUMERIC_0"
0x801082 = "KEY_MAX"
0x801048 = "KEY_ESC"
0x80104b = "KEY_MEDIA"
0x801083 = "KEY_MENU"
0x801045 = "KEY_APPSELECT"
0x801084 = "KEY_STOP"
0x801046 = "KEY_CYCLEWINDOWS"
0x801085 = "KEY_BACKSPACE"
0x801086 = "KEY_KEYBOARD"
0x801087 = "KEY_SPACE"
0x80101e = "KEY_RESERVED"
0x801098 = "BTN_0"
0x80101f = "KEY_TAB"
0x80101b = "BTN_LEFT"
0x80101d = "BTN_RIGHT"
0x801016 = "BTN_MIDDLE"
0x801088 = "KEY_MUTE"
0x80105e = "KEY_VOLUMEDOWN"
0x80105f = "KEY_VOLUMEUP"
0x80104c = "KEY_PLAY"
0x80104d = "KEY_PAUSE"
0x80104f = "KEY_EJECTCD"
0x801050 = "KEY_PREVIOUS"
0x801051 = "KEY_NEXT"
0x80104e = "KEY_STOP"
0x801052 = "KEY_REWIND"
0x801053 = "KEY_FASTFORWARD"
0x801089 = "KEY_ZOOM"
[[protocols]]
protocol = "imon_rsc"
```

## BUGS
Report bugs to Linux Media Mailing List <linux-media@vger.kernel.org>

## COPYRIGHT
Copyright (C) 2019 by Sean Young <sean@mess.org>

License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

## SEE ALSO
ir-keytable(1) and ir-ctl(1)

https://lwn.net/Articles/759188/

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/input-event-codes.h#n64


sane-epkowa

package: iscan-free

title: sane-epkowa(5)

text:
# sane-epkowa(5)

## NAME
sane-epkowa - SANE backend for EPSON scanners

## DESCRIPTION
The sane-epkowa library implements a SANE (Scanner Access Now Easy) backend that provides access to a large number of EPSON devices. A list with supported device information may be found in the iscan-data package's documentation directory, typically /usr/share/doc/iscan-data/.

## OPTIONS
The options the backend supports can either be selected through command line options to programs like scanimage or through GUI elements in xscanimage or xsane.

Valid command line options and their syntax can be listed by using

scanimage --help -d epkowa

Not all devices support all options and not all options may be docmented below. Scan Mode

The --mode switch selects the basic mode of operation of the scanner valid choices are Binary, Gray and Color. The Binary mode is black and white only, Gray will produce up to 256 levels of gray and Color means 24 bit color mode. Some scanners will internally use 36 bit color, the external interface however does only support 24 bits. The --halftoning switch selects the mode that is used in Binary mode. Valid options are None, Halftone A (Hard Tone), Halftone B (Soft Tone), Halftone C (Net Screen), Dither A (4x4 Bayer), Dither B (4x4 Spiral), Dither C (4x4 Net Screen), Dither D (8x4 Net Screen), Text Enhanced Technology, Download pattern A, and Download pattern B.

The --dropout switch selects the so called dropout color. Valid options are None, Red, Green and Blue. The default is None. The dropout color is used for monochrome scanning and selects the color that is not scanned. This can be used to e.g. scan an original with a colored background.

The --brightness switch controls the brightness of the scan. Valid options are the numbers from -3 to 3. The default is 0. The larger the brightness value, the brighter the image gets. If a user defined table for the gamma correction is selected, the brightness parameter is not available.

The --sharpness switch sets the sharpness of the image data. Valid options are the numbers from -2 to 2, with -2 meaning "Defocus", -1 "Defocus slightly", 0 "Normal", 1 "Sharpen slighly" and 2 "Sharpen".

The --gamma-correction switch controls the scanner's internal gamma correction. Valid options are "Default", "User defined", "High density printing" "Low density printing" and "High contrast printing".

The --color-correction switch controls the scanner's internal color correction function. Valid options are "No Correction", "Impact-dot printers", "Thermal printers", "Ink-jet printers" and "CRT monitors". The default is "CRT monitors".

The --resolution switch selects the resolution for a scan. Many EPSON scanners will scan in any resolution between the lowest and highest possible value. The list reported by the scanner can be displayed using the "--help -d epkowa" parameters to scanimage.

The --mirror option controls the way the image is scanned. By reading the image data from right to left the image is mirored. Valid options are "yes" and "no". The default is "no".

The --speed option can improve the scan speed in monochrome mode. Valid options are "yes" or "no", the "yes" option will speed up the scan if this option is supported.

The --auto-area-segmentation switch turns on the automatic area segmentation for monochrome scans. The scanner will try to determine which areas are text and which contain images. The image areas will be halftoned, and the text will be impoved. Valid options are "yes" and "no". The default is "yes".

The --gamma-table parameter can be used to download a user defined gamma table. The options takes 256 values from the range 0..255. In color mode this option equally affects the red, green, and blue channel.

The --red-gamma-table parameter can be used to download a user defined gamma table for the red channel. The valid options are the same as for --gamma-table.

The --green-gamma-table parameter can be used to download a user defined gamma table for the green channel. The valid options are the same as for --gamma-table.

The --blue-gamma-table parameter can be used to download a user defined gamma table for the blue channel. The valid options are the same as for --gamma-table.

The color correction coefficients --cct-1 --cct-2 --cct-3 ... --cct-9 will install color correction coefficients for the user defined color correction. Possible values are in the range -127..127.

The --preview option requests a preview scan. The frontend software automatically selects a low resolution. Valid options are "yes" and "no". The default is "no".

The --preview-speed options will increase the scan speed if this is supported by the scanner. Valid options are "yes" and "no", the default is "no".

The geometry options -l -t -x -y control the scan area: -l sets the top left x coordinate, -t the top left y coordinate, -x selects the width and -y the height of the scan aea. All parameters are specified in milimeters.

The --quick-format option lets the user select a scan area with predefined sizes. Valid parameters are "CD", "A5 portrait", "A5 landscape", "Letter", "A4" and "max". The default is "max", which selects the largest possible area.

The --source option selects the scan source. Valid options depend on the installed options. The default is "Flatbed".

The --auto-eject option will eject a page after scanning from the document feeder.

## CONFIGURATION FILE
The configuration file /etc/sane.d/epkowa.conf specifies the device(s) that the backend will use. Possible connection types are:

USB

All supported USB devices should be recognised automatically when the "usb" keyword is specified. You may have to add yourself to a specific system group though to get the privileges required to access the device. See the configuration file for information on how to get unsupported devices recognised.

SCSI

The "scsi" keyword activates detection of supported SCSI devices. If your device is not recognised despite this see the configuration file for more information.

More extensive documentation is available in the comments of the

default configuration file.

## FILES
/usr/lib64/sane/libsane-epkowa.a

The static library implementing this backend.

/usr/lib64/sane/libsane-epkowa.so

The shared library implementing this backend (present on systems that support dynamic loading).

## ENVIRONMENT
SANE_DEBUG_EPKOWA

If the library was compiled with debug support enabled, this environment variable controls the debug level for this backend. The following, case insensitive string literals are supported (in increasing level of feedback): FATAL, MAJOR, MINOR, INFO, CALL, DATA, CMD, HEX, IMG. Note that the last level includes the raw image data as obtained from the scanner and produces vast amounts of output. For most trouble shooting situations, the HEX level is sufficient.

SANE_EPSON_CMD_LVL

This allows to override the function or command level that the backend uses to communicate with the scanner. The function level a scanner supports is determined during the initialization of the device. If the backend does not recognize the function level reported by the scanner it will default to function level B5. Valid function levels include A1, A2, B1, B2, B3, B4, B5, B6, B7, B8, D1, D2, D7, D8 and F5. Use this feature only if you know what you are doing!

## SEE ALSO
sane-scsi(5), scanimage(1), xscanimage(1), xsane(1)

## BUGS
Sometimes the scanner is not initialized correctly. The problem can be resolved by killing the program and restarting it again.

## UNSUPPORTED DEVICES
Note that a number of EPSON scanners require a non-free plugin before they can be used by the backend.

The backend may be used with EPSON scanners that are not yet listed under the list of supported devices. A scanner that is not recognized may default to the function level B3, which means that not all functions that the scanner may be capable of are accessible.

If the scanner is not even recognized as an EPSON scanner it is probably because the device info reported by the scanner is not in the correct format. Please send this information to the sane-devel mailing list.

## AUTHOR
AVASYS CORPORATION


iwpmd.conf

package: iwpmd

title: iwpmd.conf(5)

summary: iWARP port mapper config file.

text:
# iwpmd.conf(5)

## NAME
iwpmd.conf - iWARP port mapper config file.

## SYNOPSIS

```
iwpmd.conf
```

## DESCRIPTION
The iwpmd.conf file provides configuration parameters for iwpmd. Parameters are in the form: param=value, and one per line. Parameters include:

nl_sock_rbuf_size - The socket buffer size of the netlink socket used to communicate with the kernel port map client. The default is 400MB.

## EXAMPLES
nl_sock_rbuf_size=419430400

## FILES
/etc/iwpmd.conf

## SEE ALSO
iwpmd(8)


kanshi

package: kanshi

title: kanshi(5)

text:
# kanshi(5)

## NAME
kanshi - configuration file

## DESCRIPTION
A kanshi configuration file is a list of profiles. Each profile has an optional name and contains profile directives delimited by brackets ({ and }).

Example:

```
include /etc/kanshi/config.d/*
profile {
	output LVDS-1 disable
	output "Some Company ASDF 4242" {
		mode 1600x900
		position 0,0
	}
}
profile nomad {
	output LVDS-1 enable scale 2
}
```

## DIRECTIVES
profile [<name>] { <profile directives...> }

Defines a new profile using the specified bracket-delimited profile directives. A name can be specified but is optional.

output <criteria> <output-directive...>

Defines defaults for output directives inside profile definitions. These defaults only apply when the respective output is mentioned in a specific profile. For example, the following two profiles are equivalent:

```
output eDP-1 scale 2
profile manual {
	output eDP-1 scale 2
}
profile uses-defaults {
	output eDP-1
}
```

Output directives may be specified in a bracket-delimited block as well.

include <path>

Include as another file from path. Expands shell syntax (see wordexp(3) for details).

## PROFILE DIRECTIVES
Profile directives are followed by space-separated arguments. Arguments can be quoted (with ") if they contain spaces.

output <criteria> <output-directive...>

An output directive adds an output to the profile. The criteria can be one of:

•An output name (e.g. "DP-1"). Note, output names may not be stable: they may change across reboots (depending on kernel driver probe order) or creation order (typically for USB-C docks).

•A space-separated string containing the output manufacturer, model and serial number (e.g. "Foocorp ASDF 1234"). A wildcard pattern can be used (e.g. "Foocorp ASDF *"), see glob(7). If one of these fields is missing, it needs to be populated with the string "Unknown" (e.g. "Foocorp ASDF Unknown").

•An output alias (e.g. "$work-desk3") defined by an output alias directive. Output aliases can only be used in profile scope.

•A wildcard "*", to match any output. Wildcards can only be used in profile scope and will only match one output.

Output directives may be specified in a bracket-delimited block as well.

On sway(1), output names and identifiers can be obtained via "swaymsg -t get_outputs".

exec <command>

An exec directive executes a command when the profile was successfully applied. This can be used to update the compositor state to the profile when not done automatically. Commands are executed asynchronously and their order may not be preserved. If you need to execute sequential commands, you should collect in one exec statement or in a separate script.

On sway(1) for example, exec can be used to move workspaces to the right output:

```
profile multihead {
	output eDP-1 enable
	output DP-1 enable transform 270
	exec swaymsg workspace 1, move workspace to eDP-1
}
```

Note that some extra care must be taken with outputs identified by an output description as the real name may change:

```
profile complex {
	output "Some Other Company GTBZ 2525" mode 1920x1200
	exec swaymsg workspace 1, move workspace to output '"Some Other Company GTBZ 2525"'
}
```

## OUTPUT DIRECTIVES
enable|disable

Enables or disables the specified output.

mode [--custom] <width>x<height>[@<rate>[Hz]]

Configures the specified output to use the specified mode. Modes are a combination of width and height (in pixels) and a refresh rate (in Hz) that your display can be configured to use. Examples:

```
output HDMI-A-1 mode 1920x1080
output HDMI-A-1 mode 1920x1080@60Hz
output HDMI-A-1 mode --custom 1280x720@60Hz
```

position <x>,<y>

Places the output at the specified position in the global coordinates space. Example:

```
output HDMI-A-1 position 1600,0
```

scale <factor>

Scales the output by the specified scale factor.

transform <transform>

Sets the output transform. Can be one of "90", "180", "270" for a rotation; or "flipped", "flipped-90", "flipped-180", "flipped-270" for a rotation and a flip; or "normal" for no transform.

adaptive_sync on|off

Enables or disables adaptive synchronization (aka. Variable Refresh Rate).

alias $<name>

Defines an alias for this output. Output aliases can only be defined in global scope.

## AUTHORS
Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other open-source contributors. For more information about kanshi development, see <https://gitlab.freedesktop.org/emersion/kanshi>.

## SEE ALSO
kanshi(1)


keymaps

package: kbd

title: keymaps(5)

text:
# keymaps(5)

## NAME
keymaps - keyboard table descriptions for loadkeys and dumpkeys

## DESCRIPTION
These files are used by loadkeys(1) to modify the translation tables used by the kernel keyboard driver and generated by dumpkeys(1) from those translation tables.

The format of these files is vaguely similar to the one accepted by xmodmap(1). The file consists of charset or key or string definition lines interspersed with comments.

Comments are introduced with ! or # characters and continue to the end of the line. Anything following one of these characters on that line is ignored. Note that comments need not begin from column one as with xmodmap(1).

The syntax of keymap files is line oriented; a complete definition must fit on a single logical line. Logical lines can, however, be split into multiple physical lines by ending each subline with the backslash character (\).

## INCLUDE FILES
A keymap can include other keymaps using the syntax

include "pathname"

## CHARSET DEFINITIONS
A character set definition line is of the form:

```
charset "iso-8859-x"
```

It defines how following keysyms are to be interpreted. For example, in iso-8859-1 the symbol mu (or micro) has code 0265, while in iso-8859-7 the letter mu has code 0354.

## COMPLETE KEYCODE DEFINITIONS
Each complete key definition line is of the form:

```
keycode keynumber = keysym keysym keysym...
```

keynumber is the internal identification number of the key, roughly equivalent to the scan code of it. keynumber can be given in decimal, octal or hexadecimal notation. Octal is denoted by a leading zero and hexadecimal by the prefix 0x.

Each of the keysyms represent keyboard actions, of which up to 256 can be bound to a single key. The actions available include outputting character codes or character sequences, switching consoles or keymaps, booting the machine etc. (The complete list can be obtained from dumpkeys(1) by saying dumpkeys -l .)

Each keysym may be prefixed by a '+' (plus sign), in which case this keysym is treated as a "letter" and therefore affected by the "CapsLock" the same way as by "Shift" (to be correct, the CapsLock inverts the Shift state). The ASCII letters ('a'-'z' and 'A'-'Z') are made CapsLock'able by default. If Shift+CapsLock should not produce a lower case symbol, put lines like

```
keycode 30 = +a  A
```

in the map file.

Which of the actions bound to a given key is taken when it is pressed depends on what modifiers are in effect at that moment. The keyboard driver supports 9 modifiers. These modifiers are labeled (completely arbitrarily) Shift, AltGr, Control, Alt, ShiftL, ShiftR, CtrlL, CtrlR and CapsShift. Each of these modifiers has an associated weight of power of two according to the following table:

modifier

weight

Shift 1

AltGr 2

Control 4

Alt 8

ShiftL 16

ShiftR 32

CtrlL 64

CtrlR 128

CapsShift 256

The effective action of a key is found out by adding up the weights of all the modifiers in effect. By default, no modifiers are in effect, so action number zero, i.e. the one in the first column in a key definition line, is taken when the key is pressed or released. When e.g. Shift and Alt modifiers are in effect, action number nine (from the 10th column) is the effective one.

Changing the state of what modifiers are in effect can be achieved by binding appropriate key actions to desired keys. For example, binding the symbol Shift to a key sets the Shift modifier in effect when that key is pressed and cancels the effect of that modifier when the key is released. Binding AltGr_Lock to a key sets AltGr in effect when the key is pressed and cancels the effect when the key is pressed again. (By default Shift, AltGr, Control and Alt are bound to the keys that bear a similar label; AltGr may denote the right Alt key.)

Note that you should be very careful when binding the modifier keys, otherwise you can end up with an unusable keyboard mapping. If you for example define a key to have Control in its first column and leave the rest of the columns to be VoidSymbols, you're in trouble. This is because pressing the key puts Control modifier in effect and the following actions are looked up from the fifth column (see the table above). So, when you release the key, the action from the fifth column is taken. It has VoidSymbol in it, so nothing happens. This means that the Control modifier is still in effect, although you have released the key. Re-pressing and releasing the key has no effect. To avoid this, you should always define all the columns to have the same modifier symbol. There is a handy short-hand notation for this, see below.

keysyms can be given in decimal, octal, hexadecimal, unicode or symbolic notation. The numeric notations use the same format as with keynumber. Unicode notation is "U+" followed by four hexadecimal digits. The symbolic notation resembles that used by xmodmap(1). Notable differences are the number symbols. The numeric symbols '0', ..., '9' of xmodmap(1) are replaced with the corresponding words 'zero', 'one', ... 'nine' to avoid confusion with the numeric notation.

It should be noted that using numeric notation for the keysyms is highly unportable as the key action numbers may vary from one kernel version to another and the use of numeric notations is thus strongly discouraged. They are intended to be used only when you know there is a supported keyboard action in your kernel for which your current version of loadkeys(1) has no symbolic name.

There is a number of short-hand notations to add readability and reduce typing work and the probability of typing-errors.

First of all, you can give a map specification line, of the form

```
keymaps 0-2,4-5,8,12
```

to indicate that the lines of the keymap will not specify all 256 columns, but only the indicated ones. (In the example: only the plain, Shift, AltGr, Control, Control+Shift, Alt and Control+Alt maps, that is, 7 columns instead of 256.) When no such line is given, the keymaps 0-M will be defined, where M+1 is the maximum number of entries found in any definition line.

Next, you can leave off any trailing VoidSymbol entries from a key definition line. VoidSymbol denotes a keyboard action which produces no output and has no other effects either. For example, to define key number 30 to output 'a' unshifted, 'A' when pressed with Shift and do nothing when pressed with AltGr or other modifiers, you can write

```
keycode  30 = a	A
```

instead of the more verbose

```
keycode  30 = a	A	VoidSymbol	VoidSymbol \
		VoidSymbol VoidSymbol VoidSymbol ...
```

For added convenience, you can usually get off with still more terse definitions. If you enter a key definition line with only and exactly one action code after the equals sign, it has a special meaning. If the code (numeric or symbolic) is not an ASCII letter, it means the code is implicitly replicated through all columns being defined. If, on the other hand, the action code is an ASCII character in the range 'a', ..., 'z' or 'A', ..., 'Z' in the ASCII collating sequence, the following definitions are made for the different modifier combinations, provided these are actually being defined. (The table lists the two possible cases: either the single action code is a lower case letter, denoted by 'x' or an upper case letter, denoted by 'Y'.)

modifier

symbol

none

x Y

Shift

X y

AltGr

x Y

Shift+AltGr

X y

Control

Control_x Control_y

Shift+Control

Control_x Control_y

AltGr+Control

Control_x Control_y

Shift+AltGr+Control

Control_x Control_y

Alt

Meta_x Meta_Y

Shift+Alt

Meta_X Meta_y

AltGr+Alt

Meta_x Meta_Y

Shift+AltGr+Alt

Meta_X Meta_y

Control+Alt

Meta_Control_x Meta_Control_y

Shift+Control+Alt

Meta_Control_x Meta_Control_y

AltGr+Control+Alt

Meta_Control_x Meta_Control_y

Shift+AltGr+Control+Alt

Meta_Control_x Meta_Control_y

## SINGLE MODIFIER DEFINITIONS
All the previous forms of key definition lines always define all the M+1 possible modifier combinations being defined, whether the line actually contains that many action codes or not. There is, however, a variation of the definition syntax for defining only single actions to a particular modifier combination of a key. This is especially useful, if you load a keymap which doesn't match your needs in only some modifier combinations, like AltGr+function keys. You can then make a small local file redefining only those modifier combinations and loading it after the main file. The syntax of this form is:

{ plain | <modifier sequence> } keycode keynumber = keysym

, e.g.,

```
plain keycode 14 = BackSpace
control alt keycode 83 = Boot
alt keycode 105 = Decr_Console
alt keycode 106 = Incr_Console
```

Using "plain" will define only the base entry of a key (i.e. the one with no modifiers in effect) without affecting the bindings of other modifier combinations of that key.

## STRING DEFINITIONS
In addition to comments and key definition lines, a keymap can contain string definitions. These are used to define what each function key action code sends. The syntax of string definitions is:

string keysym = "text"

text can contain literal characters, octal character codes in the format of backslash followed by up to three octal digits, and the three escape sequences \n, \\, and \", for newline, backslash and quote, respectively.

## COMPOSE DEFINITIONS
Then there may also be compose definitions. They have syntax

compose 'char' 'char' to 'char'

and describe how two bytes are combined to form a third one (when a dead accent or compose key is used). This is used to get accented letters and the like on a standard keyboard.

## ABBREVIATIONS
Various abbreviations can be used with kbd-0.96 and later.

strings as usual

Defines the usual values of the strings (but not the keys they are bound to).

compose as usual for "iso-8859-1"

Defines the usual compose combinations.

To find out what keysyms there are available for use in keymaps, use the command

```
dumpkeys --long-info
```

Unfortunately, there is currently no description of what each symbol does. It has to be guessed from the name or figured out from the kernel sources.

## EXAMPLES
(Be careful to use a keymaps line, like the first line of `dumpkeys`, or "keymaps 0-15" or so.)

The following entry exchanges the left Control key and the Caps Lock key on the keyboard:

```
keycode  58 = Control
keycode  29 = Caps_Lock
```

Key number 58 is normally the Caps Lock key, and key number 29 is normally the Control key.

The following entry sets the Shift and Caps Lock keys to behave more nicely, like in older typewriters. That is, pressing Caps Lock key once or more sets the keyboard in CapsLock state and pressing either of the Shift keys releases it.

```
keycode  42 = Uncaps_Shift
keycode  54 = Uncaps_Shift
keycode  58 = Caps_On
```

The following entry sets the layout of the edit pad in the enhanced keyboard to be more like that in the VT200 series terminals:

```
keycode 102 = Insert
keycode 104 = Remove
keycode 107 = Prior
shift keycode 107 = Scroll_Backward
keycode 110 = Find
keycode 111 = Select
control alt   keycode 111 = Boot
control altgr keycode 111 = Boot
```

Here's an example to bind the string "du\ndf\n" to the key AltGr-D. We use the "spare" action code F100 not normally bound to any key.

```
altgr keycode 32 = F100
string F100 = "du\ndf\n"
```

## SEE ALSO
loadkeys(1), dumpkeys(1), showkey(1), xmodmap(1)


kdump-tools

package: kdump-tools

title: kdump-tools(5)

text:
# kdump-tools(5)

## NAME
kdump-tools.conf - configuration file for the kdump-tools init script

## SYNOPSIS
/etc/sysconfig/kdump-tools

## DESCRIPTION
kdump-tools manages the kdump feature of the Linux kernel. The /etc/sysconfig/kdump-tools file contains local configuration settings of kdump.

This file is sourced into a shell script, so it's format should be consistent with shell scripting.

## OPTIONS
USE_KDUMP

Controls whether or not kdump-tools will take any action. If not set or 0, the kdump-tools init script will not run.

KDUMP_KERNEL

A full pathname to a kdump kernel (the kernel that is kexec'd at crash time in a reserved memory area, exposing the old kernel's memory for dumping). If not set, kdump-config will use the boot kernel as the kdump kernel if it is relocatable; otherwise you must set KDUMP_KERNEL in order for kdump-tools to work.

KDUMP_INITRD

A full pathname to the kdump initrd (if used). If KDUMP_KERNEL is set and KDUMP_INITRD is not set, a warning message will be printed, and an initrd will not be used.

KDUMP_COREDIR

Full path to a directory where the vmcore will be saved. Date stamped subdirectories are created each time a vmcore file is processed. If not set, /var/crash will be used.

KDUMP_FAIL_CMD

This variable specifies a command to run if the vmcore save fails. If not set, no special action is taken.

KDUMP_DUMP_DMESG

This variable controls if the dmesg buffer is dumped. If not set or set to 1, the dmesg buffer is dumped. If set to 0, the dmesg buffer is not dumped.

KDUMP_NUM_DUMPS

This variable specifies how many dump files should be kept on the local machine. If not set or set to 0, no special action is taken. If set to >1 and there are too many dump files on the machine, older dumps are removed. The cleanup action is only taken after a successful dump. This variable is ignored if remote dumping is enabled.

MAKEDUMP_ARGS

Extra arguments passed to makedumpfile(8). If not set, “-c -d 31” will be used. This tells makedumpfile to use compression, and reduce the corefile to in-use kernel pages only. See makedumpfile(8) for details.

KDUMP_KEXEC_ARGS

Additional arguments to the kexec command used to load the kdump kernel.

KDUMP_CMDLINE

Normally, the current kernel commandline is obtained from /proc/cmdline. Set this variable to override /proc/cmdline.

KDUMP_CMDLINE_APPEND

Additional arguments to append to the command line for the kdump kernel. If not set, “systemd.unit=kdump-tools-dump.service sysrq=yes panic=9 nokaslr irqpoll reset_devices cgroup_disable=memory udev.children-max=4 transparent_hugepage=never cma=0 hugetlb_cma=0 novmcoredd nr_cpus=1 mce=off numa=off acpi_no_memhotplug nokaslr hest_disable” will be used.

SSH

username and hostname of the remote server that will receive the dump and dmesg files. username@hostname format must be used.

SSH_KEY

Full path of the ssh private key to be used to login to the remote server. Use “kdump-config propagate” to send the public key to the remote server. If not set, the default /root/.ssh/kdump_id_rsa will be used

HOSTTAG

Select if hostname of IP address will be used as a prefix to the timestamped directory when sending files to the remote server. If not set, “ip” will be used.

NFS

Hostname and mount point of the NFS server configured to receive the crash dump. The syntax must be HOSTNAME:MOUNTPOINT (e.g. remote:/var/crash )

## USAGE
kdump-tools is as automated as can be at this point but there are some prerequisites to using it. Additionally, some manual configuration is still required.

By default, kernel dumps are stored locally on the system. kdump-tools can be configured to store the kernel dumps on a remote server accessible through the network.

### Manual Configuration
1.

USE_KDUMP is set to 0 by default. To enable kdump-tools, edit the /etc/sysconfig/kdump-tools configuration file and set USE_KDUMP=1.

2.

Kernel Command line parameters - the kernel must be booted with a crashkernel= command line parameter. Some example crashkernel parameters:

```
    ia64:       crashkernel=384M

    x86:        crashkernel=128M

    x86_64:     crashkernel=256M
```

Some users may also want to add nmi_watchdog=1 on certain systems. The nmi watchdog will cause the kernel to panic (and kdump) if a system hang is detected.

The kernel command line parameter is generally set in one of these files: /etc/sysconfig/grub, /boot/grub/menu.lst, /etc/elilo.conf, or /etc/lilo.conf. If the command line parameter is changed, a reboot is required in order for it to take effect.

3.

Architectural considerations

A)

x86 && PAE && memory > 4 Gigabytes - use KDUMP_KEXEC_ARGS="--elf64-core-headers"

B)

x86 and x86_64 - Some systems can take advantage of the nmi watchdog. Add nmi_watchdog=1 to the boot commandline to turn on the watchdog. The nmi interrupt will call panic if activated.

C)

ia64 - Some systems may need KDUMP_KEXEC_ARGS="--noio". Use this if the system hangs after a panic, but before the kdump kernel begins to boot.

### Networked kernel dump Configuration
1.

Either use SSH or NFS to choose which protocol to use to remotely access the target server.

2

For SSH username@hostname needs to be provided along with an appropriate SSH_KEY definition or use “kdump-config propagate” to propagate a new default ssh key.

3

For NFS the remote server name must be provided along with the directory where files are to be copied.

### Prerequisites
1.

Boot Kernel Configuration - The boot kernel must be configured with CONFIG_KEXEC=y and, if it is also to be used as the kdump kernel, CONFIG_CRASHDUMP=y. For ia64, only makedumpfile level 1 will work if the memory model selected is CONFIG_DISCONTIG. CONFIG_SPARSEMEM is recommended instead.

2.

Kdump Kernel Configuration - The kdump kernel must be relocated or relocatable. ia64 is relocatable by default, but x86, x86_64, and powerpc must be built with CONFIG_RELOCATABLE=y. Other architectures may require a predermined start location via CONFIG_PHYSICAL_START. If the boot kernel is relocatable, kdump-tools will automatically use that kernel. Otherwise, a relocatable or relocated kernel will need to be provided. The kdump kernel can be specified in the /etc/sysconfig/kdump-tools file. Set the KDUMP_KERNEL variable and if necessary the KDUMP_INITRD variable to point to the provided kernel and its initrd. The kdump kernel must be configured with: CONFIG_CRASH_DUMP=y

## SYSCTLS
Currently kdump-tools automatically sets the kernel sysctl for panic on oops, in order to collect a dump in this case. If the users want more panic triggers, like panic on OOM, or when a NMI is detected, it's recommended that they edit the sysctl configuration files (/etc/sysctl.conf or files on /etc/sysctl.d) in order to do so, and/or apply the sysctl settings with sysctl tool.

### Sysctl handling *during a kdump*
kdump-tools allows users to configure sysctls overrides on kdump environment; this is specially useful to prevent sysctls from the regular boot to mess with the resource-impaired kdump environment.

The mechanism is restricted to kdump boot and will not affect regular boots. In order to add overrides, user should edit the file /etc/kdump/sysctl.conf.

By default, hugepages overrides are set and is highly recommended to keep them in the file, to prevent kdump out-of-memory conditions.

## EXAMPLES
Use this option on x86 systems with PAE and more than 4 gig of memory:

KDUMP_KEXEC_ARGS="--elf64-core-headers"

This option starts a shell if kdump-tools cannot save the vmcore file:

KDUMP_FAIL_CMD="/bin/bash; reboot -f"

## FILES
/etc/rc.d/init.d/kdump-tools

an init script to automatically load a kdump kernel, or save a vmcore and reboot.

/etc/sysconfig/kdump-tools

the kdump-tools configuration file

/etc/kdump/sysctl.conf

kdump-tools sysctl override file

/var/crash/kernel_link

a link to the current debug kernel

/var/crash/kexec_cmd

the last kexec_cmd executed by kdump-config

## DIAGNOSTICS
See kdump-config(8) for explanations of various error messages.

## SEE ALSO
/usr/share/doc/kdump-tools/README

/usr/share/doc/kdump-tools/README.Debian

kdump-config(8), kexec(8), sysctl(8), makedumpfile(8), crash(8), gdb(1),

## AUTHOR
Terry Loftin <terry.loftin@hp.com>