crontab

package: vixie-cron

title: crontab(5)

summary: tables for driving cron

text:
# crontab(5)

## NAME
crontab — tables for driving cron

## DESCRIPTION
A crontab file contains instructions to the cron(8) daemon of the general form: “at these times on these dates run this command”. There may be a system crontab (/etc/crontab) and each user may have their own crontab (/var/spool/cron/<user>). Commands in any given crontab will be executed either as the user who owns the crontab or, in the case of the system crontab, as the user specified in the command line. Uucp and News will usually each have their own crontab, eliminating the need for explicitly running su(1) as part of a cron(8) command.

While a crontab is a text file, it is not intended to be directly edited. Creation, modification, and removal of a crontab should be done using crontab(1).

Blank lines, leading spaces, and tabs are ignored. Lines whose first non-space character is a pound sign (‘#’) are comments, and are ignored. Note that comments are not allowed on the same line as cron(8) commands, since they will be taken to be part of the command. Similarly, comments are not allowed on the same line as environment variable settings.

An active line in a crontab is either an environment variable setting or a cron(8) command.

Environment Variable Settings

Environment variable settings create the environment any command in the crontab is run in. An environment variable setting is of the form:

name = value

where the spaces around the equal-sign (‘=’) are optional, and any subsequent non-leading spaces in value will be part of the value assigned to name. The value string may be placed in quotes (single or double, but matching) to preserve leading or trailing blanks.

Several environment variables are set automatically by the cron(8) daemon. SHELL is set to /bin/sh, and LOGNAME and HOME are set from the /etc/passwd line of the crontab's owner. HOME and SHELL may be overridden by settings in the crontab; LOGNAME may not.

Note: on BSD systems the LOGNAME variable is sometimes called USER. On OpenBSD, cron(8) will set both USER and LOGNAME to the same value.

In addition to LOGNAME, HOME, and SHELL, cron(8) will look at MAILTO if it has any reason to send mail as a result of running commands in “this” crontab. If MAILTO is defined (and non-empty), mail is sent to the user so named. If MAILTO is defined but empty (MAILTO = ‘’), no mail will be sent. Otherwise mail is sent to the owner of the crontab. This option is useful for pseudo-users that lack an alias that would otherwise redirect the mail to a real person.

The MLS_LEVEL environment variable provides support for multiple per-job SELinux security contexts in the same crontab. By default, cron jobs execute with the default SELinux security context of the user that created the crontab file. When using multiple security levels and roles, this may not be sufficient, because the same user may be running in a different role or at a different security level. For more about roles and SELinux MLS/MCS see selinux(8) and undermentioned crontab example. You can set MLS_LEVEL to the SELinux security context string specifying the SELinux security context in which you want the job to run, and crond will set the execution context of the or jobs to which the setting applies to the specified context. See also the crontab(1) -s option.

cron Commands

The format of a cron(8) command is very much the V7 standard, with a number of upward-compatible extensions. Lines in the system crontab have six fixed fields plus a command in the form:

minute hour day-of-month month day-of-week user command

While lines in a user crontab have five fixed fields plus a command in the form:

minute hour day-of-month month day-of-week command

Fields are separated by blanks or tabs. The command may be one or more fields long. The allowed values for the fields are:

field

allowed values

-----

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

minute

* or 0-59

hour

* or 0-23

day-of-month

* or 1-31

month

* or 1-12 or a name (see below)

day-of-week

* or 0-7 or a name (0 or 7 is Sunday)

user

a valid username

command

text

Lists are allowed. A list is a set of numbers (or ranges) separated by commas. Examples: “1,2,5,9”,“0-4,8-12”.

Ranges of numbers are allowed. Ranges are two numbers separated with a hyphen. The specified range is inclusive. For example, 8-11 for an hour entry specifies execution at hours 8, 9, 10 and 11.

Step values can be used in conjunction with ranges. Following a range with /number specifies skips of number through the range. For example, “0-23/2” can be used in the hour field to specify command execution every other hour (the alternative in the V7 standard is “0,2,4,6,8,10,12,14,16,18,20,22”). Steps are also permitted after an asterisk, so if you want to say “every two hours”, just use “*/2”.

An asterisk (‘*’) is short form for a range of all allowed values.

Names can be used in the month and day-of-week fields. Use the first three letters of the particular day or month (case doesn't matter). Ranges or lists of names are not allowed.

The command field (the rest of the line) is the command to be run. The entire command portion of the line, up to a newline or % character, will be executed by /bin/sh or by the shell specified in the SHELL variable of the crontab. Percent signs (‘%’) in the command, unless escaped with a backslash (‘\’), will be changed into newline characters, and all data after the first ‘%’ will be sent to the command as standard input.

Commands are executed by cron(8) when the minute, hour, and month fields match the current time, and when at least one of the two day fields (day-of-month or day-of-week, see Note below) match the current time. cron(8) examines crontab entries once every minute.

Note: The day of a command's execution can be specified by two fields — day-of-month and day-of-week. If both fields are restricted (i.e., aren't *), the command will be run when either field matches the current time. For example,

30 4 1,15 * 5

would cause a command to be run at 4:30 am on the 1st and 15th of each month, plus every Friday.

Instead of the first five fields, one of eight special strings may appear:

string

meaning

------

-------

@reboot

Run once, at cron(8) startup.

@yearly

Run every January 1, "0 0 1 1 *".

@annually

(same as @yearly).

@monthly

Run the first day of every month, "0 0 1 * *".

@weekly

Run every Sunday, "0 0 * * 0".

@daily

Run every midnight, "0 0 * * *".

@midnight

(same as @daily).

@hourly

Run every hour, on the hour, "0 * * * *".

## EXAMPLES

```
# use /bin/sh to run commands, no matter what /etc/passwd says
SHELL=/bin/sh
# mail any output to `paul', no matter whose crontab this is
MAILTO=paul
#
# run five minutes after midnight, every day
5 0 * * *       $HOME/bin/daily.job >> $HOME/tmp/out 2>&1
# run at 2:15pm on the first of every month -- output mailed to paul
15 14 1 * *     $HOME/bin/monthly
# run at 10 pm on weekdays, annoy Joe
0 22 * * 1-5	mail -s "It's 10pm" joe%Joe,%%Where are your kids?%
23 0-23/2 * * * echo "run 23 minutes after midn, 2am, 4am ..., everyday"
5 4 * * sun     echo "run at 5 after 4 every sunday"
```

## SELinux with multi level security (MLS)
In crontab is important specified security level by crontab -s or specifying the required level on the first line of the crontab. Each level is specified in /etc/selinux/targeted/seusers. For using crontab in MLS mode is really important:

- check/change actual role,

- set correct role for directory, which is used for input/output.

## EXAMPLE FOR SELINUX MLS

```
# login as root
newrole -r sysadm_r
mkdir /tmp/SystemHigh
chcon -l SystemHigh /tmp/SystemHigh
crontab -e
# write in crontab file
MLS_LEVEL=SystemHigh
0-59 * * * * id -Z > /tmp/SystemHigh/crontest
When I log in as a normal user, it can't work, because /tmp/SystemHigh is
higher than my level.
```

## SEE ALSO
crontab(1), cron(8)

## EXTENSIONS
When specifying day-of-week, both day 0 and day 7 will be considered Sunday. BSD and ATT seem to disagree about this.

Lists and ranges are allowed to coexist in the same field. “1-3,7-9” would be rejected by ATT or BSD cron — they want to see “1-3” or “7,8,9” only.

Ranges can include “steps”, so “1-9/2” is the same as “1,3,5,7,9”.

Months or days of the week can be specified by name.

Environment variables can be set in the crontab. In BSD or ATT, the environment handed to child processes is basically the one from /etc/rc.

Command output is mailed to the crontab owner (BSD can't do this), can be mailed to a person other than the crontab owner (SysV can't do this), or the feature can be turned off and no mail will be sent at all (SysV can't do this either).

All of the ‘@’ commands that can appear in place of the first five fields are extensions.

## AUTHORS
Paul Vixie ⟨vixie@isc.org⟩


vnstat.conf

package: vnstat

title: vnstat.conf(5)

summary: vnStat configuration file

text:
# vnstat.conf(5)

## NAME
vnstat.conf - vnStat configuration file

## SYNOPSIS
/etc/vnstat.conf

## DESCRIPTION
vnstat(1), vnstati(1) and vnstatd(8) all use the same configuration file for configuration related settings. Some of the settings are common for all three programs. The file consists of keyword-argument pairs, one per line. Empty lines and lines starting with '#' or ';' are interpreted as comments and not processed. Arguments may optionally be enclosed in double quotes (") in order to represent arguments containing spaces. Arguments can be padded with spaces or tabulator characters. A hardcoded default value will be used if a keyword can't be found from the configuration file or if the configured value cannot be parsed or is outside supported value range.

The configuration file is divided into three sections based on the usage of each keyword. The first section contains keywords that are considered common for all commands, the second section is for daemon related keywords and the last section is for image output.

## COMMON KEYWORDS
DatabaseDir

Specifies the directory where the database is to be stored. A full path must be given and a leading '/' isn't required.

DayFormat, MonthFormat, TopFormat

Formatting of date in available outputs. Uses the same format as date(1). (vnstat and vnstati only)

DefaultDecimals

Number of decimals to use in outputs. Value range: 0..2 (vnstat and vnstati only)

EstimateBarVisible

Show a visual representation of the traffic estimation if OutputStyle has been configured with a value of 1 or 2 to make the bar column visible. 1 = enabled, 0 = disabled. (vnstat only, see EstimateStyle for vnstati)

EstimateText

Replace default "estimated" text on the estimate line with custom text. Limited to 9 characters. (vnstat and vnstati only)

EstimateVisible

Show a line with traffic estimation for the selected time period or alert as the last line of the output in output modes supporting it. Disabling estimate visibility also disables estimate conditions in --alert. 1 = enabled, 0 = disabled. (vnstat and vnstati only)

HourlyDecimals

Number of decimals to use in hourly graph output. Value range: 0..2 (vnstat only)

HourlySectionStyle

Select what kind of spacer is used for separating the numerical sections of the hourly graph output. 0 = none, 1 = '|', 2 = '][', 3 = '[ ]'. (vnstat only)

Interface

Default interface used when no other interface is specified on the command line. Leave empty for automatic selection. The automatic selection will prioritize the interface with most traffic for outputs doing database queries. Queries not using the database will first check if the database is available and select the interface with most traffic out those that are currently visible in the system. If no database can be read then the first available interface will be used. (vnstat and vnstati only)

InterfaceMatchMethod

Method for matching interface given for a query to an interface in the database. Method 0 requires the interface name to be a case sensitive exact match. Method 1 extends the previous method by allowing a case sensitive exact match of the interface alias. Method 2 extends the previous method by allowing a case insensitive exact match of the interface alias. Method 3 extends the previous method by allowing a case insensitive match of the beginning of the interface alias.

Methods will be evaluated in the order described above resulting in exact interface matches always taking precedence. If any interface alias matching method results in multiple matches then the interface with the highest total traffic will be used. (vnstat and vnstati only)

InterfaceOrder

Interface order in outputs with multiple interfaces. 0 = alphabetical by name, 1 = alphabetical by alias. If 1 is selected and multiple interfaces don't have aliases then the interface name will be used for defining the order. (vnstat only)

List5Mins, ListHours, ListDays, ListMonths, ListYears, ListTop

Number of entries to show in list outputs unless overridden from the command line. Set to 0 to show all entries available in the database. (vnstat and vnstati)

LiveSpinner

Show spinning animation at the beginning of -l / --live output line. 1 = enabled, 0 = disabled. (vnstat only)

Locale

Locale setting to be used for prints. This replaces the LC_ALL environment variable. Set to "-" or leave empty in order to use the system default value. (vnstat and vnstati only)

OutputStyle

Modify the content and style of text outputs. 0 = minimal and narrow output for terminal with limited width, 1 = normal output with bar column visible, 2 = same as 1 except rate is visible in summary output, 3 = rate column is visible in all outputs where it is supported. (vnstat and vnstati only)

QueryMode

Default query mode when no parameters are given. 0 = summary, 1 = days, 2 = months, 3 = top, 4 = single summary, 5 = short, 6 = years, 7 = hours graph, 8 = xml, 9 = one line, 10 = json, 11 = hours and 12 = 5 minute. (vnstat only)

RateUnit

Select which unit is used when traffic rate is visible. 0 = bytes, 1 = bits. (vnstat and vnstati only)

RateUnitMode

Select used prefix when traffic rate is shown in bits per second. IEC binary prefixes are calculated with powers of 1024. SI decimal prefixes are calculated with powers of 1000. 0 = IEC binary prefixes (Kibit/s...), 1 = SI decimal prefixes (kbit/s...). (vnstat and vnstati only)

RXCharacter, TXCharacter

Character used for representing the percentual share of received and transmitted traffic in list mode outputs. (vnstat only)

RXHourCharacter, TXHourCharacter

Character used for representing the percentual share of received and transmitted traffic in hourly graph output. (vnstat only)

Sampletime

Defines how many seconds the -tr option will sample traffic. Value range: 2..600 (vnstat only)

UnitMode

Select how units are prefixed. IEC and JEDEC binary prefixes are calculated with powers of 1024. SI decimal prefixes are calculated with powers of 1000. 0 = IEC standard prefixes (B/KiB/MiB/GiB...), 1 = old style (JEDEC) binary prefixes (B/KB/MB/GB...), 2 = SI decimals prefixes (B/kB/MB/GB...) (vnstat and vnstati only)

## DAEMON RELATED KEYWORDS
5MinuteHours

Data retention duration for the 5 minute resolution entries. The configuration defines for how many past hours entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data collection of this resolution.

64bitInterfaceCounters

Select interface counter handling. Set to 1 for defining that all interfaces use 64-bit counters on the kernel side and 0 for defining 32-bit counter. Set to -1 for using the old style logic used in earlier versions where counter values within 32-bits are assumed to be 32-bit and anything larger is assumed to be a 64-bit counter. This may produce false results if a 64-bit counter is reset within the 32-bits. Set to -2 for using automatic detection based on available kernel datastructures.

AlwaysAddNewInterfaces

Enable or disable automatic creation of new database entries for interfaces not currently in the database even if the database file already exists when the daemon is started. New database entries will also get created for new interfaces seen while the daemon is running. Pseudo interfaces lo, lo0 and sit0 are always excluded from getting added. 1 = enabled, 0 = disabled.

BandwidthDetection

Try to automatically detect MaxBandwidth value for each monitored interface. Mostly only ethernet interfaces support this feature. MaxBandwidth will be used as fallback value if detection fails. Any interface specific MaxBW configuration will disable the detection for the specified interface. In Linux, the detection is disabled for tun interfaces due to the Linux kernel always reporting 10 Mbit regardless of the used real interface. 1 = enabled, 0 = disabled.

BandwidthDetectionInterval

How often in minutes interface specific detection of MaxBandwidth is done for detecting possible changes when BandwidthDetection is enabled. Can be disabled by setting to 0. Value range: 0..30

BootVariation

Time in seconds how much the boot time reported by system kernel can variate between updates. Value range: 0..300

CheckDiskSpace

Enable or disable the availability check of at least some free disk space before a database write. 1 = enabled, 0 = disabled.

CreateDirs

Enable or disable the creation of directories when a configured path doesn't exist. This includes DatabaseDir , LogFile and PidFile directories. The LogFile directory will be created only when UseLogging has been set to 1. The PidFile directory will be created only if the daemon is started as a background process. The daemon process will try to create the directory using permissions of the user used to start the process.

DaemonGroup

Specify the group to which the daemon process should switch during startup. The group can either be the name of the group or a numerical group id. Leave empty to disable group switching. This option can only be used when the process is started as root.

DaemonUser

Specify the user to which the daemon process should switch during startup. The user can either be the login of the user or a numerical user id. Leave empty to disable user switching. This option can only be used when the process is started as root.

DailyDays

Data retention duration for the one day resolution entries. The configuration defines for how many past days entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data collection of this resolution.

DatabaseSynchronous

Change the setting of the SQLite "synchronous" flag which controls how much care is taken to ensure disk writes have fully completed when writing data to the database before continuing other actions. Higher values take extra steps to ensure data safety at the cost of slower performance. A value of 0 will result in all handling being left to the filesystem itself. Set to -1 to select the default value according to database mode controlled by DatabaseWriteAheadLogging setting. See SQLite documentation for more details regarding values from 1 to 3. Value range: -1..3

DatabaseWriteAheadLogging

Enable or disable SQLite Write-Ahead Logging mode for the database. See SQLite documentation for more details and note that support for read-only operations isn't available in older SQLite versions. 1 = enabled, 0 = disabled.

HourlyDays

Data retention duration for the one hour resolution entries. The configuration defines for how many past days entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data collection of this resolution.

LogFile

Specify log file path and name to be used if UseLogging is set to 1.

MaxBandwidth

Maximum bandwidth for all interfaces. If the interface specific traffic exceeds the given value then the data is assumed to be invalid and rejected. Set to 0 in order to disable the feature. Value range: 0..50000

MaxBW

Same as MaxBandwidth but can be used for setting individual limits for selected interfaces. The name of the interface is specified directly after the MaxBW keyword without spaces. For example MaxBWeth0 for eth0 and MaxBWppp0 for ppp0. BandwidthDetection is disabled on an interface specific level for each MaxBW configuration. Value range: 0..50000

MonthlyMonths

Data retention duration for the one month resolution entries. The configuration defines for how many past months entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data collection of this resolution.

MonthRotate

Day of month that months are expected to change. Usually set to 1 but can be set to alternative values for example for tracking monthly billed traffic where the billing period doesn't start on the first day. For example, if set to 7, days of February up to and including the 6th will count for January. Changing this option will not cause existing data to be recalculated. Value range: 1..28

MonthRotateAffectsYears

Enable or disable MonthRotate also affecting yearly data. Applicable only when MonthRotate has a value greater than one. 1 = enabled, 0 = disabled.

OfflineSaveInterval

How often in minutes cached interface data is saved to file when all monitored interfaces are offline. Value range: SaveInterval..60

PidFile

Specify pid file path and name to be used. The file is created only if the daemon is started as a background process.

PollInterval

How often in seconds interfaces are checked for status changes. Value range: 2..60

RescanDatabaseOnSave

Automatically discover added interfaces from the database and start monitoring. The rescan is done every SaveInterval or OfflineSaveInterval minutes depending on the current activity state. 1 = enabled, 0 = disabled.

SaveInterval

How often in minutes cached interface data is saved to file. Value range: ( UpdateInterval / 60 )..60

SaveOnStatusChange

Enable or disable the additional saving to file of cached interface data when the availability of an interface changes, i.e., when an interface goes offline or comes online. 1 = enabled, 0 = disabled.

TimeSyncWait

How many minutes to wait during daemon startup for system clock to sync if most recent database update appears to be in the future. This may be needed in systems without a real-time clock (RTC) which require some time after boot to query and set the correct time. 0 = wait disabled. Value range: 0..60

TopDayEntries

Data retention duration for the top day entries. The configuration defines how many of the past top day entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data collection of this resolution.

TrafficlessEntries

Create database entries even when there is no traffic during the entry's time period. 1 = enabled, 0 = disabled.

UpdateFileOwner

Enable or disable the update of file ownership during daemon process startup. During daemon startup, only database, log and pid files will be modified if the user or group change feature ( DaemonUser or DaemonGroup ) is enabled and the files don't match the requested user or group. During manual database creation, this option will cause file ownership to be inherited from the database directory if the directory already exists. This option only has effect when the process is started as root or via sudo.

UpdateInterval

How often in seconds the interface data is updated. Value range: PollInterval..300

UseLogging

Enable or disable logging. This option is ignored when the daemon is started with -n, --nodaemon which results in all log output being shown in terminal the daemon process is using. 0 = disabled, 1 = logfile and 2 = syslog.

UseUTC

Enable or disable using UTC as timezone in the database for all entries. When enabled, all entries added to the database will use UTC regardless of the configured system timezone. When disabled, the configured system timezone will be used. Changing this setting will not result in already existing data to be modified. 1 = enabled, 0 = disabled.

VacuumOnHUPSignal

Enable or disable the execution of SQLite VACUUM command after the daemon has received a HUP signal. When enabled, the database file is rebuilt and repacked into a minimal amount of disk space. The difference in size can be notable especially if data retention durations have been reduced or previously monitored interfaces removed from the database. 1 = enabled, 0 = disabled.

VacuumOnStartup

Enable or disable the execution of SQLite VACUUM command during daemon startup. When enabled, the database file is rebuilt and repacked into a minimal amount of disk space. The difference in size can be notable especially if data retention durations have been reduced or previously monitored interfaces removed from the database. 1 = enabled, 0 = disabled.

YearlyYears

Data retention duration for the one year resolution entries. The configuration defines for how many past years entries will be stored. Set to -1 for unlimited entries or to 0 to disable the data collection of this resolution.

## IMAGE OUTPUT RELATED KEYWORDS
5MinuteGraphResultCount

Number of 5 minute periods to be included in the 5 minute resolution graph. The value affects the width of the graph. Value range: 288..2000

5MinuteGraphHeight

Height of 5 minute resolution graph in pixels. Value range: 150..2000

BarColumnShowsRate

The bar column represents traffic rate in list outputs when enabled. Requires also that OutputStyle has been configured to show the traffic rate column by using the value 3. Enabling this option will automatically cause EstimateStyle to have the value 0. Visually this option affects only the color legend text and the last line on the list if that line represents the currently ongoing time period. 1 = enabled, 0 = disabled.

CBackground

Background color.

CEdge

Edge color, if visible.

CHeader

Header background color.

CHeaderTitle

Header title text color.

CHeaderDate

Header date text color.

CLine

Line color.

CLineL

Lighter version of line color. Set to '-' in order to use a calculated value based on CLine.

CPercentileLine

95th percentile line color. Used only in 95th percentile graph.

CRx

Color for received data.

CRxD

Darker version of received data color. Set to '-' in order to use a calculated value based on CRx.

CText

Common text color.

CTotal

Color for total data, sum of received and transmitted data. Used only in 95th percentile graph.

CTx

Color for transmitted data.

CTxD

Darker version of transmitted data color. Set to '-' in order to use a calculated value based on CTx.

EstimateStyle

Show a visual representation of the traffic estimation. 0 = not shown, 1 = continuation of existing bar, 2 = separate bar.

HeaderFormat

Formatting of date in header. Uses the same format as date(1).

HourlyGraphMode

Select the output mode of the hourly graph. 0 = 24 hour sliding window, 1 = graph begins from midnight.

HourlyRate

Show hours with rate instead of transferred amount. 1 = enabled, 0 = disabled.

ImageScale

Scale output to given percent. Value range: 50..500

LargeFonts

Increase the size of used fonts. 1 = enabled, 0 = disabled.

LineSpacingAdjustment

Adjust line spacing in list format outputs. Positive values increase the space between lines while negative values reduce it. Value range: -5..10

SummaryGraph

Select which graph style output is shown next to the summary data in the horizontal and vertical summary outputs. 0 = hours, 1 = 5 minutes.

SummaryRate

Show rate in summary output if available. 1 = enabled, 0 = disabled.

TransparentBg

Set background color as transparent. 1 = enabled, 0 = disabled.

## FILES
/etc/vnstat.conf

Config file that will be used unless $HOME/.vnstatrc exists or alternative value is given as command line parameter.

## RESTRICTIONS
Using long date output formats may cause misalignment in shown columns if the length of the date exceeds the fixed size allocation.

## AUTHOR
Teemu Toivola <tst at iki dot fi>

## SEE ALSO
vnstat(1), vnstati(1), vnstatd(8), units(7)


vomsdir

package: voms-clients-java

title: vomsdir(5)

text:
# vomsdir(5)

## NAME
vomsdir - The structure of the vomsdir VOMS server trust anchor directory

## SYNOPSIS
/etc/grid-security/vomsdir

## DESCRIPTION
This manual page describes the structure of the vomsdir VOMS server trust anchor directory. The function of this directory is to keep local information about trusted VOMS servers which is used to verify the signatures on the attributes issued by VOMS servers.

The vomsdir directory is structured as follows:

```
<vomsdir>

   |

   |--vo1

   |

   |--vo2

   |

   |--vo3

   |
```

A subdirectory is created for each of the trusted VOs. Inside each VO directory two types of files can be found:

• LSC files An LSC file contains a description of the certificate chain of the certificate used by a VOMS server to sign VOMS attributes.

• X509 certificates The certificate used by a VOMS server to sign attributes.

These files are commonly named using the following pattern:

```
<hostname>.lsc
<hostname>.pem
```

Where hostname is the host where the VOMS server is running.

When both lsc and pem files are present for a given VO and hostname, the lsc file takes precedence.

### LSC file syntax
The LSC file contains a list of X.509 subject strings, one on each line, encoded in OpenSSL slash-separated syntax, describing the certificate chain (up and including the CA that issued the certificate). For instance, the voms.cnaf.infn.it VOMS server has the following LSC file:

```
/C=IT/O=INFN/OU=Host/L=CNAF/CN=voms.cnaf.infn.it
/C=IT/O=INFN/CN=INFN CA
```

## EXAMPLES
Assuming locally two VOs are trusted, the cms VO and the cdf VO, the /etc/grid-security/vomsdir directory will be structured as follows:

```
/etc/grid-security/vomsdir
/etc/grid-security/vomsdir/cms
/etc/grid-security/vomsdir/cdf
```

The /etc/grid-security/vomsdir/cms directory will contain the following files:

```
lcg-voms.cern.ch.lsc
voms.cern.ch.lsc
```

The /etc/grid-security/vomsdir/cdf directory will contain the following files:

```
voms-01.pd.infn.it.lsc
voms.cnaf.infn.it.lsc
voms.fnal.gov.lsc
```

The LSC files will contain descriptions of the certificate chains used by VOMS servers to sign attribute certificates.

## BUGS
To report bugs or ask for support, use GGUS: https://ggus.eu/pages/home.php

## AUTHORS
Andrea Ceccanti <andrea.ceccanti@cnaf.infn.it>

Daniele Andreotti <daniele.andreotti@cnaf.infn.it>

Valerio Venturi <valerio.venturi@cnaf.infn.it>

## SEE ALSO
voms-proxy-destroy(1), voms-proxy-info(1), voms-lsc(5)

## COPYING
Copyright 2012 Istituto Nazionale di Fisica Nucleare

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

```
http://www.apache.org/licenses/LICENSE-2.0
```

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


vomses

title: vomses(5)

summary: The VOMS server contact table

text:
# vomses(5)

## NAME
vomses - The VOMS server contact table

## SYNOPSIS
/etc/vomses

~/.glite/vomses

## DESCRIPTION
This manual page describes the format of vomses files. vomses files contain contact information for VOMS servers and are typically organized in the /etc/vomses directory. A vomses file is a simple text file which contains one or more lines formatted as follows:

"alias" "hostname" "port" "server DN" "vo_name"

Where:

alias: an alias that can be used for this VOMS server (this is typically identical to the vo_name)

hostname: the hostname where the VOMS server is running

vo_name: the name of the VO served by the VOMS server

port: the port where the VOMS server is listening for incoming requests

server DN: the certificate subject of the VOMS server

System wide VOMSES configuration is maintained in the /etc/vomses file or directory. If /etc/vomses is a directory, all the files contained in such directory are parsed looking for VOMS contact information.

A user can define its custom vomses configuration in the ~/.glite/vomses file or directory, which will be parsed in the same way as just described.

## EXAMPLES
The following is an example of valid vomes file for the cms VO:

```
"cms" "lcg-voms.cern.ch" "15002" "/DC=ch/DC=cern/OU=computers/CN=lcg-voms.cern.ch" "cms"
"cms" "voms.cern.ch" "15002" "/DC=ch/DC=cern/OU=computers/CN=voms.cern.ch" "cms"
```

## BUGS
To report bugs or ask for support, use GGUS: https://ggus.eu/pages/home.php

## AUTHORS
Andrea Ceccanti <andrea.ceccanti@cnaf.infn.it>

Daniele Andreotti <daniele.andreotti@cnaf.infn.it>

Valerio Venturi <valerio.venturi@cnaf.infn.it>

## SEE ALSO
voms-proxy-destroy(1), voms-proxy-info(1), vomsdir(5)

## COPYING
Copyright 2012 Istituto Nazionale di Fisica Nucleare

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

```
http://www.apache.org/licenses/LICENSE-2.0
```

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


vsftpd.conf

package: vsftpd

title: vsftpd.conf(5)

summary: config file for vsftpd

text:
# vsftpd.conf(5)

## NAME
vsftpd.conf - config file for vsftpd

## DESCRIPTION
vsftpd.conf may be used to control various aspects of vsftpd's behaviour. By default, vsftpd looks for this file at the location /etc/vsftpd.conf. However, you may override this by specifying a command line argument to vsftpd. The command line argument is the pathname of the configuration file for vsftpd. This behaviour is useful because you may wish to use an advanced inetd such as xinetd to launch vsftpd with different configuration files on a per virtual host basis.

## FORMAT
The format of vsftpd.conf is very simple. Each line is either a comment or a directive. Comment lines start with a # and are ignored. A directive line has the format:

option=value

It is important to note that it is an error to put any space between the option, = and value.

Each setting has a compiled in default which may be modified in the configuration file.

## BOOLEAN OPTIONS
Below is a list of boolean options. The value for a boolean option may be set to YES or NO.

allow_anon_ssl

Only applies if ssl_enable is active. If set to YES, anonymous users will be allowed to use secured SSL connections. Default: NO

anon_mkdir_write_enable

If set to YES, anonymous users will be permitted to create new directories under certain conditions. For this to work, the option write_enable must be activated, and the anonymous ftp user must have write permission on the parent directory. Default: NO

anon_other_write_enable

If set to YES, anonymous users will be permitted to perform write operations other than upload and create directory, such as deletion and renaming. This is generally not recommended but included for completeness. Default: NO

anon_upload_enable

If set to YES, anonymous users will be permitted to upload files under certain conditions. For this to work, the option write_enable must be activated, and the anonymous ftp user must have write permission on desired upload locations. This setting is also required for virtual users to upload; by default, virtual users are treated with anonymous (i.e. maximally restricted) privilege. Default: NO

anon_world_readable_only

When enabled, anonymous users will only be allowed to download files which are world readable. This is recognising that the ftp user may own files, especially in the presence of uploads. Default: YES

anonymous_enable

Controls whether anonymous logins are permitted or not. If enabled, both the usernames ftp and anonymous are recognised as anonymous logins. Default: YES

ascii_download_enable

When enabled, ASCII mode data transfers will be honoured on downloads. Default: NO

ascii_upload_enable

When enabled, ASCII mode data transfers will be honoured on uploads. Default: NO

async_abor_enable

When enabled, a special FTP command known as "async ABOR" will be enabled. Only ill advised FTP clients will use this feature. Additionally, this feature is awkward to handle, so it is disabled by default. Unfortunately, some FTP clients will hang when cancelling a transfer unless this feature is available, so you may wish to enable it. Default: NO

background

When enabled, and vsftpd is started in "listen" mode, vsftpd will background the listener process. i.e. control will immediately be returned to the shell which launched vsftpd. Default: NO

check_shell

Note! This option only has an effect for non-PAM builds of vsftpd. If disabled, vsftpd will not check /etc/shells for a valid user shell for local logins. Default: YES

chmod_enable

When enabled, allows use of the SITE CHMOD command. NOTE! This only applies to local users. Anonymous users never get to use SITE CHMOD. Default: YES

chown_uploads

If enabled, all anonymously uploaded files will have the ownership changed to the user specified in the setting chown_username. This is useful from an administrative, and perhaps security, standpoint. Default: NO

chroot_list_enable

If activated, you may provide a list of local users who are placed in a chroot() jail in their home directory upon login. The meaning is slightly different if chroot_local_user is set to YES. In this case, the list becomes a list of users which are NOT to be placed in a chroot() jail. By default, the file containing this list is /etc/vsftpd/chroot_list, but you may override this with the chroot_list_file setting. Default: NO

chroot_local_user

If set to YES, local users will be (by default) placed in a chroot() jail in their home directory after login. Warning: This option has security implications, especially if the users have upload permission, or shell access. Only enable if you know what you are doing. Note that these security implications are not vsftpd specific. They apply to all FTP daemons which offer to put local users in chroot() jails. Default: NO

connect_from_port_20

This controls whether PORT style data connections use port 20 (ftp-data) on the server machine. For security reasons, some clients may insist that this is the case. Conversely, disabling this option enables vsftpd to run with slightly less privilege. Default: NO (but the sample config file enables it)

debug_ssl

If true, OpenSSL connection diagnostics are dumped to the vsftpd log file. (Added in v2.0.6). Default: NO

delete_failed_uploads

If true, any failed upload files are deleted. (Added in v2.0.7). Default: NO

deny_email_enable

If activated, you may provide a list of anonymous password e-mail responses which cause login to be denied. By default, the file containing this list is /etc/vsftpd/banned_emails, but you may override this with the banned_email_file setting. Default: NO

dirlist_enable

If set to NO, all directory list commands will give permission denied. Default: YES

dirmessage_enable

If enabled, users of the FTP server can be shown messages when they first enter a new directory. By default, a directory is scanned for the file .message, but that may be overridden with the configuration setting message_file. Default: NO (but the sample config file enables it)

download_enable

If set to NO, all download requests will give permission denied. Default: YES

dual_log_enable

If enabled, two log files are generated in parallel, going by default to /var/log/xferlog and /var/log/vsftpd.log. The former is a wu-ftpd style transfer log, parseable by standard tools. The latter is vsftpd's own style log. Default: NO

force_dot_files

If activated, files and directories starting with . will be shown in directory listings even if the "a" flag was not used by the client. This override excludes the "." and ".." entries. Default: NO

force_anon_data_ssl

Only applies if ssl_enable is activated. If activated, all anonymous logins are forced to use a secure SSL connection in order to send and receive data on data connections. Default: NO

force_anon_logins_ssl

Only applies if ssl_enable is activated. If activated, all anonymous logins are forced to use a secure SSL connection in order to send the password. Default: NO

force_local_data_ssl

Only applies if ssl_enable is activated. If activated, all non-anonymous logins are forced to use a secure SSL connection in order to send and receive data on data connections. Default: YES

force_local_logins_ssl

Only applies if ssl_enable is activated. If activated, all non-anonymous logins are forced to use a secure SSL connection in order to send the password. Default: YES

guest_enable

If enabled, all non-anonymous logins are classed as "guest" logins. A guest login is remapped to the user specified in the guest_username setting. Default: NO

hide_ids

If enabled, all user and group information in directory listings will be displayed as "ftp". Default: YES

implicit_ssl

If enabled, an SSL handshake is the first thing expect on all connections (the FTPS protocol). To support explicit SSL and/or plain text too, a separate vsftpd listener process should be run. Default: NO

listen

If enabled, vsftpd will run in standalone mode. This means that vsftpd must not be run from an inetd of some kind. Instead, the vsftpd executable is run once directly. vsftpd itself will then take care of listening for and handling incoming connections. Default: NO

listen_ipv6

Like the listen parameter, except vsftpd will listen on an IPv6 socket instead of an IPv4 one. This parameter and the listen parameter are mutually exclusive. Default: NO

local_enable

Controls whether local logins are permitted or not. If enabled, normal user accounts in /etc/passwd (or wherever your PAM config references) may be used to log in. This must be enable for any non-anonymous login to work, including virtual users. Default: NO

lock_upload_files

When enabled, all uploads proceed with a write lock on the upload file. All downloads proceed with a shared read lock on the download file. WARNING! Before enabling this, be aware that malicious readers could starve a writer wanting to e.g. append a file. Default: YES

log_ftp_protocol

When enabled, all FTP requests and responses are logged, providing the option xferlog_std_format is not enabled. Useful for debugging. Default: NO

ls_recurse_enable

When enabled, this setting will allow the use of "ls -R". This is a minor security risk, because a ls -R at the top level of a large site may consume a lot of resources. Default: NO

mdtm_write

When enabled, this setting will allow MDTM to set file modification times (subject to the usual access checks). Default: YES

no_anon_password

When enabled, this prevents vsftpd from asking for an anonymous password - the anonymous user will log straight in. Default: NO

no_log_lock

When enabled, this prevents vsftpd from taking a file lock when writing to log files. This option should generally not be enabled. It exists to workaround operating system bugs such as the Solaris / Veritas filesystem combination which has been observed to sometimes exhibit hangs trying to lock log files. Default: NO

one_process_model

If you have a Linux 2.4 kernel, it is possible to use a different security model which only uses one process per connection. It is a less pure security model, but gains you performance. You really don't want to enable this unless you know what you are doing, and your site supports huge numbers of simultaneously connected users. Default: NO

passwd_chroot_enable

If enabled, along with chroot_local_user , then a chroot() jail location may be specified on a per-user basis. Each user's jail is derived from their home directory string in /etc/passwd. The occurrence of /./ in the home directory string denotes that the jail is at that particular location in the path. Default: NO

pasv_addr_resolve

Set to YES if you want to use a hostname (as opposed to IP address) in the pasv_address option. Default: NO

pasv_enable

Set to NO if you want to disallow the PASV method of obtaining a data connection. Default: YES

pasv_promiscuous

Set to YES if you want to disable the PASV security check that ensures the data connection originates from the same IP address as the control connection. Only enable if you know what you are doing! The only legitimate use for this is in some form of secure tunnelling scheme, or perhaps to facilitate FXP support. Default: NO

port_enable

Set to NO if you want to disallow the PORT method of obtaining a data connection. Default: YES

port_promiscuous

Set to YES if you want to disable the PORT security check that ensures that outgoing data connections can only connect to the client. Only enable if you know what you are doing! Default: NO

require_cert

If set to yes, all SSL client connections are required to present a client certificate. The degree of validation applied to this certificate is controlled by validate_cert (Added in v2.0.6). Default: NO

require_ssl_reuse

If set to yes, all SSL data connections are required to exhibit SSL session reuse (which proves that they know the same master secret as the control channel). Although this is a secure default, it may break many FTP clients, so you may want to disable it. For a discussion of the consequences, see http://scarybeastsecurity.blogspot.com/2009/02/vsftpd-210-released.html (Added in v2.1.0). Default: YES

run_as_launching_user

Set to YES if you want vsftpd to run as the user which launched vsftpd. This is useful where root access is not available. MASSIVE WARNING! Do NOT enable this option unless you totally know what you are doing, as naive use of this option can create massive security problems. Specifically, vsftpd does not / cannot use chroot technology to restrict file access when this option is set (even if launched by root). A poor substitute could be to use a deny_file setting such as {/*,*..*}, but the reliability of this cannot compare to chroot, and should not be relied on. If using this option, many restrictions on other options apply. For example, options requiring privilege such as non-anonymous logins, upload ownership changing, connecting from port 20 and listen ports less than 1024 are not expected to work. Other options may be impacted. Default: NO

secure_email_list_enable

Set to YES if you want only a specified list of e-mail passwords for anonymous logins to be accepted. This is useful as a low-hassle way of restricting access to low-security content without needing virtual users. When enabled, anonymous logins are prevented unless the password provided is listed in the file specified by the email_password_file setting. The file format is one password per line, no extra whitespace. The default filename is /etc/vsftpd/email_passwords. Default: NO

session_support

This controls whether vsftpd attempts to maintain sessions for logins. If vsftpd is maintaining sessions, it will try and update utmp and wtmp. It will also open a pam_session if using PAM to authenticate, and only close this upon logout. You may wish to disable this if you do not need session logging, and you wish to give vsftpd more opportunity to run with less processes and / or less privilege. NOTE - utmp and wtmp support is only provided with PAM enabled builds. Default: NO

setproctitle_enable

If enabled, vsftpd will try and show session status information in the system process listing. In other words, the reported name of the process will change to reflect what a vsftpd session is doing (idle, downloading etc). You probably want to leave this off for security purposes. Default: NO

ssl_enable

If enabled, and vsftpd was compiled against OpenSSL, vsftpd will support secure connections via SSL. This applies to the control connection (including login) and also data connections. You'll need a client with SSL support too. NOTE!! Beware enabling this option. Only enable it if you need it. vsftpd can make no guarantees about the security of the OpenSSL libraries. By enabling this option, you are declaring that you trust the security of your installed OpenSSL library. Default: NO

ssl_request_cert

If enabled, vsftpd will request (but not necessarily require; see require_cert)acertificateonincomingSSLconnections.Normallythis should not cause any trouble at all, but IBM zOS seems to have issues. (New in v2.0.7). Default: YES

ssl_sslv2

Only applies if ssl_enable is activated. If enabled, this option will permit SSL v2 protocol connections. TLS v1.2+ connections are preferred. Default: NO

ssl_sslv3

Only applies if ssl_enable is activated. If enabled, this option will permit SSL v3 protocol connections. TLS v1.2+ connections are preferred. Default: NO

ssl_tlsv1

Only applies if ssl_enable is activated. If enabled, this option will permit TLS v1.0 protocol connections. TLS v1.2+ connections are preferred. Default: NO

ssl_tlsv1_1

Only applies if ssl_enable is activated. If enabled, this option will permit TLS v1.1 protocol connections. TLS v1.2+ connections are preferred. Default: NO

ssl_tlsv1_2

Only applies if ssl_enable is activated. If enabled, this option will permit TLS v1.2 protocol connections. TLS v1.2+ connections are preferred. Default: YES

ssl_tlsv1_3

Only applies if ssl_enable is activated. If enabled, this option will permit TLS v1.3 protocol connections. TLS v1.2+ connections are preferred. Default: YES

strict_ssl_read_eof

If enabled, SSL data uploads are required to terminate via SSL, not an EOF on the socket. This option is required to be sure that an attacker did not terminate an upload prematurely with a faked TCP FIN. Unfortunately, it is not enabled by default because so few clients get it right. (New in v2.0.7). Default: NO

strict_ssl_write_shutdown

If enabled, SSL data downloads are required to terminate via SSL, not an EOF on the socket. This is off by default as I was unable to find a single FTP client that does this. It is minor. All it affects is our ability to tell whether the client confirmed full receipt of the file. Even without this option, the client is able to check the integrity of the download. (New in v2.0.7). Default: NO

syslog_enable

If enabled, then any log output which would have gone to /var/log/vsftpd.log goes to the system log instead. Logging is done under the FTPD facility. Default: NO

tcp_wrappers

If enabled, and vsftpd was compiled with tcp_wrappers support, incoming connections will be fed through tcp_wrappers access control. Furthermore, there is a mechanism for per-IP based configuration. If tcp_wrappers sets the VSFTPD_LOAD_CONF environment variable, then the vsftpd session will try and load the vsftpd configuration file specified in this variable. Default: NO

text_userdb_names

By default, numeric IDs are shown in the user and group fields of directory listings. You can get textual names by enabling this parameter. It is off by default for performance reasons. Default: NO

tilde_user_enable

If enabled, vsftpd will try and resolve pathnames such as ~chris/pics, i.e. a tilde followed by a username. Note that vsftpd will always resolve the pathnames ~ and ~/something (in this case the ~ resolves to the initial login directory). Note that ~user paths will only resolve if the file /etc/passwd may be found within the _current_ chroot() jail. Default: NO

use_localtime

If enabled, vsftpd will display directory listings with the time in your local time zone. The default is to display GMT. The times returned by the MDTM FTP command are also affected by this option. Default: NO

use_sendfile

An internal setting used for testing the relative benefit of using the sendfile() system call on your platform. Default: YES

userlist_deny

This option is examined if userlist_enable is activated. If you set this setting to NO, then users will be denied login unless they are explicitly listed in the file specified by userlist_file. When login is denied, the denial is issued before the user is asked for a password. Default: YES

userlist_enable

If enabled, vsftpd will load a list of usernames, from the filename given by userlist_file. If a user tries to log in using a name in this file, they will be denied before they are asked for a password. This may be useful in preventing cleartext passwords being transmitted. See also userlist_deny. Default: NO

validate_cert

If set to yes, all SSL client certificates received must validate OK. Self-signed certs do not constitute OK validation. (New in v2.0.6). Default: NO

virtual_use_local_privs

If enabled, virtual users will use the same privileges as local users. By default, virtual users will use the same privileges as anonymous users, which tends to be more restrictive (especially in terms of write access). Default: NO

write_enable

This controls whether any FTP commands which change the filesystem are allowed or not. These commands are: STOR, DELE, RNFR, RNTO, MKD, RMD, APPE and SITE. Default: NO

xferlog_enable

If enabled, a log file will be maintained detailling uploads and downloads. By default, this file will be placed at /var/log/vsftpd.log, but this location may be overridden using the configuration setting vsftpd_log_file. Default: NO (but the sample config file enables it)

xferlog_std_format

If enabled, the transfer log file will be written in standard xferlog format, as used by wu-ftpd. This is useful because you can reuse existing transfer statistics generators. The default format is more readable, however. The default location for this style of log file is /var/log/xferlog, but you may change it with the setting xferlog_file. Default: NO

## NUMERIC OPTIONS
Below is a list of numeric options. A numeric option must be set to a non negative integer. Octal numbers are supported, for convenience of the umask options. To specify an octal number, use 0 as the first digit of the number.

accept_timeout

The timeout, in seconds, for a remote client to establish connection with a PASV style data connection. Default: 60

anon_max_rate

The maximum data transfer rate permitted, in bytes per second, for anonymous clients. Default: 0 (unlimited)

anon_umask

The value that the umask for file creation is set to for anonymous users. NOTE! If you want to specify octal values, remember the "0" prefix otherwise the value will be treated as a base 10 integer! Default: 077

chown_upload_mode

The file mode to force for chown()ed anonymous uploads. (Added in v2.0.6). Default: 0600

connect_timeout

The timeout, in seconds, for a remote client to respond to our PORT style data connection. Default: 60

data_connection_timeout

The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off. Default: 300

delay_failed_login

The number of seconds to pause prior to reporting a failed login. Default: 1

delay_successful_login

The number of seconds to pause prior to allowing a successful login. Default: 0

file_open_mode

The permissions with which uploaded files are created. Umasks are applied on top of this value. You may wish to change to 0777 if you want uploaded files to be executable. Default: 0666

ftp_data_port

The port from which PORT style connections originate (as long as the poorly named connect_from_port_20 is enabled). Default: 20

idle_session_timeout

The timeout, in seconds, which is the maximum time a remote client may spend between FTP commands. If the timeout triggers, the remote client is kicked off. Default: 300

listen_port

If vsftpd is in standalone mode, this is the port it will listen on for incoming FTP connections. Default: 21

local_max_rate

The maximum data transfer rate permitted, in bytes per second, for local authenticated users. Default: 0 (unlimited)

local_umask

The value that the umask for file creation is set to for local users. NOTE! If you want to specify octal values, remember the "0" prefix otherwise the value will be treated as a base 10 integer! Default: 077

max_clients

If vsftpd is in standalone mode, this is the maximum number of clients which may be connected. Any additional clients connecting will get an error message. Default: 0 (unlimited)

max_login_fails

After this many login failures, the session is killed. Default: 3

max_per_ip

If vsftpd is in standalone mode, this is the maximum number of clients which may be connected from the same source internet address. A client will get an error message if they go over this limit. Default: 0 (unlimited)

pasv_max_port

The maximum port to allocate for PASV style data connections. Can be used to specify a narrow port range to assist firewalling. Default: 65535

pasv_min_port

The minimum port to allocate for PASV style data connections. Can be used to specify a narrow port range to assist firewalling. Default: 49152

trans_chunk_size

You probably don't want to change this, but try setting it to something like 8192 for a much smoother bandwidth limiter. Default: 0 (let vsftpd pick a sensible setting)

## STRING OPTIONS
Below is a list of string options.

anon_root

This option represents a directory which vsftpd will try to change into after an anonymous login. Failure is silently ignored. Default: (none)

banned_email_file

This option is the name of a file containing a list of anonymous e-mail passwords which are not permitted. This file is consulted if the option deny_email_enable is enabled. Default: /etc/vsftpd/banned_emails

banner_file

This option is the name of a file containing text to display when someone connects to the server. If set, it overrides the banner string provided by the ftpd_banner option. Default: (none)

ca_certs_file

This option is the name of a file to load Certificate Authority certs from, for the purpose of validating client certs. The loaded certs are also advertised to the client, to cater for TLSv1.0 clients such as the z/OS FTP client. Regrettably, the default SSL CA cert paths are not used, because of vsftpd's use of restricted filesystem spaces (chroot). (Added in v2.0.6). Default: (none)

chown_username

This is the name of the user who is given ownership of anonymously uploaded files. This option is only relevant if another option, chown_uploads, is set. Default: root

chroot_list_file

The option is the name of a file containing a list of local users which will be placed in a chroot() jail in their home directory. This option is only relevant if the option chroot_list_enable is enabled. If the option chroot_local_user is enabled, then the list file becomes a list of users to NOT place in a chroot() jail. Default: /etc/vsftpd/chroot_list

cmds_allowed

This options specifies a comma separated list of allowed FTP commands (post login. USER, PASS and QUIT and others are always allowed pre-login). Other commands are rejected. This is a powerful method of really locking down an FTP server. Example: cmds_allowed=PASV,RETR,QUIT Default: (none)

cmds_denied

This options specifies a comma separated list of denied FTP commands (post login. USER, PASS, QUIT and others are always allowed pre-login). If a command appears on both this and cmds_allowed then the denial takes precedence. (Added in v2.1.0). Default: (none)

deny_file

This option can be used to set a pattern for filenames (and directory names etc.) which should not be accessible in any way. The affected items are not hidden, but any attempt to do anything to them (download, change into directory, affect something within directory etc.) will be denied. This option is very simple, and should not be used for serious access control - the filesystem's permissions should be used in preference. However, this option may be useful in certain virtual user setups. In particular aware that if a filename is accessible by a variety of names (perhaps due to symbolic links or hard links), then care must be taken to deny access to all the names. Access will be denied to items if their name contains the string given by hide_file, or if they match the regular expression specified by hide_file. Note that vsftpd's regular expression matching code is a simple implementation which is a subset of full regular expression functionality. Because of this, you will need to carefully and exhaustively test any application of this option. And you are recommended to use filesystem permissions for any important security policies due to their greater reliability. Supported regex syntax is any number of *, ? and unnested {,} operators. Regex matching is only supported on the last component of a path, e.g. a/b/? is supported but a/?/c is not. Example: deny_file={*.mp3,*.mov,.private} Default: (none)

dsa_cert_file

This option specifies the location of the DSA certificate to use for SSL encrypted connections. Default: (none - an RSA certificate suffices)

dsa_private_key_file

This option specifies the location of the DSA private key to use for SSL encrypted connections. If this option is not set, the private key is expected to be in the same file as the certificate. Default: (none)

email_password_file

This option can be used to provide an alternate file for usage by the secure_email_list_enable setting. Default: /etc/vsftpd/email_passwords

ftp_username

This is the name of the user we use for handling anonymous FTP. The home directory of this user is the root of the anonymous FTP area. Default: vsftpd

ftpd_banner

This string option allows you to override the greeting banner displayed by vsftpd when a connection first comes in. Default: (none - default vsftpd banner is displayed)

guest_username

See the boolean setting guest_enable for a description of what constitutes a guest login. This setting is the real username which guest users are mapped to. Default: vsftpd

hide_file

This option can be used to set a pattern for filenames (and directory names etc.) which should be hidden from directory listings. Despite being hidden, the files / directories etc. are fully accessible to clients who know what names to actually use. Items will be hidden if their names contain the string given by hide_file, or if they match the regular expression specified by hide_file. Note that vsftpd's regular expression matching code is a simple implementation which is a subset of full regular expression functionality. See deny_file for details of exactly what regex syntax is supported. Example: hide_file={*.mp3,.hidden,hide*,h?} Default: (none)

listen_address

If vsftpd is in standalone mode, the default listen address (of all local interfaces) may be overridden by this setting. Provide a numeric IP address. Default: (none)

listen_address6

Like listen_address, but specifies a default listen address for the IPv6 listener (which is used if listen_ipv6 is set). Format is standard IPv6 address format. Default: (none)

local_root

This option represents a directory which vsftpd will try to change into after a local (i.e. non-anonymous) login. Failure is silently ignored. Default: (none)

message_file

This option is the name of the file we look for when a new directory is entered. The contents are displayed to the remote user. This option is only relevant if the option dirmessage_enable is enabled. Default: .message

nopriv_user

This is the name of the user that is used by vsftpd when it wants to be totally unprivileged. Note that this should be a dedicated user, rather than nobody. The user nobody tends to be used for rather a lot of important things on most machines. Default: novsftpd

pam_service_name

This string is the name of the PAM service vsftpd will use. Default: vsftpd

pasv_address

Use this option to override the IP address that vsftpd will advertise in response to the PASV command. Provide a numeric IP address, unless pasv_addr_resolve is enabled, in which case you can provide a hostname which will be DNS resolved for you at startup. Default: (none - the address is taken from the incoming connected socket)

rsa_cert_file

This option specifies the location of the RSA certificate to use for SSL encrypted connections. Default: /var/lib/ssl/certs/vsftpd.pem

rsa_private_key_file

This option specifies the location of the RSA private key to use for SSL encrypted connections. If this option is not set, the private key is expected to be in the same file as the certificate. Default: (none)

secure_chroot_dir

This option should be the name of a directory which is empty. Also, the directory should not be writable by the ftp user. This directory is used as a secure chroot() jail at times vsftpd does not require filesystem access. Default: /var/empty

ssl_ciphers

This option can be used to select which SSL ciphers vsftpd will allow for encrypted SSL connections. See the ciphers man page for further details. Note that restricting ciphers can be a useful security precaution as it prevents malicious remote parties forcing a cipher which they have found problems with. Default: DES-CBC3-SHA

ssl_sni_hostname

If set, SSL connections will be rejected unless the SNI hostname in the incoming handshakes matches this value. Default: (none)

user_config_dir

This powerful option allows the override of any config option specified in the manual page, on a per-user basis. Usage is simple, and is best illustrated with an example. If you set user_config_dir to be /etc/vsftpd/user_conf and then log on as the user "chris", then vsftpd will apply the settings in the file /etc/vsftpd/user_conf/chris for the duration of the session. The format of this file is as detailed in this manual page! PLEASE NOTE that not all settings are effective on a per-user basis. For example, many settings only prior to the user's session being started. Examples of settings which will not affect any behviour on a per-user basis include listen_address, banner_file, max_per_ip, max_clients, xferlog_file, etc. Default: (none)

user_sub_token

This option is useful is conjunction with virtual users. It is used to automatically generate a home directory for each virtual user, based on a template. For example, if the home directory of the real user specified via guest_username is /home/virtual/$USER, and user_sub_token is set to $USER, then when virtual user fred logs in, he will end up (usually chroot()'ed) in the directory /home/virtual/fred. This option also takes affect if local_root contains user_sub_token. Default: (none)

userlist_file

This option is the name of the file loaded when the userlist_enable option is active. Default: /etc/vsftpd/user_list

vsftpd_log_file

This option is the name of the file to which we write the vsftpd style log file. This log is only written if the option xferlog_enable is set, and xferlog_std_format is NOT set. Alternatively, it is written if you have set the option dual_log_enable. One further complication - if you have set syslog_enable, then this file is not written and output is sent to the system log instead. Default: /var/log/vsftpd.log

xferlog_file

This option is the name of the file to which we write the wu-ftpd style transfer log. The transfer log is only written if the option xferlog_enable is set, along with xferlog_std_format. Alternatively, it is written if you have set the option dual_log_enable. Default: /var/log/xferlog

## AUTHOR
scarybeasts@gmail.com


watchdog.conf

package: watchdog

title: watchdog.conf(5)

text:
# watchdog.conf(5)

## NAME
watchdog.conf - configuration file for the watchdog daemon

## DESCRIPTION
This file carries all configuration options for the Linux watchdog daemon. Each option has to be written on a line for itself. Comments start with '#'. Blanks are ignored except after the '=' sign. An empty text after the '=' sign disables the feature as long as that makes sense.

## OPTIONS
interval = <interval>

Set the highest possible interval between two writes to the watchdog device. The device is triggered after each check regardless of the time it took. After finishing all checks watchdog goes to sleep for a full cycle of <interval> seconds. Default value is 1 second. The kernel drivers typically expects a write command every minute otherwise the system will be rebooted. Therefore an interval of more than a minute can only be used with the force command-line option [--force | -f].

logtick = <logtick>

If you enable verbose logging, a message is written into the syslog or a logfile. While this is nice, it is not necessary to get a message every interval which really fills up disk and needs CPU. logtick allows adjustment of the number of intervals skipped before a log message is written. If you use logtick = 60 and interval = 10, only every 10 minutes (600 seconds) a message is written. This may make the exact time of a crash harder to find but greatly reduces disk usage and administrator nerves if you're looking for a particular syslog entry in between of watchdog messages.

max-load-1 = <load1>

Set the maximal allowed load average for a 1 minute span. Once this load average is reached the system is rebooted. Default value is 0. That means the load average check is disabled. Be careful not to set this parameter too low. To set a value less then the predefined minimal value of 2, you have to use the -f command line option.

max-load-5 = <load5>

Set the maximal allowed load average for a 5 minute span. Once this load average is reached the system is rebooted. Default value is 3/4*max-load-1. Be careful not to this parameter too low. To set a value less then the predefined minimal value of 2, you have to use the -f command line option.

max-load-15 = <load15>

Set the maximal allowed load average for a 15 minute span. Once this load average is reached the system is rebooted. Default value is 1/2*max-load-1. Be careful not to this parameter too low. To set a value less then the predefined minimal value of 2, you have to use the -f command line option.

min-memory = <minpage>

Set the minimal amount of memory that has to stay free. Note that this is in memory pages (4kB on x86). Default value is 0 pages which means this test is disabled. The page size is taken from the system include files. The usable memory is computed from MemFree + Buffers + Cached since buffer and cache use typically expand to use most free memory but the kernel will reclaim this as needed. NOTE: If this measure gets below a few tens of MB then the system will page swap aggressively have poorer file system performance due to the lack of caching. This is a 'passive' test and works by reading /proc/meminfo

allocatable-memory = <minpage>

Set the minimum amount of allocatable memory available on the system. Note that this is in pages. Default value is 0 pages which means the test is disabled. As with min-memory, the page size is taken from the system include files. This is an 'active' test and it works by attempting to memory-map a block of the configured size.

max-swap = <maxpage>

Set the maximum amount of swap use. Note that this is in memory pages (4kB on x86). Default value is 0 pages which means this test is disabled. Often this should be a large portion of available swap, but remember that paging 1GB of swap can take several/tens of seconds. This is a 'passive' test and works by reading /proc/meminfo

watchdog-device = <device>

Set the watchdog device name, typically /dev/watchdog. Default is to disable keep alive support. This should be tested by running the daemon from the command line before configuring it to start automatically on booting.

watchdog-refresh-use-settimeout = <auto|yes|no>

Refresh watchdog timer by setting its timeout instead of using a normal watchdog refresh operation. Might help if your watchdog trips by itself when the first timeout interval elapses. Default is 'auto' for IT87 fix-up but this can be disabled with 'no' or forced for other modules with 'yes'.

watchdog-refresh-ignore-errors = <yes|no>

Ignore errors reported by writing to the watchdog device. Typically this is used for systems that have broken implementations of the IPMI driver to avoid a reboot loop.

watchdog-timeout = <timeout>

Set the watchdog device timeout during startup. If not set, a default is used that should be set to the kernel timer margin at compile time.

temperature-sensor = <temp-virtual-file>

Set the temperature sensor name. This is normally a 'virtual file' under /sys and it contains the temperature in milli-Celsius. Usually these are generated by the sensors package, but take care as device enumeration may not be fixed. Default is to disable temperature checking. Multiple sensors can be used by having repeated temperature-sensor entries. Due to the enumeration problem any missing temp sensor is simply ignored and not treated as a reboot trigger.

max-temperature = <temp>

Set the maximal allowed temperature in Celsius. Once this temperature is reached the system is stopped. Default value is 90 C. Watchdog will issue warnings once the temperature increases 90%, 95% and 98% of this temperature.

temp-power-off = <yes|no>

Set the watchdog action on overheating. Yes option (default) is to power the machine off, no option is to halt machine and allow Ctrl-Alt-Del reboot.

file = <filename>

Set file name for file mode. This option can be given as often as you like to check several files.

change = <mtime>

Set the change interval time for file mode. This options always belongs to the active filename, that is when finding a 'change =' line watchdog assumes it belongs to the most recently read 'file =' line. They don't necessarily have to follow each other directly. But you cannot specify a 'change =' before a 'file ='. The default is to only stat the file and don't look for changes. Using this feature to monitor changes in /var/log/messages might require some special syslog daemon configuration, e.g. rsyslog needs "$ActionWriteAllMarkMessages on" to be set to make sure the marks are written no matter what.

pidfile = <pidfilename>

Set pidfile name for daemon test mode. This option can be given as often as you like to check several daemons, assuming they write their post-forking PID to the specified files.

ping = <ip-addr>

Set IPv4 address for ping mode. This option can be used more than once to check different connections.

ping-count = <ping-per-interval>

Set the number of ping attempts in each 'interval' of time. Default is 3 and it completes on the first successful ping.

interface = <if-name>

Set interface name for network mode. This option can be used more than once to check different interfaces. Note it is only possible to check physical interfaces, and not aliased IP interfaces.

test-binary = <testbin>

Execute the given binary to do some user defined tests.

test-timeout = <timeout in seconds>

User defined tests may only run for <timeout> seconds. Set to 0 for unlimited.

repair-binary = <repbin>

Execute the given binary in case of a problem instead of shutting down the system.

repair-timeout = <timeout in seconds>

repair command may only run for <timeout> seconds. Set to 0 for 'unlimited', but note that the hardware timer is not refreshed in this case so the system will hard-reset at some point.

retry-timeout = <timeout in seconds>

Allow most error conditions to persist for <timeout> seconds. Set to 0 for immediate action (like softboot behaviour).

repair-maximum = <count>

This allows no more then <count> repair attempts against a given fault that report success (i.e. return 0), but fail to clear the fault, before a reboot is initiated anyway. If set to zero then a repairable fault can always be blocked by a repair program reporting success (previous daemon behaviour).

softboot-option = <yes|no>

This acts like the -b / --softboot command line and simply sets the retry timeout to zero.

admin = <mail-address>

Email address to send admin mail to. That is, who shall be notified that the machine is being halted or rebooted. Default is 'root'. If you want to disable notification via email just set admin to en empty string.

realtime = <yes|no>

If set to yes watchdog will lock itself into memory so it is never swapped out.

priority = <schedule priority>

Set the schedule priority for realtime mode passed to sched_setscheduler().

test-directory = <test directory>

Set the directory to run user test/repair scripts. Default is '/etc/watchdog.d' See the Test Directory section in watchdog(8) for more information.

log-dir = <log directory>

Set the log directory to capture the standard output and standard error from repair-binary and test-binary execution. Default is '/var/log/watchdog'.

sigterm-delay = <time in seconds>

Set the time on shut down between first sending SIGTERM to all processes, and then sending SIGKILL. Default is 5 seconds which is generally enough, but systems with large databases or virtual machines might need longer.

verbose = <level>

This overrides the command line --verbose option. Generally the verbose mode is only enabled for debugging as it creates a lot of syslog chatter, so use this option with consideration. Zero is "normal" operation (quiet), while 1 is typically used for debugging. Values of 2 or more usually generate far too many messages.

heartbeat-file = <filename>

For debugging this allows a rolling set of status values to be kept on disk

heartbeat-stamps = <interval>

For debugging this sets the number of entries in the <heartbeat-file>

log-killed-pids = <yes|no>

This acts like enabling 'verbose' logging, but only for a system reboot, where it enables the logging of the PID values for all processes that are being killed. The results are written to the killall5.log file in the log directory (if at all possible) in this case. Intended for debugging cases where you would like to know what was running at the point the machine triggered the watchdog, but don't want syslog filling up with the usual chatter of activity.

## FILES
/etc/watchdog.conf

The watchdog configuration file

/etc/watchdog.d

A directory containing test-or-repair commands. See the Test Directory section in watchdog(8) for more information.

## SEE ALSO
watchdog(8)


waybar

package: waybar

title: waybar(5)

text:
# waybar(5)

## NAME
waybar - configuration file

## DESCRIPTION
The configuration uses the JSONC file format and is named config or config.jsonc.

Valid locations for this file are:

•$XDG_CONFIG_HOME/waybar/

•~/.config/waybar/

•~/waybar/

•/etc/xdg/waybar/

•/etc/xdg/waybar/

A good starting point is the default configuration found at https://github.com/Alexays/Waybar/blob/master/resources/config.jsonc Also, a minimal example configuration can be found at the bottom of this man page.

The visual display elements for waybar use a CSS stylesheet, see waybar-styles(5) for details.

## BAR CONFIGURATION
layer

typeof: string

default: bottom

Decide if the bar is displayed in front (top) of the windows or behind (bottom)

them.

output

typeof: string|array

Specifies on which screen this bar will be displayed. Exclamation mark(!) can be used to exclude specific output.

Output specification follows sway's and can either be the output port such as "HDMI-A-1" or a string consisting of the make, model, and serial such as "Some Company ABC123 0x00000000". See sway-output(5) for details. In an array, star '*' can be used at the end to accept all outputs, in case all previous entries are exclusions.

position

typeof: string

default: top

Bar position, can be top, bottom, left, right.

height

typeof: integer

Height to be used by the bar if possible. Leave blank for a dynamic value.

width

typeof: integer

Width to be used by the bar if possible. Leave blank for a dynamic value.

modules-left

typeof: array

Modules that will be displayed on the left.

modules-center

typeof: array

Modules that will be displayed in the center.

modules-right

typeof: array

Modules that will be displayed on the right.

margin

typeof: string

Margins value using the CSS format without units.

margin-<top|left|bottom|right>

typeof: integer

Margins value without units.

spacing

typeof: integer

Size of gaps in between the different modules.

name

typeof: string

Optional name added as a CSS class, for styling multiple waybars.

mode

typeof: string

Selects one of the preconfigured display modes. This is an equivalent of the sway-bar(5) mode command and supports the same values: dock, hide, invisible, overlay.

Note: hide and invisible modes may be not as useful without Sway IPC.

start_hidden

typeof: bool

default: false

Option to start the bar hidden.

modifier-reset

typeof: string

default: press

Defines the timing of modifier key to reset the bar visibility. To reset the visibility of the bar with the press of the modifier key use press. Use release to reset the visibility upon the release of the modifier key and only if no other action happened while the key was pressed. This prevents hiding the bar when the modifier is used to switch a workspace, change binding mode, or start a keybinding.

exclusive

typeof: bool

default: true

Option to request an exclusive zone from the compositor. Disable this to allow drawing application windows underneath or on top of the bar.

fixed-center

typeof: bool

default: true

Prefer fixed center position for the `modules-center` block. The center block will stay in the middle of the bar whenever possible. It can still be pushed around if other blocks need more space. When false, the center block is centered in the space between the left and right block.

passthrough

typeof: bool

default: false

Option to pass any pointer events to the window under the bar.

Intended to be used with either top or overlay layers and without exclusive zone.

ipc

typeof: bool

default: false

Option to subscribe to the Sway IPC bar configuration and visibility events and control waybar with swaymsg bar commands.

Requires bar_id value from sway configuration to be either passed with the -b command line argument or specified with the id option.

id

typeof: string

bar_id for the Sway IPC. Use this if you need to override the value passed with the -b bar_id command line argument for the specific bar instance.

include

typeof: string|array

Paths to additional configuration files.

Each file can contain a single object with any of the bar configuration options. In case of duplicate options, the first defined value takes precedence, i.e. including file -> first included file -> etc. Nested includes are permitted, but make sure to avoid circular imports. For a multi-bar config, the include directive affects only current bar configuration object.

reload_style_on_change

typeof: bool

default: false

Option to enable reloading the css style if a modification is detected on the style sheet file or any imported css files.

## MODULE FORMAT
You can use PangoMarkupFormat (See https://developer.gnome.org/pango/stable/PangoMarkupFormat.html#PangoMarkupFormat).

e.g.

```
"format": "<span style="italic">{}</span>"
```

## MULTIPLE INSTANCES OF A MODULE
If you want to have a second instance of a module, you can suffix it by a '#' and a custom name. For example, if you want a second battery module, you can add "battery#bat2" to your modules. To configure the newly added module, you then also add a module configuration with the same name.

This could then look something like this (this is an incomplete example):

```
"modules-right": ["battery", "battery#bat2"],
"battery": {
	"bat": "BAT1"
},
"battery#bat2": {
	"bat": "BAT2"
}
```

## MINIMAL CONFIGURATION
A minimal config file could look like this:

```
{
	"layer": "top",
	"modules-left": ["sway/workspaces", "sway/mode"],
	"modules-center": ["sway/window"],
	"modules-right": ["battery", "clock"],
	"sway/window": {
		"max-length": 50
	},
	"battery": {
		"format": "{capacity}% {icon}",
		"format-icons": ["", "", "", "", ""]
	},
	"clock": {
		"format-alt": "{:%a, %d. %b  %H:%M}"
	}
}
```

## MULTI OUTPUT CONFIGURATION

### Limit a configuration to some outputs

```
{
	"layer": "top",
	"output": "eDP-1",
	"modules-left": ["sway/workspaces", "sway/mode"],
	...
}
```

```
{
	"layer": "top",
	"output": ["eDP-1", "VGA"],
	"modules-left": ["sway/workspaces", "sway/mode"],
	...
}
```

### Configuration of multiple outputs
Don't specify an output to create multiple bars on the same screen.

```
[{
	"layer": "top",
	"output": "eDP-1",
	"modules-left": ["sway/workspaces", "sway/mode"],
	...
}, {
	"layer": "top",
	"output": "VGA",
	"modules-right": ["clock"],
	...
}]
```

### Rotating modules
When positioning Waybar on the left or right side of the screen, sometimes it's useful to be able to rotate the contents of a module so the text runs vertically. This can be done using the "rotate" property of the module. Example:

```
{
	"clock": {
		"rotate": 90
	}
}
```

Valid options for the "rotate" property are: 0, 90, 180, and 270.

### Grouping modules
Module groups allow stacking modules in any direction. By default, when the bar is positioned on the top or bottom of the screen, modules in a group are stacked vertically. Likewise, when positioned on the left or right, modules in a group are stacked horizontally. This can be changed with the "orientation" property.

A module group is defined by specifying a module named "group/some-group-name". The group must also be configured with a list of contained modules. Example:

```
{
	"modules-right": ["group/hardware", "clock"],
	"group/hardware": {
		"orientation": "vertical",
		"modules": [
			"cpu",
			"memory",
			"battery"
		]
	},
	...
}
```

Valid options for the (optional) "orientation" property are: "horizontal", "vertical", "inherit", and "orthogonal" (default).

### Group Drawers
A group may hide all but one element, showing them only on mouse hover. In order to configure this, you can use the `drawer` property, whose value is an object with the following properties:

transition-duration:

typeof: integer

default: 500

Defines the duration of the transition animation in milliseconds.

children-class:

typeof: string

default: "hidden"

Defines the CSS class to be applied to the hidden elements.

transition-left-to-right:

typeof: bool

default: true

Defines the direction of the transition animation. If true, the hidden elements will slide from left to right. If false, they will slide from right to left.

When the bar is vertical, it reads as top-to-bottom.

```
"group/power": {

    "orientation": "inherit",

    "drawer": {

        "transition-duration": 500,

        "children-class": "not-power",

        "transition-left-to-right": false,

    },

    "modules": [

        "custom/power", // First element is the "group leader" and won't ever be hidden

        "custom/quit",

        "custom/lock",

        "custom/reboot",

    ]
},
```

## SUPPORTED MODULES
•waybar-backlight(5)

•waybar-battery(5)

•waybar-bluetooth(5)

•waybar-cava(5)

•waybar-clock(5)

•waybar-cpu(5)

•waybar-custom(5)

•waybar-disk(5)

•waybar-dwl-tags(5)

•waybar-dwl-window(5)

•waybar-gamemode(5)

•waybar-hyprland-language(5)

•waybar-hyprland-submap(5)

•waybar-hyprland-window(5)

•waybar-hyprland-workspaces(5)

•waybar-idle-inhibitor(5)

•waybar-image(5)

•waybar-inhibitor(5)

•waybar-jack(5)

•waybar-keyboard-state(5)

•waybar-memory(5)

•waybar-mpd(5)

•waybar-mpris(5)

•waybar-network(5)

•waybar-pulseaudio(5)

•waybar-river-layout(5)

•waybar-river-mode(5)

•waybar-river-tags(5)

•waybar-river-window(5)

•waybar-sndio(5)

•waybar-states(5)

•waybar-sway-language(5)

•waybar-sway-mode(5)

•waybar-sway-scratchpad(5)

•waybar-sway-window(5)

•waybar-sway-workspaces(5)

•waybar-temperature(5)

•waybar-tray(5)

•waybar-upower(5)

•waybar-wireplumber(5)

•waybar-wlr-taskbar(5)

•waybar-wlr-workspaces(5)

## SEE ALSO
sway-output(5) waybar-styles(5)"


waybar-backlight

title: waybar-backlight(5)

text:
# waybar-backlight(5)

## NAME
waybar - backlight module

## DESCRIPTION
The backlight module displays the current backlight level.

## CONFIGURATION
interval:

typeof: integer

default: 2

The interval in which information gets polled.

format:

typeof: string

default: {percent}%

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

max-length:

typeof: integer

The maximum length in characters the module should display.

min-length:

typeof: integer

The minimum length in characters the module should accept.

align:

typeof: float

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

justify:

typeof: string

The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.

rotate:

typeof: integer

Positive value to rotate the text label.

states:

typeof: object

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

on-click:

typeof: string

Command to execute when the module is clicked.

on-click-middle:

typeof: string

Command to execute when middle-clicked on the module using mouse scroll wheel.

on-click-right:

typeof: string

Command to execute when the module is right-clicked.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when performing a scroll up on the module. This replaces the default behaviour of brightness control.

on-scroll-down:

typeof: string

Command to execute when performing a scroll down on the module. This replaces the default behaviour of brightness control.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

reverse-scrolling:

typeof: bool

Option to reverse the scroll direction.

scroll-step:

typeof: float

default: 1.0

The speed at which to change the brightness when scrolling.

## EXAMPLE:

```
"backlight": {
	"device": "intel_backlight",
	"format": "{percent}% {icon}",
	"format-icons": ["", ""]
}
```

## STYLE
•#backlight


waybar-backlight-slider

title: waybar-backlight-slider(5)

text:
# waybar-backlight-slider(5)

## NAME
waybar - backlight slider module

## DESCRIPTION
The backlight slider module displays and controls the current brightness of the default or preferred device.

The brightness can be controlled by dragging the slider across the bar or clicking on a specific position.

## CONFIGURATION
min:

typeof: int

default: 0

The minimum volume value the slider should display and set.

max:

typeof: int

default: 100

The maximum volume value the slider should display and set.

orientation:

typeof: string

default: horizontal

The orientation of the slider. Can be either `horizontal` or `vertical`.

device:

typeof: string

The name of the preferred device to control. If left empty, a device will be chosen automatically.

## EXAMPLES

```
"modules-right": [

    "backlight-slider",
],
"backlight/slider": {

    "min": 0,

    "max": 100,

    "orientation": "horizontal",

    "device": "intel_backlight"
}
```

## STYLE
The slider is a component with multiple CSS Nodes, of which the following are exposed:

\#backlight-slider:

Controls the style of the box around the slider and bar.

\#backlight-slider slider:

Controls the style of the slider handle.

\#backlight-slider trough:

Controls the style of the part of the bar that has not been filled.

\#backlight-slider highlight:

Controls the style of the part of the bar that has been filled.

### STYLE EXAMPLE

```
#backlight-slider slider {

    min-height: 0px;

    min-width: 0px;

    opacity: 0;

    background-image: none;

    border: none;

    box-shadow: none;
}
#backlight-slider trough {

    min-height: 80px;

    min-width: 10px;

    border-radius: 5px;

    background-color: black;
}
#backlight-slider highlight {

    min-width: 10px;

    border-radius: 5px;

    background-color: red;
}
```


waybar-battery

title: waybar-battery(5)

text:
# waybar-battery(5)

## NAME
waybar - battery module

## DESCRIPTION
The battery module displays the current capacity and state (eg. charging) of your battery.

## CONFIGURATION
bat:

typeof: string

The battery to monitor, as in /sys/class/power_supply/ instead of auto detect.

adapter:

typeof: string

The adapter to monitor, as in /sys/class/power_supply/ instead of auto detect.

full-at:

typeof: integer

Define the max percentage of the battery, for when you've set the battery to stop charging at a lower level to save it. For example, if you've set the battery to stop at 80% that will become the new 100%.

design-capacity:

typeof: bool

default: false

Option to use the battery design capacity instead of its current maximal capacity.

interval:

typeof: integer

default: 60

The interval in which the information gets polled.

states:

typeof: object

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

format:

typeof: string

default: {capacity}%

The format, how information should be displayed.

format-time:

typeof: string

default: {H} h {M} min

The format, how the time should be displayed.

format-icons:

typeof: array/object

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

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

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should accept.

align:

typeof: float

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

justify:

typeof: string

The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.

rotate:

typeof: integer

Positive value to rotate the text label.

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right-click on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

bat-compatibility:

typeof: bool

default: false

Option to enable battery compatibility if not detected.

## FORMAT REPLACEMENTS
{capacity}: Capacity in percentage

{power}: Power in watts

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

{time}: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average.

{cycles}: Amount of charge cycles the highest-capacity battery has seen. (Linux only)

{health}: The percentage of the highest-capacity battery's original maximum charge it can still hold.

## TIME FORMAT
The battery module allows you to define how time should be formatted via format-time.

The three arguments are: {H}: Hours {M}: Minutes {m}: Zero-padded minutes

## CUSTOM FORMATS
The battery module allows one to define custom formats based on up to two factors. The best-fitting format will be selected.

format-<state>: With states, a custom format can be set depending on the capacity of your battery.

format-<status>: With the status, a custom format can be set depending on the status in /sys/class/power_supply/<bat>/status (in lowercase).

format-<status>-<state>: You can also set a custom format depending on both values.

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

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

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

## EXAMPLES

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

## STYLE
•#battery

•#battery.<status>

•<status> is the value of /sys/class/power_supply/<bat>/status in lowercase.

•#battery.<state>

•<state> can be defined in the config. For more information see states.

•#battery.<status>.<state>

•Combination of both <status> and <state>.

The following classes are applied to the entire Waybar rather than just the battery widget:

•window#waybar.battery-<state>

•<state> can be defined in the config, as previously mentioned.