X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=README;h=4a73ff81c0987865d17ac3327367fe19d51f15ef;hb=57a0976b6e7d84f77a08dcd4cf03d6656dae60d4;hp=3baa3f98b91914e5e3fcd28d95d7c7cccdbf2520;hpb=61c0c42465b6886f6aff3c5cf6a94404b03a1fbd;p=yaz-moved-to-github.git diff --git a/README b/README index 3baa3f9..4a73ff8 100644 --- a/README +++ b/README @@ -1,7 +1,12 @@ + + * Copyright (C) 1994, Index Data. + * All rights reserved. See the file LICENSE for details. + * Sebastian Hammer, Adam Dickmeiss + Compilation and installation The primary output of the source here is the libyaz.a library, which -contain support functions for implementing the server or client role +contains support functions for implementing the server or client role of Z39.50/SR. Currently, the library is placed in a directory 'lib' which is one level *above* the distribution directory (yaz). This was initially done because the library is often used along with several @@ -50,6 +55,8 @@ directory. The directories: +doc - Documentation. Check this out if you'd like to use the code. + util - Various little utility functions. Logging, memory debugging, primitive ISO2709 presentation for the client, etc. @@ -65,8 +72,8 @@ yazlib - This module primarily implements the transport transparency stack (COMSTACK). The comstack implements a generic interface for exchanging BER-encoded records over a network. It supports the American mode of exchanging the records straight over - TCP/IP, and Peter Furniss' XTIMOSI package over RFC1006. Look - for documentation in the file comstack.man. + TCP/IP, and uses Peter Furniss' XTIMOSI package over RFC1006. + Look for documentation in the file comstack.man. server - This is the implementation of the server frontend. It It provides event-handling and server managament functions, @@ -80,9 +87,9 @@ rfc1006 - Xtimosi requires an implementation of the OSI transport typically use). This module is not neeeded if you don't use xtimosi. +include - The various header files. + makelib - This is a simple utility that gathers the libraries from the previous modules into libyaz.a. -include - The various header files. - -../lib - The libraries. Primarily libyaz.a. +lib - The libraries. Primarily libyaz.a.