.\" Text automatically generated by txt2man
.TH gout 1 "23 November 2019" "" "Scotch user's manual"
.SH NAME
\fBgout \fP- output graphics from matrices and graphs
\fB
.SH SYNOPSIS
.nf
.fam C
\fBgout\fP [\fIoptions\fP] [\fIgfile\fP] [\fIxfile\fP] [\fImfile\fP] [\fIvfile\fP]

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
The \fBgout\fP program creates graphics files of various types,
representing the Scotch graph and mapping data which is passed to it.
.PP
Source graph file \fIgfile\fP can only be a centralized graph file. File
\fIxfile\fP stores its associated geometry, whenever necessary. File
\fImfile\fP represents label information attached to each of the graph
vertices, for instance the index of the part to which each vertex
belongs in the case of a mapping file. File \fIvfile\fP is the output
graphics file, the type of which may differ according to the input
parameters. When file names are not specified, data is read from
standard input and written to standard output. Standard streams can
also be explicitly represented by a dash '-'.
.PP
When the proper libraries have been included at compile time, gtst
can directly handle compressed graphs, both as input and output. A
stream is treated as compressed whenever its name is postfixed with
a compressed file extension, such as in 'brol.grf.bz2' or '-.gz'. The
compression formats which can be supported are the bzip2 format
('.bz2'), the gzip format ('.gz'), and the lzma format ('.lzma').
.SH OPTIONS
.TP
.B
\fB-h\fP
Display some help.
.TP
.B
\fB-g\fP\fIgeop\fP
Geometry parameters, which can be an arbitrary
combination of any of the following code letters:
.RS
.TP
.B
n
Do not read geometry data, when it is not
available or not required, such as when using
the \fB-om\fP option.
.TP
.B
p
Permute Y and Z geometry dimensions.
.TP
.B
r
Rotate geometry by 90 degrees in the (X,Y) plane.
.RE
.TP
.B
\fB-h\fP
Display some help.
.TP
.B
\fB-mn\fP
Do not read mapping data, when it is not available or
not required.
.TP
.B
\fB-o\fP\fIoutp\fP
Select the output file type and allows to provide
additional parameters between braces and separated
by commas:
.RS
.TP
.B
i
OpenInventor 3D mesh file, to be viewed by means of
programs such as \fBivview\fP. Additional parameters for
this output file type are:
.RS
.TP
.B
c
Color output.
.TP
.B
g
Gray level output.
.TP
.B
r
Remove cut edges.
.TP
.B
v
View cut edges.
.RE
.TP
.B
m
PostScript matrix pattern file. Additional parameters
for this output file type are:
.RS
.TP
.B
e
EPSF-type output.
.TP
.B
f
Full-page output.
.RE
.TP
.B
p
PostScript 2D mesh file. This output module was
intended for 2D meshes; as a fallback, the Z
coordinate is projected according to isometric
perspective rules, but drawings of full 3D objects
are most likely to be unreadable. Additional parameters
for this output file type are:
.RS
.TP
.B
c
Color output.
.TP
.B
g
Gray level output.
.TP
.B
e
EPSF-type output.
.TP
.B
f
Full-page output.
.TP
.B
s
Short clipping (disks excluded).
.TP
.B
l
Large clipping (disks included).
.TP
.B
a
Avoid displaying disks.
.TP
.B
d
Display disks.
.TP
.B
r
Remove cut edges.
.TP
.B
v
View cut edges.
.TP
.B
X=\fIrat\fP
Maximum x clipping ratio (in [0.0;1.0]).
.TP
.B
x=\fIrat\fP
Minimum x clipping ratio.
.TP
.B
Y=\fIrat\fP
Maximum y clipping ratio.
.TP
.B
y=\fIrat\fP
Minimum y clipping ratio.
.RE
.TP
.B
t
Tulip 3D mesh file. Additional parameters
for this output file type are:
.RS
.TP
.B
b
Black and white output.
.TP
.B
c
Color output.
.TP
.B
a
Avoid displaying disks.
.TP
.B
d
Display disks.
.TP
.B
r
Remove cut edges.
.TP
.B
v
View cut edges.
.RE
.RE
.TP
.B
\fB-V\fP
Display program version and copyright.
.SH EXAMPLES
Build an OpenInventor file of the mapping of graph brol.grf
contained in file brol.map. Vertices with no mapping information
attached to them will be rendered in white, while distinct colors
will be used to represent the different parts. Cut edges will be
removed:
.PP
.nf
.fam C
    $ gout '-oi{r}' brol.grf brol.xyz brol.map brol.iv
    $ ivview brol.iv

.fam T
.fi
Build an OpenInventor file of graph brol.grf without any vertex
information associated to it. Mapping data are not required and
will not be read, but a file name has to be provided, hence the
\(cq-':
.PP
.nf
.fam C
    $ gout -oi -mn brol.grf brol.xyz - brol.iv

.fam T
.fi
Output the pattern of matrix brol.grf on the form of a PostScript
flat drawing. Geometry and mapping data are not required and will
not be read, but file names have to be provided, hence the
two '-'s:
.PP
.nf
.fam C
    $ gout -om -gn -mn brol.grf - - brol.ps

.fam T
.fi
Output a PostScript 2D drawing of a rectangular portion graph
brol.grf, with disks representing mapping data:
.PP
.nf
.fam C
    $ gout '-op{c,e,d,x=0.3,X=0.6,y=0.2,Y=0.5}' brol.grf brol.xyz brol.map brol.ps


.fam T
.fi
.SH SEE ALSO
\fBgmap\fP(1), \fBgout\fP(1), \fBgtst\fP(1).
.PP
Scotch user's manual.
.SH AUTHOR
Francois Pellegrini <francois.pellegrini@labri.fr>