Network UPS Tools - Documentation

Two NUT websites

This version of the page reflects NUT release v2.8.1 with codebase commited 4ba352d8f at 2023-10-31T21:46:20+01:00

Options, features and capabilities in current development (and future releases) are detailed on the main site and may differ from ones described here.

User Documentation

FAQ - Frequently Asked Questions (online) (PDF)
NUT User Manual (online) (PDF)
Cables information (online) (PDF)
User manual pages
Devices Dumps Library (DDL): Provides information on how devices are supported; see also the HCL
Notes on NUT monitoring of USB devices in Solaris and related operating systems
NUT Configuration Examples book maintained by Roger Price
NUT GitHub Wiki

Developer Documentation

NUT Developer Guide (online) (PDF)
NUT Packager Guide (online) (PDF)
NUT Release Notes (online) (PDF)
NUT Change Log (online) (PDF)
UPS protocols library
Developer manual pages
NUT Quality Assurance
Devices Dumps Library (DDL): Provides simulation data to the driver

Data dumps for the DDL

Note: both developers contributing a driver and users using an existing driver for device not previously documented as supported by it, are welcome to report new data for the Devices Dumps Library (DDL) mentioned above. Best of all such "data dump" reports can be prepared by the tools/nut-ddl-dump.sh script from the main NUT codebase, and reported on the NUT mailing list or via NUT issues on GitHub or as a pull request against the NUT Devices Dumps Library following the naming and other rules described in the DDL documentation page.

Data dumps collected by the tools above, or by upsc client, or by drivers in exploratory data-dumping mode (with -d 1 argument), can be compared by tools/nut-dumpdiff.sh script from the main NUT codebase, which strips away lines with only numeric values (aiming to minimize the risk of losing meaningful changes like counters).