Overview

Create a cyloop file.

Usage : cylcree [cyloop_file_name]

cylcree is an interactive command that asks the user to define all the characteristics of a cyloop file before creating the file.

The cyloop filename to create can be passed as a parameter (with or without the suffix .cyl).
Without this parameter, the command cylcree begins by asking the name of the file to create.

Then begins a series of questions and answers that allows the user to define all the characteristics of the cyloop file he wants to create.

For details on creating a cyloop file, see this webpage.

Viewing the structure and content of a cyloop file.

Usage : cyldump [cyloop_file_name]

cyldump displays different characteristics of a cyloop file :
The cyloop filename to dump can be passed as a parameter (with or without the suffix .cyl).
Without this parameter, the command cyldump begins by asking the name of this file.

Incrementing a counter variable.

Usage : cylincr cyloop_file_name

cyloop_file_name parameter is mandatory.

cylincr permits to increment the variable of cyloop_file_name file at the current moment of the running cycle, when this variable is a counter.

The counter is incremented systematically during the first call of cylincr for a new moment of the cycle.

If other calls of cylincr occur during the same moment of the cycle, they will be recognized or ignored according to characteristics of the variable.

If the cycle changed since the previous call of cylincr, a weighting calculation is performed on the data already stored from previous cycles, when this calculation was provided for the variable.

Inserting a new value in a variable which is not counter-type

Usage : cyladdval cyloop_file_name value

cyloop_file_name and value parameters are required.

cyladdval adds the data value to the variable of the cyloop_file_name file at the current moment of the running cycle, when this variable is not counter-type.

The addition of the data is systematic during the first call of cyladdval for a new moment of the cycle.

If other calls of cyladdval occur during the same moment of the cycle, they will be recognized or ignored according to characteristics of the variable.

If the cycle changed since the previous call of cyladdval, a weighting calculation is performed on the data already stored from previous cycles, when this calculation was provided for the variable.

Generating graph from a cyloop file

Usage : cylgraph cyloop_file_name image_file_name general_options description_of_plots
Parameters cyloop_file_name and image_file_name are mandatory.

cylgraph generates an image image_file_name from file cyloop_file_name.

General options

These initial options are all optional and can appear in any order. They concern the properties of the generated image.
-h is used to specify the height graph_height in pixels of the graph integrated to the generated image.
By default, this height is 100 pixels, unless the total height of the image is fixed to a lower value.

-w is used to specify the width graph_width in pixels of the graph integrated to the generated image.
By default, this width is 400 pixels, unless the full width of the image is fixed to a lower value.

-H is used to specify the height image_height in pixels of the image.
By default, this height is 50 pixels higher than the height of the graph.

-W is used to specify the width image_width in pixels of the image.
By default, this width is 100 pixels wider than the width of the graph. Compared to the width you choose, it is always sewn in higher multiple of 8.

-T allows you to add on top of the generated image the title image_title

-p request to display the vertical scale of the graph as percentages, rather than as raw numerical values.

Description of plots

The description of plots consists of a range of options as follows : The following options allow each to describe a plot included in the graph.

There may be multiple plots (up to 12). In this case, the different plot in the graph are inserted in the order they are mentioned. When multiple plots overlapped in the graph, it's the last plot which has priority and that will give the pixel its color.

-tthickness color -a color -mtthickness color -ma color -Mtthickness color -Ma color

Picture Formats

The command cylgraph can generate images in many formats.
The format of the image generated depends on the the suffix of file image_file_name passed as parameter.

However, to support many image formats, the command cylgraph calls the convert command of the project ImageMagick.

Without this command, the generated images are in bmp format and image file names end with the suffix .bmp

Configuration : sysfont file

The sysfont file is an optional system file of cyloop project.

It must be created if needed when installing cyloop.

This file is only useful when the computer does not use UTF-8 character set (ie when the $LANG environment variable does not end with UTF-8).

In this case, it is used by the command cylgraph to use the correct character set to insert text in the generated graphics.

Implantation

If the executable commands of the project Cyloop are located in /usr/bin like most other operating system commands, the sysfont file must be located in /usr/share/cyloop

Otherwise, it must be implanted in the same directory as the executable files of the project Cyloop that is : (...)/cyloop/bin

Contents

The contents of the file sysfont is limited to a font file name (without other characters before or after including white space).

The possible cast file names are :

iso8859-2iso8859-3 iso8859-4iso8859-5
iso8859-6iso8859-7 iso8859-8iso8859-9
iso8859-10iso8859-11 iso8859-13iso8859-14
iso8859-15iso8859-16 windows-1252

The name iso8859-1 is also allowed, but the file sysfont is not needed when using this character set, because it is the default character set.