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

116 lines
2.4 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 functions:
.\" ufs_disk_close(3)
.\" ufs_disk_fillout(3)
.\" ufs_disk_fillout_blank(3)
.\" ufs_disk_write(3)
.\"
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$
.\"
Fixed spelling of the document date.
2004-07-02 18:00:03 +00:00
.Dd June 4, 2003
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
.Dt UFS_DISK_CLOSE 3
.Os
.Sh NAME
Don't put multiple names on a single .Nm line. This fixes apropos(1) output, from this: strnlen, strlen, strlen,(3) - find length of string │······· ... to this: strlen, strnlen(3) - find length of string PR: 223525 MFC after: 2 weeks
2018-04-17 09:05:46 +00:00
.Nm ufs_disk_close ,
.Nm ufs_disk_fillout ,
.Nm ufs_disk_fillout_blank ,
.Nm ufs_disk_write
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
.Nd open and close userland UFS disks
.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
.Ft int
.Fn ufs_disk_close "struct uufsd *disk"
.Ft int
.Fn ufs_disk_fillout "struct uufsd *disk" "const char *name"
.Ft int
.Fn ufs_disk_fillout_blank "struct uufsd *disk" "const char *name"
.Ft int
.Fn ufs_disk_write "struct uufsd *disk"
.Sh DESCRIPTION
The
.Fn ufs_disk_close
function closes a disk and frees internal memory related to it.
It does not free the
.Fa disk
structure.
.Pp
The
.Fn ufs_disk_fillout
and
.Fn ufs_disk_fillout_blank
functions open a disk specified by
.Fa name
and populate the structure pointed to by
.Fa disk .
The disk is opened read-only.
The specified
.Fa name
Allow libufs(3) functions to operate on a regular file. This makes it possible to use almost anything that uses libufs(3) against a file as an unprivileged user, e.g. tunefs(8) and dumpfs(8) against a makefs(8)-created image. Prodded by: kensmith
2009-06-11 18:04:57 +00:00
may be either a mountpoint, a device name or a filesystem image.
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
.Fn ufs_disk_fillout
function assumes there is a valid superblock and will fail if not,
whereas the
.Fn ufs_disk_fillout_blank
function makes no assumptions of that sort.
.Pp
The
.Fn ufs_disk_write
function attempts to re-open a disk as writable if it is not currently.
.Sh ERRORS
The function
.Fn ufs_disk_close
has no failure points.
.Pp
The function
.Fn ufs_disk_fillout
may fail for any of the reasons
.Fn ufs_disk_fillout_blank
might, as well as for any reason
.Xr sbread 3
might.
.Pp
The
.Fn ufs_disk_fillout_blank
may fail and set
.Va errno
for any of the errors specified for the library functions
.Xr open 2 ,
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
.Xr strdup 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
Additionally, it may follow the
.Xr libufs 3
error methodologies in situations where no device could be found to
open.
.Pp
The function
.Fn ufs_disk_write
may fail and set
.Va errno
for any of the errors specified for the library functions
Fixed xrefs.
2005-01-21 10:35:40 +00:00
.Xr open 2
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
and
Fixed xrefs.
2005-01-21 10:35:40 +00:00
.Xr stat 2 .
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
Namely, it will fail if the disk in question may not be written to.
.Sh SEE ALSO
Fixed xrefs.
2005-01-21 10:35:40 +00:00
.Xr open 2 ,
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 getfsfile 3 ,
.Xr libufs 3 ,
.Xr sbread 3
.Sh HISTORY
These functions first appeared as part of
.Xr libufs 3
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
Reference in New Issue Copy Permalink