cputool(8)

👑 cputool — CPU usage management utility

okay bestie, sit down, hydrate, and let me tell you about cputool, a section 8 system utility that is genuinely about to change your whole life 💅

---

✨ SYNOPSIS ✨

cputool [OPTION] [-- COMMAND]

like. that's it. that's the whole vibe. you give it options, you optionally give it a -- and a COMMAND, and it does its thing 🫶

---

🌸 DESCRIPTION 🌸

CPUTool is a utility which manages CPU usage and system load using SIGSTOP and SIGCONT. no cap, that's the whole magic trick ✨ CPUTool is able to "slow down" process CPU usage and manage load levels caused by processes utilizing CPU and/or IO resources.

A common use for CPUTool is decreasing the CPU load caused by compression software or backup software where there is no limit on CPU or IO resources normally imposed, but it can be used to manage almost any process. literally almost anything. it's giving universal icon energy 👑

---

💖 OPTIONS 💖

• -h, --help — Display command line usage then exit. short, sweet, gone 💨
• -p, --pid PID — Manage the CPU usage of a specific PID. This is the most efficient use of CPUTool as it does not have to walk the process tree to look for forks of children. lowkey the main character option, no fork-walking required 🎀
• -P, --pid-pgrp PID — Manage the CPU usage of a specific PID's entire process group. The same can be achieved by specifying a COMMAND which CPUTool will then execute and manage the process group created by that command. whole squad, one option 🫂
• -c, --cpu-limit PERCENT — Specify the maximum CPU the process / process group can use. Expressed as percentage of total CPU. Eg. 200 is two full CPUs in a multi processor system. Specify an integer value. so like, whole numbers only bestie, keep it clean 🧼
• -l, --load-limit LOAD — Specify the maximum load the system may experience for the process process group to continue running. Specifyng a fractional value is possible (e.g. 3.5). yes you can do decimals, she's flexible 💅
• -v, --verbose — Increase the amount of messages printed to stderr.
  • -vv will additionally show statistical information.
  • -vvv will addditionally show signals being sent to processes.

the more v's the more tea ☕

• -V, --version — Output version information and exit. identity check complete ✅

---

🌈 EXAMPLES 🌈

Limit the PID 4711 to 75% use of one CPU core:

cputool -p 4711 -c 75

Run rsync for a local backup only when the system load does not exceed 7.5. See the note for -l when using program that relies on TCP network connections:

cputool -l 7.5 -- rsync -av /home /backup/`date +%Y-%m-%d`

see how the -- separates your options from the command? iconic behaviour honestly 🦋

---

🧚 NOTES 🧚

CPUTool should run on all Linux systems. It depends on the /proc pseudo-filesystem to detect PIDs and their resource usage.

TCP network connections could time out if process execution is suspended for extended periods of time (while the load is too high). Not all programs handle this case well. so like... be aware. not every program is emotionally equipped to handle being paused mid-conversation 😭

---

💀 BUGS 💀

Please report all bugs you discover. This should be done via:

1. the project issue tracker

<https://gitlab.devlabs.linuxassist.net/cputool/cputool/-/issues>

Alternatively, you may report bugs to your software distributor / vendor. we wanna hear about it fr fr, don't gatekeep your bug reports 🙈

---

💜 AUTHORS 💜

Please refer to the AUTHORS file distributed with CPUTool.

---

🍓 COPYRIGHT 🍓

Copyright (c) 2012-2021, AllWorldIT., and the authors listed in the CPUTool AUTHORS file.

---

⭐ LICENSE ⭐

cputool is distributed under the terms of the GNU v3+. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

NO warranty bestie, capital N capital O, she said what she said 💅

---

and that's the whole page!! 💖 this was cputool, section 8, hanging out in the System Utilities crowd — go forth and throttle responsibly, you absolute legend 👑✨