docs/man/upsrw.txt

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