docs/support.txt

   1 ifdef::website[]
   2 Support instructions
   3 ====================
   4 endif::website[]
   5
   6
   7 There are various ways to obtain support for NUT.
   8
   9 Documentation
  10 -------------
  11
  12 - First, be sure to read the link:docs/FAQ.html[FAQ]. The most common problems are already
  13 addressed there.
  14
  15 ifdef::website[]
  16 - Else, you can read the link:docs/user-manual.chunked/index.html[NUT User Manual].
  17 endif::website[]
  18 ifndef::website[]
  19 - Else, you can read the linkdoc:user-manual[NUT user manual].
  20 endif::website[]
  21 It also covers many areas about installing, configuring and using NUT.
  22 The specific steps on system integration are also discussed.
  23
  24 - Finally, link:docs/man/index.html#User_man[User manual pages] will also
  25 complete the User Manual provided information. At least, read the manual
  26 page related to your driver(s).
  27
  28 Mailing lists
  29 -------------
  30
  31 If you have still not found a solution, you should search the lists before
  32 posting a question.
  33
  34 Someone may have already solved the problem:
  35
  36 ifdef::backend-xhtml11[]
  37
  38 ++++++++++++++++++++++++++++++++++++++
  39 <form action="http://www.google.com/search" method="get">
  40   <input maxlength="2048" name="as_q" size="25" type="text">
  41   <input name="as_oq" type="hidden" value="nut-upsuser nut-upsdev">
  42   <input name="domains" value="lists.alioth.debian.org" type="hidden">
  43   <input name="sitesearch" value="lists.alioth.debian.org" type="hidden">
  44   <input name="btnG" value="Search NUT lists" type="submit">
  45 </form>
  46 ++++++++++++++++++++++++++++++++++++++
  47
  48 endif::backend-xhtml11[]
  49
  50 ifndef::backend-xhtml11[]
  51
  52 link:http://www.google.com/search?as_q=&as_oq=nut-upsuser+nut-upsdev&domains=lists.alioth.debian.org&sitesearch=lists.alioth.debian.org&btnG=Search+NUT+lists[search on the NUT lists using Google]
  53
  54 endif::backend-xhtml11[]
  55
  56 Finally, you can *subscribe* to a NUT mailing list to:
  57
  58 Request help
  59 ~~~~~~~~~~~~
  60
  61 Use the link:http://lists.alioth.debian.org/mailman/listinfo/nut-upsuser[NUT Users]
  62 mailing list.
  63
  64 In this case, be sure to include the following information:
  65
  66 - OS name and version,
  67 - exact NUT version,
  68 - NUT installation method: from source tarball, package or Subversion,
  69 - exact device name and related information (manufacturing date, web pointers, ...),
  70 - complete problem description, with any relevant traces, like system log excerpts,
  71 and driver debug output. You can obtain the latter using the following command,
  72 as root and after having stopped NUT:
  73
  74         /path/to/driver -DD -a <upsname>
  75
  76 If you don't include the above information in your help request, we will not be
  77 able to help you!
  78
  79 Post a patch, ask a development question, ...
  80 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  81
  82 Use the link:http://lists.alioth.debian.org/mailman/listinfo/nut-upsdev[NUT Developers]
  83 mailing list.
  84
  85 Refer to the
  86 ifdef::website[]
  87 link:docs/developer-guide.chunked/index.html[NUT Developer Guide]
  88 for more information, and the chapter on how to
  89 link:docs/developer-guide.chunked/ar01s03.html#_submitting_patches[submit patches].
  90 endif::website[]
  91 ifndef::website[]
  92 linkdoc:developer-guide[NUT Developer Guide]
  93 for more information, and the chapter on how to
  94 link:../developer-guide.chunked/ar01s03.html#_submitting_patches[submit patches].
  95 endif::website[]
  96
  97
  98 Discuss packaging and related topics
  99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 100
 101 Use the link:http://lists.alioth.debian.org/mailman/listinfo/nut-packaging[NUT Packagers]
 102 mailing list.
 103
 104 Refer to the
 105 ifdef::website[]
 106 link:docs/packager-guide.chunked/index.html[NUT Packager Guide]
 107 endif::website[]
 108 ifndef::website[]
 109 linkdoc:packager-guide[NUT Packager Guide]
 110 endif::website[]
 111  for more information.