system/systeroid
system/systeroid
1
0
Fork 0
mirror of https://github.com/orhun/systeroid synced 2024-10-01 13:13:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): mention the environment variable for setting the documentation

Browse source
This commit is contained in:
Orhun Parmaksız 2022-03-18 02:22:16 +03:00
parent 00ba1d1ab7
commit ef0edda75d
No known key found for this signature in database
GPG key ID: F83424824B3E4B90
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -459,7 +459,7 @@ systeroid-tui --bg-color ffff99 --fg-color 003366
#### Viewing the parameter documentation
To view the documentation as parameters are being selected on the list, kernel documentation should be parsed as explained in the "[Showing information about parameters](#showing-information-about-parameters)" section. A specific path for kernel documentation can be given via `--docs` argument if it is not found in one of the locations that are checked as default.
To view the documentation as parameters are being selected on the list, kernel documentation should be parsed as explained in the "[Showing information about parameters](#showing-information-about-parameters)" section. A specific path for kernel documentation can be given via `--docs` argument or `KERNEL_DOCS` environment variable if it is not found in one of the locations that are checked as default.
To disable this feature altogether, use `--no-docs` flag.