nmdb/nmdb.1

   1 .TH nmdb 1 "11/Sep/2006"
   2 .SH NAME
   3 nmdb - A multiprotocol network database manager
   4 .SH SYNOPSIS
   5 nmdb [-d dbpath] [-l lower] [-L upper]
   6   [-t tcpport] [-T tcpaddr]
   7   [-u udpport] [-U udpaddr]
   8   [-s sctpport] [-S sctpaddr]
   9   [-c nobj] [-o fname] [-f] [-p] [-h]
  10
  11 .SH DESCRIPTION
  12
  13 nmdb is a network database that can use different protocols to communicate
  14 with its clients. At the moment, it supports TIPC, TCP, UDP and SCTP.
  15
  16 It can also be used as a generic caching system (pretty much like memcached),
  17 because it has a very fast cache that can be used without impacting on the
  18 database.
  19
  20 The database is accessed with the
  21 .BR libnmdb (3)
  22 library. Consult its manual page for programming information. Python bindings
  23 are also available.
  24
  25 For additional documentation, go to the project's website at
  26 .IR http://blitiri.com.ar/p/nmdb .
  27
  28 .SH OPTIONS
  29 .TP
  30 .B "-d dbpath"
  31 Indicate the path to the database file to use. It will be created if it
  32 doesn't exist. If a name is not provided, "database" will be used.
  33 .TP
  34 .B "-l lower"
  35 Lower TIPC port number to bind to. Defaults to 10. It's useful if you want to
  36 run more than one nmdb instance in the same TIPC cluster.
  37 .TP
  38 .B "-L upper"
  39 Upper TIPC port number to bind to. Defaults to the same value
  40 .B lower
  41 is defined. Useful mainly for passive mode.
  42 .TP
  43 .B "-t tcpport"
  44 TCP listening port. Defaults to 26010.
  45 .TP
  46 .B "-T tcpaddr"
  47 IP listening address for TCP. Defaults to all local addresses.
  48 .TP
  49 .B "-u udpport"
  50 UDP listening port. Defaults to 26010.
  51 .TP
  52 .B "-U udpaddr"
  53 IP listening address for UDP. Defaults to all local addresses.
  54 .TP
  55 .B "-s sctpport"
  56 SCTP listening port. Defaults to 26010.
  57 .TP
  58 .B "-S sctpaddr"
  59 IP listening address for SCTP. Defaults to all local addresses.
  60 .TP
  61 .B "-c nobj"
  62 Sets the maximum number of objects the cache will held, in thousands. Note
  63 that the size of the memory used by the cache layer depends on the size of the
  64 object exclusively. It defaults to 128, so the default cache size has space to
  65 hold 128 thousand objects.
  66 .TP
  67 .B "-o fname"
  68 Enable logging into the given file name. By default, output the debugging
  69 information to stdout.
  70 .TP
  71 .B "-f"
  72 Stay in the foreground, don't fork. Useful for debugging. The default is to
  73 fork.
  74 .TP
  75 .B "-p"
  76 Enable passive mode, where the server never replies requests, but acts upon
  77 them. It's useful when you want to have a live database mirror, in case the
  78 main node fails. It still requires a manual restart to became active, but at
  79 least you have a recent up-to-date database. Be aware that it's not widely
  80 tested (although it should work fine), and do
  81 .I not
  82 start an active and a passive server in the same machine (it misbehaves under
  83 some circumstances, and doesn't make much sense anyway).
  84 .TP
  85 .B "-h"
  86 Show a brief help.
  87
  88 .SH INVOCATION EXAMPLE
  89 To run the server with the database at /var/lib/nmdb-db:
  90 .B "nmdb -d /var/lib/nmdb-db"
  91
  92 Be
  93 .I very
  94 careful not to start more than one nmdb instance on the same port at the same
  95 time, even if it's on different machines. TIPC allows you to bind the same
  96 port many times (and it's a very good feature), and all of them will get the
  97 messages, which will result in several answers, which will confuse the
  98 clients. This behaviour is different from the normal IP networking, where you
  99 can't bind a port twice.
 100
 101 .SH SEE ALSO
 102 .BR libnmdb (3),
 103 .B TIPC
 104 (http://tipc.sf.net),
 105 .BR qdbm (3).
 106
 107 .SH AUTHORS
 108 Created by Alberto Bertogli (albertito@blitiri.com.ar).
 109
 110 .SH CONTACT
 111
 112 If you want to report bugs, or have any questions or comments, just let me
 113 know at albertito@blitiri.com.ar.
 114