[C-MPI-commits] SF.net SVN: c-mpi:[169] docs/manual/manual.txt

[<jmw...@us...>]

Revision: 169
          http://c-mpi.svn.sourceforge.net/c-mpi/?rev=169&view=rev
Author:   jmwozniak
Date:     2011-04-15 19:15:23 +0000 (Fri, 15 Apr 2011)

Log Message:
-----------
asciidoc version of manual complete

Modified Paths:
--------------
    docs/manual/manual.txt

Modified: docs/manual/manual.txt
===================================================================
--- docs/manual/manual.txt	2011-04-14 23:54:25 UTC (rev 168)
+++ docs/manual/manual.txt	2011-04-15 19:15:23 UTC (rev 169)
@@ -275,7 +275,8 @@
 ~~~~~~~~
 
 
-C-MPI is intended to be an easy to use MPI-based distributed key/value store.
+C-MPI is intended to be an easy to use MPI-based distributed key/value
+store.
 
 API
 ~~~
@@ -289,116 +290,110 @@
 
 +cmpi_put()+::
 
-Post a key/value pair in C-MPI.
+  Post a key/value pair in C-MPI.  Arguments:
 
-Arguments:
+  +char* key+;;
 
-+char* key+;;
+  +NULL+-terminated string key. Passed as the args argument to
+  +MPIRPC_Call_blob()+.
 
-+NULL+-terminated string key. Passed as the args argument to
-+MPIRPC_Call_blob()+.
+  +void* value+;;
 
-+void* value+;;
+  Variable-length user data. Passed as the blob argument to
+  +MPIRPC_Call_blob()+.
 
-Variable-length user data. Passed as the blob argument to
-+MPIRPC_Call_blob()+.
+  +int length+;;
 
-+int length+;;
+  Byte-length of value.
 
-Byte-length of value.
-
 +cmpi_update()+::
 
-Update the value of a key/value pair in C-MPI.
+  Update the value of a key/value pair in C-MPI.  Arguments:
 
-Arguments:
+  +char* key+;;
 
-+char* key+;;
+  +NULL+-terminated string key. Passed as the args argument to
+  MPIRPC_Call_blob().
 
-+NULL+-terminated string key. Passed as the args argument to MPIRPC_Call_blob().
+  +void* value+;;
 
-+void* value+;;
+  Variable-length user data. Passed as the blob argument to
+  +MPIRPC_Call_blob()+.
 
-Variable-length user data. Passed as the blob argument to MPIRPC_Call_blob().
+  +int length+;;
 
-+int length+;;
+  Byte-length of value.
 
-Byte-length of value.
+  +int offset+;;
 
-+int offset+;;
+  At which point to begin overwrite. Offset+length may exceed the
+  original value length. The key/value pair need not originally exist,
+  but if it does not, the offset must be 0.
 
-At which point to begin overwrite. Offset+length may exceed the
-original value length. The key/value pair need not originally exist,
-but if it does not, the offset must be 0.
 
 +cmpi_get()+::
 
-Extract the value of a key/value pair into fresh storage.
+  Extract the value of a key/value pair into fresh storage.
+  Arguments:
 
-Arguments:
+  +char* key+;;
 
-+char* key+;;
+  +NULL+-terminated string key. Passed as the args argument to
+  +MPIRPC_Call_blob()+.
 
-+NULL+-terminated string key. Passed as the args argument to MPIRPC_Call_blob().
+  +void** result+;;
 
-+void** result+;;
+  Will be set to the location of the extracted data in fresh storage.
 
-Will be set to the location of the extracted data in fresh storage.
+  +int* length+;;
 
-+int* length+;;
+  Will be set to the length of the extracted data.
 
-Will be set to the length of the extracted data.
-
 Configure, build, test
 ----------------------
 
 Configure
 ~~~~~~~~~
 
-. Run ./setup.sh.
+. Run +./setup.sh+.
 
-. Run ./configure.
+. Run +./configure+.
 
-+--with-mpi+::
+--with-mpi::
 
-Mandatory. The location of your MPICH installation. E.g., ${HOME}/sfw/mpich2-1.1.1p1-x86_64
+Mandatory. The location of your MPICH installation. E.g.,
++${HOME}/sfw/mpich2-1.1.1p1-x86_64+
 
 --enable-table-*::
 
