annotate toolboxes/graph_visualisation/share/man/man1/bcomps.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 BCOMPS 1 "18 November 2003"
Daniel@0 2 .SH NAME
Daniel@0 3 bcomps \- biconnected components filter for graphs
Daniel@0 4 .SH SYNOPSIS
Daniel@0 5 .B bcomps
Daniel@0 6 [
Daniel@0 7 .B \-stvx?
Daniel@0 8 ]
Daniel@0 9 [
Daniel@0 10 .BI -o outfile
Daniel@0 11 ]
Daniel@0 12 [
Daniel@0 13 .I files
Daniel@0 14 ]
Daniel@0 15 .SH DESCRIPTION
Daniel@0 16 .B bcomps
Daniel@0 17 decomposes graphs into their biconnected components,
Daniel@0 18 printing the components to standard output.
Daniel@0 19 .SH OPTIONS
Daniel@0 20 The following options are supported:
Daniel@0 21 .TP
Daniel@0 22 .B \-s
Daniel@0 23 No output graph is printed. Implies the
Daniel@0 24 .B \-v
Daniel@0 25 flag.
Daniel@0 26 .TP
Daniel@0 27 .B \-t
Daniel@0 28 Print the underlying block-cutvertex tree.
Daniel@0 29 .TP
Daniel@0 30 .B \-x
Daniel@0 31 Each biconnected component is printed as a separate root graph.
Daniel@0 32 .TP
Daniel@0 33 .B \-v
Daniel@0 34 Prints number of blocks and cutvertices.
Daniel@0 35 .TP
Daniel@0 36 .BI \-o " outfile"
Daniel@0 37 If specified, each root graph will be written to a different file
Daniel@0 38 with the names derived from \fIoutfile\fP. In particular,
Daniel@0 39 if both \fB-o\fP and \fB-x\fP flags are used, then each
Daniel@0 40 block is written to a different file. If \fIoutfile\fP does
Daniel@0 41 not have a suffix, the nth block of the ith graph is written
Daniel@0 42 to \fIoutfile_n_i\fP. However, the 0th block of the 0th graph is written to
Daniel@0 43 \fIoutfile\fP.
Daniel@0 44 .sp
Daniel@0 45 If \fIoutfile\fP has a suffix, i.e., has the form \fIbase.sfx\fP,
Daniel@0 46 then the files will have the same name as above, except appended with \fI.sfx\fP.
Daniel@0 47 .sp
Daniel@0 48 The block-cutvertex tree of ith graph is written to \fIoutfile_n_T\fP,
Daniel@0 49 with an appended suffix if specified.
Daniel@0 50 .LP
Daniel@0 51 By default, each input graph is printed, with each
Daniel@0 52 block given as a subgraph whose name is a concatenation of
Daniel@0 53 the name of the input graph, the string "_bcc_" and the
Daniel@0 54 number of the block.
Daniel@0 55 .SH OPERANDS
Daniel@0 56 The following operand is supported:
Daniel@0 57 .TP 8
Daniel@0 58 .I files
Daniel@0 59 Names of files containing 1 or more graphs in dot format.
Daniel@0 60 If no
Daniel@0 61 .I files
Daniel@0 62 operand is specified,
Daniel@0 63 the standard input will be used.
Daniel@0 64 .SH RETURN CODES
Daniel@0 65 .B bcomps
Daniel@0 66 returns
Daniel@0 67 .B 0
Daniel@0 68 if all the input graphs are biconnected; and
Daniel@0 69 non-zero if any graph has multiple blocks, or any error occurred.
Daniel@0 70 .SH "BUGS"
Daniel@0 71 It is possible, though unlikely, that the names used for connected
Daniel@0 72 components and their subgraphs may conflict with existing subgraph names.
Daniel@0 73 .SH AUTHORS
Daniel@0 74 Emden R. Gansner <erg@research.att.com>
Daniel@0 75 .SH "SEE ALSO"
Daniel@0 76 ccomps(1), gc(1), dot(1), gvpr(1), gvcolor(1), acyclic(1), sccmap(1), tred(1), libgraph(3)