X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffrontend.xml;h=19729e102d18fe8426b6ed10b889068c80fcdaad;hb=d00666d5391066b1acba398090170d3766ec7e4f;hp=391ca9dbb5b49a0bed07d96899c9bf480cd43f73;hpb=3b3deb4d093d747360a5eb0e02c6b4e9c8a89b84;p=yaz-moved-to-github.git diff --git a/doc/frontend.xml b/doc/frontend.xml index 391ca9d..19729e1 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,14 +1,12 @@ - - Making an IR Server for Your Database + + Generic server Introduction If you aren't into documentation, a good way to learn how the back end interface works is to look at the backend.h file. Then, look at the small dummy-server in - ztest/ztest.c. Finally, you can have a look at - the seshigh.c file, which is where most of the - logic of the frontend server is located. The backend.h + ztest/ztest.c. The backend.h file also makes a good reference, once you've chewed your way through the prose of this file. @@ -45,7 +43,7 @@ - The Database Frontend + The Database Frontend We refer to this software as a generic database frontend. Your @@ -102,22 +100,22 @@ - The Backend API + The Backend API - The headers files that you need to use the interface are in the - include/yaz directory. They are called - statserv.h and backend.h. They - will include other files from the include/yaz - directory, so you'll probably want to use the -I option of your - compiler to tell it where to find the files. When you run + The header file that you need to use the interface are in the + include/yaz directory. It's called + backend.h. It will include other files from + the include/yaz directory, so you'll + probably want to use the -I option of your compiler to tell it + where to find the files. When you run make in the top-level &yaz; directory, - everything you need to create your server is put the - lib/libyaz.a library. + everything you need to create your server is to link with the + lib/libyaz.la library. - Your main() Routine + Your main() Routine As mentioned, your main() routine can be quite brief. @@ -304,7 +302,7 @@ void statserv_setcontrol(statserv_options_block *block); - The Backend Functions + The Backend Functions For each service of the protocol, the backend interface declares one or @@ -672,7 +670,7 @@ typedef struct bend_scan_rr { - Application Invocation + Application Invocation The finished application has the following @@ -849,7 +847,7 @@ typedef struct bend_scan_rr { sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: -->