Skip to content

Commit f0d0527

Browse files
authored
Update readme.md
Production ready
1 parent 45a2d14 commit f0d0527

File tree

1 file changed

+106
-63
lines changed

1 file changed

+106
-63
lines changed
Lines changed: 106 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,123 +1,147 @@
1-
### IMPORTANT: This is being updated, files, specific instructions coming soon. This is a template only!
2-
3-
41
# Tuned-PPD Customizer Script Usage Guide
52

3+
### Important consideration
4+
Out of the box, by default, Fedora 41 power settings are excellent. However, for those who want more control over their power performance, this script provides a helping hand while remaining with the existing GNOME power profile menu.
5+
66
## What Does This Script Do?
77

88
This script helps you customize how your Fedora system manages power and performance through GNOME's power menu. It lets you change which power management profiles are used when you select "Power Saver" or "Performance" in the GNOME power menu.
99

1010
## How It Works
1111

12-
1. **GNOME Power Menu**: The menu in your system tray that lets you choose between power modes
13-
2. **The Configuration File** (`/etc/tuned/ppd.conf`): Stores your power profile settings
14-
3. **tuned-ppd.service**: Fedora's service that applies these settings when you change power modes
12+
1. **GNOME Power Menu**: The menu in your system tray that lets you choose between power modes.
13+
2. **The Configuration File** (`/etc/tuned/ppd.conf`): Stores your power profile settings.
14+
3. **tuned-ppd.service**: Fedora's service that applies these settings when you change power modes.
1515

1616
## What You Can Do With This Script
1717

18-
- Back up your current power settings
19-
- Download additional power management profiles
20-
- Change which profile is used for "Power Saver" mode
21-
- Change which profile is used for "Performance" mode
22-
- View your current configuration
23-
- Restore previous settings from backup
18+
- Back up your current power settings.
19+
- Download additional power management profiles.
20+
- Change which profile is used for "Power Saver" mode.
21+
- Change which profile is used for "Performance" mode.
22+
- View your current configuration.
23+
- Restore previous settings from backup.
24+
25+
![Launch screen](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/1.png)
2426

2527
## Using the Script
2628

27-
1. Run the script:
29+
### Install Curl
30+
31+
Curl should already be installed, but just in case:
32+
33+
### Fedora
34+
```
35+
sudo dnf install curl -y
36+
```
37+
 
38+
 
39+
 
40+
41+
## To Install Tuned-PPD Customizer Script, simply run:
42+
```
43+
curl -s https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/tuned-ppd.sh -o tuned-ppd.sh && clear && bash tuned-ppd.sh
44+
```
45+
 
46+
 
47+
 
48+
49+
1. Run the script after later on, from your home directory:
2850
```bash
2951
bash tuned-ppd.sh
3052
```
3153

3254
2. Choose from the menu options to:
33-
- Back up your settings
34-
- Apply a different profile
35-
- View current settings
36-
- Restore previous settings
55+
- Back up your settings.
56+
- Apply a different profile.
57+
- View current settings.
58+
- Restore previous settings.
3759

3860
## Available Profiles
3961

4062
### Power Saving Profiles
4163

4264
1. **balanced-battery**
43-
- Balances performance and power consumption
44-
- Uses CPU frequency scaling to reduce power usage while maintaining reasonable performance
65+
- Balances performance and power consumption.
66+
- Uses CPU frequency scaling to reduce power usage while maintaining reasonable performance.
4567

4668
2. **cpu-partitioning-powersave**
47-
- Optimizes power consumption for multi-core systems
48-
- Uses CPU frequency scaling and core parking
69+
- Optimizes power consumption for multi-core systems.
70+
- Uses CPU frequency scaling and core parking.
4971

5072
3. **desktop-powersave**
51-
- Prioritizes power saving for desktop systems
52-
- Reduces CPU frequency, dims display, powers down idle devices
73+
- Prioritizes power saving for desktop systems.
74+
- Reduces CPU frequency, dims display, powers down idle devices.
5375

5476
4. **laptop-ac-powersave**
55-
- Balances performance and power for AC-powered laptops
56-
- Uses moderate power-saving techniques
77+
- Balances performance and power for AC-powered laptops.
78+
- Uses moderate power-saving techniques.
5779

5880
5. **laptop-battery-powersave**
59-
- Maximizes battery life
60-
- Uses aggressive power-saving measures
81+
- Maximizes battery life.
82+
- Uses aggressive power-saving measures.
6183

6284
6. **powersave**
63-
- Prioritizes power saving above all else
64-
- Uses maximum power-saving techniques
85+
- Prioritizes power saving above all else.
86+
- Uses maximum power-saving techniques.
6587

6688
7. **server-powersave**
67-
- Optimizes server power consumption
68-
- Balances server performance with energy efficiency
89+
- Optimizes server power consumption.
90+
- Balances server performance with energy efficiency.
6991

7092
### Performance Profiles
7193

7294
1. **accelerator-performance**
73-
- Optimizes systems with hardware accelerators (GPUs/FPGAs)
74-
- Prioritizes accelerator resource allocation
95+
- Optimizes systems with hardware accelerators (GPUs/FPGAs).
96+
- Prioritizes accelerator resource allocation.
7597

