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

« back to all changes in this revision

Viewing changes to man/upsrw.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 UPSRW 8 "Sat May 10 2003" "" "Network UPS Tools (NUT)" 
 
2
.SH NAME
 
3
upsrw \- UPS variable administration tool
 
4
.SH SYNOPSIS
 
5
.B upsrw \fIups\fR
 
6
 
 
7
.B upsrw -h
 
8
 
 
9
.B upsrw -s \fIvariable\fB [-u \fIusername\fB] [-p \fIpassword\fB]
 
10
\fIups\fR
 
11
 
 
12
.SH DESCRIPTION
 
13
 
 
14
.B upsrw
 
15
allows you to view and change the read/write variables inside your UPS.
 
16
It sends commands via the server \fBupsd\fR(8) to your driver, which
 
17
configures the hardware for you.
 
18
 
 
19
The list of variables that allow you to change their values is based on
 
20
the capabilities of your UPS equipment.  Not all models support this
 
21
feature.  Typically, cheaper hardware does not support any of them.
 
22
Run upsrw with a UPS identifier to see what will work for you.
 
23
 
 
24
.SH OPTIONS
 
25
 
 
26
.IP -h
 
27
Display the help message.
 
28
 
 
29
.IP "-s \fIvariable\fR"
 
30
Specify the variable to be changed inside the UPS.  For unattended
 
31
mode such as in shell scripts, use the format VAR=VALUE to specify both
 
32
the variable and the value, for example:
 
33
 
 
34
-s input.transfer.high=129
 
35
 
 
36
Without this argument, upsrw will just display the list of the variables
 
37
and their possible values.
 
38
 
 
39
Some variables are strings, and can be set to any value within the
 
40
length limit.  Others are enumerated types and can only be set to one of
 
41
those values.  Refer to the list to know what's available in your
 
42
hardware.
 
43
 
 
44
.IP "-u \fIusername\fR"
 
45
Set the username for the connection to the server.  This is optional,
 
46
and you will be prompted for this when using the -s option if you don't
 
47
specify -u on the command line.
 
48
 
 
49
.IP "-p \fIpassword\fR"
 
50
Set the password to authenticate to the server.  This is also optional
 
51
like -u, and you will be prompted for it if necessary.  
 
52
 
 
53
.IP \fIups\fR
 
54
View or change the settings on this UPS.  The format for this option is
 
55
upsname@hostname[:port].  
 
56
 
 
57
.SH UNATTENDED MODE
 
58
 
 
59
If you run this program inside a shell script or similar to set
 
60
variables, you will need to specify all of the information on the
 
61
command line.  This means using -s VAR=VALUE, -u and -p.  Otherwise it
 
62
will put up a prompt and your program will hang.
 
63
 
 
64
This is not necessary when displaying the list, as the username and
 
65
password are not required for read-only mode.
 
66
 
 
67
.SH DIAGNOSTICS
 
68
 
 
69
upsrw can't set variables on your UPS unless you provide a valid
 
70
username and password.  If you get "access denied" errors, make sure
 
71
that your \fBupsd.users\fR(5) has an entry for you, and that the
 
72
username you are using has permissions to SET variables.
 
73
 
 
74
.SH HISTORY
 
75
 
 
76
This program used to be called upsct2, which was ambiguous and
 
77
confusing.
 
78
 
 
79
.SH SEE ALSO
 
80
\fBupsd\fR(8), \fBupscmd\fR(8)
 
81
 
 
82
.SS Internet resources:
 
83
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/