X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=README.md;h=688d3a60e1599a732db3c164dc84fc08aef48c1e;hb=69b66ef3871cb400e2bdeb76783355613c0bf4fc;hp=f45b1f824f1a814d0692dd48e97f5fe99c2533af;hpb=7cfd2088266176e7dcd7bcf4b4eae9734fff7a92;p=kconfig-hardened-check.git

diff --git a/README.md b/README.md
index f45b1f8..688d3a6 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,8 @@ or exploitation techniques.
   - ARM64
   - ARM
 
+TODO: RISC-V
+
 ## Installation
 
 You can install the package:
@@ -41,6 +43,8 @@ pip install git+https://github.com/a13xp0p0v/kconfig-hardened-check
 
 or simply run `./bin/kconfig-hardened-check` from the cloned repository.
 
+Some Linux distributions also provide `kconfig-hardened-check` as a package.
+
 ## Usage
 ```
 usage: kconfig-hardened-check [-h] [--version] [-p {X86_64,X86_32,ARM64,ARM}]
@@ -60,7 +64,24 @@ optional arguments:
                         choose the report mode
 ```
 
-## Output for `Ubuntu 20.04 LTS (Focal Fossa)` kernel config
+## Output modes
+
+  -  no `-m` argument for the default output mode (see the example below)
+  - `-m verbose` for printing additional info:
+    - config options without a corresponding check
+    - internals of complex checks with AND/OR, like this:
+```
+-------------------------------------------------------------------------------------------
+    <<< OR >>>                                                                             
+CONFIG_STRICT_DEVMEM                         |      y      |defconfig | cut_attack_surface 
+CONFIG_DEVMEM                                | is not set  |   kspp   | cut_attack_surface 
+-------------------------------------------------------------------------------------------
+```
+  - `-m show_fail` for showing only the failed checks
+  - `-m show_ok` for showing only the successful checks
+  - `-m json` for printing the results in JSON format (for combining `kconfig-hardened-check` with other tools)
+
+## Example output for `Ubuntu 20.04 LTS (Focal Fossa)` kernel config
 ```
 $ ./bin/kconfig-hardened-check -c kconfig_hardened_check/config_files/distros/ubuntu-focal.config 
 [+] Config file to check: kconfig_hardened_check/config_files/distros/ubuntu-focal.config