FileList 3.7 KB
Newer Older
Per Cederqvist's avatar
.  
Per Cederqvist committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
(Hey, Emacs, this is a -*- Indented-text -*- file!)

*  ansi-include/
   Directory containing ANSI-fied header files for the standard
   libraries.


*  ChangeLog
   Log file where the progressing work and changes are sporadically
   documented.  You are encouraged to add an entry in this file
   whenever you change something in this directory.


*  client/
   Directory containing a TTY-based client for LysKOM, very similar to
   the original KOM program from QZ.


*  config.h
   Configuration parameters for compiling.  Contains among other
   things all the stupid limits you really want to be without, all the
   smart limits that has to be there to make it impossible to crash
   the server, and lots of constants and configuration options.


*  debug.h
   Some #defines for debugging purposes.


*  doc/
   Documentation of LysKOM; both internal and external.  Also some
   random thoughts members of the development team wanted to write
   down during development.


*  FileList
   This file, describing all the files.


*  kom-errno.c
   Defines the variable 'kom_errno' and the function 'kom_perror()'.
   Used for error handling in LysKOM.


*  kom-errno.h
   Defines the type 'Kom_err' and declares the variable 'kom_errno'.
   The server sets the value of 'kom_errno' when an error occurs.
   The function 'kom_perror()' is declared.


*  kom-types.h
   Declares the types used by LysKOM.  Here are the types that are
   common to both the server and the client.  Types that look
   different to the server and the client, are found in
   'server/server-types.h' and 'client/client-types.h' respectively.


*  ldb/
   Directory containing the low-level database routines for the LysKOM
   server.  'ldb' stands for Lyskom DataBase.


*  List-Files
   Shell script to list the files in this directory not documented in
   the file 'FileList' (the one you are reading now).


*  Mailinglist
   List of mail addresses of people who want to be informed of the
   progress of LysKOM.


*  Makefile
   Exactly what the name says.


*  misc-types.h
   Miscellaneous types and constants that are useful in many places in
   LysKOM, but are not very LysKOM-specific.


*  s-collat-tables.c
   Collating tables used for the 's_usr_strcmp()' and
   's_usr_strhead()' functions in 's-string.h'


*  s-collat-tables.h
   Header file for 's-collat-tables.c'


*  s-string.c
   Routines for manipulating objects of type String as defined in
   's-string.h'


*  s-string.h
   Header file for 's-string.c'
   Definies our own string type 'String', and declares the functions
   in 's-string.c'


*  server/
   Directory containing the LysKOM server, except for the low-level
   database routines, which for historical reasons are in the separate
   directory 'ldb/'.


*  services.h
   Declares all the services available from the LysKOM server.


*  Summarize-Headers
   Since we write our .h files with documentation in line, they
   tend to get rather long, and it gets somewhat difficult to get
   a quick overview of what functions are declared in the file.
   This script cuts out all the "unnecessary" information: all
   comments and all preprocessor lines (starting with #).


*  TAGS
   Tags table for use with Emacs.


*  Template
   Template for automatically generating 'Makefile'.  'Makefile' is
   updated with the command 'make depend'.  This should be given
   whenever a change to 'Template' is done, or any new files are
   added, or any dependecies are changed.  Dependencies for normal C
   files are generated automatically by this.
   If 'Makefile' should become garbled, copy 'Template' to 'Makefile'
   and do a 'make depend'.


*  test-services/
   Directory containing programs to test parts of the server.  Used by
   ceder, and should not be distributed.