@@ -8,15 +8,15 @@
-## What is Watt
+## What is Superfreq
-Watt is a modern CPU frequency and power management utility for Linux
+Superfreq is a modern CPU frequency and power management utility for Linux
systems. It provides intelligent control of CPU governors, frequencies, and
power-saving features, helping optimize both performance and battery life.
@@ -48,81 +48,81 @@ but most common usecases are already implemented.
```bash
# Show current system information
-watt info
+superfreq info
# Run as a daemon in the background
-sudo watt daemon
+sudo superfreq daemon
# Run with verbose logging
-sudo watt daemon --verbose
+sudo superfreq daemon --verbose
# Display comprehensive debug information
-watt debug
+superfreq debug
```
### CPU Governor Control
```bash
# Set CPU governor for all cores
-sudo watt set-governor performance
+sudo superfreq set-governor performance
# Set CPU governor for a specific core
-sudo watt set-governor powersave --core-id 0
+sudo superfreq set-governor powersave --core-id 0
# Force a specific governor mode persistently
-sudo watt force-governor performance
+sudo superfreq force-governor performance
```
### Turbo Boost Management
```bash
# Always enable turbo boost
-sudo watt set-turbo always
+sudo superfreq set-turbo always
# Disable turbo boost
-sudo watt set-turbo never
+sudo superfreq set-turbo never
-# Let Watt manage turbo boost based on conditions
-sudo watt set-turbo auto
+# Let Superfreq manage turbo boost based on conditions
+sudo superfreq set-turbo auto
```
### Power and Performance Settings
```bash
# Set Energy Performance Preference (EPP)
-sudo watt set-epp performance
+sudo superfreq set-epp performance
# Set Energy Performance Bias (EPB)
-sudo watt set-epb 4
+sudo superfreq set-epb 4
# Set ACPI platform profile
-sudo watt set-platform-profile balanced
+sudo superfreq set-platform-profile balanced
```
### Frequency Control
```bash
# Set minimum CPU frequency (in MHz)
-sudo watt set-min-freq 800
+sudo superfreq set-min-freq 800
# Set maximum CPU frequency (in MHz)
-sudo watt set-max-freq 3000
+sudo superfreq set-max-freq 3000
# Set per-core frequency limits
-sudo watt set-min-freq 1200 --core-id 0
-sudo watt set-max-freq 2800 --core-id 1
+sudo superfreq set-min-freq 1200 --core-id 0
+sudo superfreq set-max-freq 2800 --core-id 1
```
### Battery Management
```bash
# Set battery charging thresholds to extend battery lifespan
-sudo watt set-battery-thresholds 40 80 # Start charging at 40%, stop at 80%
+sudo superfreq set-battery-thresholds 40 80 # Start charging at 40%, stop at 80%
```
Battery charging thresholds help extend battery longevity by preventing constant
charging to 100%. Different laptop vendors implement this feature differently,
-but Watt attempts to support multiple vendor implementations including:
+but Superfreq attempts to support multiple vendor implementations including:
- Lenovo ThinkPad/IdeaPad (Standard implementation)
- ASUS laptops
@@ -135,12 +135,12 @@ more than issue reports, as supporting hardware _needs_ hardware.
## Configuration
-Watt uses TOML configuration files. Default locations:
+Superfreq uses TOML configuration files. Default locations:
-- `/etc/xdg/watt/config.toml`
-- `/etc/watt.toml`
+- `/etc/xdg/superfreq/config.toml`
+- `/etc/superfreq.toml`
-You can also specify a custom path by setting the `WATT_CONFIG` environment
+You can also specify a custom path by setting the `SUPERFREQ_CONFIG` environment
variable.
### Sample Configuration
@@ -214,7 +214,7 @@ throttle_on_battery = true
# Logging level: Error, Warning, Info, Debug
log_level = "Info"
# Optional stats file path
-stats_file_path = "/var/run/watt-stats"
+stats_file_path = "/var/run/superfreq-stats"
# Optional: List of power supplies to ignore
[power_supply_ignore_list]
@@ -224,13 +224,13 @@ mouse_battery = "hid-12:34:56:78:90:ab-battery"
## Advanced Features
-Those are the more advanced features of Watt that some users might be more
+Those are the more advanced features of Superfreq that some users might be more
inclined to use than others. If you have a use-case that is not covered, please
create an issue.
### Dynamic Turbo Boost Management
-When using `turbo = "auto"` with `enable_auto_turbo = true`, Watt
+When using `turbo = "auto"` with `enable_auto_turbo = true`, Superfreq
dynamically controls CPU turbo boost based on:
- **CPU Load Thresholds**: Enables turbo when load exceeds `load_threshold_high`
@@ -260,16 +260,16 @@ The table below explains how different combinations of `turbo` and
| ------------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `turbo = "always"` | **Always enabled**
Turbo is always active regardless of CPU load or temperature | **Always enabled**
Turbo is always active regardless of CPU load or temperature |
| `turbo = "never"` | **Always disabled**
Turbo is always disabled regardless of CPU load or temperature | **Always disabled**
Turbo is always disabled regardless of CPU load or temperature |
-| `turbo = "auto"` | **Dynamically managed**
Watt enables/disables turbo based on CPU load and temperature thresholds | **System default**
Turbo is reset to system's default enabled state and is managed by the hardware/kernel |
+| `turbo = "auto"` | **Dynamically managed**
Superfreq enables/disables turbo based on CPU load and temperature thresholds | **System default**
Turbo is reset to system's default enabled state and is managed by the hardware/kernel |
> [!NOTE]
-> When `turbo = "auto"` and `enable_auto_turbo = false`, Watt ensures that
+> When `turbo = "auto"` and `enable_auto_turbo = false`, Superfreq ensures that
> any previous turbo state restrictions are removed, allowing the
> hardware/kernel to manage turbo behavior according to its default algorithms.
### Adaptive Polling
-Watt includes a "sophisticated" (euphemism for complicated) adaptive
+Superfreq includes a "sophisticated" (euphemism for complicated) adaptive
polling system to try and maximize power efficiency
- **Battery Discharge Analysis** - Automatically adjusts polling frequency based
@@ -294,7 +294,7 @@ idle periods, while maintaining responsiveness when needed.
### Power Supply Filtering
-Configure Watt to ignore certain power supplies (like peripheral batteries)
+Configure Superfreq to ignore certain power supplies (like peripheral batteries)
that might interfere with power state detection.
## Troubleshooting
@@ -319,11 +319,11 @@ Not all features are available on all hardware:
2. **CPU frequencies fluctuating**: May be due to thermal throttling
3. **Missing CPU information**: Verify kernel module support for your CPU
-While reporting issues, please attach the results from `watt debug`.
+While reporting issues, please attach the results from `superfreq debug`.
## Contributing
-Contributions to Watt are always welcome! Whether it's bug reports, feature
+Contributions to Superfreq are always welcome! Whether it's bug reports, feature
requests, or code contributions, please feel free to contribute.
> [!NOTE]
@@ -357,5 +357,5 @@ before committing to catch possible code smell early.
## License
-Watt is available under [Mozilla Public License v2.0](LICENSE) for your
+Superfreq is available under [Mozilla Public License v2.0](LICENSE) for your
convenience, and at our expense. Please see the license file for more details.
diff --git a/flake.nix b/flake.nix
index d7b9cbc..59bc72c 100644
--- a/flake.nix
+++ b/flake.nix
@@ -14,16 +14,16 @@
});
in {
overlays = {
- watt = final: _: {
- watt = final.callPackage ./nix/package.nix {};
+ superfreq = final: _: {
+ superfreq = final.callPackage ./nix/package.nix {};
};
- default = self.overlays.watt;
+ default = self.overlays.superfreq;
};
packages =
nixpkgs.lib.mapAttrs (system: pkgs: {
- inherit (pkgs) watt;
- default = self.packages.${system}.watt;
+ inherit (pkgs) superfreq;
+ default = self.packages.${system}.superfreq;
})
pkgsForEach;
@@ -34,8 +34,8 @@
pkgsForEach;
nixosModules = {
- watt = import ./nix/module.nix inputs;
- default = self.nixosModules.watt;
+ superfreq = import ./nix/module.nix inputs;
+ default = self.nixosModules.superfreq;
};
formatter = forAllSystems (system: nixpkgs.legacyPackages.${system}.alejandra);
diff --git a/nix/module.nix b/nix/module.nix
index 65ff310..f94d262 100644
--- a/nix/module.nix
+++ b/nix/module.nix
@@ -10,32 +10,32 @@ inputs: {
inherit (lib.lists) optional;
inherit (lib.meta) getExe;
- cfg = config.services.watt;
+ cfg = config.services.superfreq;
format = pkgs.formats.toml {};
- cfgFile = format.generate "watt-config.toml" cfg.settings;
+ cfgFile = format.generate "superfreq-config.toml" cfg.settings;
in {
- options.services.watt = {
+ options.services.superfreq = {
enable = mkEnableOption "Automatic CPU speed & power optimizer for Linux";
- package = mkPackageOption inputs.self.packages.${pkgs.stdenv.system} "watt" {
+ package = mkPackageOption inputs.self.packages.${pkgs.stdenv.system} "superfreq" {
pkgsText = "self.packages.\${pkgs.stdenv.system}";
};
settings = mkOption {
default = {};
type = submodule {freeformType = format.type;};
- description = "Configuration for Watt.";
+ description = "Configuration for Superfreq.";
};
};
config = mkIf cfg.enable {
environment.systemPackages = [cfg.package];
- # This is necessary for the Watt CLI. The environment variable
+ # This is necessary for the Superfreq CLI. The environment variable
# passed to the systemd service will take priority in read order.
- environment.etc."watt.toml".source = cfgFile;
+ environment.etc."superfreq.toml".source = cfgFile;
- systemd.services.watt = {
+ systemd.services.superfreq = {
wantedBy = ["multi-user.target"];
conflicts = [
"auto-cpufreq.service"
@@ -45,12 +45,12 @@ in {
"thermald.service"
];
serviceConfig = {
- Environment = optional (cfg.settings != {}) ["WATT_CONFIG=${cfgFile}"];
+ Environment = optional (cfg.settings != {}) ["SUPERFREQ_CONFIG=${cfgFile}"];
WorkingDirectory = "";
ExecStart = "${getExe cfg.package} daemon --verbose";
Restart = "on-failure";
- RuntimeDirectory = "watt";
+ RuntimeDirectory = "superfreq";
RuntimeDirectoryMode = "0755";
};
};
@@ -60,14 +60,14 @@ in {
assertion = !config.services.power-profiles-daemon.enable;
message = ''
You have set services.power-profiles-daemon.enable = true;
- which conflicts with Watt.
+ which conflicts with Superfreq.
'';
}
{
assertion = !config.services.auto-cpufreq.enable;
message = ''
You have set services.auto-cpufreq.enable = true;
- which conflicts with Watt.
+ which conflicts with Superfreq.
'';
}
];
diff --git a/nix/package.nix b/nix/package.nix
index 98228c5..d21c45b 100644
--- a/nix/package.nix
+++ b/nix/package.nix
@@ -5,7 +5,7 @@
fs = lib.fileset;
in
rustPlatform.buildRustPackage (finalAttrs: {
- pname = "watt";
+ pname = "superfreq";
version = "0.1.0";
src = fs.toSource {
@@ -24,14 +24,14 @@ in
meta = {
description = "Automatic CPU speed & power optimizer for Linux";
longDescription = ''
- Watt is a CPU speed & power optimizer for Linux. It uses
+ Superfreq is a CPU speed & power optimizer for Linux. It uses
the CPU frequency scaling driver to set the CPU frequency
governor and the CPU power management driver to set the CPU
power management mode.
'';
- homepage = "https://github.com/NotAShelf/watt";
- mainProgram = "watt";
+ homepage = "https://github.com/NotAShelf/superfreq";
+ mainProgram = "superfreq";
license = lib.licenses.mpl20;
platforms = lib.platforms.linux;
};
diff --git a/src/cli/debug.rs b/src/cli/debug.rs
index c3ef454..17cec0c 100644
--- a/src/cli/debug.rs
+++ b/src/cli/debug.rs
@@ -8,7 +8,7 @@ use std::time::Duration;
/// Prints comprehensive debug information about the system
pub fn run_debug(config: &AppConfig) -> Result<(), AppError> {
- println!("=== WATT DEBUG INFORMATION ===");
+ println!("=== SUPERFREQ DEBUG INFORMATION ===");
println!("Version: {}", env!("CARGO_PKG_VERSION"));
// Current date and time
@@ -190,11 +190,11 @@ pub fn run_debug(config: &AppConfig) -> Result<(), AppError> {
println!("\n--- DAEMON STATUS ---");
// Simple check for daemon status - can be expanded later
- let daemon_status = fs::metadata("/var/run/watt.pid").is_ok();
+ let daemon_status = fs::metadata("/var/run/superfreq.pid").is_ok();
println!("Daemon Running: {daemon_status}");
// Check for systemd service status
- if let Ok(systemd_status) = is_systemd_service_active("watt") {
+ if let Ok(systemd_status) = is_systemd_service_active("superfreq") {
println!("Systemd Service Active: {systemd_status}");
}
diff --git a/src/config/load.rs b/src/config/load.rs
index 4772423..51f7e22 100644
--- a/src/config/load.rs
+++ b/src/config/load.rs
@@ -32,26 +32,26 @@ pub fn load_config_from_path(specific_path: Option<&str>) -> Result
Result> {
// First try the traditional path with cpu0. This is the most common case
// and will usually catch early, but we should try to keep the code to handle
// "edge" cases lightweight, for the (albeit smaller) number of users that
- // run Watt on unusual systems.
+ // run Superfreq on unusual systems.
let cpu0_path = "/sys/devices/system/cpu/cpu0/cpufreq/scaling_available_governors";
if Path::new(cpu0_path).exists() {
let content = fs::read_to_string(cpu0_path).map_err(|e| {
@@ -546,12 +546,12 @@ pub fn get_platform_profiles() -> Result> {
}
/// Path for storing the governor override state
-const GOVERNOR_OVERRIDE_PATH: &str = "/etc/xdg/watt/governor_override";
+const GOVERNOR_OVERRIDE_PATH: &str = "/etc/xdg/superfreq/governor_override";
/// Force a specific CPU governor or reset to automatic mode
pub fn force_governor(mode: GovernorOverrideMode) -> Result<()> {
// Create directory if it doesn't exist
- let dir_path = Path::new("/etc/xdg/watt");
+ let dir_path = Path::new("/etc/xdg/superfreq");
if !dir_path.exists() {
fs::create_dir_all(dir_path).map_err(|e| {
if e.kind() == io::ErrorKind::PermissionDenied {
@@ -605,7 +605,7 @@ pub fn force_governor(mode: GovernorOverrideMode) -> Result<()> {
println!(
"Governor override set to '{governor}'. This setting will persist across reboots."
);
- println!("To reset, use: watt force-governor reset");
+ println!("To reset, use: superfreq force-governor reset");
Ok(())
}
}
diff --git a/src/daemon.rs b/src/daemon.rs
index 98810e6..dd90884 100644
--- a/src/daemon.rs
+++ b/src/daemon.rs
@@ -421,7 +421,7 @@ pub fn run_daemon(config: AppConfig, verbose: bool) -> Result<(), AppError> {
// Update the log level filter if needed, without re-initializing the logger
log::set_max_level(level_filter);
- info!("Starting Watt daemon...");
+ info!("Starting superfreq daemon...");
// Validate critical configuration values before proceeding
if let Err(err) = validate_poll_intervals(
diff --git a/src/engine.rs b/src/engine.rs
index 21f96e7..bbefc86 100644
--- a/src/engine.rs
+++ b/src/engine.rs
@@ -228,7 +228,7 @@ pub fn determine_and_apply_settings(
manage_auto_turbo(report, selected_profile_config, on_ac_power)?;
} else {
debug!(
- "Watt's dynamic turbo management is disabled by configuration. Ensuring system uses its default behavior for automatic turbo control."
+ "Superfreq's dynamic turbo management is disabled by configuration. Ensuring system uses its default behavior for automatic turbo control."
);
// Make sure the system is set to its default automatic turbo mode.
// This is important if turbo was previously forced off.
diff --git a/src/main.rs b/src/main.rs
index 8320aaa..edf762f 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -413,7 +413,7 @@ fn main() -> Result<(), AppError> {
Some(Commands::Daemon { verbose }) => daemon::run_daemon(config, verbose),
Some(Commands::Debug) => cli::debug::run_debug(&config),
None => {
- info!("Welcome to Watt! Use --help for commands.");
+ info!("Welcome to superfreq! Use --help for commands.");
debug!("Current effective configuration: {config:?}");
Ok(())
}