From: Adam Dickmeiss Date: Tue, 27 May 2003 12:45:23 +0000 (+0000) Subject: Manual page for yaz-comp X-Git-Tag: YAZ.2.0.3~29 X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=207401f82e01f380a3549fe5576069ac4b45331e Manual page for yaz-comp --- diff --git a/doc/Makefile.am b/doc/Makefile.am index 58c214a..46800e3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.45 2003-05-12 22:37:56 adam Exp $ +## $Id: Makefile.am,v 1.46 2003-05-27 12:45:23 adam Exp $ docdir=$(datadir)/doc/@PACKAGE@ @@ -24,7 +24,7 @@ HTMLFILES = \ zoom.records.html zoom.resultsets.html zoom.scan.html MANFILES=yaz-client.1 yaz-client-ssl.1 yaz-ztest.8 \ - yaz-ztest-ssl.8 yaz-config.8 yaz.7 zoomsh.1 + yaz-ztest-ssl.8 yaz-config.8 yaz.7 zoomsh.1 yaz-comp.1 REFFILES=yaz-client.sgml yaz-ztest.sgml yaz-config.sgml \ yaz-man.sgml zoomsh.sgml @@ -60,6 +60,9 @@ yaz-ztest-ssl.8: yaz-client-ssl.1: ln -s yaz-client.1 yaz-client-ssl.1 +yaz-comp.1: yaz-comp.sgml + docbook2man $(srcdir)/yaz-comp.sgml + $(HTMLFILES): $(XMLFILES) jade -E14 -D $(srcdir) -d yazhtml.dsl -t sgml $(srcdir)/xml.dcl yaz.xml diff --git a/doc/yaz-comp.sgml b/doc/yaz-comp.sgml new file mode 100644 index 0000000..7d27727 --- /dev/null +++ b/doc/yaz-comp.sgml @@ -0,0 +1,228 @@ + + + + + yaz-comp + 1 + + + + yaz-comp + YAZ ASN.1 compiler + + + + + yaz-comp + + + + + + + + + asn-file + + + + DESCRIPTION + + yaz-comp is an ASN.1 compiler that + reads an ASN.1 specification and produces C/C++ definitions + and encoders/decoders for it. + + + + OPTIONS + + -v + + + + Makes the ASN.1 compiler print more verbose about the + various stages of operations. + + + + + -c + cfile + + Specifies the name of the C/C++ file with encoders/decoders. + + + -c + cfile + + Specifies the name of the C/C++ file with encoders/decoders. + + + -c + cfile + + Specifies the name of the C/C++ file with encoders/decoders. + + + -h + hfile + + Specifies the name of header file with definitions. + + + -p + pfile + + Specifies the name of the a private header file with + definitions. By default all definitions are put + in header file (option -h). + + + -d + dfile + + Specifies the name of a definitions file. + + + -I + iout + + Specifies first part of directory in which header files + are written. + + + -i + idir + + Specifies second part of directory in which header files + are written. + + + -m + module + + Specifies that ASN.1 compiler should only process the + module given. If this option is not specified, + all modules in the ASN.1 file are processed. + + + + + DEFINITIONS FILE + + The definitions file is really a Tcl script but follows + traditional rules for Shell like configuration files. + That is # denotes the beginning of a comment. Definitions + are line oriented. The definitions files usually consists of + a series of variable assignments of the form: + + + set name value + + + Available variables are: + + + default-prefix + + Sets prefix for names in the produced output. + The value consists of three tokens: C function prefix, + C typedef prefix and preprocessor prefix respectively. + + + prefix(module) + + This value sets prefix values for module + module. + The value has same form as default-prefix. + + + filename(module) + + Specifies filename for C/header file for module + module. + + + init(module,h) + + Code fragment to be put in first part of public header for module + module. + + + body(module,h) + + Code fragment to be put in last part of public header for module + module (trailer). + + + init(module,c) + + Code fragment to be put in first part of C encoder/decoder for + module module. + + + body(module,c) + + Code fragment to be put in last part of C encoder/decoder for + module module (trailer). + + + map(module,name) + + Maps ASN.1 type in module module + of name to value. + + + membermap(module,name,member) + + Maps member member in SEQUENCE of + name in module + module to value. + + + unionmap(module,name,member) + + Maps member member in CHOICE of + name in module + module to value. + Value consists of three tokens. + + + + + + FILES + + /usr/share/yaz/z39.50/z.tcl + + + /usr/share/yaz/z39.50/*.asn + + + SEE ALSO + + + yaz + 7 + + + Section "Generic server" in the YAZ manual. + + + + +