dev.md: added table of content, written installfile doc

This commit is contained in:
levasseur
2021-09-24 16:09:45 +02:00
parent 1154fa5800
commit afb6b52515

View File

@@ -1,5 +1,26 @@
# init.sh developer's reference # 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)
- [2.1.1. check_root](#211-check_root)
- [2.1.2. die [--force] \<exitcode\>](#212-die---force-exitcode)
- [2.1.3. noerror [--noout] \<command\>](#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)
- [3.1.1. prnt [I|W|E|m] \<message\>](#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)
- [4.1.1. stdtime](#411-stdtime)
- [4.1.2. backupdist \<list_of_files_or_dirs\>](#412-backupdist-list_of_files_or_dirs)
- [4.1.3. installfile \<sources\> \<destination\>](#413-installfile-sources-destination)
+ [4.2. Other functionalities](#42-other-functionalities)
* [5. The pkgman.sh file](#5-the-pkgmansh-file)
## 1. Getting started ## 1. Getting started
This is a developer's reference. It's not intended to be a manual, but a This is a developer's reference. It's not intended to be a manual, but a
reference for all internal functions, so you can easily build your own modules. reference for all internal functions, so you can easily build your own modules.
@@ -111,4 +132,25 @@ exists, the function will issue a warning and continue to the next.
The function don't take any other parameters than file and/or directory names. The function don't take any other parameters than file and/or directory names.
#### 4.1.3. installfile \<sources\> \<destination\> #### 4.1.3. installfile \<sources\> \<destination\>
Install a list of file to the given destination. The source of the file can be
of three different orrigins, from highest to lowest priority:
- **repo/hosts/$HOSTNAME**: this allows to provide system specific configuration
files. Use only relative path to access the file.
- **repo/common**: this one will provide configuration files suitable for your
entire infrastructure. Yet again provide a relative path to access it.
- **Any path**: You can give fully qualified path names to access resources
from other locations.
The priorities apply on file existance. Wildcards are not allowed in file names,
so an error will occurs if you try to use any. It's also not yet possible to
give an entire directory as a source.
The last parameter is always the destination. If the path do not exists, it
will be created automatically.
### 4.2. Other functionnalities
That file don't profide any other things that the previously listed functions.
## 5. The pkgman.sh file
### 5.1. Functions
#### 5.1.1. pkgupdt