[src/trunk]: src/lib/libc/db/man Convert to mdoc.

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/1fb3d8d5f081
branches:  trunk
changeset: 545916:1fb3d8d5f081
user:      wiz <wiz%NetBSD.org@localhost>
date:      Thu Apr 17 19:48:37 2003 +0000

description:
Convert to mdoc.

diffstat:

 lib/libc/db/man/recno.3 |  224 ++++++++++++++++++++++++------------------------
 1 files changed, 112 insertions(+), 112 deletions(-)

diffs (truncated from 306 to 300 lines):

diff -r 7ad9f943245d -r 1fb3d8d5f081 lib/libc/db/man/recno.3
--- a/lib/libc/db/man/recno.3   Thu Apr 17 19:35:03 2003 +0000
+++ b/lib/libc/db/man/recno.3   Thu Apr 17 19:48:37 2003 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: recno.3,v 1.7 2002/02/07 07:00:10 ross Exp $
+.\"    $NetBSD: recno.3,v 1.8 2003/04/17 19:48:37 wiz Exp $
 .\"
 .\" Copyright (c) 1990, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -33,26 +33,24 @@
 .\"
 .\"    @(#)recno.3     8.5 (Berkeley) 8/18/94
 .\"
-.TH RECNO 3 "August 18, 1994"
-.UC 7
-.SH NAME
-recno \- record number database access method
-.SH SYNOPSIS
-.nf
-.ft B
-#include \*[Lt]sys/types.h\*[Gt]
-#include \*[Lt]db.h\*[Gt]
-.ft R
-.fi
-.SH DESCRIPTION
+.Dd April 17, 2003
+.Dt RECNO 3
+.Os
+.Sh NAME
+.Nm recno
+.Nd record number database access method
+.Sh SYNOPSIS
+.In sys/types.h
+.In db.h
+.Sh DESCRIPTION
 The routine
-.IR dbopen
+.Fn dbopen
 is the library interface to database files.
 One of the supported file formats is record number files.
 The general description of the database access methods is in
-.IR dbopen (3),
+.Xr dbopen 3 ,
 this manual page describes only the recno specific information.
-.PP
+.Pp
 The record number data structure is either variable or fixed-length
 records stored in a flat-file format, accessed by the logical record
 number.
@@ -61,158 +59,160 @@
 record number five to be renumbered to record number four, as well
 as the cursor, if positioned after record number one, to shift down
 one record.
-.PP
+.Pp
 The recno access method specific data structure provided to
-.I dbopen
-is defined in the \*[Lt]db.h\*[Gt] include file as follows:
-.PP
+.Fn dbopen
+is defined in the
+.Aq Pa db.h
+include file as follows:
+.Bd -literal
 typedef struct {
-.RS
-u_long flags;
-.br
-u_int cachesize;
-.br
-u_int psize;
-.br
-int lorder;
-.br
-size_t reclen;
-.br
-u_char bval;
-.br
-char *bfname;
-.RE
+       u_long flags;
+       u_int cachesize;
+       u_int psize;
+       int lorder;
+       size_t reclen;
+       u_char bval;
+       char *bfname;
 } RECNOINFO;
-.PP
+.Ed
+.Pp
 The elements of this structure are defined as follows:
-.TP
-flags
-The flag value is specified by
-.IR or 'ing
-any of the following values:
-.RS
-.TP
-R_FIXEDLEN
+.Bl -tag -width cachesizex
+.It Fa flags
+The flag value is specified by or'ing any of the following values:
+.Bl -tag -width R_FIXEDLENX -offset indent
+.It Dv R_FIXEDLEN
 The records are fixed-length, not byte delimited.
 The structure element
-.I reclen
+.Fa reclen
 specifies the length of the record, and the structure element
-.I bval
+.Fa bval
 is used as the pad character.
 Any records, inserted into the database, that are less than
-.I reclen
+.Fa reclen
 bytes long are automatically padded.
-.TP
-R_NOKEY
+.It Dv R_NOKEY
 In the interface specified by
-.IR dbopen ,
+.Fn dbopen ,
 the sequential record retrieval fills in both the caller's key and
 data structures.
-If the R_NOKEY flag is specified, the
-.I cursor
-routines are not required to fill in the key structure.
-This permits applications to retrieve records at the end of files without
-reading all of the intervening records.
-.TP
-R_SNAPSHOT
+If the
+.Dv R_NOKEY
+flag is specified, the cursor routines are not required to fill in the
+key structure.
+This permits applications to retrieve records at the end of files
+without reading all of the intervening records.
+.It Dv R_SNAPSHOT
 This flag requires that a snapshot of the file be taken when
