usr/src/man/man1m/prtfru.1m

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PRTFRU 1M "May 30, 2002"
   7 .SH NAME
   8 prtfru \- print FRUID-specific information about the FRUs on a system or domain
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/prtfru\fR [\fB-d\fR] | [\fB-clx\fR] [\fIcontainer\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBprtfru\fR utility is used to obtain \fBFRUID\fR data from the system or
  19 domain. Its output is that of a tree structure echoing the path in the
  20 \fBFRU\fR (Field-Replaceable Unit) tree to each container. When  a container is
  21 found, the data from that container is printed in a tree-like structure as
  22 well.
  23 .sp
  24 .LP
  25 \fBprtfru\fR without any arguments will print the \fBFRU\fR hierarchy and all
  26 of the \fBFRUID\fR container data. \fBprtfru\fR prints to stdout which may be
  27 redirected to a file.
  28 .SH OPTIONS
  29 .sp
  30 .LP
  31 The following options are supported:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fB-c\fR \fR
  36 .ad
  37 .RS 7n
  38 Prints \fIonly\fR the containers and their data. This option does not print the
  39 \fBFRU\fR tree hierarchy.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-d\fR \fR
  46 .ad
  47 .RS 7n
  48 Prints a \fBDTD\fR for the current registry to stdout.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-l\fR \fR
  55 .ad
  56 .RS 7n
  57 Prints \fIonly\fR the \fBFRU\fR tree hierarchy. This option does not print the
  58 container data.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-x\fR \fR
  65 .ad
  66 .RS 7n
  67 Prints in \fBXML\fR format with a system identifier (SYSTEM) of
  68 \fBprtfrureg.dtd\fR.
  69 .RE
  70
  71 .sp
  72 .LP
  73 Options \fB-c\fR and \fB-l\fR can be used together to obtain a list of the
  74 containers.
  75 .SH OPERANDS
  76 .sp
  77 .LP
  78 The folowing operand is supported:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIcontainer\fR\fR
  83 .ad
  84 .RS 13n
  85 The name of a particular container in the \fBFRU\fR hierarchy, that is, either
  86 the name or path/name of a container as displayed in the \fB-l\fR option.
  87 .RE
  88
  89 .SH EXIT STATUS
  90 .sp
  91 .LP
  92 The following exit values are returned:
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fB0\fR\fR
  97 .ad
  98 .RS 6n
  99 All information was found and printed successfully.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB>0\fR\fR
 106 .ad
 107 .RS 6n
 108 An error has occurred.
 109 .RE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBfruadm\fR(1M), \fBattributes\fR(5)