waybar-keyboard-state

title: waybar-keyboard-state(5)

text:
# waybar-keyboard-state(5)

## NAME
waybar - keyboard-state module

## DESCRIPTION
The keyboard-state module displays the state of number lock, caps lock, and scroll lock.

You must be a member of the input group to use this module.

## CONFIGURATION
interval:

typeof: integer

default: 1

The interval, in seconds, to poll the keyboard state.

format:

typeof: string|object

default: {name} {icon}

The format, how information should be displayed. If a string, the same format is used for all keyboard states. If an object, the fields "numlock", "capslock", and "scrolllock" each specify the format for the corresponding state. Any unspecified states use the default format.

format-icons:

typeof: object

default: {"locked": "locked", "unlocked": "unlocked"}

Based on the keyboard state, the corresponding icon gets selected. The same set of icons is used for number, caps, and scroll lock, but the icon is selected from the set independently for each. See icons.

numlock:

typeof: bool

default: false

Display the number lock state.

capslock:

typeof: bool

default: false

Display the caps lock state.

scrolllock:

typeof: bool

default: false

Display the scroll lock state.

device-path:

typeof: string

default: chooses first valid input device

Which libevdev input device to show the state of. Libevdev devices can be found in /dev/input. The device should support number lock, caps lock, and scroll lock events.

## FORMAT REPLACEMENTS
{name}: Caps, Num, or Scroll.

{icon}: Icon, as defined in format-icons.

## ICONS
The following format-icons can be set.

•locked: Will be shown when the keyboard state is locked. Default "locked".

•unlocked: Will be shown when the keyboard state is not locked. Default "unlocked"

## EXAMPLE:

```
"keyboard-state": {

    "numlock": true,

    "capslock": true,

    "format": "{name} {icon}",

    "format-icons": {

        "locked": "",

        "unlocked": ""

    }
}
```

## STYLE
•#keyboard-state

•#keyboard-state label

•#keyboard-state label.locked

•#keyboard-state label.numlock

•#keyboard-state label.numlock.locked

•#keyboard-state label.capslock

•#keyboard-state label.capslock.locked

•#keyboard-state label.scrolllock

•#keyboard-state label.scrolllock.locked


waybar-memory

package: waybar

title: waybar-memory(5)

text:
# waybar-memory(5)

## NAME
waybar - memory module

## DESCRIPTION
The memory module displays the current memory utilization.

## CONFIGURATION
Addressed by memory

interval:

typeof: integer

default: 30

The interval in which the information gets polled.

format:

typeof: string

default: {percentage}%

The format, how information should be displayed.

format-icons:

typeof: array/object

Based on the current percentage, the corresponding icon gets selected.

The order is low to high. Or by the state if it is an object.

rotate:

typeof: integer

Positive value to rotate the text label.

states:

typeof: array

A number of memory utilization states which get activated on certain percentage thresholds. See waybar-states(5).

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{percentage}: Percentage of memory in use.

{swapPercentage}: Percentage of swap in use.

{total}: Amount of total memory available in GiB.

{swapTotal}: Amount of total swap available in GiB.

{used}: Amount of used memory in GiB.

{swapUsed}: Amount of used swap in GiB.

{avail}: Amount of available memory in GiB.

{swapAvail}: Amount of available swap in GiB.

## EXAMPLES

```
"memory": {
	"interval": 30,
	"format": "{}% ",
	"max-length": 10
}
```

### FORMATTED MEMORY VALUES

```
"memory": {
	"interval": 30,
	"format": "{used:0.1f}G/{total:0.1f}G "
}
```

## STYLE
•#memory


waybar-mpd

title: waybar-mpd(5)

text:
# waybar-mpd(5)

## NAME
waybar - mpd module

## DESCRIPTION
The mpd module displays information about a running "Music Player Daemon" instance.

## CONFIGURATION
Addressed by mpd

server:

typeof: string

The network address or Unix socket path of the MPD server. If empty, connect to the default host.

port:

typeof: integer

The port MPD listens to. If empty, use the default port.

password:

typeof: string

The password required to connect to the MPD server. If empty, no password is sent to MPD.

interval:

typeof: integer

default: 5

The interval in which the connection to the MPD server is retried

timeout:

typeof: integer

default: 30

The timeout for the connection. Change this if your MPD server has a low `connection_timeout` setting

unknown-tag:

typeof: string

default: "N/A"

The text to display when a tag is not present in the current song, but used in `format`

format:

typeof: string

default: "{album} - {artist} - {title}"

Information displayed when a song is playing.

format-stopped:

typeof: string

default: "stopped"

Information displayed when the player is stopped.

format-paused:

typeof: string

This format is used when a song is paused.

format-disconnected:

typeof: string

default: "disconnected"

Information displayed when the MPD server can't be reached.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

tooltip-format:

typeof: string

default: "MPD (connected)"

Tooltip information displayed when connected to MPD.

tooltip-format-disconnected:

typeof: string

default: "MPD (disconnected)"

Tooltip information displayed when the MPD server can't be reached.

artist-len:

typeof: integer

Maximum length of the Artist tag.

album-len:

typeof: integer

Maximum length of the Album tag.

album-artist-len:

typeof: integer

Maximum length of the Album Artist tag.

title-len:

typeof: integer

Maximum length of the Title tag.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

state-icons:

typeof: object

default: {}

Icon to show depending on the play/pause state of the player ({ "playing": "...", "paused": "..." })

consume-icons:

typeof: object

default: {}

Icon to show depending on the "consume" option ({ "on": "...", "off": "..." })

random-icons:

typeof: object

default: {}

Icon to show depending on the "random" option ({ "on": "...", "off": "..." })

repeat-icons:

typeof: object

default: {}

Icon to show depending on the "repeat" option ({ "on": "...", "off": "..." })

single-icons:

typeof: object

default: {}

Icon to show depending on the "single" option ({ "on": "...", "off": "..." })

## FORMAT REPLACEMENTS

### WHEN PLAYING/PAUSED
{artist}: The artist of the current song

{albumArtist}: The artist of the current album

{album}: The album of the current song

{title}: The title of the current song

{date}: The date of the current song

{volume}: The current volume in percent

{elapsedTime}: The current position of the current song. To format as a date/time (see example configuration)

{totalTime}: The length of the current song. To format as a date/time (see example configuration)

{songPosition}: The position of the current song.

{queueLength}: The length of the current queue.

{stateIcon}: The icon corresponding the playing or paused status of the player (see state-icons option)

{consumeIcon}: The icon corresponding the "consume" option (see consume-icons option)

{randomIcon}: The icon corresponding the "random" option (see random-icons option)

{repeatIcon}: The icon corresponding the "repeat" option (see repeat-icons option)

{singleIcon}: The icon corresponding the "single" option (see single-icons option)

### WHEN STOPPED
{consumeIcon}: The icon corresponding the "consume" option (see consume-icons option)

{randomIcon}: The icon corresponding the "random" option (see random-icons option)

{repeatIcon}: The icon corresponding the "repeat" option (see repeat-icons option)

{singleIcon}: The icon corresponding the "single" option (see single-icons option)

### WHEN DISCONNECTED
Currently, no format replacements when disconnected.

## EXAMPLES

```
"mpd": {
	"format": "{stateIcon} {consumeIcon}{randomIcon}{repeatIcon}{singleIcon}{artist} - {album} - {title} ({elapsedTime:%M:%S}/{totalTime:%M:%S}) ",
	"format-disconnected": "Disconnected ",
	"format-stopped": "{consumeIcon}{randomIcon}{repeatIcon}{singleIcon}Stopped ",
	"interval": 2,
	"consume-icons": {
		"on": " " // Icon shows only when "consume" is on
	},
	"random-icons": {
		"off": "<span color="#f53c3c"></span> ", // Icon grayed out when "random" is off
		"on": " "
	},
	"repeat-icons": {
		"on": " "
	},
	"single-icons": {
		"on": "1 "
	},
	"state-icons": {
		"paused": "",
		"playing": ""
	},
	"tooltip-format": "MPD (connected)",
	"tooltip-format-disconnected": "MPD (disconnected)"
}
```

## STYLE
•#mpd

•#mpd.disconnected

•#mpd.stopped

•#mpd.playing

•#mpd.paused


waybar-network

title: waybar-network(5)

text:
# waybar-network(5)

## NAME
waybar - network module

## DESCRIPTION
The network module displays information about the current network connections.

## CONFIGURATION
Addressed by network

interface:

typeof: string

Use the defined interface instead of auto detection. Accepts wildcard.

interval:

typeof: integer

default: 60

The interval in which the network information gets polled (e.g. signal strength).

family:

typeof: string

default: ipv4

The address family that is used for the format replacement {ipaddr} and to determine if a network connection is present.

format:

typeof: string

default: {ifname}

The format, how information should be displayed. This format is used when other formats aren't specified.

format-ethernet:

typeof: string

This format is used when an ethernet interface is displayed.

format-wifi:

typeof: string

This format is used when a wireless interface is displayed.

format-linked:

typeof: string

This format is used when a linked interface with no ip address is displayed.

format-disconnected:

typeof: string

This format is used when the displayed interface is disconnected.

format-disabled:

typeof: string

This format is used when the displayed interface is disabled.

format-icons:

typeof: array/object

Based on the current signal strength, the corresponding icon gets selected.

The order is low to high. Or by the state if it is an object.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

tooltip-format:

typeof: string

The format, how information should be displayed in the tooltip. This format is used when other formats aren't specified.

tooltip-format-ethernet:

typeof: string

This format is used when an ethernet interface is displayed.

tooltip-format-wifi:

typeof: string

This format is used when a wireless interface is displayed.

tooltip-format-disconnected:

typeof: string

This format is used when the displayed interface is disconnected.

tooltip-format-disabled:

typeof: string

This format is used when the displayed interface is disabled.

## FORMAT REPLACEMENTS
{ifname}: Name of the network interface.

{ipaddr}: The first IP of the interface.

{gwaddr}: The default gateway for the interface

{netmask}: The subnetmask corresponding to the IP.

