Browse Source

Documentation update

Serj Kalichev 5 years ago
parent
commit
5b9d549381
1 changed files with 23 additions and 4 deletions
  1. 23 4
      doc/birq.md

+ 23 - 4
doc/birq.md

@@ -1,7 +1,7 @@
 ---
 title: The BIRQ user manual
 author: Sergey Kalichev <serj.kalichev@gmail.com>
-date: 2015
+date: 2017
 ...
 
 # Overview
@@ -89,7 +89,7 @@ Actually the birq balancing is not perfect. But I think the perfect balancing is
 
 # Usage
 
-The current version of birq is 1.3.0.
+The current version of birq is 1.4.0.
 
 ```
 $ birq [options]
@@ -100,15 +100,34 @@ Options :
 * **-h, --help** - Print help.
 * **-d, --debug** - Debug mode. Don't daemonize.
 * **-v, --verbose** - Be verbose.
-* **-r, --ht** - Enable Hyper Threading support. The second threads will be considered as a real CPU. Not recommended.
+* **-c <PATH>, --conf=<PATH>** - Config file. Default is /etc/birq/birq.conf. Implemented since birq-1.4.0. 
+* **-x <PATH>, --pxm=<PATH>** - Specify proximity config file. Implemented since birq-1.1.0.
 * **-p <path>, --pid=<path>** - File to save daemon's PID to.
 * **-O <facility>, --facility=<facility>** - Syslog facility. Default is DAEMON.
+
+The following options are legacy. Use config file instead command line options:
+
+* **-r, --ht** - Enable Hyper Threading support. The second threads will be considered as a real CPU. Not recommended.
 * **-t <float>, --threshold=<float>** - Threshold to consider CPU is overloaded, in percents. Float value. Default threshold is 99%.
 * **-l <float>, --load-limit=<float>** - Don't move IRQs to CPUs loaded more than this limit, in percents. Default limit is 95%.
 * **-i <sec>, --short-interval=<sec>** - Short iteration interval in seconds. It will be used when the overloaded CPU is found. Default is 2 seconds.
 * **-I <sec>, --long-interval=<sec>** - Long iteration interval in seconds. It will be used when there is no overloaded CPUs. Default is 5 seconds.
 * **-s <strategy>, --strategy=<strategy>** - Strategy for choosing IRQ to move. The possible values are "min", "max", "rnd". The default is "rnd". Note the birq-1.0.0 uses **-c, --choose** option name for the same functionality.
-* **-x <PATH>, --pxm=<PATH>** - Specify proximity config file. Implemented since birq-1.1.0.
+
+# Configuration file
+
+The default location of config file is /etc/birq/birq.conf. But you can specify another location by '-c' birq command line option.
+
+The config file can be re-read by sending SIGHUP signal to birq daemon.
+
+Options:
+
+* **threshold=<float>** - Threshold to consider CPU is overloaded, in percents. Float value. Default threshold is 99%.
+* **load-limit=<float>** - Don't move IRQs to CPUs loaded more than this limit, in percents. Default limit is 95%.
+* **short-interval=<sec>** - Short iteration interval in seconds. It will be used when the overloaded CPU is found. Default is 2 seconds.
+* **long-interval=<sec>** - Long iteration interval in seconds. It will be used when there is no overloaded CPUs. Default is 5 seconds.
+* **strategy=<strategy>** - Strategy for choosing IRQ to move. The possible values are "min", "max", "rnd". The default is "rnd".
+* **exclude-cpus=<cpumap>** - It allows to exclude some CPUs from the list of CPUs that process IRQs. The 'cpumap' is bit-mask in hex format like in /proc/irq/*/smp_affinity files.
 
 # Proximity