Commit 3d590bac by Eric Coissac

Update the readme.md

parent 907c6619
......@@ -145,10 +145,38 @@ Alias for the popclobber function. Using one of the both commands `popnoclobber`
#### download
`download <URL> [USERNAME] [PASSWORD]`
Downloads the file specified by `URL`.
If specifed the second (`USERNAME`) and third (`PASSWORD`) parametters allow
to indicate a login and password for a protected connection
#### downloadandcheck
`downloadandcheck <URL> <MD5URL> <DESTINATION> [USERNAME] [PASSWORD]`
Downloads the file specified by `URL` and check file integrity.
The MD5 checksum file URL is indicated using the `MD5URL` parametters.
You must specified a destination filename to store the downloaded data
using the `DESTINATION` parametter. The MD5 file is downloaded under the
name DESTINATION.md5
If specifed the fourth (`USERNAME`) and fifth (`PASSWORD`) parametters allow
to indicate a login and password for a protected connection
On error the function has a return status set to *1*, *0* otherwise.
#### setmaxretry
`setmaxretry <MAXRETRY>`
If downloading failed the downloadandcheck function can retry to download
the file several times before a complete failure. This function allows to
define the maximum of time the downloadandcheck tries to redownload before
exiting in error.
----------------------------------------------------------
......@@ -172,9 +200,12 @@ Alias for the popclobber function. Using one of the both commands `popnoclobber`
----------------------------------------------------------
## lecaluke
The lecaluke module provides a set of variable defining emplacement
where LECA ressources are stored on the LUKE cluster.
### Activating the module
```{shell}
......@@ -206,6 +237,15 @@ Alias for the popclobber function. Using one of the both commands `popnoclobber`
## logging
The *logging* module define a set of function allowing to log on the standard error
or into a file messages.
All the log will be done on file descriptor 3
By default file descriptor 3 is redirected to stderr (2)
By default the logging level is set to `WARNING`.
Therefore only `WARNING` and `ERROR` messages will be actually logged.
### Activating the module
```{shell}
......@@ -217,18 +257,54 @@ Alias for the popclobber function. Using one of the both commands `popnoclobber`
#### logdebug
`logdebug <MESSAGE>`
Writes `MESSAGE` as a debug level log to the current log file.
#### loginfo
`loginfo <MESSAGE>`
Writes `MESSAGE` as a info level log to the current log file.
#### logerror
`logerror <MESSAGE>`
Writes `MESSAGE` as a error level log to the current log file.
#### logwarning
`logwarning <MESSAGE>`
Writes `MESSAGE` as a warning level log to the current log file.
#### setloglevel
`setloglevel <LEVEL>`
Set the current logging level to the level specified by `LEVEL`.
Level is `DEBUG`, `INFO`, `WARNING` or `ERROR`.
A log is recorded only when it is submitted with a level
greater or equal to the current logging level.
#### openlogfile
`openlogfile <FILENAME>`
Redirected all logging to the file specified by `FILENAME`.
If the file already exists, new logs are appened at the end of the file.
If the file does not exist it is created
#### closelogfile
`closelogfile`
Closes the current logfile and redirect the logging to stderr.
----------------------------------------------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment