xref: /openbsd/lib/libutil/opendev.3 (revision 78b63d65)
1.\"	$OpenBSD: opendev.3,v 1.10 2000/05/01 06:05:33 hugh Exp $
2.\"
3.\" Copyright (c) 2000, Todd C. Miller.  All rights reserved.
4.\" Copyright (c) 1996, Jason Downs.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
16.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
19.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd February 15, 2000
28.Dt OPENDEV 3
29.Os
30.Sh NAME
31.Nm opendev
32.Nd short form device open routine
33.Sh SYNOPSIS
34.Fd #include <util.h>
35.Ft int
36.Fn opendev "char *path" "int oflags" "int dflags" "char **realpath"
37.Sh DESCRIPTION
38The
39.Fn opendev
40function opens a device using the
41.Dq short form
42name.  This is typically
43.Dq sd0
44or
45.Dq sd0c ,
46for instance, which will be expanded to
47.Pa /dev/rsd0c
48on most architectures.
49.Pp
50Device name lookup is done by first checking
51.Fa path
52for a
53.Dq /
54and if one is found attempting to open that file.
55Otherwise
56.Fa /dev
57is searched for a matching device.
58.Pp
59The
60.Fa oflags
61are the same as the
62.Fa flags
63passed to
64.Xr open 2 .
65.Pp
66The
67.Fa dflags
68are specified by
69.Tn OR Ns 'ing
70the following values:
71.Pp
72.Bd -literal -offset indent -compact
73OPENDEV_PART	attempt to open the raw partition during expansion
74OPENDEV_BLCK	open the block device (default is character device)
75.Ed
76.Pp
77If
78.Fa realpath
79is not
80.Dv NULL ,
81it is modified to point at the fully expanded device name.
82.Sh RETURN VALUES
83The
84.Fn opendev
85return value and errors are the same as the return value and errors of
86.Xr open 2 .
87.Sh SEE ALSO
88.Xr open 2 ,
89.Xr getrawpartition 3
90.Sh HISTORY
91The
92.Fn opendev
93function first appeared in
94.Ox 1.2 .
95