runExampleModule2 - A simple example for AliceO2 submodules

.B runExampleModule2

.RB [ --someoption ]

.RB [ --debug " [" --gdb=\fI...\fR ]]

.I mandatory_argument

.RI [ further_arguments... ]

runExampleModule2 is an example to demonstrate the AliceO2 cmake setup of

modules. This document illustrates creation of man pages. All options and

arument are pure fictive.

This is a fancy option of the example.

.TP 5

Run everything with debugging options

.TP 5

Add additional information to run with gdb

http://gnustep.made-it.com/man-groff.html

O2_GENERATE_MAN(NAME AliceHLTComponents)

ALICE HLT components are part of AliRoot and can be plugged into the

O2 system via the AliceHLTWrapperDevice. The wrapper device takes the

shared library name and component id as parameters to instantiate the

component instance.

.B libAliHLTUtil.so

FilePublisher

FileWriter

ROOTFilePublisher

ROOTFileWriter

.TP 2

.I filename

data file to be published

.TP 2

.I configfile

read arguments from a configfile

.TP 2

.I datatype dataorigin

data type ID and origin, e.g. -datatype 'CLUSTERS' 'TPC '

.TP 2

.I specification

data specification treated as decimal number or hex number if prepended by '0x'

.TP

Opens all files during component initialisation rather than as needed during event processing. Note: this feature may result in the system running out of file handles if a large number of files was specified.

.TP

indicate subsequent files to be published by the next event

.TP

.I filename

file name base

.TP

.I directory

target directory

.TP

create sub dir for each event, the format pattern can contain printfspecifiers to print the event no into the dir name, default is'event%%03lu' (-subdir w/o additional pattern). The format specifyer%%lu is automatically added if missing in the pattern. Please note thelong int type of the event id, the idfmt string is reset since the subdircontains the id

.TP

format specifier for the event id in the file name, default: on, default pattern: '_0x%%08x'

.TP

format specifier for the data specification in the file name default: off, default pattern: '_0x%%08x'

.TP

format specifier for the block no in the file name default: on, default pattern: '_0x%%02x'

.TP

do not consider data type when building the file name.

.TP

don't use the event number but an event counter beginning from 0

.TP

concatenate all blocks of one event into one file, this skips the block no, and the block data type in the file name

.TP

concatenate all events into one file, this skips the event no, the block no, and the block data type in the file name. Currently, this implies the -concatenate-blocks option.

.TP

.I filename

write configuration file for FilePublisher component (AliHLTFilePublisher) one line per file: -datatype id origin -datafile filename events separated by -nextevent

.TP

by default, the file writer ignores all steering events like thethe SOR/EOR events, with this option, all events will be consideredthe beginning.

.TP

by default, the file writer ignores all blocks of origin {PRIV} (::kAliHLTDataOriginPrivate), with this option, all blocks willbe written. For SOR/EOR events, a short string will be added in the beginning.

.TP

combines both -write-all-events and -write-all-blocks

.TP

size of burst buffer, blocks are written to buffer until it is filled and written in one burst (though to different files according to conf). Note: burst write is currently only supported for mode -concatenate-events AND -concatenate-blocks (both enabled).

.TP

.I id origin

data block selection by AliHLTBlockDataCollection

.TP

.I origin

data block selection by AliHLTBlockDataCollection

.TP

.I id

data block selection by AliHLTBlockDataCollection

.TP

.I specification

data block selection by AliHLTBlockDataCollection

Special implementation of the

.I FilePublisher

component.

.P

Additional options:

.TP

.I objectname

Name of the object in the root file to be fetched. This is set for all events/files. If not given, all objects are fetched.

Special implementation of the

.I FileWriter

component.

.P

Additional options:

.TP

write objects with the TObject::kOverwrite flag and avoid multiple keys in the file

Matthias.Richter@scieq.net

All questions and suggestions welcome

AliceHLTWrapperDevice(1)

.B AliceHLTWrapperDevice

.B --id

.I deviceid

.B --channel-config

.I config

.B --library

.I arg

.B --component

.I arg

.B --parameter

.I arg

.B --runno

.I n

.TP 2

A unique identifier of the device

.TP 2

channel configuration as comma separated key=\fIvalue\fR pairs

.RS

Valid Keys:

.B name

.B type

.B method

.B address

.B property

.RE

.B Note:

Every HLT component has it's own set of (command line) options which can be passed via the \fB--parameter\fR option.

.TP 2

HLT library containing the component

.TP 2

HLT component id

.TP 2

Parameter of the component, make sure to put in quotes if the argument consists

of multiple strings

.TP 2

Run number

.B --poll-period \fIperiod\fR

Polling period on the input channel

HLT components need the Alice OCDB to load the configuration. The path to the OCDB must be set in environment variable \fBALIHLT_HCDBDIR\fR.

.B AliceHLTWrapperDevice

--id publisher \\

.br

--channel-config \\

.br

name=data-out,type=pub,method=bind,address=tcp://*:42424 \\

.br

--library libAliHLTUtil.so --component FilePublisher --run 167808 \\

.br

--parameter '-datafile some_file_to_publish'

Matthias.Richter@scieq.net

All questions and suggestions welcome

AliceHLTComponents(1), FairMQDevice(1)

The device does not interface to the FairMQ parameter manager. The device itself

does not need any more parameters than the command line options. The HLT component

needs the ALICE OCDB location and the run number.