Fix various mdoc issues in various manual pages.
[dragonfly.git] / sbin / getdevpath / getdevpath.8
1 .\"
2 .\" Copyright (c) 2009 The DragonFly Project.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to The DragonFly Project
5 .\" by Matthew Dillon <dillon@backplane.com>
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in
15 .\"    the documentation and/or other materials provided with the
16 .\"    distribution.
17 .\" 3. Neither the name of The DragonFly Project nor the names of its
18 .\"    contributors may be used to endorse or promote products derived
19 .\"    from this software without specific, prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .Dd July 10, 2009
35 .Os
36 .Dt GETDEVPATH 8
37 .Sh NAME
38 .Nm getdevpath
39 .Nd "translate device partial or label to device path"
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl qr
43 .Ar devname ...
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility directly calls the
48 .Xr getdevpath 3
49 function for each supplied device name, translating the device name
50 to a device path.
51 .Pp
52 The
53 .Fl q
54 option will generate just the translated output, one per line.
55 An empty line is generated if the device name could not be translated.
56 .Pp
57 The
58 .Fl r
59 option will take the translated device name and do a further translation
60 of it if it is a softlink, returning the contents of the softlink.
61 .Sh FILES
62 .Nm
63 will search the
64 .Pa /usr/local/etc/devtab ,
65 .Pa /etc/devtab ,
66 and
67 .Pa /etc/defaults/devtab
68 files for label translations.
69 .Sh EXAMPLES
70 .Bd -literal
71 getdevpath da0
72
73 getdevpath /dev/da0
74
75 getdevpath serno:ABC123
76
77 getdevpath MyDisk
78 .Ed
79 .Sh SEE ALSO
80 .Xr getdevpath 3 ,
81 .Xr devtab 5 ,
82 .Xr fstab 5
83 .Sh HISTORY
84 The
85 .Nm
86 utility appeared in
87 .Dx 2.3