Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

yaz-asncomp(1) [debian man page]

YAZ-ASNCOMP(1)							     Commands							    YAZ-ASNCOMP(1)

NAME

       yaz-asncomp - YAZ ASN.1 compiler

SYNOPSIS

       yaz-asncomp [-v] [-c cfile] [-h hfile] [-p pfile] [-d config] [-I includeout] [-i includedir] [-m module] [filename]

DESCRIPTION

       yaz-asncomp is an ASN.1 compiler that reads an ASN.1 specification in filename and produces C/C++ definitions and BER encoders/decoders for
       it.

       The produced C/C++ code and header files uses the ODR module of YAZ 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 many output files - if the ASN.1 specification file consists of many modules.

       This utility is written in Tcl. Any version of Tcl should work.

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.

       -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 based encoder/decoder for 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 of name to value.

       membermap(module,name,member)
	   Maps member member in SEQUENCE/CHOICE of name in module module to value. The value consists of one or two tokens. First token is name
	   of C preprocessor part. Second token is resulting C member name. If second token is omitted the value (one token) is both preprocessor
	   part and 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 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. The third token overrides
	   the name of the CHOICE member; if omitted the member name is used.

FILES

       /usr/share/yaz/z39.50/z.tcl

       /usr/share/yaz/z39.50/*.asn

SEE ALSO

       yaz(7)

       Section "The ODR Module" in the YAZ manual.

YAZ 4.2.30							    04/16/2012							    YAZ-ASNCOMP(1)

Check Out this Related Man Page

YAZ-ICU(1)							     Commands								YAZ-ICU(1)

NAME

       yaz-icu - YAZ ICU utility

SYNOPSIS

       yaz-icu [-c config] [-p opt] [-s] [-x] [infile]

DESCRIPTION

       yaz-icu is utility which demonstrates the ICU chain module of yaz. (yaz/icu.h).

       The utility can be used in two ways. It may read some text using an XML configuration for configuring ICU and show text analysis. This mode
       is triggered by option -c which specififies the configuration to be used. The input file is read from standard input or from a file if
       infile is specified.

       The utility may also show ICU information. This is triggered by option -p.

OPTIONS

       -c config
	   Specifies the file containing ICU chain configuration which is XML based.

       -p type
	   Specifies extra information to be printed about the ICU system. If type is c then ICU converters are printed. If type is l available
	   locales are printed. If type is t available transliterators are printed.

       -s
	   Specifies that output should include sort key as well. Note that sort key differs between ICU versions.

       -x
	   Specifies that output should be XML based rather than "text" based.

ICU CHAIN CONFIGURATION

       The ICU chain configuration speicifies one or more rules to convert text data into tokens. The configuration format is XML based.

       The toplevel element must be named icu_chain. The icu_chain element has one required attribute locale which specifies the ICU locale to be
       used in the conversion steps.

       The icu_chain element must include elements where each element specifies a conversion step. The conversion is performed in the order in
       which the conversion steps are specified. Each conversion element takes one attribute: rule which serves as argument to the conversion
       step.

       The following conversion elements are available:

       casemap
	   Converts case and rule specifies how:

	   l
	       Lowercase using ICU function u_strToLower.

	   u
	       Upper case using ICU function u_strToUpper.

	   t
	       To title using UCU function u_strToTitle.

	   f
	       Fold case using ICU function u_strFoldCase.

       display
	   This is a meta step which specifies that a term/token is to be displayed. This term is retrieved in an application using function
	   icu_chain_token_display (yaz/icu.h).

       transform
	   Specifies an ICU transform rule using a transliterator Identifier. The rule attribute is the transliterator Identifier. See ICU
	   Transforms[1] for more information.

       transliterate
	   Specifies a rule-based transliterator. The rule attribute is the custom transformation rule to be used. See ICU Transforms[1] for more
	   information.

       tokenize
	   Breaks / tokenizes a string into components using ICU functions ubrk_open, ubrk_setText, .. . The rule is one of:

	   l
	       Line. ICU: UBRK_LINE.

	   s
	       Sentence. ICU: UBRK_SENTENCE.

	   w
	       Word. ICU: UBRK_WORD.

	   c
	       Character. ICU: UBRK_CHARACTER.

	   t
	       Title. ICU: UBRK_TITLE.

EXAMPLES

       The following command analyzes text in file text using ICU chain configuration chain.xml:

	       cat text | yaz-icu -c chain.xml

       The chain.xml might look as follows:

	   <icu_chain locale="en">
	     <transform rule="[:Control:] Any-Remove"/>
	     <tokenize rule="w"/>
	     <transform rule="[[:WhiteSpace:][:Punctuation:]] Remove"/>
	     <transliterate rule="xy > z"/>
	     <display/>
	     <casemap rule="l"/>
	   </icu_chain>

SEE ALSO

       yaz(7)

       ICU Home[2]

       ICU Transforms[1]

NOTES

	1. ICU Transforms
	   http://userguide.icu-project.org/transforms/general

	2. ICU Home
	   http://www.icu-project.org/

YAZ 4.2.30							    04/16/2012								YAZ-ICU(1)
Man Page