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

dev.md: updated doc

Browse Source
This commit is contained in:
fatalerrors
2021-12-01 11:23:42 +01:00
parent d28f17f82f
commit a9a0525cc5
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/dev.md
View File

@@ -12,8 +12,9 @@
- [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 [-n] [I|W|E|m] <message>```](#311-prnt--n-iwem-message) - [3.1.1. ```prnt [-n] [I|W|E|m] <message>```](#311-prnt--n-iwem-message)
- [3.1.2. ```dsleep <miliseconds> [char]```](#312-dsleep-miliseconds-char) - [3.1.2. ```separator```](#312-separator)
- [3.1.3. ```dump_key_buffer```](#313-dump_key_buffer) - [3.1.3. ```dsleep <miliseconds> [char]```](#313-dsleep-miliseconds-char)
- [3.1.4. ```dump_key_buffer```](#314-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. Common behavior](#41-common-behavior) - [4.1. Common behavior](#41-common-behavior)
@@ -145,7 +146,13 @@ Consequently that function can only contain code that cannot trigger errors or
fail as it's also used to display errors. Thus it only contains echoes and some fail as it's also used to display errors. Thus it only contains echoes and some
variables manipulation. variables manipulation.
#### 3.1.2. ```dsleep <miliseconds> [char]``` #### 3.1.2. ```separator```
Tat function display a seprator made with dash, to fill the length of the
screen minus one character.
It takes no parameters and return no value.
#### 3.1.3. ```dsleep <miliseconds> [char]```
That function is an equivalent to *sleep* bash command but will display a That function is an equivalent to *sleep* bash command but will display a
countdown every second until it reaches zero. Optionnally a character (or a countdown every second until it reaches zero. Optionnally a character (or a
string) can be given as a second parameter to replace the countdown by that string) can be given as a second parameter to replace the countdown by that
@@ -154,7 +161,7 @@ the wait is over.
The function returns nothing useful. The function returns nothing useful.
#### 3.1.3. ```dump_key_buffer``` #### 3.1.4. ```dump_key_buffer```
That function dumps keyboard's buffer. It's used to clear eventual key press That function dumps keyboard's buffer. It's used to clear eventual key press
before any critical keyboard action. before any critical keyboard action.