xref: /freebsd/usr.sbin/nvram/nvram.8 (revision c697fb7f)
1.\"-
2.\" Copyright (c) 2006 Maxim Sobolev <sobomax@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24.\" POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd August 1, 2006
29.Dt NVRAM 8 powerpc
30.Os
31.Sh NAME
32.Nm nvram
33.Nd "display or modify contents of the EEPROM or NVRAM"
34.Sh SYNOPSIS
35.Nm
36.Fl p
37.Nm
38.Oo Fl d Ar name Oc Ar ...
39.Op Ar name Ns = Ns Ar value ...
40.Sh DESCRIPTION
41The
42.Nm
43utility provides an interface for displaying and changing the system's
44configuration variables contained in EEPROM or NVRAM.
45In the first synopsis form, all available configuration variables and their
46current values are printed.
47In the second form, the variable selected by
48.Ar name
49is either removed or its value is changed to the
50.Ar value
51following by
52.Ql =
53sign.
54.Pp
55The following options are available:
56.Bl -tag -width indent
57.It Fl d Ar name
58Delete the variable selected by
59.Ar name
60from the EEPROM or NVRAM.
61The
62.Fl d
63flag can be specified multiple times, in which case multiple variables
64will be removed.
65.It Fl p
66Print all available configuration variables and their current values.
67.El
68.Sh EXAMPLES
69Print all available configuration variables and their current values:
70.Pp
71.Dl "nvram -p"
72.Pp
73Remove the variable named
74.Va local-mac-address? :
75.Pp
76.Dl "nvram -d local-mac-address\e?"
77.Pp
78Set the value of the
79.Va local-mac-address?
80variable to
81.Dq Li true :
82.Pp
83.Dl "nvram local-mac-address\e?=true"
84.Pp
85Note that the
86.Ql \e
87in the above examples is used to keep the shell from interpreting the
88.Ql \&? .
89.Pp
90Remove variables named
91.Va foo
92and
93.Va bar
94and set variable named
95.Va baz
96to
97.Dq Li 100 :
98.Pp
99.Dl "nvram -d foo -d bar baz=100"
100.Sh SEE ALSO
101.Xr powermac_nvram 4 ,
102.Xr eeprom 8
103.Sh HISTORY
104The
105.Nm
106utility first appeared in
107.Fx 7.0 .
108It is inspired by the
109Darwin/Mac OS X
110.Nm
111utility.
112.Sh AUTHORS
113.An Maxim Sobolev Aq Mt sobomax@FreeBSD.org
114.Sh BUGS
115Currently,
116.Nm
117only supports systems equipped with AMD flash and is only tested on Apple
118G4-based Mac Mini machines.
119