Commit 07d50db6 authored by Per Cederqvist's avatar Per Cederqvist

Document the file types and file object types that lyskomd uses.

* doc/lyskomd.texi (File Object Types): New node.
(File Types): New node.
parent 4feb7de9
2009-05-31 Per Cederqvist <ceder@lysator.liu.se>
Document the file types and file object types that lyskomd uses.
* doc/lyskomd.texi (File Object Types): New node.
(File Types): New node.
Fix menus in documentation.
* doc/lyskomd.texi (Hacking): Fill in descriptions in the menu.
......
......@@ -1762,6 +1762,8 @@ information on how to restore the database.
@menu
* The Database:: How metadata is stored.
* File Object Types:: Index of type codes in files.
* File Types:: Index of magic cookies in files.
* Adding Configuration Parameters:: How to add configuration options.
* Adding Asynchronous Messages:: Adding protocol A messages.
* Adding a New Protocol Request:: Adding protocol A calls.
......@@ -2007,6 +2009,60 @@ starting lyskomd again. You must do this periodically (as explained
in @pxref{Administration}), or the text file will keep growing
forever.
@node File Object Types
@section File Object Types
Here is a summary of all the object types used in various database
files. The table is sorted alphabetically. While most object types
are single-character types, there are a few exceptions.
@table @samp
@item #C
The number of conferences in the database file.
@xref{lyskomd Database Specification}.
@item #T
The number of texts in the database file.
@xref{lyskomd Database Specification}.
@item C
A conference.
@xref{lyskomd Database Specification}.
@item I
An info structure.
@xref{lyskomd Database Specification}.
@xref{(protocol-a)Server Information, Info}, for the datafile
version.
@item P
A person.
@xref{lyskomd Database Specification}.
@item T
A text status.
@xref{lyskomd Database Specification}.
@end table
@node File Types
@section File Types
Here is a summary of the magic markers used in file headers by
lyskomd. The table is sorted alphabetically.
@table @samp
@item CLEAN
A complete database file.
@xref{lyskomd Database Specification}.
@item DIRTY
An incomplete database file.
@xref{lyskomd Database Specification}.
@end table
@node Adding Configuration Parameters
@section Adding Configuration Parameters
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment