wmix: added autogen and .gitignore.
[dockapps.git] / wmArchUp / README
blob803ed537b759975a8aadf780d288c3c1b63067ef
1                    _____                .__     ____ ___
2 __  _  _______    /  _  \_______   ____ |  |__ |    |   \______
3 \ \/ \/ /     \  /  /_\  \_  __ \_/ ___\|  |  \|    |   /\____ \
4  \     /  Y Y  \/    |    \  | \/\  \___|   Y  \    |  / |  |_> >
5   \/\_/|__|_|  /\____|__  /__|    \___  >___|  /______/  |   __/
6              \/         \/            \/     \/          |__|
8 *******************
9 *** DESCRIPTION ***
10 *******************
12 wmArchUp is a very simple program used to monitor for package updates in Arch
13 Linux. It uses the checkupdates script that come with pacman for safe checking
14 if there is any package updates. It is a dockapp that is supported by X window
15 managers such as Window Maker, AfterStep, BlackBox, Fluxbox and Enlightenment.
17 This dockapp is quite simple. It contains an Arch Linux logo icon. When there is
18 not package updates then the Arch Linux logo icon is greyed. When there are
19 package updates then the Arch Linux logo icon is blue. The program check for
20 updates every 10 minutes by default. However you can specify the checking
21 interval by using the -c or --check-interval command line arguments. When the
22 program checks for updates it change its icon in a gear. If you right click the
23 Arch Linux logo icon then it immediately starts a check for updates. If you left
24 click the Arch Linux log the it opens an xterm window and start a system update.
26 ***************
27 *** OPTIONS ***
28 ***************
30 This program has the following command line options
31 -c <number> : Sets the checking time interval in minutes. Default is 10 minutes.
32 --check-interval <number> : Same as -c
34 *********************
35 *** REQUIREMENTS  ***
36 *********************
38 This program needs libdockapp library files in order to compile.
39 You can find libdockapp at http://www.dockapps.net/libdockapp
40 Also you need to have xterm installed.
42 *******************
43 *** COMPILATION ***
44 *******************
46 To compile, simply invoke the "make" command.
48 ********************
49 *** INSTALLATION ***
50 ********************
52 To install the program (in /usr/local/bin), run : "make install" as root user
54 **************
55 *** THANKS ***
56 **************
58 Thanks to the authors of the libdockapp code, it has been a really good starting
59 base to develop this little application.
61 **************
62 *** AUTHOR ***
63 **************
65 wmArchUp has been written by Panagiotis A. Dimopoulos <panosdim@gmail.com>
66 All comments are welcome.