2 .\" Copyright (c) 2011 The DragonFly Project. All rights reserved.
4 .\" This code is derived from software contributed to The DragonFly Project
5 .\" by Antonio Huete Jimenez <tuxillo@quantumachine.net>
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in
15 .\" the documentation and/or other materials provided with the
17 .\" 3. Neither the name of The DragonFly Project nor the names of its
18 .\" contributors may be used to endorse or promote products derived
19 .\" from this software without specific, prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nm libhammer_get_volinfo
39 .Nm libhammer_get_next_pfs
40 .Nm libhammer_get_prev_pfs
41 .Nm libhammer_get_first_pfs
42 .Nm libhammer_get_last_pfs
43 .Nm libhammer_free_volinfo
44 .Nd libhammer information functions
49 .Ft libhammer_volinfo_t
50 .Fn libhammer_get_volinfo "const char *path"
51 .Ft libhammer_pfsinfo_t
52 .Fn libhammer_get_first_pfs "libhammer_volinfo_t volinfo"
53 .Ft libhammer_pfsinfo_t
54 .Fn libhammer_get_last_pfs "libhammer_volinfo_t volinfo"
55 .Ft libhammer_pfsinfo_t
56 .Fn libhammer_get_next_pfs "libhammer_pfsinfo_t pfsinfo"
57 .Ft libhammer_pfsinfo_t
58 .Fn libhammer_get_prev_pfs "libhammer_pfsinfo_t pfsinfo"
60 .Fn libhammer_free_volinfo "libhammer_volinfo_t volinfo"
63 .Fn libhammer_get_volinfo
64 iterates all the PFSs from a given path belonging to a
66 filesystem and returns
67 .Vt libhammer_volinfo_t
73 structs, one per PFS found.
75 The list of found PFSs can be iterated with
76 .Fn libhammer_get_first_pfs ,
77 .Fn libhammer_get_last_pfs ,
78 .Fn libhammer_get_next_pfs
80 .Fn libhammer_get_prev_pfs .
82 Note that to use the next and previous functions described above you need
83 to store the returning
84 .Vt libhammer_pfsinfo_t
85 value from the first and last functions.
87 .Fn libhammer_free_volinfo
88 frees up all the memory allocated previously by
89 .Fn libhammer_get_volinfo .
91 .Fn libhammer_get_volinfo
93 .Vt libhammer_volinfo_t
94 in any case where path is in a
98 if there was any other problem.
103 .Fn libhammer_get_first_pfs
105 .Fn libhammer_get_last_pfs
111 .Fn libhammer_get_next_pfs
113 .Fn libhammer_get_prev_pfs
115 .Vt libhammer_pfsinfo_t
118 in case there are no more elements.
123 This manpage was written by
124 .An Antonio Huete Jimenez.