share/examples/ses/getencstat/getencstat.0

   1 .\"     $FreeBSD: src/share/examples/ses/getencstat/getencstat.0,v 1.1 2000/02/29 05:44:12 mjacob Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Matthew Jacob
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions, and the following disclaimer,
  11 .\"    without modification, immediately at the beginning of the file.
  12 .\" 2. The name of the author may not be used to endorse or promote products
  13 .\"    derived from this software without specific prior written permission.
  14 .\"
  15 .\" Alternatively, this software may be distributed under the terms of the
  16 .\" the GNU Public License ("GPL").
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  22 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" Matthew Jacob
  31 .\" Feral Software
  32 .\" mjacob@feral.com
  33 .Dd February 21, 2000
  34 .Dt GETENCSTAT 8
  35 .Os
  36 .Sh NAME
  37 .Nm getencstat
  38 .Nd get SCSI Environmental Services Device enclosure status
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl v
  42 .Ar device
  43 .Op Ar device ...
  44 .Sh DESCRIPTION
  45 .Nm
  46 gets summary and detailed SCSI Environmental Services (or SAF-TE) device
  47 enclosure status. The overall status is printed out. If the overall status
  48 is considered okay, nothing else is printed out (unless the
  49 .Fl v
  50 option is used).
  51 .Pp
  52 A SCSI Environmental Services device enclosure may be either in the state
  53 of being \fBOK\fR, or in one or more of the states of \fBINFORMATIONAL\fR,
  54 \fBNON-CRITICAL\fR, \fBCRITICAL\fB or \fBUNRECOVERABLE\fR states. These
  55 overall states reflect a summary of the states of each object within
  56 such a device (such as power supplies or disk drives).
  57 .Pp
  58 With the
  59 .Fl v
  60 option, the status of all objects within the device is printed, whether
  61 \fBOK\fR or not. Along with the status of each object is the object identifier.
  62 .Pp
  63 The user may then use
  64 .Xr setencstat 8
  65 to try and clear overall device status, or may use
  66 .Xr setobjstat 8
  67 to set specific object status.
  68 .Sh FILES
  69 .Bl -tag -width /dev/sesN -compact
  70 .It Pa /dev/ses\fIN\fR
  71 SCSI Environmental Services Devices
  72 .El
  73 .Sh SEE ALSO
  74 .Xr ses 4 ,
  75 .Xr sesd 8 ,
  76 .Xr setencstat 8 ,
  77 .Xr setobjstat 8
  78 .Sh BUGS