updated documentation

This commit is contained in:
2021-09-29 11:10:26 +02:00
parent d91bd4acd5
commit 148742008a

View File

@@ -152,5 +152,75 @@ will be created automatically.
That file don't profide any other things that the previously listed functions. That file don't profide any other things that the previously listed functions.
## 5. The pkgman.sh file ## 5. The pkgman.sh file
### 5.1. Functions ### 5.1. Global dependencies
#### 5.1.1. pkgupdt Because it gives system independent function to the system dependent package
manager, the entire file depends on *PKG_MAN* variable, defining the package
manager executable to use. Other variables giving command line parameters to
use for the different function will also be nedeed and detailed for every
function. All those variable are defined in a system dependant configuration
file automatically called on script startup.
### 5.2. Functions
#### 5.2.1. pkgupdt
That function calls the package manager to update package database.
It depends on the *COM_UPDATE* variable wich define the parameters to use to
accomplish that function.
That function takes no parameters and any given parameters will be ignored.
#### 5.2.2. pkginst
That function installs using the package manager the packages given in
parameters. The list of parameters are all considered as package names.
If the *INSTALL_MODE* variable is set to "dev" the package manger will be
called one package after the other. Elsewhere, it will be called once with
the entire package list as parameter.
The function depends on the *COM_INSTALL* variable wich define the parameter
to use to accomplish that function.
#### 5.2.3. pkgupgd
That function calls the package manager to upgrade system.
It depends on the *COM_UPGRADE* variable wich define the parameters to use to
accomplish that function.
That function takes no parameters and any given parameters will be ignored.
#### 5.2.4. pkgrem
That function uninstalls using the package manager the packages given in
parameters. The list of parameters are all considered as package names.
If the *INSTALL_MODE* variable is set to "dev" the package manger will be
called one package after the other. Elsewhere, it will be called once with
the entire package list as parameter.
The function depends on the *COM_REMOVE* variable wich define the parameter
to use to accomplish that function.
#### 5.2.3. pkgupgd
That function calls the package manager to remove no longer needed installed
dependencies. Any package not manually installed is considered as a depndency.
It depends on the *COM_AUTOREM* variable wich define the parameters to use to
accomplish that function.
That function takes no parameters and any given parameters will be ignored.
### 5.3. Other functionnalities
That file don't profide any other things that the previously listed functions.
## 6. The services.sh files
### 6.1. Global dependencies
That script relies on the *INIT_COM* variable, defining the program to use to
manipulate services. It is defined in configuration file automatically called
depending on your distribution. Nevertheless, even if it's system dependent,
some distributions offers you to choose between different services call (and
init system). Tested init systems are SystemV init, SystemD and UpStart. Thus,
the originally UpStart "service" program tend to be available on many systems
and is privileged.
### 6.2. Functions
#### 6.2.1. exec_serv