|
|
@@ -1,15 +1,16 @@
|
|
|
# lcmlog
|
|
|
-Client side of a tool for reading and writing the lcm staff logs (both admins and 150). Requiests are send via ssh to tuc using user's account
|
|
|
-## The three methods
|
|
|
-All these procedures are guided: the script will assist you during the upload or the search.
|
|
|
+Client side of a tool for reading and writing the lcm staff logs (both admins and 150). Requests are sent via ssh using user's account.
|
|
|
|
|
|
-### GET
|
|
|
+## Methods
|
|
|
+
|
|
|
+#### GET
|
|
|
The `GET` method is called with the `-g` option and is used to print all the logs that meet the required criteria.
|
|
|
|
|
|
-### POST
|
|
|
+#### POST
|
|
|
The `POST` method is called with the `-p` option and is used to add a log to the database.
|
|
|
|
|
|
-### UPDATE
|
|
|
+#### UPDATE
|
|
|
The `UPDATE` method is called with the `-u` option and is used to regenerate the internal server database. It should only be called if a log file is added by hand, or if some of the log files get renamed or corrupted. It assumes that all the log files are correctly formatted.
|
|
|
+
|
|
|
## Configuration file
|
|
|
-To choose the server to communicate with, edit the configuration file. The configuration file is named `config` and is a ssh config file: so, for more help, refer to ssh\_config manuals (i.e. run `man ssh_config` on your terminal). This file _must_ be located in the same directory of the script.
|
|
|
+To choose the server to communicate with, ssh uses a config file located in `~/.config/lcmlog`. The configuration file is named `config` and is a ssh config file: so, for more help, refer to ssh\_config manuals (i.e. run `man ssh_config` on your terminal). The script always checks if the config file exist: if false, it asks you if you want to generate it. You can't use this program until the config file is generated in `~/.config/lcmlog`.
|