{cidr}: The subnetmask corresponding to the IP in CIDR notation.

{essid}: Name (SSID) of the wireless network.

{signalStrength}: Signal strength of the wireless network.

{signaldBm}: Signal strength of the wireless network in dBm.

{frequency}: Frequency of the wireless network in MHz.

{bandwidthUpBits}: Instant up speed in bits/seconds.

{bandwidthDownBits}: Instant down speed in bits/seconds.

{bandwidthUpOctets}: Instant up speed in octets/seconds.

{bandwidthDownOctets}: Instant down speed in octets/seconds.

{icon}: Icon, as defined in format-icons.

## EXAMPLES

```
"network": {
	"interface": "wlp2s0",
	"format": "{ifname}",
	"format-wifi": "{essid} ({signalStrength}%) ",
	"format-ethernet": "{ifname} ",
	"format-disconnected": "", //An empty format will hide the module.
	"format-disconnected": "",
	"tooltip-format": "{ifname}",
	"tooltip-format-wifi": "{essid} ({signalStrength}%) ",
	"tooltip-format-ethernet": "{ifname} ",
	"tooltip-format-disconnected": "Disconnected",
	"max-length": 50
}
```

## STYLE
•#network

•#network.disconnected

•#network.disabled

•#network.linked

•#network.ethernet

•#network.wifi


waybar-pulseaudio

title: waybar-pulseaudio(5)

text:
# waybar-pulseaudio(5)

## NAME
waybar - pulseaudio module

## DESCRIPTION
The pulseaudio module displays the current volume reported by PulseAudio.

Additionally you can control the volume by scrolling up or down while the cursor is over the module.

## CONFIGURATION
format:

typeof: string

default: {volume}%

The format, how information should be displayed. This format is used when other formats aren't specified.

format-bluetooth:

typeof: string

This format is used when using bluetooth speakers.

format-muted:

typeof: string

This format is used when the sound is muted.

format-source:

typeof: string

default: {volume}%

This format used for the source.

format-source-muted:

typeof: string

This format is used when the source is muted.

format-icons:

typeof: array

Based on the current port-name and volume, the corresponding icon gets selected. The order is low to high. See Icons.

rotate:

typeof: integer

Positive value to rotate the text label.

states:

typeof: array

A number of volume states which get activated on certain volume levels. See waybar-states(5)

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

scroll-step:

typeof: float

default: 1.0

The speed in which to change the volume when scrolling.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module. This replaces the default behaviour of volume control.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module. This replaces the default behaviour of volume control.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{desc}: Pulseaudio port's description, for bluetooth it'll be the device name.

{volume}: Volume in percentage.

{icon}: Icon, as defined in format-icons.

{format_source}: Source format, format-source, format-source-muted.

## ICONS:
The following strings for format-icons are supported.

•the device name

If they are found in the current PulseAudio port name, the corresponding icons will be selected.

•default (Shown, when no other port is found)

•headphone

•speaker

•hdmi

•headset

•hands-free

•portable

•car

•hifi

•phone

## EXAMPLES

```
"pulseaudio": {
	"format": "{volume}% {icon}",
	"format-bluetooth": "{volume}% {icon}",
	"format-muted": "",
	"format-icons": {
		"alsa_output.pci-0000_00_1f.3.analog-stereo": "",
		"headphones": "",
		"handsfree": "",
		"headset": "",
		"phone": "",
		"portable": "",
		"car": "",
		"default": ["", ""]
	},
	"scroll-step": 1,
	"on-click": "pavucontrol"
}
```

## STYLE
•#pulseaudio

•#pulseaudio.bluetooth

•#pulseaudio.muted


waybar-river-tags

title: waybar-river-tags(5)

text:
# waybar-river-tags(5)

## NAME
waybar - river tags module

## DESCRIPTION
The tags module displays the current state of tags in river.

## CONFIGURATION
Addressed by river/tags

num-tags:

typeof: uint

default: 9

The number of tags that should be displayed. Max 32.

tag-labels:

typeof: array

The label to display for each tag.

disable-click:

typeof: bool

default: false

If set to false, you can left click to set focused tag. Right click to toggle tag focus. If set to true this behaviour is disabled.

## EXAMPLE

```
"river/tags": {

    "num-tags": 5
}
```

## STYLE
•#tags button

•#tags button.occupied

•#tags button.focused

•#tags button.urgent

Note that occupied/focused/urgent status may overlap. That is, a tag may be both occupied and focused at the same time.

## SEE ALSO
waybar(5), river(1)


waybar-river-window

title: waybar-river-window(5)

text:
# waybar-river-window(5)

## NAME
waybar - river window module

## DESCRIPTION
The window module displays the title of the currently focused window in river

## CONFIGURATION
Addressed by river/window

format:

typeof: string

default: {}

The format, how information should be displayed. On {} data gets inserted.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

## EXAMPLES

```
"river/window": {

    "format": "{}"
}
```

## STYLE
•#window

•#window.focused Applied when the output this module's bar belongs to is focused..RE


waybar-sndio

title: waybar-sndio(5)

text:
# waybar-sndio(5)

## NAME
waybar - sndio module

## DESCRIPTION
The sndio module displays the current volume reported by sndio(7).

Additionally, you can control the volume by scrolling up or down while the cursor is over the module, and clicking on the module toggles mute.

## CONFIGURATION
format:

typeof: string

default: {volume}%

The format for how information should be displayed.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

scroll-step:

typeof: int

default: 5

The speed in which to change the volume when scrolling.

on-click:

typeof: string

Command to execute when clicked on the module.

This replaces the default behaviour of toggling mute.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

This replaces the default behaviour of volume control.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

This replaces the default behaviour of volume control.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

## FORMAT REPLACEMENTS
{volume}: Volume in percentage.

{raw_value}: Volume as value reported by sndio.

## EXAMPLES

```
"sndio": {

    "format": "{raw_value} 🎜",

    "scroll-step": 3
}
```

## STYLE
•#sndio

•#sndio.muted


waybar-states

title: waybar-states(5)

text:
# waybar-states(5)

## OVERVIEW
Some modules support 'states' which allows percentage values to be used as styling triggers to apply a class when the value matches the declared state value.

## STATES
•Every entry (state) consists of a <name> (typeof: string) and a <value> (typeof: integer).

•The state can be addressed as a CSS class in the style.css. The name of the CSS class is the <name> of the state. Each class gets activated when the current capacity is equal or below the configured <value>.

•Also each state can have its own format. Those can be configured via format-<name>. Or if you want to differentiate a bit more even as format-<status>-<state>.

## EXAMPLE

```
"battery": {
	"bat": "BAT2",
	"interval": 60,
	"states": {
		"warning": 30,
		"critical": 15
	},
	"format": "{capacity}% {icon}",
	"format-icons": ["", "", "", "", ""],
	"max-length": 25
}
```

## STYLING STATES
•#battery.<state> - <state> can be defined in the config.

## EXAMPLE:
•#battery.warning: { background: orange; }

•#battery.critical: { background: red; }


waybar-sway-language

title: waybar-sway-language(5)

text:
# waybar-sway-language(5)

## NAME
waybar - sway language module

## DESCRIPTION
The language module displays the current keyboard layout in Sway

## CONFIGURATION
Addressed by sway/language

format:

typeof: string

default: {}

The format, how layout should be displayed.

tooltip-format:

typeof: string

default: {}

The format, how layout should be displayed in tooltip.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{short}: Short name of layout (e.g. "us"). Equals to {}.

{shortDescription}: Short description of layout (e.g. "en").

{long}: Long name of layout (e.g. "English (Dvorak)").

{variant}: Variant of layout (e.g. "dvorak").

{flag}: Country flag of layout.

## EXAMPLES

```
"sway/language": {

    "format": "{}",
},
"sway/language": {

    "format": "{short} {variant}",
}
```

## STYLE
•#language


waybar-sway-mode

title: waybar-sway-mode(5)

text:
# waybar-sway-mode(5)

## NAME
waybar - sway mode module

## DESCRIPTION
The mode module displays the current binding mode of Sway

## CONFIGURATION
Addressed by sway/mode

format:

typeof: string

default: {}

The format, how information should be displayed. On {} data gets inserted.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## EXAMPLES

```
"sway/mode": {

    "format": " {}",

    "max-length": 50
}
```

## STYLE
•#mode


waybar-sway-window

title: waybar-sway-window(5)

text:
# waybar-sway-window(5)

## NAME
waybar - sway window module

## DESCRIPTION
The window module displays the title of the currently focused window in Sway

## CONFIGURATION
Addressed by sway/window

format:

typeof: string

default: {}

The format, how information should be displayed. On {} data gets inserted.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

rewrite:

typeof: object

Rules to rewrite window title. See rewrite rules.

icon:

typeof: bool

default: false

Option to hide the application icon.

icon-size:

typeof: integer

default: 24

Option to change the size of the application icon.

## REWRITE RULES
rewrite is an object where keys are regular expressions and values are rewrite rules if the expression matches. Rules may contain references to captures of the expression.

Regular expression and replacement follow ECMA-script rules.

If no expression matches, the title is left unchanged.

Invalid expressions (e.g., mismatched parentheses) are skipped.

## EXAMPLES

```
"sway/window": {

    "format": "{}",

    "max-length": 50,

    "rewrite": {

      "(.*) - Mozilla Firefox": "🌎 $1",

      "(.*) - zsh": "> [$1]"

    }
}
```

## STYLE
•#window

•window#waybar.empty When no windows is in the workspace

•window#waybar.solo When one window is in the workspace

•window#waybar.<app_id> Where app_id is the app_id or instance name like (chromium) of the only window in the workspace


waybar-sway-workspaces

title: waybar-sway-workspaces(5)

text:
# waybar-sway-workspaces(5)

## NAME
waybar - sway workspaces module

## DESCRIPTION
The workspaces module displays the currently used workspaces in Sway.

## CONFIGURATION
Addressed by sway/workspaces

all-outputs:

typeof: bool

default: false

If set to false, workspaces will only be shown on the output they are on. If set to true all workspaces will be shown on every output.

format:

typeof: string

