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 2020-02-03 04:55:07 +09:00
parent f869d849eb
commit e6eace7375
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -94,6 +94,11 @@ To use `PSI`:
- Awful documentation. - Awful documentation.
## nohang vs nohang-desktop
`nohang` comes with two configs: `nohang.conf` and `nohang-desktop.conf`. `nohang` comes with two systemd service unit files: `nohang.service` and `nohang-desktop.service`. Choose one.
## How to install ## How to install
#### To install on Fedora 30+: #### To install on Fedora 30+:
@ -153,11 +158,13 @@ $ sudo make uninstall
``` ```
./nohang -h ./nohang -h
usage: nohang [-h] [-v] [-p] [-c CONFIG] [-cc CONFIG] usage: nohang [-h] [-v] [-m] [-p] [-c CONFIG] [-cc CONFIG]
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-v, --version print version -v, --version print version
-m, --memload consume memory until 20 MiB remain free, and terminate
the process
-p, --print-proc-table -p, --print-proc-table
print table of processes with their badness values print table of processes with their badness values
-c CONFIG, --config CONFIG -c CONFIG, --config CONFIG
@ -184,6 +191,13 @@ The program can be configured by editing the [config file](https://github.com/ha
Just read the description of the parameters and edit the values. Please restart nohang to apply the changes. Default path to the config after installing is `/etc/nohang/nohang.conf`. Just read the description of the parameters and edit the values. Please restart nohang to apply the changes. Default path to the config after installing is `/etc/nohang/nohang.conf`.
## How to test nohang
- The safest way is to run `nohang --memload`. This causes memory consumption, and the process will exits before OOM occurs.
- Another way is to run `tail /dev/zero`. This causes fast memory comsumption and causes OOM at the end.
If testing occurs while `nohang` is running, these processes should be terminated before OOM occurs.
## Print table of processes with their badness values ## Print table of processes with their badness values
Run `sudo nohang -p` to see the table of prosesses with their badness values, oom_scores, names, UIDs etc. Run `sudo nohang -p` to see the table of prosesses with their badness values, oom_scores, names, UIDs etc.

7
nohang/nohang.1
View File

@ -83,6 +83,13 @@ Please restart nohang to apply the changes.
Default path to the config after installing is /etc/nohang/nohang.conf. Default path to the config after installing is /etc/nohang/nohang.conf.
.SH HOW TO TEST
- The safest way is to run `nohang --memload`. This causes memory consumption, and the process will exits before OOM occurs.
- Another way is to run `tail /dev/zero`. This causes fast memory comsumption and causes OOM at the end.
If testing occurs while nohang is running, these processes should be terminated before OOM occurs.
.SH LOGGING .SH LOGGING
To view the latest entries in the log (for systemd users): To view the latest entries in the log (for systemd users):