NAME

oyranos-xforms-modules - Oyranos command line option forms dumping tool

SYNOPSIS

oyranos-xforms-modules [ [-n REGISTRATION] [-x FILENAME] [-v] ]
oyranos-xforms-modules [ [-n REGISTRATION -t TYPE] [--short [--short]] [-v] ]
oyranos-xforms-modules [-l]
oyranos-xforms-modules [-?]

DESCRIPTION

The tool dumps out Oyranos option forms from a given module.

OPTIONS

-n module_registration

Get option forms from module.

-f include policy options

-x FILENAME Write to a option forms document.

-n module_registration -t type

Get informations from module.

-t "" list information types

-t name get informations of type "name"

--short make information shorter,

--short --short gives a nick length information

-l list modules registrations

-v be verbose

-?

help text

ENVIRONMENT

OY_DEBUG

set the Oyranos debug level. Alternatively the -v option can be used.

XDG_CONFIG_HOME XDG_DATA_DIRS

route Oyranos to top directories containing resources. The derived paths for policies have a "color/settings" appended.

http://www.oyranos.com/wiki/index.php?title=OpenIccDirectoryProposal

OY_MODULE_PATH

route Oyranos to additional directories containing modules.

EXAMPLES

Get default options forms for module:: oyranos-xforms-modules -n lcm2
Get default options forms for module and write to a file:: oyranos-xforms-modules -n lcm2 -x lcms.xhtml
Pipe in forms, show and write to file:: oyranos-xforms-modules -n lcm2 | oyranos-xforms-fltk -o lcm2.xhtml
Get help text for module:: oyranos-xforms-modules -n 4_scale -t help
Print a help text:: oyranos-xforms-modules -?

MODULE SELECTION

The -n module / filter selection happens as string called a registration. Fro instance "org/oyranos/openicc/icc_color._lcm2._CPU._NOACCEL"

This is how Oyranos identifies filters. The string is separated into sections by a slash'/'. The sections can be subdivided by point'.' for additional attributes as needed.

The sections meaning are as follows:

top e.g. org

vendor e.g. oyranos

filter type e.g. openicc

filter name e.g. "icc_color._lcm2._NOACCEL._CPU"

Registration search pattern:

To explicitely select a different processor and context creator the according registration attribute must have a number and prefix, e.g. "4_lcms" "7_octl". A search pattern can add keywords.

a number followed by underscore, plus or minus signs the according API. The feature of interesst must then be appended, e.g. "7_GPU" preferes a GPU interpolator. This is useful to select a certain API of a module.
underscore '_' means preference
minus '-' means must skip
plus '+' means must have
"4[_,+,-]" - context+UI oyCMMapi4_s
"6[_,+,-]" - context convertor oyCMMapi6_s
"7[_,+,-]" - processor oyCMMapi7_s By default all attributes in a search pattern are considered mandatory. A level can be omitted, "//", or a attribute can be tagged by a '_' underscore in front for making it optional, or a '-' to indicate a attibute must not match.

Example - a complete registration search pattern:

"//openicc/4+icc_color.7+ACCEL.7_GPU.7_HLSL.7-GLSL" selects a accelerated CMM interpolator with prefered GPU and HLSL but no GLSL support together with a ICC compliant context generator and options.

"//openicc/4_lcms.7_lcm2" selects the "lcms" options filter together with a "lcm2" data processor

AUTHOR

Kai-Uwe Behrmann (ku.b (at) gmx.de)

COPYRIGHT

(c) 2005-2011, Kai-Uwe Behrmann and others
License: new BSD <http://www.opensource.org/licenses/BSD-3-Clause>

BUGS

at: http://sourceforge.net/tracker/?group_id=177017&atid=879553