xymonweb

title: xymonweb(5)

summary: web page headers, footers and forms.

text:
# xymonweb(5)

## NAME
Xymon-Web-Templates - web page headers, footers and forms.

## DESCRIPTION
The Xymon webpages are somewhat customizable, by modifying the header- and footer-templates found in the ~xymon/server/web/ directory. There are usually two or more files for a webpage: A template_header file which is the header for this webpage, and a template_footer file which is the footer. Webpages where entry forms are used have a template_form file which is the data-entry form.

With the exception of the bulletin files, the header files are inserted into the HTML code at the very beginning and the footer files are inserted at the bottom.

The following templates are available:

bulletin

A bulletin_header and bulletin_footer is not shipped with Xymon, but if they exist then the content of these files will be inserted in all HTML documents generated by Xymon. The "bulletin_header" contents will appear after the normal header for the webpage, and the "bulletin_footer" will appear just before the normal footer for the webpage. These files can be used to post important information about the Xymon system, e.g. to notify users of current operational or monitoring problems.

acknowledge

Header, footer and form template for the Xymon acknowledge alert webpage generated by acknowledge.cgi(1)

stdnormal

Header and footer for the Xymon Main view webpages, generated by xymongen(1)

stdnongreen

Header and footer for the Xymon All non-green view webpage, generated by xymongen(1)

stdcritical (DEPRECATED)

Header and footer for the now deprecated old critical webpage, generated by xymongen. You should use the newer criticalview.cgi(1) utility instead, which uses the critical templates.

repnormal

Header and footer for the Xymon Main view availability report webpages, generated by xymongen(1) when running in availability report mode.

snapnormal

Header and footer for the Xymon Main view snapshot webpages, generated by xymongen(1) when running in snapshot report mode.

snapnongreen

Header and footer for the Xymon All non-green view snapshot webpage, generated by xymongen(1) when running in snapshot report mode.

columndoc

Header and footer for the Xymon Column documentation webpages, generated by the csvinfo.cgi(1) utility in the default Xymon configuration.

confreport

Header and footer for the Xymon Configuration report webpage, generated by the confreport.cgi(1) utility. Note that there are also "confreport_front" and "confreport_back" templates, these are inserted into the generated report before the hostlist, and before the column documentation, respectively.

event

Header, footer and form for the Xymon Eventlog report, generated by eventlog.cgi(1)

findhost

Header, footer and form for the Xymon Find host webpage, generated by findhost.cgi(1)

graphs

Header and footer for the Xymon Graph details webpages, generated by showgraph.cgi(1)

hist

Header and footer for the Xymon History webpage, generated by history.cgi(1)

histlog

Header and footer for the Xymon Historical status-log webpage, generated by svcstatus.cgi(1) utility when used to show a historical (non-current) status log.

critical

Header and footer for the Xymon Critical Systems view webpage, generated by criticalview.cgi(1)

hostsvc

Header and footer for the Xymon Status-log webpage, generated by svcstatus.cgi(1) utility when used to show a current status log.

info

Header and footer for the Xymon Info column webpage, generated by svcstatus.cgi(1) utility when used to show the host configuration page.

maintact

Header and footer for the Xymon webpage, generated by enadis.cgi(1) utility when using the Enable/Disable "preview" mode.

maint

Header, footer and form for the Xymon Enable/disable webpage, generated by enadis.cgi(1)

critack

Form show on the status-log webpage when viewed from the "Critical Systems" overview. This form is used to acknowledge a critical status by the operators monitoring the Critical Systems view.

critedit

Header, footer and form for the Critical Systems Editor, the criticaleditor.cgi(1) utility.

replog

Header and footer for the Xymon Report status-log webpage, generated by svcstatus.cgi(1) utility when used to show a status log for an availability report.

report

Header, footer and forms for selecting a pre-generated Availability Report. Handled by the datepage.cgi(1) utility.

snapshot

Header and footer for the Xymon Snapshot report selection webpage, generated by snapshot.cgi(1)

## SEE ALSO
xymongen(1), svcstatus.cgi(1), xymon(7)


xymonwebaccess

package: xymon-man

title: xymonwebaccess(5)

summary: Web-based access controls in Xymon

text:
# xymonwebaccess(5)

## NAME
xymon-webaccess - Web-based access controls in Xymon

## DESCRIPTION
Xymon does not provide any built-in authentication (login) mechanism. Instead, it relies on the access controls available in your web server, e.g. the Apache mod_auth modules.

This provides a simple way of controlling access to the physical directories that make up the pages and subpages with the hosts defined in your Xymon hosts.cfg(5) setup - you can use the Apache "require" setting to allow or deny access to information on any page, usually through the use of a "Require group ..." setting. The group name then refers to one or more groups in an Apache AuthGroupFile file.

However, this does not work for the Xymon CGI programs since they are used to fetch information about all hosts in Xymon, but there is only a single directory holding all of the CGI's. So here you can only require that the user is logged-in (the Apache "Require valid-user" directive). A user with a login can - if he knows the hostname - manipulate the request sent to the webserver and fetch information about any status by use of the Xymon CGI programs, even though he cannot see the overview webpages.

