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
native-path:

typeof: string

default:

The battery to monitor. Refer to the https://upower.freedesktop.org/docs/UpDevice.html#UpDevice--native-path

Can be obtained using `upower --dump`

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

default: 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.

on-click:

typeof: string

Command to execute when clicked on the module.

show-icon:

typeof: bool

default: true

Option to disable battery icon.

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

```
"upower": {
	"native-path": "/org/bluez/hci0/dev_D4_AE_41_38_D0_EF",
	"icon-size": 20,
	"hide-if-empty": true,
	"tooltip": true,
	"tooltip-spacing": 20
}
```

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

```
"upower": {
	"show-icon": false,
	"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

package: waybar

title: waybar-wlr-taskbar(5)

text:
# waybar-wlr-taskbar(5)

## NAME
waybar - wlr 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.

sort-by-app-id:

typeof: bool

default: false

If set to true, group tasks by their app_id. Cannot be used with 'active-first'.

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

rewrite:

typeof: object

Rules to rewrite the module format output. See rewrite rules.

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

{name}: The application name as in desktop file if appropriate desktop files are 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.

## 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 format output is left unchanged.

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

## 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"
	},
	"rewrite": {
		"Firefox Web Browser": "Firefox",
		"Foot Server": "Terminal"
	}
}
```

## Style
•#taskbar

•#taskbar button

•#taskbar button.maximized

•#taskbar button.minimized

•#taskbar button.active

