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

26
doc/dev.md
View File

@@ -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] \<message\>](#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 \<service\> \<command\>](#621-exec_serv-service-command)
- [6.2.2. svc_start \<service1\> [service2 ... serviceN]](#622-svc_start-service1-service2--servicen)
- [6.2.3. svc_reload \<service1\> [service2 ... serviceN]](#623-svc_reload-service1-service2--servicen)
- [6.2.2. svc_restart \<service1\> [service2 ... serviceN]](#622-svc_restart-service1-service2--servicen)
- [6.2.3. svc_stop \<service1\> [service2 ... serviceN]](#623-svc_stop-service1-service2--servicen)
- [6.2.1. exec_serv \<service\> \<command\>](#621-exec_serv-service-command)
- [6.2.2. svc_start \<service1\> [service2 ... serviceN]](#622-svc_start-service1-service2--servicen)
- [6.2.3. svc_reload \<service1\> [service2 ... serviceN]](#623-svc_reload-service1-service2--servicen)
- [6.2.2. svc_restart \<service1\> [service2 ... serviceN]](#622-svc_restart-service1-service2--servicen)
- [6.2.3. svc_stop \<service1\> [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 \<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.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