opendev.3: opendev(3) man page

1 files changed, 71 insertions, 0 deletions

diff --git a/lib/libutil/opendev.3 b/lib/libutil/opendev.3
new file mode 100644
index 00000000000..481f9cc42da
--- /dev/null
+++ b/lib/libutil/opendev.3
@@ -0,0 +1,71 @@
+.\"	$OpenBSD: opendev.3,v 1.1 1996/06/17 08:17:33 downsj Exp $
+.\"
+.\" Copyright (c) 1996, Jason Downs.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
+.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
+.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd June 17, 1996
+.Dt OPENDEV 3
+.Os OpenBSD
+.Sh NAME
+.Nm opendev
+.Nd short form device open routine
+.Sh SYNOPSIS
+.Fd #include <util.h>
+.Ft int
+.Fn opendev "char *path" "int oflags" "int dflags" "char **realpath"
+.Sh DESCRIPTION
+The
+.Fn opendev
+function opens a device using the ``short form'' name.  This is typically
+``sd0'' or ``sd0c'', for instance, which will be expaned to
+.Pa /dev/rsd0c
+on most architectures.
+.Pp
+The
+.Ar oflags
+are the same as the
+.Ar flags
+passed to
+.Xr open 2 .
+.Pp
+The
+.Ar dflags
+are specified by
+.Em or Ns 'ing
+the following values:
+.Pp
+.Bd -literal -offset indent -compact
+OPENDEV_PART	attempt to open the raw partition during expansion
+OPENDEV_DRCT	attempt to open the device itself during expansion
+.Ed
+.Pp
+.Ar Realpath
+will be modified to point at the fully expanded device name.
+.Pp
+.Sh RETURN VALUES
+The
+.Fn opendev
+return value is the return value of
+.Xr open 2 .
+.Sh SEE ALSO
+.Xr open 2