| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| panel-plugins:xfce4-genmon-plugin:start [2021/03/17 23:45] – created kevinbowen | panel-plugins:xfce4-genmon-plugin:start [2025/01/03 04:17] (current) – update screenshot kevinbowen |
|---|
| ~~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 image, a bar, a button and a personalized tooltip. | |
| |
| * **[[#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]]** |
| |
| |
| ===== Usage ===== | |
| 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. | |
| |
| **XML Tags** | ===== Important Note about version 4.2.0 ===== |
| |
| If you want the plugin to display a personalized ''Image'' or ''Tooltip'' or ''Bar'' or ''Button'', you should develop (or get) a script returning a XML string, and enter the path of this script in the //Command// field of the //Property// section of the plugin. | <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> |
| |
| The XML tags which can be used: | |
| * ''<txt>Text to display</txt>'' | |
| * ''<img>Path to the image to display</img>'' | |
| * ''<tool>Tooltip text</tool>'' | |
| * ''<bar>Pourcentage to display in the bar</bar>'' | |
| * ''<click>The command to be executed when clicking on the image</click>'' | |
| * ''<txtclick>The command to be executed when clicking on the text</txtclick>'' | |
| * ''<icon>Themed icon to be displayed</icon>'' | |
| * ''<iconclick>The command to be executed when clicking on the icon</click>'' | |
| |
| The <icon> tag allows the following functionality: | ===== Screenshots ===== |
| * image changes with the icon theme | |
| * supports panel's Adjust Icon Size Automatically functionality | |
| * supports light/dark symbolic icon auto-colour changes | |
| |
| If None of the tags are detected in the result of the command, the plugin returns to its original behaviour (displaying the result of the command). | <figure "Genmon Configuration/Properties Dialog Window"> |
| | {{:panel-plugins:xfce4-genmon-plugin-properties.png|Genmon Configuration/Properties Dialog Window}} |
| | </figure> |
| |
| **Example Script (cpu temperature)** | [[|Back To Top]] |
| | ---- |
| |
| Here's a simple example of a plugin displaying the Temp of the CPU in the panel | ===== Usage ===== |
| (with an icon) and the Freq in a Tooltip: | |
| <file sh cuptemp.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. | |
| |
| **Another Example Script (keyboard leds)** | - [[: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. |
| |
| Here's a another simple example of a plugin displaying the keyboard LED states of the caps, num and scroll lock keys: | 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. |
| <file sh kbdleds.sh> | |
| #!/bin/bash | |
| # genmon script to display status of keyboard LEDS | |
| # genmon properties: | |
| # Command = path to this script | |
| # Label = optional Label preceeding output | |
| # 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 | |
| |
| # configuration | **XML Tags** |
| FG="white" # foreground colour | |
| OBC="red" # background colour of cell text if active | |
| |
| # code | If you want the plugin to display a personalized ''Text'', ''Image'', ''Icon'', ''Tooltip'' or ''Bar'', you should develop (or get) a script returning a XML string, and enter the path of this script in the //Command// field of the //Property// section of the plugin. |
| STATE=($(xset q | grep Caps\ Lock | awk '{print $4" "$8" "$12}')) | |
| 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 | The XML tags which can be used: |
| echo "<txt>$CAPS$NUM$SCROLL</txt>" | * **<txt>Text to display</txt>** |
| echo "<tool>CAPS = ${STATE[0]}" | * Displays the "Text to display" directly on the plugin. |
| echo "NUM = ${STATE[1]}" | * eg. ''echo "<txt>Hello World!</txt>"'' |
| echo "SCROLL = ${STATE[2]}</tool>" | * 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>** |
| | * If displaying text, this tag will allow for a program/script to be run when the text is clicked. |
| | * eg. ''echo "<txt>File Manager</txt><txtclick>thunar</txtclick>"'' |
| | * **<img>Path to the image to display</img>** |
| | * 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>"'' |
| | * 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>** |
| | * If using an image, this tag will allow for a program/script to be run when the image is clicked. |
| | * eg. ''echo "<img>/usr/share/pixmaps/xfce4_xicon.png</img><click>xfce4-about</click>"'' |
| | * **<icon>Themed icon to be displayed</icon>** |
| | * Display an icon from the current icon theme using only the icon name. |
| | * eg. ''echo "<icon>org.xfce.mousepad</icon>"'' |
| | * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:icon.png?50|Genmon Display Themed Icon Example}} |
| | * Note: the <icon> tag allows the following functionality: |
| | * image changes with the icon theme |
| | * supports panel's 'Adjust Icon Size Automatically' functionality |
| | * supports light/dark symbolic icon auto-colour changes |
| | * **<iconclick>The command to be executed when clicking on the icon</click>** |
| | * If using an icon, this tag will allow for a program/script to run when the icon is clicked. |
| | * eg. ''echo "<icon>org.xfce.mousepad</icon><iconclick>mousepad</iconclick>"'' |
| | * **<tool>Tooltip text</tool>** |
| | * Display specific content in a tooltip. |
| | * eg. ''echo "<tool>My custom tooltip text</tool>"'' |
| | * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:tool.png?150|Genmon Tooltip Text Display Example}} |
| | * Note: |
| | * 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>** |
| | * Display a value-based progress bar on the plugin. |
| | * eg. ''echo "<bar>42</bar>"'' (this will show a progress bar at 42%) |
| | * Result: \\ {{:panel-plugins:xfce4-genmon-plugin:bar.png?50|Genmon Percentage Bar Display Example}} |
| | * **<css>embedded CSS tweaks</css>** |
| | * 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;}</css>"'' |
| | * 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. |
| |
| exit 0 | 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). |
| </file> | |
| |
| More scripts are available at: [[http://git.xfce.org/panel-plugins/xfce4-genmon-plugin/tree/scripts]]. | **Example Script (system stats)** |
| |
| **Pango Markups in the <txt> tag** | 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: |
| | <file sh systemstats.sh> |
| | #!/bin/sh |
| |
| 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: | ICON=utilities-system-monitor |
| | PARTITION=sda2 |
| |
| echo "<txt><span weight='Bold' fgcolor='Red'>Test</span></txt>" | # 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) |
| |
| Refer to the previous link for information on all of the properties that can be set. | # get memory info |
| | MEMTOT=$(cat /proc/meminfo | grep MemTotal | awk '{printf ("% 0.1f", $2/1024000)}') |
| | MEMAVA=$(cat /proc/meminfo | grep MemAvailable | awk '{printf ("%0.1f", $2/1024000)}') |
| | MEMUSAGE=$(free | grep Mem | awk '{printf("%02d", $3/$2 * 100.0)}') |
| | MEMUSAGE2=$(echo "$MEMTOT GB in use") |
| | MEMUSED=$(echo "scale=2;($MEMTOT - $MEMAVA)" | bc) |
| | TOPMEM=$(ps aux --no-headers | awk '{print $4 " " $11}' | sort -rn | head -n 5) |
| |
| **Refreshing the plugin** | # 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) |
| |
| The xfce4-genmon-plugin now supports xfce4-panel plugin-event functionality. Currently it only supports the "refresh" action which resets the timer and causes the associated command to execute again. You can use this command remotely or at the end of a script to force the panel plugin to refresh. | # do the genmon |
| | echo "<icon>$ICON</icon><iconclick>xfce4-taskmanager</iconclick>" |
| | echo "<txt> $CPU | $MEMUSAGE | $HD </txt><txtclick>xfce4-taskmanager</txtclick>" |
| | echo "<tool>-=CPU $CPULOAD=- |
| | $TOPCPU |
| |
| To refresh the plugin, issue the command: | -=MEM: $MEMUSED of $MEMUSAGE2=- |
| | $TOPMEM |
| |
| xfce4-panel --plugin-event=genmon-X:refresh:bool:true | -=HD usage: $HDUSED of $HDSIZE GB in use=- |
| 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. | $TOPHD</tool>" |
| |
| | exit 0 |
| | </file> |
| |
| **Enhanced Gtk3 CSS Styling Capabilities** | <figure "Genmon syststats.sh Script Example"> |
| | {{:panel-plugins:xfce4-genmon-plugin:syststats.png?300|Genmon syststats.sh Script Example}} |
| | </figure> |
| |
| 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]]. | <note>More scripts are available at: [[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin/-/tree/master/scripts]].</note> |
| |
| //**(*dev-only)**// functionality is currently only available in the git tree and has not yet been officially released | 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]] |
| |
| |
| ---- | ---- |
| |
| ===== Screenshots ===== | ===== Advanced Features ===== |
| {{:panel-plugins:xfce4-genmon-plugin.png|:panel-plugins:xfce4-genmon-plugin.png}} | **Pango Text Markup Support** |
| |
| In this example, the plugin is used to (from left to right): | 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: |
| - 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 | |
| |
| | echo "<txt><span weight='Bold' fgcolor='Red'><i>Test</i></span></txt>" |
| | |
| | Result: |
| |
| | <figure "Genmon Pango Markup Support Example"> |
| | {{:panel-plugins:xfce4-genmon-plugin:pango.png?50|Genmon Pango Markup Support Example}} |
| | </figure> |
| |
| {{:panel-plugins:gmail.png|:panel-plugins:gmail.png}} | Refer to the previous link for information on all of the properties that can be set. |
| |
| In this example, we see the gmail checker script in action: | **Refreshing the plugin** |
| - 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 | |
| |
| | 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 |
| | 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. |
| |
| {{:panel-plugins:sysstat.png|:panel-plugins:sysstat.png}} | 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): |
| |
| In this example, we see the sysstat script in action: | <figure "Genmon 'Update Now' Menu Item"> |
| - plugin display shows optional icon and 3 readings (cpu, memory, hard drive usage) | {{:panel-plugins:xfce4-genmon-plugin:updatenowmenu.png|Genmon 'Update Now' Menu Item}} |
| - tooltip shows top 5 cpu and memory uses and hard drive space usage | </figure> |
| - clicking on the text output launches xfce4-taskmanager (//ver. 3.99 or greater//) | |
| |
| | **Enhanced Gtk3 CSS Styling Capabilities** |
| |
| | 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]]. |
| |
| {{:panel-plugins:googcal.png|:panel-plugins:googcal.png}} | 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> |
| In this example, we see the google calendar checker script in action: | #!/bin/bash |
| - plugin display shows icon indicating state of new upcoming appointments | # set Label = Hello |
| - tooltip shows a listing of upcoming appointments | echo "<txt>There</txt>" |
| - clicking on the icon opens google calendar in your browser | echo "<txtclick>mousepad</txtclick>" |
| | echo "<css>.genmon_valuebutton {background-color:red; color:yellow} .genmon_label {color:green}</css>" |
| | echo "<tool>Hello there</tool>" |
| | </file> |
| {{:panel-plugins:twit0.png|:panel-plugins:twit0.png}} | |
| {{:panel-plugins:twit1.png|:panel-plugins:twit1.png}} | |
| |
| In this example, we see the twit (Twitter Timeline Notifier) script in action: | Result: \\ {{:panel-plugins:xfce4-genmon-plugin:hellothere.png?90|Genmon Enhanced Gtk3 CSS Styling Capabilities Example}} |
| - plugin display shows icon indicating state of new tweets in your timeline | |
| - libnotify notifications will be sent with new tweets | |
| - tool tip will show new and optionally recent tweets | |
| - clicking on the plugin icon can either execute a program, display a yad dialog with all recent tweets (above image), or compose and send a tweet. | |
| |
| Most of the scripts are available in the plugin archive. | |
| |
| [[|Back To Top]] | [[|Back To Top]] |
| |
| ===== Latest Release ===== | ===== Latest Release ===== |
| {{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]]** | {{rss>https://archive.xfce.org/feeds/project/xfce4-genmon-plugin 1 date 2h}} |
| | |
| | [[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) |
| |
| [[|Back to Top]] | [[|Back to Top]] |
| |
| ---- | ---- |
| | |
| ===== Source code repository ===== | ===== Source code repository ===== |
| | |
| [[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin]] | [[https://gitlab.xfce.org/panel-plugins/xfce4-genmon-plugin]] |
| | |
| ---- | ---- |
| | |
| ===== Reporting Bugs ===== | ===== Reporting Bugs ===== |
| * **[[:panel-plugins:xfce4-genmon-plugin:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs | |
| | * **[[: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]] | [[|Back To Top]] |
| ---- | ---- |
| [[ :xfce:xfce4-panel:start:|Return to Main Xfce4-panel page]] | [[:xfce:xfce4-panel:start:|Return to xfce4-panel Main Documentation Page]] |