github/nohang
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Alexey Avramov 2018-07-21 19:35:41 +09:00
parent d4b89e27e9
commit 9d96e54d07
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -45,12 +45,12 @@ Also look at [Why are low memory conditions handled so badly?](https://www.reddi
## Requirements ## Requirements
- `Linux 3.14+` (because the MemAvailable parameter appeared in /proc/meminfo since kernel version 3.14) and `Python 3.4+` (compatibility with earlier versions was not tested) for basic usage - `Linux 3.14+` and `Python 3.4+` for basic usage
- `libnotify` (Fedora, Arch) or `libnotify-bin` (Debian, Ubuntu) for desktop notifications and `sudo` for desktop notifications as root - `libnotify` (Fedora, Arch) or `libnotify-bin` (Debian, Ubuntu) to show GUI notifications
## Memory and CPU usage ## Memory and CPU usage
- VmRSS is 10 — 13.5 MiB depending on the settings - VmRSS is 10 — 14 MiB depending on the settings
- CPU usage depends on the level of available memory (the frequency of memory status checks increases as the amount of available memory decreases) and monitoring intensity (can be changed by user via config) - CPU usage depends on the level of available memory (the frequency of memory status checks increases as the amount of available memory decreases) and monitoring intensity (can be changed by user via config)
## Status ## Status
@ -60,20 +60,20 @@ The program is unstable and some fixes are required before the first stable vers
## Download ## Download
```bash ```bash
git clone https://github.com/hakavlad/nohang.git $ git clone https://github.com/hakavlad/nohang.git
cd nohang cd nohang
``` ```
## Installation and start for systemd users ## Installation and start for systemd users
```bash ```bash
sudo ./install.sh $ sudo ./install.sh
``` ```
## Purge ## Purge
```bash ```bash
sudo ./purge.sh $ sudo ./purge.sh
``` ```
## Command line options ## Command line options
@ -93,14 +93,16 @@ optional arguments:
The program can be configured by editing the [config file](https://github.com/hakavlad/nohang/blob/master/nohang.conf). The configuration includes the following sections: The program can be configured by editing the [config file](https://github.com/hakavlad/nohang/blob/master/nohang.conf). The configuration includes the following sections:
- Thresholds for sending signals to victims 1. Memory levels to respond to as an OOM threat
- Intensity of monitoring (and CPU usage) 2. The frequency of checking the level of available memory (and CPU usage)
- Prevention of killing innocent victims 3. The prevention of killing innocent victims
- Avoid and prefer victim names via regex matching 4. Impact on the badness of processes via matching their names with regular expressions
- Execute the command instead of sending the SIGTERM signal 5. The execution of a specific command instead of sending the SIGTERM signal
- GUI notifications: results of preventing OOM and low memory warnings 6. GUI notifications:
- Self-defense and preventing slowing down the program - results of preventing OOM
- Output verbosity - low memory warnings
7. Preventing the slowing down of the program
8. Output verbosity
Just read the description of the parameters and edit the values. Please restart nohang to apply changes. Default path to the config arter installing via `./install.sh` is `/etc/nohang/nohang.conf`. Just read the description of the parameters and edit the values. Please restart nohang to apply changes. Default path to the config arter installing via `./install.sh` is `/etc/nohang/nohang.conf`.