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

« back to all changes in this revision

Viewing changes to man/dummycons.8

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Quette
  • Date: 2004-05-28 13:10:01 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040528131001-yj2m9qcez4ya2w14
Tags: upstream-1.4.2
ImportĀ upstreamĀ versionĀ 1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH DUMMYCONS 8 "Mon Jul 14 2003" "" "Network UPS Tools (NUT)"
 
2
.SH NAME
 
3
dummycons \- Driver for testing UPS software
 
4
 
 
5
.SH SYNOPSIS
 
6
.B dummycons [\fIport\fB]
 
7
 
 
8
.SH DESCRIPTION
 
9
This program looks like a standard UPS driver to \fBupsd\fR(8) and 
 
10
allows you to set any value for testing purposes.  It is interactive,
 
11
and does not enter the background.
 
12
 
 
13
.SH ARGUMENTS
 
14
With no arguments, dummycons will assume a port name of "null".  
 
15
Otherwise, it will use the first argument that you supply as the port 
 
16
name.  This port name must match the one given in \fBups.conf\fR(5).
 
17
 
 
18
You can run multiple instances if needed, as long as they all have
 
19
different port names.
 
20
 
 
21
.SH INTERACTIVE MODE
 
22
By default, you get 5 variables preloaded with information when the
 
23
program starts.  They are:
 
24
 
 
25
        driver.name     = dummycons
 
26
 
 
27
        driver.version  = (varies)
 
28
 
 
29
        ups.mfr         = Console testing
 
30
 
 
31
        ups.model       = Dummy UPS
 
32
 
 
33
        ups.status      = OL
 
34
 
 
35
To create more variables or change the existing values, use the (s)et
 
36
command.  These variables may be deleted with the (d)elete command.  The
 
37
(l)ist command will show everything that you have created.
 
38
 
 
39
Variables can contain spaces if you remember to quote them just like
 
40
in the config files.  That is, if you want to register both on battery and 
 
41
low battery, you need to do something like this:
 
42
 
 
43
        Command (? for help): s ups.status "OB LB"
 
44
 
 
45
Other commands are available, and follow this general pattern.  Use ? in
 
46
the program to see the full list.
 
47
 
 
48
.SH BACKGROUND
 
49
 
 
50
This driver was written in a bar one afternoon when I realized that I 
 
51
had neither Xdialog to run \fBdummyups\fR(8) (since removed from the
 
52
tree) nor an actual UPS on hand.  It has also been used to debug things
 
53
like \fBupsmon\fR(8) in places where you could never have a UPS - like
 
54
on a commercial airliner.
 
55
 
 
56
.SH BUGS
 
57
 
 
58
Instant commands and SET commands don't do anything useful.  You will
 
59
get a notice on the screen when it is received from upsd, but nothing
 
60
else happens.
 
61
 
 
62
This will need to change in the future when the infrastructure for
 
63
confirming these actions has been added.
 
64
 
 
65
.SH SEE ALSO
 
66
 
 
67
\fBups.conf\fR(5)
 
68
 
 
69
.SS Internet resources:
 
70
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/