commit c2ed9e9

hovercats  ·  2023-09-02 18:18:59 +0000 UTC
parent eb06cb5
add some info in README
1 files changed,  +50, -1
M README
M README
+50, -1
 1@@ -1,4 +1,53 @@
 2 rcsm
 3 ----
 4 
 5-a tiny service manager written in rc
 6+A tiny service manager written in rc.
 7+It doesnt really do much, appart from launching and killing services.
 8+So no logging, no monitoring, just start/stop.
 9+
10+It follows the same concept as svc[0], but is about half the LOCs.
11+
12+
13+Install
14+-------
15+
16+	$ chmod 755 rcsm
17+
18+Then add to your PATH.
19+
20+Usage
21+-----
22+
23+Create neccessary directories
24+
25+	$ rcsm -c 
26+
27+Now create your service scripts
28+To launch your services with rcsm
29+
30+	$ rcsm -s foo
31+
32+If you have multiple services you want to run, you can activate them
33+
34+	$ rcsm -a foo
35+	$ rcsm -a bar
36+
37+You can now start all your activated services simultaneously
38+	
39+	$ rcsm -s
40+
41+To kill your services, it follows the same idea as -s flag
42+
43+	$ rcsm -k foo
44+	$ rcsm -k
45+
46+
47+Service scripts
48+---------------
49+
50+Service scripts are rather simple, and only require 2 case statements (-s/-k).
51+this means that you can essentially use w/e language/shell you want, as long as
52+-s and -k options is available.
53+
54+
55+[0] https://github.com/hovercats/svc