docs/user-manual.txt

   1 :titles.underlines: "__","==","--","~~","^^"
   2
   3 Network UPS Tools User Manual
   4 _____________________________
   5 :Author: Russell_Kroll,_Arnaud_Quette_and_Arjen_de_Korte
   6 :Author Initials: RK, AQ & ADK
   7
   8 Introduction
   9 ============
  10
  11 The primary goal of the Network UPS Tools (NUT) project is to provide support
  12 for Power Devices, such as Uninterruptible Power Supplies, Power Distribution
  13 Units and Solar Controllers.
  14
  15 NUT provides many control and monitoring <<Features,features>>, with a uniform
  16 control and management interface.
  17
  18 More than 100 different manufacturers, and several thousands models are
  19 <<HCL,compatible>>.
  20
  21 This software is the combined effort of many
  22 <<Acknowledgements,individuals and companies>>.
  23
  24 This document intend to describe how to install software support for your
  25 <<general_powerdev_info, Power Devices>> (UPS, PDU, ...), and how to use the
  26 NUT project. It is not intended to explain what are, nor distinguish the
  27 different technologies that exist.  For such information, have a look at the
  28 <<general_powerdev_info,General Power Devices Information>>.
  29
  30 If you wish to discover how everything came together, have a look at the
  31 <<Project_History,Project History>>.
  32
  33
  34 [[Overview]]
  35
  36 include::../README[]
  37
  38
  39 [[Features]]
  40
  41 include::features.txt[]
  42
  43
  44 Compatibility information
  45 -------------------------
  46
  47 Hardware
  48 ~~~~~~~~
  49
  50 The current list of hardware supported by NUT can be viewed <<HCL,here>>.
  51
  52 Operating systems
  53 ~~~~~~~~~~~~~~~~~
  54
  55 This software has been reported to run on:
  56
  57 - Linux distributions,
  58 - the BSDs,
  59 - Apple's OS X,
  60 - Sun Solaris,
  61 - SGI IRIX,
  62 - HP/UX,
  63 - Tru64 Unix,
  64 - AIX.
  65
  66 There is also a port of the client-side monitoring to Windows called WinNUT.
  67 Windows users may be able to build it directly with Cygwin.
  68
  69 Your system will probably run it too. You just need a good C compiler and
  70 possibly some more packages to gain access to the serial ports.
  71 Other features, such as USB / SNMP / whatever, will also need extra software
  72 installed.
  73
  74 Success reports are welcomed to keep this list accurate.
  75
  76
  77 [[Download_instructions]]
  78
  79 include::download.txt[]
  80
  81
  82 [[_installation_instructions]]
  83
  84 include::../INSTALL[]
  85
  86
  87 [[Configuration_notes]]
  88
  89 include::config-notes.txt[]
  90
  91
  92 [[Advanced_usage_scheduling_notes]]
  93
  94 include::scheduling.txt[]
  95
  96
  97 [[Outlets_PDU_notes]]
  98
  99 include::outlets.txt[]
 100
 101
 102 [[NUT_Security]]
 103
 104 include::security.txt[]
 105
 106
 107 Appendix A: Glossary
 108 ====================
 109
 110 This section document the various acronyms used throughout the present
 111 documentation.
 112
 113 [template="glossary",id="terms"]
 114 NUT::
 115         Network UPS Tools.
 116 PDU::
 117         Power Distribution Unit.
 118 SCD::
 119         Solar Controller Device.
 120 UPS::
 121         Uninterruptible Power Supply.
 122
 123
 124 [[Acknowledgements]]
 125 Appendix B: Acknowledgements / Contributions
 126 ============================================
 127
 128 include::acknowledgements.txt[Acknowledgements / Contributions]
 129
 130
 131 [[nut-names]]
 132 Appendix C: NUT command and variable naming scheme
 133 ==================================================
 134
 135 include::nut-names.txt[]
 136
 137
 138 [[HCL]]
 139 Appendix D: Hardware Compatibility List
 140 =======================================
 141
 142 ifdef::website[]
 143 include::stable-hcl.txt[]
 144 endif::website[]
 145
 146 ifndef::website[]
 147 Refer to the link:http://www.networkupstools.org/stable-hcl.html[online HCL].
 148 endif::website[]
 149
 150
 151 Appendix E: Documentation
 152 =========================
 153
 154 include::documentation.txt[]
 155
 156
 157 [[Support_Request]]
 158 Appendix F: Support instructions
 159 ================================
 160
 161 include::support.txt[]
 162
 163
 164 [[Cables_information]]
 165 Appendix G: Cables information
 166 ==============================
 167
 168 include::cables.txt[]
 169
 170
 171 [[Configure_options]]
 172 Appendix H: Configure options
 173 =============================
 174
 175 include::configure.txt[]
 176
 177
 178 [[Upgrading_notes]]
 179 Appendix I: Upgrading notes
 180 ===========================
 181
 182 include::../UPGRADING[]
 183
 184
 185 [[Project_History]]
 186 Appendix J: Project history
 187 ===========================
 188
 189 include::history.txt[]