xref: /netbsd-src/usr.sbin/ofctl/ofctl.8 (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1.\"	$NetBSD: ofctl.8,v 1.4 2008/09/25 22:44:51 reed Exp $
2.\"
3.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Matt Thomas.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd September 29, 2006
31.Dt OFCTL 8
32.Os
33.Sh NAME
34.Nm ofctl
35.Nd display the OpenPROM or OpenFirmware device tree
36.Sh SYNOPSIS
37.Nm
38.Op Fl p
39.Op Fl f Ar file
40.Op Ar node
41.Sh DESCRIPTION
42.Nm
43provides an interface for displaying the OpenPROM or OpenFirmware
44device tree and node properties.
45The
46.Nm
47program is only installed on supported platforms.
48.Pp
49Without any arguments,
50.Nm
51will dump the full tree.
52When given the name of a specific node,
53.Nm
54will display that node and its child nodes.
55.Pp
56The options are as follows:
57.Bl -tag -offset indent -width 8n
58.It Fl f Ar file
59On systems with OpenPROM, use
60.Ar file
61instead of the default
62.Pa /dev/openprom .
63On systems with OpenFirmware, use
64.Ar file
65instead of the default
66.Pa /dev/openfirm .
67.It Fl p
68Display each node's properties.
69.El
70.Sh FILES
71.Bl -tag -width "/dev/openprom "
72.It /dev/openprom
73The openprom device on systems with OpenPROM.
74.It /dev/openfirm
75The openfirm device on systems with OpenFirmware.
76.El
77.Sh SEE ALSO
78.Xr eeprom 8
79