.\" This is the manual page for ctioga2 .\" .\" Copyright 2009 by Vincent Fourmond .\" .\" This file is generated from the ctioga2 code and from the file ctioga2.1.template .\" .\" This program is free software; you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details (in the COPYING file). .\" .TH CTIOGA2 1 "Tue 29 Mar 22:54:55 CEST 2016" "Version 0.14.1" "Command-line interface for Tioga" .\" We want to use the .URL command .\" .mso www.tmac .\" Do we ?? .SH NAME ctioga2 \- a command-line front-end for the Tioga plotting library .SH SYNOPSIS .B ctioga2 .I arguments \&.\|.\|. .SH DESCRIPTION .B ctioga2 is a command-line front-end to the wonderful Tioga plotting library. It aims at plotting quickly both data files and mathematical functions, with however the possibility of a high control over the details. The main feature that was introduced compared to the old .B ctioga is that it is now possible to use command files for .BR ctioga2 : every single command-line option corresponds to a command, whose name is written. Just give the command the same arguments as to the command-line option. To read a command file, feed it to the .B -f command-line option. .SH EXAMPLES Here are a few examples, both from command-line and using the corresponding files. .TP 8 .BI ctioga2 \ File.dat Produces a file \fIPlot.pdf\fR showing the second column of File.dat as a function of the first. .P The corresponding command file would be: #!/usr/bin/env ctioga2 -f plot(File.dat) .SH OPTIONS .SS Plots Plots .TP 8 .B --plot \fIDATASET\fR Use the current backend to load the given datasets onto the data stack and plot them. It is a combination of the \fIload\fR and the \fIplot-last\fR commands; you might want to see their documentation. .br .B Optional arguments: .I as bypass-transforms class clipped color color-map contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-number depth error-bar-color error-bar-line-width fill fill-color fill-pattern fill-transparency id ignore_hooks legend line-cap line-style line-width marker marker-angle marker-color marker-color-map marker-fill-color marker-fill-color-map marker-line-color marker-line-color-map marker-line-width marker-min-scale marker-scale name path-style region-side split-on-nan where xaxis yaxis zaxis .br .B Corresponding command: .I plot(dataset,option=...) .TP 8 .B -p, --plot-last \fI\fR Plots the last dataset pushed onto the data stack (or the one specified with the which option), with the current style. All aspects of the curve style (colors, markers, line styles...) can be overridden through the use of options. .br .B Optional arguments: .I class clipped color color-map contour-conrec contour-minor-number contour-minor-scale contour-minor-style contour-number depth error-bar-color error-bar-line-width fill fill-color fill-pattern fill-transparency id legend line-cap line-style line-width marker marker-angle marker-color marker-color-map marker-fill-color marker-fill-color-map marker-line-color marker-line-color-map marker-line-width marker-min-scale marker-scale path-style region-side split-on-nan which xaxis yaxis zaxis .br .B Corresponding command: .I plot-last(,option=...) .SS Curves styles Set stylistic details of curves or other object drawn from data .TP 8 .B --[no-]clipped \fI\fR Sets the clipped for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I clipped(boolean-or-auto) .TP 8 .B -c, --color \fICOLOR-OR-FALSE-OR-AUTO\fR Sets the line color for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I color(color-or-false-or-auto) .TP 8 .B --color-map \fICOLORMAP-OR-AUTO\fR Sets the color map for the subsequent curves, until cancelled by an auto argument. Color maps are used for 3D plots, ie under the effet of \fIcontour\fR, \fIxyz-map\fR and \fIxy-parametric\fR. .br .br .B Corresponding command: .I color-map(colormap-or-auto) .TP 8 .B --color-set \fICOLOR-OR-FALSE-SET\fR Chooses a set for the line color of subsequent curves. Also sets \fIcolor\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I color-set(color-or-false-set) .TP 8 .B --[no-]contour-conrec \fI\fR If on, the subsequent curves will use the CONREC algorithm for contouring. In the opposite case, the contouring algorithm of Gri is used. Only useful when \fIcontour\fR is in effect. .br .br .B Corresponding command: .I contour-conrec(boolean-or-auto) .TP 8 .B --contour-minor-number \fIINTEGER-OR-AUTO\fR Sets the number of minor level lines between major ones (approx) for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I contour-minor-number(integer-or-auto) .TP 8 .B --contour-minor-scale \fIFLOAT-OR-AUTO\fR Sets the relative scale of minor level lines for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I contour-minor-scale(float-or-auto) .TP 8 .B --contour-minor-style \fILINE-STYLE-OR-AUTO\fR Sets the minor ticks line style for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I contour-minor-style(line-style-or-auto) .TP 8 .B --contour-number \fIINTEGER-OR-AUTO\fR Sets the overall number of level lines for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I contour-number(integer-or-auto) .TP 8 .B --depth \fIINTEGER-OR-AUTO\fR Sets the depth for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I depth(integer-or-auto) .TP 8 .B --error-bar-color \fICOLOR-OR-FALSE-OR-AUTO\fR Sets the error bar color for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I error-bar-color(color-or-false-or-auto) .TP 8 .B --error-bar-color-set \fICOLOR-OR-FALSE-SET\fR Chooses a set for the error bar color of subsequent curves. Also sets \fIerror-bar-color\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I error-bar-color-set(color-or-false-set) .TP 8 .B --error-bar-line-width \fIFLOAT-OR-AUTO\fR Sets the error bar line width for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I error-bar-line-width(float-or-auto) .TP 8 .B --error-bar-line-width-set \fIFLOAT-SET\fR Chooses a set for the error bar line width of subsequent curves. Also sets \fIerror-bar-line-width\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I error-bar-line-width-set(float-set) .TP 8 .B --fill \fIFILL-UNTIL-OR-AUTO\fR Sets the Fill until for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I fill(fill-until-or-auto) .TP 8 .B --fill-color \fICOLOR-OR-AUTO\fR Sets the fill color for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I fill-color(color-or-auto) .TP 8 .B --fill-color-set \fICOLOR-SET\fR Chooses a set for the fill color of subsequent curves. Also sets \fIfill-color\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I fill-color-set(color-set) .TP 8 .B --fill-pattern \fIFILL-PATTERN-OR-AUTO\fR Sets the fill pattern for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I fill-pattern(fill-pattern-or-auto) .TP 8 .B --fill-set \fIFILL-UNTIL-SET\fR Chooses a set for the Fill until of subsequent curves. Also sets \fIfill\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I fill-set(fill-until-set) .TP 8 .B --fill-transparency \fIFLOAT-OR-AUTO\fR Sets the fill transparency for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I fill-transparency(float-or-auto) .TP 8 .B --fill-transparency-set \fIFLOAT-SET\fR Chooses a set for the fill transparency of subsequent curves. Also sets \fIfill-transparency\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I fill-transparency-set(float-set) .TP 8 .B --line-cap \fILINE-CAP-OR-AUTO\fR Sets the line cap for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I line-cap(line-cap-or-auto) .TP 8 .B --line-style \fILINE-STYLE-OR-AUTO\fR Sets the line style for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I line-style(line-style-or-auto) .TP 8 .B --line-style-set \fILINE-STYLE-SET\fR Chooses a set for the line style of subsequent curves. Also sets \fIline-style\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I line-style-set(line-style-set) .TP 8 .B --line-width \fIFLOAT-OR-AUTO\fR Sets the line width for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I line-width(float-or-auto) .TP 8 .B --line-width-set \fIFLOAT-SET\fR Chooses a set for the line width of subsequent curves. Also sets \fIline-width\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I line-width-set(float-set) .TP 8 .B -m, --marker \fIMARKER-OR-AUTO\fR Sets the marker for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker(marker-or-auto) .TP 8 .B --marker-angle \fIFLOAT-OR-AUTO\fR Sets the marker angle for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-angle(float-or-auto) .TP 8 .B --marker-color \fICOLOR-OR-FALSE-OR-AUTO\fR Sets the marker color for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-color(color-or-false-or-auto) .TP 8 .B --marker-color-map \fICOLORMAP-OR-AUTO\fR Sets the color map for markers for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-color-map(colormap-or-auto) .TP 8 .B --marker-color-set \fICOLOR-OR-FALSE-SET\fR Chooses a set for the marker color of subsequent curves. Also sets \fImarker-color\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I marker-color-set(color-or-false-set) .TP 8 .B --marker-fill-color \fICOLOR-OR-FALSE-OR-AUTO\fR Sets the marker fill color for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-fill-color(color-or-false-or-auto) .TP 8 .B --marker-fill-color-map \fICOLORMAP-OR-AUTO\fR Sets the color map for the lines of markers for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-fill-color-map(colormap-or-auto) .TP 8 .B --marker-fill-color-set \fICOLOR-OR-FALSE-SET\fR Chooses a set for the marker fill color of subsequent curves. Also sets \fImarker-fill-color\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I marker-fill-color-set(color-or-false-set) .TP 8 .B --marker-line-color \fICOLOR-OR-FALSE-OR-AUTO\fR Sets the marker stroke color for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-line-color(color-or-false-or-auto) .TP 8 .B --marker-line-color-map \fICOLORMAP-OR-AUTO\fR Sets the color map for the lines of markers for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-line-color-map(colormap-or-auto) .TP 8 .B --marker-line-color-set \fICOLOR-OR-FALSE-SET\fR Chooses a set for the marker stroke color of subsequent curves. Also sets \fImarker-line-color\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I marker-line-color-set(color-or-false-set) .TP 8 .B --marker-line-width \fIFLOAT-OR-AUTO\fR Sets the marker line width for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-line-width(float-or-auto) .TP 8 .B --marker-min-scale \fIFLOAT-OR-FALSE-OR-AUTO\fR Sets the marker scale for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-min-scale(float-or-false-or-auto) .TP 8 .B --marker-scale \fIFLOAT-OR-AUTO\fR Sets the marker scale for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I marker-scale(float-or-auto) .TP 8 .B --marker-scale-set \fIFLOAT-SET\fR Chooses a set for the marker scale of subsequent curves. Also sets \fImarker-scale\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I marker-scale-set(float-set) .TP 8 .B --marker-set \fIMARKER-SET\fR Chooses a set for the marker of subsequent curves. Also sets \fImarker\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I marker-set(marker-set) .TP 8 .B --path-style \fITEXT-OR-AUTO\fR Sets the path style for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I path-style(text-or-auto) .TP 8 .B --path-style-set \fITEXT-SET\fR Chooses a set for the path style of subsequent curves. Also sets \fIpath-style\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I path-style-set(text-set) .TP 8 .B --region-side \fIREGION-SIDE-OR-AUTO\fR Sets the region side for subsequent curves, until cancelled with auto as argument. .br .br .B Corresponding command: .I region-side(region-side-or-auto) .TP 8 .B --region-side-set \fIREGION-SIDE-SET\fR Chooses a set for the region side of subsequent curves. Also sets \fIregion-side\fR to auto, so that the set takes effect immediately .br .br .B Corresponding command: .I region-side-set(region-side-set) .TP 8 .B --reuse-style \fIOBJECT\fR After using this command, the next curve will have the same style as the curve whose name was given as the first argument (it is the name given to the `/id=` option to plot. .br .br .B Corresponding command: .I reuse-style(object) .TP 8 .B --skip \fI\fR This command acts as if one (or number) dataset had been drawn with respect to the style of the next dataset to be drawn. .br .B Optional arguments: .I number .br .B Corresponding command: .I skip(,option=...) .TP 8 .B --[no-]split-on-nan \fI\fR In general, the NaN (not a number, ie invalid data points in the dataset) in a dataset are silently ignored. When this option is on, the lines of \fIxy-plot\fR-style plots are split upon encountering a NaN. .br .br .B Corresponding command: .I split-on-nan(boolean-or-auto) .TP 8 .B --zaxis \fITEXT-OR-AUTO\fR Sets the name of the zaxis for the subsequent curves. This must be an axis that has been previously created using \fInew-zaxis\fR. This axis will be used to display the colormaps of the following curve. .br .br .B Corresponding command: .I zaxis(text-or-auto) .SS Legends Commands to specify legends and tweak their look. .TP 8 .B --[no-]auto-legend \fI\fR When this option is in effect (off by default), all datasets get a legend, their 'dataset name', unless another legend is manually specified. .br .br .B Corresponding command: .I auto-legend(boolean) .TP 8 .B -l, --legend \fITEXT\fR Sets the legend for the next dataset. Overridden by the legend option to the \fIplot\fR command. .br .br .B Corresponding command: .I legend(text) .TP 8 .B --legend-inside \fIALIGNED-POINT\fR Using this command sets the position of the legends for the current (sub)plot inside it, at the precise location given. As a shortcut, \fIlegend-inside\fR also takes all the options that \fIlegend-style\fR takes, with the same effect. .br .B Optional arguments: .I class dy frame_cap frame_color frame_fill_color frame_fill_pattern frame_fill_transparency frame_padding frame_radius frame_shape frame_style frame_width id picto_height picto_to_text picto_width scale symbol_scale text_scale vpadding .br .B Corresponding command: .I legend-inside(aligned-point,option=...) .TP 8 .B --legend-line \fITEXT\fR Adds a line of text unrelated to any curve to the legend. The options controlling the aspect of the legend are documented in the \fIdefine-text-style\fR command. .br .B Optional arguments: .I align alignment angle color halign justification position scale shift text_align text_width valign .br .B Corresponding command: .I legend-line(text,option=...) .TP 8 .B --legend-multicol \fI\fR Following legends will be layed out in multiple columns, until a call to \fIlegend-multicol-end\fR. .br .B Optional arguments: .I columns dx .br .B Corresponding command: .I legend-multicol(,option=...) .TP 8 .B --legend-multicol-end \fI\fR Stop layout out legends in several columns .br .br .B Corresponding command: .I legend-multicol-end() .TP 8 .B --legend-style \fI\fR Sets the various aspects of the style of the legends throught its options: .RS 10 .IP "\fB*\fR" 2 dy: the spacing between the baseline of consecutive lines; it is deprecated now in favor of vpadding; .IP "\fB*\fR" 2 vpadding: the space left between the bottom of a line and the top of the next one; .IP "\fB*\fR" 2 scale: the overall scale of the legends .IP "\fB*\fR" 2 text-scale: the scale of the text (and the markers) inside the legends .RE .IP "" 8 The frame- options control the drawing of a frame around the legend; they have the same meaning as corresponding ones of \fIdefine-box-style\fR with the frame- bit dropped. .br .B Optional arguments: .I class dy frame_cap frame_color frame_fill_color frame_fill_pattern frame_fill_transparency frame_padding frame_radius frame_shape frame_style frame_width id picto_height picto_to_text picto_width scale symbol_scale text_scale vpadding .br .B Corresponding command: .I legend-style(,option=...) .SS Switch between different kinds of plots How to switch between different kinds of plot types .TP 8 .B --contour \fI\fR Switch to contour plots for later curves. Contour plots need three columns (X,Y,Z). They have major and minor lines. .br .br .B Corresponding command: .I contour() .TP 8 .B --histogram \fI\fR Switch to drawing histograms. .br .B Optional arguments: .I compute_dx cumulative gap intra_sep .br .B Corresponding command: .I histogram(,option=...) .TP 8 .B --xy-parametric \fI\fR Switch to XY parametric plots, that is standard XY plots whose appearance (such as color, marker color, and, potentially, marker kinds and more) are governed by one (or more ?) Z values. .br .B Optional arguments: .I z1 z2 z3 z4 .br .B Corresponding command: .I xy-parametric(,option=...) .TP 8 .B --xy-plot \fI\fR Switch (back) to standard XY plots (ctioga's default) .br .br .B Corresponding command: .I xy-plot() .TP 8 .B --xyz-map \fI\fR Switch to XYZ maps, ie plots where the color at a XY location is given by its Z value. .br .br .B Corresponding command: .I xyz-map() .SS Plot coordinates Plot coordinates .TP 8 .B --margin \fIFLOAT\fR Leaves a margin around the data points. Expressed in relative size of the whole plot. .br .br .B Corresponding command: .I margin(float) .TP 8 .B --xfact \fIFLOAT\fR Alias for \fIxscale\fR. .br .br .B Corresponding command: .I xfact(float) .TP 8 .B --[no-]xlog \fI\fR Uses a logarithmic scale for the X axis. .br .br .B Corresponding command: .I xlog(boolean) .TP 8 .B --xoffset \fIFLOAT\fR Adds the given offset to all X coordinates. .br .br .B Corresponding command: .I xoffset(float) .TP 8 .B --xrange \fIPARTIAL-FLOAT-RANGE\fR Sets the range of the X coordinates. *Important note:* when the axis is in log range (using \fIxlog\fR), the numbers you give are not the or \fIylog\fR values, but their log10, so that to display X values from 1e-2 to 1e3, use: xyrange -2:3 .br .br .B Corresponding command: .I xrange(partial-float-range) .TP 8 .B --xscale \fIFLOAT\fR Multiplies the X coordinates by this factor. .br .br .B Corresponding command: .I xscale(float) .TP 8 .B --yfact \fIFLOAT\fR Alias for \fIyscale\fR. .br .br .B Corresponding command: .I yfact(float) .TP 8 .B --[no-]ylog \fI\fR Uses a logarithmic scale for the Y axis. .br .br .B Corresponding command: .I ylog(boolean) .TP 8 .B --yoffset \fIFLOAT\fR Adds the given offset to all Y coordinates. .br .br .B Corresponding command: .I yoffset(float) .TP 8 .B --yrange \fIPARTIAL-FLOAT-RANGE\fR Sets the range of the Y coordinates. *Important note:* when the axis is in log range (using \fIylog\fR), the numbers you give are not the or \fIylog\fR values, but their log10, so that to display Y values from 1e-2 to 1e3, use: yyrange -2:3 .br .br .B Corresponding command: .I yrange(partial-float-range) .TP 8 .B --yscale \fIFLOAT\fR Multiplies the Y coordinates by this factor. .br .br .B Corresponding command: .I yscale(float) .SS Graphics primitives Tioga graphics primitives .TP 8 .B --draw \fIDRAWING-SPEC\fR Tries to emulate the old --draw behavior of ctioga. Don't use it for new things. .br .br .B Corresponding command: .I draw(drawing-spec) .TP 8 .B --draw-arrow \fIPOINT POINT\fR Draws arrow on the current plot, using the given style. For more information on the available options, see the \fIdefine-arrow-style\fR command. .br .B Optional arguments: .I cap class clipped color depth head_angle head_color head_marker head_scale id line_style line_width style tail_angle tail_color tail_marker tail_scale width .br .B Corresponding command: .I draw-arrow(point,point,option=...) .TP 8 .B --draw-box \fIPOINT POINT\fR Draws box on the current plot, using the given style. For more information on the available options, see the \fIdefine-box-style\fR command. .br .B Optional arguments: .I cap class clipped color depth fill-color fill-transparency fill_color fill_pattern fill_transparency id radius shape style width .br .B Corresponding command: .I draw-box(point,point,option=...) .TP 8 .B --draw-color-list \fIPOINT DIMENSION\fR Directly draws the list of all named colors on the current plot .br .B Optional arguments: .I class clipped columns depth id padding scale .br .B Corresponding command: .I draw-color-list(point,dimension,option=...) .TP 8 .B --draw-color-set-list \fIPOINT DIMENSION\fR Directly draws the list of all color sets on the current plot .br .B Optional arguments: .I class clipped depth exclude id include scale .br .B Corresponding command: .I draw-color-set-list(point,dimension,option=...) .TP 8 .B --draw-contour \fILEVEL\fR Directly draws contour on the current plot .br .B Optional arguments: .I class clipped closed color depth id style width .br .B Corresponding command: .I draw-contour(level,option=...) .TP 8 .B --draw-image \fIFILE TOP-LEFT BOTTOM-RIGHT\fR Draws image on the current plot, using the given style. For more information on the available options, see the \fIdefine-image-style\fR command. .br .B Optional arguments: .I aspect_ratio auto_rotate class clipped depth id transparency .br .B Corresponding command: .I draw-image(file,top-left,bottom-right,option=...) .TP 8 .B --draw-legend-pictogram \fIPOINT OBJECT\fR Draws the legend pictogram for the given curve .br .B Optional arguments: .I class clipped depth id width .br .B Corresponding command: .I draw-legend-pictogram(point,object,option=...) .TP 8 .B --draw-line \fIPOINT POINT\fR Draws line on the current plot, using the given style. For more information on the available options, see the \fIdefine-line-style\fR command. .br .B Optional arguments: .I cap class clipped color depth head_angle head_color head_marker head_scale id line_style line_width style tail_angle tail_color tail_marker tail_scale width .br .B Corresponding command: .I draw-line(point,point,option=...) .TP 8 .B --draw-line-style-list \fIPOINT DIMENSION\fR Directly draws the list of all named line styles on the current plot .br .B Optional arguments: .I class clipped columns depth id padding scale .br .B Corresponding command: .I draw-line-style-list(point,dimension,option=...) .TP 8 .B --draw-marker \fIPOINT MARKER\fR Draws marker on the current plot, using the given style. For more information on the available options, see the \fIdefine-marker-style\fR command. .br .B Optional arguments: .I alignment angle class clipped color depth fill_color horizontal_scale id justification scale stroke_color stroke_width vertical_scale .br .B Corresponding command: .I draw-marker(point,marker,option=...) .TP 8 .B --draw-marker-list \fIPOINT DIMENSION\fR Directly draws the list of all named markers on the current plot .br .B Optional arguments: .I class clipped columns depth id padding scale .br .B Corresponding command: .I draw-marker-list(point,dimension,option=...) .TP 8 .B --draw-marker-set-list \fIPOINT DIMENSION\fR Directly draws the list of all marker sets on the current plot .br .B Optional arguments: .I class clipped depth exclude id include scale .br .B Corresponding command: .I draw-marker-set-list(point,dimension,option=...) .TP 8 .B --draw-oriented-line \fIPOINT DIMENSION\fR Draws oriented-line on the current plot, using the given style. For more information on the available options, see the \fIdefine-oriented-line-style\fR command. .br .B Optional arguments: .I angle cap class clipped color depth head_angle head_color head_marker head_scale id origin style tail_angle tail_color tail_marker tail_scale width .br .B Corresponding command: .I draw-oriented-line(point,dimension,option=...) .TP 8 .B --draw-string-marker \fIPOINT TEXT\fR Draws marker on the current plot, using the given style. For more information on the available options, see the \fIdefine-marker-style\fR command. .br .B Optional arguments: .I alignment angle class clipped color depth fill_color font horizontal_scale id justification scale stroke_color stroke_width vertical_scale .br .B Corresponding command: .I draw-string-marker(point,text,option=...) .TP 8 .B --draw-tangent \fIDATA-POINT\fR Draws tangent on the current plot, using the given style. For more information on the available options, see the \fIdefine-arrow-style\fR command. .br .B Optional arguments: .I cap class clipped color depth head_angle head_color head_marker head_scale id line_style line_width nbavg style tail_angle tail_color tail_marker tail_scale width xextent xfrom xto yextent yfrom yto .br .B Corresponding command: .I draw-tangent(data-point,option=...) .TP 8 .B --draw-text \fIPOINT TEXT\fR Draws text on the current plot, using the given style. For more information on the available options, see the \fIdefine-text-style\fR command. .br .B Optional arguments: .I alignment angle class clipped color depth font halign id justification position scale shift text_align text_width valign .br .B Corresponding command: .I draw-text(point,text,option=...) .SS The 'direct' backend: Direct format The commands in this group drive the behaviour of the \fIdirect\fR backend; see its documentation for more information .TP 8 .B --direct \fI\fR Selects the '\fIdirect\fR' backend .br .br .B Corresponding command: .I direct() .SS The 'gnuplot' backend: Gnuplot files The commands in this group drive the behaviour of the \fIgnuplot\fR backend; see its documentation for more information .TP 8 .B --gnuplot \fI\fR Selects the '\fIgnuplot\fR' backend .br .B Optional arguments: .I range samples vars .br .B Corresponding command: .I gnuplot(,option=...) .TP 8 .B --gnuplot-range \fIRANGE\fR The plotting X range, such as 0:2 .br .br .B Corresponding command: .I gnuplot-range(range) .TP 8 .B --gnuplot-samples \fISAMPLES\fR The number of samples .br .br .B Corresponding command: .I gnuplot-samples(samples) .TP 8 .B --gnuplot-vars \fIVARS\fR A colon-separated override of local variables, such as a=1;b=3;c=5 .br .br .B Corresponding command: .I gnuplot-vars(vars) .SS The 'math' backend: Mathematical functions The commands in this group drive the behaviour of the \fImath\fR backend; see its documentation for more information .TP 8 .B --math \fI\fR Selects the '\fImath\fR' backend .br .B Optional arguments: .I log samples trange xrange .br .B Corresponding command: .I math(,option=...) .TP 8 .B --[no-]math-log \fI\fR Space samples logarithmically .br .br .B Corresponding command: .I math-log(log) .TP 8 .B --math-samples \fISAMPLES\fR The number of points .br .br .B Corresponding command: .I math-samples(samples) .TP 8 .B --math-trange \fITRANGE\fR T range (a:b) (parametric plot) .br .br .B Corresponding command: .I math-trange(trange) .TP 8 .B --math-xrange \fIXRANGE\fR X range (a:b) .br .br .B Corresponding command: .I math-xrange(xrange) .SS The 'smath' backend: Mathematical functions (multi-D) The commands in this group drive the behaviour of the \fIsmath\fR backend; see its documentation for more information .TP 8 .B --smath \fI\fR Selects the '\fIsmath\fR' backend .br .B Optional arguments: .I samples urange usamples vrange vsamples .br .B Corresponding command: .I smath(,option=...) .TP 8 .B --smath-samples \fISAMPLES\fR Number of samples (default, overriden by variable-specific specs) .br .br .B Corresponding command: .I smath-samples(samples) .TP 8 .B --smath-urange \fIURANGE\fR U range (a:b) .br .br .B Corresponding command: .I smath-urange(urange) .TP 8 .B --smath-usamples \fIUSAMPLES\fR Number of U samples .br .br .B Corresponding command: .I smath-usamples(usamples) .TP 8 .B --smath-vrange \fIVRANGE\fR V range (a:b) .br .br .B Corresponding command: .I smath-vrange(vrange) .TP 8 .B --smath-vsamples \fIVSAMPLES\fR Number of V samples .br .br .B Corresponding command: .I smath-vsamples(vsamples) .SS The 'text' backend: Text format The commands in this group drive the behaviour of the \fItext\fR backend; see its documentation for more information .TP 8 .B --csv \fI\fR Now parse the following data files as CSV. Equivalent to text /separator=/[,;]/ .br .br .B Corresponding command: .I csv() .TP 8 .B --text \fI\fR Selects the '\fItext\fR' backend .br .B Optional arguments: .I col header-line parameters separator skip split .br .B Corresponding command: .I text(,option=...) .TP 8 .B --text-col \fICOL\fR Which columns to use when the @1:2 syntax is not used .br .br .B Corresponding command: .I text-col(col) .TP 8 .B --text-header-line \fIHEADER-LINE\fR Regular expression indicating the header line (containing column names) (default /^##/ .br .br .B Corresponding command: .I text-header-line(header-line) .TP 8 .B --text-parameters \fIPARAMETERS\fR Regular expression for extracting parameters from a file. Defaults to nil (ie nothing) .br .br .B Corresponding command: .I text-parameters(parameters) .TP 8 .B --text-separator \fISEPARATOR\fR The columns separator. Defaults to / +/ .br .br .B Corresponding command: .I text-separator(separator) .TP 8 .B --text-skip \fISKIP\fR Number of lines to be skipped at the beginning of the file .br .br .B Corresponding command: .I text-skip(skip) .TP 8 .B --[no-]text-split \fI\fR If true, splits files into subsets on blank/non number lines .br .br .B Corresponding command: .I text-split(split) .SS LaTeX Commands providing control over the LaTeX output (preamble, packages...) .TP 8 .B --preamble \fITEXT\fR Adds the given string to the LaTeX preamble of the output. .br .br .B Corresponding command: .I preamble(text) .TP 8 .B --set-global-font \fI\fR Set global font. Sets the size of everything, including that of text that has already been used. .br .B Optional arguments: .I size .br .B Corresponding command: .I set-global-font(,option=...) .TP 8 .B --use \fITEXT\fR Adds a command to include the LaTeX package into the preamble. The arguments, if given, are given within [square backets]. .br .B Optional arguments: .I arguments .br .B Corresponding command: .I use(text,option=...) .TP 8 .B --utf8 \fI\fR Makes ctioga2 use UTF-8 for all text. It is exactly equivalent to the command \fIpreamble\fR with the argument: \usepackage[utf8]{inputenc}\usepackage[T1]{fontenc} .br .br .B Corresponding command: .I utf8() .SS Subplots and assimilated Subplots and assimilated .TP 8 .B --end \fI\fR Leaves the current subobject. .br .br .B Corresponding command: .I end() .TP 8 .B --frame-margins \fIFRAME-MARGINS\fR Sets the margins for the current plot. Margins are the same things as the position (such as specified for and inset). Using this within an inset or more complex plots might produce unexpected results. The main use of this function is to control the padding around simple plots. The options override the contents of the margin, which makes it easy to set all the dimensions to a given value and just override the ones you need to: frame-margins 2mm /left=1cm This sets all the margins around the side to 2mm excepted the left one, which means in particular the bottom axis tick labels will be cut. .br .B Optional arguments: .I bottom left right top .br .B Corresponding command: .I frame-margins(frame-margins,option=...) .TP 8 .B --gradient \fICOLOR COLOR\fR All the curves between this command and the corresponding \fIend\fR will have their \fIcolor\fR set to a weighted average of the colors given as argument. This gives a neat gradient effect. .br .B Optional arguments: .I class id .br .B Corresponding command: .I gradient(color,color,option=...) .TP 8 .B --hide \fIOBJECTS\fR Hides all the named objects in the list. Useful for creating animations. .br .B Optional arguments: .I show .br .B Corresponding command: .I hide(objects,option=...) .TP 8 .B --inset \fIBOX\fR Starts a new inset within the given box. If no graph has been started yet, it just creates a new graph using the given box. In short, it does what it seems it should. .br .B Optional arguments: .I class id .br .B Corresponding command: .I inset(box,option=...) .TP 8 .B --next-inset \fIBOX\fR Has the same effet as \fIend\fR followed by \fIinset\fR. Particularly useful for chaining subgraphs. In that case, you might be interested in the grid box specification and \fIsetup-grid\fR. .br .B Optional arguments: .I class id .br .B Corresponding command: .I next-inset(box,option=...) .TP 8 .B --padding \fIDIMENSION\fR When the \fIframe-margins\fR is set to automatic, ctioga2 leaves that much space around the plot on the sides where there are no labels. .br .br .B Corresponding command: .I padding(dimension) .TP 8 .B --plot-scale \fIFLOAT\fR Applies a scaling factor to the whole current subplot. Depending on the 'what' option (default text), the scale applies to: .RS 10 .IP "\fB*\fR" 2 text ('text' or 'both') .IP "\fB*\fR" 2 marker size ('text' or 'both') .IP "\fB*\fR" 2 line widths ('lines' or 'both') Scaling also applies to all elements of the plot that were added before the call to plot-scale. .RE .IP "" 8 .br .B Optional arguments: .I what .br .B Corresponding command: .I plot-scale(float,option=...) .TP 8 .B --region \fI\fR The curves up to the corresponding \fIend\fR will be considered for delimiting a colored region between them. The actual position of the curves with respect to the region can be fine-tuned using the \fIregion-side\fR command (or the corresponding option to \fIplot\fR). .br .B Optional arguments: .I class color id pattern reversed_color reversed_pattern reversed_transparency transparency .br .B Corresponding command: .I region(,option=...) .TP 8 .B --reopen \fIOBJECT\fR Reopens a previously finished container, such as a subplot, a region or a gradient. Provide the unique name you gave as the /id= option to the first command .br .br .B Corresponding command: .I reopen(object) .TP 8 .B --root-plot \fI\fR Begins the root plot. This command is only necessary if you want to give styling information to the root plot. .br .B Optional arguments: .I class id .br .B Corresponding command: .I root-plot(,option=...) .TP 8 .B --setup-grid \fITEXT\fR Sets up a grid of the given layout (such as 2x1). After this command, arguments such as grid:0,1 can be used as the \fIbox\fR argument of \fIinset\fR and \fInext-inset\fR commands. Alternatively, the layout can be specified as 1,2,1x1,4, in which case there are three columns and two rows; the second column is 2 times larger than the other ones, while the second row is four times larger than the first. .br .B Optional arguments: .I bottom dx dy left right top .br .B Corresponding command: .I setup-grid(text,option=...) .TP 8 .B --text-adjust-mode \fITEXT-ADJUST-MODE\fR When this is on (the default), ctioga2 tries to be smart about the size of the text bits around the plot. However, this can be bothersome at times, so you can disable that with this command. .br .br .B Corresponding command: .I text-adjust-mode(text-adjust-mode) .SS Axes and labels Axes and labels .TP 8 .B --axis-style \fIAXIS\fR This command can be used to set various aspects of the style of the given axis, through its various options, which are documented in more details in the \fIdefine-axis-style\fR command -- excepted for the ticks bit which are documented in the \fIticks\fR command. If the option also-axes is specified, the style is also applied to the comma-separated list of axes it contains. .br .B Optional arguments: .I also-axes axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width decoration line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I axis-style(axis,option=...) .TP 8 .B --background-grid \fICOLOR-OR-FALSE\fR Shortcut to set the color for the left and bottom axes .br .B Optional arguments: .I cap style width .br .B Corresponding command: .I background-grid(color-or-false,option=...) .TP 8 .B --background-lines \fIAXIS COLOR-OR-FALSE\fR Sets the color of the background lines for the given axis. .br .B Optional arguments: .I cap style width .br .B Corresponding command: .I background-lines(axis,color-or-false,option=...) .TP 8 .B --bottom \fIAXIS-DECORATION\fR Sets the type of the bottom axis. The options have the same meaning as for \fIdefine-axis-style\fR, see that command for more information. .br .B Optional arguments: .I axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I bottom(axis-decoration,option=...) .TP 8 .B --clear-axes \fI\fR Removes all the axes and their associated labels .br .br .B Corresponding command: .I clear-axes() .TP 8 .B --drawing-frame \fI\fR Setup a drawing frame, ie a frame in which the top-left point is at 0,0, with X and Y values positive over the whole frame, and counted in centimeters (or with the unit given using the /units option, ie /units=mm expressed in millimeters or /units=12pt expressed in multiple of 12 TeX points). .br .B Optional arguments: .I units .br .B Corresponding command: .I drawing-frame(,option=...) .TP 8 .B --label-style \fILABEL\fR Sets the style of the given label (see the type \fIlabel\fR for more information). See \fIdefine-text-style\fR for detailed information about the meaning of the options. The option text permits to also set the text of the label (does not work for ticks). For tick labels, setting the color option also sets the color for the lines of the corresponding axis. If you don't want that, you can override the color using the stroke-color option of \fIaxis-style\fR. This will only work with Tioga version 1.11 or greater. .br .B Optional arguments: .I align alignment angle color halign justification loc position scale shift text text_align text_width valign .br .B Corresponding command: .I label-style(label,option=...) .TP 8 .B --left \fIAXIS-DECORATION\fR Sets the type of the left axis. The options have the same meaning as for \fIdefine-axis-style\fR, see that command for more information. .br .B Optional arguments: .I axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I left(axis-decoration,option=...) .TP 8 .B --new-zaxis \fITEXT\fR Creates a named Z axis that can display information from Z color maps .br .B Optional arguments: .I axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width bar_shift bar_size bounds class decoration id line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset padding stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I new-zaxis(text,option=...) .TP 8 .B --no-title \fI\fR Removes the title of the current plot. .br .br .B Corresponding command: .I no-title() .TP 8 .B --no-xlabel \fI\fR Removes the X label for the current plot. .br .br .B Corresponding command: .I no-xlabel() .TP 8 .B --no-ylabel \fI\fR Removes the Y label for the current plot. .br .br .B Corresponding command: .I no-ylabel() .TP 8 .B --right \fIAXIS-DECORATION\fR Sets the type of the right axis. The options have the same meaning as for \fIdefine-axis-style\fR, see that command for more information. .br .B Optional arguments: .I axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I right(axis-decoration,option=...) .TP 8 .B --ticks \fIAXIS\fR This command can be used to control the location of major and minor ticks and the text of their labels for the given axis. Options available: .RS 10 .IP "\fB*\fR" 2 format the format of the tick labels, using a sprintf-like syntax (see below) .IP "\fB*\fR" 2 format-last the format of the last of the tick labels (useful to include an overall "power-of-ten" factor .IP "\fB*\fR" 2 major a space or comma-separated list of the positions of the major (labeled) ticks .IP "\fB*\fR" 2 minor same for the minor ticks .IP "\fB*\fR" 2 label a comma-separated list of the tick labels (must be the same number of elements as that of the major list). If you must include a comma inside, then use || as a separator. .RE .IP "" 8 Format is a normal sprintf format, with the following additional special codes: .RS 10 .IP "\fB*\fR" 2 %p the "common power of 10": if you divide the tick values by 10 to the power %p, the smallest absolute value will be between 1 and 10 (excluding 0 of course) .IP "\fB*\fR" 2 %b... is the tick value divided by this common power of 10. You *must* follow this spec by a usual sprintf format: %b.3g would get you a number with 3 significant digits .RE .IP "" 8 .br .B Optional arguments: .I format format_last labels major major_delta major_number major_sep minor minor_delta minor_number minor_sep_min .br .B Corresponding command: .I ticks(axis,option=...) .TP 8 .B -t, --title \fITEXT\fR Sets the title of the current plot. .br .B Optional arguments: .I align alignment angle color halign justification loc position scale shift text_align text_width valign .br .B Corresponding command: .I title(text,option=...) .TP 8 .B --top \fIAXIS-DECORATION\fR Sets the type of the top axis. The options have the same meaning as for \fIdefine-axis-style\fR, see that command for more information. .br .B Optional arguments: .I axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I top(axis-decoration,option=...) .TP 8 .B --x2 \fI\fR Switches to using the top axis for X axis for the subsequent curves, and turns on full decoration for the right axis. Shortcut for: xaxis top axis-style top /decoration=full .br .br .B Corresponding command: .I x2() .TP 8 .B --xaxis \fIAXIS\fR Sets the default axis for the X axis for all subsequent commands take rely on default axes (such as \fIplot\fR, \fIxrange\fR, \fIyrange\fR...). .br .br .B Corresponding command: .I xaxis(axis) .TP 8 .B -x, --xlabel \fITEXT\fR Sets the X label of the current plot. .br .B Optional arguments: .I align alignment angle color halign justification loc position scale shift text_align text_width valign .br .B Corresponding command: .I xlabel(text,option=...) .TP 8 .B --y2 \fI\fR Switches to using the right axis for Y axis for the subsequent curves, and turns on full decoration for the right axis. Shortcut for: yaxis right axis-style right /decoration=full .br .br .B Corresponding command: .I y2() .TP 8 .B --yaxis \fIAXIS\fR Sets the default axis for the Y axis for all subsequent commands take rely on default axes (such as \fIplot\fR, \fIxrange\fR, \fIyrange\fR...). .br .br .B Corresponding command: .I yaxis(axis) .TP 8 .B -y, --ylabel \fITEXT\fR Sets the Y label of the current plot. .br .B Optional arguments: .I align alignment angle color halign justification loc position scale shift text_align text_width valign .br .B Corresponding command: .I ylabel(text,option=...) .SS Background Commands dealing with the aspect of the background of a plot (excluding background lines, which are linked to axes). .TP 8 .B --background \fICOLOR-OR-FALSE\fR Sets the background color for the current (and subsequent?) plot. .br .br .B Corresponding command: .I background(color-or-false) .TP 8 .B --watermark \fITEXT\fR Sets a watermark for the background of the current plot. .br .B Optional arguments: .I alignment angle color fill_color font horizontal_scale justification scale stroke_color stroke_width vertical_scale .br .B Corresponding command: .I watermark(text,option=...) .SS Default styles Commands for defining default styles. All commands take the selector of the style to be defined. It is a CSS-like selector, relying on #id and .class, and using #parentality. Therefore, defining a style for .insets #stuff will define it for an object named stuff, but only if it is contained within another one that has a .insets class. ctioga2 does not support changing a style after its use. It may affect only the following objects or all the ones that were created from the beginning, depending on the context. For safety, only define style before issueing any graphics command. .TP 8 .B --define-arrow-style \fITEXT\fR Sets the default style for arrows. All arrow styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the \fIdraw-arrow\fR command. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 color, style and width: same as in \fIdefine-line-style\fR .IP "\fB*\fR" 2 head-marker, tail-marker: a \fImarker\fR to be used for the head or for the tail .IP "\fB*\fR" 2 head-scale, tail-scale: scale of the head or tail markers .IP "\fB*\fR" 2 head-angle, tail-angle: rotate the head or the tail by that many degrees .IP "\fB*\fR" 2 head-color, tail-color: the \fIcolor\fR of the head or tail .RE .IP "" 8 .br .B Optional arguments: .I cap color head_angle head_color head_marker head_scale style tail_angle tail_color tail_marker tail_scale width .br .B Corresponding command: .I define-arrow-style(text,option=...) .TP 8 .B --define-axis-style \fITEXT\fR Sets the style for a whole axis. All axis styles descend from the base style. Horizontal and vertical axis styles descend from the x and y styles, and plot sides are styled with the left, right, top and bottom styles. Axis styles have lots of parameters: .RS 10 .IP "\fB*\fR" 2 axis-label- and tick-label- parameters are title style parameters whose meaning is given in \fIdefine-title-style\fR, that affect ticks and axis labels .IP "\fB*\fR" 2 decoration: a \fIaxis-decoration\fR that specify which ticks and tick labels to draw .IP "\fB*\fR" 2 background-lines- parameters define the style of background lines, as in \fIdefine-line-style\fR .RE .IP "" 8 .br .B Optional arguments: .I axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_lines_cap background_lines_color background_lines_style background_lines_width decoration line_width location log major_tick_length major_tick_width minor_tick_length minor_tick_width offset stroke_color tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform .br .B Corresponding command: .I define-axis-style(text,option=...) .TP 8 .B --define-background-style \fITEXT\fR Sets the style for plot background. All background styles descend from the base style. In addition, the background of a plot is change by the style name background. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 watermark: the text of the watermark .IP "\fB*\fR" 2 all watermark_ styles have the same meaning as in \fIdefine-text-style\fR, as the watermark is a string marker .IP "\fB*\fR" 2 background_color: the color of the background .RE .IP "" 8 .br .B Optional arguments: .I background_color watermark watermark_alignment watermark_angle watermark_color watermark_fill_color watermark_font watermark_horizontal_scale watermark_justification watermark_scale watermark_stroke_color watermark_stroke_width watermark_vertical_scale .br .B Corresponding command: .I define-background-style(text,option=...) .TP 8 .B --define-box-style \fITEXT\fR Sets the default style for boxes. All box styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the \fIdraw-box\fR command. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 color, style and width: same as in \fIdefine-line-style\fR .IP "\fB*\fR" 2 fill-color: fill color for the box .IP "\fB*\fR" 2 fill-transparency: the transparency for the fill, from 0 to 1 .RE .IP "" 8 .br .B Optional arguments: .I cap color fill_color fill_pattern fill_transparency radius shape style width .br .B Corresponding command: .I define-box-style(text,option=...) .TP 8 .B --define-curve-style \fITEXT\fR Sets the default style for the named plot background. .br .B Optional arguments: .I clipped color color_map contour_conrec contour_minor_number contour_minor_scale contour_minor_style contour_minor_width contour_number contour_use_naturals depth error_bar_color error_bar_line_cap error_bar_line_color error_bar_line_style error_bar_line_width fill fill_close_type fill_color fill_pattern fill_transparency legend line_cap line_color line_style line_width location_xaxis location_yaxis marker marker_angle marker_color marker_color_map marker_fill_color marker_fill_color_map marker_line_color marker_line_color_map marker_line_width marker_marker marker_min_scale marker_scale path_style region_position split_on_nan zaxis .br .B Corresponding command: .I define-curve-style(text,option=...) .TP 8 .B --define-image-style \fITEXT\fR Sets the default style for the named image. .br .B Optional arguments: .I aspect_ratio auto_rotate transparency .br .B Corresponding command: .I define-image-style(text,option=...) .TP 8 .B --define-legend-style \fITEXT\fR Sets the style for legends. .br .B Optional arguments: .I dy frame_cap frame_color frame_fill_color frame_fill_pattern frame_fill_transparency frame_padding frame_radius frame_shape frame_style frame_width picto_height picto_to_text picto_width scale symbol_scale text_scale vpadding .br .B Corresponding command: .I define-legend-style(text,option=...) .TP 8 .B --define-line-style \fITEXT\fR Sets the default style for lines. All line styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the \fIdraw-line\fR command. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 color: the color of the line, see \fIcolor\fR .IP "\fB*\fR" 2 style: the line style, see \fIline-style\fR .IP "\fB*\fR" 2 width: the line width (in points) .RE .IP "" 8 --define-line-style * /color=Pink makes all lines pink (unless overriden by the /color option to \fIdraw-line\fR), while --define-line-style .pink /color=Pink only affect those to which the /class=pink style option was given. .br .B Optional arguments: .I cap color style width .br .B Corresponding command: .I define-line-style(text,option=...) .TP 8 .B --define-marker-style \fITEXT\fR Sets the style for marker and marker strings. All marker and marker string styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the \fIdraw-marker\fR or \fIdraw-string-marker\fR commands. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 alignment, justification, angle, color and scale: as in \fIdefine-text-style\fR .IP "\fB*\fR" 2 fill-color and stroke_color: markers are both stroked and filled, you can control all colors in one go using color or specifying each with fill-color and stroke_color .IP "\fB*\fR" 2 font: is a PDF font number (from 1 to 14), only used for marker strings .IP "\fB*\fR" 2 horizontal-scale, vertical-scale: scales the marker only horizontally or vertically .RE .IP "" 8 .br .B Optional arguments: .I alignment angle color fill_color font horizontal_scale justification scale stroke_color stroke_width vertical_scale .br .B Corresponding command: .I define-marker-style(text,option=...) .TP 8 .B --define-oriented-line-style \fITEXT\fR Sets the default style for the named oriented lines. .br .B Optional arguments: .I angle cap color head_angle head_color head_marker head_scale origin style tail_angle tail_color tail_marker tail_scale width .br .B Corresponding command: .I define-oriented-line-style(text,option=...) .TP 8 .B --define-style \fITEXT\fR ... .br .B Optional arguments: .I alignment angle aspect_ratio auto_rotate axis_label_alignment axis_label_angle axis_label_color axis_label_halign axis_label_justification axis_label_loc axis_label_position axis_label_scale axis_label_shift axis_label_text axis_label_text_align axis_label_text_width axis_label_valign background_color background_lines_cap background_lines_color background_lines_style background_lines_width cap clipped color color_map contour_conrec contour_minor_number contour_minor_scale contour_minor_style contour_minor_width contour_number contour_use_naturals decoration depth dy error_bar_color error_bar_line_cap error_bar_line_color error_bar_line_style error_bar_line_width fill fill_close_type fill_color fill_pattern fill_transparency font frame_cap frame_color frame_fill_color frame_fill_pattern frame_fill_transparency frame_padding frame_radius frame_shape frame_style frame_width halign head_angle head_color head_marker head_scale horizontal_scale justification legend line_cap line_color line_style line_width loc location location_xaxis location_yaxis log major_tick_length major_tick_width marker marker_angle marker_color marker_color_map marker_fill_color marker_fill_color_map marker_line_color marker_line_color_map marker_line_width marker_marker marker_min_scale marker_scale minor_tick_length minor_tick_width offset origin path_style picto_height picto_to_text picto_width position radius region_position scale shape shift split_on_nan stroke_color stroke_width style symbol_scale tail_angle tail_color tail_marker tail_scale text text_align text_scale text_width tick_label_alignment tick_label_angle tick_label_color tick_label_halign tick_label_justification tick_label_position tick_label_scale tick_label_shift tick_label_text_align tick_label_text_width tick_label_valign ticks_format ticks_format_last ticks_labels ticks_major ticks_major_delta ticks_major_number ticks_major_sep ticks_minor ticks_minor_delta ticks_minor_number ticks_minor_sep_min ticks_side transform transparency valign vertical_scale vpadding watermark watermark_alignment watermark_angle watermark_color watermark_fill_color watermark_font watermark_horizontal_scale watermark_justification watermark_scale watermark_stroke_color watermark_stroke_width watermark_vertical_scale width zaxis .br .B Corresponding command: .I define-style(text,option=...) .TP 8 .B --define-text-style \fITEXT\fR Sets the default style for texts. All text styles descend from the base style. Use a style different than base by passing its name as the /base-style option to the \fIdraw-text\fR command. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 alignment: vertical alignment .IP "\fB*\fR" 2 justification: horizontal alignment .IP "\fB*\fR" 2 angle: angle in degrees to the horizontal (or default orientation in some cases) .IP "\fB*\fR" 2 color: text color .IP "\fB*\fR" 2 scale: text scale .RE .IP "" 8 .br .B Optional arguments: .I alignment angle color halign justification position scale shift text_align text_width valign .br .B Corresponding command: .I define-text-style(text,option=...) .TP 8 .B --define-title-style \fITEXT\fR Sets the style for title. All title styles descend from the base style. In addition, the title of a plot is addressed by the style name title. Meaning of the style parameters: .RS 10 .IP "\fB*\fR" 2 alignment, justification, angle, color and scale: as in \fIdefine-text-style\fR .IP "\fB*\fR" 2 text: sets the title text .IP "\fB*\fR" 2 loc: the side on which to display the title, a \fIlocation\fR .IP "\fB*\fR" 2 shift: the distance away from the plot in text size units (maybe a dimension should be better later) .IP "\fB*\fR" 2 position: shift from the center (parallel to the plot side) .RE .IP "" 8 .br .B Optional arguments: .I alignment angle color halign justification loc position scale shift text text_align text_width valign .br .B Corresponding command: .I define-title-style(text,option=...) .TP 8 .B --load-style \fIFILE\fR ... .br .br .B Corresponding command: .I load-style(file) .SS Output setup Commands in this group deal with various aspects of the production of output files: .RS 2 .IP "\fB*\fR" 2 output file location .IP "\fB*\fR" 2 post-processing (including automatic display) .IP "\fB*\fR" 2 cleanup... .RE .TP 8 .B --[no-]clean \fI\fR When this is on (the default), ctioga2 automatically cleans up intermediate files produced by Tioga. When LaTeX fails, it can be useful to have a closer look at them, so disable it to be able to look into them. .br .br .B Corresponding command: .I clean(boolean) .TP 8 .B --[no-]cleanup-pdf \fI\fR If this is on, then ctioga2 uses ghostscript to cleanup the PDF file produced. It is on by default is ctioga2 is able to find the gs executable. .br .br .B Corresponding command: .I cleanup-pdf(boolean) .TP 8 .B --dependencies \fIFILE\fR Saves the dependencies as a Makefike into the given file name. .br .br .B Corresponding command: .I dependencies(file) .TP 8 .B --[no-]eps \fI\fR When this feature is on, all produced PDF files are converted to EPS using the pdftops program (from the xpdf tools suite). .br .br .B Corresponding command: .I eps(boolean) .TP 8 .B --[no-]mark \fI\fR When this feature is on (which is the default, as it comes in very useful), the 'title' field of the PDF informations is set to the command-line that resulted in the PDF file. Disable it if you don't want any information to leak. Please note that this will not log the values of the CTIOGA2_PRE and CTIOGA2_POST variables, so you might still get a different output if you make heavy use of those. .br .br .B Corresponding command: .I mark(boolean) .TP 8 .B -n, --name \fIFIGURE_NAME\fR Sets the name of the figure, which is also the base name for the output file. This has nothing to do with the title of the plot, which can be set using the command \fItitle\fR. If the name contains a %, it is interpreted by ctioga2 as a printf-like format. It will attempt to find the first file that does not exist, feeding it with increasing numbers. The default value is now Plot-%03d, which means you'll get increasing numbers automatically. .br .br .B Corresponding command: .I name(figure name) .TP 8 .B --open \fI\fR Uses open (available on MacOS) to view the PDF files produced by ctioga2. .br .br .B Corresponding command: .I open() .TP 8 .B -o, --output \fIFIGURE_NAME\fR Writes a figure with the given name (see \fIname\fR) and keeps the current state. This can be used to create an animation. .br .br .B Corresponding command: .I output-now(figure name) .TP 8 .B --output-and-reset \fI\fR Writes the current figure and starts a fresh one. All non-graphical information are kept (curves loaded, figure names, preamble, and so on). .br .br .B Corresponding command: .I output-and-reset() .TP 8 .B -O, --output-directory \fITEXT\fR Sets the directory to which files will be plot. It defaults to the current directory. .br .br .B Corresponding command: .I output-directory(text) .TP 8 .B -r, --page-size \fITEXT\fR Sets the size of the output PDF file, in real units. Takes arguments in the form of 12cm x 3in (spaces can be omitted). .br .B Optional arguments: .I count-legend .br .B Corresponding command: .I page-size(text,option=...) .TP 8 .B --png \fIRESOLUTION\fR Turns all produced PDF files into PNG images of the given resolution using convert. This also has for effect to set the \fIpage-size\fR to the resolution divided by the 'scale' option in Postscript points. By default, 2 pixels are rendered for 1 final to produce a nicely antialiased image. Use the 'oversampling' option to change that, in case the output looks too pixelized. This option only affects conversion time. .br .B Optional arguments: .I oversampling pdftoppm scale .br .B Corresponding command: .I png(resolution,option=...) .TP 8 .B --resolution \fIFLOAT\fR By default, ctioga2 has a resolution of 1/100th of a postscript point. This is clearly enough for most tasks, but you can increase it should you need, or decrease it to generate possibly a little more jaggy but less large PDF files. The number given is the number of output points per postscript point. Better change that at the beginning of the plot. .br .br .B Corresponding command: .I resolution(float) .TP 8 .B --[no-]svg \fI\fR When this feature is on, all produced PDF files are converted to SVG using the neat pdf2svg program. .br .br .B Corresponding command: .I svg(boolean) .TP 8 .B --viewer \fITEXT\fR Sets the command for viewing the PDF file after ctioga2 has been run. .br .br .B Corresponding command: .I viewer(text) .TP 8 .B -X, --xpdf \fI\fR Uses xpdf to view the PDF files produced by ctioga2. If xpdf is not found, then it tries to guess which viewers are available: .RS 10 .IP "\fB*\fR" 2 on windows, it uses the system file associations to open the PDF file .IP "\fB*\fR" 2 on mac, it uses the open command .IP "\fB*\fR" 2 on linux, it tries, mime-open, and if that is missing, falls back to commonly available PDF viewers. .RE .IP "" 8 .br .br .B Corresponding command: .I xpdf() .SS Data stack manipulation Commands for manipulation of the data stack .TP 8 .B --append \fIDATASET\fR Use the current backend to load the given dataset(s) and append to the last dataset on the stack (without creating a new dataset). Roughly the equivalent of first running \fIload\fR and then \fIjoin-datasets\fR. .br .B Optional arguments: .I as ignore_hooks where .br .B Corresponding command: .I append(dataset,option=...) .TP 8 .B --apply-formula \fITEXT\fR Applies a formula to the last dataset (or the named one) .br .B Optional arguments: .I name which .br .B Corresponding command: .I apply-formula(text,option=...) .TP 8 .B --bin \fI\fR This command bins the contents of the Y column of the last dataset on the stack, and pushes the results as a new dataset. .br .B Optional arguments: .I column delta max min name normalize number which .br .B Corresponding command: .I bin(,option=...) .TP 8 .B --compute-contour \fIFLOAT\fR Computes the contour at the given level for the given dataset (or the last on the stack if none is specified) and pushes it onto the data stack. You can further manipulate it as usual. .br .B Optional arguments: .I which .br .B Corresponding command: .I compute-contour(float,option=...) .TP 8 .B --dataset-hook \fICOMMANDS\fR The dataset hook is a series of commands such as those in the command files that are run every time after a dataset is added onto the data stack. Its main use is to provide automatic filtering of data, but any arbitrary command can be used, so enjoy ! .br .br .B Corresponding command: .I dataset-hook(commands) .TP 8 .B --dataset-hook-add \fICOMMANDS\fR Adds the given commands to the dataset hook. See \fIdataset-hook\fR for more information about the dataset hook. .br .br .B Corresponding command: .I dataset-hook-add(commands) .TP 8 .B --dataset-hook-clear \fI\fR Clears the dataset hook. See \fIdataset-hook\fR for more information. .br .br .B Corresponding command: .I dataset-hook-clear() .TP 8 .B --drop \fISTORED-DATASET\fR Removes the given dataset from the stack. Can become useful when dealing with large datasets, some of which are only used as intermediates for \fIapply-formula\fR or \fIcompute-contour\fR, for instance. .br .br .B Corresponding command: .I drop(stored-dataset) .TP 8 .B -j, --join-datasets \fI\fR Pops the last two (or number, if it is specified) datasets from the stack, concatenates them (older last) and push them back onto the stack. The name option can be used to give a name to the new dataset. .br .B Optional arguments: .I name number which .br .B Corresponding command: .I join-datasets(,option=...) .TP 8 .B -L, --load \fIDATASET\fR Use the current backend to load the given dataset(s) onto the data stack. If the name option is given, the last dataset loaded this way (if dataset expansion occurs) gets named, or, if it contains a %d (or similar construct), each dataset gets named with %d replace with the number of the dataset within the expansion (starting at 0). This name can be used to further use the dataset without remembering its number. See the type \fIstored-dataset\fR for more information. .br .B Optional arguments: .I as ignore_hooks name where .br .B Corresponding command: .I load(dataset,option=...) .TP 8 .B --make-contour \fIFLOAT\fR .br .B Optional arguments: .I as ignore_hooks name where which .br .B Corresponding command: .I make-contour(float,option=...) .TP 8 .B --merge-datasets \fI\fR This commands merges data with matching X values from a dataset (by default the one before the last) into the last one. Data points that have no corresponding X value in the current dataset are simply ignored. If the columns option is provided, the numbered columns are use instead of the X columns (X is 1). More than one column can be provided this way, in which case *all* values must match. This can be used to build 3D datasets for \fIxyz-map\fR or \fIxy-parametric\fR. .br .B Optional arguments: .I columns number precision which .br .B Corresponding command: .I merge-datasets(,option=...) .TP 8 .B -P, --print-dataset \fI\fR Prints to standard output data contained in the last dataset pushed onto the stack, or the given stored dataset if the which option is given. .br .B Optional arguments: .I save which .br .B Corresponding command: .I print-dataset(,option=...) .TP 8 .B --show-stack \fI\fR Displays the current contents of the dataset stack. Mostly used for debugging when operations like \fImerge-datasets\fR or \fIjoin-datasets\fR don't work as expected. .br .br .B Corresponding command: .I show-stack() .TP 8 .B --xy-reglin \fI\fR ... This command will get documented some day. .br .B Optional arguments: .I linear which .br .B Corresponding command: .I xy-reglin(,option=...) .SS Introspection Commands displaying information about the internals of ctioga2, such as known types/commands/backends... .TP 8 .B --edit-command \fITEXT\fR Edit the given command in an editor. It will only work from the top directory of a ctioga2 source tree. .br .B Optional arguments: .I doc .br .B Corresponding command: .I edit-command(text,option=...) .TP 8 .B --edit-group \fITEXT\fR Edit the given group in an editor. It will only work from the top directory of a ctioga2 source tree. .br .br .B Corresponding command: .I edit-group(text) .TP 8 .B --edit-type \fITEXT\fR Edit the given type in an editor. It will only work from the top directory of a ctioga2 source tree. .br .br .B Corresponding command: .I edit-type(text) .TP 8 .B --list-commands \fI\fR List all commands known to ctioga2 .br .B Optional arguments: .I format raw .br .B Corresponding command: .I list-commands(,option=...) .TP 8 .B --list-groups \fI\fR List all command groups known to ctioga2 .br .B Optional arguments: .I raw .br .B Corresponding command: .I list-groups(,option=...) .TP 8 .B --list-styles \fI\fR Lists all available color sets, marker sets and the like. .br .B Optional arguments: .I raw .br .B Corresponding command: .I list-styles(,option=...) .TP 8 .B --list-types \fI\fR List all types known to ctioga2 .br .B Optional arguments: .I raw .br .B Corresponding command: .I list-types(,option=...) .TP 8 .B --version-raw \fI\fR Prints the raw version number, without any other decoration and newline. .br .br .B Corresponding command: .I version-raw() .SS Filters The commands in this group act upon the last dataset pushed unto the data stack: they can be viewed as filters. .TP 8 .B --avg-dup \fI\fR Install the \fIavg-dup-last\fR command as a dataset hook (see \fIdataset-hook\fR): all datasets acquired after this is on will be averaged if they have identical successive values of X. .br .br .B Corresponding command: .I avg-dup() .TP 8 .B --avg-dup-last \fI\fR Averages successive points with identical X values. This algorithm is naive with respect to the min/max values and averages them just as well, whereas one might expect something more clever. To average over all X values when they are not successive in the dataset, you should use \fIsort-last\fR first. .br .B Optional arguments: .I mode .br .B Corresponding command: .I avg-dup-last(,option=...) .TP 8 .B --cherry-pick \fITEXT\fR Install the \fIcherry-pick-last\fR command as a dataset hook (see \fIdataset-hook\fR): all points for which the formula returns false for subsequent datasets will be removed. .br .br .B Corresponding command: .I cherry-pick(text) .TP 8 .B --cherry-pick-last \fITEXT\fR Removes the data from the last dataset in the data stack for which the formula returns false. See also the \fIcherry-pick\fR command to apply the selection to all datasets. You might find it much easier to use the /where option of the \fIplot\fR or \fIload\fR commands. .br .br .B Corresponding command: .I cherry-pick-last(text) .TP 8 .B --smooth \fIINTEGER\fR Install the \fIsmooth-last\fR command as a dataset hook (see \fIdataset-hook\fR): from now on, the datasets are all smoothed .br .br .B Corresponding command: .I smooth(integer) .TP 8 .B --smooth-last \fIINTEGER\fR Smooth the data using a simple (naive even) gaussian filter. Good for producing 'lines to guide the eye' .br .br .B Corresponding command: .I smooth-last(integer) .TP 8 .B --sort \fI\fR Install the \fIsort-last\fR command as a dataset hook (see \fIdataset-hook\fR): all subsequent datasets will be sorted according to their X values. .br .br .B Corresponding command: .I sort() .TP 8 .B --sort-last \fI\fR Sorts the last dataset pushed unto the stack according to X values. Can be used as a filter. This command sorts in-place. See also \fIsort\fR. .br .br .B Corresponding command: .I sort-last() .TP 8 .B --trim \fIINTEGER\fR Install the \fItrim-last\fR command as a dataset hook (see \fIdataset-hook\fR): all subsequent datasets will be trimmed to keep only every n point. .br .br .B Corresponding command: .I trim(integer) .TP 8 .B --trim-last \fIINTEGER\fR Only keeps one every ? data point on the last dataset pushed unto the data stack. Useful when data have too many points to avoid creating heavy PDF files that take ages to display with no additional benefits. This operation is very crude and does not average data. See also \fItrim\fR. .br .br .B Corresponding command: .I trim-last(integer) .SS General commands General scope commands .TP 8 .B --debug \fI\fR With this on, ctioga2 writes a whole lot of debugging information. You probably will not need that unless you intend to file a bug report or to tackle a problem yourself. Be warned that it *will* slow down very significantly the processing of ctioga2 (up to hundreds of times slower), especially if you are not redirecting the output to a file. .br .br .B Corresponding command: .I debug() .TP 8 .B --echo \fI\fR Writes the whole command-line used to standard error, quoted in such a way that it should be usable directly for copy/paste. .br .br .B Corresponding command: .I echo() .TP 8 .B -e, --eval \fICOMMANDS\fR Runs the given strings as commands, as if given from a command file. .br .br .B Corresponding command: .I eval(commands) .TP 8 .B -f, --file \fIFILE\fR Reads the file and runs commands found in them, using the ctioga language. ctioga2 -f my_file.ct2 If the /log is on, then all messages are written to a -log.txt file instead of to the terminal. .br .B Optional arguments: .I log .br .B Corresponding command: .I include(file,option=...) .TP 8 .B -h, --help \fI\fR Prints helps about short and long options available when run from the command-line. .br .B Optional arguments: .I pager .br .B Corresponding command: .I command-line-help(,option=...) .TP 8 .B --help-on \fITEXT\fR Prints help about the given command .br .br .B Corresponding command: .I help-on(text) .TP 8 .B --[no-]pause \fI\fR When this is on, the program will ask for confirmation before finishing, when errors or warnings have been shown. This is especially useful on windows or other environments where the terminal shuts down as soon as ctioga2 has finished. .br .br .B Corresponding command: .I pause(boolean) .TP 8 .B --print-instructions \fI\fR Writes the list of all the instructions run so far. This is not very helpful for now, possibly. .br .br .B Corresponding command: .I print-instructions() .TP 8 .B --ruby-run \fIFILE\fR Reads the file and runs the Ruby code found inside, a bit like Ruby would do with the require command, excepted that ctioga2 does not follow Ruby's file searching rules: you have to specify the full path. .br .br .B Corresponding command: .I ruby-run(file) .TP 8 .B --set \fITEXT TEXT\fR Sets the value of the variable (first argument) to the given second argument. No parsing is done. .br .br .B Corresponding command: .I set(text,text) .TP 8 .B -v, --verbose \fI\fR With this on, ctioga2 outputs quite a fair amount of informative messages. .br .br .B Corresponding command: .I verbose() .TP 8 .B -V, --version \fI\fR Prints the version of ctioga in use .br .br .B Corresponding command: .I version() .SH TYPES Most of the commands accept one or more arguments, which have different types. Here are the meanings of those types. .TP 8 .I aligned-point A point together with alignment specifications, used to place some elements such as legends for instance, that require alignment information. The first two letters represent the alignment: .RS 10 .IP "\fB*\fR" 2 t for top .IP "\fB*\fR" 2 b for bottom .IP "\fB*\fR" 2 c for center .IP "\fB*\fR" 2 l for left and .IP "\fB*\fR" 2 r for right .RE .IP "" 8 These letters can optionally be followed by the exact location of the point in frame coordinates. If not provided, a reasonable default value is chosen. Examples: .RS 10 .IP "\fB*\fR" 2 tl is a point at the top left of the frame aligned to the top and left; .IP "\fB*\fR" 2 cl:0.1,0.6 is vertically centered and aligned to the left, and positioned 10% from the left and 60% from the bottom. .RE .IP "" 8 .TP .I alignment Vertical aligment for text. Can be one of: .RS 10 .IP "\fB*\fR" 2 t or top .IP "\fB*\fR" 2 c, center, m or midheight (vertically centered) .IP "\fB*\fR" 2 B, Baseline or baseline to align at the baseline .IP "\fB*\fR" 2 b or bottom .RE .IP "" 8 .TP .I aspect-ratio How the \fIdraw-image\fR command respects the original image aspect ratio: .RS 10 .IP "\fB*\fR" 2 ignore (the default) ignores the original aspect ratio .IP "\fB*\fR" 2 expand expand the original box to respect aspect ratio .IP "\fB*\fR" 2 contract contract the original box to respect aspect ratio .RE .IP "" 8 .TP .I average-mode How the \fIavg-dup-last\fR command : .RS 10 .IP "\fB*\fR" 2 naive or average (the default) treats all columns (values and error bars) the same way, and average everythin .IP "\fB*\fR" 2 stddev ignores the original errors, and sets the new errors to the standard deviation of the values .RE .IP "" 8 .TP .I axis The name of the axis of a plot. It can be: .RS 10 .IP "\fB*\fR" 2 left, top, bottom or right; .IP "\fB*\fR" 2 x, xaxis, y, yaxis, which return one of the above depending on the preferences of the current plot (see \fIxaxis\fR and \fIyaxis\fR to change them); .IP "\fB*\fR" 2 one of the named axes, such as the ones created by \fInew-zaxis\fR. .RE .IP "" 8 .TP .I axis-decoration Kinds of decoration on a axis line, such as nothing, lines, ticks, tick labels. Possible values: .RS 10 .IP "\fB*\fR" 2 hidden, off, no, none: no axis at all .IP "\fB*\fR" 2 line: only a line .IP "\fB*\fR" 2 ticks: only ticks .IP "\fB*\fR" 2 major: only major ticks .IP "\fB*\fR" 2 major-num: major ticks along with their labels .IP "\fB*\fR" 2 full: major ticks and labels + minor ticks .RE .IP "" 8 .TP .I axis-or-auto Same thing as \fIaxis\fR, or auto to let the style factory handle automatically. .TP .I bijection A pair of functions of x specifying a bidirectional coordinate transformation separated by a double colon (::), in the order from::to. Each of the functions must be valid Ruby code - it is not exactly mathematical functions, in particular Ruby does not like floats which are missing digits on either side of the dot : for instance, .3 and 1. are not valid. Sorry. In most of the usual cases, the coordinate transform is an involution, that is from and to is the same function (this is the case for a/x). In this case, you can omit the second function. .TP .I boolean Yes or no. .TP .I boolean-or-auto Same thing as \fIboolean\fR, or auto to let the style factory handle automatically. .TP .I box The specification for a box, such as an inset. It can be a grid specification, such as grid:0,1. For this to work, a grid must have been setup beforehand using \fIsetup-grid\fR. It can also be an \fIaligned-point\fR together with a width and optionally a height in frame coordinates, such as: .RS 10 .IP "\fB*\fR" 2 cc:0.3: a box in the center of size 30% width and 30% height; .IP "\fB*\fR" 2 bl:0.1,0.2:0.7,0.2 a box starting from the point at 10% from the left and 20% from the bottom, with a width of 70% and a height of 20%. .RE .IP "" 8 .TP .I box-shape The shape of a box. It can be: .RS 10 .IP "\fB*\fR" 2 square for a plain square box .IP "\fB*\fR" 2 round for a rounded box .RE .IP "" 8 .TP .I color A color. It can take three forms: .RS 10 .IP "\fB*\fR" 2 a named color, see \fIhttp://tioga.rubyforge.org/doc/classes/Tioga/ColorConstants.html\fR for the list of color names. .IP "\fB*\fR" 2 an HTML color: for instance, #f00 or #ff0000 is red; .IP "\fB*\fR" 2 a list of three numbers between 0 and 1: 1,0,0 is red too. .RE .IP "" 8 .TP .I color-or-auto Same thing as \fIcolor\fR, or auto to let the style factory handle automatically. .TP .I color-or-false A \fIcolor\fR, or none to say that nothing should be drawn. .TP .I color-or-false-or-auto Same thing as \fIcolor-or-false\fR, or auto to let the style factory handle automatically. .TP .I color-or-false-set Sets of \fIcolor-or-false\fR .TP .I color-set Sets of \fIcolor\fR .TP .I colormap A Z color map. It takes the form Color1--Color2--Color3.... All colors can optionally be followed by a number. For instance, for Red--Blue--Pink--Green, the colors are evenly spaced. In the case Red--Blue(0.1)--Pink(0.2)--Green, the Blue to Pink strech is located between Z values 0.1 and 0.2. If a prefix hls: or wheel: is present, then linear interpolation is done in the HLS colorspace instead of the RGB one (the default). If a suffix :sym:_value_ is present, then the colormap is symmetric around that value. It is also possible to directly use a \fIcolor-set\fR, in which case eveything works as if the colors of the \fIcolor-set\fR had been given directly, without Z values. .TP .I colormap-or-auto Same thing as \fIcolormap\fR, or auto to let the style factory handle automatically. .TP .I commands ctioga2 commands, such as the ones that could be found in command files. .TP .I compute-dx This controls how the histograms treats unevenly spaced X values: .RS 10 .IP "\fB*\fR" 2 none: ignores the problem, and treats the points as if they were all evenly spaced .IP "\fB*\fR" 2 min, mindx: considers that all slots have the size of the smallest variation of X values .RE .IP "" 8 .TP .I cumulative-histograms How to specify that histograms should be stacked. Can be: .RS 10 .IP "\fB*\fR" 2 a positive number, in which case the following histograms will be added to the numbered one (0 is the first) .IP "\fB*\fR" 2 no/false, in which case the following histograms are not stacked .IP "\fB*\fR" 2 next, in which case the following histograms get stacked on a new slot .RE .IP "" 8 .TP .I data-point A point from an already-loaded Dataset. You have two ways to choose the point: .RS 10 .IP "\fB*\fR" 2 @13 takes the 13th point in the last dataset; .IP "\fB*\fR" 2 0.2 takes the point the closest to 20% of the dataset. .RE .IP "" 8 If you need another dataset than the last one, give its number or named within brackets: {-2}0.2 is the point closest to the 20% of the one-before-last dataset. .TP .I dataset One expandable dataset. .TP .I dimension A dimension, in absolute units, or in units of text height, figure, frame or page coordinates. It is in the form value unit where value is a number and unit can be one of pt, bp, in, cm (absolute units, same meaning as in TeX), dy (1.0 dy is the height of a text line), figure or f (for figure coordinates, i.e. the coordinates of the plot), frame or F (1.0 frame is the full size of the current subplot) and page or p (1.0 page is the whole height/width of the output file). It can also be auto, which is 1.0 in frame units (ie the width or the height of the current plot). .TP .I dimension-or-no A \fIdimension\fR, or no or none. .TP .I drawing-spec A ctioga 1 --draw specification. .TP .I file A file name. .TP .I fill-pattern A fill pattern, one of: .RS 10 .IP "\fB*\fR" 2 lines:_angle_,_distance_,_width_ .IP "\fB*\fR" 2 vlines:_distance_,_width_ .IP "\fB*\fR" 2 hlines:_distance_,_width_ .IP "\fB*\fR" 2 xlines:_distance_,_width_,_angle_ .IP "\fB*\fR" 2 solid or plain .RE .IP "" 8 The first three are lines, of arbitrary orientation for lines, vertical for vlines and horizontal for hlines. xlines correspond to crossed perpendicular lines (the _angle_ is 45 by default). For these styles, the _distance_ and _width_ are all optional and correspond respectively to the distance between the lines and the line width. solid or plain correspond to solid fill (i.e. not patterned). .TP .I fill-pattern-or-auto Same thing as \fIfill-pattern\fR, or auto to let the style factory handle automatically. .TP .I fill-until How to close the path of a curve to fill it. Can be: .RS 10 .IP "\fB*\fR" 2 bottom, top, left, right to fill until the named side of the plot .IP "\fB*\fR" 2 axis or xaxis to fill until the X axis (ie y = 0) .IP "\fB*\fR" 2 yaxis to fill until the Y axis (ie x = 0) .IP "\fB*\fR" 2 x:value or x=value to fill until the given X value .IP "\fB*\fR" 2 y:value or y=value to fill until the given Y value .IP "\fB*\fR" 2 close for just closing the path (doesn't look good in general) .IP "\fB*\fR" 2 none for no fill .RE .IP "" 8 .TP .I fill-until-or-auto Same thing as \fIfill-until\fR, or auto to let the style factory handle automatically. .TP .I fill-until-set Sets of \fIfill-until\fR .TP .I float A floating-point number. .TP .I float-list A list of space-separated or comma-separated floating point numbers. .TP .I float-or-auto Same thing as \fIfloat\fR, or auto to let the style factory handle automatically. .TP .I float-or-false A floating-point number, or none. .TP .I float-or-false-or-auto Same thing as \fIfloat-or-false\fR, or auto to let the style factory handle automatically. .TP .I float-range A beginning:end range. .TP .I float-set Sets of \fIfloat\fR .TP .I frame-margins Margins around a plot, ie the distance from the side of the plot to the corresponding side of the container (most likely the whole PDF). It can take three forms: .RS 10 .IP "\fB*\fR" 2 dimension (applies to all sides) .IP "\fB*\fR" 2 left_right, top_bottom .IP "\fB*\fR" 2 left, right, top, bottom .RE .IP "" 8 Each of these elements is a valid \fIdimension\fR. It can also be auto, in which case the position of the margins is computed automatically to accomodate the various labels/ticks. .TP .I integer An integer. .TP .I integer-list A list of space-separated or comma-separated integers .TP .I integer-or-auto Same thing as \fIinteger\fR, or auto to let the style factory handle automatically. .TP .I internal-format Output format for internals. .TP .I justification Horizontal aligment of the (with respect to its location). Can be one of: .RS 10 .IP "\fB*\fR" 2 l or left .IP "\fB*\fR" 2 c, center .IP "\fB*\fR" 2 r, right .RE .IP "" 8 .TP .I label The name of an label. It can be: .RS 10 .IP "\fB*\fR" 2 title to mean the current plot's title. .IP "\fB*\fR" 2 axis_tick or axis_ticks or simply axis, where axis is a a valid \fIaxis\fR. It designates the ticks of the named axis. .IP "\fB*\fR" 2 axis_label, same as above but targets the label of the named axis. .RE .IP "" 8 .TP .I latex-font A LaTeX font. @todo document ! .TP .I level A level on a XYZ map (that is, just a Z value). .TP .I line-cap A line cap style, i.e. how the line extends beyond its last point. Available choices: .RS 10 .IP "\fB*\fR" 2 round (extends as a half circle default) .IP "\fB*\fR" 2 butt (does not extend at all) .IP "\fB*\fR" 2 square (extends as a half square) .RE .IP "" 8 .TP .I line-cap-or-auto Same thing as \fIline-cap\fR, or auto to let the style factory handle automatically. .TP .I line-style A line style, which is one of solid, dots, dashes, small_dots, a series of comma-separated numbers which are the length of the strokes and gaps, or no, none or off to mean no line. .TP .I line-style-or-auto Same thing as \fIline-style\fR, or auto to let the style factory handle automatically. .TP .I line-style-set Sets of \fIline-style\fR .TP .I location A position on the plot, referenced with respect to the sides. Can be: .RS 10 .IP "\fB*\fR" 2 left .IP "\fB*\fR" 2 right .IP "\fB*\fR" 2 top .IP "\fB*\fR" 2 bottom .IP "\fB*\fR" 2 x0, for the x = 0 position .IP "\fB*\fR" 2 y0, for the y = 0 position .RE .IP "" 8 In addition, there will one day be the possibility to specify an offset from these locations. But that is still something to do. .TP .I marker A Tioga Marker, ie either a name from the list at \fIhttp://tioga.rubyforge.org/doc/Tioga/MarkerConstants.html\fR, such as Box, Star, Spade or two or three comma-separated numbers, _font_, _number_ and _width_. _font_ defines the font (standard PDF fonts, from 1 to 14), _number_ the number of the character within the font (between 0 and 255), and if _width_ is specified, the marker is stroked and not filled, and the number is the line width for the stroke. .TP .I marker-or-auto Same thing as \fImarker\fR, or auto to let the style factory handle automatically. .TP .I marker-set Sets of \fImarker\fR .TP .I object A named object (whose name was given using the /id= option to the appropriate command). .TP .I objects A list of comma-separated \fIobject\fRs, or a class specification starting with a . .TP .I partial-float-range A beginning:end range, where either of the endpoints can be ommitted. .TP .I pdf-font A number between 1 and 14 that designates one of the 14 standard PDF fonts. (see for instance \fIhttp://tioga.rubyforge.org/doc/classes/Tioga/MarkerConstants.html\fR for more information). .TP .I point A given point on a figure. .TP .I regexp A plain string or a regular expression (the latter being enclosed within /.../). .TP .I region-side Within a \fIregion\fR, designates the position of the curve with respect to the region: .RS 10 .IP "\fB*\fR" 2 above .IP "\fB*\fR" 2 below .IP "\fB*\fR" 2 ignore if this curve is not to be taken into account .RE .IP "" 8 .TP .I region-side-or-auto Same thing as \fIregion-side\fR, or auto to let the style factory handle automatically. .TP .I region-side-set Sets of \fIregion-side\fR .TP .I stored-dataset A dataset that has already been loaded. It is either: .RS 10 .IP "\fB*\fR" 2 A number, in which case it specifies the index inside the stack. 0 is the first on that was pushed onto the stack (the oldest dataset), 1 the second, -1 the last one, -2 the one before the last and so on. (it works just like Ruby's arrays). .IP "\fB*\fR" 2 The name of a named dataset. .IP "\fB*\fR" 2 # followed by the id of a plot element .RE .IP "" 8 .TP .I style-aspect This type designs which aspect of the style of a \fIxy-parametric\fR plot is controlled by a certain Z value. It can take the following values: .RS 10 .IP "\fB*\fR" 2 marker_color: the color for the markers .IP "\fB*\fR" 2 marker_size/marker_scale: the size of the markers .RE .IP "" 8 .TP .I text Plain text. .TP .I text-adjust-mode Mode for text size adjustment .RS 10 .IP "\fB*\fR" 2 old for the old style heuristics .IP "\fB*\fR" 2 both for both the old style heuristics and the measures, taking whichever of those is the biggest .IP "\fB*\fR" 2 measure for only measured text size (but watch out for axis ticks !) .RE .IP "" 8 .TP .I text-align Horizontal aligment for text within its box. Only of use for texts with a given text width. Can be one of: .RS 10 .IP "\fB*\fR" 2 l or left .IP "\fB*\fR" 2 c, center .IP "\fB*\fR" 2 r, right .IP "\fB*\fR" 2 no or none to not issue aligning commands, in which case you get full LaTeX-justified paragraphs (probably with a lot of hyphens). .RE .IP "" 8 .TP .I text-list A list of comma-separated texts. If you must include a comma inside the texts, then use || as a separator. .TP .I text-or-auto Same thing as \fItext\fR, or auto to let the style factory handle automatically. .TP .I text-set Sets of \fItext\fR .TP .I ticks-side On what side of an axis line are the ticks positioned: .RS 10 .IP "\fB*\fR" 2 inside: on the inside .IP "\fB*\fR" 2 outside: on the outside .IP "\fB*\fR" 2 both: on both the inside and the outside .RE .IP "" 8 .SH ENVIRONMENT VARIABLES If the environment variables .B CTIOGA2_PRE or .B CTIOGA2_POST are set, they are split into words according to shell rules (see the Shellwords.shellwords ruby function for more information) and prepended or appended to the command-line arguments. They don't leave any trace in the actual command-line (so, for instance, .B --echo won't be aware of them). .SH AUTHOR .B ctioga2 was written by Vincent Fourmond. .B Tioga was written by Bill Paxton. .SH BUGS .B ctioga2 is most certainly not bug-free. You can use the facility at .B rubyforge.org to report any bug you notice: .IR http://rubyforge.org/tracker/?group_id=8218 . You can also use the same facility for feature requests and to provide use with patches. Alternatively, you can use the forums at .I http://rubyforge.org/forum/?group_id=8218 or the .I ctioga2-users@rubyforge.org mailing list to report any kind of problems or suggestions. .SH "SEE ALSO" .BR xpdf (1), .BR pdflatex (1), .BR open (1), .BR gnuplot (1), .BR ctioga "(1) (the original ctioga)" The original tarball includes an .I examples/ with various examples demonstrating different features of .B ctioga2\fR, and in particular the different ways to use it: command-line or command-file. It also includes a .I tests/ directory containing test shell scripts. Runnning these shell scripts should give you a decent idea of .BR ctioga2 's possibilities while assuring that it did install properly. Useful information, documentation and most up-to-date news can be found at .BR ctioga2 's website, at .IR http://ctioga2.rubyforge.org/ . More information about .B Tioga and its rdoc documentation can be found at .IR http://www.kitp.ucsb.edu/~paxton/tioga.html .