xref: /freebsd/lib/libufs/libufs.3 (revision 1a720cbec513210fa2e85c3882741ef2f6dc5f35)
1e78ea9f7SJuli Mallett.\" Author:	Juli Mallett <jmallett@FreeBSD.org>
2e78ea9f7SJuli Mallett.\" Date:	June 04, 2003
3e78ea9f7SJuli Mallett.\" Description:
4e78ea9f7SJuli Mallett.\" 	Manual page for libufs.
5e78ea9f7SJuli Mallett.\"
627fd7478SJuli Mallett.\" This file is in the public domain.
727fd7478SJuli Mallett.\"
885ee267aSKirk McKusick.Dd September 2, 2020
9dfa13bbfSJuli Mallett.Dt LIBUFS 3
10e78ea9f7SJuli Mallett.Os
11e78ea9f7SJuli Mallett.Sh NAME
12e78ea9f7SJuli Mallett.Nm libufs
13dfa13bbfSJuli Mallett.Nd operate on UFS file systems from userland
14e78ea9f7SJuli Mallett.Sh LIBRARY
15e78ea9f7SJuli Mallett.Lb libufs
16e78ea9f7SJuli Mallett.Sh SYNOPSIS
17e78ea9f7SJuli Mallett.In sys/param.h
18e78ea9f7SJuli Mallett.In sys/mount.h
19e78ea9f7SJuli Mallett.In ufs/ufs/ufsmount.h
20e78ea9f7SJuli Mallett.In ufs/ufs/dinode.h
21e78ea9f7SJuli Mallett.In ufs/ffs/fs.h
22e78ea9f7SJuli Mallett.In libufs.h
23e78ea9f7SJuli Mallett.Sh DESCRIPTION
24e78ea9f7SJuli MallettThe
25e78ea9f7SJuli Mallett.Nm
26e78ea9f7SJuli Mallettlibrary and the functions it provides are used for implementing
27e78ea9f7SJuli Mallettutilities which need to access a UFS file system at a low level from
28e78ea9f7SJuli Mallettuserland.
29e78ea9f7SJuli MallettFacilities provided are used to implement utilities such as
30e78ea9f7SJuli Mallett.Xr newfs 8
31e78ea9f7SJuli Mallettand
32e78ea9f7SJuli Mallett.Xr dumpfs 8 .
33e78ea9f7SJuli MallettThe
34e78ea9f7SJuli Mallett.Nm
35dfa13bbfSJuli Mallettlibrary is designed to be simple, and to provide functions that are
36e78ea9f7SJuli Malletttraditionally useful to have.
37e78ea9f7SJuli Mallett.Pp
38e78ea9f7SJuli MallettA disk is represented as the type
39c81fcafdSRuslan Ermilov.Vt "struct uufsd"
40e78ea9f7SJuli Mallettas defined in
41c81fcafdSRuslan Ermilov.In libufs.h .
42e78ea9f7SJuli MallettThe structure is filled out, operations are performed, and the disk
43e78ea9f7SJuli Mallettis closed.
44e78ea9f7SJuli Mallett.Sh ERRORS
45e78ea9f7SJuli MallettFunctions provided by
46e78ea9f7SJuli Mallett.Nm
47c81fcafdSRuslan Ermilovreturn \-1 in every functional error situation.
48e78ea9f7SJuli MallettThey also set the
49c81fcafdSRuslan Ermilov.Va d_error
50dfa13bbfSJuli Mallettfield of
51c81fcafdSRuslan Ermilov.Vt "struct uufsd"
52dfa13bbfSJuli Mallettto a string describing the error.
53e78ea9f7SJuli Mallett.Sh SEE ALSO
544391a9c0SKirk McKusick.Xr berase 3 ,
55e78ea9f7SJuli Mallett.Xr bread 3 ,
56e78ea9f7SJuli Mallett.Xr bwrite 3 ,
5772f854ceSKirk McKusick.Xr cgget 3 ,
5872f854ceSKirk McKusick.Xr cgput 3 ,
59e78ea9f7SJuli Mallett.Xr cgread 3 ,
60e78ea9f7SJuli Mallett.Xr cgread1 3 ,
6172f854ceSKirk McKusick.Xr cgwrite 3 ,
62cf4652e7SPawel Jakub Dawidek.Xr cgwrite1 3 ,
634391a9c0SKirk McKusick.Xr getinode 3 ,
644391a9c0SKirk McKusick.Xr putinode 3 ,
654391a9c0SKirk McKusick.Xr sbget 3 ,
664391a9c0SKirk McKusick.Xr sbput 3 ,
67e78ea9f7SJuli Mallett.Xr sbread 3 ,
68e78ea9f7SJuli Mallett.Xr sbwrite 3 ,
69e78ea9f7SJuli Mallett.Xr ufs_disk_close 3 ,
70e78ea9f7SJuli Mallett.Xr ufs_disk_fillout 3 ,
71e78ea9f7SJuli Mallett.Xr ufs_disk_fillout_blank 3 ,
72e78ea9f7SJuli Mallett.Xr ufs_disk_write 3 ,
73*1a720cbeSAlexander Ziaee.Xr ffs 4
74e78ea9f7SJuli Mallett.Sh HISTORY
75e78ea9f7SJuli MallettThe
76e78ea9f7SJuli Mallett.Xr libufs 3
77e78ea9f7SJuli Mallettlibrary first appeared in
78e78ea9f7SJuli Mallett.Fx 5.0 .
79e78ea9f7SJuli Mallett.Sh AUTHORS
802b7af31cSBaptiste Daroussin.An Juli Mallett Aq Mt jmallett@FreeBSD.org
8185ee267aSKirk McKusick.An Marshall Kirk McKusick Aq Mt mckusick@FreeBSD.org
82e78ea9f7SJuli Mallett.Pp
83c81fcafdSRuslan Ermilov.An -nosplit
84e78ea9f7SJuli MallettAdditional design, feedback, and ideas were provided by
852b7af31cSBaptiste Daroussin.An Poul-Henning Kamp Aq Mt phk@FreeBSD.org .
86