tAdd README file - cdb - Constant database manipulation utility
(HTM) git clone git://git.z3bra.org/cdb.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit 163f98f115615d0fd57bb8d0a0b225beac3b4526
(DIR) parent 5f651bd60445ff4315d4a0f7efb5bb3e58ddec0f
(HTM) Author: Willy Goiffon <dev@z3bra.org>
Date: Wed, 31 Aug 2022 22:49:29 +0200
Add README file
Diffstat:
A README | 40 +++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+), 0 deletions(-)
---
(DIR) diff --git a/README b/README
t@@ -0,0 +1,40 @@
+cdb
+===
+Utility to create and manipulate constant databases.
+
+Constant databases acts as an on-disk key/value map providing very fast
+and reliable lookups.
+
+More informations on [djb's website][0].
+
+Features
+-----
+- Create a new cdb from encoded records
+- Dump existing cdb as encoded records
+- Query a key to retrieve its value(s)
+
+Usage
+-----
+Refer to cdb(1) manual page for details and examples. The below commands
+are provided as a quick introduction.
+
+Create and query a constant database
+
+ cat <<EOF | cdb -m file.cdb
+ +3,5:one->Hello
+ +3,7:two->Goodbye
+ EOF
+
+ cdb -k one file.cdb
+ Hello
+
+For more infomations about the input format, see cdb(5).
+
+Installation
+-----
+Edit config.mk as needed, then build/install with the following commands:
+
+ mk
+ mk install
+
+[0]: http://cr.yp.to/cdb.html