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


package: vzctl

title: networks_classes(5)

summary: OpenVZ network classes configuration

text:
# networks_classes(5)

## NAME
networks_classes - OpenVZ network classes configuration

## SYNOPSIS
/etc/vz/conf/networks_classes

## DESCRIPTION
This file describes pools of IP addresses used for OpenVZ traffic shaping and accounting. File consist of records; each record resides on a separate line and contains a pair of values Class Network, separated by space. Here Class is number in the range 0 - MAX_CLASSES (which is defined in /etc/vz/conf/vz-functions), and Network is network block in CIDR notation (e.g. A.B.C.D/M, where M is the number of binary 1-s in network mask). If nested networks exists with different class numbers, "wider" networks must be mentioned first.

Class number 0 is reserved for network addresses used by CT themselves. OpenVZ traffic accounting won't work unless you specify at least this class.

## EXAMPLES
\# Example of networks_classes file.

\# host server CT's networks

0 10.10.10.0/24

0 10.10.15.0/24

\# all IP ("local" traffic)

1 0.0.0.0/0

\# class 2 - "foreign" traffic

2 10.0.0.0/8

2 11.0.0.0/8

\# inside "foreign" network there

\# is a hole with "local" traffic

1 10.10.16.0/24

## SEE ALSO
vzctl(8), vz-net_add(5).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


ve.conf

title: ve.conf(5)

summary: configuration file for a Container.

text:
# ve.conf(5)

## NAME
ve.conf - configuration file for a Container.

## SYNOPSIS
/etc/vz/conf/XXX.conf

## DESCRIPTION
This is a configuration file for a CT. It is stored as /etc/vz/conf/XXX.conf, where XXX is the ID of the given CT.

Configuration file consists of lines arrayed in a column.

PARAMETER="value"

All parameter names and values are case-sensitive. Quotes surrounding a value are required if the value contains spaces, and are optional otherwise. Extra spaces are not allowed. All unrecognized lines will be ignored.

Please note that the file is created/modified by the vzctl(8) command with the set --save arguments, therefore changes to this file made otherwise than by vzctl(8) can be lost during the next vzctl run.

The meaning of each parameter is described in vzctl(8), so here only the appropriate vzctl set option is given.

### Miscellaneous parameters
ONBOOT="yes|no"

Specifies whether this CT will be started during the system boot. The default value is no, meaning the CT will not be started if the ONBOOT parameter is omitted. Corresponds to the --onboot option.

BOOTORDER="number"

Specifies the CT boot order priority. Corresponds to the --bootorder option.

OSTEMPLATE="tmpl_name"

Corresponds to the --ostemplate option.

TEMPLATES="app_name ..."

This is a list of the templates installed inside a CT by the vzpkg command.

VE_ROOT="directory"

Corresponds to the --root option.

VE_PRIVATE="directory"

Corresponds to the --private option.

DISABLED="yes|no"

Corresponds to the --disabled option.

ORIGIN_SAMPLE="name"

Name of the CT sample the CT is based on.

CONFIG_CUSTOMIZED="yes|no"

Set to yes if the CT configuration file has been modified.

### Resource management parameters
NUMPROC

Corresponds to the --numproc options.

NUMFILE

Corresponds to the --numfile options.

NUMFLOCK

Corresponds to the --numflock options.

NUMPTY

Corresponds to the --numpty options.

NUMSIGINFO

Corresponds to the --numsiginfo options.

PRIVVMPAGES

Corresponds to the --privvmpages options.

VMMGUARPAGES

Corresponds to the --vmguarpages options.

LOCKEDPAGES

Corresponds to the --lockedpages options.

SHMPAGES

Corresponds to the --shmpages options.

NUMIPTENT

Corresponds to the --numiptent options.

CPUUNITS

Corresponds to the --cpuunits option.

DISKSPACE="softlimit[:hardlimit]"

Corresponds to the --diskspace parameter.

QUOTAUGIDLIMIT="num"

Corresponds to the --quotaugidlimit parameter.

NOATIME="yes|no"

Corresponds to the --noatime option.

RATE="interface:class:rate [interface:class:rate ...]"

Corresponds to the --rate option.

RATEBOUND="yse|no"

Corresponds to the --ratebound option.

### Network related parameters
IP_ADDRESS="address [address]"

