including openisis 0.9.0 into webpac tree

[webpac] / openisis / doc / Builtin.txt

diff --git a/openisis/doc/Builtin.txt b/openisis/doc/Builtin.txt
new file mode 100644 (file)
index 0000000..d694c4c
--- /dev/null
+++ b/openisis/doc/Builtin.txt
@@ -0,0 +1,57 @@
+overview of OpenIsis builtin metadata
+
+*      system parameters
+
+This FDT includes the fields specified for the
+>      Syspar  SYSPAR.PAR
+file, augmented by system related (process wide) parameters
+for the OpenIsis tools in the 700 range.
+
+
+system (schema 0) parameters
+| tag | C-name | name | description
+| 5   | SPATH  | syspath | base for relative paths
+| 700 | SLOGF  | logfile | name of logfile
+| 701 | SLOGV  | v | loglevel: off, fatal, syserr, error, warn, info, verbose, trace, debug, all
+
+
+schema parameters
+| tag | C-name    | name | description
+| 710 | SC_NAME   | name | name of schema
+| 711 | SC_HOST   | host | hostname of server
+| 712 | SC_PORT   | port | port of server
+| 721 | SC_DFLTDB | defaultdb | dbname to send by default with requests
+
+
+*      database parameters
+
+These are the fields specified for the
+>      Syspar  dbname.PAR and .EXP
+files, augmented by per database parameters for OpenIsis in the 800s.
+
+This also includes the metadata fields
+-      worksheets
+-      formats
+-      selections
+-      field
+specified in the
+>      Meta    FDT
+although in OpenIsis, databases and FDTs do not need
+to have a strict one-to-one relation (but typically have).
+
+
+*      the internal request, query and formatting language
+
+This contains the whole story of transforming one record into another.
+All field ids are five digit (greater than 9999),
+and structure tags are greater than 16383.
+
+
+*      the other protocols language
+
+This FDT will contain a collection of commonly used headers
+from SMTP, NNTP, HTTP and similar stuff.
+
+
+---
+       $Id: Builtin.txt,v 1.2 2003/06/02 17:18:34 kripke Exp $