•#taskbar button.fullscreen


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
autolaunch     Autolaunch 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

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
fullscreen
ivi
kiosk
```

xwayland=true

ask Weston to load the XWayland module (boolean).

modules=screen-share.so

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

```
screen-share.so
```

backend=headless

overrides defaults backend. Available backends are:

```
drm
headless
rdp
pipewire
vnc
wayland
x11
```

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.

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

require-outputs=any

configures the behavior if Weston fails to configure and enable outputs. Depending on the use-case, it may preferable to ensure that Weston only starts if it can enable all available outputs, or that it ignores failed outputs. The possible options are:

```
all-found    all available outputs must be enabled
any          start if any output could be enabled
none         start even if no output was enabled
```

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

renderer=auto

Selects a renderer to use for internal composition when required, or auto to select the most appropriate renderer. Available renderers are:

```
auto
gl
noop
pixman
```

Not all backends support all renderers. use-pixman=true

Deprecated in favour of the renderer= option. 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.

color-management=true

Enables color management and requires using GL-renderer. Boolean, defaults to false. TENTATIVE, EXPERIMENTAL, WORK IN PROGRESS: Color management enables the use of ICC files to describe monitor color behavior, Wayland protocol extensions for clients to describe their color spaces and perform monitor profiling, and tone mapping required to enable HDR video modes. This extended functionality comes at the cost of heavier image processing and sometimes a loss of some hardware off-loading features like composite-bypass.

output-decorations=true

For headless-backend with GL-renderer only: draws output window decorations, similar to what wayland-backend does for floating output windows. Boolean, defaults to false. These decorations cannot normally be screenshot. This option is useful for the Weston test suite only.

## 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=/usr/lib64/weston/clients/weston-desktop-shell

specifies the path for the shell client to run. It is possible to pass arguments and environment variables to the program, for example, 'ENVFOO=bar ENVBAR=baz /path/to/program --arg anotherarg', with entries that are space-separated but with no support for quoting. If no client was specified then 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, minutes-24h, seconds-24h. 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 by desktop-shell when starting up (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)

cursor-theme=theme

sets the cursor theme (string).

cursor-size=24

sets the cursor size (unsigned integer).

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

displayname=displayname

sets the display name of the launcher that appears in the tooltip.

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

icc_profile=file

If option color-management is true, load the given ICC file as the output color profile. This works only on DRM, headless, wayland, and x11 backends, and for remoting and pipewire outputs.

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.

content-type=content_type

The type of the content being primarily displayed to this output. Can be "no data" (default), "graphics", "photo", "cinema" or "game".

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.

colorimetry-mode=default

Sets the colorimetry mode on the output. The colorimetry mode together with the EOTF mode below define the color encoding used in the video signal. The colorimetry mode is used for choosing between the default sink defined colorimetry (intended to be described by EDID), and standardised other encodings that support wide color gamut (WCG). The display driver, the graphics card, and the video sink (monitor) need to support the chosen mode, otherwise the result is undefined or fails.

The mode can be one of the following strings:

```
default              default (RGB) colorimetry, video sink dependant
bt2020cycc           Rec. ITU-R BT.2020 constant luminance YCbCr
bt2020ycc            Rec. ITU-R BT.2020 non-constant luminance YCbCr
bt2020rgb            Rec. ITU-R BT.2020 RGB
p3d65                SMPTE ST 2113 DCI-P3 RGB D65
p3dci                SMPTE ST 2113 DCI-P3 RGB Theater
ictcp                Rec. ITU-R BT.2100 ICtCp
```

Defaults to default. Non-default modes require color-management=true. Note: The operating system might not honor the choice between RGB and YCbCr, that may be picked by a Linux display driver automatically.

eotf-mode=sdr

Sets the EOTF mode on the output. This is used for choosing between standard dynamic range (SDR) mode and the various high dynamic range (HDR) modes. The display driver, the graphics card, and the video sink (monitor) need to support the chosen mode, otherwise the result is undefined. The mode can be one of the following strings:

```
sdr                  traditional gamma, SDR
hdr-gamma            traditional gamma, HDR
st2084               SMPTE ST 2084, a.k.a Perceptual Quantizer
hlg                  Hybrid Log-Gamma (ITU-R BT.2100)
```

Defaults to sdr. Non-SDR modes require color-management=true.

color_characteristics=name

Sets the basic output color characteristics by loading the parameters from the color_characteristics section with the key name=name . If an ICC profile is also set, the ICC profile takes precedence.

mirror-of=ouput_name

Makes the remote output overlap (mirror) the native output identified by the mirror-of value. This is useful for sharing or mirroring a native DRM output. The output mirroring the DRM native one, will inherit the same video modeline as the DRM native one, including the refresh rate and scale of the native output. Note that depending on the remote backend, automatic output resize will be disabled when mirroring is in effect. Mirroring a DRM native output to another DRM native output is yet not supported, being intended only for remote outputs. NOTE: The native outputs created by the DRM backend using the 'clone-of' are for cloning the outputs, and not sharing or mirroring. See also weston-drm(7).

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

sets the path of the on screen keyboard input method (string). It is possible to pass arguments and environment variables to the program, for example, 'ENVFOO=bar ENVBAR=baz /path/to/program --arg anotherarg', with entries that are space-separated but with no support for quoting.

overlay-keyboard=false

sets weston-keyboard as overlay panel.

## 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 --shell=fullscreen --no-clients-resize --no-config

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

start-on-startup=false

If set to true, start screen sharing of all outputs available on Weston startup. Set to false by default. Set to false by default. When using this option make sure you enable --no-config to avoid re-loading the screen-share module and implictly trigger screen-sharing for the RDP output already performing the screen share. Alternatively, you could also supply a different configuration file, by using --config /path/to/config/file, and make sure that the configuration file doesn't load the screen-share module.

## AUTOLAUNCH SECTION
path=/usr/bin/echo

Path to an executable file to run after startup. This file is executed in parallel to Weston, so it does not have to immediately exit. Defaults to empty.

watch=false

If set to true, quit Weston after the auto-launched executable exits. Set to false by default.

## COLOR_CHARACTERISTICS SECTION
Each color_characteristics section records one set of basic display or monitor color characterisation parameters. The parameters are defined in CTA-861-H specification as Static Metadata Type 1, and they can also be found in EDID. The parameters are divided into groups. Each group must be given either fully or not at all.

Each section should be named with name key by which it can be referenced from other sections. A metadata section is just a collection of parameter values and does nothing on its own. It has an effect only when referenced from elsewhere.

See output section key color_characteristics.

name=name

An arbitrary name for this section. You can choose any name you want as long as it does not contain the colon (:) character. Names with at least one colon are reserved.

### Primaries group
red_x=x

red_y=y

green_x=x

green_y=y

blue_x=x

blue_y=y

The CIE 1931 xy chromaticity coordinates of the display primaries. These floating point values must reside between 0.0 and 1.0, inclusive.

### White point group
white_x=x

white_y=y

The CIE 1931 xy chromaticity coordinates of the display white point. These floating point values must reside between 0.0 and 1.0, inclusive.

### Independent parameters
Each parameter listed here has its own group and therefore can be given alone.

max_L=L

Display's desired maximum content luminance (peak) L cd/m², a floating point value in the range 0.0–100000.0.

min_L=L

Display's desired minimum content luminance L cd/m², a floating point value in the range 0.0–100000.0.

maxFALL=L

Display's desired maximum frame-average light level L cd/m², a floating point value in the range 0.0–100000.0.

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


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.


wlogout

package: wlogout

title: wlogout(5)

text:
# wlogout(5)

## NAME
wlogout - layout file and options

## LAYOUT
wlogout's buttons can consist of up to six values

•label

•action

•text

•keybind

•height *

•width *

•circular *

* Optional values

Label is the css selector by which the buttons may be referred to in a style.css file, action is the shell command to be executed when the button is clicked, text is the description displayed on the button, keybind is the key mapped to the button (note escape is reserved for exiting the application), height and width are values between 0.0 and 1.0 that control the location of where text is displayed the default width 0.5, height 0.9, and circular is a boolean value that makes a button round.

## FILE
The buttons values are specified in a JSON formatted file, wherein the values are used as keys and one button corresponds to one JSON object for example:

```
{

    "label" : "foo",

    "action" : "echo 'hello world'",

    "text" : "bar",

    "keybind" : "f",

    "height" : 1,

    "width" : 1,

    "circular" : true
}
```

Would create a round button that has a css label of foo, prints "hello world" upon being clicked, displays "bar" on the button, be bound to the key 'f', and "bar" would be shown at the bottom right corner. To create multiple buttons simply create another JSON object.

## AUTHORS
Maintained by Haden Collins <collinshaden@gmail.com> for more information about wlogout, see <https://github.com/ArtsyMacaw/wlogout>.

## SEE ALSO
wlogout(1)


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)


wofi

package: wofi

title: wofi(5)

summary: configuration file and styling

text:
# wofi(5)

## NAME
wofi - configuration file and styling

## DESCRIPTION
Wofi's configuration format is very simple, consisting of key value pairs in snake case. The majority of the config options are the command line options, there are however a small handful of options only accessible via wofi's config.

Mode specific options for the built-in modes are documented in wofi(7). They are placed in the config file in the format mode-example_opt=val. For example dmenu has an option called parse_action which would be placed in the config as dmenu-parse_action=true.

Anything following a # is considered to be a comment unless the # is prefixed with a \. For this reason in order to put a backslash in the config it must be escaped as well giving \\.

## CONFIG OPTIONS
Most of the options here are the command flags as found in wofi(1) in snake case, however some are unique to the config.

style=PATH

Specifies the CSS file to use as the stylesheet.

stylesheet=PATH

Specifies the CSS file to use as the stylesheet. This option is NOT the same as style. Absolute paths are absolute however relative paths are relative to the wofi config folder location $XDG_CONFIG_HOME/wofi and NOT the current working directory as they are with style. They are also NOT relative to the path as specified by --conf. This option comes from rootbar and is probably more confusing than it's worth. You should probably use style unless you're sure this is what you want.

color=PATH

Specifies the colors file to use.

colors=PATH

Specifies the colors file to use. This option is NOT the same as color. Absolute paths are absolute however relative paths are relative to the wofi config folder location $XDG_CONFIG_HOME/wofi and NOT the current working directory as they are with color. They are also NOT relative to the path as specified by --conf. This option comes from rootbar and is probably more confusing than it's worth. You should probably use color unless you're sure this is what you want.

show=MODE

Specifies the mode to run in. A list of modes can be found in wofi(7).

mode=MODE

Identical to show.

width=WIDTH

Specifies the menu width in pixels or percent of screen size, default is 50%. Pixels are used unless the number ends with a %.

height=HEIGHT

Specifies the menu height in pixels or percent of screen size, default is 40%. Pixels are used unless the number ends with a %.

prompt=PROMPT

Sets the prompt to be display in the search box, default is the name of the mode.

xoffset=OFFSET

Sets the x offset from the location in pixels, default is 0.

x=OFFSET

Identical to xoffset.

yoffset=OFFSET

Sets the y offset from the location in pixels, default is 0.

y=OFFSET

Identical to yoffset.

normal_window=BOOL

If true runs wofi in a normal window instead of using wlr-layer-shell, default is false.

allow_images=BOOL

If true allows image escape sequences to be processed and rendered, default is false.

allow_markup=BOOL

If true allows pango markup to be processed and rendered, default is false.

cache_file=PATH

Specifies the cache file to load/store cache, default is $XDG_CACHE_HOME/wofi-<mode name> where <mode name> is the name of the mode, if $XDG_CACHE_HOME is not specified ~/.cache is used.

term=TERM

Specifies the term to use when running a program in a terminal. This overrides the default terminal run order which is kitty, termite, alacritty, foot, gnome-terminal, weston-terminal in that order.

password=CHARACTER

Runs wofi in password mode using the specified character, default is false.

exec_search=BOOL

If true activiating a search with enter will execute the search not the first result, default is false.

hide_scroll=BOOL

If true hides the scroll bars, default is false.

matching=MODE

Specifies the matching mode, it can be either contains, multi-contains, or fuzzy, default is contains.

insensitive=BOOL

If true enables case insensitive search, default is false.

parse_search=BOOL

If true parses out image escapes and pango preventing them from being used for searching, default is false.

location=LOCATION

Specifies the location. See wofi(7) for more information, default is center.

no_actions=BOOL

If true disables multiple actions for modes that support it, default is false.

lines=LINES

Specifies the height in number of lines instead of pixels.

columns=COLUMNS

Specifies the number of columns to display, default is 1.

sort_order=ORDER

Specifies the default sort order. There are currently two orders, default and alphabetical. See wofi(7) for details.

gtk_dark=BOOL

If true, instructs wofi to use the dark variant of the current GTK theme (if available). Default is false.

search=STRING

Specifies something to search for immediately on opening

monitor=STRING

Sets the monitor to open on

pre_display_cmd=COMMAND

Specifies a printf-like string which is used on the entries prior to displaying them. This command is only used to represent the label widget's string, and won't affect the the output of the selected label.

orientation=ORIENTATION

Specifies the orientation, it can be either horizontal or vertical, default is vertical.

halign=ALIGN

Specifies the horizontal align for the entire scrolled area, it can be any of fill, start, end, or center, default is fill.

content_halign=ALIGN

Specifies the horizontal align for the individual entries, it can be any of fill, start, end, or center, default is fill.

valign=ALIGN

Specifies the vertical align for the entire scrolled area, it can be any of fill, start, end, or center, the default is orientation dependent. If vertical then it defaults to start, if horizontal it defaults to center.

filter_rate=RATE

Specifies the rate at which search results are updated in milliseconds, default is 100.

image_size=SIZE

Specifies the size of images in pixels when images are enabled, default is 32.

key_up=KEY

Specifies the key to use in order to move up. Default is Up(Up arrow). See wofi-keys(7) for the key codes.

key_down=KEY

Specifies the key to use in order to move down. Default is Down(Down arrow). See wofi-keys(7) for the key codes.

key_left=KEY

Specifies the key to use in order to move left. Default is Left(Left arrow). See wofi-keys(7) for the key codes.

key_right=KEY

Specifies the key to use in order to move right. Default is Right(Right arrow). See wofi-keys(7) for the key codes.

key_forward=KEY

Specifies the key to use in order to move forward. Default is Tab. See wofi-keys(7) for the key codes.

key_backward=KEY

Specifies the key to use in order to move backward. Default is ISO_Left_Tab(Shift+Tab). See wofi-keys(7) for the key codes.

key_submit=KEY

Specifies the key to use in order to submit an action. Default is Return. See wofi-keys(7) for the key codes.

key_exit=KEY

Specifies the key to use in order to exit wofi. Default is Escape. See wofi-keys(7) for the key codes.

key_pgup=KEY

Specifies the key to use in order to move one page up. Default is Page_Up. See wofi-keys(7) for the key codes.

key_pgdn=KEY

Specifies the key to use in order to move one page down. Default is Page_Down. See wofi-keys(7) for the key codes.

key_expand=KEY

Specifies the key to use in order to expand/contract multi-action entires. There is no default. See wofi-keys(7) for the key codes.

key_hide_search=KEY

Specifies the key to use in order to hide/show the search bar. There is no default. See wofi-keys(7) for the key codes.

key_copy=KEY

Specifies the key to use in order to copy the action text for the current entry. The default is Control_L-c. See wofi-keys(7) for the key codes.

line_wrap=MODE

Specifies the line wrap mode to use. The options are off, word, char, and word_char. Default is off.

global_coords=BOOL

Specifies whether x and y offsets should be calculated using the global compositor space instead of the current monitor. Default is false. This does not play well with locations and using it with them is not advised.

hide_search=BOOL

Specifies whether the search bar should be hidden. Default is false.

dynamic_lines=BOOL

Specifies whether wofi should be dynamically shrunk to fit the number of visible lines or if it should always stay the same size. Default is false.

layer=LAYER

Specifies the layer to open on. The options are background, bottom, top, and overlay. Default is top

copy_exec=PATH

Specifies the executable to pipe copy data into. $PATH will be scanned, this is not passed to a shell and must be an executable. Default is wl-copy.

single_click=BOOL

Specifies whether or not actions should be executed on a single click or a double click. Default is false.

## CSS SELECTORS
Any GTK widget can be selected by using the name of its CSS node, these however might change with updates and are not guaranteed to stay constant. Wofi also provides certain widgets with names and classes which can be referenced from CSS to give access to the most important widgets easily. wofi(7) contains the current widget layout used by wofi so if you want to get into CSS directly using GTK widget names look there for info.

\#window

The name of the window itself.

\#outer-box

The name of the box that contains everything.

\#input

The name of the search bar.

\#scroll

The name of the scrolled window containing all of the entries.

\#inner-box

The name of the box containing all of the entries.

\#img

The name of all images in entries displayed in image mode.

\#text

The name of all the text in entries.

\#unselected

The name of all entries currently unselected. A better way of doing this is to do #entry and combine that with #entry:selected

\#selected

The name of all entries currently selected. A better way of doing this is to do #entry:selected

.entry

The class attached to all entries. This is attached to the inside property box and is old, you probably want #entry instead

\#entry

The name of all entries.

## COLORS
The colors file should be formatted as new line separated hex values. These values should be in the standard HTML format and begin with a hash. These colors will be loaded however wofi doesn't know what color should be used for what so you must reference them from your CSS.

You can reference these from your CSS by doing --wofi-color<n> where <n> is the line number - 1. For example to reference the color on line 1 you would do --wofi-color0.

The colors can also be referenced by doing --wofi-rgb-color<n> where <n> is the line number - 1. The difference between these is the format used to replace the macro.

--wofi-color<n> is replaced with an HTML color code in the format #FFFFFF. --wofi-rgb-color<n> is replaced with comma separated rgb values in the format 255, 255, 255. The correct usage of --wofi-rgb-color<n> is to wrap it in rgb() or rgba(). Note that it does not return an alpha value so combining it with rgba() should be done like so rgba(--wofi-rgb-color0, 0.8). This would set the color to line 1 with an opacity of 80%.


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


lexnames

title: lexnames(5)

text:
# lexnames(5)

## NAME
lexnames - List of WordNet lexicographer file names and numbers

## DESCRIPTION
During WordNet development synsets are organized into forty-five lexicographer files based on syntactic category and logical groupings. grind(1) processes these files and produces a database suitable for use with the WordNet library, interface code, and other applications. The format of the lexicographer files is described in wninput(5).

A file number corresponds to each lexicographer file. File numbers are encoded in several parts of the WordNet system as an efficient way to indicate a lexicographer file name. The file lexnames lists the mapping between file names and numbers, and can be used by programs or end users to correlate the two.

### File Format
Each line in lexnames contains 3 tab separated fields, and is terminated with a newline character. The first field is the two digit decimal integer file number. (The first file in the list is numbered 00.) The second field is the name of the lexicographer file that is represented by that number, and the third field is an integer that indicates the syntactic category of the synsets contained in the file. This is simply a shortcut for programs and scripts, since the syntactic category is also part of the lexicographer file's name.

### Syntactic Category
The syntactic category field is encoded as follows:

```
1	NOUN
2	VERB
3	ADJECTIVE
4	ADVERB
```

### Lexicographer Files
The names of the lexicographer files and their corresponding file numbers are listed below along with a brief description each file's contents.

File Number

Name

Contents

00

adj.all

all adjective clusters

01

adj.pert

relational adjectives (pertainyms)

02

adv.all

all adverbs

03

noun.Tops

unique beginner for nouns

04

noun.act

nouns denoting acts or actions

05

noun.animal

nouns denoting animals

06

noun.artifact

nouns denoting man-made objects

07

noun.attribute

nouns denoting attributes of people and objects

08

noun.body

nouns denoting body parts

09

noun.cognition

nouns denoting cognitive processes and contents

10

noun.communication

nouns denoting communicative processes and contents

11

noun.event

nouns denoting natural events

12

noun.feeling

nouns denoting feelings and emotions

13

noun.food

nouns denoting foods and drinks

14

noun.group

nouns denoting groupings of people or objects

15

noun.location

nouns denoting spatial position

16

noun.motive

nouns denoting goals

17

noun.object

nouns denoting natural objects (not man-made)

18

noun.person

nouns denoting people

19

noun.phenomenon

nouns denoting natural phenomena

20

noun.plant

nouns denoting plants

21

noun.possession

nouns denoting possession and transfer of possession

22

noun.process

nouns denoting natural processes

23

noun.quantity

nouns denoting quantities and units of measure

24

noun.relation

nouns denoting relations between people or things or ideas

25

noun.shape

nouns denoting two and three dimensional shapes

26

noun.state

nouns denoting stable states of affairs

27

noun.substance

nouns denoting substances

28

noun.time

nouns denoting time and temporal relations

29

verb.body

verbs of grooming, dressing and bodily care

30

verb.change

verbs of size, temperature change, intensifying, etc.

31

verb.cognition

verbs of thinking, judging, analyzing, doubting

32

verb.communication

verbs of telling, asking, ordering, singing

33

verb.competition

verbs of fighting, athletic activities

34

verb.consumption

verbs of eating and drinking

35

verb.contact

verbs of touching, hitting, tying, digging

36

verb.creation

verbs of sewing, baking, painting, performing

37

verb.emotion

verbs of feeling

38

verb.motion

verbs of walking, flying, swimming

39

verb.perception

verbs of seeing, hearing, feeling

40

verb.possession

verbs of buying, selling, owning

41

verb.social

verbs of political and social activities and events

42

verb.stative

verbs of being, having, spatial relations

43

verb.weather

verbs of raining, snowing, thawing, thundering

44

adj.ppl

participial adjectives

## NOTES
The lexicographer files are not included in the WordNet database package.

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

## FILES
lexnames

list of lexicographer file names and numbers

## SEE ALSO
grind(1), wnintro(5), wndb(5), wninput(5).


wndb

title: wndb(5)

summary: WordNet database files

text:
# wndb(5)

## NAME
index.noun, data.noun, index.verb, data.verb, index.adj, data.adj, index.adv, data.adv - WordNet database files

noun.exc, verb.exc. adj.exc adv.exc - morphology exception lists

sentidx.vrb, sents.vrb - files used by search code to display sentences illustrating the use of some specific verbs

## DESCRIPTION
For each syntactic category, two files are needed to represent the contents of the WordNet database - index.pos and data.pos, where pos is noun, verb, adj and adv. The other auxiliary files are used by the WordNet library's searching functions and are needed to run the various WordNet browsers.

Each index file is an alphabetized list of all the words found in WordNet in the corresponding part of speech. On each line, following the word, is a list of byte offsets (synset_offsets) in the corresponding data file, one for each synset containing the word. Words in the index file are in lower case only, regardless of how they were entered in the lexicographer files. This folds various orthographic representations of the word into one line enabling database searches to be case insensitive. See wninput(5) for a detailed description of the lexicographer files

A data file for a syntactic category contains information corresponding to the synsets that were specified in the lexicographer files, with relational pointers resolved to synset_offsets. Each line corresponds to a synset. Pointers are followed and hierarchies traversed by moving from one synset to another via the synset_offsets.

The exception list files, pos.exc, are used to help the morphological processor find base forms from irregular inflections.

The files sentidx.vrb and sents.vrb contain sentences illustrating the use of specific senses of some verbs. These files are used by the searching software in response to a request for verb sentence frames. Generic sentence frames are displayed when an illustrative sentence is not present.

The various database files are in ASCII formats that are easily read by both humans and machines. All fields, unless otherwise noted, are separated by one space character, and all lines are terminated by a newline character. Fields enclosed in italicized square brackets may not be present.

See wngloss(7) for a glossary of WordNet terminology and a discussion of the database's content and logical organization.

### Index File Format
Each index file begins with several lines containing a copyright notice, version number and license agreement. These lines all begin with two spaces and the line number so they do not interfere with the binary search algorithm that is used to look up entries in the index files. All other lines are in the following format. In the field descriptions, number always refers to a decimal integer unless otherwise defined.

```
lemma  pos  synset_cnt  p_cnt  [ptr_symbol...]  sense_cnt  tagsense_cnt   synset_offset  [synset_offset...]
```

lemma

lower case ASCII text of word or collocation. Collocations are formed by joining individual words with an underscore (_) character.

pos

Syntactic category: n for noun files, v for verb files, a for adjective files, r for adverb files.

All remaining fields are with respect to senses of lemma in pos.

synset_cnt

Number of synsets that lemma is in. This is the number of senses of the word in WordNet. See Sense Numbers below for a discussion of how sense numbers are assigned and the order of synset_offsets in the index files.

p_cnt

Number of different pointers that lemma has in all synsets containing it.

ptr_symbol

A space separated list of p_cnt different types of pointers that lemma has in all synsets containing it. See wninput(5) for a list of pointer_symbols. If all senses of lemma have no pointers, this field is omitted and p_cnt is 0.

sense_cnt

Same as sense_cnt above. This is redundant, but the field was preserved for compatibility reasons.

tagsense_cnt

Number of senses of lemma that are ranked according to their frequency of occurrence in semantic concordance texts.

synset_offset

Byte offset in data.pos file of a synset containing lemma. Each synset_offset in the list corresponds to a different sense of lemma in WordNet. synset_offset is an 8 digit, zero-filled decimal integer that can be used with fseek(3) to read a synset from the data file. When passed to read_synset(3) along with the syntactic category, a data structure containing the parsed synset is returned.

### Data File Format
Each data file begins with several lines containing a copyright notice, version number and license agreement. These lines all begin with two spaces and the line number. All other lines are in the following format. Integer fields are of fixed length, and are zero-filled.

```
synset_offset  lex_filenum  ss_type  w_cnt  word  lex_id  [word  lex_id...]  p_cnt  [ptr...]  [frames...]  |  gloss
```

synset_offset

Current byte offset in the file represented as an 8 digit decimal integer.

lex_filenum

Two digit decimal integer corresponding to the lexicographer file name containing the synset. See lexnames(5) for the list of filenames and their corresponding numbers.

ss_type

One character code indicating the synset type:

```
n	NOUN
v	VERB
a	ADJECTIVE
s	ADJECTIVE SATELLITE
r	ADVERB
```

w_cnt

Two digit hexadecimal integer indicating the number of words in the synset.

word

ASCII form of a word as entered in the synset by the lexicographer, with spaces replaced by underscore characters (_). The text of the word is case sensitive, in contrast to its form in the corresponding index.pos file, that contains only lower-case forms. In data.adj, a word is followed by a syntactic marker if one was specified in the lexicographer file. A syntactic marker is appended, in parentheses, onto word without any intervening spaces. See wninput(5) for a list of the syntactic markers for adjectives.

lex_id

One digit hexadecimal integer that, when appended onto lemma, uniquely identifies a sense within a lexicographer file. lex_id numbers usually start with 0, and are incremented as additional senses of the word are added to the same file, although there is no requirement that the numbers be consecutive or begin with 0. Note that a value of 0 is the default, and therefore is not present in lexicographer files.

p_cnt

Three digit decimal integer indicating the number of pointers from this synset to other synsets. If p_cnt is 000 the synset has no pointers.

ptr

A pointer from this synset to another. ptr is of the form:

```
pointer_symbol  synset_offset  pos  source/target
```

where synset_offset is the byte offset of the target synset in the data file corresponding to pos.

The source/target field distinguishes lexical and semantic pointers. It is a four byte field, containing two two-digit hexadecimal integers. The first two digits indicates the word number in the current (source) synset, the last two digits indicate the word number in the target synset. A value of 0000 means that pointer_symbol represents a semantic relation between the current (source) synset and the target synset indicated by synset_offset.

A lexical relation between two words in different synsets is represented by non-zero values in the source and target word numbers. The first and last two bytes of this field indicate the word numbers in the source and target synsets, respectively, between which the relation holds. Word numbers are assigned to the word fields in a synset, from left to right, beginning with 1.

See wninput(5) for a list of pointer_symbols, and semantic and lexical pointer classifications.

frames

In data.verb only, a list of numbers corresponding to the generic verb sentence frames for words in the synset. frames is of the form:

```
f_cnt   +   f_num  w_num  [ +   f_num  w_num...]
```

where f_cnt a two digit decimal integer indicating the number of generic frames listed, f_num is a two digit decimal integer frame number, and w_num is a two digit hexadecimal integer indicating the word in the synset that the frame applies to. As with pointers, if this number is 00, f_num applies to all words in the synset. If non-zero, it is applicable only to the word indicated. Word numbers are assigned as described for pointers. Each f_num w_num pair is preceded by a +. See wninput(5) for the text of the generic sentence frames.

gloss

Each synset contains a gloss. A gloss is represented as a vertical bar (|), followed by a text string that continues until the end of the line. The gloss may contain a definition, one or more example sentences, or both.

### Sense Numbers
Senses in WordNet are generally ordered from most to least frequently used, with the most common sense numbered 1. Frequency of use is determined by the number of times a sense is tagged in the various semantic concordance texts. Senses that are not semantically tagged follow the ordered senses. The tagsense_cnt field for each entry in the index.pos files indicates how many of the senses in the list have been tagged.

The cntlist(5) file provided with the database lists the number of times each sense is tagged in the semantic concordances. The data from cntlist is used by grind(1) to order the senses of each word. When the index.pos files are generated, the synset_offsets are output in sense number order, with sense 1 first in the list. Senses with the same number of semantic tags are assigned unique but consecutive sense numbers. The WordNet OVERVIEW search displays all senses of the specified word, in all syntactic categories, and indicates which of the senses are represented in the semantically tagged texts.

### Exception List File Format
Exception lists are alphabetized lists of inflected forms of words and their base forms. The first field of each line is an inflected form, followed by a space separated list of one or more base forms of the word. There is one exception list file for each syntactic category.

Note that the noun and verb exception lists were automatically generated from a machine-readable dictionary, and contain many words that are not in WordNet. Also, for many of the inflected forms, base forms could be easily derived using the standard rules of detachment programmed into Morphy (See morph(7)). These anomalies are allowed to remain in the exception list files, as they do no harm.

### Verb Example Sentences
For some verb senses, example sentences illustrating the use of the verb sense can be displayed. Each line of the file sentidx.vrb contains a sense_key followed by a space and a comma separated list of example sentence template numbers, in decimal. The file sents.vrb lists all of the example sentence templates. Each line begins with the template number followed by a space. The rest of the line is the text of a template example sentence, with %s used as a placeholder in the text for the verb. Both files are sorted alphabetically so that the sense_key and template sentence number can be used as indices, via binsrch(3), into the appropriate file.

When a request for FRAMES is made, the WordNet search code looks for the sense in sentidx.vrb. If found, the sentence template(s) listed is retrieved from sents.vrb, and the %s is replaced with the verb. If the sense is not found, the applicable generic sentence frame(s) listed in frames is displayed.

## NOTES
Information in the data.pos and index.pos files represents all of the word senses and synsets in the WordNet database. The word, lex_id, and lex_filenum fields together uniquely identify each word sense in WordNet. These can be encoded in a sense_key as described in senseidx(5). Each synset in the database can be uniquely identified by combining the synset_offset for the synset with a code for the syntactic category (since it is possible for synsets in different data.pos files to have the same synset_offset).

The WordNet system provide both command line and window-based browser interfaces to the database. Both interfaces utilize a common library of search and morphology code. The source code for the library and interfaces is included in the WordNet package. See wnintro(3) for an overview of the WordNet source code.

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

## FILES
index.pos

database index files

data.pos

database data files

*.vrb

files of sentences illustrating the use of verbs

pos.exc

morphology exception lists

## SEE ALSO
grind(1), wn(1), wnb(1), wnintro(3), binsrch(3), wnintro(5), cntlist(5), lexnames(5), senseidx(5), wninput(5), morphy(7), wngloss(7), wngroups(7), wnstats(7).