xref: /netbsd-src/usr.sbin/ofctl/ofctl.8 (revision d90047b5d07facf36e6c01dcc0bded8997ce9cc2)
1.\"	$NetBSD: ofctl.8,v 1.7 2018/05/28 12:42:02 wiz 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 May 28, 2018
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 lpv
39.Op Fl f Ar file
40.Op Fl r Ar propfile
41.Op Fl w Ar propfile
42.Op Ar node
43.Sh DESCRIPTION
44.Nm
45provides an interface for displaying the OpenPROM or OpenFirmware
46device tree and node properties.
47The
48.Nm
49program is only installed on supported platforms.
50.Pp
51Without any arguments,
52.Nm
53will dump the full tree.
54When given the name of a specific node,
55.Nm
56will display that node and its child nodes.
57.Pp
58The options are as follows:
59.Bl -tag -offset indent -width 12n
60.It Fl f Ar file
61On systems with OpenPROM, use
62.Ar file
63instead of the default
64.Pa /dev/openprom .
65On systems with OpenFirmware, use
66.Ar file
67instead of the default
68.Pa /dev/openfirm .
69.It Fl l
70Dump a partial tree starting from
71.Ar node .
72.It Fl p
73Display each node's properties.
74.It Fl r Ar propfile
75Instead of reading from the openprom or openfirm device,
76use the proplib file
77.Ar propfile
78as input.
79See also
80.Fl w .
81.It Fl v
82Display the full path name for each node.
83.It Fl w Ar propfile
84Write the device tree to the proplib file
85.Ar propfile .
86See also
87.Fl r .
88.El
89.Sh FILES
90.Bl -tag -width "/dev/openprom "
91.It Pa /dev/openprom
92The openprom device on systems with OpenPROM.
93.It Pa /dev/openfirm
94The openfirm device on systems with OpenFirmware.
95.El
96.Sh SEE ALSO
97.Xr eeprom 8
98