From 33da21dfe249ee5e23960d31812640af22b80bec Mon Sep 17 00:00:00 2001 From: levasseur Date: Fri, 8 Oct 2021 17:35:39 +0200 Subject: [PATCH] updated documentation --- README.md | 7 ++++++- doc/dev.md | 26 +++++++++++++++++++++----- 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a8d9e7b..936d33e 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,9 @@ results. - **-r, --resume**: Restart an interrupted process with the last executed module that failed. - **-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. - **-s, --shell**: Launch a shell with entire script's environment for 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. 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. Without the *--keep-going* option, any error will immediately stop execution. diff --git a/doc/dev.md b/doc/dev.md index 1061a71..5eb43f4 100644 --- a/doc/dev.md +++ b/doc/dev.md @@ -12,6 +12,7 @@ - [3. The display.sh file](#3-the-displaysh-file) - [3.1. Functions](#31-functions) - [3.1.1. prnt [I|W|E|m] \](#311-prnt-iwem-message) + - [3.1.2. dump_key_buffer](#312-dump_key_buffer) - [3.2. Other functionalities](#32-other-functionalities) - [4. The filefct.sh file](#4-the-filefctsh-file) - [4.1. Functions](#41-functions) @@ -31,17 +32,18 @@ - [6. The services.sh files](#6-the-servicessh-files) - [6.1. Global dependencies](#61-global-dependencies) - [6.2. Functions](#62-functions) - - [6.2.1. exec_serv \ \](#621-exec_serv-service-command) - - [6.2.2. svc_start \ [service2 ... serviceN]](#622-svc_start-service1-service2--servicen) - - [6.2.3. svc_reload \ [service2 ... serviceN]](#623-svc_reload-service1-service2--servicen) - - [6.2.2. svc_restart \ [service2 ... serviceN]](#622-svc_restart-service1-service2--servicen) - - [6.2.3. svc_stop \ [service2 ... serviceN]](#623-svc_stop-service1-service2--servicen) + - [6.2.1. exec_serv \ \](#621-exec_serv-service-command) + - [6.2.2. svc_start \ [service2 ... serviceN]](#622-svc_start-service1-service2--servicen) + - [6.2.3. svc_reload \ [service2 ... serviceN]](#623-svc_reload-service1-service2--servicen) + - [6.2.2. svc_restart \ [service2 ... serviceN]](#622-svc_restart-service1-service2--servicen) + - [6.2.3. svc_stop \ [service2 ... serviceN]](#623-svc_stop-service1-service2--servicen) - [6.3. Other functionnalities](#63-other-functionnalities) - [7. The support.sh file](#7-the-supportsh-file) - [7.1. Functions](#71-functions) - [7.1.1. disp_help](#711-disp_help) - [7.1.2. show_version](#712-show_version) - [7.1.3. get_mod_name \](#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.1. Functions](#81-functions) - [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. +#### 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 Using that script will declare some easy to remember variables containing Bash color codes: @@ -307,6 +315,14 @@ only one parameter: the module file name. 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.1. Functions #### 8.1.1. get_os_version