mscgen(1) [debian man page]
MSCGEN(1) User Commands MSCGEN(1) NAME
mscgen - Message Sequence Chart Renderer SYNOPSIS
mscgen -T type [ -o file ] [ -i ] infile mscgen -l DESCRIPTION
Mscgen is a small program that parses Message Sequence Chart descriptions and produces PNG, EPS, SVG or server side image maps (ismaps) as the output. Message Sequence Charts (MSCs) are a way of representing entities and interactions over some time period and are often used in combination with SDL. MSCs are popular in Telecoms to specify how protocols operate although MSCs need not be complicated to create or use. Mscgen aims to provide a simple text language that is clear to create, edit and understand, which can also be transformed into images. OPTIONS
-T type Specifies the output file type, which maybe one of 'png', 'eps', 'svg' or 'ismap' -i infile The file from which to read input. If omitted or specified as '-', input will be read from stdin. The '-i' option maybe omitted if <infile> is specified as the last option. -o file Write output to the named file. This option must be specified if input is taken from stdin, otherwise the output filename defaults to <infile>.<type>. -F font Use specified font for rendering PNG output. This is only supported if mscgen was built with USE_FREETYPE and is ignored otherwise. -p Display the parsed msc as text to stdout. This is useful only for checking the parser. -l Display program licence and exit. EXAMPLE
The language interpreted by mscgen is similar to that of Graphviz dot, using simple text instructions to add entities and then message arcs. The following example shows the input for a simple message sequence chart. # MSC for some fictional process msc { a,b,c; a->b [ label = "ab()" ] ; b->c [ label = "bc(TRUE)"]; c=>c [ label = "process(1)" ]; c=>c [ label = "process(2)" ]; ...; c=>c [ label = "process(n)" ]; c=>c [ label = "process(END)" ]; a<<=c [ label = "callback()"]; --- [ label = "If more to run", ID="*" ]; a->a [ label = "next()"]; a->c [ label = "ac1() ac2()"]; b<-c [ label = "cb(TRUE)"]; b->b [ label = "stalled(...)"]; a<-b [ label = "ab() = FALSE"]; } More information on the input can be found at http://www.mcternan.co.uk/mscgen/. COPYRIGHT
Mscgen, Copyright (C) 2010 Michael C McTernan, Michael.McTernan.2001@cs.bris.ac.uk 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. PNG rendering by libgd, www.libgd.org. SEE ALSO
http://www.mcternan.co.uk/mscgen/ mscgen-0.20 2011-03-05 MSCGEN(1)
Check Out this Related Man Page
ColumnInfo(3pm) LogReport's Lire Documentation ColumnInfo(3pm) NAME
Lire::Report::ColumnInfo - Object that holds column meta-data. SYNOPSIS
my $info = $subreport->column_info_by_idx( 0 ); print "Column's name: ", $info->name(), " "; print "Column's index: ", $info->index(), " "; print "Column's type: ", $info->type(), " "; print "Column's label: ", $info->label(), " "; DESCRIPTION
The Lire::Report::ColumnInfo object contains meta-data information on the columns of a subreport. CONSTRUCTOR
new( $group, $name, $class, $type, [$label]]) Creates a new Lire::Report::ColumnInfo object. The column info attributes are initialized based on $name, $class, $type and $label. OBJECT METHODS
name() Returns the name of this column. This name can be used to find the group operation (from the report specification) that is responsible for the column's content. class() Returns the column's class of data. This will be either 'numerical' or 'categorical'. type() Returns the column's type. This referes to the type of the DLF field that was usd to generate this column's values. group_info() Returns the GroupInfo object which contains this column. index() Returns the column's index in the table. This will be undef until the column info object is added to a Lire::Subreport or Lire::Group object. col_start() Returns the display column which is the start of the cell span that should be used to render this column's values. col_end() Returns the display column which is the end of the cell span that should be used to render this column's values. col_width() Returns the suggested column width for this column in characters. max_chars() This method returns the length of the longest string in that column (including the label). avg_chars() This method returns the average length of strings in that column (including the label). This will be round up to the next integer (1.3 -> 2). label( [$label] ) Returns the column's label. If the $label parameter is defined, the column's label will be set to this new value. SEE ALSO
Lire::Report::Subreport(3pm) Lire::Report::GroupInfo(3pm) VERSION
$Id: ColumnInfo.pm,v 1.15 2006/07/23 13:16:31 vanbaal Exp $ COPYRIGHT
Copyright (C) 2002 Stichting LogReport Foundation LogReport@LogReport.org This file is part of Lire. Lire 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. You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html. AUTHOR
Francis J. Lacoste <flacoste@logreport.org> Lire 2.1.1 2006-07-23 ColumnInfo(3pm)