ifndef::included-skip-title[]
ifdef::website[]
NUT manual pages
================
endif::website[]
endif::included-skip-title[]

[[User_man]]
User manual pages
-----------------

include::{builddir}linkman-docbuildmode-note.txt[]

ifndef::in-nut-manpage[]
NUT overview
~~~~~~~~~~~~

- linkman:nut[7]
endif::in-nut-manpage[]

Configuration files
~~~~~~~~~~~~~~~~~~~

- linkman:nut.conf[5]
- linkman:ups.conf[5]
- linkman:upsd.conf[5]
- linkman:upsd.users[5]
- linkman:upsmon.conf[5]
- linkman:upssched.conf[5]

- linkman:hosts.conf[5]
- linkman:upsset.conf[5]
- linkman:upsstats.html[5]

Daemons
~~~~~~~

- linkman:upsd[8]
- linkman:upsmon[8]
- linkman:upssched[8]
- linkman:upslog[8]

Clients commands
~~~~~~~~~~~~~~~~

- linkman:upsc[8]
- linkman:upscmd[8]
- linkman:upsrw[8]
- linkman:NUT-Monitor[8]

Configuration commands
~~~~~~~~~~~~~~~~~~~~~~

- linkman:nutconf[8]
- linkman:nut-scanner[8]

CGI programs
~~~~~~~~~~~~

- linkman:upsimage.cgi[8]
- linkman:upsset.cgi[8]
- linkman:upsstats.cgi[8]

//////////////////////////////////////////////////////////
// While nominally asciidoc allows for sect0..sect4 layering,
// in practice the /etc/asciidoc/docbook*.conf lack the sect4
// or refsect4 data in many distros. For now we just avoid it
// by not using the ++++ layer (for un-shifted leveloffset).
//////////////////////////////////////////////////////////

Platform management
~~~~~~~~~~~~~~~~~~~

Windows
^^^^^^^

- linkman:nut.exe[8]

//////////////////////////////////////////////////////////

Linux systemd
^^^^^^^^^^^^^

TBD

Solaris/illumos SMF
^^^^^^^^^^^^^^^^^^^

TBD

MacOS launchd
^^^^^^^^^^^^^

TBD

//////////////////////////////////////////////////////////

[[Drivers]]
Driver control
~~~~~~~~~~~~~~

include::{builddir}linkman-drivertool-names.txt[]

Drivers
~~~~~~~

- linkman:nutupsdrv[8]
include::{builddir}linkman-driver-names.txt[]

[[Developer_man]]
Developer manual pages
----------------------

- linkman:libupsclient-config[1]
- linkman:nut-recorder[8]
- linkman:skel[8]
- linkman:sockdebug[8]

[[devclient]]
Client library
~~~~~~~~~~~~~~

- linkman:libnutclient[3]
- linkman:libnutclient_commands[3]
- linkman:libnutclient_devices[3]
- linkman:libnutclient_general[3]
- linkman:libnutclient_misc[3]
- linkman:libnutclient_tcp[3]
- linkman:libnutclient_variables[3]

- linkman:upsclient[3]
- linkman:upscli_add_host_cert[3]
- linkman:upscli_cleanup[3]
- linkman:upscli_connect[3]
- linkman:upscli_tryconnect[3]
- linkman:upscli_disconnect[3]
- linkman:upscli_fd[3]
- linkman:upscli_get[3]
- linkman:upscli_init[3]
- linkman:upscli_set_default_connect_timeout[3]
- linkman:upscli_get_default_connect_timeout[3]
- linkman:upscli_init_default_connect_timeout[3]
- linkman:upscli_list_next[3]
- linkman:upscli_list_start[3]
- linkman:upscli_readline[3]
- linkman:upscli_sendline[3]
- linkman:upscli_splitaddr[3]
- linkman:upscli_splitname[3]
- linkman:upscli_ssl[3]
- linkman:upscli_strerror[3]
- linkman:upscli_upserror[3]
- linkman:upscli_str_add_unique_token[3]
- linkman:upscli_str_contains_token[3]

[[devscan]]
Device discovery library
~~~~~~~~~~~~~~~~~~~~~~~~

- linkman:nutscan[3]
- linkman:nutscan_add_device_to_device[3]
- linkman:nutscan_add_ip_range[3]
- linkman:nutscan_add_option_to_device[3]
- linkman:nutscan_cidr_to_ip[3]
- linkman:nutscan_display_parsable[3]
- linkman:nutscan_display_sanity_check[3]
- linkman:nutscan_display_sanity_check_serial[3]
- linkman:nutscan_display_ups_conf[3]
- linkman:nutscan_display_ups_conf_with_sanity_check[3]
- linkman:nutscan_free_device[3]
- linkman:nutscan_free_ip_ranges[3]
- linkman:nutscan_get_serial_ports_list[3]
- linkman:nutscan_init[3]
- linkman:nutscan_init_ip_ranges[3]
- linkman:nutscan_ip_ranges_iter_inc[3]
- linkman:nutscan_ip_ranges_iter_init[3]
- linkman:nutscan_new_device[3]
- linkman:nutscan_scan_avahi[3]
- linkman:nutscan_scan_eaton_serial[3]
- linkman:nutscan_scan_ipmi[3]
- linkman:nutscan_scan_nut[3]
- linkman:nutscan_scan_nut_simulation[3]
- linkman:nutscan_scan_snmp[3]
- linkman:nutscan_scan_usb[3]
- linkman:nutscan_scan_xml_http_range[3]
- linkman:nutscan_stringify_ip_ranges[3]
