← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/upssched.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2005-07-20 19:48:50 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050720194850-oo61wjr33rrx2mre
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/upssched.conf.5
1
 
.TH UPSSCHED.CONF 5 "Mon Jul 14 2003" "" "Network UPS Tools (NUT)"
 
1
.TH UPSSCHED.CONF 5 "Wed Nov 26 2003" "" "Network UPS Tools (NUT)"
2
2
.SH NAME
3
3
upssched.conf \- Configuration for upssched timer program
4
4
 
5
5
.SH DESCRIPTION
6
6
 
7
 
This file controls the operations of \fBupssched\fR(8), the timer-based
 
7
This file controls the operations of \fBupssched\fR(8), the timer\(hybased
8
8
helper program for \fBupsmon\fR(8).
9
9
 
10
10
.SH CONFIGURATION DIRECTIVES
15
15
argument which is the name of the timer that caused it to trigger.
16
16
 
17
17
.IP "PIPEFN \fIfilename\fR"
18
 
This sets the file name of the FIFO that will pass communications between
19
 
processes to start and stop timers.  This should be set to some path where
20
 
normal users can't create the file, due to the possibility of symlinking
 
18
Required.  This sets the file name of the socket which will be used for
 
19
interprocess communications.  This should be in a directory where normal
 
20
users can't create the file, due to the possibility of symlinking
21
21
and other evil.
22
22
.IP
23
23
Note: if you are running Solaris or similar, the permissions that
38
38
your system works before potentially opening a security hole.
39
39
 
40
40
.IP "LOCKFN \fIfilename\fR"
41
 
REQUIRED.  This was added after version 1.2.1.
42
 
.IP
43
 
upssched needs to be able to create this filename in order to avoid
44
 
a race condition when two events are dispatched from upsmon at nearly
 
41
Required.  upssched attempts to create this file in order to avoid a 
 
42
race condition when two events are dispatched from upsmon at nearly
45
43
the same time.  This file will only exist briefly.  It must not be
46
44
created by any other process.
47
45
.IP
56
54
and \fIupsname\fR match the current activity.  Possible values for
57
55
\fIcommand\fR are:
58
56
.IP
59
 
START-TIMER \fItimername\fR \fIinterval\fR
 
57
START\-TIMER \fItimername\fR \fIinterval\fR
60
58
.IP
61
59
.nf
62
60
        Start a timer of \fIinterval\fR seconds.  When it triggers, it
71
69
        Start a timer that'll execute when any UPS (*) has been 
72
70
        gone for 10 seconds
73
71
 
74
 
        AT COMMBAD * START-TIMER upsgone 10
 
72
        AT COMMBAD * START\-TIMER upsgone 10
75
73
.fi
76
74
.LP
77
75
 
78
76
.IP
79
 
CANCEL-TIMER \fItimername\fR [cmd]
 
77
CANCEL\-TIMER \fItimername\fR [cmd]
80
78
.IP
81
79
.nf
82
80
        Cancel a running timer called <timername>, if possible. 
92
90
        If a specific UPS (myups@localhost) comes back online, then 
93
91
        stop the timer before it triggers
94
92
 
95
 
        AT COMMOK myups@localhost CANCEL-TIMER upsgone
 
93
        AT COMMOK myups@localhost CANCEL\-TIMER upsgone
96
94
.fi
97
95
.LP
98
96
 
109
107
.IP
110
108
.nf
111
109
        If any UPS (*) reverts to utility power, then execute
112
 
        'ups-back-on-line' via CMDSCRIPT.
 
110
        'ups\-back\-on\-line' via CMDSCRIPT.
113
111
 
114
 
        AT ONLINE * EXECUTE ups-back-on-line
 
112
        AT ONLINE * EXECUTE ups\-back\-on\-line
115
113
.fi
116
114
.LP
117
115