summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2001-10-26 02:39:45 (GMT)
committerH. Peter Anvin <hpa@zytor.com>2001-10-26 02:39:45 (GMT)
commitd259839a66ea956f9752ce92082fa264d9ab3f3e (patch)
tree41919fbed23ee44b8fa4267ce3dcc5c1f3dfdc58
parentd5cfcf4d16630bd5961157fb66f6a9d9d288c063 (diff)
downloadlpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.zip
lpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.tar.gz
lpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.tar.bz2
lpsm-d259839a66ea956f9752ce92082fa264d9ab3f3e.tar.xz
Remove stuff from README that is now in lpsm(7), add stuff from
README that belong in lpsm(7) into the latter.
-rw-r--r--README47
-rw-r--r--lpsm.7.in29
2 files changed, 30 insertions, 46 deletions
diff --git a/README b/README
index 008b208..5e97688 100644
--- a/README
+++ b/README
@@ -35,49 +35,4 @@ IMPORTANT: I cannot at this stage guarantee that future versions of
the LPSM will be binary compatible. These are test releases. Use at
your own risk.
-LPSM DATABASES ARE NOT PORTABLE. This is pretty much inherent in the
-fact that the LPSM library does not attach any meaning to the data it
-stores. Therefore it is imperative that your application allows a way
-to dump its database contents in a portable form.
-
-Currently the persistent memory database is not sharable nor
-thread-safe. I'm hoping to resolve at least the latter condition in
-due time.
-
-Because the persistent memory is mapped into memory at a fixed address
-(which varies with architecture) it is not possible to have more than
-one LPSM database mapped at any one time.
-
-
-** Functionality description:
-
-The persistent memory store can be used in two modes: managed and
-unmanaged. Unmanaged provides a flat chunk (arena) of memory without
-any further management support; managed provides management via
-malloc/free/realloc.
-
-All of these use a pair of files as backing store: a datafile, which
-is equivalent in size to the managed memory, and a logfile, which is
-used for the commit log.
-
-The LPSM library installs a signal handler for SIGSEGV.
-
-Please see the following man pages included with this distribution:
-
-Unmanaged mode:
-
- lpsm_arena_init(3)
- lpsm_checkpoint(3)
- lpsm_extend(3)
- lpsm_shutdown(3)
- lpsm_recover(3)
-
-Managed mode:
-
- lpsm_init(3)
- lpsm_recover(3)
- lpsm_checkpoint(3)
- lpsm_shutdown(3)
- lpsm_malloc(3)
- lpsm_arena_stats(3)
- lpsm_recover(3)
+Please see the included man page lpsm(7) for usage details.
diff --git a/lpsm.7.in b/lpsm.7.in
index 683fa5e..c4749b0 100644
--- a/lpsm.7.in
+++ b/lpsm.7.in
@@ -101,6 +101,24 @@ is used to checkpoint the data store, and
to close. As with unmanaged mode,
.B lpsm_recover()
can be used to do offline log recovery.
+.SH "IMPORTANT NOTES"
+.B "LPSM databases are not portable."
+This is pretty much inherent in the fact that the LPSM library does
+not attach any meaning to the data it stores. Therefore it is
+imperative that your application allows a way to dump its database
+contents in a portable form.
+.PP
+Currently the persistent memory database is not sharable nor
+thread-safe. I'm hoping to resolve at least the latter condition in
+due time.
+.PP
+Because the persistent memory is mapped into memory at a fixed address
+(which varies with architecture) it is not possible to have more than
+one LPSM database mapped at any one time.
+.PP
+The LPSM library installs a handler for the
+.B SIGSEGV
+signal.
.SH "SEE ALSO"
.BR lpsm_init (3),
.BR lpsm_malloc (3),
@@ -112,3 +130,14 @@ can be used to do offline log recovery.
.BR lpsm_recover (3),
.BR mmap (2),
.BR malloc (3).
+.SH "VERSION"
+This man page is applicable as to version @@VERSION@@ of LPSM.
+.SH "AUTHOR"
+LPSM was written by H. Peter Anvin, <hpa@zytor.com>.
+.SH "COPYRIGHT AND LICENSE"
+\(co 2001 H. Peter Anvin \- All Rights Reserved
+.PP
+LPSM is free software; you can redistribute it and/or modify it under
+the terms of the GNU Lesser General Public License as published by the
+Free Software Foundation, Inc., 59 Temple Place Ste 330, Bostom MA
+02111-1307, USA; version 2.1, incorporated herein by reference.