fatalerrors/init.sh
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
levasseur
2021-10-08 17:35:39 +02:00
parent a5975307dd
commit 33da21dfe2
2 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -65,6 +65,9 @@ results.
- **-r, --resume**: Restart an interrupted process with the last executed module - **-r, --resume**: Restart an interrupted process with the last executed module
that failed. that failed.
- **-R, --no-root-check**: Disable checks on root rights (or the 0 UID). - **-R, --no-root-check**: Disable checks on root rights (or the 0 UID).
- **-D, --no-deps**: Disable module dependencies checks.
- **-P, --no-proxy**: Do not hot apply proxy setting to the running system even
if system proxy is set in configuration files.
- **-h, --help**: Display information on command line usage. - **-h, --help**: Display information on command line usage.
- **-s, --shell**: Launch a shell with entire script's environment for - **-s, --shell**: Launch a shell with entire script's environment for
debugging purpose. No action or modification is made to the system unless you debugging purpose. No action or modification is made to the system unless you
@@ -103,7 +106,9 @@ will be done, triggering errors in case of inconsistency or incompatible
options. options.
Finally, checking processes are launched in their declaration order (cf. Finally, checking processes are launched in their declaration order (cf.
configuration file). If no error occurs and after a confirmation prompt, final configuration file). A module depency check is made prior to the module specific
checks unless the *--no-deps* option is given or if a manual module list have
been transmited. If no error occurs and after a confirmation prompt, final
treatment processes, those that actually makes changes, are launched. treatment processes, those that actually makes changes, are launched.
Without the *--keep-going* option, any error will immediately stop execution. Without the *--keep-going* option, any error will immediately stop execution.

16
doc/dev.md
View File

@@ -12,6 +12,7 @@
- [3. The display.sh file](#3-the-displaysh-file) - [3. The display.sh file](#3-the-displaysh-file)
- [3.1. Functions](#31-functions) - [3.1. Functions](#31-functions)
- [3.1.1. prnt [I|W|E|m] \<message\>](#311-prnt-iwem-message) - [3.1.1. prnt [I|W|E|m] \<message\>](#311-prnt-iwem-message)
- [3.1.2. dump_key_buffer](#312-dump_key_buffer)
- [3.2. Other functionalities](#32-other-functionalities) - [3.2. Other functionalities](#32-other-functionalities)
- [4. The filefct.sh file](#4-the-filefctsh-file) - [4. The filefct.sh file](#4-the-filefctsh-file)
- [4.1. Functions](#41-functions) - [4.1. Functions](#41-functions)
@@ -42,6 +43,7 @@
- [7.1.1. disp_help](#711-disp_help) - [7.1.1. disp_help](#711-disp_help)
- [7.1.2. show_version](#712-show_version) - [7.1.2. show_version](#712-show_version)
- [7.1.3. get_mod_name \<module_file\>](#713-get_mod_name-module_file) - [7.1.3. get_mod_name \<module_file\>](#713-get_mod_name-module_file)
- [7.1.4. set_system_proxy](#714-set_system_proxy)
- [8. The version.sh file](#8-the-versionsh-file) - [8. The version.sh file](#8-the-versionsh-file)
- [8.1. Functions](#81-functions) - [8.1. Functions](#81-functions)
- [8.1.1. get_os_version](#811-get_os_version) - [8.1.1. get_os_version](#811-get_os_version)
@@ -117,6 +119,12 @@ The first parameter is the header type, having those possible values:
The second parameter is the message to display. The second parameter is the message to display.
#### 3.1.2. dump_key_buffer
That function dumps keyboard's buffer. It's used to clear eventual key press
before a ny critical keyboard action.
That function takes no parameter and returns no useful value.
### 3.2. Other functionalities ### 3.2. Other functionalities
Using that script will declare some easy to remember variables containing Bash Using that script will declare some easy to remember variables containing Bash
color codes: color codes:
@@ -307,6 +315,14 @@ only one parameter: the module file name.
Result is sent to *stdout*. Result is sent to *stdout*.
#### 7.1.4. set_system_proxy
That function applies proxy settings in the configuration files to the system
proxy configuration, unless the *--no-proxy* parameters have been given command
line.
That function takes no parameters and only change *http_proxy* and *https_proxy*
standard POSIX variables. No usefull result will be returned.
## 8. The version.sh file ## 8. The version.sh file
### 8.1. Functions ### 8.1. Functions
#### 8.1.1. get_os_version #### 8.1.1. get_os_version