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