d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fac6dee9eb
freebsd-nq/lib/libufs/libufs.3

87 lines
1.7 KiB
Groff
Raw Normal View History

Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.\" Author: Juli Mallett <jmallett@FreeBSD.org>
.\" Date: June 04, 2003
.\" Description:
.\" Manual page for libufs.
.\"
Left out the critical part of my "public domain" template, a notice saying that this file is (these files are) in the public domain. PR: 53149
2003-06-10 18:24:40 +00:00
.\" This file is in the public domain.
.\"
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.\" $FreeBSD$
.\"
Bring up to date with recently added functions berase(3), getinode(3), putinode(3), sbget(3), and sbput(3). Sponsored by: Netflix
2018-11-26 23:09:45 +00:00
.Dd November 26, 2018
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
.Dt LIBUFS 3
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Os
.Sh NAME
.Nm libufs
Markup fixes.
2004-07-05 06:53:34 +00:00
.Nd operate on UFS file systems from userland
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Sh LIBRARY
.Lb libufs
.Sh SYNOPSIS
.In sys/param.h
.In sys/mount.h
.In ufs/ufs/ufsmount.h
.In ufs/ufs/dinode.h
.In ufs/ffs/fs.h
.In libufs.h
.Sh DESCRIPTION
The
.Nm
library and the functions it provides are used for implementing
Markup fixes.
2004-07-05 06:53:34 +00:00
utilities which need to access a UFS file system at a low level from
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
userland.
Facilities provided are used to implement utilities such as
.Xr newfs 8
and
.Xr dumpfs 8 .
The
.Nm
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
library is designed to be simple, and to provide functions that are
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
traditionally useful to have.
.Pp
A disk is represented as the type
Markup fixes.
2004-07-05 06:53:34 +00:00
.Vt "struct uufsd"
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
as defined in
Markup fixes.
2004-07-05 06:53:34 +00:00
.In libufs.h .
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
The structure is filled out, operations are performed, and the disk
is closed.
.Sh ERRORS
Functions provided by
Removed trailing whitespace.
2004-07-02 19:07:33 +00:00
.Nm
Markup fixes.
2004-07-05 06:53:34 +00:00
return \-1 in every functional error situation.
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
They also set the
Markup fixes.
2004-07-05 06:53:34 +00:00
.Va d_error
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
field of
Markup fixes.
2004-07-05 06:53:34 +00:00
.Vt "struct uufsd"
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
to a string describing the error.
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Sh SEE ALSO
Bring up to date with recently added functions berase(3), getinode(3), putinode(3), sbget(3), and sbput(3). Sponsored by: Netflix
2018-11-26 23:09:45 +00:00
.Xr berase 3 ,
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Xr bread 3 ,
.Xr bwrite 3 ,
Correct fsck journal-recovery code to update a cylinder-group check-hash after making changes to the cylinder group. The problem was that the journal-recovery code was calling the libufs bwrite() function instead of the cgput() function. The cgput() function updates the cylinder-group check-hash before writing the cylinder group. This change required the additions of the cgget() and cgput() functions to the libufs API to avoid a gratuitous bcopy of every cylinder group to be read or written. These new functions have been added to the libufs manual pages. This was the first opportunity that I have had to use and document the use of the EDOOFUS error code. Reviewed by: kib Reported by: emaste and others
2018-01-17 17:58:24 +00:00
.Xr cgget 3 ,
.Xr cgput 3 ,
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Xr cgread 3 ,
.Xr cgread1 3 ,
Correct fsck journal-recovery code to update a cylinder-group check-hash after making changes to the cylinder group. The problem was that the journal-recovery code was calling the libufs bwrite() function instead of the cgput() function. The cgput() function updates the cylinder-group check-hash before writing the cylinder group. This change required the additions of the cgget() and cgput() functions to the libufs API to avoid a gratuitous bcopy of every cylinder group to be read or written. These new functions have been added to the libufs manual pages. This was the first opportunity that I have had to use and document the use of the EDOOFUS error code. Reviewed by: kib Reported by: emaste and others
2018-01-17 17:58:24 +00:00
.Xr cgwrite 3 ,
Implement cgwrite1(3) function which stored a given cylinder group on disk. Sponsored by: home.pl
2006-10-31 21:21:48 +00:00
.Xr cgwrite1 3 ,
Bring up to date with recently added functions berase(3), getinode(3), putinode(3), sbget(3), and sbput(3). Sponsored by: Netflix
2018-11-26 23:09:45 +00:00
.Xr getinode 3 ,
.Xr putinode 3 ,
.Xr sbget 3 ,
.Xr sbput 3 ,
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Xr sbread 3 ,
.Xr sbwrite 3 ,
.Xr ufs_disk_close 3 ,
.Xr ufs_disk_fillout 3 ,
.Xr ufs_disk_fillout_blank 3 ,
.Xr ufs_disk_write 3 ,
Sort SEE ALSO references (in dictionary order, ignoring case).
2004-07-04 20:55:50 +00:00
.Xr ffs 7
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Sh HISTORY
The
.Xr libufs 3
library first appeared in
.Fx 5.0 .
.Sh AUTHORS
use .Mt to mark up email addresses consistently (part3) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-23 08:23:05 +00:00
.An Juli Mallett Aq Mt jmallett@FreeBSD.org
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Pp
Markup fixes.
2004-07-05 06:53:34 +00:00
.An -nosplit
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
Additional design, feedback, and ideas were provided by
use .Mt to mark up email addresses consistently (part3) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-23 08:23:05 +00:00
.An Poul-Henning Kamp Aq Mt phk@FreeBSD.org .
Reference in New Issue Copy Permalink