wmbattery: fix format-specifier.
[dockapps.git] / wmlongrun / INSTALL
blob324465976f958534f8adb48c850362e29386c160
2 Supported Platforms:
3 ====================
5 - GNU/Linux (kernel 2.4.x / 2.2.18 or later)
6 - FreeBSD (5.0-CURRENT / 4.4-RELEASE or later)
8 Patches to make it work on other platforms are welcome.
11 Requirements:
12 ============
13 - Basic obvious stuff
14         If you will build WMLongRun, make sure you have gcc (or some Other ANSI
15         C compiler).the X header files installed.
17 - X11R6.x
18         WMLongRun can NOT be compiled in older versions of X, like X11R5 or
19         X11R4. Upgrading the client libraries (Xlib, Xext) will help if you
20         can't upgrade the server.
22 - libXPM 4.7 or newer
23         Older versions may not work.
24         Available at ftp://sunsite.unc.edu/pub/Linux/libs/X/
26 - CPUID/MSR drivers. (GNU/Linux)
27         To run WMLongRun under GNU/Linux, you will need CPUID/MSR drivers.
28         These drivers have been a part of the kernel distribution since version
29         2.2.18. (2.4.x kernel has already included support for CPUID/MSR.) Make
30         sure your kernel was compiled with 'CONFIG_X86_CPUID=y' and
31         'CONFIG_X86_MSR=y'. If the CPUID/MSR drivers are not already built, you
32         will need to configure and build a new kernel. You can either build the
33         CPUID/MSR drivers into the kernel or build them as kernel loadable
34         modules.
36 - CPUID/MSR character devices (GNU/Linux)
37         To get the information of the LongRun settings and status, you may need
38         to make the special character files in the /dev directory. Please type
39         as following to see if these devices already exist.
41          $ ls -l /dev/cpu/0/*
42          crw-------   1 root    root     203,  0 Sep 27  00:16 /dev/cpu/0/cpuid
43          cr--r--r--   1 root    root     202,  0 Sep 27  00:16 /dev/cpu/0/msr
45         If not, you will need to create them. There is a MAKEDEV-cpuid-msr
46         script in the source distribution of WMLongRun which will create
47         the CPUID/MSR devices for you. You can also do it yourself.
48         As root, type:
50          $ mkdir -m 0755 -p /dev/cpu/0
51          $ mknod /dev/cpu/0/msr -m 0600 c 202 0
52          $ mknod /dev/cpu/0/cpuid -m 0444 c 203 0
55 Installation:
56 =============
58 1: tar -zxvf wmlongrun-<version>.tar.gz
59 2: cd wmlongrun-<version>
60 3: ./configure
61 4: make
62 5: su root
63 6: make install (or 'make install-strip')
64 7: wmlongrun &
66 NOTES:
67 - WMLongRun is installed as a setuid-root program on GNU/Linux. A setuid
68   program with a graphical user interface is NOT secure. Please use at your own
69   risk.
70 - Non-GNU make may not work.
71   e.g.) it doesn't work on FreeBSD when you run 'make clean'.