in.tftpd

package: tftpd

title: in.tftpd(8)

summary: Trivial File Transfer Protocol server

text:
# in.tftpd(8)

## NAME
tftpd - Trivial File Transfer Protocol server

## SYNOPSIS
in.tftpd [options...] directory...

## DESCRIPTION
tftpd is a server for the Trivial File Transfer Protocol. The TFTP protocol is extensively used to support remote booting of diskless devices. The server is normally started by inetd, but can also run standalone.

## OPTIONS
--ipv4, -4

Connect with IPv4 only, even if IPv6 support was compiled in.

--ipv6, -6

Connect with IPv6 only, if compiled in.

-l, --listen

Run the server in standalone (listen) mode, rather than run from inetd. In listen mode, the --timeout option is ignored, and the --address option can be used to specify a specific local address or port to listen to.

--foreground, -L

Similar to --listen but do not detach from the foreground process. Implies --listen.

--pid, -P

Create pid file /var/run/tftpd.pid in standalone (listen) mode.

--address [address][:port], -a [address][:port]

Specify a specific address and port to listen to when called with the --listen or --foreground option. The default is to listen to the tftp port specified in /etc/services on all local addresses. Please note: Numeric IPv6 adresses must be enclosed in square brackets to avoid ambiguity with the optional port information.

--create, -c

Allow new files to be created. By default, tftpd will only allow upload of files that already exist. Files are created with default permissions allowing anyone to read or write them, unless the --permissive or --umask options are specified.

--secure, -s

Change root directory on startup. This means the remote host does not need to pass along the directory as part of the transfer, and may add security. When --secure is specified, exactly one directory should be specified on the command line. The use of this option is recommended for security as well as compatibility with some boot ROMs which cannot be easily made to include a directory name in its request.

--user username, -u username

Specify the username which tftpd will run as; the default is "nobody". The user ID, group ID, and (if possible on the platform) the supplementary group IDs will be set to the ones specified in the system permission database for this username.

--umask umask, -U umask

Sets the umask for newly created files to the specified value. The default is zero (anyone can read or write) if the --permissive option is not specified, or inherited from the invoking process if --permissive is specified.

--permissive, -p

Perform no additional permissions checks above the normal system-provided access controls for the user specified via the --user option.

--timeout timeout, -t timeout

When run from inetd this specifies how long, in seconds, to wait for a second connection before terminating the server. inetd will then respawn the server when another request comes in. The default is 900 (15 minutes.)

--retransmit timeout, -T timeout

Determine the default timeout, in microseconds, before the first packet is retransmitted. This can be modified by the client if the timeout or utimeout option is negotiated. The default is 1000000 (1 second.)

--mapfile remap-file, -m remap-file

Specify the use of filename remapping. The remap-file is a file containing the remapping rules. See the section on filename remapping below. This option may not be compiled in, see the output of in.tftpd -V to verify whether or not it is available.

--verbose, -v

Increase the logging verbosity of tftpd. This flag can be specified multiple times for even higher verbosity.

--verbosity value

Set the verbosity value to value.

--refuse tftp-option, -r tftp-option

Indicate that a specific RFC 2347 TFTP option should never be accepted.

--blocksize max-block-size, -B max-block-size

Specifies the maximum permitted block size. The permitted range for this parameter is from 512 to 65464. Some embedded clients request large block sizes and yet do not handle fragmented packets correctly; for these clients, it is recommended to set this value to the smallest MTU on your network minus 32 bytes (20 bytes for IP, 8 for UDP, and 4 for TFTP; less if you use IP options on your network.) For example, on a standard Ethernet (MTU 1500) a value of 1468 is reasonable.

--port-range port:port, -R port:port

Force the server port number (the Transaction ID) to be in the specified range of port numbers.

--version, -V

Print the version number and configuration to standard output, then exit gracefully.

## RFC 2347 OPTION NEGOTIATION
This version of tftpd supports RFC 2347 option negotation. Currently implemented options are:

blksize (RFC 2348)

Set the transfer block size to anything less than or equal to the specified option. This version of tftpd can support any block size up to the theoretical maximum of 65464 bytes.

blksize2 (nonstandard)

Set the transfer block size to anything less than or equal to the specified option, but restrict the possible responses to powers of 2. The maximum is 32768 bytes (the largest power of 2 less than or equal to 65464.)

tsize (RFC 2349)

Report the size of the file that is about to be transferred. This version of tftpd only supports the tsize option for binary (octet) mode transfers.

timeout (RFC 2349)

Set the time before the server retransmits a packet, in seconds.

utimeout (nonstandard)

Set the time before the server retransmits a packet, in microseconds.

rollover (nonstandard)

Set the block number to resume at after a block number rollover. The default and recommended value is zero.

The --refuse option can be used to disable specific options; this may be necessary to work around bugs in specific TFTP client implementations. For example, some TFTP clients have been found to request the blksize option, but crash with an error if they actually get the option accepted by the server.