To alleviate this situation, the following Xymon CGI's support a "--access=FILENAME" option, where FILENAME is an Apache compatible group-definitions file:

svcstatus.cgi(1)

acknowledge.cgi(1)

enadis.cgi(1)

appfeed.cgi(1)

When invoked with this option the CGI will read the Apache group-definitions file, and assume that an Apache group maps to a Xymon page, and then - based on the logged-in userid - determine which pages and hosts the user is allowed access to. Only information about those hosts will be made available by the CGI tool.

Members of the group root has access to all hosts.

Access will also be granted, if the user is a member of a group with the same name as the host being requested, or as the statuscolumn being requested.

## SEE ALSO
The Apache "Authentication, Authorization and Access Control" documentation, http://httpd.apache.org/docs/2.2/howto/auth.html

branch: sisyphus


zathurarc

package: zathura

title: zathurarc(5)

summary: zathura configuration file

text:
# zathurarc(5)

## NAME
zathurarc - zathura configuration file

## SYNOPSIS
/etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc

## DESCRIPTION
The zathurarc file is a simple plain text file that can be populated with various commands to change the behaviour and the look of zathura which we are going to describe in the following subsections. Each line (besides empty lines and comments (which start with a prepended #) is evaluated on its own, so it is not possible to write multiple commands in one single line.

## COMMANDS

### set - Changing options
In addition to the built-in :set command zathura offers more options to be changed and makes those changes permanent. To overwrite an option you just have to add a line structured like the following

```
set <option> <new value>
```

The option field has to be replaced with the name of the option that should be changed and the new value field has to be replaced with the new value the option should get. The type of the value can be one of the following:

- INT - An integer number

- FLOAT - A floating point number

- STRING - A character string

- BOOL - A boolean value ("true" for true, "false" for false)

In addition we advice you to check the options to get a more detailed view of the options that can be changed and which values they should be set to.

The following example should give some deeper insight of how the set command can be used

```
set option1 5
set option2 2.0
set option3 hello
set option4 hello\ world
set option5 "hello world"
```

Especially for options with strings as values, note that escaping of special characters and white spaces is necessary. In the above example, option4 and option5 are both set to hello world, but set option6 hello world would set option6 only to hello.

For colors, zathura supports HTML color codes and CSS3-style rgb(r,g,b) and rgba(r,g,b,a) values. If you want to use color codes for some options, make sure to quote them accordingly or to escape the hash symbol.

```
set default-fg "#CCBBCC"
set default-fg \#CCBBCC
```

For rgba, note that it parses the color components as integers between 0 and 255 and the alpha component as float between 0 and 1.

### include - Including another config file
This commands allows one to include other configuration files. If a relative path is given, the path will be resolved relative to the configuration file that is currently processed.

```
include another-config
```

### map - Mapping a shortcut
It is possible to map or remap new key bindings to shortcut functions which allows a high level of customization. The :map command can also be used in the zathurarc file to make those changes permanent:

```
map [mode] <binding> <shortcut function> <argument>
```

Mode

The map command expects several arguments where only the binding as well as the shortcut-function argument is required. Since zathura uses several modes it is possible to map bindings only for a specific mode by passing the mode argument which can take one of the following values:

- normal (default)

- fullscreen

- presentation

- index

The brackets around the value are mandatory.

Single key binding

The (possible) second argument defines the used key binding that should be mapped to the shortcut function and is structured like the following. On the one hand it is possible to just assign single letters, numbers or signs to it:

```
map a shortcut_function optional_argument
map b shortcut_function optional_argument
map c shortcut_function optional_argument
map 1 shortcut_function optional_argument
map 2 shortcut_function optional_argument
map 3 shortcut_function optional_argument
map ! shortcut_function optional_argument
map ? shortcut_function optional_argument
```

Using modifiers

It is also possible to use modifiers like the Control or Alt button on the keyboard. It is possible to use the following modifiers:

- A - Alt

- C - Control

- S - Shift

If any of the modifiers should be used for a binding, it is required to define the binding with the following structure:

```
map <A-a> shortcut_function
map <C-a> shortcut_function
```

Special keys

zathura allows it also to assign keys like the space bar or the tab button which also have to be written in between angle brackets. The following special keys are currently available:

```
Identifier    Description
BackSpace     Back space
CapsLock      Caps lock
NumLock       Num Lock
ScrollLock    Scroll Lock
Esc           Escape
Down          Arrow down
Up            Arrow up
Left          Arrow left
Right         Arrow right
F1            F1
F2            F2
F3            F3
F4            F4
F5            F5
F6            F6
F7            F7
F8            F8
F9            F9
F10           F10
F11           F11
F12           F12
PageDown      Page Down
PageUp        Page Up
Return        Return
Space         Space
Super         Windows key
Tab           Tab
Print         Print key
KPUp          Numpad Up (where the number 8 is)
KPDown        Numpad Down (where the number 2 is)
KPLeft        Numpad Left (where the number 4 is)
KPRight       Numpad Right (where the number 6 is)
KPBegin       Numpad Center button (where the number 5 is)
KPPrior       Numpad PageUp (where the number 9 is)
KPPageUp      Numpad PageUp (where the number 9 is)
KPNext        Numpad PageDown (where the number 3 is)
KPPageDown    Numpad PageDown (where the number 3 is)
KPHome        Numpad Home (where the number 7 is)
KPEnd         Numpad End (where the number 1 is)
KPInsert      Numpad Insert (where the number 0 is)
KPDelete      Numpad Delete (where the numpad period is)
KPMultiply    Numpad Asterisk
KPAdd         Numpad Plus sign
KPSubtract    Numpad Minus sign
KPDivide      Numpad Slash sign
```

Of course it is possible to combine those special keys with a modifier. The usage of those keys should be explained by the following examples:

```
map <Space> shortcut_function
map <C-Space> shortcut_function
```

Mouse buttons

It is also possible to map mouse buttons to shortcuts by using the following special keys:

```
Identifier Description
Button1    Mouse button 1 (left)
Button2    Mouse button 2 (middle)
Button3    Mouse button 3 (right)
Button4    Mouse button 4
Button5    Mouse button 5
```

They can also be combined with modifiers:

```
map <Button1> shortcut_function
map <C-Button1> shortcut_function
```

Buffer commands

If a mapping does not match one of the previous definition but is still a valid mapping it will be mapped as a buffer command:

```
map abc quit
map test quit
```

Shortcut functions

The following shortcut functions can be mapped:

- abort Switch back to normal mode.

- adjust_window Adjust page width. Possible arguments are best-fit and width.

- change_mode Change current mode. Pass the desired mode as argument.

- copy_filepath Copy the full path of the currently opened document to the clipboard

- copy_link Copy a link target to the clipboard.

- cycle_first_column In multiple page layout, cycle the column in which the first page is displayed.

- display_link: Display link target.

- exec: Execute an external command. $FILE expands to the current document path, $PAGE to the current page number, and $DBUS to the bus name of the D-Bus interface.

- file_chooser: Open a File Chooser Dialog. Uses the native file chooser on Windows and MacOS, desktop portals when available and otherwise GtkFileChooser.

- focus_inputbar Focus inputbar.

- follow Follow a link.

- goto Go to a certain page.

- jumplist Move forwards/backwards in the jumplist. Pass forward as argument to move to the next entry and backward to move to the previous one.

- navigate Navigate to the next/previous page.

- navigate_index Navigate through the index.

- print Show the print dialog.

- page_mode Set the page sizing mode. Default is equal_none, which doesn't resize individual pages. equal_width and equal_height resizes each page to have the same width and height respectively.

- quit Quit zathura.

- recolor Recolor pages.

- reload Reload the document.

- rotate Rotate the page. Pass rotate-ccw as argument for counterclockwise rotation and rotate-cw for clockwise rotation.

- scroll Scroll.

- search Search next/previous item. Pass forward as argument to search for the next hit and backward to search for the previous hit.

- set Set an option.

- snap_to_page Snaps to the current page. Equivalent to goto <current_page>

- toggle_fullscreen Toggle fullscreen.

- toggle_index Show or hide index.

- toggle_inputbar Show or hide inputbar.

- toggle_page_mode Toggle between one and multiple pages per row.

- toggle_single_page_mode Toggle between displaying a page grid or a single page.

- toggle_statusbar Show or hide statusbar.

- zoom Zoom in or out.

- zoom_page Zoom in or out of the current page.

- mark_add Set a quickmark.

- mark_evaluate Go to a quickmark.

- feedkeys Simulate key presses. Note that all keys will be interpreted as if pressing a key on the keyboard. To input uppercase letters, follow the same convention as for key bindings, i.e. for X, use <S-X>.

Pass arguments

Some shortcut function require or have optional arguments which influence the behaviour of them. Those can be passed as the last argument:

```
map <C-i> zoom in
map <C-o> zoom out
```

Possible arguments are:

- best-fit

- bottom

- backward

- collapse

- collapse-recursive

- collapse-all

- default

- down

- expand

- expand-recursive

- expand-all

- forward

- full-down

- full-up

- half-down

- half-up

- smooth-down

- smooth-up

- in

- left

- next

- out

- page-bottom

- page-top

- previous

- right

- rotate-ccw

- rotate-cw

- select

- specific

- toggle

- top

- up

- width

- equal_none

- equal_width

- equal_height

### unmap - Removing a shortcut
In addition to mapping or remaping custom key bindings it is possible to remove existing ones by using the :unmap command. The command is used in the following way (the explanation of the parameters is described in the map section of this document

```
unmap [mode] <binding>
```

## OPTIONS
This section describes settings concerning the behaviour of zathura. The settings described here can be changed with set.

n-completion-items

Defines the maximum number of displayed completion entries.

- Value type: Integer

- Default value: 15

completion-bg

Defines the background color that is used for command line completion entries

- Value type: String

- Default value: #232323

completion-fg

Defines the foreground color that is used for command line completion entries

- Value type: String

- Default value: #DDDDDD

completion-group-bg

Defines the background color that is used for command line completion group elements

- Value type: String

- Default value: #000000

completion-group-fg

Defines the foreground color that is used for command line completion group elements

- Value type: String

- Default value: #DEDEDE

completion-highlight-bg

Defines the background color that is used for the current command line completion element

- Value type: String

- Default value: #9FBC00

completion-highlight-fg

Defines the foreground color that is used for the current command line completion element

- Value type: String

- Default value: #232323

default-bg

Defines the default background color

- Value type: String

- Default value: #000000

default-fg

Defines the default foreground color

- Value type: String

- Default value: #DDDDDD

exec-command

Defines a command the should be prepended to any command run with exec.

- Value type: String

- Default value:

font

Defines the font that will be used

- Value type: String

- Default value: monospace normal 9

guioptions

Shows or hides GUI elements. If it contains 'c', the command line is displayed. If it contains 's', the statusbar is displayed. If it contains 'h', the horizontal scrollbar is displayed. If it contains 'v', the vertical scrollbar is displayed.

- Value type: String

- Default value: s

inputbar-bg

Defines the background color for the inputbar

- Value type: String

- Default value: #131313

inputbar-fg

Defines the foreground color for the inputbar

- Value type: String

- Default value: #9FBC00

notification-bg

Defines the background color for a notification

- Value type: String

- Default value: #FFFFFF

notification-fg

Defines the foreground color for a notification

- Value type: String

- Default value: #000000

notification-error-bg

Defines the background color for an error notification

- Value type: String

- Default value: #FF1212

notification-error-fg

Defines the foreground color for an error notification

- Value type: String

- Default value: #FFFFFF

notification-warning-bg

Defines the background color for a warning notification

- Value type: String

- Default value: #FFF712

notification-warning-fg

Defines the foreground color for a warning notification

- Value type: String

- Default value: #FFFFFF

statusbar-bg

Defines the background color of the statusbar

- Value type: String

- Default value: #000000

statusbar-fg

Defines the foreground color of the statusbar

- Value type: String

- Default value: #FFFFFF

statusbar-h-padding

Defines the horizontal padding of the statusbar and notificationbar

- Value type: Integer

- Default value: 8

statusbar-v-padding

Defines the vertical padding of the statusbar and notificationbar

- Value type: Integer

- Default value: 2

window-height

Defines the window height on startup

- Value type: Integer

- Default value: 600

window-width

Defines the window width on startup

- Value type: Integer

- Default value: 800

abort-clear-search

Defines if the search results should be cleared on abort.

- Value type: Boolean

- Default value: true

adjust-open

Defines which auto adjustment mode should be used if a document is loaded. Possible options are "best-fit" and "width".

- Value type: String

- Default value: best-fit

advance-pages-per-row

Defines if the number of pages per row should be honored when advancing a page.

- Value type: Boolean

- Default value: false

continuous-hist-save

Tells zathura whether to save document history at each page change or only when closing a document.

- Value type: Boolean

- Default value: false

database

Defines the database backend to use for bookmarks and input history. Possible values are "sqlite" and "null". If "null" is used, bookmarks and input history will not be stored.

- Value type: String

- Default value: sqlite

dbus-raise-window

Defines whether zathura's window should be raised when receiving certain commands via D-Bus.

- Value type: Boolean

- Default value: true

dbus-service

En/Disables the D-Bus service. If the services is disabled, SyncTeX forward synchronization is not available.

- Value type: Boolean

- Default value: true

double-click-follow

Defines whether double or single click on a link should trigger follow.

- Value type: Boolean

- Default value: true

filemonitor

Defines the file monitor backend used to check for changes in files. Possible values are "glib", "signal" (if signal handling is supported), and "noop". The "noop" file monitor does not trigger reloads.

- Value type: String

- Default value: glib

first-page-column

Defines the column in which the first page will be displayed. This setting is stored separately for every value of pages-per-row according to the following pattern <1 page per row>:[<2 pages per row>[: ...]]. The last value in the list will be used for all other number of pages per row if not set explicitly. Per default, the first column is set to 2 for double-page layout, i.e. the value is set to 1:2. A value of 1:1:3 would put the first page in dual-page layout in the first column, and for layouts with more columns the first page would be put in the 3rd column.

- Value type: String

- Default value: 1:2

highlight-active-color

Defines the color that is used to show the current selected highlighted element (e.g: current search result)

- Value type: String

- Default value: rgba(0,188,0,0.5)

highlight-color

Defines the color that is used for highlighting parts of the document (e.g.: show search results)

- Value type: String

- Default value: rgba(159,251,0,0.5)

highlight-fg

Defines the color that is used for text when highlighting parts of the document (e.g.: number for links).

- Value type: String

- Default value: rgba(0,0,0,0.5)

highlighter-modifier

Defines the modifier that needs to be pressed together with the left mouse button to draw the highlighter. Possible values are "shift", "ctrl" and "alt".

- Value type: String

- Default value: shift

incremental-search

En/Disables incremental search (search while typing).

- Value type: Boolean

- Default value: true

index-active-bg

Define the background color of the selected element in index mode.

- Value type: String

- Default value: #9FBC00

index-active-fg

Defines the foreground color of the selected element in index mode.

- Value type: String

- Default value: #232323

index-bg

Define the background color of the index mode.

- Value type: String

- Default value: #232323

index-fg

Defines the foreground color of the index mode.

- Value type: String

- Default value: #DDDDDD

jumplist-size

Maximum number of positions to remember in the jumplist.

- Value type: Integer

- Default value: 2000

link-hadjust

En/Disables aligning to the left internal link targets, for example from the index.

- Value type: Boolean

- Default value: true

link-zoom

En/Disables the ability of changing zoom when following links.

- Value type: Boolean

- Default value: true

nohlsearch

Dis/Enables the highlighting of search results.

- Value type: Boolean

- Default value: false

open-first-page

Always open documents on the first page. If disabled, zathura will jump to the last remembered position.

- Value type: Boolean

- Default value: false

page-cache-size

Defines the maximum number of pages that could be kept in the page cache. When the cache is full and a new page that isn't cached becomes visible, the least recently viewed page in the cache will be evicted to make room for the new one. Large values for this variable are NOT recommended, because this will lead to consuming a significant portion of the system memory.

- Value type: Integer

- Default value: 15

page-v-padding

Vertical page padding defines the vertical gap in pixels between each rendered page.

- Value type: Integer

- Default value: 1

page-h-padding

Horizontal page padding defines the horizontal gap in pixels between each rendered page.

- Value type: Integer

- Default value: 1

page-right-to-left

Defines whether pages in multi-column view should start from the right side.

- Value type: Boolean

- Default value: false

page-thumbnail-size

Defines the maximum size in pixels of the thumbnail that could be kept in the thumbnail cache per page. The thumbnail is scaled for a quick preview during zooming before the page is rendered. When the page is rendered, the result is saved as the thumbnail only if the size is no more than this value. A larger value increases quality but introduces longer delay in zooming and uses more system memory.

- Value type: Integer

- Default value: 4194304 (4M)

pages-per-row

Defines the number of pages that are rendered next to each other in a row.

- Value type: Integer

- Default value: 1

recolor

En/Disables recoloring

- Value type: Boolean

- Default value: false

recolor-adjust-lightness

En/Disables adjusting lightness when recoloring.

- Value type: Boolean

- Default value: false

recolor-darkcolor

Defines the color value that is used to represent dark colors in recoloring mode

- Value type: String

- Default value: #FFFFFF

recolor-keephue

En/Disables keeping original hue when recoloring

- Value type: Boolean

- Default value: false

recolor-lightcolor

Defines the color value that is used to represent light colors in recoloring mode

- Value type: String

- Default value: #000000

recolor-reverse-video

Defines if original image colors should be kept while recoloring.

- Value type: Boolean

- Default value: false

render-loading

Defines if the "Loading..." text should be displayed if a page is rendered.

- Value type: Boolean

- Default value: true

render-loading-bg

Defines the background color that is used for the "Loading..." text.

- Value type: String

- Default value: #FFFFFF

render-loading-fg

Defines the foreground color that is used for the "Loading..." text.

- Value type: String

- Default value: #000000

scroll-full-overlap

Defines the proportion of the current viewing area that should be visible after scrolling a full page.

- Value type: Float

- Default value: 0

scroll-hstep

Defines the horizontal step size of scrolling by calling the scroll command once

- Value type: Float

- Default value: -1

scroll-step

Defines the step size of scrolling by calling the scroll command once

- Value type: Float

- Default value: 40

scroll-page-aware

Defines if scrolling by half or full pages stops at page boundaries.

- Value type: Boolean

- Default value: false

scroll-wrap

Defines if the last/first page should be wrapped

- Value type: Boolean

- Default value: false

search-hadjust

En/Disables horizontally centered search results.

- Value type: Boolean

- Default value: true

selection-clipboard

Defines the X clipboard into which mouse-selected data will be written. When it is "clipboard", selected data will be written to the CLIPBOARD clipboard, and can be pasted using the Ctrl+v key combination. When it is "primary", selected data will be written to the PRIMARY clipboard, and can be pasted using the middle mouse button, or the Shift-Insert key combination. The value "false" can be used to disable copying to the clipboard.

- Value type: String

- Default value: primary

selection-notification

Defines if a notification should be displayed after selecting text.

- Value type: Boolean

- Default value: true

signature-error-color

Defines the background color when displaying additional information for signatures with errors.

- Value type: String

- Default value: rgba(92%,11%,14%,0.9)

signature-success-color

Defines the background color when displaying additional information for valid signatures.

- Value type: String

- Default value: rgba(18%,80%,33%,0.9)

signature-warning-color

Defines the background color when displaying additional information for signatures with warnings.

- Value type: String

- Default value: rgba(100%,84%,0%,0.9)

show-directories

Defines if the directories should be displayed in completion.

- Value type: Boolean

- Default value: true

show-hidden

Defines if hidden files and directories should be displayed in completion.

- Value type: Boolean

- Default value: false

show-recent

Defines the number of recent files that should be displayed in completion. If the value is negative, no upper bounds are applied. If the value is 0, no recent files are shown.

- Value type: Integer

- Default value: 10

show-signature-information

Defines whether additional information on signatures embedded in documents should be displayed.

- value type: Boolean

- Default value false

statusbar-basename

Use basename of the file in the statusbar.

- Value type: Boolean

- Default value: false

statusbar-home-tilde

Display a short version of the file path, which replaces $HOME with ~, in the statusbar.

- Value type: Boolean

- Default value: false

statusbar-page-percent

Display (current page / total pages) as a percent in the statusbar.

- Value type: Boolean

- Default value: false

synctex

En/Disables SyncTeX backward synchronization support.

- Value type: Boolean

- Default value: true

synctex-edit-modifier

Defines the modifier that needs to be pressed together with the left mouse button to trigger the SyncTeX backward synchronization. Possible values are "shift", "ctrl" and "alt".

- Value type: String

- Default value: ctrl

synctex-editor-command

Defines the command executed for SyncTeX backward synchronization.

- Value type: String

- Default value:

vertical-center

Center the screen at the vertical midpoint of the page by default.

- Value type: Boolean

- Default value: false

window-icon-document

Defines whether the window document should be updated based on the first page of a dcument.

- Value type: Boolean

- Default value: false

window-title-basename

Use basename of the file in the window title.

- Value type: Boolean

- Default value: false

window-title-home-tilde

Display a short version of the file path, which replaces $HOME with ~, in the window title.

- Value type: Boolean

- Default value: false

window-title-page

Display the page number in the window title.

- Value type: Boolean

- Default value: false

zoom-center

En/Disables horizontally centered zooming.

- Value type: Boolean

- Default value: false

zoom-max

Defines the maximum percentage that the zoom level can be.

- Value type: Integer

- Default value: 1000

zoom-min

Defines the minimum percentage that the zoom level can be.

- Value type: Integer

- Default value: 10

zoom-step

Defines the amount of percent that is zoomed in or out on each command.

- Value type: Integer

- Default value: 10

## SEE ALSO
zathura(1)

## Author
pwmt.org

## Copyright
2009-2026, pwmt.org


package: zfs-utils

title: vdev_id.conf(5)

summary: configuration file for vdev_id(8)

text:
# vdev_id.conf(5)

## NAME
vdev_id.conf — configuration file for vdev_id(8)

## DESCRIPTION
vdev_id.conf is the configuration file for vdev_id(8). It controls the default behavior of vdev_id(8) while it is mapping a disk device name to an alias.

The vdev_id.conf file uses a simple format consisting of a keyword followed by one or more values on a single line. Any line not beginning with a recognized keyword is ignored. Comments may optionally begin with a hash character.

The following keywords and values are used.

alias name devlink

Maps a device link in the /dev directory hierarchy to a new device name. The udev rule defining the device link must have run prior to vdev_id(8). A defined alias takes precedence over a topology-derived name, but the two naming methods can otherwise coexist. For example, one might name drives in a JBOD with the sas_direct topology while naming an internal L2ARC device with an alias. name is the name of the link to the device that will by created under /dev/disk/by-vdev.

devlink is the name of the device link that has already been defined by udev. This may be an absolute path or the base filename.

channel [pci_slot] port name

Maps a physical path to a channel name (typically representing a single disk enclosure).

enclosure_symlinks yes|no

Additionally create /dev/by-enclosure symlinks to the disk enclosure sg devices using the naming scheme from vdev_id.conf. enclosure_symlinks is only allowed for sas_direct mode.

enclosure_symlinks_prefix prefix

Specify the prefix for the enclosure symlinks in the form /dev/by-enclosure/⟨prefix⟩-⟨channel⟩⟨num⟩ Defaults to “enc”.

slot prefix new [channel]

Maps a disk slot number as reported by the operating system to an alternative slot number. If the channel parameter is specified then the mapping is only applied to slots in the named channel, otherwise the mapping is applied to all channels. The first-specified slot rule that can match a slot takes precedence. Therefore a channel-specific mapping for a given slot should generally appear before a generic mapping for the same slot. In this way a custom mapping may be applied to a particular channel and a default mapping applied to the others.

zpad_slot digits

Pad slot numbers with zeros to make them digits long, which can help to make disk names a consistent length and easier to sort.

multipath yes|no

Specifies whether vdev_id(8) will handle only dm-multipath devices. If set to yes then vdev_id(8) will examine the first running component disk of a dm-multipath device as provided by the driver command to determine the physical path.

topology sas_direct|sas_switch|scsi

Identifies a physical topology that governs how physical paths are mapped to channels: sas_direct and scsi

channels are uniquely identified by a PCI slot and HBA port number

sas_switch

channels are uniquely identified by a SAS switch port number

phys_per_port num

Specifies the number of PHY devices associated with a SAS HBA port or SAS switch port. vdev_id(8) internally uses this value to determine which HBA or switch port a device is connected to. The default is 4.

slot bay|phy|port|id|lun|bay_lun|ses

Specifies from which element of a SAS identifier the slot number is taken. The default is bay: bay

read the slot number from the bay identifier.

phy

read the slot number from the phy identifier.

port

use the SAS port as the slot number.

id

use the scsi id as the slot number.

lun

use the scsi lun as the slot number.

bay_lun

read the slot number from the bay identifier and append the lun number. Useful for multi-lun multi-actuator hard drives.

ses

use the SCSI Enclosure Services (SES) enclosure device slot number, as reported by sg_ses(8). Intended for use only on systems where bay is unsupported, noting that port and id may be unstable across disk replacement.

## FILES
/etc/zfs/vdev_id.conf

The configuration file for vdev_id(8).

## EXAMPLES
A non-multipath configuration with direct-attached SAS enclosures and an arbitrary slot re-mapping:

```
multipath     no
topology      sas_direct
phys_per_port 4
slot          bay

#       PCI_SLOT HBA PORT  CHANNEL NAME
channel 85:00.0  1         A
channel 85:00.0  0         B
channel 86:00.0  1         C
channel 86:00.0  0         D

# Custom mapping for Channel A

#    Linux      Mapped
#    Slot       Slot      Channel
slot 1          7         A
slot 2          10        A
slot 3          3         A
slot 4          6         A

# Default mapping for B, C, and D

slot 1          4
slot 2          2
slot 3          1
slot 4          3
```

A SAS-switch topology. Note, that the channel keyword takes only two arguments in this example:

```
topology      sas_switch

#       SWITCH PORT  CHANNEL NAME
channel 1            A
channel 2            B
channel 3            C
channel 4            D
```

A multipath configuration. Note that channel names have multiple definitions - one per physical path:

```
multipath yes

#       PCI_SLOT HBA PORT  CHANNEL NAME
channel 85:00.0  1         A
channel 85:00.0  0         B
channel 86:00.0  1         A
channel 86:00.0  0         B
```

A configuration with enclosure_symlinks enabled:

```
multipath yes
enclosure_symlinks yes

#          PCI_ID      HBA PORT     CHANNEL NAME
channel    05:00.0     1            U
channel    05:00.0     0            L
channel    06:00.0     1            U
channel    06:00.0     0            L
```

In addition to the disks symlinks, this configuration will create:

```
/dev/by-enclosure/enc-L0
/dev/by-enclosure/enc-L1
/dev/by-enclosure/enc-U0
/dev/by-enclosure/enc-U1
```

A configuration using device link aliases:

```
#     by-vdev
#     name     fully qualified or base name of device link
alias d1       /dev/disk/by-id/wwn-0x5000c5002de3b9ca
alias d2       wwn-0x5000c5002def789e
```

## SEE ALSO
vdev_id(8)


zram-generator.conf

package: zram-generator

title: zram-generator.conf(5)

text:
# zram-generator.conf(5)

## NAME
zram-generator.conf - Systemd unit generator for zram swap devices (configuration)

## SYNOPSIS
/usr/lib/systemd/zram-generator.conf

/usr/local/lib/systemd/zram-generator.conf

/etc/systemd/zram-generator.conf

/run/systemd/zram-generator.conf

/usr/lib/systemd/zram-generator.conf.d/*.conf

/usr/local/lib/systemd/zram-generator.conf.d/*.conf

/etc/systemd/zram-generator.conf.d/*.conf

/run/systemd/zram-generator.conf.d/*.conf

## DESCRIPTION
These files configure devices created by zram-generator(8). See systemd.syntax(5) for a general description of the syntax.

## CONFIGURATION DIRECTORIES AND PRECEDENCE
The default configuration doesn´t specify any devices. Consult /usr/share/zram-generator/zram-generator.conf.example for an example configuration file.

When packages need to customize the configuration, they can install configuration snippets in /usr/lib/systemd/zram-generator.conf.d/. Files in /etc/ are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages. The main configuration file is read before any of the configuration directories, and has the lowest precedence; entries in a file in any configuration directory override entries in the single configuration file. Files in the *.conf.d/ configuration subdirectories are sorted by their filename in lexicographic order, regardless of which of the subdirectories they reside in. When multiple files specify the same option, for options which accept just a single value, the entry in the file with the lexicographically latest name takes precedence. It is recommended to prefix all filenames in those subdirectories with a two-digit number and a dash, to simplify the ordering of the files.

To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null in the configuration directory in /etc/, with the same filename as the vendor configuration file.

The generator understands the following option on the kernel command-line: systemd.zram[=0|1]. When specified with a true argument (or no argument), the zram0 device will be created. Default options apply, but may be overridden by configuration on disk if present. When specified with a false argument, no zram devices will be created by the generator. This option thus has higher priority than the configuration files.

## OPTIONS
Each device is configured independently in its [zramN] section, where N is a nonnegative integer. The global section may contain DIRECTIVES. Other sections are ignored.

Devices with the final size of 0 will be discarded.

○

host-memory-limit=

Sets the upper limit on the total usable RAM (as defined by MemTotal in /proc/meminfo, confer proc(5)) above which the device will not be created.

This takes a nonnegative number, representing that limit in megabytes, or the literal string none, which can be used to override a limit set earlier.

Defaults to none.

○

zram-size=

Sets the size of the zram device as a function of MemTotal, available as the ram variable. Additional variables may be provided by DIRECTIVES.

Arithmetic operators (^%/*-+), e, π, SI suffixes, log(), int(), ceil(), floor(), round(), abs(), min(), max(), and trigonometric functions are supported.

Defaults to min(ram / 2, 4096).

○

zram-resident-limit=

Sets the maximum resident memory limit of the zram device (or 0 for no limit) as a function of MemTotal, available as the ram variable.

Same format as zram-size. Defaults to 0.

○

compression-algorithm=

Specifies the algorithm used to compress the zram device.

This takes a whitespace-separated list string, representing the algorithms to use, and parameters in parenteses.

Consult /sys/block/zram0/comp_algorithm (and .../recomp_algorithm) for a list of currently loaded compression algorithms, but note that additional ones may be loaded on demand.

If unset, none will be configured and the kernel´s default will be used.

If more than one is given, and recompression is enabled in the kernel, subsequent ones will be set as the recompression algorithms, with decreasing priority.

If a compression algorithm is suffixed with a parenthesised comma-separated list of parameters, those are given to .../algorithm_params (and .../recompress). A parenthesised parameter list without a compression algorithm is set as the global recompression parameters.

○

writeback-device=

Write incompressible pages, for which no gain was achieved, to the specified device under memory pressure. This corresponds to the /sys/block/zramX/backing_dev parameter.

Takes a path to a block device, like /dev/disk/by-partuuid/2d54ffa0-01 or /dev/zvol/tarta-zoot/swap-writeback.

If unset, none is used, and incompressible pages are kept in RAM.

○

swap-priority=

Controls the relative swap priority, a value between -1 and 32767. Higher numbers indicate higher priority.

If unset, 100 is used.

○

mount-point=

Format the device with a file system (not as swap) and mount this file system over the specified directory. When neither this option nor fs-type= is specified, the device will be formatted as swap.

Note that the device is temporary: contents will be destroyed automatically after the file system is unmounted (to release the backing memory).

○

fs-type=

Specifies how the device shall be formatted. The default is ext2 if mount-point is specified, and swap otherwise. (Effectively, the device will be formatted as swap, if neither fs-type= nor mount-point= are specified.)

Note that the device is temporary: contents will be destroyed automatically after the file system is unmounted (to release the backing memory).

Also see systemd-makefs(8).

○

options=

Sets mount or swapon options. Availability depends on fs-type.

Defaults to discard.

## DIRECTIVES
The global section (before any section header) may contain directives in the following form:

○

set!variable=program

program is executed by the shell as-if by system(3), its standard output stream parsed as an arithmetic expression (like zram-size/zram-resident-limit), then the result is remembered into variable, usable in later set!s and zram-sizes/zram-resident-limits.

## ENVIRONMENT VARIABLES
Setting ZRAM_GENERATOR_ROOT during parsing will cause /proc/meminfo to be read from $ZRAM_GENERATOR_ROOT/proc/meminfo instead, and {/usr/lib,/usr/local/lib,/etc,/run}/systemd/zram-generator.conf to be read from $ZRAM_GENERATOR_ROOT/{/usr/lib,/usr/local/lib,/etc,/run}/systemd/zram-generator.conf.

## EXAMPLES
The default configuration will yield the following:

```
 zram device size

     ^

     │

  4G>│               ooooooooooooo

     │             o

     │           o

     │         o

  2G>│       o

     │     o

     │   o
512M>│ o

     0───────────────────────> total usable RAM

       ^     ^       ^

       1G    4G      8G
```

A piecewise-linear size 1:1 for the first 4G, then 1:2 above, up to a max of 32G:

zram-size = min(min(ram, 4096) + max(ram - 4096, 0) / 2, 32 * 1024)

```
 zram device size

     ^

 32G>|                                                oooooooooooooo

     |                                            o

 30G>|                                        o

     |

    /=/

     |

  8G>│                           o

     │                       o

     │                   o

     │               o

     │           o

  4G>│       o

     │     o

     │   o

  1G>│ o

     0───────────────────────────────────||──────────────────────> total usable RAM

       ^     ^       ^               ^        ^       ^       ^

       1G    4G      8G             12G      56G     60G     64G
```

## OBSOLETE OPTIONS
○

memory-limit=

Compatibility alias for host-memory-limit.

○

zram-fraction=

Defines the scaling factor of the zram device´s size with relation to the total usable RAM.

This takes a nonnegative floating-point number representing that factor.

Defaulted to 0.5. Setting this or max-zram-size overrides zram-size.

○

max-zram-size=

Sets the limit on the zram device´s size obtained by zram-fraction.

This takes a nonnegative number, representing that limit in megabytes, or the literal string none, which can be used to override a limit set earlier.

Defaulted to 4096. Setting this or zram-fraction overrides zram-size.

## REPORTING BUGS
https://github.com/systemd/zram-generator/issues

## SEE ALSO
zram-generator(8), systemd.syntax(5), proc(5)

https://github.com/systemd/zram-generator

Linux documentation of zram: https://kernel.org/doc/html/latest/admin-guide/blockdev/zram.html

and the zram sysfs ABI: https://kernel.org/doc/Documentation/ABI/testing/sysfs-block-zram

fasteval documentation for the entire zram-size arithmetic DSL: https://docs.rs/fasteval/0.2.4/fasteval/#the-fasteval-expression-mini-language