Difference between revisions of "Paramano"

From ArchWiki
Jump to: navigation, search
m (add ja link)
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
[[Category:Power management]]
 
[[Category:Power management]]
 
[[Category:CPU]]
 
[[Category:CPU]]
[[Category:Daemons and system services]]
 
 
[[it:Trayfreq]]
 
[[it:Trayfreq]]
[[ru:Trayfreq]]
+
[[ja:Paramano]]
== Introduction ==
+
[[ru:Trayfreq-archlinux]]
Trayfreq (pronounced tray-freek) is a GTK+ application released under GPL that lets you select your CPU's governor or frequency from a tray icon and displays information for your battery. Trayfreq is designed to be desktop-environment-independent so it depends only on GTK+ and a system tray to show its icons. Trayfreq is the perfect addition to Xfce, LXDE, and Window Managers (Openbox, Fluxbox, etc.).
+
Paramano is a Gtk3 application released under the GPL that lets you select your cores' governor or frequency from a tray icon and displays information about your battery graphically. Paramano is designed to be desktop-environment-independent so it depends only on Gtk3, a system tray and sudo. It's a nice addition to Xfce, LXDE, dwm, and so on.
  
{{Warning| Package in AUR might not work with post 3.0.4 kernels. See recent comments. }}
+
== Short history ==
 +
The original version was abandoned at 0.2.x.dev1-3 (sometime during 2009) and eventually failed as {{ic|/proc/acpi/}} became deprecated. The original project was forked and named trayfreq-archlinux with the aim of bringing trayfreq back into functionality.
  
=== Latest Version ===
+
It was later renamed to Paramano, initially a nonsense word which turned out to mean 'cuff' in Italian.
0.2.x.dev1-3
+
  
=== Features ===
+
== Features ==
* Displays a icon that shows you the relative current CPU frequency
+
* Displays an icon that shows you the current CPU frequency as a proportion of the maximum
 
* When the CPU icon is right-clicked, it provides a menu of available frequencies and governors to choose.
 
* When the CPU icon is right-clicked, it provides a menu of available frequencies and governors to choose.
* When the CPU icon is left-clicked, it runs a command (set in config file, default nothing)
+
* (Optional) Displays a icon that shows you the status of your battery (charging, discharging, charged) and its current charge
* Displays a icon that shows you the status of your Battery (Charging, Discharging, Charged) and its relative current charge (optional)
+
* Hovering over the battery icon gives the estimated time until fully charged/discharged
* Toggling of CPU governor based on if the battery is discharging or not.
+
* Automatic switching of CPU governor based on AC adapter presence
* Lightweight, Desktop-Environment Independent
+
* Configuration can be reloaded on-the-fly by sending the {{ic|USR1}} signal
 +
* Lightweight and desktop-environment-independent
  
 
== Installation ==
 
