xref: /freebsd/usr.sbin/diskinfo/diskinfo.8 (revision 57e129b18cfc348b6c91abe2f9ab7df05e72271e)
1.\"
2.\" Copyright (c) 2003 Poul-Henning Kamp
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.\" 3. The names of the authors may not be used to endorse or promote
14.\"    products derived from this software without specific prior written
15.\"    permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd July 1, 2017
32.Dt DISKINFO 8
33.Os
34.Sh NAME
35.Nm diskinfo
36.Nd get information about disk device
37.Sh SYNOPSIS
38.Nm
39.Op Fl citv
40.Ar disk ...
41.Nm
42.Op Fl p
43.Ar disk ...
44.Nm
45.Op Fl s
46.Ar disk ...
47.Sh DESCRIPTION
48The
49.Nm
50utility prints out information about a disk device,
51and optionally runs a naive performance test on the device.
52.Pp
53The following options are available:
54.Bl -tag -width ".Fl v"
55.It Fl v
56Print fields one per line with a descriptive comment.
57.It Fl c
58Perform a simple measurement of the I/O read command overhead.
59.It Fl i
60Perform a simple IOPS benchmark.
61.It Fl p
62Return the physical path of the disk.
63This is a string that identifies the physical path to the disk in the
64storage enclosure.
65.It Fl s
66Return the disk serial number
67.It Fl t
68Perform a simple and rather naive benchmark of the disks seek
69and transfer performance.
70.El
71.Pp
72If given no arguments, the output will be a single line per specified device
73with the following fields: device name, sectorsize, media size in bytes,
74media size in sectors, stripe size, stripe offset, firmware cylinders,
75firmware heads, and firmware sectors.
76The last three fields are only present if the information is available.
77.It Fl i
78Return the disk ident, usually the serial number.
79.It Fl p
80Return the physical path of the disk.
81This is a string that identifies the physical path to the disk in the
82storage enclosure.
83.El
84.Sh HISTORY
85The
86.Nm
87command appeared in
88.Fx 5.1 .
89.Sh AUTHORS
90The
91.Nm
92utility was written by
93.An Poul-Henning Kamp Aq Mt phk@FreeBSD.org .
94.Sh BUGS
95There are in order of increasing severity: lies,
96damn lies, statistics, and computer benchmarks.
97