1 .\" Copyright (c) 2010 The DragonFly Project. All rights reserved.
3 .\" This code is derived from software contributed to The DragonFly Project
4 .\" by Ákos Kovács <akoskovacs@gmx.com>
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in
14 .\" the documentation and/or other materials provided with the
16 .\" 3. Neither the name of The DragonFly Project nor the names of its
17 .\" contributors may be used to endorse or promote products derived
18 .\" from this software without specific, prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 .Nm fsid_volname_all ,
43 .Nd general libfsid functions
45 A simple interface for filesystem recognising.
46 Programs should be linked with
51 .Fn fsid_probe "const char *dev" "const char *fs_type"
53 .Fn fsid_probe_all "const char *dev"
55 .Fn fsid_volname "const char *dev" "const char *fs_type"
57 .Fn fsid_volname_all "const char *dev"
59 .Fn fsid_fsname "int id"
61 .Fn fsid_fs_count "void"
64 .\" General description
67 provides an interface to determine several filesystems
68 and to get their volume labels.
70 Big part of the functions use the first parameter
72 as the full path of the device, some of them has additionally an
74 parameter wich is the name of the choosen filesystem. It can be:
76 .Bd -literal -offset indent -compact
85 .\" fsid_probe function
88 returns 1 if the device has the filesystem type as expected by the
90 parameter, otherwise 0.
92 .\" fsid_probe_all function
94 function try to identify the filesystem type, it returns 0 if the filesystem unknown, or the check fails. Otherwise the returned value is one of this macros:
96 .Bd -literal -offset indent -compact
101 FSID_MSDOSFS FAT32, FAT16
104 The name of the filesystem can easily queried with the
108 function returns with the volume label, if the filesystem is the same as the
110 if not just returns with
114 give back the volume label, if the filesystem known otherwise returns with
118 give back the name of the filesystem as a pointer to string. The
120 is mostly the return value of the
124 return with a number of supported filesystems.
126 The library and the manual page wrote by Ákos Kovács <akoskovacs@gmx.com>.