wmclockmon: update change-log
[dockapps.git] / wmcube / README
blob0c5b9d1f1c56f649880a100c763d77563528f1d8
1 wmcube 1.0.2
2 ---------------------------------------------------------------
3 Author: Cezary M. Kruk
4         c.kruk@bigfoot.com
5         http://linux-bsd-unix.strefa.pl
7 Contributors:
8         Doug Torrance <dtorrance@piedmont.edu>
10 wmCube 0.98
11 ---------------------------------------------------------------
12 Author: Robert Kling
13         robkli-8@student.luth.se
14         http://boombox.campus.luth.se
16 Contributors:
17         Thorsten Jens <thodi@et-inf.fho-emden.de>
18         Jakob Borg <email-adress goes here>
19         Dan Price <dp@rampant.org>
20         Brian Joseph Czapiga <rys@godsey.net>
21         Tai-hwa Liang <avatar@mmlab.cse.yzu.edu.tw>
22         Jared Smolens <jsmolens+@andrew.cmu.edu>
24 Description
25 ---------------------------------------------------------------
26 wmcube is a dockapp displaying a realtime rotating 3D object
27 (plugin) together with the current CPU load.  The speed of the
28 rotation depends on the CPU load.
30 Commands
31 ---------------------------------------------------------------
32 Display help:
34     $ wmcube -h
36 Run cube.wmc plugin from the current or default directory:
38     $ wmcube -o cube.wmc &
40 Run random plugin from the default directory:
42     $ wmcube &
44 Run random plugin from the current directory:
46     $ wmcube -o . &
48 Run sample.wmc plugin from the selected directory:
50     $ wmcube -o ~/myplugins/sample.wmc &
52 (The default directory is set to /usr/share/wmcube.)
54 Mouse actions
55 ---------------------------------------------------------------
56 Display the next plugin (works with the directories including
57 the plugins):
59     click the center of the dockapp
61 Zoom the plugin out or in:
63     click - or +
65 Hide or show CPU usage:
67     click XX%
69 Files
70 ---------------------------------------------------------------
71 3D-objects  3D object files (plugins)
72 COPYING     GNU General Public License Version 3
73 CHANGES     description of the changes
74 INSTALL     installation instructions
75 README      this file
76 THANKS      my thanks to other people
78 Bugs
79 ---------------------------------------------------------------
80 If you discover any bugs in this software, please send a
81 bugreport to c.kruk@bigfoot.com and describe the problem as
82 detailed as you can.
84 Copyright
85 ---------------------------------------------------------------
86 wmcube (C) 2014-2016 by Cezary M. Kruk, Wrocław, Poland
87 wmCube (C) 2000-2001 by Robert Kling, Lulea, Sweden