Specifies the address the CT will be assigned. Several addresses are divided by spaces. Corresponds to the --ipadd option.

HOSTNAME="name"

Corresponds to the --hostname option.

NAMESERVER="ip [ip]"

Corresponds to the --nameserver option. Several name server addresses are set off by spaces.

SEARCHDOMAIN="domain [domain]"

Corresponds to the --searchdomain option. Several search domains are separated by spaces.

## SEE ALSO
vzctl(8), vz(5).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


vz

title: vz(5)

summary: global OpenVZ configuration file

text:
# vz(5)

## NAME
vz - global OpenVZ configuration file

## SYNOPSIS
/etc/vz/vz.conf

## DESCRIPTION
This is the global configuration file for OpenVZ. It consists of lines in the form

PARAMETER="value"

All parameter names and values are case-sensitive. Quotes surrounding value are required if value contains spaces, and are optional otherwise. Extra spaces are not allowed. All unrecognized lines will be ignored.

### Global parameters
ACTIONLOGDIR=directory

Set the directory to write action log files to. Action log files are needed for vzctl/vzcoll interaction, so vzcoll will know what actions are done on CTs.

LOCKDIR=directory

Set the directory to put lock files to. This parameter is used by both vzctl(8) and hwcoll(8).

REMOVEMIGRATED=yes|no

Remove private area on migrating yes|no This option is not supported for ploop-based CT.

VE_ENVIRONMENT="NAME=VALUE [NAME=VALUE ...]"

Environment variables to be set for CT init.

