aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README83
1 files changed, 83 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..e9a0c5b
--- /dev/null
+++ b/README
@@ -0,0 +1,83 @@
+* Overview
+
+This is a generic helper program for writing system initialization
+scripts. Depending on the operation mode, it starts, stops,
+reconfigures or displays the status of a specific program.
+
+Primary audience is Slackware system administrators. However, the
+tool is generic enough to be used on any other Linux (and not only)
+distribution.
+
+In the contrast to another similar programs like start-stop-daemon,
+it is designed so that the entire rc file can consist of only one
+line, invoking (or exec'ing) genrc with the right set of arguments.
+
+* Example
+
+The following is the example /etc/rc.d/rc.ntpd script:
+
+#! /bin/sh
+PIDFILE=/var/run/ntpd.pid
+exec /sbin/genrc \
+ --command="/usr/sbin/ntpd -g -p $PIDFILE" \
+ --no-reload \
+ --signal-stop=SIGHUP \
+ --pid-from="FILE:$PIDFILE" "$@"
+
+* Downloads
+
+This and newer versions of genrc can be downloaded from
+
+ http://download.gnu.org.ua/release/genrc
+
+For the recent development sources, see
+
+ http://git.gnu.org.ua/cgit/genrc.git
+
+* Building
+
+When building from source package, usual incantations apply:
+
+ ./configure
+ make
+ make install
+
+If you are building from a clone of the Git repository, you will need
+GNU autotools to bootstrap the package first. Run
+
+ autoreconf -f -i -s
+
+in the top level source directory. This will create the configure
+script and populate the directory with the missing files. Then proceed
+as described above.
+
+* Documentation
+
+Manpage genrc.8 included. After installing the package, run
+man genrc.
+
+* Bug reporting.
+
+Send bug reports to <gray@gnu.org>.
+
+
+* Copyright information:
+
+Copyright (C) 2018 Sergey Poznyakoff
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:

Return to:

Send suggestions and report system problems to the System administrator.