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.
18 .Nm ufs_disk_close , ufs_disk_fillout , ufs_disk_fillout_blank, ufs_disk_write
19 .Nd open and close userland UFS disks
25 .In ufs/ufs/ufsmount.h
30 .Fn ufs_disk_close "struct uufsd *disk"
32 .Fn ufs_disk_fillout "struct uufsd *disk" "const char *name"
34 .Fn ufs_disk_fillout_blank "struct uufsd *disk" "const char *name"
36 .Fn ufs_disk_write "struct uufsd *disk"
40 function closes a disk and frees internal memory related to it.
48 .Fn ufs_disk_fillout_blank
49 functions open a disk specified by
51 and populate the structure pointed to by
53 The disk is opened read-only.
56 may be either a mountpoint, a device name or a filesystem image.
59 function assumes there is a valid superblock and will fail if not,
61 .Fn ufs_disk_fillout_blank
62 function makes no assumptions of that sort.
66 function attempts to re-open a disk as writable if it is not currently.
70 has no failure points.
74 may fail for any of the reasons
75 .Fn ufs_disk_fillout_blank
76 might, as well as for any reason
81 .Fn ufs_disk_fillout_blank
84 for any of the errors specified for the library functions
87 Additionally, it may follow the
89 error methodologies in situations where no device could be found to
96 for any of the errors specified for the library functions
100 Namely, it will fail if the disk in question may not be written to.
107 These functions first appeared as part of
112 .An Juli Mallett Aq jmallett@FreeBSD.org