HTTP_PROXY=[protocol://]host[:port]

Proxy server configuration.

USE_NET_HWCSUM=yes|no

Enable use of hardware checksumming on venet interfaces. In case all the hardware network interfaces in the system support scatter-gather and hw checksumming features it is recommended to set USE_NET_HWCSUM to yes. If USE_NET_HWCSUM is absent or has a value different from yes|no then it is autoconfigured (minimal common subset of capabilities among physical adapters on node).

USE_NET_TSO=yes|no

Enable use of hardware tcp segmentation offload on venet interfaces. If USE_NET_TSO is absent or has a value different from yes|no then it is autoconfigured (minimal common subset of capabilities among physical adapters on node).

USE_NET_RPS=yes|no

Enables or disables use of Receive packet steering on venet and veth interfaces. RPS is enabled by default.

USE_VENET_MASK=yes|no

Enable the assignment of network masks to Containers operating in the venet0 mode (no by default).

GOLDEN_IMAGE=yes|no

Enable the use of Golden Images for creating Containers (yes by default). A Golden Image is an extended template cache that includes an OS template and one or more application templates.

VE_PARALLEL=number

Sets a number of Containers to start simultaneously on node boot. If not specified, the number is calculated based on node's CPU power. This parameter is used by the /etc/init.d/vz script.

VE_STOP_MODE=suspend|stop

Specifies an action to be performed on Containers on node shutdown or reboot. This parameter is used by the /etc/init.d/vz script.

• suspend - Suspend Containers on shutdown (default),

• stop - Stop Containers.

REPAIR_MODE=force|auto

Specifies the mode for the fsck file system checking utility.

• auto - fsck will automatically fix any file system issues that can be safely fixed without human intervention (default).

• force - fsck will always attempt to fix all file system corruption issues automatically (not recommended).

### Logging parameters
LOGGING=yes|no

Enables or disables logging. This parameter can be set to yes or no, default is yes.

LOGFILE=file

Sets location of log file, default is /var/log/vzctl.log.

LOG_LEVEL=number

Set the logging level. The more the number is, the more information will be written to a log file. Default value is 0. Some useful values are:

• 0 - actions/errors of vzctl on start, stop, mount, umount, create, destroy,

• 1 - logging helper comands vzctl running in /usr/share/libvzctl/scripts,

• 2 - logging create action events, pool, version used on create action,

• 3 - logging vzctl command line.

### Disk quota parameters
DISK_QUOTA=yes|no

In case the value of this parameter is set to no, all disk quota operations are disabled.

### Network interface parameters
VE_ROUTE_SRC_DEV="device"

This parameter specifies the network device name which IP address will be used as the source IP. This is helpful in case more than one network interface is configured on HN and there is a need to specify the source IP address. Default is the first device in the network device list.

### Network traffic parameters
TRAFFIC_SHAPING="yes|no"

Traffic shaping allows limiting bandwidth consumed by Containers. If it is set to yes then limitations will be turned on. Default is no.

BANDWIDTH="dev [dev ...]"

List of network devices for traffic shaping. If no value is given, the device will be automatically determined by the default route.

TOTALRATE="dev:class:Kbits"

Specifies bound rate for network devices.

RATE="dev:class:Kbits"

Specifies guaranteed rate for network devices.

RATEMPU="dev:class[:bytes]"

Specifies Minimum Packet Unit for traffic shaping. If packet size is lower then MPU bytes, it will consume MPU HTB tokens. This is to limit packet rate (packet rate = TOTALRATE / RATEMPU). If MPU value (bytes) is omitted then VZ_TC_DEFAULT_MPU (1000) is used. If dev:class is not in RATEMPU then packet rate is not limited for them.

### Disk IO limit parameters
VZ_TOOLS_BCID="ID"

Enables disk IO limits for backup, restore, and migration operations. Make sure that no Container with the specified ID exists on the Node.

VZ_TOOLS_IOLIMIT="limit"

Sets the disk IO limit for backup, restore, and migration operations, in bytes per second.

VZ_TOOLS_MEMLIMIT="limit"

Sets the memory limit for backup, restore, and migration operations, in bytes.

### Template parameters
TEMPLATE="directory"

Value of this parameter is the directory in which all the files and directories shared between all CTs are stored.

### Defaults for CT
Below parameters are defaults for CT, and gets overwritten by parameters in ve.conf(5) CT configuration file.

VE_ROOT=directory

Value of this parameter is the directory which serves as CT root mount point. Value must contain literal string $VEID, which will be substituted with actual numeric CT ID.

VE_PRIVATE=directory

Value of this parameter is the directory in which all the files and directories specific to that CT are stored. Value must contain literal string $VEID, which will be substituted with actual numeric CT ID.

CONFIGFILE=name

Specifies default configuration file for create action, corresponds to --config option of vzctl create.

Any other parameter that appears in per-CT configuration file ve.conf(5) can be also set here. Still, it is recommended to keep TEMPLATE, VE_PRIVATE and VE_ROOT in this configuration files, and all the other CT-related parameters in per-CT configuration files.

## SEE ALSO
vzctl(8), vzpkg(8), ve.conf(5).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


title: vz-create_prvt(5)

text:
# vz-create_prvt(5)

## NAME
vz-create_prvt - Container's script for creating CT private area

## SYNOPSIS
/usr/share/libvzctl/scripts/vz-create_prvt

## DESCRIPTION
The vz-create_prvt script is called by vzctl(8) when it gets called with create command. The script can be any executable file and is usually a shell script.

This script is expected to create CT private area from private area template, and randomize its crontab.

Parameters are passed to the script in the form of environment variables. The following variables can be defined:

VEID

Numeric id of CT.

PRIVATE_TEMPLATE

Path to private area template, used as a source.

VE_PRIVATE

Path to root of CT private areas.

DIR

Suffix to CT private area path, used as a destination. Full path is VE_PRIVATE/tmp/DIR.

## DIAGNOSTICS
The script is expected to return 0 on success, any other return code will be printed by vzctl.

## SEE ALSO
vzctl(8).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


title: vz-net_add(5)

text:
# vz-net_add(5)

## NAME
vz-net_add - Container's script for adding an IP alias

## SYNOPSIS
/usr/share/libvzctl/scripts/vz-net_add

## DESCRIPTION
The vz-net_add script is called by vzctl(8). The script can be any executable file and is usually a shell script.

This script adds source routing for given IP, by executing command "/sbin/ip route add addr dev venet0 src srcaddr", where addr is IP address given, and srcaddr is first local non-loopback address.

Also, it adds public ARP records for given IP on all interfaces excluding those with LOOPBACK or NOARP flags set. It does so with the command "/sbin/ip neigh add proxy addr dev device", where addr is IP address and device is network interface device name (like eth0).

## OPTIONS
Parameters are passed to the script in the form of environment variables. The following variables can be defined:

VEID

Numeric id of CT.

IP_ADDR

IP address(es) to add as an alias to CT. Several addresses are divided by space.

VE_STATE

This (optional) variable is telling the state of CT and can be one of the following: running, starting, stopping, stopped.

## DIAGNOSTICS
The script is expected to return 0 on success, any other return code will be printed by vzctl.

## SEE ALSO
vzctl(8).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


title: vz-net_del(5)

text:
# vz-net_del(5)

## NAME
vz-net_del - Container's script for removing an IP alias

## SYNOPSIS
/usr/share/libvzctl/scripts/vz-net_del

## DESCRIPTION
The vz-net_del script is called by vzctl(8). The script can be any

executable file and is usually a shell script.

First, it removes source routing for this IP, by executing command "/sbin/ip route del addr dev venet0", where addr is given IP address.

Then, it removes ARP records for given IP from all interfaces, excluding those with LOOBBACK or NOARP flags set, by executing command "/sbin/ip neigh del proxy addr dev device", where addr is IP address and device is network interface device name (like eth0).

## OPTIONS
Parameters are passed to the script in the form of environment variables. The following variables can be defined:

VEID

Numeric id of CT.

IP_ADDR

IP address(es) to remove from CT. Several addresses are divided by space.

DIST

Name of the distribution this CT runs (like redhat-7.1). Used for script to do distribution-dependent setup.

VZ_LOG

Location of log file to write log to (optional).

## DIAGNOSTICS
The script is expected to return 0 on success, any other return code will be printed by vzctl.

## SEE ALSO
vzctl(8).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


vz-postinst

title: vz-postinst(5)

text:
# vz-postinst(5)

## NAME
vz-postinst - Container's script to perform postinstall tasks

## SYNOPSIS
/usr/share/libvzctl/scripts/vz-postinst

## DESCRIPTION
The vz-postinst script is called by vzctl(8) after CT private area is created and mounted.

This script performs various postinstall tasks.

It randomizes times in VE_ROOT/etc/crontab file to prevent starting cron jobs in all VEs in the same time.

It also disables root password if the password field is empty in VE_ROOT/etc/passwd file.

## OPTIONS
Parameters are passed to the script in the form of environment variables. The following variables can be defined:

VE_ROOT

Root directory of CT.

DIST

Name of the distribution this CT runs (like redhat-7.1). Used for script to do distribution-dependent setup.

## DIAGNOSTICS
The script is expected to return 0 on success, any other return code will be printed by vzctl.

## SEE ALSO
vzctl(8).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


vz-start

title: vz-start(5)

text:
# vz-start(5)

## NAME
vz-start - Container's startup configuration script

## SYNOPSIS
/usr/share/libvzctl/scripts/vz-start

## DESCRIPTION
The vz-start script is called by vzctl(8) just before CT is started. The script can be any executable file and is usually a shell script. It can be used to perform any additional setup of the CT such as network setup.

Parameters are passed to the script in the form of environment variables. Currently only two variables IP_ADDR and VE_ID are defined.

IP_ADDR

IP address(es) assigned to the CT.

VE_ROOT

Root directory of given CT.

DIST

Name of the distribution this CT runs (like redhat-7.1). Used for script to do distribution-dependent setup.

## DIAGNOSTICS
The script is expected to return 0 on success, any other return code will be printed by vzctl, but the CT booting will not be terminated.

## SEE ALSO
vzctl(8).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


vz-stop

title: vz-stop(5)

text:
# vz-stop(5)

## NAME
vz-stop - Container's shutdown configuration script

## SYNOPSIS
/usr/share/libvzctl/scripts/vz-stop

## DESCRIPTION
The vz-stop script is called by vzctl(8) just after the CT is shut down. The script can be any executable file and is usually a shell script. It can be used to perform any additional cleanup of the CT such as network cleanup.

Parameters are passed to the script in the form of environment variables.

VEID

Numeric id of CT.

IP_ADDR

IP address(es) assigned to the CT. Several addresses should be divided by spaces.

## DIAGNOSTICS
The script is expected to return 0 on success, any other return code will be printed by vzctl(8).

## SEE ALSO
vzctl(8).

## COPYRIGHT
Copyright (c) 1999-2017, Parallels International GmbH. All rights reserved. Copyright (c) 2017-2019 Virtuozzo International GmbH. All rights reserved.


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 JSON file format and is named config.

Valid locations for this file are:

•$XDG_CONFIG_HOME/waybar/config

•~/.config/waybar/config

•~/waybar/config

•/etc/xdg/waybar/config

•/etc/xdg/waybar/config

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

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

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

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.

gtk-layer-shell

typeof: bool

default: true

Option to disable the use of gtk-layer-shell for popups.

Only functional if compiled with gtk-layer-shell support.

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

## 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 the direction orthogonal to the bar direction. 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.

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": {
		"modules": [
			"cpu",
			"memory",
			"battery"
		]
	},
	...
}
```

## SUPPORTED MODULES
•waybar-backlight(5)

•waybar-battery(5)

•waybar-bluetooth(5)

•waybar-clock(5)

•waybar-cpu(5)

•waybar-custom(5)

•waybar-disk(5)

•waybar-idle-inhibitor(5)

•waybar-keyboard-state(5)

•waybar-memory(5)

•waybar-mpd(5)

•waybar-network(5)

•waybar-pulseaudio(5)

•waybar-river-tags(5)

•waybar-states(5)

•waybar-sway-mode(5)

•waybar-sway-window(5)

•waybar-sway-workspaces(5)

•waybar-wlr-taskbar(5)

•waybar-wlr-workspaces(5)

•waybar-temperature(5)

•waybar-tray(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 take up.

align:

typeof: float

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

rotate:

typeof: integer

Positive value to rotate the text label.

states:

typeof: array

A number of backlight states which get activated on certain brightness levels.

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

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.

on-scroll-down:

typeof: string

Command to execute when performing a scroll down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

## EXAMPLE:

```
"backlight": {

    "device": "intel_backlight",

    "format": "{percent}% {icon}",

    "format-icons": ["", ""]
}
```

## STYLE
•#backlight


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 it's current maximal capacity.

interval:

typeof: integer

default: 60

The interval in which the information gets polled.

states:

typeof: array

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

format:

typeof: string

default: {capacity}%

The format, how the time 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 take up.

align:

typeof: float

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

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 clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{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.

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

The two arguments are: {H}: Hours {M}: 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 or below the configured <value>.

•Also each state can have its own format. Those con 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>.


waybar-bluetooth

title: waybar-bluetooth(5)

text:
# waybar-bluetooth(5)

## NAME
waybar - bluetooth module

## DESCRIPTION
The bluetooth module displays information about a bluetooth controller and its connections.

## CONFIGURATION
Addressed by bluetooth

controller:

typeof: string

Use the controller with the defined alias. Otherwise a random controller is used. Recommended to define when there is more than 1 controller available to the system.

format-device-preference:

typeof: array

A ranking of bluetooth devices, addressed by their alias. The order is from first displayed to last displayed.

If this config option is not defined or none of the devices in the list are connected, it will fall back to showing the last connected device.

format:

typeof: string

default:  {status}

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

format-disabled:

typeof: string

This format is used when the displayed controller is disabled.

format-off:

typeof: string

This format is used when the displayed controller is turned off.

format-on:

typeof: string

This format is used when the displayed controller is turned on with no devices connected.

format-connected:

typeof: string

This format is used when the displayed controller is connected to at least 1 device.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

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

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

tooltip-format:

typeof: string

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

tooltip-format-disabled:

typeof: string

This format is used when the displayed controller is disabled.

tooltip-format-off:

typeof: string

This format is used when the displayed controller is turned off.

tooltip-format-on:

typeof: string

This format is used when the displayed controller is turned on with no devices connected.

tooltip-format-connected:

typeof: string

This format is used when the displayed controller is connected to at least 1 device.

tooltip-format-enumerate-connected:

typeof: string

This format is used to define how each connected device should be displayed within the device_enumerate format replacement in the tooltip menu.

## FORMAT REPLACEMENTS
{status}: Status of the bluetooth device.

{num_connections}: Number of connections the displayed controller has.

{controller_address}: Address of the displayed controller.

{controller_address_type}: Address type of the displayed controller.

{controller_alias}: Alias of the displayed controller.

{device_address}: Address of the displayed device.

{device_address_type}: Address type of the displayed device.

{device_alias}: Alias of the displayed device.

{device_enumerate}: Show a list of all connected devices, each on a seperate line. Define the format of each device with the tooltip-format-enumerate-connected

and/or tooltip-format-enumerate-connected-battery config options. Can only be used in the tooltip related format options.

## EXPERIMENTAL BATTERY PERCENTAGE FEATURE
At the time of writing, the experimental features of BlueZ need to be turned on, for the battery percentage options listed below to work.

### FORMAT REPLACEMENT
{device_battery_percentage}: Battery percentage of the displayed device if available. Use only in the config options defined below.

### CONFIGURATION
format-connected-battery:

typeof: string

This format is used when the displayed device provides its battery percentage.

tooltip-format-connected-battery:

typeof: string

This format is used when the displayed device provides its battery percentage.

tooltip-format-enumerate-connected-battery:

typeof: string

This format is used to define how each connected device with a battery should be displayed within the device_enumerate format replacement option.

When this config option is not defined, it will fall back on the tooltip-format-enumerate-connected config option.

## EXAMPLES

```
"bluetooth": {
	// "controller": "controller1", // specify the alias of the controller if there are more than 1 on the system
	"format": " {status}",
	"format-disabled": "", // an empty format will hide the module
	"format-connected": " {num_connections} connected",
	"tooltip-format": "{controller_alias}\t{controller_address}",
	"tooltip-format-connected": "{controller_alias}\t{controller_address}\n\n{device_enumerate}",
	"tooltip-format-enumerate-connected": "{device_alias}\t{device_address}"
}
```

```
"bluetooth": {
	"format": " {status}",
	"format-connected": " {device_alias}",
	"format-connected-battery": " {device_alias} {device_battery_percentage}%",
	// "format-device-preference": [ "device1", "device2" ], // preference list deciding the displayed device
	"tooltip-format": "{controller_alias}\t{controller_address}\n\n{num_connections} connected",
	"tooltip-format-connected": "{controller_alias}\t{controller_address}\n\n{num_connections} connected\n\n{device_enumerate}",
	"tooltip-format-enumerate-connected": "{device_alias}\t{device_address}",
	"tooltip-format-enumerate-connected-battery": "{device_alias}\t{device_address}\t{device_battery_percentage}%"
}
```

## STYLE
•#bluetooth

•#bluetooth.disabled

•#bluetooth.off

•#bluetooth.on

•#bluetooth.connected

•#bluetooth.discoverable

•#bluetooth.discovering

•#bluetooth.pairable


waybar-clock

title: waybar-clock(5)

text:
# waybar-clock(5)

## NAME
waybar - clock module

## DESCRIPTION
The clock module displays the current date and time.

## CONFIGURATION
interval:

typeof: integer

default: 60

The interval in which the information gets polled.

format:

typeof: string

default: {:%H:%M}

The format, how the date and time should be displayed.

It uses the format of the date library. See https://howardhinnant.github.io/date/date.html#to_stream_formatting for details.

timezone:

typeof: string

default: inferred local timezone

The timezone to display the time in, e.g. America/New_York.

This field will be ignored if timezones field is set and have at least one value.

timezones:

typeof: list of strings

A list of timezones to use for time display, changed using the scroll wheel.

Use "" to represent the system's local timezone. Using %Z in the format or tooltip format is useful to track which time zone is currently displayed.

locale:

typeof: string

default: inferred from current locale

A locale to be used to display the time. Intended to render times in custom timezones with the proper language and format.

today-format:

typeof: string

default: {}

The format of today's date in the calendar.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

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

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 clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

View all valid format options in strftime(3).

## FORMAT REPLACEMENTS
{calendar}: Current month calendar {timezoned_time_list}: List of time in the rest timezones, if more than one timezone is set in the config

## EXAMPLES

```
"clock": {

    "interval": 60,

    "format": "{:%H:%M}",

    "max-length": 25
}
```

## STYLE
•#clock


waybar-cpu

title: waybar-cpu(5)

text:
# waybar-cpu(5)

## NAME
waybar - cpu module

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

## CONFIGURATION
interval:

typeof: integer

default: 10

The interval in which the information gets polled.

format:

typeof: string

default: {usage}%

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

format-icons:

typeof: array/object

Based on the current usage, 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 take up.

align:

typeof: float

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

rotate:

typeof: integer

Positive value to rotate the text label.

states:

typeof: array

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

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{load}: Current cpu load.

{usage}: Current overall cpu usage.

{usage{n}}: Current cpu core n usage. Cores are numbered from zero, so first core will be {usage0} and 4th will be {usage3}.

{avg_frequency}: Current cpu average frequency (based on all cores) in GHz.

{max_frequency}: Current cpu max frequency (based on the core with the highest frequency) in GHz.

{min_frequency}: Current cpu min frequency (based on the core with the lowest frequency) in GHz.

{icon}: Icon for overall cpu usage.

{icon{n}}: Icon for cpu core n usage. Use like {icon0}.

## EXAMPLES
Basic configuration:

```
"cpu": {
	"interval": 10,
	"format": "{}% ",
	"max-length": 10
}
```

Cpu usage per core rendered as icons:

```
"cpu": {
	"interval": 1,
	"format": "{icon0}{icon1}{icon2}{icon3} {usage:>2}% ",
	"format-icons": ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"],
},
```

## STYLE
•#cpu


waybar-custom

title: waybar-custom(5)

text:
# waybar-custom(5)

## NAME
waybar - custom module

## DESCRIPTION
The custom module displays either the output of a script or static text. To display static text, specify only the format field.

## CONFIGURATION
Addressed by custom/<name>

exec:

typeof: string

The path to the script, which should be executed.

exec-if:

typeof: string

The path to a script, which determines if the script in exec should be executed.

exec will be executed if the exit code of exec-if equals 0.

exec-on-event:

typeof: bool

default: true

If an event command is set (e.g. on-click or on-scroll-up) then re-execute the script after

executing the event command.

return-type:

typeof: string

See return-type

interval:

typeof: integer

The interval (in seconds) in which the information gets polled.

Use once if you want to execute the module only on startup. You can update it manually with a signal. If no interval is defined, it is assumed that the out script loops it self.

restart-interval:

typeof: integer

The restart interval (in seconds).

Can't be used with the interval option, so only with continuous scripts. Once the script exit, it'll be re-executed after the restart-interval.

signal:

typeof: integer

The signal number used to update the module.

The number is valid between 1 and N, where SIGRTMIN+N = SIGRTMAX.

format:

typeof: string

default: {}

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

format-icons:

typeof: array

Based on the set percentage, the corresponding icon gets selected. The order is low to high.

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

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

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

escape:

typeof: bool

default: false

Option to enable escaping of script output.

## RETURN-TYPE
When return-type is set to json, Waybar expects the exec-script to output its data in JSON format. This should look like this:

```
{"text": "$text", "tooltip": "$tooltip", "class": "$class", "percentage": $percentage }
```

The class parameter also accepts an array of strings.

If nothing or an invalid option is specified, Waybar expects i3blocks style output. Values are newline separated. This should look like this:

```
$text\n$tooltip\n$class*
```

class is a CSS class, to apply different styles in style.css

## FORMAT REPLACEMENTS
{}: Output of the script.

{percentage} Percentage which can be set via a json return-type.

{icon}: An icon from 'format-icons' according to percentage.

## EXAMPLES

### Spotify:

```
"custom/spotify": {
	"format": " {}",
	"max-length": 40,
	"interval": 30, // Remove this if your script is endless and write in loop
	"exec": "$HOME/.config/waybar/mediaplayer.sh 2> /dev/null", // Script in resources folder
	"exec-if": "pgrep spotify",
	"return-type": "json"
}
```

### mpd:

```
"custom/mpd": {
	"format": "♪ {}",
	//"max-length": 15,
	"interval": 10,
	"exec": "mpc current",
	"exec-if": "pgrep mpd",
	"on-click": "mpc toggle",
	"on-click-right": "sonata"
}
```

### cmus:

```
"custom/cmus": {
	"format": "♪ {}",
	//"max-length": 15,
	"interval": 10,
	"exec": "cmus-remote -C "format_print '%a - %t'"", // artist - title
	"exec-if": "pgrep cmus",
	"on-click": "cmus-remote -u",                        //toggle pause
	"escape": true                                       //handle markup entities
}
```

### Pacman

```
"custom/pacman": {
	"format": "{}  ",
	"interval": "once",
	"exec": "pacman_packages",
	"on-click": "update-system",
	"signal": 8
}
```

### Alternate Pacman

```
"custom/pacman": {
	"format": "{}  ",
	"interval": 3600,                     // every hour
	"exec": "checkupdates | wc -l",       // # of updates
	"exec-if": "exit 0",                  // always run; consider advanced run conditions
	"on-click": "termite -e 'sudo pacman -Syu'; pkill -SIGRTMIN+8 waybar", // update system
	"signal": 8
}
```

You can use the signal and update the number of available packages with pkill -RTMIN+8 waybar.

## STYLE
•#custom-<name>

•#custom-<name>.<class>

•<class> can be set by the script. For more information see return-type


waybar-disk

title: waybar-disk(5)

text:
# waybar-disk(5)

## NAME
waybar - disk module

## DESCRIPTION
The disk module displays the current disk space used.

## CONFIGURATION
Addressed by disk

path:

typeof: string

default: "/"

Any path residing in the filesystem or mountpoint for which the information should be displayed.

interval:

typeof: integer

default: 30

The interval in which the information gets polled.

format:

typeof: string

default: "{percentage_used}%"

The format, how information should be displayed.

rotate:

typeof: integer

Positive value to rotate the text label.

states:

typeof: array

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

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

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

on-click:

typeof: string

Command to execute when clicked on the module.

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

tooltip-format:

typeof: string

default: "{used} out of {total} used ({percentage_used}%)"

The format of the information displayed in the tooltip.

## FORMAT REPLACEMENTS
{percentage_used}: Percentage of disk in use.

{percentage_free}: Percentage of free disk space

{total}: Total amount of space on the disk, partition or mountpoint.

{used}: Amount of used disk space.

{free}: Amount of available disk space for normal users.

{path}: The path specified in the configuration.

## EXAMPLES

```
"disk": {
	"interval": 30,
	"format": "{percentage_free}% free on {path}",
}
```

## STYLE
•#disk


waybar-idle-inhibitor

title: waybar-idle-inhibitor(5)

text:
# waybar-idle-inhibitor(5)

## NAME
waybar - idle_inhibitor module

## DESCRIPTION
The idle_inhibitor module can inhibiting the idle behavior such as screen blanking, locking, and screensaving, also known as "presentation mode".

## CONFIGURATION
format:

typeof: string

The format, how the state should be displayed.

format-icons:

typeof: array

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

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

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

on-click:

typeof: string

Command to execute when clicked on the module. A click also toggles the state

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

timeout:

typeof: double

The number of minutes the inhibit should last.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{status}: status (activated or deactivated)

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

## EXAMPLES

```
"idle_inhibitor": {
	"format": "{icon}",
	"format-icons": {
	    "activated": "",
	    "deactivated": ""
	},
	"timeout": 30.5
}
```


waybar-inhibitor

title: waybar-inhibitor(5)

text:
# waybar-inhibitor(5)

## NAME
waybar - inhibitor module

## DESCRIPTION
The inhibitor module allows to take an inhibitor lock that logind provides. See systemd-inhibit(1) for more information.

## CONFIGURATION
what:

typeof: string or array

The inhibitor lock or locks that should be taken when active. The available inhibitor locks are idle, shutdown, sleep, handle-power-key, handle-suspend-key, handle-hibernate-key and handle-lid-switch.

format:

typeof: string

The format, how the state should be displayed.

format-icons:

typeof: array

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

rotate:

typeof: integer

Positive value to rotate the text label.

max-length:

typeof: integer

The maximum length in character the module should display.

min-length:

typeof: integer

The minimum length in characters the module should take up.

align:

typeof: float

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

on-click:

typeof: string

Command to execute when clicked on the module. A click also toggles the state

on-click-middle:

typeof: string

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

on-click-right:

typeof: string

Command to execute when you right clicked on the module.

on-update:

typeof: string

Command to execute when the module is updated.

on-scroll-up:

typeof: string

Command to execute when scrolling up on the module.

on-scroll-down:

typeof: string

Command to execute when scrolling down on the module.

smooth-scrolling-threshold:

typeof: double

Threshold to be used when scrolling.

tooltip:

typeof: bool

default: true

Option to disable tooltip on hover.

## FORMAT REPLACEMENTS
{status}: status (activated or deactivated)

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

## EXAMPLES

```
"inhibitor": {
	"what": "handle-lid-switch",
	"format": "{icon}",
	"format-icons": {
	    "activated": "",
	    "deactivated": ""
	}
}
```