annotate toolboxes/graph_visualisation/share/man/man1/acyclic.1 @ 0:e9a9cd732c1e tip

first hg version after svn
author wolffd
date Tue, 10 Feb 2015 15:05:51 +0000
parents
children
rev   line source
wolffd@0 1 .TH ACYCLIC 1 "21 March 2001"
wolffd@0 2 .SH NAME
wolffd@0 3 acyclic \- make directed graph acyclic
wolffd@0 4 .SH SYNOPSIS
wolffd@0 5 .B acyclic
wolffd@0 6 [
wolffd@0 7 .B \-nv?
wolffd@0 8 ] [
wolffd@0 9 .B \-o
wolffd@0 10 .I outfile
wolffd@0 11 ]
wolffd@0 12 [
wolffd@0 13 .I file
wolffd@0 14 ]
wolffd@0 15 .SH DESCRIPTION
wolffd@0 16 .B acyclic
wolffd@0 17 is a filter that takes a directed graph as input and outputs
wolffd@0 18 a copy of the graph with sufficient edges reversed to make
wolffd@0 19 the graph acyclic. The reversed edge inherits all of the attributes
wolffd@0 20 of the original edge. The optional file argument specifies where the
wolffd@0 21 the input graph is stored; by default, the program reads from \fBstdin\fP.
wolffd@0 22 .SH OPTIONS
wolffd@0 23 The following options are supported:
wolffd@0 24 .TP
wolffd@0 25 .B \-n
wolffd@0 26 No output is produced, though the return value
wolffd@0 27 will indicate whether the graph is acyclic or not.
wolffd@0 28 .TP
wolffd@0 29 .B \-v
wolffd@0 30 Print information about whether the file is acyclic, has a cycle or
wolffd@0 31 is undirected.
wolffd@0 32 .TP
wolffd@0 33 .BI \-o " outfile"
wolffd@0 34 causes the output to be written to the specified file; by default,
wolffd@0 35 output is written to \fBstdout\fP.
wolffd@0 36 .TP
wolffd@0 37 .B \-?
wolffd@0 38 option causes the program to print usage information.
wolffd@0 39 .SH RETURN CODES
wolffd@0 40 .B acyclic
wolffd@0 41 returns
wolffd@0 42 .B 0
wolffd@0 43 if the graph is acyclic;
wolffd@0 44 .B 1
wolffd@0 45 if the graph has a cycle;
wolffd@0 46 .B 2
wolffd@0 47 if the graph is undirected; and
wolffd@0 48 .B 255
wolffd@0 49 if there are any errors.
wolffd@0 50 .SH BUGS
wolffd@0 51 If the graph is strict and there is a cycle of length 2,
wolffd@0 52 the attributes of the reversed edge are lost.
wolffd@0 53 .PP
wolffd@0 54 Some edge attributes are non-symmetric, referring to either the head
wolffd@0 55 or tail node. At present, there is no mechanism or convention for
wolffd@0 56 for correctly switching or renaming these.
wolffd@0 57 .SH AUTHORS
wolffd@0 58 Stephen C. North <north@research.att.com>
wolffd@0 59 .br
wolffd@0 60 Emden R. Gansner <erg@research.att.com>
wolffd@0 61 .SH "SEE ALSO"
wolffd@0 62 gc(1), dot(1), gvpr(1), gvcolor(1), ccomps(1), sccmap(1), tred(1), libgraph(3)