xref: /minix/lib/libutil/getfsspecname.3 (revision 0a6a1f1d)
1.\"	$NetBSD: getfsspecname.3,v 1.5 2015/06/13 19:52:58 dholland Exp $
2.\"
3.\" Copyright (c) 2012 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Christos Zoulas.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\"
31.Dd August 18, 2014
32.Dt GETFSSPECNAME 3
33.Os
34.Sh NAME
35.Nm getfsspecname
36.Nd get the underlying wedge name from a label
37.Sh LIBRARY
38.Lb libutil
39.Sh SYNOPSIS
40.In util.h
41.Ft const char *
42.Fn getfsspecname "char *buf" "size_t buflen" "const char *spec"
43.Sh DESCRIPTION
44The
45.Fn getfsspecname
46function translates an
47.Ft fs_spec
48field in the
49.Fa spec
50argument of the form
51.Dq NAME=wedgename
52to the underlying
53.Xr dk 4
54device node, and places the resulting pathname in
55.Fa buf
56up to len
57.Fa buflen .
58.Pp
59If the
60.Fa spec
61argument is not of the form
62.Dq NAME=wedgename ,
63.Fa spec
64is copied
65to
66.Fa buf
67and returned.
68.Sh RETURN VALUES
69On success the absolute pathname of the underlying wedge device is returned,
70or the original
71.Fa spec
72argument.
73On failure
74.Dv NULL
75is returned and
76.Fa buf
77contains the reason for the error.
78.Sh SEE ALSO
79.Xr fstab 5
80.Sh HISTORY
81The
82.Fn getfsspecname
83function appeared in
84.Nx 7.0 .
85