aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 17beaf0f46355d08e701a409e9ef2f519629c7d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
What?
=====
This is a fork of trayfreq. It provides two icons in your system tray; one for your battery and one for your CPU.
Hover the mouse over each for information, or right click the CPU to switch governors and frequencies.
Simple.


Installation
------------

* [Paramano on the AUR](https://aur.archlinux.org/packages/paramano)
* [Latest stable source package](http://phillid.tk/sources/paramano-0.60.tar.gz)
* A Gentoo ebuild is provided in the `build/` directory
* For other distros, you'll likely want to install Paramano using your package manager, creating a package if one doesn't exist in your distro's repositories.

Runtime Dependencies
--------------------

* gtk3
* sudo

Building
========
Due to KISS, I don't tend to use ./configure scripts for relatively small programs.
The sort of parameters you might pass to a ./configure can instead be passed to make.

Here's a list:

* BINDIR to override default binary directory (`/usr/bin`) for paramano and paramano-set
* PREFIX to prefix all paths with something
* SHAREDIR to override default of `/usr/share/`
* LOCALEDIR to override default of `SHAREDIR/locale`
* SUDO to override default sudo program `BINDIR/sudo`
* MAKE to override default make program `make`
* CC to override default compiler `gcc`
* PARAMANO_SET to override default paramano-set program of `BINDIR/paramano-set`
* DEBUG can be set to anything to build a huge amount of debug output stuff into parmano and parmano-set
* DESTDIR (only for `make install` -- see below)

FAQ
===
Changing the governor/frequency doesn't work!
---------------------------------------------
You need root permissions to change the governor or frequency.
Paramano will detect if it's not being run as root, and attempt to use sudo to elevate any calls to `paramano-set` to root.
However, this requires passwordless sudo access to `paramano-set`.
Here is an example for the user `alice`:

    # ... (/etc/sudoers)
	alice ALL = NOPASSWD: /usr/bin/paramano-set
	# ...


This won't build under MinGW/This doesn't work on Windows
-----------------------------
Correct.