OpenBSD-4.6/lib/libutil/readlabelfs.3

Compare this file to the similar file:
Show the results in this format:
.\"	$OpenBSD: readlabelfs.3,v 1.7 2007/05/31 19:19:38 jmc 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 $Mdocdate: May 31 2007 $
.Dt READLABELFS 3
.Os
.Sh NAME
.Nm readlabelfs
.Nd read disklabel filesystem type
.Sh SYNOPSIS
.Fd #include <util.h>
.Ft char *
.Fn readlabelfs "char *device" "int verbose"
.Sh DESCRIPTION
The
.Fn readlabelfs
function attempts to determine the filesystem type of the disk
partition specified by
.Fa device
and returns it in a short form that can be easily used to construct
arguments within
.Xr mount 8
and similar high-level filesystem utilities.
.Pp
If the
.Fa verbose
argument is not 0,
.Fn readlabelfs
will print appropriate error messages before returning.
Otherwise, it produces no output on the terminal.
.Sh RETURN VALUES
.Fn readlabelfs
returns
.Dv NULL
upon error, or a valid filesystem type upon success.
.Sh HISTORY
.Fn readlabelfs
first appeared in
.Ox 2.0 .