## FILENAME REMAPPING
The --mapfile option specifies a file which contains filename remapping rules. Each non-comment line (comments begin with hash marks, #) contains an operation, specified below; a regex, a regular expression in the style of egrep; and optionally a replacement pattern. The operation indicated by operation is performed if the regex matches all or part of the filename. Rules are processed from the top down, and by default, all rules are processed even if there is a match.

The operation can be any combination of the following letters:

r

Replace the substring matched by regex by the replacement pattern. The replacement pattern may contain escape sequences; see below.

g

Repeat this rule until it no longer matches. This is always used with r.

i

Match the regex case-insensitively. By default it is case sensitive.

e

If this rule matches, end rule processing after executing the rule.

s

If this rule matches, start rule processing over from the very first rule after executing this rule.

a

If this rule matches, refuse the request and send an access denied error to the client.

G

This rule applies to GET (RRQ) requests only.

P

This rule applies to PUT (WRQ) requests only.

~

Inverse the sense of this rule, i.e. execute the operation only if the regex doesn't match. Cannot used together with r.

The following escape sequences are recognized as part of the replacement pattern:

\0

The entire string matched by the regex.

\1 to \9

The strings matched by each of the first nine parenthesized subexpressions, \( ... \), of the regex pattern.

\i

The IP address of the requesting host, in dotted-quad notation (e.g. 192.0.2.169).

\x

The IP address of the requesting host, in hexadecimal notation (e.g. C00002A9).

\\

Literal backslash.

\whitespace

Literal whitespace.

\#

Literal hash mark.

\U

Turns all subsequent letters to upper case.

\L

Turns all subsequent letters to lower case.

\E

Cancels the effect of \U or \L.

If the mapping file is changed, you need to send SIGHUP to any outstanding tftpd process.

## SECURITY
The use of TFTP services does not require an account or password on the server system. Due to the lack of authentication information, tftpd will allow only publicly readable files (o+r) to be accessed, unless the --permissive option is specified. Files may be written only if they already exist and are publicly writable, unless the --create option is specified. Note that this extends the concept of ``public'' to include all users on all hosts that can be reached through the network; this may not be appropriate on all systems, and its implications should be considered before enabling TFTP service. Typically, some kind of firewall or packet-filter solution should be employed. If appropriately compiled (see the output of in.tftpd --version) tftpd will query the hosts_access(5) database for access control information. This may be slow; sites requiring maximum performance may want to compile without this option and rely on firewalling or kernel-based packet filters instead.

The server should be set to run as the user with the lowest possible privilege; please see the --user flag. It is probably a good idea to set up a specific user account for tftpd, rather than letting it run as "nobody", to guard against privilege leaks between applications.

Access to files can, and should, be restricted by invoking tftpd with a list of directories by including pathnames as server program arguments on the command line. In this case access is restricted to files whole names are prefixed by one of the given directories. If possible, it is recommended that the --secure flag is used to set up a chroot() environment for the server to run in once a connection has been set up.

Finally, the filename remapping (--mapfile flag) support can be used to provide a limited amount of additional access control.

## CONFORMING TO
RFC 1123, Requirements for Internet Hosts - Application and Support.

RFC 1350, The TFTP Protocol (revision 2).

RFC 2347, TFTP Option Extension.

RFC 2348, TFTP Blocksize Option.

RFC 2349, TFTP Timeout Interval and Transfer Size Options.

## AUTHOR
This version of tftpd is maintained by H. Peter Anvin <hpa@zytor.com>. It was derived from, but has substantially diverged from, an OpenBSD source base, with added patches by Markus Gutschke and Gero Kulhman.

## SEE ALSO
tftp(1), egrep(1), umask(2), hosts_access(5), regex(7), inetd(8).


thermald

package: thermald

title: thermald(8)

summary: start Linux thermal daemon

text:
# thermald(8)

## NAME
thermald - start Linux thermal daemon

## SYNOPSIS
thermald [ OPTIONS ]

## DESCRIPTION
thermald is a Linux daemon used to prevent the overheating of platforms. This daemon monitors temperature and applies compensation using available cooling methods.

By default, it monitors CPU temperature using available CPU digital temperature sensors and maintains CPU temperature under control, before HW takes aggressive correction action.

Thermal daemon looks for thermal sensors and thermal cooling drivers in the Linux thermal sysfs (/sys/class/thermal) and builds a list of sensors and cooling drivers. Each of the thermal sensors can optionally be binded to a cooling driver by the in kernel drivers. In this case the Linux kernel thermal core can directly take actions based on the temperature trip points, for each sensor and associated cooling device. For example a trip temperature X in a sensor can be associates a cooling driver Y. So when the sensor temperature = X, the cooling driver "Y" is activated.

Thermal daemon allows one to change this relationship or add new one via a thermal configuration file (thermal-conf.xml). This file is automatically created (thermal-conf.xml.auto) and used, if the platform has ACPI thermal relationship table. If not this needs to be manually configured.

For manual configuration refer to the manual page of the thermal-conf.xml.

In some newer platforms the auto creation of the config file is done by a companion tool "dptfxtract". This tool can be downloaded from "https://github.com/intel/dptfxtract". It is suggested as parts of the install process, run dptfxtract.

There can be multiple configuration files. User can select a configuration file via -config-file option to override the default selection. The default selection picks one of the file in the following order:

- /etc/thermald/thermal-conf.xml.auto

- /var/run/thermald/thermal-conf.xml.auto

- /etc/thermald/thermal-conf.xml

(*Assuming configure prefix=/ is used during build.)

There is another companion tool "ThermalMonitor", which presents a graphical front end. This allows the monitoring of sensors and changing of thermal trips to give the user more control. The source code of "ThermalMonitor" is a part of the thermald github source, in the tools folder.

## OPTIONS
-h, --help

Show help options.

--version

Print thermald version and exit.

--no-daemon

Don't become a daemon: Default is daemon mode.

--loglevel=info

log severity: info level and up.

--loglevel=debug

log severity: debug level and up: Max logging.

--poll-interval

Poll interval in seconds: Poll for zone temperature changes. To disable polling, set to zero. Polling can only be disabled, if available temperature sensors can notify temperature change asynchronously.

--dbus-enable

Enable Dbus.

--exclusive-control

Act as exclusive thermal controller. This will use user-space governor for thermal sysfs and take over control.

--ignore-cpuid-check

Ignore cpuid check for supported CPU models.

--config-file

Specify thermal-conf.xml path and ignore default thermal-conf.xml.

--ignore-default-control

Ignore default CPU temperature control. Strictly follow thermal-conf.xml or thermal-conf.xml.auto.

--workaround-enabled

Enable special workarounds for RAPL MMIO power limit and TCC offset every 30 seconds. This helps to disable RAPL MMIO when not used and adjust TCC offset in certain Lenovo laptops.

--disable-active-power

Disable active power management. This will not set active power limits using RAPL MMIO. This may result in constrained performance, if the system boots up with lower power limits.

--adaptive

Use DPTF adaptive tables when present. This will ignore thermald config via xml files.

--test-mode

Force use adaptive mode and exit if not supported, instead of restarting in non adaptive mode. This option is primarily for developers.

--systemd

Assume that thermald is started by systemd. This will prevent running as daemon irrespective of --no-daemon option.

--ignore-critical-trip

If the configuration defined a critical temperature point, which is too low, this option will avoid shutting down the system on reaching this temperature limit.

## SEE ALSO
thermal-conf.xml(5)


package: thin-provisioning-tools

title: cache_check(8)

text:
# cache_check(8)

## NAME
cache_check - validates cache metadata on a device or file.

## SYNOPSIS

```
cache_check [options] {device|file}
```

## DESCRIPTION
cache_check checks cache metadata created by the device-mapper cache target on a device or file.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Output version information and exit.

-q, --quiet

Suppress output messages, return only exit code.

--super-block-only

Only check the superblock.

--skip-hints

Skip checking of the policy hint values metadata.

--skip-discards

Skip checking of the discard bits in the metadata.

--clear-needs-check-flag

Clears the 'needs_check' flag in the superblock.

```
    The kernel may set a flag to force the pool to be checked before it's next

    activated.  Set this switch to clear the flag if the check is successful.

    If the metadata check failed, the flag is not cleared and a cache_repair run

    is needed to fix any issues. After cache_repair succeeded, you may run

    cache_check again.
```

## EXAMPLE
Analyses and repairs cache metadata on logical volume /dev/vg/metadata:

```
    $ cache_check /dev/vg/metadata
```

The device may not be actively used by the target when running.

## DIAGNOSTICS
cache_check returns an exit code of 0 for success or 1 for error.

## SEE ALSO
cache_dump(8), cache_repair(8), cache_restore(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: cache_dump(8)

text:
# cache_dump(8)

## NAME
cache_dump - dump cache metadata from device or file to standard output.

## SYNOPSIS

```
cache_dump [options] {device|file}
```

## DESCRIPTION
cache_dump dumps binary cache metadata created by the device-mapper cache target on a device or file to standard output for analysis or postprocessing in XML format. XML formatted metadata can be fed into cache_restore in order to put it back onto a metadata device (to process by the device-mapper target), or file.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-r, --repair

Repair the metadata whilst dumping it.

-o {xml file}

Specify an output file for the xml, rather than printing to stdout.

## EXAMPLES
Dumps the cache metadata on logical volume /dev/vg/metadata to standard output in XML format:

```
    $ cache_dump /dev/vg/metadata
```

Dumps the cache metadata on logical volume /dev/vg/metadata whilst repairing it to standard output in XML format:

```
    $ cache_dump --repair /dev/vg/metadata
```

## DIAGNOSTICS
cache_dump returns an exit code of 0 for success or 1 for error.

## SEE ALSO
cache_check(8), cache_repair(8), cache_restore(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: cache_metadata_size(8)

text:
# cache_metadata_size(8)

## NAME
cache_metadata_size - Estimate the size of the metadata device needed for a given configuration.

## SYNOPSIS

```
cache_metadata_size [options]
```

## DESCRIPTION
cache_metadata_size estimates the size of the metadata. Either --nr-blocks, or --block-size and --device-size must be specified.

## OPTIONS
--nr-blocks {natural}

Specify the number of cache blocks.

--block-size {sectors}

Specify the size of each cache block in 512 byte sectors.

--device-size {sectors}

Specify total size of the fast device used in the cache. In 512 byte sectors.

--max-hint-width {nr bytes}

Specify hint width.

```
    Cache policies use a per block 'hint' to record extra info (for instance

    hit counts).  At the moment all policies use a 4 byte hint

    width.  If you want to use a different hint width specify it with this

    switch.
```

## EXAMPLE
$ cache_metadata_size --nr-blocks 10240

$ cache_metadata_size --block-size 128 --device-size 1024000

## SEE ALSO
cache_dump(8), cache_repair(8), cache_restore(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <heinzm@redhat.com>


title: cache_repair(8)

text:
# cache_repair(8)

## NAME
cache_repair - repair cache binary metadata from device/file to device/file.

## SYNOPSIS

```
cache_repair [options] -i {device|file} -o {device|file}
```

## DESCRIPTION
cache_repair reads binary cache metadata created by the respective device-mapper target from one device or file, repairs it and writes it to another device or file. If written to a metadata device, the metadata can be processed by the device-mapper target.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-i, --input {device|file}

Input file or device containing binary metadata.

-o, --output {device|file}

Output file or device for repaired binary metadata.

```
    If a file is then it must be preallocated, and large enough to hold the

    metadata.
```

## EXAMPLE
Reads the binary cache metadata from file metadata, repairs it and writes it to logical volume /dev/vg/metadata for further processing by the respective device-mapper target:

```
    $ cache_repair -i metadata -o /dev/vg/metadata
```

## DIAGNOSTICS
cache_repair returns an exit code of 0 for success or 1 for error.

## SEE ALSO
cache_dump(8), cache_check(8), cache_restore(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: cache_restore(8)

text:
# cache_restore(8)

## NAME
cache_restore - restore cache metadata file to device or file.

## SYNOPSIS

```
cache_restore [options] -i {xml file} -o {device|file}
```

## DESCRIPTION
cache_restore restores cache metadata created by the respective device-mapper target dumped into an XML formatted (see cache_dump(8)) file, which optionally can be preprocessed before the restore to another device or file. If restored to a metadata device, the metadata can be processed by the device-mapper target.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-q, --quiet

Don't print any output. Check the exit code to test for success.

-i, --input {xml file}

Input xml.

-o, --output {device|file}

Output file or device for restored binary metadata.

```
    If a file is used thin it must be preallocated, and large enough to hold

    the metadata.
```

--metadata-version {1|2}

Choose a metadata version.

## DEBUGGING OPTIONS
--debug-override-metadata-version {integer}

Override the version stored in the metadata.

--omit-clean-shutdown

Don't set the clean shutdown flag.

## EXAMPLE
Restores the XML formatted cache metadata on file metadata to logical volume /dev/vg/metadata for further processing by the respective device-mapper target:

```
    $ cache_restore -i metadata -o /dev/vg/metadata
```

## DIAGNOSTICS
cache_restore returns an exit code of 0 for success or 1 for error.

## SEE ALSO
cache_dump(8), cache_check(8), cache_repair(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: cache_writeback(8)

text:
# cache_writeback(8)

## NAME
cache_writeback - writeback dirty blocks to the origin device.

## SYNOPSIS

```
cache_writeback [options] --metadata-device {device|file} --origin-device {device|file} --fast-device {device|file}
```

## DESCRIPTION
cache_writeback is an offline tool that writes back dirty data to the data device (origin). Intended for use in recovery scenarios when the SSD is giving IO errors.

This tool cannot be run on a live cache.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

--metadata-device {device|file}

Location of cache metadata.

--origin-device {device|file}

Slow device being cached.

--fast-device {device|file}

Fast device containing the data that needs to be written back.

--no-metadata-update

Do not update the metadata to clear the dirty flags.

```
    You may want to use this flag if you're decommissioning the cache.
```

--buffer-size-meg {size}

Specify the size for the data cache, in megabytes.

```
    Defaults to 64 MiB, a larger size may improve performance.
```

--list-failed-blocks

List any blocks that failed the writeback process.

## SEE ALSO
cache_dump(8), cache_check(8), cache_repair(8), cache_restore(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: era_check(8)

text:
# era_check(8)

## NAME
era_check - validate era metadata on device or file.

## SYNOPSIS

```
era_check [options] {device|file}
```

## DESCRIPTION
era_check checks era metadata created by the device-mapper era target on a device or file.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-q, --quiet

Suppress output messages, return only exit code.

--super-block-only

Only check the superblock is present.

## EXAMPLE
Analyse thin provisioning metadata on logical volume /dev/vg/metadata:

```
    $ era_check /dev/vg/metadata
```

The device may not be actively used by the target when running.

## DIAGNOSTICS
era_check returns an exit code of 0 for success or 1 for error.

## SEE ALSO
era_dump(8), era_restore(8), era_invalidate(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: era_dump(8)

text:
# era_dump(8)

## NAME
era_dump - dump era metadata from device or file to standard output.

## SYNOPSIS

```
era_dump [options] {device|file}
```

## DESCRIPTION
era_dump dumps binary era metadata created by the device-mapper era target on a device or file to standard output for analysis or postprocessing in XML format. XML formatted metadata can be fed into era_restore (see era_restore(8)) in order to put it back onto a metadata device (to process by the device-mapper target) or file.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

--repair

Repair the metadata whilst dumping it.

--logical

Fold any unprocessed write sets into the final era array.

```
    You probably want to do this if you're intending to process the results as

    it simplifies the XML.
```

-o {xml file}

Specify a file for the output rather than writing to stdout.

## EXAMPLES
Dumps era metadata on logical volume /dev/vg/metadata to standard output in XML format:

```
    $ era_dump /dev/vg/metadata
```

## DIAGNOSTICS
era_dump returns an exit code of 0 for success or 1 for error.

## SEE ALSO
era_check(8), era_restore(8), era_invalidate(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: era_invalidate(8)

text:
# era_invalidate(8)

## NAME
era_invalidate - Provide a list of blocks that have changed since a particular era.

## SYNOPSIS

```
era_invalidate [options] {device|file}
```

## DESCRIPTION
era_invalidate examines era metadata and lists blocks that may have changed since a given era.

This tool cannot be run on live metadata unless the --metadata-snap option is used.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-o {output file}

Write output to a file rather than stdout.

--metadata-snapshot

Use the metadata snapshot rather than the current superblock.

--written-since {era nr}

Blocks written since the given era will be listed.

## EXAMPLE
List the blocks that may have been written since the beginning of era 13 on the metadata device /dev/vg/metadata:

```
    $ era_invalidate --written-since 13 /dev/vg/metadata
```

The device may not be actively used by the target when running.

## DIAGNOSTICS
era_invalidate returns an exit code of 0 for success or 1 for error (eg, metadata corruption).

## SEE ALSO
era_check(8), era_dump(8), era_restore(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: era_restore(8)

text:
# era_restore(8)

## NAME
era_restore - restore era metadata file to device or file.

## SYNOPSIS

```
era_restore [options] -i {xml file} -o {device|file}
```

## DESCRIPTION
era_restore restores era metadata created by the respective device-mapper target dumped into an XML formatted (see era_dump(8)) file, which optionally can be preprocessed before the restore to another device or file. If restored to a metadata device, the metadata can be processed by the device-mapper target.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-q, --quiet

Don't print any output. Check the exit code to test for success.

-i, --input {xml file}

Specify input file containing xml metadata.

-o, --output {device|file}

Output device or file for restored binary metadata.

```
    If a file is used, then it must be preallocated, and large enough to hold

    the metadata.
```

## EXAMPLE
Restores the XML formatted era metadata on file metadata to logical volume /dev/vg/metadata for further processing by the respective device-mapper target:

```
    $ era_restore -i metadata -o /dev/vg/metadata
```

## DIAGNOSTICS
era_restore returns an exit code of 0 for success or 1 for error.

## SEE ALSO
era_dump(8), era_check(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: thin_check(8)

text:
# thin_check(8)

## NAME
thin_check - validates thin provisioning metadata on a device or file

## SYNOPSIS

```
thin_check [options] {device|file}
```

## DESCRIPTION
thin_check checks thin provisioning metadata created by the device-mapper thin provisioning target on a device or file.

The tool cannot be run on live metadata unless the --metadata-snapshot option is used.

## OPTIONS
-q, --quiet

Suppress output messages, return only exit code.

-h, --help

Print help and exit.

-V, --version

Output version information and exit.

--super-block-only

Only check the superblock.

--skip-mappings

Skip checking of the block mappings which make up the bulk of the metadata.

--ignore-non-fatal-errors

Will only return a non-zero exit code if it finds a fatal error.

```
    An example of a nonfatal error is an incorrect data block reference count

    causing a block to be considered allocated when it in fact isn't.  Ignoring

    errors for a long time is not advised, you really should be using

    thin_repair to fix them.
```

--clear-needs-check-flag

Clears the 'needs_check' flag in the superblock.

```
    The kernel may set a flag to force the pool to be checked before it's next

    activated.  Set this switch to clear the flag if the check is successful.

    If the metadata check failed, the flag is not cleared and a thin_repair run

    is needed to fix any issues. After thin_repair succeeded, you may run

    thin_check again.
```

--metadata-snapshot, -m

Check the metadata snapshot.

```
    This will check the devices tree and mappings in a metadata snapshot.

    The snap does not contain space maps, so these will not be checked.  This

    may be used on live metadata.
```

--auto-repair

Automatically repair any trivial issues found with the metadata.

```
    Currently only fixes metadata leaks.
```

--override-mapping-root <block>

Specify a mapping root to use.

```
    Don't use this.  This overrides what's specified in the superblock.  Only

    use this if you really understand the metadata format and are trying to

    recover damaged metadata.
```

## EXAMPLE
Analyses thin provisioning metadata on logical volume /dev/vg/metadata:

```
    $ thin_check /dev/vg/metadata
```

The device must not be actively used by the target when running.

## DIAGNOSTICS
thin_check returns an exit code of 0 for success or 1 for error.

## SEE ALSO
thin_dump(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <heinzm@redhat.com>


title: thin_delta(8)

text:
# thin_delta(8)

## NAME
thin_delta - Print the differences in the mappings between two thin devices.

## SYNOPSIS

```
thin_delta [options] {device|file}
```

## DESCRIPTION
thin_delta allows you to compare the mappings in two thin volumes (snapshots allow common blocks between thin volumes).

This tool cannot be run on live metadata unless the --metadata-snap option is used.

## OPTIONS
--thin1, --snap1 {natural}

The numeric identifier for the first thin volume to diff.

--thin2, --snap2 {natural}

The numeric identifier for the second thin volume to diff.

--metadata-snap [block nr]

Use a metadata snapshot.

```
    If you want to get information out of a live pool then you will need to

    take a metadata snapshot and use this switch.  In order for the information

    to be meaningful, you need to ensure the thin volumes you're examining are

    not changing (ie, do not activate those thins).
```

--verbose

Provide extra information on the mappings.

-h, --help

Print help and exit.

-V, --version

Output version information and exit.

## SEE ALSO
thin_dump(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <heinzm@redhat.com>


title: thin_dump(8)

text:
# thin_dump(8)

## NAME
thin_dump - dump thin provisioning metadata from device or file to standard output.

## SYNOPSIS

```
thin_dump [options] {device|file}
```

## DESCRIPTION
thin_dump dumps binary thin provisioning metadata (optionally from alternate block; see option --metadata-snap) created by the device-mapper thin provisioning target on a device or file to standard output for analysis or postprocessing in either XML or human readable format. XML formatted metadata can be fed into thin_restore (see thin_restore(8)) in order to put it back onto a metadata device (to process by the device-mapper target) or file.

This tool cannot be run on live metadata unless the --metadata-snap option is used.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-f, --format {xml|human_readable}

Choose output format.

-r, --repair

Repair the metadata whilst dumping it.

-m, --metadata-snap[=<block nr>]

Dump metadata snapshot.

```
    If block is not provided, access the default metadata snapshot created by

    the thin provisioning device-mapper target, else try the one at block nr.

    See the thin provisioning target documentation on how to create or release

    a metadata snapshot and retrieve the block number from the kernel.
```

--dev-id {natural}

Dump the specified device.

```
    This option may be specified multiple times to select more than one thin

    device.
```

--transaction-id {natural}

Override the transaction id given in the input xml.

--data-block-size {sectors}

Override the data block size given in the input xml.

--nr-data-blocks {natural}

Override the nr data blocks given in the input xml.

--skip-mappings

Do not dump the mappings.

-o {xml file}

Specify a file for the output rather than writing to stdout.

## EXAMPLES
Dumps the thin provisioning metadata on logical volume /dev/vg/metadata to standard output in human readable format:

```
    $ thin_dump -f human_readable /dev/vg/metadata
```

Dumps the thin provisioning metadata on logical volume /dev/vg/metadata to standard output in XML format:

```
    $ thin_dump /dev/vg/metadata
```

Dumps the thin provisioning metadata snapshot on logical volume /dev/vg/metadata to standard output in human readable format (not processable by thin_restore(8)):

```
    $ thin_dump --format human_readable --metadata-snap /dev/vg/metadata
```

## DIAGNOSTICS
thin_dump returns an exit code of 0 for success or 1 for error.

## SEE ALSO
thin_check(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: thin_ls(8)

text:
# thin_ls(8)

## NAME
thin_ls - List thin volumes within a pool.

## SYNOPSIS

```
thin_ls [options] {device|file}
```

## DESCRIPTION
thin_ls displays information about thin volumes in a pool. Pass the metadata device on the command line, not the pool device.

This tool cannot be run on live metadata unless the --metadata-snap option is used.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-o, --format

Give a comma separated list of fields to be output.

```
    Valid fields are:

      DEV, MAPPED_BLOCKS, EXCLUSIVE_BLOCKS, SHARED_BLOCKS, HIGHEST_BLOCK,

      MAPPED_SECTORS, EXCLUSIVE_SECTORS, SHARED_SECTORS, HIGHEST_SECTOR,

      MAPPED_BYTES, EXCLUSIVE_BYTES, SHARED_BYTES, HIGHEST_BYTE, MAPPED,

      EXCLUSIVE, SHARED, HIGHEST_MAPPED, TRANSACTION, CREATE_TIME, SNAP_TIME
```

--no-headers

Don't output headers.

-m, --metadata-snap

Use metadata snapshot.

```
    If you want to get information out of a live pool then you will need to

    take a metadata snapshot and use this switch.
```

## SEE ALSO
thin_dump(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_trim(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: thin_metadata_pack(8)

text:
# thin_metadata_pack(8)

## NAME
thin_metadata_pack - pack thin provisioning binary metadata.

## SYNOPSIS

```
thin_metadata_pack [options] -i {device|file} -o {device|file}
```

## DESCRIPTION
thin_metadata_pack and thin_metadata_unpack are used to compress binary metadata. Useful for support.

thin_metadata_pack compresses the metadata, omitting any metadata blocks that are unused.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-i, --input {device|file}

Input file or device with binary data.

-o, --output {device|file}

Output file or device for binary data.

## SEE ALSO
thin_dump(8), thin_check(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: thin_metadata_size(8)

text:
# thin_metadata_size(8)

## NAME
thin_metadata_size - thin provisioning metadata device/file size calculator.

## SYNOPSIS

```
thin_metadata_size [options]
```

## DESCRIPTION
thin_metadata_size calculates the size of the thin provisioning metadata based on the block size of the thin provisioned devices, the size of the thin provisioning pool and the maximum number of all thin provisioned devices and snapshots. Because thin provisioning pools are holding widely variable contents, this tool is needed to provide sensible initial default size.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-b, --block-size {BLOCKSIZE[bskKmMgGtTpPeEzZyY]}

Set block size.

```
    Block size of thin provisioned devices in units of bytes, sectors,

    kibibytes, kilobytes, ... respectively. Default is in sectors without a

    block size unit specifier. Size/number option arguments can be followed by

    unit specifiers in short one character and long form (eg. -b1m or

    -b1mebibytes).
```

-s, --pool-size {POOLSIZE[bskKmMgGtTpPeEzZyY]}

Set pool size.

```
    Thin provisioning pool size in units of bytes, sectors, kibibytes,

    kilobytes, ... respectively. Default is in sectors without a pool size

    unit specifier.
```

-m, --max-thins {count[bskKmMgGtTpPeEzZyY]}

Set max thins.

```
    Maximum sum of all thin provisioned devices and snapshots. Unit identifier

    supported to allow for convenient entry of large quantities, eg. 1000000 =

    1M. Default is absolute quantity without a number unit specifier.
```

-u, --unit {bskKmMgGtTpPeEzZyY}

```
    Output unit specifier in units of bytes, sectors, kibibytes, kilobytes, ...

    respectively. Default is in sectors without an output unit specifier.
```

-n, --numeric-only {short|long}

Limit output to just the size number.

## EXAMPLES
Calculates the thin provisioning metadata device size for block size 64 kibibytes, pool size 1 tebibytes and maximum number of thin provisioned devices and snapshots of 1000 in units of sectors with long output:

```
    $ thin_metadata_size -b64k -s1t -m1000
```

Or (using the long options instead) for block size 1 gibibyte, pool size 1 petabyte and maximum number of thin provisioned devices and snapshots of 1 million with numeric-only output in units of gigabytes:

```
    $ thin_metadata_size --block-size=1g --pool-size=1P --max-thins=1M --unit=G --numeric-only
```

Same as before (1g, 1P, 1M, numeric-only) but with unit specifier character appended:

```
    $ thin_metadata_size --block-size=1gibi --pool-size=1petabytes --max-thins=1mega --unit=G --numeric-only=short
```

Or with unit specifier string appended:

```
    $ thin_metadata_size --block-size=1gibi --pool-size=1petabytes --max-thins=1mega --unit=G -nlong
```

## DIAGNOSTICS
thin_metadata_size returns an exit code of 0 for success or 1 for error.

## SEE ALSO
thin_dump(8), thin_check(8), thin_repair(8), thin_restore(8), thin_rmap(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: thin_metadata_unpack(8)

text:
# thin_metadata_unpack(8)

## NAME
thin_metadata_unpack - unpack thin provisioning binary metadata.

## SYNOPSIS

```
thin_metadata_unpack [options] -i {device|file} -o {device|file}
```

## DESCRIPTION
thin_metadata_pack and thin_metadata_unpack are used to compress binary metadata. Useful for support.

thin_metadata_unpack expands metadata that has previously been packed with thin_metadata_pack. It outputs a binary file that the rest of the thin tools can use.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-i, --input {device|file}

Input file or device with binary data.

-o, --output {device|file}

Output file or device for binary data.

## SEE ALSO
thin_dump(8), thin_check(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: thin_migrate(8)

text:
# thin_migrate(8)

## NAME
thin_migrate

## SYNOPSIS

```
thin_migrate [options] --source-dev {device} --dest-dev {device}
thin_migrate [options] --source-dev {device} --dest-file {file}
```

## DESCRIPTION
thin_migrate copies provisioned data blocks from a thin device to another device or file. It is designed for cloning a read-only snapshot or thin volume within a live thin-pool. A metadata snapshot is required to read the data mappings.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

--source-dev {device}

The input read-only thin device to copy.

--dest-dev {device}

The output device as the copy destination.

--dest-file {file}

The output file as the copy destination.

-q, --quit

Suppress output messages, return only exit code.

--buffer-size-meg {size}

Specify the size of the data buffers, in megabytes.

## EXAMPLE
Assuming that there's a thin snapshot 'vg/snap' to copy, we must first set the snapshot to read-only:

```
    $ lvchange vg/snap --permission r
```

Next, create a metadata snapshot for running thin_migrate:

```
    $ dmsetup message vg-mythinpool-tpool 0 reserve_metadata_snap
```

Once the metadata snapshot is created, copy the snapshot into another linear or thin volume. The destination volume must have the same size as the source device.

```
    $ thin_migrate --src-device /dev/vg/snap --dest-device /dev/vg2/dest
```

Alternatively, copy the snapshot into a file. thin_migrate can optionally create the destination file if it is not present, or the size of the file will be truncated to match that of the source device.

```
    $ thin_migrate --src-device /dev/vg/snap --dest-file dest.bin
```

Finally, release the metadata snapshot after thin_migrate finishes its job:

```
    $ dmsetup message vg-mythinpool-tpool 0 release_metadata_snap
```

## DIAGNOSTICS
thin_migrate returns an exit code of 0 for success or 1 for error.

## AUTHOR
Joe Thornber <ejt@redhat.com>


title: thin_repair(8)

text:
# thin_repair(8)

## NAME
thin_repair - repair thin provisioning binary metadata.

## SYNOPSIS

```
thin_repair [options] -i {device|file} -o {device|file}
```

## DESCRIPTION
thin_repair reads binary thin provisioning metadata created by the respective device-mapper target from one device or file, repairs it and writes it to different device or file. If written to a metadata device, the metadata can be processed by the device-mapper target.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-i, --input {device|file}

Input file or device with binary data.

-o, --output {device|file}

Output file or device for binary data.

```
    If a file is used for output, then it must be preallocated, and large

    enough to hold the metadata.
```

--transaction-id {natural}

Override the transaction id given in the input xml.

--data-block-size {natural}

Override the data block size given in the input xml.

--nr-data-blocks {natural}

Override the nr data blocks given in the input xml.

## EXAMPLE
Reads the binary thin provisioning metadata from file metadata, repairs it and writes it to logical volume /dev/vg/metadata for further processing by the respective device-mapper target:

```
    $ thin_repair -i metadata -o /dev/vg/metadata
```

## DIAGNOSTICS
thin_repair returns an exit code of 0 for success or 1 for error.

## SEE ALSO
thin_dump(8), thin_check(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: thin_restore(8)

text:
# thin_restore(8)

## NAME
thin_restore - restore thin provisioning metadata file to device or file.

## SYNOPSIS

```
thin_restore [options] -i {xml file} -o {device|file}
```

## DESCRIPTION
thin_restore restores thin provisioning metadata created by the respective device-mapper target dumped into an XML formatted (see thin_dump(8)) file, which optionally can be preprocessed before the restore to another device or file. If restored to a metadata device, the metadata can be processed by the device-mapper target.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

-q, --quiet

Suppress output messages, return only exit code.

-i, --input {xml file}

Input file containing XML metadata.

-o, --output {device|file}

Output file or device for restored binary metadata.

```
    If a file is used for output, then it must be preallocated, and large

    enough to hold the metadata.
```

--transaction-id {natural}

Override the transaction id given in the input xml.

--data-block-size {natural}

Override the data block size given in the input xml.

--nr-data-blocks {natural}

Override the nr data blocks given in the input xml.

## EXAMPLE
Restores the XML formatted thin provisioning metadata on file metadata to logical volume /dev/vg/metadata for further processing by the respective device-mapper target:

```
    $ thin_restore -i metadata -o /dev/vg/metadata
```

## DIAGNOSTICS
thin_restore returns an exit code of 0 for success or 1 for error.

## SEE ALSO
thin_dump(8), thin_check(8), thin_repair(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: thin_rmap(8)

text:
# thin_rmap(8)

## NAME
thin_rmap - output reverse map of a thin provisioned region of blocks from metadata device or file.

## SYNOPSIS

```
thin_rmap [options] {device|file}
```

## DESCRIPTION
thin_rmap outputs the reverse mapping stored in the metadata on a device or file between a region of thin provisioned pool blocks and the associated thin provisioned devices.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

--region {block range}

Specify range of blocks on the data device.

```
    At least one region must be specified.  Multiple regions may be specified.

    The range takes the format <begin>..<one past the end>.  For example,

    "5..45" specifies data blocks 5 to 44 inclusive, but not 45.
```

## EXAMPLES
$ thin_rmap --region 5..45 /dev/pool-metadata

## DIAGNOSTICS
thin_rmap returns an exit code of 0 for success or 1 for error.

## SEE ALSO
thin_check(8), thin_dump(8), thin_repair(8), thin_restore(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>, Heinz Mauelshagen <HeinzM@RedHat.com>


title: thin_trim(8)

text:
# thin_trim(8)

## NAME
thin_trim - Issue discard requests for free pool space (offline tool).

## SYNOPSIS

```
thin_trim [options] --metadata-dev {device|file} --data-dev {device|file}
```

## DESCRIPTION
thin_trim sends discard requests to the pool device for unprovisioned areas.

This tool cannot be run on live metadata.

## OPTIONS
-h, --help

Print help and exit.

-V, --version

Print version information and exit.

## SEE ALSO
thin_dump(8), thin_repair(8), thin_restore(8), thin_rmap(8), thin_metadata_size(8)

## AUTHOR
Joe Thornber <ejt@redhat.com>


vncsession

package: tigervnc-server

title: vncsession(8)

summary: start a VNC server

text:
# vncsession(8)

## NAME
vncsession - start a VNC server

## SYNOPSIS
vncsession [-D] <username> <:display#>

## DESCRIPTION
vncsession is used to start a VNC (Virtual Network Computing) desktop. vncsession performs all the necessary steps to create a new user session, run Xvnc with appropriate options and starts a window manager on the VNC desktop.

vncsession is rarely called directly and is normally started by the system service manager.

## -D OPTION
vncsession by default forks and detaches. If the -D option is used, it does not fork and detach. This option is provided for use with system service managers that require services to run in the foreground. This option is not intended for debugging in a login shell from a terminal or for running vncsession from a terminal as an ordinary user.

## FILES
Several VNC-related files are found in the directory $HOME/.config/tigervnc:

/etc/tigervnc/vncserver-config-defaults

The optional system-wide equivalent of $HOME/.config/tigervnc/config. If this file exists and defines options to be passed to Xvnc, they will be used as defaults for users. The user's $HOME/.config/tigervnc/config overrides settings configured in this file. The overall configuration file load order is: this file, $HOME/.config/tigervnc/config, and then /etc/tigervnc/vncserver-config-mandatory. None are required to exist.

/etc/tigervnc/vncserver-config-mandatory

The optional system-wide equivalent of $HOME/.config/tigervnc/config. If this file exists and defines options to be passed to Xvnc, they will override any of the same options defined in a user's $HOME/.config/tigervnc/config. This file offers a mechanism to establish some basic form of system-wide policy. WARNING! There is nothing stopping users from constructing their own vncsession-like script that calls Xvnc directly to bypass any options defined in /etc/tigervnc/vncserver-config-mandatory. The overall configuration file load order is: /etc/tigervnc/vncserver-config-defaults, $HOME/.config/tigervnc/config, and then this file. None are required to exist.

$XDG_CONFIG_HOME/tigervnc/config

$HOME/.config/tigervnc/config

An optional server config file wherein options to be passed to Xvnc are listed to avoid hard-coding them to the physical invocation. List options in this file one per line. For those requiring an argument, simply separate the option from the argument with an equal sign, for example: "geometry=2000x1200" or "securitytypes=vncauth,tlsvnc". Options without an argument are simply listed as a single word, for example: "localhost" or "alwaysshared". The special option session can be used to control which session type will be started. This should match one of the files in /usr/share/xsessions. E.g. if there is a file called "gnome.desktop", then "session=gnome" would be set to use that session type.

$XDG_CONFIG_HOME/tigervnc/passwd

$HOME/.config/tigervnc/passwd

The VNC password file.

$XDG_STATE_HOME/tigervnc/Bhost:Bdisplay#.log

$HOME/.local/state/tigervnc/Bhost:Bdisplay#.log

The log file for Xvnc and the session.

## SEE ALSO
vncviewer(1), vncpasswd(1), vncconfig(1), Xvnc(1)

https://www.tigervnc.org

## AUTHOR
Tristan Richardson, RealVNC Ltd., D. R. Commander and others.

VNC was originally developed by the RealVNC team while at Olivetti Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were implemented by Constantin Kaplinsky. Many other people have since participated in development, testing and support. This manual is part of the TigerVNC software suite.


timeoutd

package: timeoutd

title: timeoutd(8)

text:
# timeoutd(8)

## NAME
timeoutd - Enforce idle and session time restrictions

## SYNOPSIS
/usr/sbin/timeoutd [ user tty ]

## DESCRIPTION
timeoutd enforces the time restrictions specified in /etc/timeoutd/timeouts. When invoked in daemon mode (without any parameters) timeoutd backgrounds itself, then scans /var/run/utmp every minute and checks /etc/timeoutd/timeouts for an entry which matches that user, based on:

- The current day and time

- The tty that the user is currently logged in on

- The user's login ID

- Any primary or secondary groups the user is in

If a match is found, the limits specified for that entry are enforced by sending a SIGHUP (Hangup signal) to the user's login process, followed after 5 seconds by a SIGKILL (Sure kill signal) to ensure the user is logged out.

Where possible, timeoutd will send a warning to the user every minute for 5 minutes (or other time specified in /etc/timeoutd/timeouts) before logging them out. Warnings are not sent for exceeded idle limits, as this would count as activity on the terminal.

Timeoutd currently allows limits to be set on idle time as well as amount of time logged in per session and per day.

When calculating idle time, any activity on the terminal, either incoming (such as typing) or outgoing (such as information displayed on the screen) is counted as activity. This is to prevent log-offs during file transfers.

Under Linux, timeoutd detects when a serial line is in SLIP mode and disables idle time limit checking (as the last read/write times for the tty are not updated).

Debug information, error messages and notification of users who have been timed out are all recorded via syslog (facility=DAEMON).

timeoutd can also be invoked by login to check whether a user is allowed to login at that time, or whether they have exceeded their daily time limit. When invoked in this way, by passing a username and tty (without the leading /dev) on the command line, timeoutd returns one of the following exit codes:

0 User is allowed to login

1 Fatal error

5 Incorrect command line format

10 User has exceeded maximum daily connect time

20 User not permitted to login at this time on this tty

30 Internal error checking user name (probably invalid user name)

## FILES
/etc/timeoutd/timeouts - lists valid login times and idle/session time restrictions

/var/run/utmp - current login sessions

/var/log/wtmp - for calculating total logged in time for current day

## BUGS
Sessions which end in the current day but started before midnight will not be considered when calculating total daily logged in time for a user on that day. This will not, however, affect checking of the session limit, which should limit such problems. It does mean that a user could conceivably exceed their maximum daily time by one extra session if they log on just before midnight.

## SEE ALSO
timeouts(5)

## WRITTEN BY
Originally written by Shane Alderton <shanea@bigpond.net.au>, updated by Dennis Stampfer <seppy@debian.org>.


tincd

package: tinc

title: tincd(8)

summary: tinc VPN daemon

text:
# tincd(8)

## NAME
tincd — tinc VPN daemon

## SYNOPSIS
tincd

[-cdDkKnoLRU] [--config=DIR] [--no-detach] [--debug[=LEVEL]] [--kill[=SIGNAL]] [--net=NETNAME] [--generate-keys[=BITS]] [--option=[HOST.]KEY=VALUE] [--mlock] [--logfile[=FILE]] [--pidfile=FILE] [--bypass-security] [--chroot] [--user=USER] [--help] [--version]

## DESCRIPTION
This is the daemon of tinc, a secure virtual private network (VPN) project. When started, tincd will read it's configuration file to determine what virtual subnets it has to serve and to what other tinc daemons it should connect. It will connect to the ethertap or tun/tap device and set up a socket for incoming connections. Optionally a script will be executed to further configure the virtual device. If that succeeds, it will detach from the controlling terminal and continue in the background, accepting and setting up connections to other tinc daemons that are part of the virtual private network. Under Windows (not Cygwin) tinc will install itself as a service, which will be restarted automatically after reboots.

## OPTIONS
-c, --config=DIR

Read configuration files from DIR instead of /etc/tinc/.

-D, --no-detach

Don't fork and detach. This will also disable the automatic restart mechanism for fatal errors. If not mentioned otherwise, this will show log messages on the standard error output.

-d, --debug[=LEVEL]

Increase debug level or set it to LEVEL (see below).

-k, --kill[=SIGNAL]

Attempt to kill a running tincd (optionally with the specified SIGNAL instead of SIGTERM) and exit. Under Windows (not Cygwin) the optional argument is ignored, the service will always be stopped and removed.

-n, --net=NETNAME

Connect to net NETNAME. This will let tinc read all configuration files from /etc/tinc/ NETNAME. Specifying . for NETNAME is the same as not specifying any NETNAME.

-K, --generate-keys[=BITS]

Generate public/private RSA keypair and exit. If BITS is omitted, the default length will be 2048 bits. When saving keys to existing files, tinc will not delete the old keys, you have to remove them manually.

-o, --option=[HOST.]KEY=VALUE

Without specifying a HOST, this will set server configuration variable KEY to VALUE. If specified as HOST.KEY=VALUE, this will set the host configuration variable KEY of the host named HOST to VALUE. This option can be used more than once to specify multiple configuration variables.

-L, --mlock

Lock tinc into main memory. This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.

--logfile[=FILE]

Write log entries to a file instead of to the system logging facility. If FILE is omitted, the default is /var/log/tinc.NETNAME.log.

--pidfile=FILE

Write PID to FILE instead of /var/run/tinc.NETNAME.pid. Under Windows this option will be ignored.

--bypass-security

Disables encryption and authentication of the meta protocol. Only useful for debugging.

-R, --chroot

With this option tinc chroots into the directory where network config is located (/etc/tinc/NETNAME if -n option is used, or to the directory specified with -c option) after initialization.

-U, --user=USER

setuid to the specified USER after initialization.

--help

Display short list of options.

--version

Output version information and exit.

## SIGNALS
ALRM

Forces tincd to try to connect to all uplinks immediately. Usually tincd attempts to do this itself, but increases the time it waits between the attempts each time it failed, and if tincd didn't succeed to connect to an uplink the first time after it started, it defaults to the maximum time of 15 minutes.

HUP

Partially rereads configuration files. Connections to hosts whose host config file are removed are closed. New outgoing connections specified in tinc.conf will be made. If the --logfile option is used, this will also close and reopen the log file, useful when log rotation is used.

INT

Temporarily increases debug level to 5. Send this signal again to revert to the original level.

USR1

Dumps the connection list to syslog.

USR2

Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.

WINCH

Purges all information remembered about unreachable nodes.

## DEBUG LEVELS
The tinc daemon can send a lot of messages to the syslog. The higher the debug level, the more messages it will log. Each level inherits all messages of the previous level:

0

This will log a message indicating tincd has started along with a version number. It will also log any serious error.

1

This will log all connections that are made with other tinc daemons.

2

This will log status and error messages from scripts and other tinc daemons.

3

This will log all requests that are exchanged with other tinc daemons. These include authentication, key exchange and connection list updates.

4

This will log a copy of everything received on the meta socket.

5

This will log all network traffic over the virtual private network.

## FILES
/etc/tinc/

Directory containing the configuration files tinc uses. For more information, see tinc.conf(5).

/var/run/tinc.NETNAME.pid

The PID of the currently running tincd is stored in this file.

## BUGS
The BindToInterface option may not work correctly.

The cryptography in tinc is not well tested yet. Use it at your own risk!

If you find any bugs, report them to tinc@tinc-vpn.org.

## TODO
A lot, especially security auditing.

## SEE ALSO
tinc.conf(5), https://www.tinc-vpn.org/, http://www.cabal.org/.

The full documentation for tinc is maintained as a Texinfo manual. If the info and tinc programs are properly installed at your site, the command info tinc should give you access to the complete manual.

tinc comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions; see the file COPYING for details.

## AUTHORS
Ivo Timmermans

Guus Sliepen ⟨guus@tinc-vpn.org⟩

And thanks to many others for their contributions to tinc!


tinyproxy

package: tinyproxy

title: tinyproxy(8)

summary: A light\-weight HTTP proxy daemon

text:
# tinyproxy(8)

## NAME
tinyproxy - A light-weight HTTP proxy daemon

## SYNOPSIS
tinyproxy [-vdch]

## DESCRIPTION
tinyproxy is a light-weight HTTP proxy daemon designed to consume a minimum amount of system resources. It listens on a given TCP port and handles HTTP proxy requests. Designed from the ground up to be fast and yet small, it is an ideal solution for use cases such as embedded deployments where a full featured HTTP proxy is required, but the system resources for a larger proxy are unavailable.

## OPTIONS
tinyproxy accepts the following options:

-c <config-file>

Use an alternate configuration file.

-d

Don't daemonize and stay in the foreground. Useful for debugging purposes.

-h

Display a short help screen of command line arguments and exit.

-v

Display version information and exit.

## SIGNALS
In addition to command-line options, there are also several signals that can be sent to tinyproxy while it is running to generate debugging information and to force certain events.

SIGHUP

Force Tinyproxy to do a garbage collection on the current connections linked list. This is usually done automatically after a certain number of connections have been handled. (Daemon mode only)

SIGUSR1

Force reload of config file and filter list. This is handy to update the configuration if Tinyproxy is running in foreground without dropping active connections.

## TEMPLATE FILES
There are two occasions when Tinyproxy delivers HTML pages to the client on it's own right:

- When an error occurred, a corresponding error page is returned.

- When a request for the stathost is made, a page summarizing the connection statistics is returned. (See STATHOST below.)

The layout of both error pages and the statistics page can be controlled via configurable HTML template files that are plain HTML files that additionally understand a few template variables.

## TEMPLATE VARIABLES
There are several standard HTML variables that are available in every template file:

request

The full HTTP request line.

cause

The abbreviated cause of the error condition.

clientip

The IP address of the client making the request.

clienthost

The hostname of the client making the request.

version

The version of Tinyproxy.

package

The package name. Presently, resolves to 'tinyproxy'.

date

The current date/time in HTTP format.

In addition, almost all templates support:

detail

A detailed, plain English explanation of the error and possible causes.

When Tinyproxy finds a variable name enclosed in braces, e.g. "{request}", then this is replaced by the value of the corresponding variable before delivery of the page.

## STATHOST
Tinyproxy returns a HTML page with connection statistics when it receives a HTTP request for a certain host -- the stathost. The stathost name defaults to `tinyproxy.stats` and can be changed at runtime to any name or IP address with the configuration variable `StatHost`.

The stat file template can be changed at runtime through the configuration variable `StatFile`.

## FILES
/etc/tinyproxy/tinyproxy.conf

/var/run/tinyproxy/tinyproxy.pid

/var/log/tinyproxy/tinyproxy.log

## BUGS
To report bugs in Tinyproxy, please visit <https://tinyproxy.github.io/>.

## SEE ALSO
tinyproxy.conf(5)

## AUTHOR
This manpage was written by the Tinyproxy project team.

## COPYRIGHT
Copyright (c) 1998-2020 the Tinyproxy authors.

This program is distributed under the terms of the GNU General Public License version 2 or above. See the COPYING file for additional information.


tinysshd

package: tinyssh

title: tinysshd(8)

summary: Tiny SSH daemon

text:
# tinysshd(8)

## NAME
tinysshd - Tiny SSH daemon

## SYNOPSIS
tinysshd [ options ] keydir

## DESCRIPTION
tinysshd is a minimalistic SSH server which implements only a subset of SSHv2 features.

tinysshd supports only secure cryptography (minimum 128-bit security, protected against cache-timing attacks)

tinysshd doesn't implement older crypto (such as RSA, DSA, HMAC-MD5, HMAC-SHA1, 3DES, RC4, ...)

tinysshd doesn't implement unsafe features (such as password or hostbased authentication)

tinysshd doesn't have features such: SSH1 protocol, compression, port forwarding, agent forwarding, X11 forwarding ...

tinysshd doesn't use dynamic memory allocation (no allocation failures, etc.)

## OPTIONS
-q

no error messages

-Q

print error messages (default)

-v

print extra information

-s

enable state-of-the-art crypto (default) signing - ssh-ed25519

key-exchange - curve25519-sha256

symmetric - chacha20-poly1305@openssh.com

-S

disable state-of-the-art crypto

-p

enable post-quantum crypto (default) signing - TODO (not implemented yet)

key-exchange - sntrup761x25519-sha512@openssh.com

symmetric - chacha20-poly1305@openssh.com

-P

disable post-quantum crypto

-l

use syslog instead of standard error output (useful for running from inetd)

-L

don't use syslog, use standard error output (default)

-x name=command

add subsystem command (e.g.: sftp=/usr/libexec/openssh/sftp-server)

-e command

execute the given command instead of spawning the shell (disables exec/subsystem channel requests)

keydir

directory containing TinySSH keys, typically /etc/tinyssh/sshkeydir

## AUTHORIZATION
tinysshd supports only public-key authorization via AuthorizedKeysFile ~/.ssh/authorized_keys. Each line of the file contains one key in format "keytype base64-encoded-key comment". tinyssh supports only "ssh-ed25519" keytype.

~/.ssh/authorized_keys example:

```
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILV5AGhGQ1QVXjBWhTKJP3vrqE3isL4ivisBailQ14gS comment
```

## RUNNING
TCPSERVER

tcpserver -HRDl0 0.0.0.0 22 /usr/sbin/tinysshd -v /etc/tinyssh/sshkeydir &

BUSYBOX

busybox tcpsvd 0 22 tinysshd -v /etc/tinyssh/sshkeydir &

INETD

/etc/inetd.conf: ssh stream tcp nowait root /usr/sbin/tinysshd tinysshd -l -v /etc/tinyssh/sshkeydir

SYSTEMD

tinysshd.socket:

```
[Unit]
Description=TinySSH server socket
ConditionPathExists=!/etc/tinyssh/disable_tinysshd
[Socket]
ListenStream=22
Accept=yes
[Install]
WantedBy=sockets.target
```

tinysshd@.service:

```
[Unit]
Description=Tiny SSH server
After=network.target auditd.service
[Service]
ExecStartPre=-/usr/sbin/tinysshd-makekey -q /etc/tinyssh/sshkeydir
EnvironmentFile=-/etc/default/tinysshd
ExecStart=/usr/sbin/tinysshd ${TINYSSHDOPTS} -- /etc/tinyssh/sshkeydir
KillMode=process
SuccessExitStatus=111
StandardInput=socket
StandardError=journal
[Install]
WantedBy=multi-user.target
```

## SEE ALSO
tinysshd-makekey(8), tinysshd-printkey(8)

```
https://tinyssh.org/
```


tinysshd-makekey

title: tinysshd-makekey(8)

summary: create TinySSH key\-directory

text:
# tinysshd-makekey(8)

## NAME
tinysshd-makekey - create TinySSH key-directory

## SYNOPSIS
tinysshd-makekey [ options ] keydir

## DESCRIPTION
tinysshd-makekey safely creates secret-keys and appropriate public-keys in directory keydir

## OPTIONS
-q

no error messages

-Q

print error messages (default)

keydir

directory for TinySSH keys, typically /etc/tinyssh/sshkeydir

## EXAMPLE
tinysshd-makekey /etc/tinyssh/sshkeydir

## SEE ALSO
tinysshd(8), tinysshd-printkey(8)

```
https://tinyssh.org/
```


tinysshd-printkey

title: tinysshd-printkey(8)

summary: print TinySSH public\-keys

text:
# tinysshd-printkey(8)

## NAME
tinysshd-printkey - print TinySSH public-keys

## SYNOPSIS
tinysshd-printkey keydir

## DESCRIPTION
tinysshd-printkey prints TinySSH public-keys in base64 format

## OPTIONS
keydir

directory containing TinySSH keys, typically /etc/tinyssh/sshkeydir

## EXAMPLE
tinysshd-printkey /etc/tinyssh/sshkeydir

## SEE ALSO
tinysshd(8), tinysshd-makekey(8)

```
https://tinyssh.org/
```


tinysshnoneauthd

title: tinysshnoneauthd(8)

text:
# tinysshnoneauthd(8)

## NAME
tinysshnoneauthd - Tiny SSH daemon with 'none' auth. enabled

## SYNOPSIS
tinysshnoneauthd [ options ] keydir

## DESCRIPTION
tinysshnoneauthd creates encrypted (but not auhenticated) SSH connection. It's used to protect older protocols which uses e.g. telnet etc.

## OPTIONS
-q

no error messages

-Q

print error messages (default)

-v

print extra information

-l

use syslog instead of standard error output (useful for running from inetd)

-L

don't use syslog, use standard error output (default)

-e command

execute the given command instead of spawning the shell (disables exec/subsystem channel requests)

keydir

directory containing TinySSH keys, typically /etc/tinyssh/sshkeydir

## EXAMPLES
TCPSERVER

```
useradd tinysshnoneauth
mkdir -p /home/tinysshnoneauth/
tinysshd-makekey /home/tinysshnoneauth/sshkeydir
chown -R tinysshnoneauth /home/tinysshnoneauth/sshkeydir
envuidgid tinysshnoneauth tcpserver -UHRDl0 0 2222 /usr/sbin/tinysshnoneauthd -vv -e 'cat /etc/motd' /home/tinysshnoneauth/sshkeydir
```

## SEE ALSO
tinysshd(8), tinysshd-makekey(8), tinysshd-printkey(8)

```
https://tinyssh.org/
```


tlp

package: tlp

title: tlp(8)

text:
# tlp(8)

## NAME
tlp - apply laptop power saving settings

## SYNOPSIS
tlp command [parameters] [-- CONFIG_PARAM=value ... ]

## DESCRIPTION
tlp applies power saving settings manually and controls battery care features.

## COMMANDS
start

Start tlp and apply power saving profile for the actual power source. Also use to apply a changed configuration or to leave manual mode.

bat

Apply battery profile and enter manual mode. Manual mode means that changes to the power source will be ignored until the next reboot or tlp start is issued to resume automatic mode.

true

Alias for bat.

ac

Apply AC profile and enter manual mode. Manual mode means that changes to the power source will be ignored until the next reboot or tlp start is issued to resume automatic mode.

false

Alias for ac.

usb

Enable autosuspend for all USB devices except those excluded by default or via configuration.

bayoff

Turn off optical drive in UltraBay/MediaBay. The drive may be re-enabled by pulling the eject lever or pushing the media eject button on newer models.

setcharge [start_threshold stop_threshold] [battery]

Change battery charge thresholds temporarily. If your hardware supports only a stop threshold, set the start value to 0. Configured charge thresholds will be restored at the next boot or by using tlp setcharge again but without the threshold arguments.

fullcharge [battery]

Charge battery to full capacity. This is done by applying vendor presets to the charge thresholds temporarily. Configured charge thresholds will be restored at the next boot or by using tlp setcharge without the threshold arguments.

chargeonce [battery]

Charge battery to the stop charge threshold once. This is done by temporarily lifting the start charge threshold. The configured start charge threshold will be restored at the next boot or by using tlp setcharge without the threshold arguments.

discharge [battery] [target_charge_level]

Force a complete or partial discharge of the battery while on AC power.

recalibrate [battery]

Perform a battery recalibration while on AC power: completely discharge the battery and recharge to 100%. The latter is done by temporarily applying vendor presets to the thresholds. Configured thresholds will be restored at the next boot or by using tlp setcharge.

diskid

Print disk ids for configured drives.

--version

Print TLP version.

-- CONFIG_PARAM=value ...

Append configuration parameters to a command. These temporarily override the system configuration during execution of that command only and are not kept afterwards. Disclaimer: this feature exists for the sole purpose of test automation during TLP's development. It is provided as is and there is no support whatsoever.

## NOTES
Availability of the above battery care commands and the possible charge threshold values always depend on laptop vendor or brand, Linux kernel version and TLP version. Check for actual availability, threshold ranges and battery names with tlp-stat -b. Follow the link in the SEE ALSO section for details.

For laptops with two batteries, the secondary battery must be specified as a command parameter in order to select it. In many cases the main battery will be BAT0, the secondary battery BAT1. When in doubt, the output of tlp-stat -b, which lists all batteries, can help.

## EXAMPLES
Change thresholds of the main battery to 70 / 90% temporarily:

tlp setcharge 70 90

Charge the secondary battery to full capacity:

tlp fullcharge BAT1

Recalibrate the main battery:

tlp recalibrate

## FILES
/etc/tlp.conf

System-wide user configuration file, uncomment parameters here to override default settings and customization files below.

/etc/tlp.d/*.conf

System-wide drop-in customization files, overriding defaults below.

/usr/share/tlp/defaults.conf

Intrinsic default settings. DO NOT EDIT this file, instead use one of the above alternatives.

/run/tlp/run.conf

Effective settings consolidated from all above files. DO NOT CHANGE this file, it is for reference only and regenerated on every invocation of TLP.

/etc/default/tlp

Obsolete system-wide configuration file. DO NOT USE this file, it is evaluated only when /etc/tlp.conf is non-existent.

## EXIT STATUS
On success, 0 is returned, a non-zero failure code otherwise.

## SEE ALSO
tlp-stat(8), bluetooth(1), nfc(1), wifi(1), wwan(1).

## AUTHOR
(c) 2025 Thomas Koch <linrunner at gmx.net>


tlp-stat

title: tlp-stat(8)

text:
# tlp-stat(8)

## NAME
tlp-stat - view power saving status

## SYNOPSIS
tlp-stat [options] [-- CONFIG_PARAM=value ... ]

## DESCRIPTION
View configuration, system information, kernel power saving tunables and battery data. Invocation without options shows all information categories.

## OPTIONS
-b, --battery

View battery data. Add -v to see battery voltages (if available).

-c, --config

View active configuration.

--cdiff

View the difference between defaults and user configuration.

-d, --disk

View disk device information.

-e, --pcie

View PCIe device information. Add -v to see device runtime status.

-g, --graphics

View graphics card information.

-m, --mode

Print current power mode.

-p, --processor

View processor information. For clarity the standard output shows only cpu0. Add -v to see all cpus. Add -q to see cpu driver state only.

-q, --quiet

Omit version header and show less information in the processor category.

-r, --rfkill

View radio device states.

-s, --system

View system information and TLP status.

-t, --temp

View temperatures and fan speed.

-u, --usb

View USB device information. Add -v to see device runtime status.

-v, --verbose

Show more information in the battery, PCIe, processor and USB categories.

--version

Print TLP version.

Diagnostics and debugging:

-P, --pev

Monitor power supply udev events.

--psup

View power supply diagnostics.

-T, --trace

View trace output.

--udev

Check if udev rules for power source changes and connecting USB devices are active.

-w, --warn

View warnings about SATA disks.

-- CONFIG_PARAM=value ...

Append configuration parameters to a command. These temporarily override the system configuration during execution of that command only and are not kept afterwards. Disclaimer: this feature exists for the sole purpose of test automation during TLP's development. It is provided as is and there is no support whatsoever.

## FILES
/etc/tlp.conf

System-wide user configuration file, uncomment parameters here to override default settings and customization files below.

/etc/tlp.d/*.conf

System-wide drop-in customization files, overriding defaults below.

/usr/share/tlp/defaults.conf

Intrinsic default settings. DO NOT EDIT this file, instead use one of the above alternatives.

/run/tlp/run.conf

Effective settings consolidated from all above files. DO NOT CHANGE this file, it is for reference only and regenerated on every invocation of TLP.

/etc/default/tlp

Obsolete system-wide configuration file. DO NOT USE this file, it is evaluated as fallback only when /etc/tlp.conf is non-existent.

## SEE ALSO
tlp(8).

## AUTHOR
(c) 2025 Thomas Koch <linrunner at gmx.net>


tlp.service

title: tlp.service(8)

text:
# tlp.service(8)

## NAME
tlp.service - Initialize power saving at boot and cleanup upon shutdown

## SYNOPSIS
tlp.service

## DESCRIPTION
tlp.service executes the following tasks:

1.

System boot-up: switch or restore radio states, apply power saving settings and charge thresholds.

2.

System shutdown: save radio states and cleanup.

## FILES
/lib/systemd/system-sleep/tlp

Applies power saving settings upon system suspend and resume.

## SEE ALSO
tlp(8).

## NOTES
Do not employ tlp.service to refresh power saving settings after a configuration change. Use tlp start instead.

## SEE ALSO
tlp(8).

## AUTHOR
(c) 2025 Thomas Koch <linrunner at gmx.net>


tlp-rdw

package: tlp-rdw

title: tlp-rdw(8)

text:
# tlp-rdw(8)

## NAME
tlp-rdw - disable Radio Device Wizard temporarily (until reboot).

## SYNOPSIS
tlp-rdw [command]

## COMMANDS
disable

Disable RDW actions.

enable

Enable RDW actions.

<none>

Show RDW state.

--version

Print TLP version.

## SEE ALSO
tlp(8).

## AUTHOR
(c) 2024 Thomas Koch <linrunner at gmx.net>


tntnet

package: tntnet

title: tntnet(8)

summary: web application server for c++

text:
# tntnet(8)

## NAME
tntnet - web application server for c++

## SYNOPSIS
tntnet [-c file] [--logall]

tntnet-C [-q query-string] componentId ...

## DESCRIPTION
This manual page documents briefly the tntnet command.

tntnet is a web server that can generate dynamic content via precompiled C++ modules.

## OPTIONS
A summary of options is included below.

-c file

Use file as the configuration file. If the -c is omitted, the first nonoption argument is used as the config file.

--logall

Initialize logging earlier. Normally logging is initialized after starting the listeners and changing user so that logfiles are created with the right owner. For debugging reasons this option forces to do that earlier.

-C

Call components and print the result to stdout instead of starting tntnet as a webserver

-q query-string

In -C mode pass this query string to the component. The option may be repeated multiple times to pass name-value-pairs easily.

## EXAMPLE
tntnet -C -q arg1=35 -q arg2=7 -q op=/ calc@calc

calls the component calc@calc with query parameters and prints the result to stdout.

## FILES
/etc/tntnet/tntnet.xml

The default configuration file.

## ENVIRONMENT
TNTNET_CONF

This is checked for the configuration file name if it is not specified on the command line.

## AUTHOR
tntnet was written by Tommi Mäkitalo tommi@tntnet.org.

This manual page was written by Kari Pahula kaol@debian.org, for the Debian project (but may be used by others).

## SEE ALSO
tntnet-config(1), ecpp(7), ecppc(1), ecppl(1), ecppll(1), tntnet.xml(7), tntnet.properties(7), Tntnet homepage http://www.tntnet.org. More documentation can be found in /usr/share/doc/tntnet-doc/.

Tntnet July 23, 2006 tntnet(8)


pbsnodes

package: torque-client

title: pbsnodes(8)

summary: pbs node manipulation

text:
# pbsnodes(8)

## NAME
pbsnodes - pbs node manipulation

## SYNOPSIS
pbsnodes [-{a|x}] [-q] [-s server] [node|:property]

pbsnodes -l [-q] [-s server] [state] [nodename|:property ...]

pbsnodes [-{c|d|o|r}] [-q] [-s server] [-n] [-N "note"] [-A "append note"] [node|:property]

## DESCRIPTION
The pbsnodes command is used to mark nodes down, free or offline. It can also be used to list nodes and their state. Node information is obtained by sending a request to the PBS job server. Sets of nodes can be operated on at once by specifying a node property prefixed by a colon.

Nodes do not exist in a single state, but actually have a set of states. For example, a node can be simultaneously "busy" and "offline". The "free" state is the absence of all other states and so is never combined with other states.

In order to execute pbsnodes with other than the -a or -l options, the user must have PBS Manager or Operator privilege.

## OPTIONS
-A

Append a note attribute to existing note attributes. The -N note option will overwrite exiting note attributes. -A will append a new note attribute to the existing note attributes delimited by a ',' and a space.

-a

All attributes of a node or all nodes are listed. This is the default if no flag is given.

-x

Same as -a, but the output has an XML-like format.

-c

Clear OFFLINE from listed nodes.

-d

Print MOM diagnosis on the listed nodes. Not yet implemented. Use momctl instead.

-o

Add the OFFLINE state. This is different from being marked DOWN. OFFLINE prevents new jobs from running on the specified nodes. This gives the administrator a tool to hold a node out of service without changing anything else. The OFFLINE state will never be set or cleared automatically by pbs_server; it is purely for the manager or operator.

-p

Purge the node record from pbs_server. Not yet implemented.

-r

Reset the listed nodes by clearing OFFLINE and adding DOWN state. pbs_server will ping the node and, if they communicate correctly, free the node.

-l

List node names and their state. If no state is specified, only nodes in the DOWN, OFFLINE, or UNKNOWN states are listed. Specifying a state string acts as an output filter. Valid state strings are "free", "offline", "down", "reserve", "job-exclusive", "job-sharing", "busy", "time-shared", or "state-unknown".

-N

Specify a "note" attribute. This allows an administrator to add an arbitrary annotation to the listed nodes. To clear a note, use -N "" or -N n.

-n

Show the "note" attribute for nodes that are DOWN, OFFLINE, or UNKNOWN. This option requires -l.

-q

Supress all error messages.

-s

Specify the PBS server's hostname or IP address.

## SEE ALSO
pbs_server(8B) and the PBS External Reference Specification


qdisable

title: qdisable(8)

summary: disable input to a pbs destination

text:
# qdisable(8)

## NAME
qdisable - disable input to a pbs destination

## SYNOPSIS
qdisable destination ...

## DESCRIPTION
The qdisable command directs that a destination should no longer accept batch jobs. If the command is accepted, the destination will no longer accept Queue Job requests which specified the disabled queue. Jobs which already reside in the queue will continue to be processed. This allows a queue to be "drained."

In order to execute qdisable, the user must have PBS Operation or Manager privilege.

## OPERANDS
The qdisable command accepts one or more destination operands. The operands are one of three forms:

queue

@server

queue@server

If queue is specified, the request is to disable that queue at the default server. If the @server form is given, the request is to disable all the queues at that server. If a full destination identifier, queue@server, is given, the request is to disable the named queue at the named server.

## STANDARD ERROR
The qdisable command will write a diagnostic message to standard error for each error occurrence.

## EXIT STATUS
Upon successful processing of all the operands presented to the qdisable command, the exit status will be a value of zero.

If the qdisable command fails to process any operand, the command exits with a value greater than zero.

## SEE ALSO
pbs_server(8B), qmgr(1B), and qenable(8B)


qenable

title: qenable(8)

summary: enable input to a pbs destination

text:
# qenable(8)

## NAME
qenable - enable input to a pbs destination

## SYNOPSIS
qenable destination ...

## DESCRIPTION
The qenable command directs that a destination should accept batch jobs.

The qenable command sends a Manage request to the batch server specified by destination. If the command is accepted, the destination will accept Queue Job requests which specified the queue.

In order to execute qenable, the user must have PBS Operation or Manager privilege.

## OPERANDS
The qenable command accepts one or more destination operands. The operands are one of three forms:

queue

@server

queue@server

If queue is specified, the request is to enable that queue at the default server. If the @server form is given, the request is to enable all the queues at that server. If a full destination identifier, queue@server, is given, the request is to enable the named queue at the named server.

## STANDARD ERROR
The qenable command will write a diagnostic message to standard error for each error occurrence.

## EXIT STATUS
Upon successful processing of all the operands presented to the qenable command, the exit status will be a value of zero.

If the qenable command fails to process any operand, the command exits with a value greater than zero.

## SEE ALSO
pbs_server(8B), qdisable(8B), and qmgr(1B)


qrun

title: qrun(8)

summary: run a pbs batch job

text:
# qrun(8)

## NAME
qrun - run a pbs batch job

## SYNOPSIS
qrun [-a] [-H host] job_identifier ...

## DESCRIPTION
The qrun command is used to force a batch server to initiate the execution of a batch job. The job is run regardless of scheduling position, resource requirements, or state.

In order to execute qrun, the user must have PBS Operation or Manager privilege.

## OPTIONS
-a

Specifies the job(s) is to be run asynchronously.

-H host

Specifies the host within the cluster on which the job(s) are to be run. The host argument is the name of a host that is a member of the cluster of hosts managed by the server. If the option is not specified, the server will select the "worst possible" host on which to execute the job.

## OPERANDS
The qrun command accepts one or more job_identifier operands of the form:

sequence_number[.server_name][@server]

## STANDARD ERROR
The qrun command will write a diagnostic message to standard error for each error occurrence.

## EXIT STATUS
Upon successful processing of all the operands presented to the qrun command, the exit status will be a value of zero.

If the qrun command fails to process any operand, the command exits with a value greater than zero.

## SEE ALSO
pbs_server(8B), pbs_sched(8B), qmgr(1B)


qstart

title: qstart(8)

text:
# qstart(8)

## NAME
qstart - start pbs batch job processing at a destination

## SYNOPSIS
qstart destination ...

## DESCRIPTION
The qstart command directs that a destination should process batch jobs. If the destination is an execution queue, the server will begin to schedule jobs that reside in the queue for execution. If the destination is a routing queue, the server will begin to route jobs from that queue.

In order to execute qstart, the user must have PBS Operation or Manager privilege.

## OPERANDS
The qstart command accepts one or more destination operands. The operands are one of three forms:

queue

@server

queue@server

If queue is specified, the request is to start that queue at the default server. If the @server form is given, the request is to start all queues at that server. If a full destination identifier, queue@server, is given, the request is to start the named queue at the named server.

## STANDARD ERROR
The qstart command will write a diagnostic message to standard error for each error occurrence.

## EXIT STATUS
Upon successful processing of all the operands presented to the qstart command, the exit status will be a value of zero.

If the qstart command fails to process any operand, the command exits with a value greater than zero.

## SEE ALSO
pbs_server(8B), qstop(8B), and qmgr(1B)


qstop

title: qstop(8)

text:
# qstop(8)

## NAME
qstop - stop pbs batch job processing at a destination

## SYNOPSIS
qstop destination ...

## DESCRIPTION
The qstop command directs that a destination should stop processing batch jobs. If the destination is a execution queue, the server will cease scheduling jobs that reside in the queue for execution. If the destination is a routing queue, the server will cease routing jobs from that queue.

In order to execute qstop, the user must have PBS Operation or Manager privilege.

## OPERANDS
The qstop command accepts one or more destination operands. The operands are one of three forms:

queue

@server

queue@server

If queue is specified, the request is to stop that queue at the default server. If the @server form is given, the request is to stop all the queues at that server. If a full destination identifier, queue@server, is given, the request is to stop the named queue at the named server.

## STANDARD ERROR
The qstop command will write a diagnostic message to standard error for each error occurrence.

## EXIT STATUS
Upon successful processing of all the operands presented to the qstop command, the exit status will be a value of zero.

If the qstop command fails to process any operand, the command exits with a value greater than zero.

## SEE ALSO
pbs_server(8B), qstart(8B), and qmgr(1B)


qterm

title: qterm(8)

text:
# qterm(8)

## NAME
qterm - terminate processing by a PBS batch server

## SYNOPSIS
qterm [-t type] [server...]

## DESCRIPTION
The qterm command terminates a PBS batch server. When a server receives a terminate command, the server will go into a terminating state. While in this state, the server will not allow new jobs to be started or enqueued. By default, qterm will request a "quick" shutdown of the PBS server. Other ways of shutting down the server (specified with the -t argument), and their impact on running jobs, are described below. The qterm command will not exit until the server has completed its shutdown procedure.

In order to execute qterm, the user must have PBS Operation or Manager privilege.

## OPTIONS
-t type

Specifies the type of shut down. The type are:

quick

This option is used when you wish that running jobs be left running when the server shuts down. The server will cleanly shutdown and can be restarted when desired. Upon restart of the server, jobs that continue to run are shown as running; jobs that terminated during the server's absence will be placed into the exiting state.

## OPERANDS
The server operand specifies which servers are to shutdown. If no servers are given, then the default server will be terminated.

## STANDARD ERROR
The qterm command will write a diagnostic message to standard error for each error occurrence.

## EXIT STATUS
Upon successful processing of all the operands presented to the qterm command, the exit status will be a value of zero.

If the qterm command fails to process any operand, the command exits with a value greater than zero.

## SEE ALSO
pbs_server(8B), qmgr(1B), pbs_resources_aix4(7B), pbs_resources_irix5(7B), pbs_resources_sp2(7B), pbs_resources_sunos4(7B), and pbs_resources_unicos8(7B)