Date: Tue, 10 Jun 2003 16:42:24 +0200 (CEST) From: Lukas Ertl <l.ertl@univie.ac.at> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/53149: [PATCH] overhaul libufs(3) manpages Message-ID: <200306101442.h5AEgOam001759@korben.in.tern> Resent-Message-ID: <200306101450.h5AEoCC6055106@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 53149 >Category: docs >Synopsis: [PATCH] overhaul libufs(3) manpages >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Tue Jun 10 07:50:12 PDT 2003 >Closed-Date: >Last-Modified: >Originator: Lukas Ertl >Release: FreeBSD 5.1-CURRENT i386 >Organization: Vienna University Computer Center >Environment: System: FreeBSD korben 5.1-CURRENT FreeBSD 5.1-CURRENT #8: Tue Jun 10 01:46:17 CEST 2003 le@korben:/usr/obj/usr/src/sys/KORBEN i386 >Description: The freshly imported manpages for libufs(3) contain some errors and are missing a copyright notice. >How-To-Repeat: >Fix: I hope Juli is not upset that I add a standard BSD license on the files. :-) --- libufs.diff begins here --- Index: lib/libufs/bread.3 =================================================================== RCS file: /u/cvs/cvs/src/lib/libufs/bread.3,v retrieving revision 1.1 diff -u -r1.1 bread.3 --- lib/libufs/bread.3 9 Jun 2003 09:59:11 -0000 1.1 +++ lib/libufs/bread.3 10 Jun 2003 14:37:36 -0000 @@ -1,3 +1,30 @@ +.\" Copyright (c) 2003 Juli Mallett +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The names of the authors may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" .\" Author: Juli Mallett <jmallett@FreeBSD.org> .\" Date: June 04, 2003 .\" Description: @@ -32,7 +59,7 @@ .Fn bread and .Fn bwrite -functions provide a block read and write api for +functions provide a block read and write API for .Xr libufs 3 consumers. They operate on a userland UFS disk structure, and perform the read @@ -44,7 +71,7 @@ .Fn bread and .Fn bwrite -functions return the amount 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 @@ -52,7 +79,7 @@ may fail and set .Va errno for any of the errors specified for the library functions -.Xr ufs_disk_write +.Xr ufs_disk_write 3 or .Xr pread 2 . Additionally, it may follow the Index: lib/libufs/cgread.3 =================================================================== RCS file: /u/cvs/cvs/src/lib/libufs/cgread.3,v retrieving revision 1.1 diff -u -r1.1 cgread.3 --- lib/libufs/cgread.3 9 Jun 2003 09:59:11 -0000 1.1 +++ lib/libufs/cgread.3 10 Jun 2003 14:37:36 -0000 @@ -1,3 +1,30 @@ +.\" Copyright (c) 2003 Juli Mallett +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The names of the authors may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" .\" Author: Juli Mallett <jmallett@FreeBSD.org> .\" Date: June 04, 2003 .\" Description: @@ -44,7 +71,7 @@ field of a userland UFS disk structure. It sets the .Fa d_lcg -field to the cylinger group number +field to the cylinder group number .Fa c . .Pp The Index: lib/libufs/libufs.3 =================================================================== RCS file: /u/cvs/cvs/src/lib/libufs/libufs.3,v retrieving revision 1.1 diff -u -r1.1 libufs.3 --- lib/libufs/libufs.3 9 Jun 2003 09:59:11 -0000 1.1 +++ lib/libufs/libufs.3 10 Jun 2003 14:37:36 -0000 @@ -1,3 +1,30 @@ +.\" Copyright (c) 2003 Juli Mallett +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The names of the authors may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" .\" Author: Juli Mallett <jmallett@FreeBSD.org> .\" Date: June 04, 2003 .\" Description: @@ -6,11 +33,11 @@ .\" $FreeBSD: src/lib/libufs/libufs.3,v 1.1 2003/06/09 09:59:11 jmallett Exp $ .\" .Dd June 04, 2003 -.Dt SBREAD 3 +.Dt LIBUFS 3 .Os .Sh NAME .Nm libufs -.Nd operate on UFS disks from userland +.Nd operate on UFS filesystems from userland .Sh LIBRARY .Lb libufs .Sh SYNOPSIS @@ -33,7 +60,7 @@ .Xr dumpfs 8 . The .Nm -library is designed to be simple, and provide functions that are +library is designed to be simple, and to provide functions that are traditionally useful to have. .Pp A disk is represented as the type @@ -48,14 +75,14 @@ return -1 in every functional error situation. They also set the .Fa d_error -field to a string describing the error. +field of +.Dq struct uufsd +to a string describing the error. .Sh SEE ALSO .Xr bread 3 , .Xr bwrite 3 , .Xr cgread 3 , .Xr cgread1 3 , -.Xr getino 3 , -.Xr putino 3 , .Xr sbread 3 , .Xr sbwrite 3 , .Xr ufs_disk_close 3 , Index: lib/libufs/sbread.3 =================================================================== RCS file: /u/cvs/cvs/src/lib/libufs/sbread.3,v retrieving revision 1.1 diff -u -r1.1 sbread.3 --- lib/libufs/sbread.3 9 Jun 2003 09:59:11 -0000 1.1 +++ lib/libufs/sbread.3 10 Jun 2003 14:37:36 -0000 @@ -1,3 +1,30 @@ +.\" Copyright (c) 2003 Juli Mallett +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The names of the authors may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" .\" Author: Juli Mallett <jmallett@FreeBSD.org> .\" Date: June 04, 2003 .\" Description: Index: lib/libufs/ufs_disk_close.3 =================================================================== RCS file: /u/cvs/cvs/src/lib/libufs/ufs_disk_close.3,v retrieving revision 1.1 diff -u -r1.1 ufs_disk_close.3 --- lib/libufs/ufs_disk_close.3 9 Jun 2003 09:59:11 -0000 1.1 +++ lib/libufs/ufs_disk_close.3 10 Jun 2003 14:37:37 -0000 @@ -1,3 +1,30 @@ +.\" Copyright (c) 2003 Juli Mallett +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The names of the authors may not be used to endorse or promote +.\" products derived from this software without specific prior written +.\" permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" .\" Author: Juli Mallett <jmallett@FreeBSD.org> .\" Date: June 04, 2003 .\" Description: @@ -82,7 +109,7 @@ .Va errno for any of the errors specified for the library functions .Xr open 2 , -.Xr strdup 3 +.Xr strdup 3 . Additionally, it may follow the .Xr libufs 3 error methodologies in situations where no device could be found to --- libufs.diff ends here --- >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200306101442.h5AEgOam001759>