summaryrefslogtreecommitdiffstats
path: root/lib/libufs
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-07-05 06:53:34 +0000
committerru <ru@FreeBSD.org>2004-07-05 06:53:34 +0000
commitfb1f106142236de87bc55c894569373c3559c0ab (patch)
tree8b55b52af9504e03f7fe2906d76823380725cbfc /lib/libufs
parentb5e1c67f190b165b28331207530a72be81657177 (diff)
downloadFreeBSD-src-fb1f106142236de87bc55c894569373c3559c0ab.zip
FreeBSD-src-fb1f106142236de87bc55c894569373c3559c0ab.tar.gz
Markup fixes.
Diffstat (limited to 'lib/libufs')
-rw-r--r--lib/libufs/bread.313
-rw-r--r--lib/libufs/cgread.314
-rw-r--r--lib/libufs/getino.38
-rw-r--r--lib/libufs/libufs.315
-rw-r--r--lib/libufs/sbread.312
5 files changed, 31 insertions, 31 deletions
diff --git a/lib/libufs/bread.3 b/lib/libufs/bread.3
index 5fe7224..80aa921 100644
--- a/lib/libufs/bread.3
+++ b/lib/libufs/bread.3
@@ -14,7 +14,7 @@
.Os
.Sh NAME
.Nm bread , bwrite
-.Nd read and write blocks of a UFS filesystem
+.Nd read and write blocks of a UFS file system
.Sh LIBRARY
.Lb libufs
.Sh SYNOPSIS
@@ -27,7 +27,10 @@
.Ft ssize_t
.Fn bread "struct uufsd *disk" "ufs2_daddr_t blockno" "void *data" "size_t size"
.Ft ssize_t
-.Fn bwrite "struct uufsd *disk" "ufs2_daddr_t blockno" "const void *data" "size_t size"
+.Fo bwrite
+.Fa "struct uufsd *disk" "ufs2_daddr_t blockno"
+.Fa "const void *data" "size_t size"
+.Fc
.Sh DESCRIPTION
The
.Fn bread
@@ -38,14 +41,14 @@ functions provide a block read and write API for
consumers.
They operate on a userland UFS disk structure, and perform the read
and write at a given block address, which uses the current
-.Fa d_bsize
+.Va d_bsize
value of the structure.
-.Pp
+.Sh RETURN VALUES
The
.Fn bread
and
.Fn bwrite
-functions return the amount read or written, or -1 in case of any error,
+functions return the amount read or written, or \-1 in case of any error,
including short read.
.Sh ERRORS
The function
diff --git a/lib/libufs/cgread.3 b/lib/libufs/cgread.3
index e43af73..f98da40 100644
--- a/lib/libufs/cgread.3
+++ b/lib/libufs/cgread.3
@@ -41,10 +41,10 @@ The
function reads from one cylinder group, specified by
.Fa c
into the
-.Fa d_cg
+.Va d_cg
field of a userland UFS disk structure.
It sets the
-.Fa d_lcg
+.Va d_lcg
field to the cylinder group number
.Fa c .
.Pp
@@ -54,15 +54,15 @@ function operates on sequential cylinder groups.
Calling the
.Fn cgread
function is equivalent to calling
-.Nm cgread1
+.Fn cgread1
with a cylinder group specifier equivalent to the value of the current
-.Fa d_ccg
+.Va d_ccg
field, and then incrementing the
-.Fa d_ccg
+.Va d_ccg
field.
-.Pp
+.Sh RETURN VALUES
Both functions return 0 if there are no more cylinder groups to read,
-1 if there are more cylinder groups, and -1 on error.
+1 if there are more cylinder groups, and \-1 on error.
.Sh ERRORS
The function
.Fn cgread
diff --git a/lib/libufs/getino.3 b/lib/libufs/getino.3
index a0cc2b5..881d9e7 100644
--- a/lib/libufs/getino.3
+++ b/lib/libufs/getino.3
@@ -47,9 +47,9 @@ pointed to by
It maintains a cache of nearby inodes, and may simply return pointers
into memory that are in said cache.
The pointer it returns may be modified as if it were of the type
-.Dq struct ufs1_dinode
+.Vt "struct ufs1_dinode"
or
-.Dq struct ufs2_dinode
+.Vt "struct ufs2_dinode"
depending on whether the disk being operated on is UFS1 or UFS2,
respectively.
.Pp
@@ -66,8 +66,8 @@ by
Calls to
.Fn putino
immediately invalidate the inode cache.
-.Pp
-Both functions return 0 on success and -1 on error.
+.Sh RETURN VALUES
+.Rv -std
.Sh ERRORS
The function
.Fn getino
diff --git a/lib/libufs/libufs.3 b/lib/libufs/libufs.3
index 72d5c45..ecdfb27 100644
--- a/lib/libufs/libufs.3
+++ b/lib/libufs/libufs.3
@@ -12,7 +12,7 @@
.Os
.Sh NAME
.Nm libufs
-.Nd operate on UFS filesystems from userland
+.Nd operate on UFS file systems from userland
.Sh LIBRARY
.Lb libufs
.Sh SYNOPSIS
@@ -26,7 +26,7 @@
The
.Nm
library and the functions it provides are used for implementing
-utilities which need to access a UFS filesystem at a low level from
+utilities which need to access a UFS file system at a low level from
userland.
Facilities provided are used to implement utilities such as
.Xr newfs 8
@@ -38,19 +38,19 @@ library is designed to be simple, and to provide functions that are
traditionally useful to have.
.Pp
A disk is represented as the type
-.Dq struct uufsd
+.Vt "struct uufsd"
as defined in
-.Pa libufs.h .
+.In libufs.h .
The structure is filled out, operations are performed, and the disk
is closed.
.Sh ERRORS
Functions provided by
.Nm
-return -1 in every functional error situation.
+return \-1 in every functional error situation.
They also set the
-.Fa d_error
+.Va d_error
field of
-.Dq struct uufsd
+.Vt "struct uufsd"
to a string describing the error.
.Sh SEE ALSO
.Xr bread 3 ,
@@ -72,5 +72,6 @@ library first appeared in
.Sh AUTHORS
.An Juli Mallett Aq jmallett@FreeBSD.org
.Pp
+.An -nosplit
Additional design, feedback, and ideas were provided by
.An Poul-Henning Kamp Aq phk@FreeBSD.org .
diff --git a/lib/libufs/sbread.3 b/lib/libufs/sbread.3
index abdc616..e59365a 100644
--- a/lib/libufs/sbread.3
+++ b/lib/libufs/sbread.3
@@ -14,7 +14,7 @@
.Os
.Sh NAME
.Nm sbread , sbwrite
-.Nd read and write superblocks of a UFS filesystem
+.Nd read and write superblocks of a UFS file system
.Sh LIBRARY
.Lb libufs
.Sh SYNOPSIS
@@ -41,19 +41,15 @@ The
and
.Fn sbwrite
functions operate on the superblock field,
-.Fa d_sb ,
+.Va d_sb ,
associated with a given userland UFS disk structure.
Additionally, the
.Fn sbwrite
function will write to all superblock locations if the
.Fa all
value is non-zero.
-.Pp
-The
-.Fn sbread
-and
-.Fn sbwrite
-functions return 0 on success or -1 on error.
+.Sh RETURN VALUES
+.Rv -std sbread sbwrite
.Sh ERRORS
The function
.Fn sbread
OpenPOWER on IntegriCloud