-.I dbopen
-is called, instead of permitting any unmodified records to be read from
-the original file.
-.RE
-.TP
-cachesize
+.Fn dbopen
+is called, instead of permitting any unmodified records to be read
+from the original file.
+.El
+.It Fa cachesize
 A suggested maximum size, in bytes, of the memory cache.
 This value is
-.B only
-advisory, and the access method will allocate more memory rather than fail.
+.Em only
+advisory, and the access method will allocate more memory rather than
+fail.
 If
-.I cachesize
-is  0 (no size is specified) a default cache is used.
-.TP
-psize
+.Fa cachesize
+is 0 (no size is specified) a default cache is used.
+.It Fa psize
 The recno access method stores the in-memory copies of its records
 in a btree.
-This value is the size (in bytes) of the pages used for nodes in that tree.
+This value is the size (in bytes) of the pages used for nodes in that
+tree.
 If
-.I psize
+.Fa psize
 is 0 (no page size is specified) a page size is chosen based on the
 underlying file system I/O block size.
 See
-.IR btree (3)
+.Xr btree 3
 for more information.
-.TP
-lorder
+.It Fa lorder
 The byte order for integers in the stored database metadata.
 The number should represent the order as an integer; for example,
 big endian order would be the number 4,321.
 If
-.I lorder
+.Fa lorder
 is 0 (no order is specified) the current host order is used.
-.TP
-reclen
+.It Fa reclen
 The length of a fixed-length record.
-.TP
-bval
+.It Fa bval
 The delimiting byte to be used to mark the end of a record for
 variable-length records, and the pad character for fixed-length
 records.
-If no value is specified, newlines (``\en'') are used to mark the end
-of variable-length records and fixed-length records are padded with
-spaces.
-.TP
-bfname
+If no value is specified, newlines
+.Pq Dq \en
+are used to mark the end of variable-length records and fixed-length
+records are padded with spaces.
+.It Fa bfname
 The recno access method stores the in-memory copies of its records
 in a btree.
-If bfname is non-NULL, it specifies the name of the btree file,
-as if specified as the file name for a dbopen of a btree file.
-.PP
+If bfname is
+.No non- Ns Dv NULL ,
+it specifies the name of the btree file, as if specified as the file
+name for a
+.Fn dbopen
+of a btree file.
+.El
+.Pp
 The data part of the key/data pair used by the recno access method
 is the same as other access methods.
 The key is different.
 The
-.I data
+.Fa data
 field of the key should be a pointer to a memory location of type
-.IR recno_t ,
-as defined in the \*[Lt]db.h\*[Gt] include file.
+recno_t, as defined in the
+.Aq Pa db.h
+include file.
 This type is normally the largest unsigned integral type available to
 the implementation.
 The
-.I size
+.Fa size
 field of the key should be the size of that type.
-.PP
+.Pp
 Because there can be no meta-data associated with the underlying
 recno access method files, any changes made to the default values
-(e.g. fixed record length or byte separator value) must be explicitly
+(e.g., fixed record length or byte separator value) must be explicitly
 specified each time the file is opened.
-.PP
+.Pp
 In the interface specified by
-.IR dbopen ,
+.Fn dbopen ,
 using the
-.I put
+.Fa put
 interface to create a new record will cause the creation of multiple,
 empty records if the record number is more than one greater than the
 largest record currently in the database.
-.SH ERRORS
+.Sh ERRORS
 The
-.I recno
+.Nm
 access method routines may fail and set
-.I errno
+.Va errno
 for any of the errors specified for the library routine
-.IR dbopen (3)
+.Xr dbopen 3
 or the following:
-.TP
-[EINVAL]
+.Bl -tag -width Er
+.It Er EINVAL
 An attempt was made to add a record to a fixed-length database that
 was too large to fit.
-.SH "SEE ALSO"
-.IR btree (3),
-.IR dbopen (3),
-.IR hash (3),
-.IR mpool (3)
-.sp
-.IR "Document Processing in a Relational Database System" ,
-Michael Stonebraker, Heidi Stettner, Joseph Kalash, Antonin Guttman,
-Nadene Lynn, Memorandum No. UCB/ERL M82/32, May 1982.
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr btree 3 ,
+.Xr dbopen 3 ,
+.Xr hash 3 ,
+.Xr mpool 3
+.Pp
+.Rs
+.%T "Document Processing in a Relational Database System"
+.%A Michael Stonebraker
+.%A Heidi Stettner
+.%A Joseph Kalash
+.%A Antonin Guttman