7698
2. **enterprise-storage**
77-
- Optimizes enterprise storage system performance
78-
- Tunes disk scheduling and I/O operations
99+
- Optimizes enterprise storage system performance.
100+
- Tunes disk scheduling and I/O operations.
79101

80102
3. **latency-performance**
81-
- Minimizes system latency
82-
- Optimizes for low response times
103+
- Minimizes system latency.
104+
- Optimizes for low response times.
83105

84106
4. **network-latency**
85-
- Reduces network latency
86-
- Optimizes network settings for minimal delay
107+
- Reduces network latency.
108+
- Optimizes network settings for minimal delay.
87109

88110
5. **network-throughput**
89-
- Maximizes network throughput
90-
- Optimizes for high data transfer rates
111+
- Maximizes network throughput.
112+
- Optimizes for high data transfer rates.
91113

92114
6. **throughput-performance**
93-
- Maximizes system throughput
94-
- Optimizes for high data processing rates
115+
- Maximizes system throughput.
116+
- Optimizes for high data processing rates.
95117

96118
## Recommendations
97119

98120
### For Laptops: Maximum Battery Life
99121
Best profile: `laptop-battery-powersave`
100-
- Optimized specifically for laptop battery operation
101-
- Aggressively reduces power consumption
102-
- Manages CPU frequency, screen brightness, and device power states
103-
- Best choice when you need to maximize battery life
122+
- Optimized specifically for laptop battery operation.
123+
- Aggressively reduces power consumption.
124+
- Manages CPU frequency, screen brightness, and device power states.
125+
- Best choice when you need to maximize battery life.
104126

105127
### For Gaming: Maximum Performance
106128
Best profile: `latency-performance`
107-
- Minimizes system latency
108-
- Keeps CPU at maximum frequency
109-
- Optimizes for quick system response
110-
- Ideal for games where every millisecond counts
129+
- Minimizes system latency.
130+
- Keeps CPU at maximum frequency.
131+
- Optimizes for quick system response.
132+
- Ideal for games where every millisecond counts.
111133

112134
### For High Computational Tasks
113135
Best profile: `accelerator-performance`
114-
- Optimized for GPU and accelerator-heavy workloads, or just general high performance non-specific tasks
115-
- Ideal for video editing and machine learning tasks
116-
- Prioritizes accelerator and computational performance
117-
- Best choice when using CUDA, OpenCL, or similar GPU compute tasks
136+
- Optimized for GPU and accelerator-heavy workloads, or just general high performance non-specific tasks.
137+
- Ideal for video editing and machine learning tasks.
138+
- Prioritizes accelerator and computational performance.
139+
- Best choice when using CUDA, OpenCL, or similar GPU compute tasks.
118140

119141
## Troubleshooting
120142

143+
You are using tuned-ppd, not PPD or tuneD itself. Fedora 41 by default, is already using tuned-ppd.
144+
121145
If you see the error `Error: /etc/tuned/ppd.conf does not exist!`:
122146

123147
1. Verify the configuration file:
@@ -130,12 +154,31 @@ If you see the error `Error: /etc/tuned/ppd.conf does not exist!`:
130154

131155
Contact support before making additional changes if issues persist.
132156

133-
## Important Notes
157+
## Important Notes and FAQ
158+
159+
- The script is designed for Fedora installations, should work on any distro with tuned-ppd running though with some minor tweaks.
160+
- We get the additional profiles from https://github.com/redhat-performance/tuned/
161+
- Changes take effect immediately after applying a new profile.
162+
- Always keep a backup of your settings using this script.
163+
- These recommendations are based on typical use cases; your specific needs may vary.
164+
- The script clears the terminal screen between sections for better readability.
165+
- Why are you using bsdtar vs something else? It's been shown to be more reliable for this script. For Fedora users, it self-installs.
166+
- **For enhanced control**, consider using the [TunedSwitcher](https://flathub.org/apps/org.easycoding.TunedSwitcher) Flatpak (compatible with GNOME/KDE).
167+
- Ubuntu support is planned for future releases.
168+
169+
## Screenshots
170+
171+
![Launch screen](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/1.png)
172+
173+
![Backup](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/2.png)
174+
175+
![Install additional profiles](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/3.png)
176+
177+
![Restore most recent backup](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/4.png)
178+
179+
![Select a profile](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/5.png)
180+
181+
![View powersave and performance configuration](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/6.png)
134182

135-
- The script is designed for Fedora systems, should work on any distro with tuned-ppd running though
136-
- Changes take effect immediately after applying a new profile
137-
- Always keep a backup of your settings using this script
138-
- These recommendations are based on typical use cases; your specific needs may vary
139-
- The script clears the terminal screen between sections for better readability
140-
- For enhanced control, consider using the Tuned Switcher Flatpak (compatible with GNOME/KDE)
141-
- Ubuntu support is planned for future releases
183+
(Note: my theme just happens to be purple, your default GNOME menu will be used)
184+
![GNOME power menu remains default](https://raw.githubusercontent.com/FrameworkComputer/linux-docs/refs/heads/main/Tuned-PPD-Customizer-Script/images/7.png)

0 commit comments

Comments
 (0)