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.
19 .Nm ufs_disk_fillout ,
20 .Nm ufs_disk_fillout_blank ,
22 .Nd open and close userland UFS disks
28 .In ufs/ufs/ufsmount.h
33 .Fn ufs_disk_close "struct uufsd *disk"
35 .Fn ufs_disk_fillout "struct uufsd *disk" "const char *name"
37 .Fn ufs_disk_fillout_blank "struct uufsd *disk" "const char *name"
39 .Fn ufs_disk_write "struct uufsd *disk"
43 function closes a disk and frees internal memory related to it.
51 .Fn ufs_disk_fillout_blank
52 functions open a disk specified by
54 and populate the structure pointed to by
56 The disk is opened read-only.
59 may be either a mountpoint, a device name or a filesystem image.
62 function assumes there is a valid superblock and will fail if not,
64 .Fn ufs_disk_fillout_blank
65 function makes no assumptions of that sort.
69 function attempts to re-open a disk as writable if it is not currently.
73 has no failure points.
77 may fail for any of the reasons
78 .Fn ufs_disk_fillout_blank
79 might, as well as for any reason
84 .Fn ufs_disk_fillout_blank
87 for any of the errors specified for the library functions
90 Additionally, it may follow the
92 error methodologies in situations where no device could be found to
99 for any of the errors specified for the library functions
103 Namely, it will fail if the disk in question may not be written to.
110 These functions first appeared as part of
115 .An Juli Mallett Aq Mt jmallett@FreeBSD.org