Skip to content

Commit 2e30502

Browse files
committedNov 22, 2024
Update readme
1 parent 488df7e commit 2e30502

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed
 

‎readme.md

+50
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,56 @@ As of now afreq depends only on:
1919
- procps (vmstat, pgrep)
2020

2121

22+
## installation
23+
24+
Install everything:
25+
```sh
26+
sudo make install-all
27+
```
28+
this will provide:
29+
|component|default location|description|
30+
|----|----|----|
31+
|afreq|`/usr/local/sbin/afreq`|the actual daemon doing the work|
32+
|acpufreq|`/etc/init.d/acpufreq`|sysvinit initscript|
33+
|acpufreq.service|`/etc/systemd/system/acpufreq.service`|systemd unit|
34+
35+
36+
### install config
37+
38+
Edit the config.mk file to tweak installation options.
39+
40+
#### SysV init script
41+
42+
This repo provides 2 sysvinit init scripts, a hand written one and one that uses
43+
Debian's init-d-script framework that provides a Debian and LSB compliant init.d
44+
script that may be preferred on some environments, you can choose with the
45+
config.mk file.
46+
47+
## Usage
48+
49+
### sysvinit
50+
51+
The makefile should put the script in `/etc/init.d/acpufreq` by default, after that
52+
a simple ```sudo update-rc.d acpufreq defaults``` should be enough to activate
53+
it for the next boot
54+
55+
The service script supports the standard actions.
56+
57+
A simple `sudo service acpufreq start` will initiate the daemon.
58+
59+
60+
### systemd
61+
62+
The makefile should put the unit in `/etc/systemd/system/acpufreq.service` by
63+
default, all you need is run ```sudo systemctl enable acpufreq``` to activate the
64+
service for the next boot.
65+
66+
Initiate the service with `sudo systemctl start acpufreq`
67+
68+
69+
##
70+
71+
2272
Currently afreq.sh is a proof of concept to demonstrate that such a program can
2373
be written in a real unix way (not reinventing the wheel, using the tools
2474
available), with the expectation that it may mature further.

0 commit comments

Comments
 (0)
Please sign in to comment.