-Mandatory. The underlying DHT algorithm. Current options:
+  Mandatory. The underlying DHT algorithm. Current options:
 
---enable-table-dense-1;;
+  --enable-table-dense-1;;
 
-Simple dense table defined in src/dense-1. Uses monolithic
-communicator. Hashes keys and assigns to nodes by modulus. Not really
-a DHT; doesn't need neighbor tables. Great for debugging, simple and
-fast.
+  Simple dense table defined in src/dense-1. Uses monolithic
+  communicator. Hashes keys and assigns to nodes by modulus. Not
+  really a DHT; doesn't need neighbor tables. Great for debugging,
+  simple and fast.
 
---enable-table-kda-2A;;
+  --enable-table-kda-2A;;
 
-Kademlia implementation defined in +src/kda-2+, linked with
-+src/kda-2/conn-A.c+. Uses monolithic communicator.
+  Kademlia implementation defined in +src/kda-2+, linked with
+  +src/kda-2/conn-A.c+. Uses monolithic communicator.
 
---enable-table-kda-2B;;
+  --enable-table-kda-2B;;
 
-Kademlia implementation defined in +src/kda-2+, linked with
-+src/kda-2/conn-B.c+. Uses MPI-2 dynamic processes.
+  Kademlia implementation defined in +src/kda-2+, linked with
+  +src/kda-2/conn-B.c+. Uses MPI-2 dynamic processes.
 
---enable-mode-*;;
+--enable-mode-*::
 
-The node layout scheme. (see <<cmpi-modes>>).
+  The node layout scheme. (see <<cmpi-modes>>).
 
---enable-mode-mono;;
+--enable-tests::
 
-The default.
-
---enable-mode-pairs
-
---enable-tests
-
 Turn on support for tests. When compiling tests, be sure to use make D=1.
 
---enable-cmpi-io
+--enable-cmpi-io::
 
 Turn on support for the skeletal CMPI-IO component.
 
@@ -419,10 +414,11 @@
 
 D=1::
 
-    Turn on debugging output. Mandatory for many tests.
+Turn on debugging output.  Mandatory for many tests.
+
 V=1::
 
-    Turn on verbose build output. Useful when debugging build process.
+Turn on verbose build output. Useful when debugging build process.
 
 -j::
 
@@ -495,34 +491,42 @@
 one node process and one client process, the client will only contact
 the local node.
 
-node.c
++node.c+::
 
-    Reusable C-MPI node.
+Reusable C-MPI node.  Generally, a C-MPI node is anything that calls
+into +cmpi_init()+.
 
-    Generally, a C-MPI node is anything that calls into cmpi_init().
-client.c
++client.c+::
++
+Reusable C-MPI client.
++
+Generally, a C-MPI client is anything that calls into
++cmpi_init_client()+. +client.c+ calls into cmpi_client_code(), which
+is a convenient way to reuse the setup routines in +client.c+. See the
+tests for use of +cmpi_client_code()+.
++
+Other clients could be built that do different things, such as provide
+filesystem interfaces.
++
 
-    Reusable C-MPI client.
++driver+::
 
-    Generally, a C-MPI client is anything that calls into cmpi_init_client(). client.c calls into cmpi_client_code(), which is a convenient way to reuse the setup routines in client.c. See the tests for use of cmpi_client_code().
+    Issue commands to a client over a stream interface.
 
-    Other clients could be built that do different things, such as provide filesystem interfaces.
-driver
++cmpi-db+::
 
-    Issue commands to a client over a stream interface.
-cmpi-db
+Instantiates several nodes and clients. The clients may be manipulated
+by a driver.
 
-    Instantiates several nodes and clients. The clients may be manipulated by a driver.
-cmpi-cp
++cmpi-cp+::
 
-    Acts as a "user" in the diagram above.
-adts
+Acts as a "user" in the diagram above.
 
-    Abstract data types: lists, hash tables, etc.
-gossip
++adts+::
 
-    A logging library from Phil Carns.
+Abstract data types: lists, hash tables, etc.
 
-8. Appendix
++gossip+;;
 
-Updated: Fri May 21 11:02:44 CDT 2010
+A logging library from Phil Carns.
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.