xref: /dflybsd-src/share/man/man5/devtab.5 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\"
286d7f5d3SJohn Marino.\" Copyright (c) 2009
386d7f5d3SJohn Marino.\"	The DragonFly Project.  All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
686d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
786d7f5d3SJohn Marino.\" are met:
886d7f5d3SJohn Marino.\"
986d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
1086d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1186d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1286d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in
1386d7f5d3SJohn Marino.\"    the documentation and/or other materials provided with the
1486d7f5d3SJohn Marino.\"    distribution.
1586d7f5d3SJohn Marino.\" 3. Neither the name of The DragonFly Project nor the names of its
1686d7f5d3SJohn Marino.\"    contributors may be used to endorse or promote products derived
1786d7f5d3SJohn Marino.\"    from this software without specific, prior written permission.
1886d7f5d3SJohn Marino.\"
1986d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
2086d7f5d3SJohn Marino.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
2186d7f5d3SJohn Marino.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
2286d7f5d3SJohn Marino.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
2386d7f5d3SJohn Marino.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
2486d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
2586d7f5d3SJohn Marino.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
2686d7f5d3SJohn Marino.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
2786d7f5d3SJohn Marino.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
2886d7f5d3SJohn Marino.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
2986d7f5d3SJohn Marino.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3086d7f5d3SJohn Marino.\" SUCH DAMAGE.
3186d7f5d3SJohn Marino.\"
3286d7f5d3SJohn Marino.Dd September 13, 2009
3386d7f5d3SJohn Marino.Dt DEVTAB 5
3486d7f5d3SJohn Marino.Os
3586d7f5d3SJohn Marino.Sh NAME
3686d7f5d3SJohn Marino.Nm devtab
3786d7f5d3SJohn Marino.Nd label conversion file for device paths
3886d7f5d3SJohn Marino.Sh DESCRIPTION
3986d7f5d3SJohn MarinoThe
4086d7f5d3SJohn Marino.Nm
4186d7f5d3SJohn Marinofile contains label conversions for
4286d7f5d3SJohn Marino.Xr fstab 5 ,
4386d7f5d3SJohn Marino.Xr mount 8 ,
4486d7f5d3SJohn Marino.Xr hammer 8 ,
4586d7f5d3SJohn Marinoand other commands which expect device paths.
4686d7f5d3SJohn MarinoIt is typically used to translate longer serial numbers (which
4786d7f5d3SJohn Marino.Xr devfs 5
4886d7f5d3SJohn Marinoautomatically creates as
4986d7f5d3SJohn Marino.Pa /dev/serno/<serial>[.suffix] )
5086d7f5d3SJohn Marinointo short form names.
5186d7f5d3SJohn Marino.Pp
5286d7f5d3SJohn Marino.Nm
5386d7f5d3SJohn Marinois only read by programs, and not written;
5486d7f5d3SJohn Marinoit is the duty of the system administrator to properly create
5586d7f5d3SJohn Marinoand maintain this file.
5686d7f5d3SJohn MarinoEach conversion is described on a separate line;
5786d7f5d3SJohn Marinofields on each line are separated by tabs or spaces.
5886d7f5d3SJohn Marino.Pp
5986d7f5d3SJohn MarinoThe first field specifies the conversion's label.
6086d7f5d3SJohn Marino.Pp
6186d7f5d3SJohn MarinoThe second field is the conversion's type.
6286d7f5d3SJohn MarinoValid types are
6386d7f5d3SJohn Marino.Bl -tag -width ".Sy serno" -offset indent
6486d7f5d3SJohn Marino.It Sy serno
6586d7f5d3SJohn MarinoTranslates to
6686d7f5d3SJohn Marino.Pa /dev/serno
6786d7f5d3SJohn Marino.It Sy path
6886d7f5d3SJohn MarinoTranslates to the path as specified
6986d7f5d3SJohn Marino.El
7086d7f5d3SJohn Marino.Pp
7186d7f5d3SJohn MarinoThe third field specifies the conversion's base path
7286d7f5d3SJohn Marino.Sh FILES
7386d7f5d3SJohn Marino.Bl -tag -width ".Pa /etc/devtab" -compact
7486d7f5d3SJohn Marino.It Pa /etc/devtab
7586d7f5d3SJohn MarinoThe
7686d7f5d3SJohn Marino.Nm
7786d7f5d3SJohn Marinofile resides in
7886d7f5d3SJohn Marino.Pa /etc .
7986d7f5d3SJohn Marino.El
8086d7f5d3SJohn Marino.Sh EXAMPLES
8186d7f5d3SJohn MarinoThis will translate references like
8286d7f5d3SJohn Marino.Sy fubar ,
8386d7f5d3SJohn Marino.Sy fubar.s1a
8486d7f5d3SJohn Marinoetc.\& to their
8586d7f5d3SJohn Marino.Pa /dev/serno/L123456
8686d7f5d3SJohn Marinocounterparts:
8786d7f5d3SJohn Marino.Pp
8886d7f5d3SJohn Marino.Dl "fubar        serno        L123456"
8986d7f5d3SJohn Marino.Pp
9086d7f5d3SJohn MarinoThis will translate references like
9186d7f5d3SJohn Marino.Sy fubar ,
9286d7f5d3SJohn Marino.Sy fubar.s1a
9386d7f5d3SJohn Marinoetc.\& to their
9486d7f5d3SJohn Marino.Pa /full/path
9586d7f5d3SJohn Marinocounterparts:
9686d7f5d3SJohn Marino.Pp
9786d7f5d3SJohn Marino.Dl "fubar        path         /full/path"
9886d7f5d3SJohn Marino.Sh SEE ALSO
9986d7f5d3SJohn Marino.Xr getdevpath 3 ,
10086d7f5d3SJohn Marino.Xr fstab 5 ,
10186d7f5d3SJohn Marino.Xr hammer 8 ,
10286d7f5d3SJohn Marino.Xr mount 8
10386d7f5d3SJohn Marino.Sh HISTORY
10486d7f5d3SJohn MarinoThe
10586d7f5d3SJohn Marino.Nm
10686d7f5d3SJohn Marinofile format appeared in
10786d7f5d3SJohn Marino.Dx 2.3 .
108