Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
panel-plugins:xfce4-genmon-plugin:start [2023/04/19 15:31] – [Usage] tozpanel-plugins:xfce4-genmon-plugin:start [2025/01/03 04:17] (current) – update screenshot kevinbowen
Line 1: Line 1:
 ~~NOTOC~~ ~~NOTOC~~
-====== xfce4-genmon-plugin - Genmon ======+====== xfce4-genmon-plugin - Generic Monitor Plugin ======
 This plugin cyclically spawns the indicated script/program, captures its output (stdout) and displays the resulting string into the panel. This plugin cyclically spawns the indicated script/program, captures its output (stdout) and displays the resulting string into the panel.
 The string can also contain markup to displayed an formatted text, image/icon, a bar, a button, and a personalized tooltip. The string can also contain markup to displayed an formatted text, image/icon, a bar, a button, and a personalized tooltip.
  
-  * **[[#Usage|Usage]]** 
-  * **[[#Advanced Features|Advanced Features]]** 
   * **[[#Screenshots|Screenshots]]**   * **[[#Screenshots|Screenshots]]**
 +  * **[[#Usage|Usage]]**
 +    * XML Tags
 +    * Example Script
 +  * **[[#Advanced Features|Advanced Features]]** 
 +    * Pango Text Markup Support
 +    * Refreshing the plugin
 +    * Enhanced Gtk3 CSS Styling Capabilities
   * **[[#Latest Release|Latest Release]]**   * **[[#Latest Release|Latest Release]]**
   * **[[#Source Code Repository|Source Code Repository]]**   * **[[#Source Code Repository|Source Code Repository]]**
Line 14: Line 19:
  
 ===== Important Note about version 4.2.0 ===== ===== Important Note about version 4.2.0 =====
 +
 <note important>In version 4.2.0, the backend settings have been migrated from rc files to xfconf. Individual plugin settings will not be automatically migrated to xfconf and each plugin will need to be manually re-configured. A script has been developed ([[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/blob/master/scripts/migrate_to_xfconf.sh]]) that can offer assistance for the migration. </note> <note important>In version 4.2.0, the backend settings have been migrated from rc files to xfconf. Individual plugin settings will not be automatically migrated to xfconf and each plugin will need to be manually re-configured. A script has been developed ([[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/blob/master/scripts/migrate_to_xfconf.sh]]) that can offer assistance for the migration. </note>
 +
 +
 +===== Screenshots =====
 +
 +<figure "Genmon Configuration/Properties Dialog Window">
 +{{:panel-plugins:xfce4-genmon-plugin-properties.png|Genmon Configuration/Properties Dialog Window}}
 +</figure>
 +
 +[[|Back To Top]]
 +----
  
 ===== Usage ===== ===== Usage =====
 +
 +
 +  - [[:xfce:xfce4-panel:add-new-items|Add the plugin to the panel]].
 +  - Right-click on the added plugin, select **Properties** to open the settings window. 
 +
 If you want the plugin to display only text (original version), enter the command in the //Command// field of the //Properties// section of the plugin. Otherwise, xml tags are used to display content on the plugin. If you want the plugin to display only text (original version), enter the command in the //Command// field of the //Properties// section of the plugin. Otherwise, xml tags are used to display content on the plugin.
  
Line 27: Line 48:
     * Displays the "Text to display" directly on the plugin.      * Displays the "Text to display" directly on the plugin. 
     * eg. ''echo "<txt>Hello World!</txt>"''     * eg. ''echo "<txt>Hello World!</txt>"''
-    * Result: {{:panel-plugins:xfce4-genmon-plugin:txt.png?100|}}+    * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:txt.png?100|Genmon Display Text Example}}
     * **<txtclick>The command to be executed when clicking on the text</txtclick>**     * **<txtclick>The command to be executed when clicking on the text</txtclick>**
       * If displaying text, this tag will allow for a program/script to be run when the text is clicked.       * If displaying text, this tag will allow for a program/script to be run when the text is clicked.
Line 34: Line 55:
     * Display an image on the plugin using the complete path and name to the image file.     * Display an image on the plugin using the complete path and name to the image file.
     * eg. ''echo "<img>/usr/share/pixmaps/xfce4_xicon.png</img>"''     * eg. ''echo "<img>/usr/share/pixmaps/xfce4_xicon.png</img>"''
-    * Result: {{:panel-plugins:xfce4-genmon-plugin:img.png?50|}}+    * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:img.png?50|Genmon Display Image with Full Path Example}}
     * **<click>The command to be executed when clicking on the image</click>**     * **<click>The command to be executed when clicking on the image</click>**
       * If using an image, this tag will allow for a program/script to be run when the image is clicked.       * If using an image, this tag will allow for a program/script to be run when the image is clicked.
Line 41: Line 62:
     * Display an icon from the current icon theme using only the icon name.     * Display an icon from the current icon theme using only the icon name.
     * eg. ''echo "<icon>org.xfce.mousepad</icon>"''     * eg. ''echo "<icon>org.xfce.mousepad</icon>"''
-    * Result: {{:panel-plugins:xfce4-genmon-plugin:icon.png?50|}}+    * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:icon.png?50|Genmon Display Themed Icon Example}}
     * Note: the <icon> tag allows the following functionality:     * Note: the <icon> tag allows the following functionality:
       * image changes with the icon theme       * image changes with the icon theme
-      * supports panel's Adjust Icon Size Automatically functionality+      * supports panel's 'Adjust Icon Size Automatically' functionality
       * supports light/dark symbolic icon auto-colour changes       * supports light/dark symbolic icon auto-colour changes
     * **<iconclick>The command to be executed when clicking on the icon</click>**       * **<iconclick>The command to be executed when clicking on the icon</click>**  
Line 52: Line 73:
     * Display specific content in a tooltip.     * Display specific content in a tooltip.
     * eg. ''echo "<tool>My custom tooltip text</tool>"''     * eg. ''echo "<tool>My custom tooltip text</tool>"''
-    * Result: {{:panel-plugins:xfce4-genmon-plugin:tool.png?150|}}+    * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:tool.png?150|Genmon Tooltip Text Display Example}}
     * Note:     * Note:
       * To hide the tooltip bubble, use an empty tool tag, eg: ''echo "<tool></tool>"''       * To hide the tooltip bubble, use an empty tool tag, eg: ''echo "<tool></tool>"''
 +      * The tooltip will not display with a cycle of less than 0.5 (see: [[https://gitlab.gnome.org/GNOME/gtk/-/issues/826]])
   * **<bar>Percentage to display in the bar</bar>**   * **<bar>Percentage to display in the bar</bar>**
     * Display a value-based progress bar on the plugin.     * Display a value-based progress bar on the plugin.
     * eg. ''echo "<bar>42</bar>"'' (this will show a progress bar at 42%)     * eg. ''echo "<bar>42</bar>"'' (this will show a progress bar at 42%)
-    * Result: {{:panel-plugins:xfce4-genmon-plugin:bar.png?50|}}+    * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:bar.png?50|Genmon Percentage Bar Display Example}}
   * **<css>embedded CSS tweaks</css>**   * **<css>embedded CSS tweaks</css>**
     * This tag will allow the embedding of css tweaks directly into the plugin.     * This tag will allow the embedding of css tweaks directly into the plugin.
-    * eg. ''echo "<css>.genmon_valuebutton { background-color:green; color: yellow; padding: 5px} .genmon_label { color: lightblue; }</css>"'' +    * eg. ''echo "<css>.genmon_valuebutton { background-color:green; color: yellow; padding: 5px;}</css>"'' 
-    * Result: {{:panel-plugins:xfce4-genmon-plugin:css.png?50|}}+    * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:css.png?50|Genmon Embedded CSS Example}}
     * More information on css and css tweaking of the plugin in the **Advanced Features** section below.     * More information on css and css tweaking of the plugin in the **Advanced Features** section below.
  
 If None of the tags are detected in the result of the command, the plugin reverts to its original behavior (displaying the result of the command). If None of the tags are detected in the result of the command, the plugin reverts to its original behavior (displaying the result of the command).
  
-**Example Script (cpu temperature)**+**Example Script (system stats)**
  
-Here's a simple example of a plugin displaying the Temp of the CPU in the panel +Here is an example of a genmon plugin displaying basic system stats (cpu, memory, harddrive usage) using the <icon>, <txt>, <txtclick> and <tool> xml tags: 
-(with an icon) and the Freq in a Tooltip: +<file sh systemstats.sh> 
-<file sh cuptemp.sh> +#!/bin/sh
-#!/bin/bash +
-echo "<img>/usr/share/icons/Bluecurve/16x16/apps/gnome-monitor.png</img>" +
-declare -i cpuFreq +
-cpuFreq=$(cat /proc/cpuinfo | grep "cpu MHz" | sed 's/\ \ */ /g' | cut -f3 -d" " | cut -f1 -d".") +
-if [ $cpuFreq -ge 1000 ] +
-then +
-  cpu=$(echo $cpuFreq | cut -c1).$(echo $cpuFreq | cut -c2)GHz +
-else +
-  cpu=${cpuFreq}MHz +
-fi +
-echo "<txt>"$(cat /proc/acpi/thermal_zone/THM/temperature | sed 's/\ \ */ /g' | cut -f2 -d" ")" C</txt>" +
-echo "<tool>Freq: "$cpu"</tool>" +
-</file>+
  
-PS: Depending on your configuration, you should change the image path.+ICON=utilities-system-monitor 
 +PARTITION=sda2
  
-**Another Example Script (keyboard leds)**+# get CPU info 
 +CPU=$(cat <(grep 'cpu ' /proc/stat) <(sleep 1 && grep 'cpu ' /proc/stat) | awk -v RS="" '{printf("%02d", ($13-$2+$15-$4)*100/($13-$2+$15-$4+$16-$5))}') 
 +CPULOAD=$(uptime | tr -s " " | cut -d' ' -f9-) 
 +TOPCPU=$(ps aux --no-headers | awk '{print $3 " "  $11}' | sort -rn | head -n 5)
  
-Here's a another simple example of a plugin displaying the keyboard LED states of the caps, num and scroll lock keys: +# get memory info 
-<file sh kbdleds.sh> +MEMTOT=$(cat /proc/meminfo | grep MemTotal | awk '{printf ("% 0.1f", $2/1024000)}') 
-#!/bin/bash +MEMAVA=$(cat /proc/meminfo | grep MemAvailable | awk '{printf ("%0.1f", $2/1024000)}') 
-# genmon script to display status of keyboard LEDS +MEMUSAGE=$(free | grep Mem | awk '{printf("%02d",  $3/$2 * 100.0)}') 
-# genmon properties: +MEMUSAGE2=$(echo "$MEMTOT GB in use") 
-#   Command = path to this script +MEMUSED=$(echo "scale=2;($MEMTOT - $MEMAVA)" | bc) 
-#   Label = optional Label preceeding output +TOPMEM=$(ps aux --no-headers | awk '{print $4 " "  $11}' | sort -rn | head -n 5) 
-#   Period = how often to check the status - the lower the number the quicker the response + 
-#   Font = the font to use - monospace fonts keep the widget from resizing+# get hard drive usage info  
 +HD=$(df -hl /dev/$PARTITION | grep $PARTITION | awk '{printf ("%02d", $5)}' | sed -e 's/%//') 
 +HDUSED=$(df -hl /dev/$PARTITION | grep $PARTITION | awk '{print $3}' | sed -e 's/G//') 
 +HDSIZE=$(df -hl /dev/$PARTITION | grep $PARTITION | awk '{print $2}' | sed -e 's/G//') 
 +TOPHD=$(df -hl /dev/$PARTITION | tail -1)
  
-# configuration +# do the genmon 
-FG="white" # foreground colour +echo "<icon>$ICON</icon><iconclick>xfce4-taskmanager</iconclick>" 
-OBC="red" # background colour of cell text if active+echo "<txt> $CPU | $MEMUSAGE | $HD </txt><txtclick>xfce4-taskmanager</txtclick>" 
 +echo "<tool>-=CPU $CPULOAD=- 
 +$TOPCPU
  
-# code +-=MEM: $MEMUSED of $MEMUSAGE2=- 
-STATE=($(xset q | grep Caps\ Lock | awk '{print $4" "$8" "$12}')) +$TOPMEM
-CAPS=$([[ ${STATE[0]} == "on" ]] && echo "<span foreground='$FG' background='$OBC'>C</span>" || echo "<span foreground='$FG'>c</span>") +
-NUM=$([[ ${STATE[1]} == "on" ]] && echo "<span foreground='$FG' background='$OBC'>N</span>" || echo "<span foreground='$FG'>n</span>") +
-SCROLL=$([[ ${STATE[2]} == "on" ]] && echo "<span foreground='$FG' background='$OBC'>S</span>" || echo "<span foreground='$FG'>s</span>")    +
  
-# genmon     +-=HD usage: $HDUSED of $HDSIZE GB in use=- 
-echo "<txt>$CAPS$NUM$SCROLL</txt>" +$TOPHD</tool>"
-echo "<tool>CAPS = ${STATE[0]}" +
-echo "NUM = ${STATE[1]}" +
-echo "SCROLL = ${STATE[2]}</tool>"+
  
 exit 0 exit 0
 </file> </file>
 +
 +<figure "Genmon syststats.sh Script Example">
 +{{:panel-plugins:xfce4-genmon-plugin:syststats.png?300|Genmon syststats.sh Script Example}}
 +</figure>
  
 <note>More scripts are available at: [[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/tree/master/scripts]].</note> <note>More scripts are available at: [[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/tree/master/scripts]].</note>
 +
 +Additional genmon scripts can be found in the following online repositories (special thanks to the individual developers for creating them):
 +  * [[https://github.com/xtonousou/xfce4-genmon-scripts]]
 +  * [[https://github.com/almaceleste/xfce4-genmon-scripts]]
 +  * [[https://github.com/levimake/xfce4-genmon-panel-scripts]]
 +  * [[https://codeberg.org/jn/genmon-scripts]]
 +
  
 [[|Back To Top]] [[|Back To Top]]
Line 127: Line 151:
 **Pango Text Markup Support** **Pango Text Markup Support**
  
-Both the <txt> and <tool> tags support Pango Markups. See: [[https://developer.gnome.org/pygtk/stable/pango-markup-language.html]]. With Pango markups, you can change text attributes like font colour, weight, size, etc, in your output string. To do so, use the <span></span> tag within the <txt></txt> or <tool></tool> tags. For example, to display the output in bold red, you could use something like:+Both the <txt> and <tool> tags support Pango Markups. See: [[https://docs.gtk.org/Pango/pango_markup.html]]. With Pango markups, you can change text attributes like font colour, weight, size, etc, in your output string. To do so, use the <span></span> (or any convenience) tag within the <txt></txt> or <tool></tool> tags. For example, to display the output in bold red and italic, you could use something like: 
 + 
 +  echo "<txt><span weight='Bold' fgcolor='Red'><i>Test</i></span></txt>" 
 +   
 +Result:
  
-  echo "<txt><span weight='Bold' fgcolor='Red'>Test</span></txt>"+<figure "Genmon Pango Markup Support Example"> 
 +{{:panel-plugins:xfce4-genmon-plugin:pango.png?50|Genmon Pango Markup Support Example}} 
 +</figure>
  
 Refer to the previous link for information on all of the properties that can be set. Refer to the previous link for information on all of the properties that can be set.
Line 135: Line 165:
 **Refreshing the plugin** **Refreshing the plugin**
  
-The xfce4-genmon-plugin supports xfce4-panel plugin-event functionality to remotely force the plugin to refresh. To refresh the plugin, issue the command:+As of version 3.99, the xfce4-genmon-plugin supports xfce4-panel plugin-event functionality to remotely force the plugin to refresh. To refresh the plugin, issue the command:
  
   xfce4-panel --plugin-event=genmon-X:refresh:bool:true       xfce4-panel --plugin-event=genmon-X:refresh:bool:true    
 where "genmon-X" is the widget name of the particular genmon instance. To get this name, go to the panel properties screen and on the Items tab, hover your mouse over the genmon plugin to get it's internal name. where "genmon-X" is the widget name of the particular genmon instance. To get this name, go to the panel properties screen and on the Items tab, hover your mouse over the genmon plugin to get it's internal name.
  
-As of version 4.2.0, there is also now an "Update Now" menu item on the plugin right-click menu to immediately update the plugin (this does not reset the timer). +As of version 4.2.0, an "Update Now" menu item was added to the plugin right-click menu to immediately update the plugin (this does not reset the timer): 
 + 
 +<figure "Genmon 'Update Now' Menu Item"> 
 +{{:panel-plugins:xfce4-genmon-plugin:updatenowmenu.png|Genmon 'Update Now' Menu Item}} 
 +</figure>
  
 **Enhanced Gtk3 CSS Styling Capabilities** **Enhanced Gtk3 CSS Styling Capabilities**
  
-CSS styling capabilities have been enhanced by providing style classes for all elements of the plugin that can be styled via themes or individual overrides (~/.config/gtk-3.0/gtk.css). For more information, see: [[https://git.xfce.org/panel-plugins/xfce4-genmon-plugin/tree/CSS%20Styling.txt]].+As of version 4.0.1, CSS styling capabilities have been enhanced by providing style classes for all elements of the plugin that can be styled via themes or individual overrides (~/.config/gtk-3.0/gtk.css). For more information, see: [[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/blob/master/CSS%20Styling.txt]].
  
-As of version 4.2.0, this plugin also supports CSS tags (special thanks to @stergem) that allow you to tweak the plugin css directly from within the command/script using <css></css> tags. For example:+And as of version 4.2.0, this plugin also supports CSS tags (special thanks to @stergem) that allow you to tweak the plugin css directly from within the command/script using <css></css> tags. For example:
 <file genmonTest.sh> <file genmonTest.sh>
 #!/bin/bash #!/bin/bash
-echo "<txt>Hello</txt>"+# set Label = Hello 
 +echo "<txt>There</txt>"
 echo "<txtclick>mousepad</txtclick>" echo "<txtclick>mousepad</txtclick>"
 echo "<css>.genmon_valuebutton {background-color:red; color:yellow} .genmon_label {color:green}</css>" echo "<css>.genmon_valuebutton {background-color:red; color:yellow} .genmon_label {color:green}</css>"
 echo "<tool>Hello there</tool>" echo "<tool>Hello there</tool>"
 </file> </file>
 +
 +Result: \\ {{:panel-plugins:xfce4-genmon-plugin:hellothere.png?90|Genmon Enhanced Gtk3 CSS Styling Capabilities Example}}
  
  
Line 159: Line 196:
 ---- ----
  
-===== Screenshots ===== +===== Latest Release =====
-{{:panel-plugins:xfce4-genmon-plugin.png|:panel-plugins:xfce4-genmon-plugin.png}}+
  
-In ^this^ example, the plugin is used to (from left to right): +{{rss>https://archive.xfce.org/feeds/project/xfce4-genmon-plugin 1 date 2h}}
-  - display the date +
-  - mount/unmount an USB disk with 1 click +
-  - display the CPU temperature (and the frequency in the tooltip) +
-  - display the HD temperature +
-  - display the state of the 2 batteries of my laptop +
-  - display the WIFI quality+
  
 +[[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/blob/master/NEWS|Read the CHANGELOG]]
  
 +  * **[[https://archive.xfce.org/src/panel-plugins/xfce4-genmon-plugin/|Download current release]]** (older versions of this component are also available here)
  
-{{:panel-plugins:gmail.png|:panel-plugins:gmail.png}} +[[|Back to Top]]
- +
-In ^this^ example, we see the gmail checker script in action: +
-  - plugin display shows icon indicating state of new emails available +
-  - tooltip shows number of new messages, sender/subject of new messages, and timestamp of last check +
-  - clicking on the icon launches your email program +
- +
- +
- +
-{{:panel-plugins:sysstat.png|:panel-plugins:sysstat.png}} +
- +
-In ^this^ example, we see the sysstat script in action: +
-  - plugin display shows optional icon and 3 readings (cpu, memory, hard drive usage) +
-  - tooltip shows top 5 cpu and memory uses and hard drive space usage +
-  - clicking on the text output launches xfce4-taskmanager (//ver. 3.99 or greater//) +
- +
- +
- +
-{{:panel-plugins:googcal.png|:panel-plugins:googcal.png}} +
- +
-In ^this^ example, we see the google calendar checker script in action: +
-  - plugin display shows icon indicating state of new upcoming appointments +
-  - tooltip shows a listing of upcoming appointments +
-  - clicking on the icon opens google calendar in your browser+
  
 +----
  
 +===== Source code repository =====
  
-Most of the scripts are available in the plugin archive.+[[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin]]
  
-[[|Back To Top]] 
 ---- ----
  
-===== Latest Release ===== +===== Reporting Bugs =====
-{{rss>https://archive.xfce.org/feeds/project/xfce4-genmon-plugin 1 date description 2h}}+
  
-  * **[[https://archive.xfce.org/src/panel-plugins/xfce4-genmon-plugin/|Previous Releases]]** +  * **[[:panel-plugins:xfce4-genmon-plugin:bugs|Reporting Bugs]]** -- List of currently open bugs and instructions on how to submit new bug reports
- +
-[[|Back to Top]] +
- +
----- +
-===== Source code repository ===== +
-[[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin]] +
----- +
-===== Reporting Bugs ===== +
-  * **[[:panel-plugins:xfce4-genmon-plugin:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs+
  
 [[|Back To Top]] [[|Back To Top]]
 ---- ----
-[[ :xfce:xfce4-panel:start:|Return to Main Xfce4-panel page]]+[[:xfce:xfce4-panel:start:|Return to xfce4-panel Main Documentation Page]]