]> Sergey Matveev's repositories - godlighty.git/blobdiff - doc/usage.texi
Small comments
[godlighty.git] / doc / usage.texi
diff --git a/doc/usage.texi b/doc/usage.texi
new file mode 100644 (file)
index 0000000..3eb93bd
--- /dev/null
@@ -0,0 +1,39 @@
+@node Usage
+@unnumbered Usage
+
+All @ref{Configuration, configuration} is assumed to be placed in
+@file{rc/cfg}. Probably you want to deal with multiple server
+configurations simultaneously. You place them in corresponding
+@file{rc/NAME.cfg} directories and use @url{http://cr.yp.to/redo.html,
+redo} default target to create necessary symbolic link of
+@file{rc/NAME.cfg} to @file{rc/cfg} and build executable itself.
+
+@example
+$ redo example
+# will produce example executable with rc/example.cfg configuration
+
+$ redo fcgi.example
+# will produce fcgi.example executable with rc/fcgi.example.cfg configuration
+@end example
+
+But because you will mostly like to create binary patches to quickly
+update already existing binaries, then you can use @file{make-update.sh}
+script, that will store newly created binaries in @file{updates/}
+directory and make shell-script with the built-in binary patch and
+SHA512 checksum checker:
+
+@example
+# First run
+$ ./make-update example
+$ scp updates/example.old web-server:/path/to/www-server
+
+$ ./make-update example
+$ scp updates/example-update.sh web-server:/tmp
+web-server $ /tmp/example-update.sh /path/to/www-server
+web-server $ svc -t /var/service/www-server
+@end example
+
+@file{contrib/service} contains @command{daemontools} example run scripts.
+
+Send @code{SIGINFO} (@code{SIGUSR1} on Linux) signal to get current
+daemon's configuration.