default: {value}

The format, how information should be displayed.

format-icons:

typeof: array

Based on the workspace name and state, the corresponding icon gets selected. See icons.

disable-scroll:

typeof: bool

default: false

If set to false, you can scroll to cycle through workspaces. If set to true this behaviour is disabled.

disable-click:

typeof: bool

default: false

If set to false, you can click to change workspace. If set to true this behaviour is disabled.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

disable-scroll-wraparound:

typeof: bool

default: false

If set to false, scrolling on the workspace indicator will wrap around to the first workspace when reading the end, and vice versa. If set to true this behavior is disabled.

enable-bar-scroll:

typeof: bool

default: false

If set to false, you can't scroll to cycle throughout workspaces from the entire bar. If set to true this behaviour is enabled.

disable-markup:

typeof: bool

default: false

If set to true, button label will escape pango markup.

current-only:

typeof: bool

default: false

If set to true. Only focused workspaces will be shown.

persistent_workspaces:

typeof: json (see below)

default: empty

Lists workspaces that should always be shown, even when non existent

on-update:

typeof: string

Command to execute when the module is updated.

disable-auto-back-and-forth:

typeof: bool

Whether to disable workspace_auto_back_and_forth when clicking on workspaces. If this is set to true, clicking on a workspace you are already on won't do anything, even if workspace_auto_back_and_forth is enabled in the Sway configuration.

## FORMAT REPLACEMENTS
{value}: Name of the workspace, as defined by sway.

{name}: Number stripped from workspace value.

{icon}: Icon, as defined in format-icons.

{index}: Index of the workspace.

## ICONS
Additional to workspace name matching, the following format-icons can be set.

•default: Will be shown, when no string matches is found.

•urgent: Will be shown, when workspace is flagged as urgent

•focused: Will be shown, when workspace is focused

•persistent: Will be shown, when workspace is persistent one.

## PERSISTENT WORKSPACES
Each entry of persistent_workspace names a workspace that should always be shown. Associated with that value is a list of outputs indicating where the workspace should be shown, an empty list denoting all outputs.

```
"sway/workspaces": {

    "persistent_workspaces": {

        "3": [], // Always show a workspace with name '3', on all outputs if it does not exists

        "4": ["eDP-1"], // Always show a workspace with name '4', on output 'eDP-1' if it does not exists

        "5": ["eDP-1", "DP-2"] // Always show a workspace with name '5', on outputs 'eDP-1' and 'DP-2' if it does not exists

    }
}
```

n.b.: the list of outputs can be obtained from command line using swaymsg -t get_outputs

## EXAMPLES

```
"sway/workspaces": {

    "disable-scroll": true,

    "all-outputs": true,

    "format": "{name}: {icon}",

    "format-icons": {

        "1": "",

        "2": "",

        "3": "",

        "4": "",

        "5": "",

        "urgent": "",

        "focused": "",

        "default": ""

    }
}
```

## Style
•#workspaces button

•#workspaces button.visible

•#workspaces button.focused

•#workspaces button.urgent

•#workspaces button.persistent

•#workspaces button.current_output

•#workspaces button#sway-workspace-${name}


waybar-temperature

title: waybar-temperature(5)

text:
# waybar-temperature(5)

## NAME
waybar - temperature module

## DESCRIPTION
The temperature module displays the current temperature from a thermal zone.

## CONFIGURATION
Addressed by temperature

thermal-zone:

typeof: integer

The thermal zone, as in /sys/class/thermal/.

hwmon-path:

typeof: string

The temperature path to use, e.g. /sys/class/hwmon/hwmon2/temp1_input instead of one in /sys/class/thermal/.

hwmon-path-abs:

typeof: string

