X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-asncomp-man.xml;h=18b6146fd18f8a5f2ca59e8276725c22dca479da;hp=f39207fd4255f13098639248ecb668a94a70274e;hb=a6b61b9f8b6576e8159a4e7e6aee88bba7e5d07d;hpb=c6e47cbbff56f39f6d81b079ebaeac41d793d4d9 diff --git a/doc/yaz-asncomp-man.xml b/doc/yaz-asncomp-man.xml index f39207f..18b6146 100644 --- a/doc/yaz-asncomp-man.xml +++ b/doc/yaz-asncomp-man.xml @@ -1,17 +1,31 @@ - + %local; + + %entities; + + %idcommon; ]> - + + YAZ + &version; + Index Data + + yaz-asncomp 1 + Commands - + yaz-asncomp YAZ ASN.1 compiler - + yaz-asncomp @@ -25,7 +39,7 @@ filename - + DESCRIPTION @@ -38,7 +52,7 @@ which is a library that encodes/decodes/prints BER packages. yaz-asncomp allows you to specify name of resulting source via options. Alternatively, you can specify - a DEFINISIONS file, which provides customized output to + a DEFINITIONS file, which provides customized output to many output files - if the ASN.1 specification file consists of many modules. @@ -54,25 +68,25 @@ Makes the ASN.1 compiler print more verbose about the - various stages of operations. + various stages of operations. - + -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 @@ -81,14 +95,14 @@ in header file (option -h). - + -d dfile Specifies the name of a definitions file. - + -I iout @@ -96,7 +110,7 @@ are written. - + -i idir @@ -104,7 +118,7 @@ are written. - + -m module @@ -113,7 +127,7 @@ all modules in the ASN.1 file are processed. - + DEFINITIONS FILE @@ -121,7 +135,7 @@ 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 + are line oriented. The definitions files usually consist of a series of variable assignments of the form: @@ -130,7 +144,7 @@ Available variables are: - + default-prefix Sets prefix for names in the produced output. @@ -138,7 +152,7 @@ C typedef prefix and preprocessor prefix respectively. - + prefix(module) This value sets prefix values for module @@ -146,24 +160,24 @@ 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 + 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 + Code fragment to be put in last part of public header for module module (trailer). @@ -174,21 +188,21 @@ module module. - + body(module,c) Code fragment to be put in last part of C based encoder/decoder for module module (trailer). - + map(module,name) - Maps ASN.1 type in module module + Maps ASN.1 type in module module of name to value. - + membermap(module,name,member) Maps member member in SEQUENCE/CHOICE of @@ -201,13 +215,13 @@ C struct,union. - + unionmap(module,name,member) Maps member member in CHOICE of name in module module to value. - Value consists of to or three tokens. The first token + Value consists of two or three tokens. The first token is name of the integer in the union that is used as selector for the union itself. The second token is name of the union. @@ -240,15 +254,7 @@