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