← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/upscode2.8

  • 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/upscode2.8
 
1
.TH UPSCODE2 8 "Tue Oct 19 2004" "" "Network UPS Tools (NUT)"
 
2
.SH NAME
 
3
upscode2 \- Driver for UPScode II compatible UPS equipment
 
4
.SH NOTE
 
5
This man page only documents the hardware\(hyspecific features of the
 
6
upscode2 driver.  For information about the core driver, see
 
7
\fBnutupsdrv\fR(8).
 
8
 
 
9
.SH SUPPORTED HARDWARE
 
10
This driver supports UPS equipment which can be controlled via
 
11
teh UPScode II protocol.
 
12
This is mainly Fiskars, Powerware equipment, but also some (probably OEM'ed)
 
13
products from Compaq.
 
14
 
 
15
.SH EXTRA ARGUMENTS
 
16
This driver supports the following optional settings in the
 
17
\fBups.conf\fR(5):
 
18
 
 
19
.IP "manufacturer=\fIvalue\fR"
 
20
Autodetection of this parameter is not possible yet (and it probably
 
21
never will be). Therefore this user defined string accepts any name. The
 
22
default is \fIunknown\fR.
 
23
 
 
24
.IP "input_timeout=\fIvalue\fR"
 
25
The timeout waiting for a response from the UPS. Some UPS models have
 
26
shown to be rather slow, resulting in frequent messages about empty
 
27
responses from the UPS. If you see this, try incresing this value.
 
28
 
 
29
.IP "output_pace=\fIvalue\fR"
 
30
Delay between characters sent to the UPS. This was added for completenes
 
31
with the above parameter. It has not shown to be needed yet.
 
32
 
 
33
.IP "baudrate=\fIvalue\fR"
 
34
The default baudrate is 1200, which is the standard for the UPScode II
 
35
protocol.
 
36
 
 
37
.IP "full_update_timer=\fIvalue\fR"
 
38
Number of seconds between collection of normative values.
 
39
 
 
40
.IP "use_crlf"
 
41
Flag to set if commands towards to UPS need to be terminated with CR-LF,
 
42
and not just CR.
 
43
 
 
44
.IP "use_pre_lf"
 
45
Flag to set if commands towards to UPS need to be introduced with an LF.
 
46
A Compaq T1500h is known to need this.
 
47
 
 
48
.SH UPSCMD
 
49
 
 
50
The driver supports the following commands for those UPSen that support them.
 
51
The available commands are autodetected during initialization,
 
52
so you should check availability with \fIupscmd -l\fR.
 
53
 
 
54
test.panel.start \(hy Start UPS self test
 
55
 
 
56
test.battery.start \(hy Start battery self test
 
57
 
 
58
beeper.on \(hy Enable UPS beeper
 
59
 
 
60
beeper.off \(hy Disable UPS beeper
 
61
 
 
62
shutdown.return \(hy Shut down in 1 second and wait for power to return
 
63
 
 
64
shutdown.stayoff \(hy Shut down in 1 seconds
 
65
 
 
66
shutdown.reboot \(hy Shut down in 1 seconds and reboot after 1 minute
 
67
 
 
68
shutdown.reboot.graceful \(hy Shut down in 20 seconds and reboot after 1 minute
 
69
 
 
70
.SH NOTES
 
71
 
 
72
The Powerware UPS models that this driver has been tested against until now
 
73
has not returned a value for \fIbattery.charge\fR. Therefore the driver will
 
74
guesstimate a value based on the nominal battery min/max and the current
 
75
battery voltage.
 
76
 
 
77
.SH AUTHOR
 
78
H�vard Lygre <hklygre@online.no>,
 
79
Niels Baggesen <niels@baggesen.net>
 
80
 
 
81
.SH SEE ALSO
 
82
 
 
83
.SS The core driver:
 
84
\fBnutupsdrv\fR(8)
 
85
 
 
86
.SS Internet resources:
 
87
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/