The path of the hwmon-directory of the device, e.g. /sys/devices/pci0000:00/0000:00:18.3/hwmon. (Note that the subdirectory hwmon/hwmon#, where # is a number is not part of the path!) Has to be used together with input-filename.

input-filename:

typeof: string

The temperature filename of your hwmon-path-abs, e.g. temp1_input

critical-threshold:

typeof: integer

The threshold before it is considered critical (Celsius).

interval:

typeof: integer

default: 10

The interval in which the information gets polled.

format-critical:

typeof: string

The format to use when temperature is considered critical

format:

typeof: string

default: {temperatureC}°C

The format (Celsius/Fahrenheit/Kelvin) in which the temperature should be displayed.

format-icons:

typeof: array

Based on the current temperature (Celsius) and critical-threshold if available, the corresponding icon gets selected. The order is low to high.

tooltip-format:

typeof: string

default: {temperatureC}°C

The format for the tooltip

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in characters the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.

on-click:

typeof: string

Command to execute when you clicked on the module.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mousewheel.

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{temperatureC}: Temperature in Celsius.

{temperatureF}: Temperature in Fahrenheit.

{temperatureK}: Temperature in Kelvin.

## EXAMPLES

```
 "temperature": {
	// "thermal-zone": 2,
	// "hwmon-path": "/sys/class/hwmon/hwmon2/temp1_input",
	// "critical-threshold": 80,
	// "format-critical": "{temperatureC}°C ",
	"format": "{temperatureC}°C "
}
```

## STYLE
•#temperature

•#temperature.critical


waybar-tray

title: waybar-tray(5)

text:
# waybar-tray(5)

## NAME
waybar - tray module

## DESCRIPTION
WARNING tray is still in beta. There may me bugs. Breaking changes may occur.

## CONFIGURATION
Addressed by tray

icon-size:

typeof: integer

Defines the size of the tray icons.

show-passive-items:

typeof: bool

default: false

Defines visibility of the tray icons with Passive status.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

spacing:

typeof: integer

Defines the spacing between the tray icons.

reverse-direction:

typeof: bool

Defines if new app icons should be added in a reverse order

on-update:

typeof: string

Command to execute when the module is updated.

## EXAMPLES

```
"tray": {

    "icon-size": 21,

    "spacing": 10
}
```

## STYLE
•#tray

•#tray > .passive

•#tray > .active

•#tray > .needs-attention


waybar-upower

title: waybar-upower(5)

text:
# waybar-upower(5)

## NAME
waybar - upower module

## DESCRIPTION
The upower module displays the main battery capacity with all other upower compatible devices in the tooltip.

## CONFIGURATION
icon-size:

typeof: integer

default: 20

Defines the size of the icons.

format:

typeof: string

default: {percentage}

The text format.

format-alt:

typeof: string

default: {percentage} {time}

The text format when toggled.

hide-if-empty:

typeof: bool

default: true

Defines visibility of the module if no devices can be found.

tooltip:

typeof: bool

defualt: true

Option to disable tooltip on hover.

tooltip-spacing:

typeof: integer

default: 4

Defines the spacing between the tooltip device name and device battery

status.

tooltip-padding:

typeof: integer

default: 4

Defines the spacing between the tooltip window edge and the tooltip content.

## FORMAT REPLACEMENTS
{percentage}: The battery capacity in percentage

{time}: An estimated time either until empty or until fully charged

depending on the charging state.

## EXAMPLES

```
"upower": {
	"icon-size": 20,
	"hide-if-empty": true,
	"tooltip": true,
	"tooltip-spacing": 20
}
```

## STYLE
•#upower

•#upower.charging

•#upower.discharging

•#upower.full

•#upower.empty

•#upower.unknown-status


waybar-wlr-taskbar

title: waybar-wlr-taskbar(5)

text:
# waybar-wlr-taskbar(5)

## NAME
wlroots - Taskbar module

## DESCRIPTION
The taskbar module displays the currently open applications. This module requires a compositor that implements the foreign-toplevel-manager interface.

## CONFIGURATION
Addressed by wlr/taskbar

all-outputs:

typeof: bool

default: false

If set to false applications on the waybar's current output will be shown. Otherwise all applications are shown.

format:

typeof: string

default: {icon}

The format, how information should be displayed.

icon-theme:

typeof: array|string

The names of the icon-themes that should be used to find an icon. The list will be traversed from left to right. If omitted, the system default will be used.

icon-size:

typeof: integer

default: 16

The size of the icon.

markup:

typeof: bool

default: false

If set to true, pango markup will be accepted in format and tooltip-format.

tooltip:

typeof: bool

default: true

If set to false no tooltip will be shown.

tooltip-format:

typeof: string

default: {title}

The format, how information in the tooltip should be displayed.

active-first:

typeof: bool

default: false

If set to true, always reorder the tasks in the taskbar so that the currently active one is first. Otherwise don't reorder.

on-click:

typeof: string

The action which should be triggered when clicking on the application button with the left mouse button.

on-click-middle:

typeof: string

The action which should be triggered when clicking on the application button with the middle mouse button.

on-click-right:

typeof: string

The action which should be triggered when clicking on the application button with the right mouse button.

on-update:

typeof: string

Command to execute when the module is updated.

ignore-list:

typeof: array

List of app_id/titles to be invisible.

app_ids-mapping:

typeof: object

Dictionary of app_id to be replaced with

## FORMAT REPLACEMENTS
{icon}: The icon of the application.

{title}: The application name as in desktop file if appropriate desktop fils found, otherwise same as {app_id}

{title}: The title of the application.

{app_id}: The app_id (== application name) of the application.

{state}: The state (minimized, maximized, active, fullscreen) of the application.

{short_state}: The state (minimize == m, maximized == M, active == A, fullscreen == F) represented as one character of the application.

## CLICK ACTIONS
activate: Bring the application into foreground.

minimize: Toggle application's minimized state.

minimize-raise: Bring the application into foreground or toggle its minimized state.

maximize: Toggle application's maximized state.

fullscreen: Toggle application's fullscreen state.

close: Close the application.

## EXAMPLES

```
"wlr/taskbar": {
	"format": "{icon}",
	"icon-size": 14,
	"icon-theme": "Numix-Circle",
	"tooltip-format": "{title}",
	"on-click": "activate",
	"on-click-middle": "close",
	"ignore-list": [
	    "Alacritty"
	],
	"app_ids-mapping": {
		"firefoxdeveloperedition": "firefox-developer-edition"
	}
}
```

## Style
•#taskbar

•#taskbar button

•#taskbar button.maximized

•#taskbar button.minimized

•#taskbar button.active

•#taskbar button.fullscreen


waybar-wlr-workspaces

title: waybar-wlr-workspaces(5)

text:
# waybar-wlr-workspaces(5)

## NAME
waybar - wlr workspaces module

## DESCRIPTION
The workspaces module displays the currently used workspaces in wayland compositor.

## CONFIGURATION
Addressed by wlr/workspaces

format:

typeof: string

default: {name}

The format, how information should be displayed.

format-icons:

typeof: array

Based on the workspace name and state, the corresponding icon gets selected. See icons.

sort-by-name:

typeof: bool

default: true

Should workspaces be sorted by name.

sort-by-coordinates:

typeof: bool

default: true

Should workspaces be sorted by coordinates.

Note that if both sort-by-name and sort-by-coordinates are true sort by name will be first. If both are false - sort by id will be performed.

all-outputs:

typeof: bool

default: false

If set to false workspaces group will be shown only in assigned output. Otherwise all workspace groups are shown.

active-only:

typeof: bool

default: false

If set to true only active or urgent workspaces will be shown.

## FORMAT REPLACEMENTS
{name}: Name of workspace assigned by compositor

{icon}: Icon, as defined in format-icons.

## CLICK ACTIONS
activate: Switch to workspace.

close: Close the workspace.

## ICONS
Additional to workspace name matching, the following format-icons can be set.

•default: Will be shown, when no string match is found.

•focused: Will be shown, when workspace is focused

## EXAMPLES

```
"wlr/workspaces": {
	"format": "{name}: {icon}",
	"format-icons": {
		"1": "",
		"2": "",
		"3": "",
		"4": "",
		"5": "",
		"focused": "",
		"default": ""
	}
}
```

## Style
•#workspaces

•#workspaces button

•#workspaces button.active

•#workspaces button.urgent

•#workspaces button.hidden


ignore.list

package: websec

title: ignore.list(5)

summary: websec url monitoring configuration

text:
# ignore.list(5)

## NAME
ignore.list - websec url monitoring configuration

## DESCRIPTION

### IGNORE KEYWORDS
When determining which parts of a particular web page has changed, you may want to skip those paragraphs that contains certain predefined words. For example, pages like InfoWorld, PC Magazine and PC Week often contain the current date/time regardless of whether there is new or changed content. In such cases, you can use IGNORE KEYWORDS to skip those paragraphs which contains date/time information.

Ignore keywords are stored in a file called "ignore.list" in the same directory as websec. Like the URL list, the ignore keywords are partitioned into different sections. Each section has a user-defined name. An example is shown below:

```
        [General]
        all rights reserved
        an error occurred
        click here
        comments
        copyright
        [Date_Time]
        January\s+\d{1,2}
        February\s+\d{1,2}
        March\s+\d{1,2}
        April\s+\d{1,2}
        May\s+\d{1,2}
```

In the example above, there are two sections: "General" and "Date_Time". You can use them in the URL list as follows:

```
    Ignore = General
```

You can also use multiple sections at one go:

```
    Ignore = General,Date_Time
```

If you use certain ignore keywords regularly, you might want to add them to a defaults section in the URL list.

Ignore keywords can contain regular expressions. For example, the ignore keyword "January\s+\d{1,2}" tells websec to look for the string "January", followed by one or more spaces, followed by at least one but not more than two digits.

Two sections of ignore keywords are supplied in this distribution. "General" contains some general ignore keywords which you may want to use. "Date_Time" contains date/time detectors coded using regular expressions. Feel free to add your own!

### IGNORE URLS
Most advertisements in webpages are of the following form:

```
        <A HREF="http://page.url.com/advert/cgi-bin/" ...>
        <IMG SRC="advert.animated.gif" ...>
        Click here for free beer!
        </A>
```

Such advertisements can be ignored when running webdiff using ignore URLs.

Ignore URLs are also stored in "ignore.list". They contain all of parts of the URL referred to by the <A HREF> tag which you want to ignore. An example is shown below:

```
        [Adverts]
        page.url.com/advert/cgi-bin/
```

Use the "Adverts" section in the URL list as follows:

```
    IgnoreURL = Adverts
```

You can also use multiple sections at one go:

```
    IgnoreURL = Adverts1,Adverts2
```

If you use certain ignore URLs regularly, you might want to add them to a defaults section in the URL list.

Like ignore keywords, ignore URLs can contain regular expressions.

An "Adverts" section is supplied in this distribution. Feel free to add your own!

## SEE ALSO
url.list(5)

## AUTHOR
Baruch Even <websec@ev-en.org> is maintaining this program.


url.list

title: url.list(5)

summary: websec url monitoring configuration

text:
# url.list(5)

## NAME
url.list - websec url monitoring configuration

## DESCRIPTION
The URL list consists of one or more sections separated by newlines. You can have sections without a URL, they will update the defaults for all the subsequenet blocks. The Name and Prefix parameters are required as well as one of Email, EmailLink and Program. The rest are completely optional.

The following parameters (case-sensitive) are recognized in each section:

```
    URL        - URL of web page to monitor
    Name       - Name of web site. Pages delivered to you will have the
                 following format: "Name - Date (Day)" eg. "PC Magazine - 4
                 Sep 98 (Fri)"
    Prefix     - Prefix of filenames for archive files of web pages created
                 by Web Secretary.
    Email      - Comma-delimited list of email addresses to send highlighted
                 pages to.
    EmailLink  - Comma-delimited list of email addresses to send URL of
                 changed pages to.
    Program    - application to call with the diff-file, special cases:
                 "mozilla", pages are opened in new tabs,
                 "konqueror", pages are opened using "kfmclient openURL"
    Auth       - Authentication information in "username:password" format.
                 Put "none" if no authentication needed.
    Diff       - Put "none" if you want Web Secretary to always mail this
                 page to you instead of checking for and highlighting
                 changes in the page.  Put "webdiff" if you want Web
                 Secretary to check for changes.
                 Put "htmldiff" to use a different implementation of HTML
                 diff output. Note that you need to install the perl-modules
                 Algorithm::Diff and HTML::Diff which are availabe on
                 http://www.cpan.org/ for this to work.
    Hicolor   -  Color used to highlight new or changed content. Currently,
                 four colors are defined. They are: blue, pink, yellow and
                 grey. You can also supply your own HTML color tag in the
                 form "#rrggbb".
    Ignore     - Comma-delimited List of section names containing ignore
                 keywords. There must be NO SPACES between delimiters and
                 section names. The ignore sections and keywords are stored
                 in a file called "ignore.list".
    IgnoreURL  - Comma-delimited List of section names containing ignore
                 URLs. There must be NO SPACES between delimiters and
                 section names. The ignore sections and keywords are stored
                 in a file called "ignore.list".
    AsciiMarker - If set to 1 it will add ascii markers around the changes so
                     that highlighting is noticeable in text mode too. Useful for
                                 text MUAs users.
    Tmin       - Every token containing <= Tmin words will not be highlighted
                 for differences.
    Tmax       - Every token containing >= Tmax words will not be checked for
                 ignore keywords.
    Proxy      - Specify proxy "http://your.proxy.here:portnum" if you are
                 using one. (Alternatively, you can make use of the
                 "http_proxy" environment variable)
    ProxyAuth  - Specify proxy authentication in "username:password" format.
                 The code for this feature was contributed by Volker Stampa.
    MailFrom   - The E-Mail address to send mail from, this can be left empty
                 and the user used to run websec will be used.
    ProgramDigest - If specified "true", websec does not open all changed pages
                 separately with the application specified in "Program", but opens
                 a summary page that contains links to all changed pages.
    Digest     - true|false or yes|no. This works only if EmailLink is
                 specified. It consolidates all the changed URLs and sends
                 them in one email.
    UserAgent  - The User-Agent that will be sent by the web client. This can
                 be used to bypass servers that prevent access based on the user
                 agent.
    DateFMT    - Date format to use in e-mail messages, can be empty for no date.
                 Set it to " - %Y-%m-%d" for ISO dates. This is perl format for dates.
    RandomWait - Websec waits for a random number of seconds between retries up
                 to the value specified by the RandomWait keyword. This is to
                 prevent websec from being blocked by websites that perform log
                 analysis to find time similarities between requests.
```

Any line which begins with a '#' is treated as comment and ignored.

If a section does not contain a URL entry, the values provided will be treated as the default for the following sections.

For example,

```
    # Defaults
    Auth = none
    Diff = webdiff
    Hicolor = blue
    Ignore = General,Date_Time
    IgnoreURL = Adverts
    Tmin = 1
    Tmax = 10
    Proxy = http://proxy.nus.edu.sg:8080
    Email = vchew@post1.com
    # Web page to monitor which does not require authentication
    URL = http://browserwatch.iworld.com/news.html
    Name = Browser Watch
    Prefix = browsewatch
    # New defaults with authentication information
    Auth = user:password
    # More web pages to monitor which requires authentication
    URL = http://www.infoworld.com
    Name = Infoworld
    Prefix = infoworld
    URL = http://developer.javasoft.com/
    Name = Java Developer Central
    Prefix = jdc
```

## SEE ALSO
ignore.list(5)

## AUTHOR
Baruch Even <websec@ev-en.org> is maintaining this program.


weston.ini

package: weston

title: weston.ini(5)

summary: configuration file for

text:
# weston.ini(5)

## NAME
weston.ini - configuration file for Weston - the reference Wayland compositor

## INTRODUCTION
Weston obtains configuration from its command line parameters and the configuration file described here.

## DESCRIPTION
Weston uses a configuration file called weston.ini for its setup. The weston.ini configuration file is searched for in one of the following places when the server is started:

```
$XDG_CONFIG_HOME/weston.ini   (if $XDG_CONFIG_HOME is set)
$HOME/.config/weston.ini      (if $HOME is set)
weston/weston.ini in each
    $XDG_CONFIG_DIR           (if $XDG_CONFIG_DIRS is set)
/etc/xdg/weston/weston.ini    (if $XDG_CONFIG_DIRS is not set)
```

where environment variable $HOME is the user's home directory, and $XDG_CONFIG_HOME is the user specific configuration directory, and $XDG_CONFIG_DIRS is a colon ':' delimited listed of configuration base directories, such as /etc/xdg-foo:/etc/xdg.

The weston.ini file is composed of a number of sections which may be present in any order, or omitted to use default configuration values. Each section has the form:

```
[SectionHeader]
Key1=Value1
Key2=Value2

    ...
```

The spaces are significant. Comment lines are ignored:

```
#comment
```

The section headers are:

```
core           The core modules and options
libinput       Input device configuration
shell          Desktop customization
launcher       Add launcher to the panel
output         Output configuration
input-method   Onscreen keyboard input
keyboard       Keyboard layouts
terminal       Terminal application options
xwayland       XWayland options
screen-share   Screen sharing options
```

Possible value types are string, signed and unsigned 32-bit integer, and boolean. Strings must not be quoted, do not support any escape sequences, and run till the end of the line. Integers can be given in decimal (e.g. 123), octal (e.g. 0173), and hexadecimal (e.g. 0x7b) form. Boolean values can be only 'true' or 'false'.

## CORE SECTION
The core section is used to select the startup compositor modules and general options.

shell=desktop-shell.so

specifies a shell to load (string). This can be used to load your own implemented shell or one with Weston as default. Available shells in the /usr/lib64/weston directory are:

```
desktop-shell.so
```

xwayland=true

ask Weston to load the XWayland module (boolean).

modules=cms-colord.so,screen-share.so

specifies the modules to load (string). Available modules in the /usr/lib64/weston directory are:

```
cms-colord.so
screen-share.so
```

backend=headless-backend.so

overrides defaults backend. Available backend modules in the /usr/lib64/libweston-9 directory are:

```
drm-backend.so
fbdev-backend.so
headless-backend.so
rdp-backend.so
wayland-backend.so
x11-backend.so
```

repaint-window=N

Set the approximate length of the repaint window in milliseconds. The repaint window is used to control and reduce the output latency for clients. If the window is longer than the output refresh period, the repaint will be done immediately when the previous repaint finishes, not processing client requests in between. If the repaint window is too short, the compositor may miss the target vertical blank, increasing output latency. The default value is 7 milliseconds. The allowed range is from -10 to 1000 milliseconds. Using a negative value will force the compositor to always miss the target vblank.

gbm-format=format

sets the GBM format used for the framebuffer for the GBM backend. Can be xrgb8888, xrgb2101010, rgb565. By default, xrgb8888 is used.

idle-time=seconds

sets Weston's idle timeout in seconds. This idle timeout is the time after which Weston will enter an "inactive" mode and screen will fade to black. A value of 0 disables the timeout. Important : This option may also be set via Weston's '-i' command line option and will take precedence over the current .ini option. This means that if both weston.ini and command line define this idle-timeout time, the one specified in the command-line will be used. On the other hand, if none of these sets the value, default idle timeout will be set to 300 seconds.

require-input=true

require an input device for launch

pageflip-timeout=milliseconds

sets Weston's pageflip timeout in milliseconds. This sets a timer to exit gracefully with a log message and an exit code of 1 in case the DRM driver is non-responsive. Setting it to 0 disables this feature.

wait-for-debugger=true

Raises SIGSTOP before initializing the compositor. This allows the user to attach with a debugger and continue execution by sending SIGCONT. This is useful for debugging a crash on start-up when it would be inconvenient to launch weston directly from a debugger. Boolean, defaults to false. There is also a command line option to do the same.

remoting=remoting-plugin.so

specifies a plugin for remote output to load (string). This can be used to load your own implemented remoting plugin or one with Weston as default. Available remoting plugins in the __libweston_modules_dir__ directory are:

```
remoting-plugin.so
```

use-pixman=true

Enables pixman-based rendering for all outputs on backends that support it. Boolean, defaults to false. There is also a command line option to do the same.

## LIBINPUT SECTION
The libinput section is used to configure input devices when using the libinput input device backend. The defaults are determined by libinput and vary according to what is most sensible for any given device.

Available configuration are:

enable-tap=false

Enables tap to click on touchpad devices.

tap-and-drag=false

For touchpad devices with enable-tap enabled. If the user taps, then taps a second time, this time holding, the virtual mouse button stays down for as long as the user keeps their finger on the touchpad, allowing the user to click and drag with taps alone.

tap-and-drag-lock=false

For touchpad devices with enable-tap and tap-and-drag enabled. In the middle of a tap-and-drag, if the user releases the touchpad for less than a certain number of milliseconds, then touches it again, the virtual mouse button will remain pressed and the drag can continue.

disable-while-typing=true

For devices that may be accidentally triggered while typing on the keyboard, causing a disruption of the typing. Disables them while the keyboard is in use.

middle-button-emulation=false

For pointer devices with left and right buttons, but no middle button. When enabled, a middle button event is emitted when the left and right buttons are pressed simultaneously.

left-handed=false

Configures the device for use by left-handed people. Exactly what this option does depends on the device. For pointers with left and right buttons, the buttons are swapped. On tablets, the tablet is logically turned upside down, because it will be physically turned upside down.

rotation=n

Changes the direction of the logical north, rotating it n degrees clockwise away from the default orientation, where n is a whole number between 0 and 359 inclusive. Needed for trackballs, mainly. Allows the user to orient the trackball sideways, for example.

accel-profile={flat,adaptive}

Set the pointer acceleration profile. The pointer's screen speed is proportional to the physical speed with a certain constant of proportionality. Call that constant alpha. flat keeps alpha fixed. See accel-speed. adaptive causes alpha to increase with physical speed, giving the user more control when the speed is slow, and more reach when the speed is high. adaptive is the default.

accel-speed=v

If accel-profile is set to flat, it simply sets the value of alpha. If accel-profile is set to adaptive, the effect is more complicated, but generally speaking, it will change the pointer's speed. v is normalised and must lie in the range [-1, 1]. The exact mapping between v and alpha is hardware-dependent, but higher values cause higher cursor speeds.

natural-scroll=false

Enables natural scrolling, mimicking the behaviour of touchscreen scrolling. That is, if the wheel, finger, or fingers are moved down, the surface is scrolled up instead of down, as if the finger, or fingers were in contact with the surface being scrolled.

scroll-method={two-finger,edge,button,none}

Sets the scroll method. two-finger scrolls with two fingers on a touchpad. edge scrolls with one finger on the right edge of a touchpad. button scrolls when the pointer is moved while a certain button is pressed. See scroll-button. none disables scrolling altogether.

scroll-button={BTN_LEFT,BTN_RIGHT,BTN_MIDDLE,...}

For devices with scroll-method set to button. Specifies the button that will trigger scrolling. See /usr/include/linux/input-event-codes.h for the complete list of possible values.

touchscreen_calibrator=true

Advertise the touchscreen calibrator interface to all clients. This is a potential denial-of-service attack vector, so it should only be enabled on trusted userspace. Boolean, defaults to false. The interface is required for running touchscreen calibrator applications. It provides the application raw touch events, bypassing the normal touch handling. It also allows the application to upload a new calibration into the compositor.

Even though this option is listed in the libinput section, it does affect all Weston configurations regardless of the used backend. If the backend does not use libinput, the interface can still be advertised, but it will not list any devices.

calibration_helper=/bin/echo

An optional calibration helper program to permanently save a new touchscreen calibration. String, defaults to unset. The given program will be executed with seven arguments when a calibrator application requests the server to take a new calibration matrix into use. The program is executed synchronously and will therefore block Weston for its duration. If the program exit status is non-zero, Weston will not apply the new calibration. If the helper is unset or the program exit status is zero, Weston will use the new calibration immediately.

The program is invoked as:

calibration_helper syspath m1 m2 m3 m4 m5 m6

where syspath is the udev sys path for the device and m1 through m6 are the calibration matrix elements in libinput's LIBINPUT_CALIBRATION_MATRIX udev property format. The sys path is an absolute path and starts with the sys mount point.

## SHELL SECTION
The shell section is used to customize the compositor. Some keys may not be handled by different shell plugins.

The entries that can appear in this section are:

client=file

sets the path for the shell client to run. If not specified weston-desktop-shell is launched (string).

background-image=file

sets the path for the background image file (string).

background-type=tile

determines how the background image is drawn (string). Can be centered, scale, scale-crop or tile (default). Centered shows the image once centered. If the image is smaller than the output, the rest of the surface will be in background color. If the image size does fit the output it will be cropped left and right, or top and bottom. Scale means scaled to fit the output precisely, not preserving aspect ratio. Scale-crop preserves aspect ratio, scales the background image just big enough to cover the output, and centers it. The image ends up cropped from left and right, or top and bottom, if the aspect ratio does not match the output. Tile repeats the background image to fill the output.

background-color=0xAARRGGBB

sets the color of the background (unsigned integer). The hexadecimal digit pairs are in order alpha, red, green, and blue.

clock-format=format

sets the panel clock format (string). Can be none, minutes, seconds. By default, minutes format is used.

panel-color=0xAARRGGBB

sets the color of the panel (unsigned integer). The hexadecimal digit pairs are in order transparency, red, green, and blue. Examples:

```
0xffff0000    Red
0xff00ff00    Green
0xff0000ff    Blue
0x00ffffff    Fully transparent
```

panel-position=top

sets the position of the panel (string). Can be top, bottom, left, right, none.

locking=true

enables screen locking (boolean).

animation=zoom

sets the effect used for opening new windows (string). Can be zoom, fade, none. By default, no animation is used.

close-animation=fade

sets the effect used when closing windows (string). Can be fade, none. By default, the fade animation is used.

startup-animation=fade

sets the effect used for opening new windows (string). Can be fade, none. By default, the fade animation is used.

focus-animation=dim-layer

sets the effect used with the focused and unfocused windows. Can be dim-layer, none. By default, no animation is used.

allow-zap=true

whether the shell should quit when the Ctrl-Alt-Backspace key combination is pressed

binding-modifier=ctrl

sets the modifier key used for common bindings (string), such as moving surfaces, resizing, rotating, switching, closing and setting the transparency for windows, controlling the backlight and zooming the desktop. See weston-bindings(7). Possible values: none, ctrl, alt, super (default)

num-workspaces=6

defines the number of workspaces (unsigned integer). The user can switch workspaces by using the binding+F1, F2 keys. If this key is not set, fall back to one workspace.

cursor-theme=theme

sets the cursor theme (string).

cursor-size=24

sets the cursor size (unsigned integer).

lockscreen-icon=path

sets the path to lock screen icon image (string). (tablet shell only)

lockscreen=path

sets the path to lock screen background image (string). (tablet shell only)

homescreen=path

sets the path to home screen background image (string). (tablet shell only)

## LAUNCHER SECTION
There can be multiple launcher sections, one for each launcher.

icon=icon

sets the path to icon image (string). Svg images are not currently supported.

path=program

sets the path to the program that is run by clicking on this launcher (string). It is possible to pass arguments and environment variables to the program. For example:

```
path=GDK_BACKEND=wayland gnome-terminal --full-screen

```

## OUTPUT SECTION
There can be multiple output sections, each corresponding to one output. It is currently only recognized by the drm and x11 backends.

name=name

sets a name for the output (string). The backend uses the name to identify the output. All X11 output names start with a letter X. All Wayland output names start with the letters WL. The available output names for DRM backend are listed in the weston-launch(1) output. Examples of usage:

```
LVDS1    DRM backend, Laptop internal panel no.1
VGA1     DRM backend, VGA connector no.1
X1       X11 backend, X window no.1
WL1      Wayland backend, Wayland window no.1
```

See weston-drm(7) for more details.

mode=mode

sets the output mode (string). The mode parameter is handled differently depending on the backend. On the X11 backend, it just sets the WIDTHxHEIGHT of the weston window. The DRM backend accepts different modes, along with an option of a modeline string. See weston-drm(7) for examples of modes-formats supported by DRM backend.

transform=normal

How you have rotated your monitor from its normal orientation (string). The transform key can be one of the following 8 strings:

```
normal               Normal output.
rotate-90            90 degrees clockwise.
rotate-180           Upside down.
rotate-270           90 degrees counter clockwise.
flipped              Horizontally flipped
flipped-rotate-90    Flipped and 90 degrees clockwise
flipped-rotate-180   Flipped and upside down
flipped-rotate-270   Flipped and 90 degrees counter clockwise
```

scale=factor

The scaling multiplier applied to the entire output, in support of high resolution ("HiDPI" or "retina") displays, that roughly corresponds to the pixel ratio of the display's physical resolution to the logical resolution. Applications that do not support high resolution displays typically appear tiny and unreadable. Weston will scale the output of such applications by this multiplier, to make them readable. Applications that do support their own output scaling can draw their content in high resolution, in which case they avoid compositor scaling. Weston will not scale the output of such applications, and they are not affected by this multiplier.

An integer, 1 by default, typically configured as 2 or higher when needed, denoting the scaling multiplier for the output.

seat=name

The logical seat name that this output should be associated with. If this is set then the seat's input will be confined to the output that has the seat set on it. The expectation is that this functionality will be used in a multiheaded environment with a single compositor for multiple output and input configurations. The default seat is called "default" and will always be present. This seat can be constrained like any other.

allow_hdcp=true

Allows HDCP support for this output. If set to true, HDCP can be tried for the content-protection, provided by the backends, on this output. By default, HDCP support is always allowed for an output. The content-protection can actually be realized, only if the hardware (source and sink) support HDCP, and the backend has the implementation of content-protection protocol. Currently, HDCP is supported by drm-backend.

app-ids=app-id[,app_id]*

A comma separated list of the IDs of applications to place on this output. These IDs should match the application IDs as set with the xdg_shell.set_app_id request. Currently, this option is supported by kiosk-shell.

## INPUT-METHOD SECTION
path=/usr/lib64/weston/clients/weston-keyboard

sets the path of the on screen keyboard input method (string).

## KEYBOARD SECTION
This section contains the following keys:

keymap_rules=evdev

sets the keymap rules file (string). Used to map layout and model to input device.

keymap_model=pc105

sets the keymap model (string). See the Models section in xkeyboard-config(7).

keymap_layout=us,de,gb

sets the comma separated list of keyboard layout codes (string). See the Layouts section in xkeyboard-config(7).

keymap_variant=euro,,intl

sets the comma separated list of keyboard layout variants (string). The number of variants must be the same as the number of layouts above. See the Layouts section in xkeyboard-config(7).

keymap_options=grp:alt_shift_toggle,grp_led:scroll

sets the keymap options (string). See the Options section in xkeyboard-config(7).

repeat-rate=40

sets the rate of repeating keys in characters per second (unsigned integer)

repeat-delay=400

sets the delay in milliseconds since key down until repeating starts (unsigned integer)

numlock-on=false

sets the default state of the numlock on weston startup for the backends which support it.

vt-switching=true

Whether to allow the use of Ctrl+Alt+Fn key combinations to switch away from the compositor's virtual console.

## TERMINAL SECTION
Contains settings for the weston terminal application (weston-terminal). It allows to customize the font and shell of the command line interface.

font=DejaVu Sans Mono

sets the font of the terminal (string). For a good experience it is recommended to use monospace fonts. In case the font is not found, the default one is used.

font-size=14

sets the size of the terminal font (unsigned integer).

term=xterm-256color

The terminal shell (string). Sets the $TERM variable.

## XWAYLAND SECTION
path=/usr/bin/Xwayland

sets the path to the xserver to run (string).

## SCREEN-SHARE SECTION
command=/usr/bin/weston --backend=rdp-backend.so --shell=fullscreen-shell.so --no-clients-resize

sets the command to start a fullscreen-shell server for screen sharing (string).

## SEE ALSO
weston(1), weston-bindings(7), weston-drm(7), xkeyboard-config(7)


whois.conf

package: whois

title: whois.conf(5)

text:
# whois.conf(5)

## NAME
whois.conf - alternative WHOIS servers list for whois client

## SYNOPSIS
/etc/whois.conf

## DESCRIPTION
This file contains a list of WHOIS servers which can augment or override the built-in list of the client.

It's a plain text file in ASCII encoding. Each line consists of two fields: a pattern to match WHOIS object identifier and a corresponding WHOIS server domain name.

Fields are separated by non-empty sequence of space or a tabular characters. A line starting with a hash character is a free comment and it's not considered.

The pattern is case-insensitive extended regular expression if whois client has been compiled with POSIX regular expressions support. Otherwise, simple case-insensitive suffix comparison against WHOIS object identifier is used.

Internationalized domain names (IDN) must be specified in ascii-compatible encoding (ACE) format.

## EXAMPLE
\.nz$ nz.whois-servers.net

\# Hangul Korean TLD

\.xn--3e0b707e$ whois.kr

\# Private ASNs

^as645(1[2-9]|2[0-9]|3[0-4])$ whois.example.net

## FILES
/etc/whois.conf

## SEE ALSO
whois(1)

## AUTHOR
This manual page was written by Petr Písař <ppisar@redhat.com> and is licensed under the terms of the GNU General Public License, version 2 or higher.


whoson.conf

package: whoson

title: whoson.conf(5)

summary: whoson configuration file

text:
# whoson.conf(5)

## NAME
whoson.conf - whoson configuration file

## SYNOPSYS
/etc/whoson.conf

## DESCRIPTION
whoson.conf is the file that controls operation of both whosond(8) daemon and whoson(3) API functions.

### General structure
whoson.conf file contains of a serias of entries. Each entry starts with a line containing the word server or client from the first position, followed by a word specifying the entry type. Then, there may follow arbitrary number of keyword=value pairs, in the same line or in the continuation lines. Continuation lines start with whitespace. Hash (#) character specify the logical end of the line; comment may follow. All-whitespace lines are ignored.

### Server entry
There are currently 5 types of server entries: tcp, udp, unix, unixd, and global.

tcp server entry must contain port=number keyword-value pair and may contain keepalive=number, allow=pattern, deny=patternand listenq=number pairs.

udp server entry must contain port=number keyword-value pair and may contain allow=patternand deny=pattern pairs.

unix server entry must contain port=path keyword-value pair and may contain keepalive=numberand listenq=number pairs.

unixd server entry must contain port=path keyword-value pair.

global is a special server entry that contains parameters that are not specific to a particular communication protocol. Currntly supported global parameters are ttl=number, cachesize=number, user=userid, group=group id

port=number or port=path specifies the IP port number to listen on in dotted quad notation, or path name for UNIX domain socket.

allow=pattern and deny=pattern specify which clients are allowed to the server. pattern is dotted quad address followed by the number of bits to check after a slash (/) character. If that many bits of the peer IP address matches the address specified in the pattern, the pattern is considered matching. Of matching patterns, the one with maximum number of bits is used. By default, all clients are denied.

keepalive=number specifies the number of seconds to keep the connection to the client open when the client does not send any requests. This is only applicable to streaming connection protocols.

ttl=number is the global parameter specifying the number of seconds to keep an entry in the database if it is not deleted explicitly.

cachesize=number is the global parameter specifying the maximum number of entries to keep in the database.

chroot=path path to chdir and chroot into after the daemon binds to the sockets. It may be wise to set to some empty and not used by any other processes directory. Directory must exist. Only will work if the daemon is started by root.

user=userid is the (symbolic) user id to change to after the daemon binds to the sockets. It may be wise to set to nobody for security reasons. Only will work if the daemon is started by root.

group=group id - the same for group. If not specified, the group of the user is set.

listenq=number - size of listen(2) backlog queue. Defaults to 5 if not specified.

Example:

```
server tcp keepalive=600
	port=9876 allow=123.45.67.0/24
	deny=123.45.67.89/32
```

### Client entry
There are currently 4 types of client entries: tcp, udp, unix and unixd.

tcp client entry must contain port=number and address=addrspec keyword-value pairs.

udp client entry must contain port=number and address=addrspec keyword-value pairs and may contain allow=pattern, inittimeout=number and maxtries=number pairs.

unix client entry must contain port=path keyword-value pair.

unixd client entry must contain port=path keyword-value pair and may contain inittimeout=number and maxtries=number pairs.

port=number or port=path specifies the IP port number to connect in dotted quad notation, or path name for UNIX domain socket.

address=addrspec specify the IP address of the server in dotted quad notation.

inittimeout=number is the initical timeout in microseconds to wait for the server responce. After timeout is expired, the request is resent and the timeout is doubled.

maxtries=number is the number of retries to make is the server does not respond.

allow=pattern, and deny=pattern for the udp client specify the set of IP addresses from which the server responce is allowed. If not present, the server address must exactly match the address value. Specifying different set of addresses may be necessary if the server has multiple IP interfaces and there is no way to predict which of them will be used as the source address in the UDP packet.

All configured entries are tried in order until a working one is found.

It may be wise to avoid tcp connection protocol because of considerable startup overhead and because if destination host is not responding, it may take very long time for connect() to detect failure.

Example:

```
client udp
	port=9876
	address=123.45.67.89
	inittimeout=200000
	maxtries=3
```

## COPYRIGHT
Public domain

## SEE ALSO
whoson(3), whosond(8)


wicd-manager-settings.conf

package: wicd-common

title: wicd-manager-settings.conf(5)

text:
# wicd-manager-settings.conf(5)

## NAME
wicd-manager-settings.conf - contains settings that control Wicd's behavior

## DESCRIPTION
This file contains general configuration information for Wicd.

This file is located at /etc/wicd/manager-settings.conf

## SETTINGS
link_detect_tool = <0|1|2>

0 = autodetect

1 = ethtool

2 = mii-tool

flush_tool = <0|1|2>

0 = autodetect

1 = ip

2 = route

backend = <ioctl|external>

Default is ioctl backend.

signal_display_type = <0|1>

0 = Show signal strength as a percentage

1 = Show signal strength in dBm

dhcp_client = <0|1|2|3>

0 = autodetect

1 = dhclient

2 = dhcpcd

3 = pump

sudo_app = <0|1|2|3>

0 = autodetect

1 = pkexec

2 = kdesu

3 = ktsuss

wired_interface = <interface_name|None>

always_show_wired_interface = <True|False>

wired_connect_mode = <1|2|3>

1 = default profile

2 = show list

3 = last used profile

prefer_wired = <True|False>

True = Switch to wired interface if a link is detected, even if already connected to wireless

False = Do not switch to wired interface automatically

wireless_interface = <name_of_wireless_interface|None>

wpa_driver = <wext|madwifi|ndiswrapper|hostap|hermes|atmel|broadcom|ipw|ralinklegacy|none>

The default (and best supported) is wext. It should work properly in most cases. The none special value makes WICD pass no -D parameter to wpa_supplicant, which might be useful in some cases.

auto_reconnect = <True|False>

This settings determines whether Wicd will attempt to reconnect on connection loss.

use_global_dns = <True|False>

If set to "True" and values are specified in the global DNS settings below, this will cause Wicd to use these DNS settings.

global_dns_dom = <plaintext_domain_name>

This specifies the default search domain to be used by the resolver.

global_dns_1 = <ip_address>

global_dns_2 = <ip_address>

global_dns_3 = <ip_address>

debug_mode = <integer_value>

0 = disabled

1 = enabled

## SEE ALSO
wicd(8), wicd-curses(8), wicd-wired-settings.conf(5), wicd-wireless-settings.conf(5).


wicd-wired-settings.conf

title: wicd-wired-settings.conf(5)

summary: controls Wicd's wired network settings

text:
# wicd-wired-settings.conf(5)

## NAME
wicd-wired-settings.conf - controls Wicd's wired network settings

## DESCRIPTION
This file contains configuration information for wired interfaces in Wicd.

This file is located at /etc/wicd/wired-settings.conf

## SETTINGS
default = <0|1>

This option decides whether to use this profile as the default. 0 = do not use this profile as default.

1 = use this profile as default.

beforescript = <None|arbitrary_script>

This defines a script to run before Wicd brings up the connection. The script should be a Bourne-compatible script and should be executable.

IMPORTANT - scripts should ONLY be writable by root and located in a directory that is only writable by root.

afterscript = <None|arbitrary_script>

This defines a script to run after Wicd brings up the connection. The script should be a Bourne-compatible script and should be executable.

IMPORTANT - scripts should ONLY be writable by root and located in a directory that is only writable by root.

predisconnectscript = <None|arbitrary_script>

This defines a script to run before Wicd disconnects the interface. The script should be a Bourne-compatible script and should be executable.

postdisconnectscript = <None|arbitrary_script>

This defines a script to run after Wicd disconnects the interface. The script should be a Bourne-compatible script and should be executable.

IMPORTANT - scripts should ONLY be writable by root and located in a directory that is only writable by root.

ip = <None|ip_address>

Use this option if you have a static ip address for your system.

netmask = <None|networkmask>

This setting is only appropriate if a static ip address is configured above.

broadcast = <None|broadcast_address>

This setting is only appropriate if a static ip address is configured above.

gateway = <None|gateway_address>

This setting is only appropriate if a static ip address is configured above.

use_static_dns = <True|False>

True = use static DNS servers instead of accepting what the dhcp server supplies.

use_global_dns = <True|False>

True = use the global DNS servers provided in wicd-manager-settings.conf(5). This option is only appropriate if "use_static_dns = True"

dns1 = <None|ip_address>

Static DNS address if "use_static_dns = True" and "use_global_dns = False"

dns2 = <None|ip_address>

Static DNS address if "use_static_dns = True" and "use_global_dns = False"

dns3 = <None|ip_address>

Static DNS address if "use_static_dns = True" and "use_global_dns = False"

## SEE ALSO
wicd(8), wicd-curses(8), wicd-manager-settings.conf(5), wicd-wireless-settings.conf(5).


wicd-wireless-settings.conf

title: wicd-wireless-settings.conf(5)

text:
# wicd-wireless-settings.conf(5)

## NAME
wicd-wired-settings.conf - controls Wicd's wireless network settings

## DESCRIPTION
This file contains configuration information for wireless interfaces in Wicd.

This file is located at /etc/wicd/wireless-settings.conf

## SETTINGS
bssid = <BSSID_of_network>

This value can be found using iwconfig(8).

essid = <ESSID_of_network>

This value can be found using iwconfig(8).

hidden = <True|False>

This option notes whether the network's ESSID is broadcast or not.

channel = <integer_value>

Valid channels are dependent upon country.

This value can be found using iwconfig(8).

mode = <Master|Ad-hoc>

This value can be found using iwconfig(8).

enctype = <encryption_template>

This can take the value of any encryption template shown in /etc/wicd/encryption/templates/.

encryption_method = WEP|WPA|WPA2>

This value can be found using iwconfig(8).

key = <plain_text_key>

Be sure this file is readable only by root.

automatic = <True|False>

This option determines whether Wicd should automatically connect to this network.

ip = <None|ip_address>

Use this option if you have a static ip address for your system.

netmask = <None|networkmask>

This setting is only appropriate if a static ip address is configured above.

broadcast = <None|broadcast_address>

This setting is only appropriate if a static ip address is configured above.

gateway = <None|gateway_address>

This setting is only appropriate if a static ip address is configured above.

use_static_dns = <True|False>

True = use static DNS servers instead of accepting what the dhcp server supplies.

use_global_dns = <True|False>

True = use the global DNS servers provided in wicd-manager-settings.conf(5).

This option is only appropriate if "use_static_dns = True"

dns1 = <None|ip_address>

Static DNS address if "use_static_dns = True" and "use_global_dns = False"

dns2 = <None|ip_address>

Static DNS address if "use_static_dns = True" and "use_global_dns = False"

dns3 = <None|ip_address>

Static DNS address if "use_static_dns = True" and "use_global_dns = False"

use_settings_globally = <0|1>

Wicd keeps track of whether to autoconnect to networks based on bssid. This ensures that you don't accidentally connect to another network that is not yours but happens to have the same essid - for example, there are a lot of commercial routers in use with "linksys" as the essid.

0 = Do not use settings globally

1 = Use settings globally

beforescript = <None|arbitrary_script>

This defines a script to run before Wicd brings up the connection.

IMPORTANT - scripts should ONLY be writable by root and should be located in a directory that is writable by only root.

afterscript = <None|arbitrary_script>

This defines a script to run after Wicd brings up the connection.

IMPORTANT - scripts should ONLY be writable by root and located in a directory that is writable by only root.

predisconnectscript = <None|arbitrary_script>

This defines a script to run before Wicd disconnects the interface.

postdisconnectscript = <None|arbitrary_script>

This defines a script to run after Wicd disconnects the interface.

IMPORTANT - scripts should ONLY be writable by root and located in a directory that is writable by only root.

## OTHER
The "use_settings_globally" option determines how an individual network's configuration stanza starts. If the option is "0" (do not use settings globally), then the stanza's top line will be the bssid of the access point (in this format):

[00:15:3E:87:D3:68]

If the "option is set to "1" (use settings globally), then the first line of the stanza will be in this format:

[essid:UA Public Wireless Network]

## SEE ALSO
wicd(8), wicd-curses(8), wicd-manager-settings.conf(5), wicd-wired-settings.conf(5).


wildmidi.cfg

package: wildmidi

title: wildmidi.cfg(5)

summary: Config file for libWildMidi

text:
# wildmidi.cfg(5)

## NAME
wildmidi.cfg - Config file for libWildMidi

## LIBRARY
libWildMidi

## DESCRIPTION
Contains the patch configuration for libWildMidi and location of Gravis Ultrasound compatible patch files.

```
dir ~/guspats/
source /etc/wildmidi.cfg
bank 0
0 acpiano.pat amp=110 env_time4=300
1 brpiano.pat amp=100
drumset 0
25 snarerol keep=env amp=225 note=60
26 snap	note=65
```

## SYNTAX
guspat_editor_author_cant_read_so_fix_release_time_for_me

Some patch file editors switch the 4th and 5th envelopes around making the sound play much longer than intended in players that stuck to the Gravis Ultrasound patch standard. Including this option in the config enables a fix that detects this oversight, playing the sound samples as if they were correct.

NOTE: This is a global setting. If it is found to affect good patch samples it will be moved to a per patch setting in a future version.

auto_amp

Forces WildMIDI to amplify samples to their maximum level ignoring the amp=% in the patch lines of the config.

auto_amp_with_amp

Forces WildMIDI to amplify samples to their maximum level then apply the amp=% in the patch lines of the config.

dir dir-name

Change the search path for config and patch files to dir-name. This is specific to the current config file and carried to any included config file unless they have their own dir setting. Any included file that has its own dir setting does not effect the dir setting of the current config file.

source include-confg

Include the settings from include-config. Any patch already set will be over-ridden by the included config file.

bank N

The patches following this setting belong to MIDI instrument bank N.

drumset N

The patches following this setting belong to MIDI drum bank N.

patchno patchfile [amp=volume] [note=miodinte] [keep=loop] [keep=env] [remove=sustain] [remove=clamped] [env_level[0-5]=level] [env_time[0-5]=time]

Example: 0 acpiano.pat amp=110

patchno

This is the MIDI patch number the instrument belongs to.

patchfile

The filename of the Gravis Ultrasound compatible patch file. If the filename is missing the .pat extension, libWildMidi will add .pat when attempting to load the file.

amp=volume

Force the volume of the samples in this patch to volume% prior to using it.

note=midinote

Use note midinote when playing the samples in this patch. NOTE: this is for instruments listed under drumset.

keep=loop

Play the samples in this patch with the loop, when normally we would not for this instrument.

keep=env

Use the envelope data in this patch, when normally we wouldn't for this instrument.

remove=sustain

Do note hold the note after the 3rd envelope until note off, which is what happens if the sustain bit is set in the patch file.

remove=clamped

Do not jump to 6th envelope on note off, which is what happens if the clamped bit is set in the patch file.

env_level[0-5]=level

Set the envelope level to level with 1.0 being maximum, and 0.0 being minimum.

Example: set 5th envelope level to 10% - env_level[0-5]=0.1

env_time[0-5]=time

Set the envelope time to time with a resolution of 1/1000th of a second. This setting is the time it should take for the envelope to reach maximum level.

Example: set 1st envelope time to 1sec - env_time0=1000

Example: set 3rd envelope time to 0.5secs - env_time2=500

reverb_room_width fval

Set the room width for the reverb engine in meters. fval is a float value in meters. Minimum setting is 1.0 meter, maximum setting is 100.0 meters, and default is 15.0 meters.

Example: set room width to 30 meters - reverb_room_width 30

reverb_room_length fval

Set the room length for the reverb engine in meters. fval is a float value in meters. Minimum setting is 1.0 meter, maximum setting is 100.0 meters, and default is 20.0 meters.

Example: set room length to 40 meters - reverb_room_length 40

## SEE ALSO
wildmidi(1)

## AUTHOR
Chris Ison <wildcode@users.sf.net> Bret Curtis <psi29a@gmail.com>

## COPYRIGHT
Copyright (C) Chris Ison 2001-2010 Copyright (C) Bret Curtis 2013-2016

This file is part of WildMIDI.

WildMIDI is free software: you can redistribute and/or modify the player under the terms of the GNU General Public License and you can redistribute and/or modify the library under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the licenses, or(at your option) any later version.

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

You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with WildMIDI. If not, see <http://www.gnu.org/licenses/>.

This manpage is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.


wmapplrc

package: wmappl

title: wmapplrc(5)

summary: configuration file for wmappl

text:
# wmapplrc(5)

## NAME
wmapplrc - configuration file for wmappl

## DESCRIPTION
The format of a wmappl configuration file consists of a number of sections, defined by a section name surrounded in square brakets, for example: "[section]". Each button that should appear in wmappl should have its own section. The lines following the section name specify the icon to use, the command to launch when the button is pressed and an optional tooltip string to be displayed.

An optional [wmappl] section may be specified which specifies configuration options for wmappl. These options have the same names as the long command line options and are entirely optional. Command line arguments will override any specified in the configuration file. There are some options that have no cooresponding command line option.

Anything after a pound sign ('#') is considered a comment and will be ignored. A line may be continued by ending the line in a backslash ('\'). Blank lines and any invalid key=value pairs are ignored.

## BUTTON SECTION OPTIONS
icon=<iconfile>

xpm icon for the button, accepts an absolute path or a path relative to a directory in the iconpath

command=<command>

command to execute when button is pressed, it should end with an to run it in the background

tooltip=<tooltip string>

tooltip that should be displayed over the button when the mouse is hovered over it

## WMAPPL SECTION OPTIONS
iconpath=<path1>:[path2]:...:[pathN]

a colon separated path to search for icons

name=<windowname>

window name (specify different names to run multiple instances)

tooltip_delay=<delay in milliseconds>

delay in milliseconds before appearance of tooltip

window=

run in windowed mode if this option is specified

debug=

run in debug mode if this option is specified

background_color=<color>

specifies the background color of wmappl

background_icon=<iconfile>

xpm icon for the background of wmappl, accepts an absolute path or a path relative to a directory in the iconpath (takes precedence over background_color option)

tooltip_foreground=<color>

foreground (text) color for tooltips

tooltip_background=<color>

background color for tooltips

tooltip_font=<X11 font string>

X11 font string for the font to use for tooltips

## EXAMPLE
The following example defines nine buttons, specifies wmappl options and demonstrates comments, line expansion and blank lines:

[wmappl]

iconpath=/usr/share/icons/wmappl:/usr/share/pixmaps/mini

name=Demo

window=

debug=

tooltip_delay=800 # 800 milliseconds

tooltip_foreground=rgb:ff/ff/ff # white tooltip text

tooltip_background=rgb:ff/00/00 # red tooltip background

tooltip_font=-*-bitstream vera serif-*-*-*-*-*-*-*-*-*-*-*-* # use vera serif font

background_color=rgb:73/7e/df # light blue wmappl background

background_icon=checker.xpm

\# the checkered background will override the light blue background

[info]

icon = info.xpm

command = xmessage "Reports bugs to: \

wmappl.sourceforge.net" &

tooltip = wmappl information

[man wmappl]

icon = wmappl.xpm

command = xterm -fg white -bg black -e man wmappl &

tooltip = open the wmappl man page

[wprefs]

icon = gnustep.xpm

command = /usr/share/GNUstep/WPrefs.app/WPrefs &

[mozilla]

icon = mozilla.xpm

command = mozilla &

[xterm]

icon = glowx.xpm

command = xterm &

[ghostview]

icon = ghost.xpm

command = gv &

[xmms]

icon = xmms.xpm

command = xmms &

tooltip = xmms gets a really really really \

really really really really really \

really really really really really \

long tooltip!

[ssh to work]

icon = ssh.xpm

command = xterm -fg green -bg black \

-e ssh -l user shell.work.com &

## REPORTING BUGS
Report bugs at http://wmappl.sourceforge.net

## WARRANTY
This is free software with ABSOLUTELY NO WARRANTY

## AUTHOR
Casey Harkins <charkins@pobox.com>

## SEE ALSO
wmappl(1)


cntlist

package: wordnet-dict

title: cntlist(5)

text:
# cntlist(5)

## NAME
cntlist - file listing number of times each tagged sense occurs in a semantic concordance, sorted most to least frequently tagged

cntlist.rev - file listing number of times each tagged sense occurs in a semantic concordance, sorted by sense key

## DESCRIPTION
A cntlist file for a semantic concordance lists the number of times each semantically tagged sense occurs in the concordance and its sense number in the WordNet database. Each line in the file corresponds to a sense in the WordNet database to which at least one semantic tag points. Only senses that are tagged in a concordance are in the concordance's cntlist file.

### WordNet Database cntlist File
In the WordNet database, words are assigned sense numbers based on frequency of use in semantically tagged corpora. The cntlist file used by grind(1) to build the WordNet database and assign the sense numbers is a union of the cntlist files from the various semantic concordances that were formerly released by Princeton University. This combined cntlist file is provided with the WordNet package and is found in the WNSEARCHDIR directory.

The cntlist.rev file is used at run-time by the WordNet library code and browser interfaces to print in the output display the number of times each sense has been tagged.

### File Format
Each line in a cntlist file contains information for one sense. The file is ordered from most to least frequently tagged sense. The fields are separated by one space, and each line is terminated with a newline character. Senses having the same tag_cnt value are listed in reverse alphabetical order of the lemma field of the sense_key.

Each line in cntlist is of the form:

tag_cnt sense_key sense_number

where tag_cnt is the decimal number of times the sense is tagged in the corresponding semantic concordance. sense_key is a WordNet sense encoding and sense_number is a WordNet sense number as described in

The cntlist.rev file contains the same fields described above, in the following order:

sense_key sense_number tag_cnt

## NOTES
Princeton no longer maintains or releases the Semantic Concordance files. The cntlist file used to order the senses in WordNet 3.0 was generated from the Semantic Concordance files at the point that they were last updated in 2001. In general, the order of senses presented usually reflects what the user would expect, however sense ordering is now less reliable than in prior releases and should not be construed as an accurate indicator of frequency of use.

## ENVIRONMENT VARIABLES (UNIX)
WNHOME

Base directory for WordNet. Default is /usr/local/WordNet-3.0.

WNSEARCHDIR

Directory in which the WordNet database has been installed. Default is WNHOME/dict.

## REGISTRY (WINDOWS)
HKEY_LOCAL_MACHINE\SOFTWARE\WordNet\3.0\WNHome

Base directory for WordNet. Default is C:\Program Files\WordNet\3.0.

HKEY_CURRENT_USER\SOFTWARE\WordNet\3.0\wnres

User's default browser options.

## FILES
cntlist, cntlist.rev

file of combined semantic concordance cntlist files. Used to assign sense numbers in WordNet database

## SEE ALSO
grind(1), wnintro(5), senseidx(5).