summaryrefslogtreecommitdiff
path: root/shutdownasap.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'shutdownasap.1.in')
-rw-r--r--shutdownasap.1.in36
1 files changed, 36 insertions, 0 deletions
diff --git a/shutdownasap.1.in b/shutdownasap.1.in
new file mode 100644
index 0000000..34e3aad
--- /dev/null
+++ b/shutdownasap.1.in
@@ -0,0 +1,36 @@
+.TH shutdownasap 8 "" "shutdownasap #VERSION#" ""
+.SH NAME
+shutdownasap \- simple script for \fBshutdown\fP waiting for certain processes and files to disapear
+.SH SYNOPSIS
+\fBshutdownasap\fP
+.SH DESCRIPTION
+\fBshutdownasap\fP shuts down the computer after a certain directory becomes empty and certain processes are not running.
+For actually shutting down it calls \fBsudo shutdown\fP.
+.SH CONFIGURATION
+The configfile \fB#ETCDIR#/shutdownasap.conf\fP is a bash script, which defines the following variables and routines:
+.TP
+.B "pidFile"
+file to store pid in
+.TP
+.B "waitForDir"
+directory which must be empty before shutting down
+.TP
+.B "shutDownNoGos"
+list of processes which must not be running before shutting down
+.TP
+.B "beforeWatchHook"
+routine which is called after start of \fBshutdownasap\fP, before watching above conditions
+.TP
+.B "beforeShutDownHook"
+routine which is called before shutting down
+.SH FILES
+.TP
+.B "#BINDIR#/shutdownasap"
+program file
+.TP
+.B "#ETCDIR#/shutdownasap.conf"
+contains configuration
+.SH AUTHOR
+.nf
+Erich Eckner <opensource at eckner dot net>
+.fi