1 .\" Author: Juli Mallett <jmallett@FreeBSD.org>
2 .\" Date: June 04, 2003
4 .\" Manual page for libufs functions:
6 .\" ufs_disk_fillout(3)
7 .\" ufs_disk_fillout_blank(3)
10 .\" This file is in the public domain.
17 .Nm ufs_disk_fillout ,
18 .Nm ufs_disk_fillout_blank ,
20 .Nd open and close userland UFS disks
26 .In ufs/ufs/ufsmount.h
31 .Fn ufs_disk_close "struct uufsd *disk"
33 .Fn ufs_disk_fillout "struct uufsd *disk" "const char *name"
35 .Fn ufs_disk_fillout_blank "struct uufsd *disk" "const char *name"
37 .Fn ufs_disk_write "struct uufsd *disk"
41 function closes a disk and frees internal memory related to it.
49 .Fn ufs_disk_fillout_blank
50 functions open a disk specified by
52 and populate the structure pointed to by
54 The structure referenced by the
56 pointer must be aligned to at least the alignment specified by
58 that is defined in the
61 The disk is opened read-only.
64 may be either a mountpoint, a device name or a filesystem image.
67 function assumes there is a valid superblock and will fail if not,
69 .Fn ufs_disk_fillout_blank
70 function makes no assumptions of that sort.
74 function attempts to re-open a disk as writable if it is not currently.
78 has no failure points.
82 may fail for any of the reasons
83 .Fn ufs_disk_fillout_blank
84 might, as well as for any reason
89 .Fn ufs_disk_fillout_blank
92 for any of the errors specified for the library functions
95 Additionally, it may follow the
97 error methodologies in situations where no device could be found to
104 for any of the errors specified for the library functions
108 Namely, it will fail if the disk in question may not be written to.
115 These functions first appeared as part of
120 .An Juli Mallett Aq Mt jmallett@FreeBSD.org