Sync usage with man page.
[netbsd-mini2440.git] / usr.sbin / memswitch / memswitch.8
blobcf9c99ea878c0a31ec8583173d71bac001d78a77
1 .\" $NetBSD: memswitch.8,v 1.3 2003/02/25 10:36:13 wiz Exp $
2 .\"
3 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Minoura Makoto.
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 June 21, 1999
31 .Dt MEMSWITCH 8 x68k
32 .Os
33 .Sh NAME
34 .Nm memswitch
35 .Nd get or set x68k memory switch
36 .Sh SYNOPSIS
37 .Nm
38 .Fl a
39 .Nm
40 .Op Fl h
41 .Op Fl n
42 .Ar variable ...
43 .Nm
44 .Fl w Ar variable=value ...
45 .Nm
46 .Fl r Ar filename
47 .Nm
48 .Fl s Ar filename
49 .Sh DESCRIPTION
50 The
51 .Nm
52 command gets or sets the x68k memory switch stored in the non-volatile
53 static ram.
54 .Pp
55 The first form shows the current values of all the variables of the memory
56 switch.
57 .Pp
58 The second form shows the current values of the specified variables.  If the
59 .Fl h
60 flag is specified, a brief descriptions of the variables are displayed.
61 The
62 .Fl n
63 flag suppresses printing of the variable name.
64 .Pp
65 The third form sets or modifies the specified variables to the given value.
66 .Pp
67 In the fourth and fifth form, the whole memory switch part of non-volatile
68 SRAM is saved to, or restored from the specified file, respectively.
69 .Sh FILES
70 .Bl -tag -width /dev/sram
71 .It Pa /dev/sram
72 non-volatile static memory control device
73 .El
74 .Sh HISTORY
75 The
76 .Nm
77 command first appeared in
78 .Nx 1.5 .