Merge pull request #40 from jfsmig/M-doc-20200120

Fix the doc

Author: jfsmig

.travis.yml

@@ -1,5 +1,5 @@
 sudo: required
-dist: trusty
+dist: bionic
 language: c
 install:
   - sudo apt-get install -y --force-yes gcc make cmake libglib2.0-dev

README.md

@@ -4,6 +4,11 @@ Gridinit is a tool used to manage non-daemon processes.
 
 ## Build
 
+```
+cmake -D GRIDINIT_SOCK_PATH=/tmp/gridinit.sock .
+make
+```
+
 ### Dependencies
 
 * cmake, make, gcc
@@ -16,3 +21,18 @@ Gridinit is a tool used to manage non-daemon processes.
 | ----- | ------- | ----------- |
 | GRIDINIT_SOCK_PATH | /var/run/gridinit.sock | Path used for the socket on both server and client side, when no path is specified in the configuration. |
 
+## Try it
+
+```
+./gridinit -d ./gridinit.conf
+./gridinit_cmd status
+./gridinit_cmd status2
+./gridinit_cmd status3
+./gridinit_cmd status @NS0
+./gridinit_cmd status @NS1
+./gridinit_cmd status @local
+./gridinit_cmd status @local @NS1 @NS0
+./gridinit_cmd stop
+./gridinit_cmd start
+```
+

gridinit.conf

@@ -1,15 +1,19 @@
 [Default]
-#listen=/var/run/gridinit.sock
-pidfile=/var/run/gridinit.pid
+# Default:listen GRIDINIT_SOCK_PATH
+listen=/tmp/gridinit.sock
+
+# No default value
+# Specify a path to let gridinti write its pid file.
+pidfile=/tmp/gridinit.pid
 
 # Default:uid : STRING | INTEGER
 # The default user ID to be applied to services. You can use even
-# a logical name or its ID. 
+# a logical name or its ID.
 uid=root
 
 # Default:gid : STRING | INTEGER
 # The default group ID to be applied to services. You can use even
-# a logical name or its ID. 
+# a logical name or its ID.
 gid=root
 
 # Default:include : PATTERN
@@ -43,59 +47,64 @@ limit.core_size=-1
 limit.max_files=8192
 
 # Default:limit.stack_size : INTEGER
-# Default maximal thread stack size in kilobytes for each 
+# Default maximal thread stack size in kilobytes for each
 # Default value : 1024
 limit.stack_size=1024
 
-# Default:groups_only : STRING[,STRING]...
-# Set this variable if you want to filter the services. Only those
-# matching one of the given groups will be considered by CLI
-# start/stop commands
-groups_only=NS-common,NS-stgdev
 
-[service.key0]
+[service.key-down]
+# group : STRING [ "," STRING ]...
+# A coma-separated sequence of tokens. Each tokens is the name of a
+# group the current service belongs to. It is usefull to have the commands
+# target many services at once, when specifying @groups instead of services
+# IDs.
+group=NS0,local
+
+# The command to be executed.
+command=/bin/sleep 15
 
-# group : STRING
-# Optional configuration directive setting an arbitrary tag on the
-# service. This tag allows start/stop CLI commands to work on the current
-# service when an argument with the form '@STRING' is present and STRING
-# matches the current service's group. 
-group=NS0
+# Supersedes the default env variale with the same key.
+env.PATH=/bin:/usr/bin:/usr/local/bin
 
-# command : STRING
-# Mandatory Directive
-command=gridinit_testcmd /tmp/key0.out 5
+# Supersedes the default env variale with the same key.
+env.LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib
 
 # enabled : BOOL
-# Optional directive telling if the service is allowed to start.
-# A disabled service cannot be started even if start CLI commands
-# are sent.
+# Tells gridinit to consider (or not) that section in the configuration.
 enabled=true
 
-# on_die : 'cry' | 'respawn'
-# Optional and dangerous directive telling what to do with the whole
-# gridinit when the current service dies, whatever the normality of
-# the death.
+# on_die : "respawn" | "cry"
+# Tells what to do when the child dies.
+# - "respawn": it will be respawn N times (after N attempts, it will be
+#   considered BROKEN and it will have to be repaired.
+# - "cry": an alert will be logged, and that's it.
 on_die=respawn
 
-# env.STRING : STRING
-# 
-env.PATH=/bin:/usr/bin:/usr/local/bin
-env.LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib
-
-# uid : STRING | INTEGER
-# Ignored if the gridinit uid is not 0
-uid=root
-
-# gid : STRING | INTEGER
-# Ignored if the gridinit uid is not 0
-gid=root
-
 # start_at_boot : BOOL
 # Optional, default: true
 # Tells if the service has to be started when it is met for the first
 # time (i.e. not changed if the service is refreshed after a configuration
 # reload). 'start_at_boot' is overriden by 'enable' or CLI 'start' and
 # 'stop' commands.
+start_at_boot=false
+
+
+[service.key-disabled]
+group=NS0,local
+command=/bin/sleep 15
+enabled=false
+on_die=respawn
+env.PATH=/bin:/usr/bin:/usr/local/bin
+env.LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib
+start_at_boot=true
+
+
+[service.key1]
+group=NS1,local
+command=/bin/sleep 25
+enabled=true
+on_die=respawn
+env.PATH=/bin:/usr/bin:/usr/local/bin
+env.LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib
 start_at_boot=true
 

main/gridinit.c

@@ -1336,7 +1336,7 @@ static void
 __parse_options(int argc, char ** args)
 {
 	GError *error_local = NULL;
-	GOptionContext *context = g_option_context_new(" CONFIG_PATH [LOG4C_PATH]");
+	GOptionContext *context = g_option_context_new(" CONFIG_PATH");
 	g_option_context_add_main_entries(context, entries, NULL);
 	if (!g_option_context_parse(context, &argc, &args, &error_local)) {
 		g_print("option parsing failed: %s\n", error_local->message);