.\" Text automatically generated by txt2man
.TH gmk_hy 1 "August 03, 2010" "" "Scotch user's manual"
.SH NAME
\fBgmk_hy, gmk_m2, gmk_m3, gmk_ub2 \fP- create source graphs
\fB
.SH SYNOPSIS
.nf
.fam C
\fBgmk_hy\fP [\fIoptions\fP] \fIdim\fP [\fIofile\fP]
.PP
\fBgmk_m2\fP [\fIoptions\fP] [\fB-g\fP\fIcfile\fP] \fIdimX\fP \fIdimY\fP [\fIofile\fP]
.PP
\fBgmk_m3\fP [\fIoptions\fP] [\fB-g\fP\fIcfile\fP] \fIdimX\fP \fIdimY\fP \fIdimZ\fP [\fIofile\fP]
.PP
\fBgmk_ub2\fP [\fIoptions\fP] \fIdim\fP
.fam T
.fi
.SH DESCRIPTION
The \fBgmk_\fP* programs create source graph files for some common,
regular topologies.
.PP
\fBgmk_hy\fP creates a hypercube of dimension \fIdim\fP.
.PP
\fBgmk_m2\fP creates a 2D regular grid of dimensions \fIdimX\fP and \fIdimY\fP.
.PP
\fBgmk_m3\fP creates a 3D regular grid of dimensions \fIdimX\fP, \fIdimY\fP and \fIdimZ\fP.
.PP
\fBgmk_ub2\fP creates an unoriented de Bruijn graph of dimension \fIdim\fP.
.SH OPTIONS
.TP
.B
\fB-b\fP base
For \fBgmk_m2\fP and \fBgmk_m3\fP only. Output graphs with base
value set to base. Default value is 0.
.TP
.B
\fB-e\fP
For \fBgmk_m2\fP only. Build a 8-neighbor grid rather than a
4-neighbor grid.
.TP
.B
\fB-g\fP\fIcfile\fP
For \fBgmk_m2\fP and \fBgmk_m3\fP only. Output graph vertex
coordinates (that is, geometry data to be used by
\fBgout\fP(1)) in file \fIcfile\fP.
.TP
.B
\fB-h\fP
Display some help.
.TP
.B
\fB-t\fP
For \fBgmk_m2\fP and \fBgmk_m3\fP only. Create torus graphs, that
is, graphs such that there exist loop edges between
vertices of rank 0 and (\fIdim\fP-1) in every dimension.
.TP
.B
\fB-V\fP
Display program version and copyright.
.SH EXAMPLE
Create a 5x7 grid along with its geometry:
.PP
.nf
.fam C
    $ gmk_m2 5 7 -g/tmp/m5x7.xyz /tmp/m5x7.grf

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