Non-Volatile Memory Library

This is doc/README.

This directory contains source for the man pages for the NVM Library.
If you're looking for documentation to get you started using NVML,
start here: http://pmem.io/nvml and follow the links to examples and
man pages.  Developers new to NVML are probably looking for libpmemobj.
To generate web-based documentation, you need to have groff and doxygen
installed.

All files in the *generated* directory are automatically generated and updated by the
nvml-bot. **DO NOT MODIFY THE FILES IN THAT DIRECTORY**. All changes to the
documentation are to be made by modifying the \*.md files in the main doc
directory.

libpmem(3) -- low-level persistent memory support
    Man page source is in: libpmem.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/libpmem.3.html

libpmemblk(3) -- pmem-resident arrays of blocks
    Man page source is in: libpmemblk.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/libpmemblk.3.html

libpmemlog(3) -- pmem-resident log files
    Man page source is in: libpmemlog.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/libpmemlog.3.html

libpmemobj(3) -- transactional object store
    Man page source is in: libpmemobj.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/libpmemobj.3.html

libvmem(3) -- volatile memory allocation library
    Man page source is in libvmem.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/libvmem.3.html

libvmmalloc(3) -- general purpose volatile memory allocation library
    Man page source is in libvmmalloc.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/libvmmalloc.3.html

libpmempool(3) -- persistent memory pool management library
    Man page source is in libpmempool.3.md
    HTML formatted version: http://pmem.io/nvml/libpmempool/libpmempool.3.html

pmempool(1) -- Persistent Memory Pool Management Tool
    Man page source is in pmempool.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool.1.html

pmempool-info(1) -- Print basic information about Persistent Memory Pool file
    Man page source is in pmempool-info.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-info.1.html

pmempool-check(1) -- Check and repair Persistent Memory Pool
    Man page source is in pmempool-check.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-check.1.html

pmempool-create(1) -- Create Persistent Memory Pool of specified type
    Man page source is in pmempool-create.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-create.1.html

pmempool-dump(1) -- Dump user data from specified pool
    Man page source is in pmempool-dump.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-dump.1.html

pmempool-rm(1) -- Remove pool file or pool files from poolset
    Man page source is in pmempool-rm.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-rm.1.html

pmempool-convert(1) -- Update the pool to the latest available layout version
    Man page source is in pmempool-convert.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-convert.1.html

pmempool-sync(1) -- Synchronize data between replicas within a poolset
    Man page source is in pmempool-sync.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-sync.1.html

pmempool-transform(1) -- Modify internal structure of a poolset
    Man page source is in pmempool-transform.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/pmempool-transform.1.html

These man pages provide the API specification for the corresponding libraries
in this source tree, so any updates to one should be tested, reviewed, and
committed with changes to the other.

The following two files are initial man pages for experimental components
still under development:

librpmem(3) -- remote access to persistent memory
    Man page source is in librmpem.3.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/librpmem.3.html

rpmemd(1) -- remote persistent memory daemon
    Man page source is in rpmemd.1.md
    HTML formatted version: http://pmem.io/nvml/manpages/master/rpmemd.1.html

To create more readable text files from the source, use:
	$ make
An even more convenient way to read these is to use the "man" command to
format them (includes bold, underline, etc. when run in a terminal window):
	$ man -l libpmem.3
	$ man -l libvmem.3
