Updating branch refs/heads/master
to 44b6728aae06ca9e4c781a49eaf30fa2cd834a2b (commit)
from c4054133dff24bc0c35a98c28be54df9737bdc7b (commit)
commit 44b6728aae06ca9e4c781a49eaf30fa2cd834a2b
Author: Florian Rivoal <[email protected]>
Date: Thu Sep 30 00:34:10 2010 +0900
Update the documentation
Reflect recent changes in the documentation, and describe more
completely the options in the README file.
AUTHORS | 1 +
NEWS | 20 +++++++--
README | 151 +++++++++++++++++++++++++++++++++++++++------------------------
TODO | 6 ---
4 files changed, 111 insertions(+), 67 deletions(-)
diff --git a/AUTHORS b/AUTHORS
index 42493a3..5fd3bf2 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -2,3 +2,4 @@ Alexander Nordfelth <[email protected]>
gatopeich <[email protected]>
lidiriel <[email protected]>
Angelo Miguel Arrifano <[email protected]>
+Florian Rivoal <[email protected]>
diff --git a/NEWS b/NEWS
index b65e725..07df7ba 100644
--- a/NEWS
+++ b/NEWS
@@ -1,8 +1,14 @@
-0.3.0
+1.0.0
=====
-- Ported to Xfce 4.4 panel API
-- Use xfce4-dev-tools
-- Use real frame widget
+- Clean up, bug fixing and optimization
+- Added (back) support for FreeBSD, OpenBSD, NetBSD, and GNU/kFreeBSD
+- Support both 32 and 64 bits on all platforms, with multi core support on
linux, OpenBSD and NetBSD
+- Available in 35 languages, 15 of which with a complete translation
+- Bring back the fire color mode
+- Bring back the time scaling mode
+- Possibility to track only one CPU when you have several
+- More settings, with better defaults
+- Make the cpu bar graphs optional
0.4.0
=====
@@ -14,3 +20,9 @@
- Remove *BSD code (go back in next released)
- Add a new view mode : the grid
- Add an associate customizable command
+
+0.3.0
+=====
+- Ported to Xfce 4.4 panel API
+- Use xfce4-dev-tools
+- Use real frame widget
diff --git a/README b/README
index 4bdc415..a074c65 100644
--- a/README
+++ b/README
@@ -2,63 +2,100 @@ CPU Graph plugin for the XFce4 panel.
This plugin displays an graph from your latest system load.
-Currently supporting Linux, FreeBSD, NetBSD and OpenBSD.
-The *BSD support is from Riccardo's <[email protected]> system load
plugin.
-
-i18n support is on it's way.
-
-Color description:
- Color 1: None - Normal: The color of the whole graph.
- LED: The color of the inactive leds.
- No History: The color of the whole "graph".
-
- Gradient - Normal: The start color of the graph.
- LED: The color of the inactive leds.
- No History: The start color of the "graph".
-
- Fire - Normal: The start color of the graph.
- LED: The color of the inactive leds.
- No History: The start color of the "graph".
-
- cpufreq - Normal: color when CPU frequency is at its
- minimal value. Intermediate shades are used
- for intermediate values.
-
- Color 2: None - Normal: This color isn't used.
- LED: The color of the active leds.
- No History: This color isn't used.
-
- Gradient - Normal: The end color of the graph.
- LED: The start color of the leds.
- No History: The end color of the "graph".
-
- Fire - Normal: The end color of the graph.
- LED: The start color of the leds.
- No History: The end color of the "graph".
-
- cpufreq - Normal: color when CPU frequency is at its
- maximal value. Intermediate shades are used
- for intermediate values.
-
- Color 3: None - Normal: This color isn't used.
- LED: This color isn't used.
- No History: This color isn't used.
-
- Gradient - Normal: This color isn't used.
- LED: The end color of the leds.
- No History: This color isn't used.
-
- Fire - Normal: This color isn't used.
- LED: The end color of the leds.
- No History: This color isn't used.
-
-* "Use frame"? If this option is checked it draws a frame around the plugin.
-* "Non-linear time scale"? When checked, scrolling will work differently.
- Try and see.
-* The color next to the checkbox opens a color dialog so you set the frame(s)
color.
-
-Please report any bugs to <[email protected]>
+Currently supporting Linux, FreeBSD, NetBSD and OpenBSD, and GNU/kFreeBSD.
+The *BSD support is derived from Riccardo's <[email protected]>
+system load plugin.
+
+i18n support is up to 15 fully supported languages, with another 20 partially
+supported languages.
+
+--------
+How to use
+----
+Just add it to your xfce pannel, and it should display the CPU usage in an easy
+to understand way.
+
+A left click on the plugin will launch xfce4-taskmanager, or if you don't have
+it, top in a terminal.
+
+A right click gives access to the usual xfce plugin context menu, from which
+properties can be opened. The properties are split into two tabs.
+
+The first tab allows to change the appearance of the main graph. You can select
+between 4 modes and 3 color modes, and pick the various colors used. Here is a
+description of what the various colors mean in each combination of mode and
+color mode.
+
+Color 1: None - Normal: The color of the whole graph.
+ LED: The color of the inactive leds.
+ No History: The color of the whole "graph".
+
+ Gradient - Normal: The start color of the graph.
+ LED: The color of the inactive leds.
+ No History: The start color of the "graph".
+
+ Fire - Normal: The start color of the graph.
+ LED: The color of the inactive leds.
+ No History: The start color of the "graph".
+
+Color 2: None - Normal: This color isn't used.
+ LED: The color of the active leds.
+ No History: This color isn't used.
+
+ Gradient - Normal: The end color of the graph.
+ LED: The start color of the leds.
+ No History: The end color of the "graph".
+
+ Fire - Normal: The end color of the graph.
+ LED: The start color of the leds.
+ No History: The end color of the "graph".
+
+Color 3: None - Normal: This color isn't used.
+ LED: This color isn't used.
+ No History: This color isn't used.
+
+ Gradient - Normal: This color isn't used.
+ LED: The end color of the leds.
+ No History: This color isn't used.
+
+ Fire - Normal: This color isn't used.
+ LED: The end color of the leds.
+ No History: This color isn't used.
+
+In the second tab of the properties, the following options are available:
+
+* Update interval: How often the graph is refreshed with new CPU data
+
+* Tracked core: On multi core or multi CPU systems, allows to pick whether CPU
+ Graph should display data representing all cores/CPUs or only a
+ specific one.
+
+* Width / Height: Depending on the orientation of the xfce panel, allows to
+ change the width or height of the CPU Graph plugin.
+
+* Non-linear time scale: When checked, scrolling will work differently. Try
+ and see.
+
+* Show frame: If this option is checked it draws a frame around the plugin.
+
+* Show border: If this option is checked, a small blank area is drawn around
+ the plugin.
+
+* Show current usage bars: When checked, in addition to the main graph area,
+ the plugin show one bar per core/CPU, displaying the
+ current load of that core/CPU.
+
+* Associated command: Sets the command to run when the plugin is left-clicked.
+
+* Run in a terminal: When checked, the associated command will be run from a
+ terminal, rather than as a graphical application. Useful
+ for example when the associated command is "top".
+
+* Use startup notification: When checked, uses startup notification for the
+ associated command.
+
+Please report any bugs to http://bugs.xfce.org/
Hope this suite your needs.
Regards,
- Alexander Nordfelth <[email protected]>
+ The authors
diff --git a/TODO b/TODO
deleted file mode 100644
index 6893b72..0000000
--- a/TODO
+++ /dev/null
@@ -1,6 +0,0 @@
-* Even more modes
-* Add *BSD code in cpu_os (see 0.3.0)
-* Add Frequency color mode ? (see 0.3.0)
-* Add Fire color mode (see 0.3.0)
-* Add Time scalling
-* Continue to cleanup/refactoring code
_______________________________________________
Xfce4-commits mailing list
[email protected]
http://foo-projects.org/mailman/listinfo/xfce4-commits
