← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/upscmd.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/upscmd.8
2
2
.SH NAME
3
3
upscmd \- UPS administration program for instant commands
4
4
.SH SYNOPSIS
5
 
.B upscmd -h
6
 
 
7
 
.B upscmd -l \fIups\fR
8
 
 
9
 
.B upscmd [-u \fIusername\fB] [-p \fIpassword\fB] \fIups\fB \fIcommand\fR
 
5
.B upscmd \-h
 
6
 
 
7
.B upscmd \-l \fIups\fR
 
8
 
 
9
.B upscmd [\-u \fIusername\fB] [\-p \fIpassword\fB] \fIups\fB \fIcommand\fR
10
10
 
11
11
.SH DESCRIPTION
12
12
 
13
13
.B upscmd 
14
14
allows you to invoke "instant commands" in your UPS hardware.
15
 
Not all hardware supports this, so check the list with -l to see if
 
15
Not all hardware supports this, so check the list with \-l to see if
16
16
anything will work on your equipment.
17
17
 
18
18
On hardware that supports it, you can use this program to start and stop
21
21
 
22
22
.SH OPTIONS
23
23
 
24
 
.IP -h
 
24
.IP \-h
25
25
Display the help message.
26
26
 
27
 
.IP "-l \fIups\fR"
 
27
.IP "\-l \fIups\fR"
28
28
Show the list of supported instant commands on that UPS.  Some hardware
29
29
may not support any of them.
30
30
 
31
 
.IP "-u \fIusername\fR"
 
31
.IP "\-u \fIusername\fR"
32
32
Set the username for the connection to the server.  This is optional, and
33
 
you will be prompted for this when invoking a command if -u is not used.
 
33
you will be prompted for this when invoking a command if \-u is not used.
34
34
 
35
 
.IP "-p \fIpassword\fR"
 
35
.IP "\-p \fIpassword\fR"
36
36
Set the password to authenticate to the server.  This is also optional 
37
 
like -u, and you will be prompted for it if necessary.
 
37
like \-u, and you will be prompted for it if necessary.
38
38
 
39
39
.IP \fIups\fR
40
40
Connect to this UPS.  The format is upsname@hostname[:port].  
43
43
 
44
44
If you run this program inside a shell script or similar to invoke
45
45
a command, you will need to specify all of the information on the command
46
 
line.  This means using -u and -p.  Otherwise it will put up a prompt and
 
46
line.  This means using \-u and \-p.  Otherwise it will put up a prompt and
47
47
your program will hang.
48
48
 
49
49
This is not necessary when displaying the list, as the username and
50
 
password are not required for read-only mode.
 
50
password are not required for read\(hyonly mode.
51
51
 
52
52
.SH DANGEROUS COMMANDS
53
53
 
54
 
Some drivers like \fBapcsmart\fR(8) have built-in paranoia for the
 
54
Some drivers like \fBapcsmart\fR(8) have built\(hyin paranoia for the
55
55
dangerous commands like load.off.  To make them actually turn off the
56
56
load, you will have to send the command twice within a short window.
57
57
That is, you will have to send it once, then send it again after 3