usr.sbin/nvram/nvram.8

   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 .Op Fl d Ar name
  39 .Op Ar name Ns = Ns Ar value
  40 .Ar ...
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility provides an interface for displaying and changing the system's
  45 configuration variables contained in EEPROM or NVRAM.
  46 In the first synopsis form, all available configuration variables and their
  47 current values are printed.
  48 In the second form, the variable selected by
  49 .Ar name
  50 is either removed or its value is changed to the
  51 .Ar value
  52 following by
  53 .Ql =
  54 sign.
  55 .Pp
  56 The following options are available:
  57 .Bl -tag -width indent
  58 .It Fl d Ar name
  59 Delete the variable selected by
  60 .Ar name
  61 from the EEPROM or NVRAM.  The
  62 .Fl d
  63 flag can be specified multiple times, in which case multiple variables
  64 will be removed.
  65 .It Fl p
  66 Print all available configuration variables and their current values.
  67 .El
  68 .Sh EXAMPLES
  69 Print all available configuration variables and their current values:
  70 .Pp
  71 .Dl "nvram -p"
  72 .Pp
  73 Remove the variable named
  74 .Va local-mac-address? :
  75 .Pp
  76 .Dl "nvram -d local-mac-address\e?"
  77 .Pp
  78 Set the value of the
  79 .Va local-mac-address?
  80 variable to
  81 .Dq Li true :
  82 .Pp
  83 .Dl "nvram local-mac-address\e?=true"
  84 .Pp
  85 Note that the
  86 .Ql \e
  87 in the above examples is used to keep the shell from interpreting the
  88 .Ql \&? .
  89 .Pp
  90 Remove variables named
  91 .Va foo
  92 and
  93 .Va bar
  94 and set variable named
  95 .Va baz
  96 to
  97 .Dq Li 100 :
  98 .Pp
  99 .Dl "nvram -d foo -d bar baz=100"
 100 .Ed
 101 .Sh SEE ALSO
 102 .Xr powermac_nvram 4 ,
 103 .Xr eeprom 8
 104 .Sh HISTORY
 105 The
 106 .Nm
 107 utility first appeared in
 108 .Fx 7.0 .
 109 It is inspired by the
 110 Darwin/Mac OS X
 111 .Xr nvram 8
 112 utility.
 113 .Sh AUTHORS
 114 .An Maxim Sobolev Aq sobomax@FreeBSD.org .
 115 .Sh BUGS
 116 Currently,
 117 .Nm
 118 only supports systems equipped with AMD flash and is only tested on Apple
 119 G4-based Mac Mini machines.