diff options
author | Todd C. Miller <millert@cvs.openbsd.org> | 1999-02-26 06:54:51 +0000 |
---|---|---|
committer | Todd C. Miller <millert@cvs.openbsd.org> | 1999-02-26 06:54:51 +0000 |
commit | 7ba0ec3d87e967c7ff34618d5b357791ff3dccb9 (patch) | |
tree | a71f8cab29ef75911c9c971d42dd13ffef4a95f5 /lib/libc | |
parent | cb786aab9af937db151ef3dc1d44d3953a0dd2e7 (diff) |
.Ar -> .Fa and NULL is Dv
Diffstat (limited to 'lib/libc')
-rw-r--r-- | lib/libc/db/man/mpool.3 | 45 |
1 files changed, 24 insertions, 21 deletions
diff --git a/lib/libc/db/man/mpool.3 b/lib/libc/db/man/mpool.3 index 7797196b039..7f426b66b0c 100644 --- a/lib/libc/db/man/mpool.3 +++ b/lib/libc/db/man/mpool.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mpool.3,v 1.2 1999/02/26 01:20:41 millert Exp $ +.\" $OpenBSD: mpool.3,v 1.3 1999/02/26 06:54:50 millert Exp $ .\" .\" Copyright (c) 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -68,28 +68,30 @@ The function .Fn mpool_open initializes a memory pool. The -.Ar key +.Fa key argument is the byte string used to negotiate between multiple processes wishing to share buffers. If the file buffers are mapped in shared memory, all processes using the same key will share the buffers. If -.Ar key -is NULL, the buffers are mapped into private memory. +.Fa key +is +.Dv NULL , +the buffers are mapped into private memory. The -.Ar fd +.Fa fd argument is a file descriptor for the underlying file, which must be seekable. If -.Ar key +.Fa key is non-NULL and matches a file already being mapped, the -.Ar fd +.Fa fd argument is ignored. .Pp The -.Ar pagesize +.Fa pagesize argument is the size, in bytes, of the pages into which the file is broken up. The -.Ar maxcache +.Fa maxcache argument is the maximum number of pages from the underlying file to cache at any one time. This value is not relative to the number of processes which share a file's @@ -101,15 +103,15 @@ The function is intended to make transparent input and output processing of the pages possible. If the -.Ar pgin +.Fa pgin function is specified, it is called each time a buffer is read into the memory pool from the backing file. If the -.Ar pgout +.Fa pgout function is specified, it is called each time a buffer is written into the backing file. Both functions are are called with the -.Ar pgcookie +.Fa pgcookie pointer, the page number and a pointer to the page to being read or written. .Pp The function @@ -117,10 +119,11 @@ The function takes an MPOOL pointer, an address, and a set of flags as arguments. If a new page can be allocated, a pointer to the page is returned and the page number is stored into the -.Ar pgnoaddr +.Fa pgnoaddr address. -Otherwise, NULL is returned and errno is set. -The flags value is formed by +Otherwise, +.Dv NULL +is returned and errno is set. The flags value is formed by .Em or Ns 'ing the following values: .Bl -tag -width Ds @@ -139,16 +142,16 @@ generated by .Pp The function .Fn mpool_get -takes an MPOOL pointer and a page number as arguments. -If the page exists, a pointer to the page is returned. -Otherwise, NULL is returned and errno is set. -The flags parameter is not currently used. +takes an MPOOL pointer and a page number as arguments. If the page +exists, a pointer to the page is returned. Otherwise, +.Dv NULL +is returned and errno is set. The flags parameter is not currently used. .Pp The function .Fn mpool_put unpins the page referenced by -.Ar pgaddr . -.Ar Pgaddr +.Fa pgaddr . +.Fa Pgaddr must be an address previously returned by .Fn mpool_get or |