[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Sks-devel] where are the docs????
From: |
Robert Urban |
Subject: |
[Sks-devel] where are the docs???? |
Date: |
Sun, 12 Sep 2004 23:47:43 +0200 |
Hello,
so I seem to have gotten SKS compiled, using ocaml-3.07 and berkeley-db-4.1
(4.2 does NOT work).
I then start to look for documentation, as I know NOTHING about this
software. I look among the distribution files... there is a very *very*
thin README. I look on the project webpage.... nada. I look in the
sks-devel archives, and find references to a "wiki" on
documentation.penguin.de,
which, among other things, has a FAQ with 3 questions and answers.
The README sort-of explains how to build a database using a keydump,
but what about if I just want to start with an empty database? There
is no hint of how to do this. I tried "sks build", which seemed to
do something, and "sks db" ran afterwards, so I guess "build" was
the correct parameter...
What is the format of the config file? All I know is what is in the
readme, which is that there is a "logfile" keyword. What other keywords
exist? I guess I'll be poking around in the sources for the answer
to this question...
Random things that struck me as missing:
- no sample config file
- no sample init file with the distribution
(I know, there is one as part of a FAQ answer...)
behaviour that needs documenting:
- what command/parameters exist and what do they do
- what signals, if any, are caught and used (HUP?)
- what are error messages and their meanings
- what are the basic patterns of use? (i.e., examples of how
to do common tasks (such as creating a new, empty database...)).
I hope this won't be misunderstood: I appreciate the effort that
went into sks. It just seems a shame that there's no documentation...
cheers,
Robert Urban
- [Sks-devel] where are the docs????,
Robert Urban <=