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

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