diff --git a/doc/dev.md b/doc/dev.md index cc046e2..ad48c1c 100644 --- a/doc/dev.md +++ b/doc/dev.md @@ -1,25 +1,37 @@ # init.sh developer's reference ## Table of content - * [1. Getting started](#1-getting-started) - * [2. The aaa_error.sh file](#2-the-aaa_errorsh-file) - + [2.1. Functions](#21-functions) +- [init.sh developer's reference](#initsh-developers-reference) + - [1. Getting started](#1-getting-started) + - [2. The aaa_error.sh file](#2-the-aaa_errorsh-file) + - [2.1. Functions](#21-functions) - [2.1.1. check_root](#211-check_root) - [2.1.2. die [--force] \](#212-die---force-exitcode) - [2.1.3. noerror [--noout] \](#213-noerror---noout-command) - + [2.2. Other functionalities](#22-other-functionalities) - * [3. The display.sh file](#3-the-displaysh-file) - + [3.1. Functions](#31-functions) + - [2.2. Other functionalities](#22-other-functionalities) + - [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.2. Other functionalities](#32-other-functionalities) - * [4. The filefct.sh file](#4-the-filefctsh-file) - + [4.1. Functions](#41-functions) + - [3.2. Other functionalities](#32-other-functionalities) + - [4. The filefct.sh file](#4-the-filefctsh-file) + - [4.1. Functions](#41-functions) - [4.1.1. stdtime](#411-stdtime) - [4.1.2. backupdist \](#412-backupdist-list_of_files_or_dirs) - [4.1.3. installfile \ \](#413-installfile-sources-destination) - + [4.2. Other functionalities](#42-other-functionalities) - * [5. The pkgman.sh file](#5-the-pkgmansh-file) - + - [4.2. Other functionnalities](#42-other-functionnalities) + - [5. The pkgman.sh file](#5-the-pkgmansh-file) + - [5.1. Global dependencies](#51-global-dependencies) + - [5.2. Functions](#52-functions) + - [5.2.1. pkgupdt](#521-pkgupdt) + - [5.2.2. pkginst \](#522-pkginst-package_list) + - [5.2.3. pkgupgd](#523-pkgupgd) + - [5.2.4. pkgrem \](#524-pkgrem-package_list) + - [5.2.3. pkgupgd](#523-pkgupgd) + - [5.3. Other functionnalities](#53-other-functionnalities) + - [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) ## 1. Getting started This is a developer's reference. It's not intended to be a manual, but a @@ -118,7 +130,8 @@ echo -e "${IRed}${On_IYellow}ATTENTION:${DEFAULTBG} this is a warning!${DEFAULTC ### 4.1. Functions #### 4.1.1. stdtime Display date and time based on RFC 3339 standard but slightly modified so it can -be used in filename. +be used in filename. Thus spaces are replaced by dash, and comas between hours, +minutes and seconds are removed. That function takes no parameters and return its result on standard output.