git » nmdb » commit caf2db3

Minor documentation fixes

author Alberto Bertogli
2008-08-03 04:47:47 UTC
committer Alberto Bertogli
2008-08-03 04:47:47 UTC
parent 130ba0a7750dc3380652d3bfb8b57472aa4c8209

Minor documentation fixes

Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>

doc/guide.rst +5 -3
nmdb/main.c +3 -2
nmdb/nmdb.1 +5 -1

diff --git a/doc/guide.rst b/doc/guide.rst
index 65dfb26..12c18e8 100644
--- a/doc/guide.rst
+++ b/doc/guide.rst
@@ -42,10 +42,12 @@ Compiling and installing
 ------------------------
 
 There are three components of the nmdb tarball: the server in the *nmdb/*
-directory, the C library in *libnmdb/*, and the Python module in *python/*.
+directory, the C library in *libnmdb/*, and the Python module in
+*bindings/python/*.
 
 To install the server and the C library, run ``make install; ldconfig``. To
-install the Python module, run ``make python_install``.
+install the Python module, run ``make python_install`` after installing the C
+library.
 
 If you want to disable support for some protocol (i.e. TIPC), you can do so by
 running ``make ENABLE_TIPC=0 install``.
@@ -71,7 +73,7 @@ simple way to test it is to use the python module, like this::
   >>> db['x'] = 1               # store some data
   >>> db[(1, 2)] = (2, 6)
   >>> print db['x'], db[(1, 2)] # retreive the values
-  1 (3, 5)
+  1 (2, 6)
   >>> del db['x']               # delete from the database
 
 Everything should have worked as shown, and you are now ready to use some
diff --git a/nmdb/main.c b/nmdb/main.c
index 02ff3ca..a07ac62 100644
--- a/nmdb/main.c
+++ b/nmdb/main.c
@@ -27,7 +27,8 @@ struct queue *op_queue;
 static void help(void) {
 	char h[] = \
 	  "nmdb [options]\n"
-	  "  -d dbpath	database path ('database', must be created with dpmgr)\n"
+	  "\n"
+	  "  -d dbpath	database path ('database' by default)\n"
 	  "  -l lower	TIPC lower port number (10)\n"
 	  "  -L upper	TIPC upper port number (= lower)\n"
 	  "  -t port	TCP listening port (26010)\n"
@@ -37,7 +38,7 @@ static void help(void) {
 	  "  -s port	SCTP listening port (26010)\n"
 	  "  -S addr	SCTP listening address (all local addresses)\n"
 	  "  -c nobj	max. number of objects to be cached, in thousands (128)\n"
-	  "  -o fname	log to the given file (defaults to stdout).\n"
+	  "  -o fname	log to the given file (stdout).\n"
 	  "  -f		don't fork and stay in the foreground\n"
 	  "  -p		enable passive mode, for redundancy purposes (read docs.)\n"
 	  "  -h		show this help\n"
diff --git a/nmdb/nmdb.1 b/nmdb/nmdb.1
index 417f1b6..b7fffb2 100644
--- a/nmdb/nmdb.1
+++ b/nmdb/nmdb.1
@@ -6,7 +6,7 @@ nmdb [-d dbpath] [-l lower] [-L upper]
   [-t tcpport] [-T tcpaddr]
   [-u udpport] [-U udpaddr]
   [-s sctpport] [-S sctpaddr]
-  [-c nobj] [-f] [-p] [-h]
+  [-c nobj] [-o fname] [-f] [-p] [-h]
 
 .SH DESCRIPTION
 
@@ -64,6 +64,10 @@ that the size of the memory used by the cache layer depends on the size of the
 object exclusively. It defaults to 128, so the default cache size has space to
 hold 128 thousand objects.
 .TP
+.B "-o fname"
+Enable logging into the given file name. By default, output the debugging
+information to stdout.
+.TP
 .B "-f"
 Stay in the foreground, don't fork. Useful for debugging. The default is to
 fork.