Expand PMF_FN_* macros.
[netbsd-mini2440.git] / sbin / amrctl / amrctl.8
blob69afe99a6b6980a0d9ecc0fd079d0bc505e6604b
1 .\"     $NetBSD: amrctl.8,v 1.2 2006/07/23 13:23:12 wiz Exp $
2 .\"
3 .\" Copyright (c) 2006 Manuel Bouyer.
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 WARRANTIES
16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 .\"
25 .Dd July 22, 2006
26 .Dt AMRCTL 8
27 .Os
28 .Sh NAME
29 .Nm amrctl
30 .Nd Control utility for AMI MegaRaid controllers
31 .Sh SYNOPSIS
32 .Nm
33 .Ar stat
34 .Op Fl bgv
35 .Op Fl a Ar attempts
36 .Op Fl f Ar device
37 .Op Fl l Ar volno
38 .Op Fl p Ar driveno
39 .Op Fl s Ar busno
40 .Op Fl s Ar busno:driveno
41 .Op Fl t Ar microseconds
42 .Sh DESCRIPTION
43 The
44 .Nm
45 queries or controls AMI MegaRaid controllers supported
46 by the
47 .Xr amr 4
48 driver.
49 .Pp
50 Only the
51 .Ar stat
52 subcommand is currently implemented, and reports status of the controller.
53 The options for the
54 .Ar stat
55 subcommand are as follows:
56 .Bl -tag -offset indent -width XpXperiodXX
57 .It Fl a Ar attempts
58 Number of retries for a command before giving up.
59 Default 5.
60 .It Fl b
61 Report battery status.
62 .It Fl f Ar device
63 Device to use.
64 Default to
65 .Pa /dev/amr0 .
66 .It Fl g
67 Report global paramters for the controller.
68 .It Fl l Ar volno
69 Report status of a logical drive.
70 .It Fl p Ar driveno
71 Report status of a physical drive.
72 .It Fl s Ar busno
73 Report status of all physical drives on the specified bus.
74 .It Fl s Ar busno:driveno
75 Report status of the specified physical drive on the specified bus.
76 .It Fl t Ar microseconds
77 Delay between retries for a command.
78 .It Fl v
79 Increase verbosity level by one.
80 .El
81 .Sh SEE ALSO
82 .Xr amr 4
83 .Sh HISTORY
84 The
85 .Nm
86 command first appeared in
87 .Nx 4.0 .
88 .Sh AUTHORS
89 The
90 .Nm
91 command was written by
92 .An Pierre David
93 .Aq Pierre.David@crc.u-strasbg.fr
94 and
95 .An Jung-uk Kim
96 .Aq jkim@FreeBSD.org
97 for
98 .Fx .