commit ffb2437

hovercats  ·  2025-03-11 02:13:11 +0000 UTC
parent aad5b89
update README, reflecting recent changes, aswell as some improvements
1 files changed,  +20, -24
M README
M README
+20, -24
 1@@ -2,7 +2,7 @@ rcsm
 2 ----
 3 
 4 A tiny service manager written in rc.
 5-It doesnt really do much, appart from launching and killing services.
 6+It doesnt really do much, appart from starting and killing services.
 7 So no logging, no monitoring, just start/stop.
 8 
 9 It follows the same concept as shsm[0], but is about half the LOCs.
10@@ -13,36 +13,32 @@ Install
11 
12 	$ make install
13 
14+
15 Usage
16 -----
17+rcsm [flag] [args]
18+-a	- Activate service.
19+-c  - Create neccessary directories.
20+-d  - Deactivate services.
21+-h  - Show usage message.
22+-k  - Kill services.
23+-l  - List available services.
24+-s  - Start services.
25+-r  - Restart services.
26 
27-Create neccessary directories
28-
29-	$ rcsm -c 
30-
31-Now create your service scripts
32-To start/stop your services with rcsm
33-
34-	$ rcsm -s foo
35-	$ rcsm -k foo
36+Some flags have additional functionallity when ran without arguments:
37+-a  - Lists activated services.
38+-k  - Kill all activated services.
39+-s  - Start all activated services.
40 
41-If you have multiple services you want to run, you can activate them
42-
43-	$ rcsm -a foo
44-	$ rcsm -a bar
45-
46-You can now start/stop all your activated services simultaneously
47-	
48-	$ rcsm -s
49-	$ rcsm -k
50+Some flags also supports multiple arguments: -a -d -k -s -r
51 
52 
53 Service scripts
54 ---------------
55-
56-Service scripts are rather simple, and only require 2 case statements (-s/-k).
57-this means that you can essentially use w/e language/shell you want, as long as
58--s and -k options is available.
59-
60+Service scripts are rather simple, and have only 2 requirements:
61+Accepting -s/-k flags.
62+Which gives users the freedom to use whichever language/shell they like for
63+service scripts.
64 
65 [0] https://github.com/hovercats/shsm