== Installation ==
Install [https://aur.archlinux.org/packages.php?ID=26999 trayfreq] from the [[AUR]]. [[AUR Helpers]] are available.
+
Install {{AUR|paramano}} from the AUR.
 +
Then optionally edit the configuration file.
 +
If you want to have per-user configuration, then create a configuration file in your home directory:
  
=== System Setup ===
+
$ cp /etc/paramano.conf ~/.paramano.conf
For Trayfreq to work, you will need the appropriate kernel modules loaded and added to your [[rc.conf]]. See [[CPU Frequency Scaling]] for instructions on loading cpufreq drivers and governors.
+
  
=== Trayfreq Setup ===
+
Without this, what you change in the next step will be system-wide – it's your choice.
Now, let's edit the configuration file for trayfreq.
+
 
$ cp /usr/share/trayfreq/trayfreq.config ~/.trayfreq.config
+
Open the appropriate config file ({{ic|/etc/paramano.conf}} or {{ic|~/.paramano.conf}}) with your favourite editor.
$ nano ~/.trayfreq.config
+
Everything will be commented out; un-comment what you want to use.
Everything will be commented out; uncomment what you want to use. Let's go through the options
+
*{{Ic|[battery]}} – the group battery
+
**{{Ic|show=1}} – 1 to show the battery tray icon, 0 to not show it
+
**{{Ic|governor=powersave}} – this sets the governor to use if the battery is discharging
+
*{{Ic|[ac]}} – the group for if the batter is not discharging
+
**{{Ic|governor=ondemand}} – this sets the governor to use if the battery is not discharging
+
*{{Ic|[events]}} – the group events
+
**{{Ic|activate=/usr/bin/xterm}} – this sets the program to launch when the tray icon is activated (left clicked usually)
+
*{{Ic|[governor]}} – the group governor
+
**{{Ic|default=ondemand}} – this sets the default governor to be set when trayfreq starts
+
*{{Ic|[frequency]}} – the group frequency
+
**{{Ic|default=800000}} – this sets the default frequency in hertz to be set when trayfreq starts
+
 
Note that, if a default frequency is set, it will override the governor.   
 
Note that, if a default frequency is set, it will override the governor.   
  
Sample File:
+
== Troubleshooting and tips ==
[battery]
+
A desktop file is installed into {{ic|/etc/xdg/autostart/}}. It will automatically start once installed. If you do not want it to start automatically, open the start up manager that comes with your desktop environment and uncheck paramano.
show=1
+
 
governor=powersave
+
If paramano doesn't seem to want to change the governor, it'll be because it's detected that it's not running as root and has tried to use sudo to elevate its privileges. However, it requires that it has passwordless access to run {{ic|/usr/bin/paramano-set}}. If you have sudo configured such that you type your password to authenticate, you'll need to add this line to {{ic|/etc/sudoers}}:
[ac]
+
governor=ondemand
+
[events]
+
activate=/usr/bin/showbatt
+
[governor]
+
default=ondemand
+
#[frequency]
+
#default=800000
+
  
If you want, you can have a configuration file in your home folder, but it can now set the program to run when the tray icon is activated too. The file should be {{ic|~/.trayfreq.config}}; if it exists, trayfreq will not look at {{ic|/usr/share/trayfreq/trayfreq.config}}.
+
  your_user_name ALL = NOPASSWD: /usr/bin/paramano-set
  
== Remarks ==
+
== See also ==
A desktop file is installed into {{ic|/etc/xdg/autostart/}}. It will automatically start once installed.  If you do not want it to start automatically, open the start up manager that comes with your desktop enviroment and uncheck trayfreq.
+
  
== External Links ==
+
* [https://github.com/phillid/paramano Paramano main page]
*[http://trayfreq.sourceforge.net Trayfreq's Website]
+
* [https://github.com/phillid/paramano/releases Paramano releases]
 +
* [http://trayfreq.sourceforge.net Original Trayfreq Website]

Latest revision as of 00:00, 5 March 2015

Paramano is a Gtk3 application released under the GPL that lets you select your cores' governor or frequency from a tray icon and displays information about your battery graphically. Paramano is designed to be desktop-environment-independent so it depends only on Gtk3, a system tray and sudo. It's a nice addition to Xfce, LXDE, dwm, and so on.

Short history

The original version was abandoned at 0.2.x.dev1-3 (sometime during 2009) and eventually failed as /proc/acpi/ became deprecated. The original project was forked and named trayfreq-archlinux with the aim of bringing trayfreq back into functionality.

It was later renamed to Paramano, initially a nonsense word which turned out to mean 'cuff' in Italian.

Features

  • Displays an icon that shows you the current CPU frequency as a proportion of the maximum
  • When the CPU icon is right-clicked, it provides a menu of available frequencies and governors to choose.
  • (Optional) Displays a icon that shows you the status of your battery (charging, discharging, charged) and its current charge
  • Hovering over the battery icon gives the estimated time until fully charged/discharged
  • Automatic switching of CPU governor based on AC adapter presence
  • Configuration can be reloaded on-the-fly by sending the USR1 signal
  • Lightweight and desktop-environment-independent

Installation

Install paramanoAUR from the AUR. Then optionally edit the configuration file. If you want to have per-user configuration, then create a configuration file in your home directory:

$ cp /etc/paramano.conf ~/.paramano.conf

Without this, what you change in the next step will be system-wide – it's your choice.

Open the appropriate config file (/etc/paramano.conf or ~/.paramano.conf) with your favourite editor. Everything will be commented out; un-comment what you want to use. Note that, if a default frequency is set, it will override the governor.

Troubleshooting and tips

A desktop file is installed into /etc/xdg/autostart/. It will automatically start once installed. If you do not want it to start automatically, open the start up manager that comes with your desktop environment and uncheck paramano.

If paramano doesn't seem to want to change the governor, it'll be because it's detected that it's not running as root and has tried to use sudo to elevate its privileges. However, it requires that it has passwordless access to run /usr/bin/paramano-set. If you have sudo configured such that you type your password to authenticate, you'll need to add this line to /etc/sudoers:

your_user_name ALL = NOPASSWD: /usr/bin/paramano-set

See also