diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 0000000..823104b --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,240 @@ +WMNut +===== + +Description +----------- + +WMNut is a program to monitor multiple UPSs statistics through the NUT +(link:http://www.networkupstools.org[Network UPS Tools]) framework on Linux +and other systems. + +It is a dockapp that is supported natively by X window managers such as +Window Maker, AfterStep, BlackBox, FluxBox, and Enlightenment. + +WMNut will run as a simple 64*64 pixels window in other Window Managers, or +when using *-w*. + +image:images/WMnut_desc.png[] + +WMNut provides multiple UPSs monitoring with: + +- Status of power supply (battery or AC Power), +- Communication status with UPS (Red/Green "C"), +- Percentage of battery remaining (numeric and meter), +- Load level percentage on output (numeric, if available), +- Runtime to empty, ie time left to battery depletion (MM:SS), +- High/Low/Critical battery status (Red/Yellow/Green colored meter and battery). + +It is known to run on GNU/Linux and FreeBSD, but should also run on any other +system supporting X11. + +Download +-------- + +- link:https://github.com/downloads/aquette/wmnut/wmnut-0.63.tar.bz2[wmnut-0.63.tar.gz] +- link:https://github.com/downloads/aquette/wmnut/wmnut-0.63.tar.bz2[wmnut-0.63.tar.bz2] +- link:http://github.com/aquette/wmnut/raw/master/ChangeLog[ChangeLog] + +//////////////////////////////////////////////////////////////////////////////// +link:README[] +link:HINTS[] +link:TODO[] +//////////////////////////////////////////////////////////////////////////////// + +- link:http://packages.debian.org/wmnut[Debian packages] +- link:www.rpmfind.net/linux/rpm2html/search.php?query=wmnut[RPM packages] + +Note that you can also access to +link:http://github.com/aquette/wmnut/downloads[old and testing WMNut releases]. + +Installation instructions +------------------------- + +Requirements +~~~~~~~~~~~~ + +WMNUT requires the: + +- X Window client and Xpm libraries and development files, +- NUT client library, version 2.2.1 or higher. + +In order to compile WMNUT using the Makefile, GNU make must be used. +For FreeBSD users, the default BSD 'make' does not work, so use 'gmake' instead! + +Installation +~~~~~~~~~~~~ + +1) Download WMNut source code (from github) or archive (.tar.gz or .tar.bz2) + +Either get file from link:http://github.com/aquette/wmnut/downloads[WMNut downloads] +or clone the git repository using: + + $ git clone git://github.com/aquette/wmnut.git + +2) Uncompress the archive (not needed for github source code) + + $ tar -zxvf wmnut-X.YZ.tar.gz + $ tar -jxvf wmnut-X.YZ.tar.bz2 + +3) Switch to WMNut source code directory + + $ cd wmnut-X.YZ + +If you are using the git source code, use: + + $ cd wmnut + +4) Prepare the source for building + +[NOTE] +================================================================================ +when using the git repository, be sure to first call: + + $ autoreconf -i +================================================================================ + +Just call the usual: + + $ ./configure + +NOTE: WMNut now uses pkg-config to determine the location of NUT library +and headers. + +5) Now compile WMNut + + $ make + +Or (for *BSD systems): + + $ gmake + +6) And install it on your system + +Use the following command, as root: + + $ make install + +Or simply copy the 'wmnut' binary (and optionally its manual page) to the +right directories on your system. + +7) Optionally, configure WMNut for your own use + +WMNut will automatically connect to any local device(s). +So if you have remote system(s) that you want to monitor, edit and adapt +'wmnutrc'. Then copy it to your home or / and your /etc directory, using: + + $ cp wmnutrc /etc/wmnutrc + +or / and: + + $ cp wmnutrc ~/.wmnutrc + +[NOTE] +================================================================================ +- if both files exist, "~/.wmnutrc" takes precedence, +- command lines options takes precedence on configuration files, +- on debian, a sample 'wmnutrc' is located in /usr/share/doc/wmnut/. +================================================================================ + +8) Launch WMNut + + $ wmnut & + +You can also use 'wmnut -h' for help, or 'man wmnut' to access the manual page. + +If no parameter is given, wmnut will try to access the UPS at "localhost" +address. Otherwise try 'wmnut -U upsname@hostname' or edit your wmnutrc files. + +Be sure to read the HINTS and TODO files too! + + +Copyright and license +--------------------- + + WMNut is Copyright (C) 2002 - 2012 link:http://arnaud.quette.free.fr/contact.html[Arnaud Quette] + + wmnut is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Credits +------- + +WMNut is based on wmapm originally written by Chris D. Faulhaber and +M.G. Henderson. + +Huge thanks to: + +- Russell Kroll for having initiated and driven the NUT project +(link:http://www.networkupstools.org[Network UPS Tools]), until 2004. +Note that I have however taken over NUT leadership since 2005... +- Bill Richter, Laszlo Hazy and David Butts for their support in beta test +and improvement of WMNut, +- Martijm Pieterse and Antoine Nulle for a great (and somewhat standardised) +interface which I used as a template (wmmon.app and wmgeneral), +- Luca Filipozzi for WMNut Debian package creation, which I now personaly hold, +available at link:http://packages.debian.org/wmnut[Debian website]. + + +Help +---- +I'm interested in having feedback about how WMNut runs on other platforms +(BSD, Solaris, ...) and searching for packagers on those platforms. + +If you have nice suggestions, ideas, whatever, that aren't on TODO list, feel free to mail them to me. +Comments and remarks are also welcomed (mail to: link:http://arnaud.quette.free.fr/contact.html[Arnaud Quette]). + +FAQ +--- + +(How) Does WMNut support multiple UPS monitoring? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Yes, WMNut can monitor up to 9 UPSs since release 0.1. Take a look at HINTS +file and manual page for more details about using this feature. + +Can I set the initial size of WMNut? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +No, WMNut is limited to 64*64. + +I'm not running WindowMaker nor AfterStep. How can I run WMNut in windowed mode (ie not having transparent background !)? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Try running "wmnut -w". See below for a screenshot. + +I can't compile WMNut ("undefined reference to `upslogx'", "upsfetch.h/o not found" or "upsclient.h/o not found") or WMNut doesn't work! +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +There is always lots of improvements in both NUT and WMNut... +To solve your problem, you should upgrade to the most current release of NUT +and WMNut, and the problem should disappear. + +Screenshots +----------- + +Withdrawn mode +~~~~~~~~~~~~~~ + +image:http://github.com/aquette/wmnut/raw/master/images/wmnut-0_09w.jpg[] + +Windowed mode (-w) +~~~~~~~~~~~~~~~~~~ + +image:http://github.com/aquette/wmnut/raw/master/images/wmnut-0_09win.jpg[] + +Windowed mode (-w) under KDE (Plastik) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +image:http://github.com/aquette/wmnut/raw/master/images/wmnut-0_60kde.jpg[] diff --git a/README.md b/README.md deleted file mode 100644 index 7ff0199..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -wmnut -===== - -DockApp for NUT (Network UPS Tools) \ No newline at end of file diff --git a/icons/wmnut-mdk-16.png b/icons/wmnut-16.png similarity index 100% rename from icons/wmnut-mdk-16.png rename to icons/wmnut-16.png diff --git a/icons/wmnut-mdk-32.png b/icons/wmnut-32.png similarity index 100% rename from icons/wmnut-mdk-32.png rename to icons/wmnut-32.png diff --git a/icons/wmnut-mdk-48.png b/icons/wmnut-48.png similarity index 100% rename from icons/wmnut-mdk-48.png rename to icons/wmnut-48.png diff --git a/images/WMnut_desc.png b/images/WMnut_desc.png new file mode 100644 index 0000000..dc4158c Binary files /dev/null and b/images/WMnut_desc.png differ diff --git a/images/wmnut-0_09w.jpg b/images/wmnut-0_09w.jpg new file mode 100644 index 0000000..d20f4c7 Binary files /dev/null and b/images/wmnut-0_09w.jpg differ diff --git a/images/wmnut-0_09win.jpg b/images/wmnut-0_09win.jpg new file mode 100644 index 0000000..f385c92 Binary files /dev/null and b/images/wmnut-0_09win.jpg differ diff --git a/images/wmnut-0_60kde.jpg b/images/wmnut-0_60kde.jpg new file mode 100644 index 0000000..a334822 Binary files /dev/null and b/images/wmnut-0_60kde.jpg differ