1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
Name: Model Arguments
File: model-arguments.txt
Date: 27 November 2001
Auth: Russell Kroll <rkroll@exploits.org>
This file now serves two purposes. It explains the arguments in the
drivers that share a common core, and also lists the arguments that are
being used by the other drivers.
Common core
-----------
Right now, these drivers are in the minority, but that will eventually
change. These are the only drivers that can be autostarted by upsdrvctl,
and are also the only ones that use ups.conf.
To find out if a driver has been converted, call it with -h. If it
lists "-x <var>=<val>" in the help text, then it has. Otherwise, see
the "other drivers" section below.
-a <id> - autostart using ups.conf section <id>
This switch will tell the driver to fetch settings from your
ups.conf file. upsdrvctl uses it when starting drivers for you.
You can also use it manually if you want to start them by hand.
You can override anything in the config file by using additional
arguments after this one. This makes it easy to set site defaults
in the config file, yet still change things for occasional tests.
-d <num> - wait <num> seconds after sending shutdown command
The driver will wait this long after telling the UPS to power off
when you use the -k switch.
-k - force shutdown. Tell the UPS to turn off.
-x <var>=<val> - define a variable called <var> equal to <val>.
This is strictly for passing additional settings to the
hardware-specific part of the driver. Anything you define with -x
can also be defined as <var>=<val> in the ups.conf section for
that UPS.
The apcsmart driver recognizes "-x cable=940-0095B", for example.
You can also define flags if a driver supports it. "-x xyzzy"
would set a flag called xyzzy that the author can check later.
To see what a given driver supports for -x values, call it with
-h.
Other drivers
-------------
This list was intended to list the common command line arguments that were
in use to prevent overlap and confusion. It wasn't always successful.
This will get better as more drivers are converted to the common scheme
described above, as their specific add-on arguments will turn into -x
additions.
This section of the file will be deleted once all of the old drivers
have been converted. Hopefully that will happen soon. Help wanted,
inquire within.
WARNING: this list will be changing significantly during the 0.45 cycle
as the model drivers are being integrated into a common structure.
Check the -h for a given driver as this list will not always
reflect reality.
Switch = Description and some drivers that support it
===================================================================
-c <cable> = use <cable> signaling mode
-d <num> = wait <num> seconds after sending shutdown command
-D = debug mode, run in foreground
-f <file> = specify state file manually
-h = program help
-k <port> = shutdown UPS on <port> immediately
*** older version: parses no further arguments! ***
-i <ident> = ident, default "myups"
powercom
-l = list supported UPS type numbers
genericups
-l <num> = line voltage, default 230
powercom
-m <model> = set model name
genericups powercom
-M <mfr> = set manufacturer name
genericups
-s <num> = select shutdown type
optiups
-s <num> = shutdown after <num> seconds (should be -d!)
victronups
-s <str> = set serial number
powercom
-t <num> = select UPS type
genericups
-t = send custom command to port and print result
optiups
|
