graphviz filter commands: add pages (#6401)

beep
Daniel Birket 2021-09-01 12:56:46 -04:00 committed by GitHub
parent fb0412d03b
commit 82ba854bed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 203 additions and 0 deletions

17
pages/common/acyclic.md Normal file
View File

@ -0,0 +1,17 @@
# acyclic
> Make a directed graph acyclic by reversing some edges.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://graphviz.org/pdf/acyclic.1.pdf>.
- Make a directed graph acyclic by reversing some edges:
`acyclic {{path/to/input.gv}} > {{path/to/output.gv}}`
- Print if a graph is acyclic, has a cycle, or is undirected, producing no output graph:
`acyclic -v -n {{path/to/input.gv}}`
- Display help for `acyclic`:
`acyclic -?`

21
pages/common/bcomps.md Normal file
View File

@ -0,0 +1,21 @@
# bcomps
> Decompose graphs into their biconnected components.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://graphviz.org/pdf/bcomps.1.pdf>.
- Decompose one or more graphs into their biconnected components:
`bcomps {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}`
- Print the number of blocks and cutvertices in one or more graphs:
`bcomps -v -s {{path/to/input1.gv}} {{path/to/input2.gv ...}}`
- Write each block and block-cutvertex tree to multiple numbered filenames based on `output.gv`:
`bcomps -x -o {{path/to/output.gv}} {{path/to/input1.gv}} {{path/to/input2.gv ...}}`
- Display help for `bcomps`:
`bcomps -?`

21
pages/common/ccomps.md Normal file
View File

@ -0,0 +1,21 @@
# ccomps
> Decompose graphs into their connected components.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://graphviz.org/pdf/ccomps.1.pdf>.
- Decompose one or more graphs into their connected components:
`ccomps {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}`
- Print the number of nodes, edges, and connected components in one or more graphs:
`ccomps -v -s {{path/to/input1.gv}} {{path/to/input2.gv ...}}`
- Write each connected component to numbered filenames based on `output.gv`:
`ccomps -x -o {{path/to/output.gv}} {{path/to/input1.gv}} {{path/to/input2.gv ...}}`
- Display help for `ccomps`:
`ccomps -?`

21
pages/common/edgepaint.md Normal file
View File

@ -0,0 +1,21 @@
# edgepaint
> Colorize edges of a graph layout to clarify crossing edges.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://graphviz.org/pdf/edgepaint.1.pdf>.
- Colorize edges of one or more graph layouts (that already have layout information) to clarify crossing edges:
`edgepaint {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Colorize edges using a color scheme. (See <https://graphviz.org/doc/info/colors.html#brewer>):
`edgepaint -color-scheme={{accent7}} {{path/to/layout.gv}} > {{path/to/output.gv}}`
- Lay out a graph and colorize its edges, then convert to a PNG image:
`dot {{path/to/input.gv}} | edgepaint | dot -T {{png}} > {{path/to/output.png}}`
- Display help for `edgepaint`:
`edgepaint -?`

17
pages/common/gvcolor.md Normal file
View File

@ -0,0 +1,17 @@
# gvcolor
> Colorize a ranked digraph with a range of colors.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://graphviz.org/pdf/gvcolor.1.pdf>.
- Colorize one or more ranked digraph (that were already processed by `dot`):
`gvcolor {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Lay out a graph and colorize it, then convert to a PNG image:
`dot {{path/to/input.gv}} | gvcolor | dot -T {{png}} > {{path/to/output.png}}`
- Display help for `gvcolor`:
`gvcolor -?`

25
pages/common/gvpack.md Normal file
View File

@ -0,0 +1,25 @@
# gvpack
> Combine several graph layouts (that already have layout information).
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://graphviz.org/pdf/gvpack.1.pdf>.
- Combine several graph layouts (that already have layout information):
`gvpack {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Combine several graph layouts at the graph level, keeping graphs separate:
`gvpack -g {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Combine several graph layouts at the node level, ignoring clusters:
`gvpack -n {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Combine several graph layouts without packing:
`gvpack -u {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Display help for `gvpack`:
`gvpack -?`

17
pages/common/mingle.md Normal file
View File

@ -0,0 +1,17 @@
# mingle
> Bundle the edges of a graph layout.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://www.graphviz.org/pdf/mingle.1.pdf>.
- Bundle the edges of one or more graph layouts (that already have layout information):
`mingle {{path/to/layout1.gv}} {{path/to/layout2.gv ...}} > {{path/to/output.gv}}`
- Perform layout, bundling, and output to a picture with one command:
`dot {{path/to/input.gv}} | mingle | dot -T {{png}} > {{path/to/output.png}}`
- Display help for `mingle`:
`mingle -?`

17
pages/common/nop.md Normal file
View File

@ -0,0 +1,17 @@
# nop
> Check validity and pretty-print graphs in canonical format.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://www.graphviz.org/pdf/nop.1.pdf>.
- Pretty-print one or more graphs in canonical format:
`nop {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}`
- Check one or more graphs for validity, producing no output graph:
`nop -p {{path/to/input1.gv}} {{path/to/input2.gv ...}}`
- Display help for `nop`:
`nop -?`

17
pages/common/sccmap.md Normal file
View File

@ -0,0 +1,17 @@
# sccmap
> Extract strongly connected components of directed graphs.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://www.graphviz.org/pdf/sccmap.1.pdf>.
- Extract strongly connected components of one or more directed graphs:
`sccmap -S {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}`
- Print statistics about a graph, producing no output graph:
`sccmap -v -s {{path/to/input1.gv}} {{path/to/input2.gv ...}}`
- Display help for `sccmap`:
`sccmap -?`

13
pages/common/tred.md Normal file
View File

@ -0,0 +1,13 @@
# tred
> Compute the transitive reduction of directed graphs.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://www.graphviz.org/pdf/tred.1.pdf>.
- Construct the transitive reduction graph of one or more directed graphs:
`tred {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}`
- Display help:
`tred -?`

17
pages/common/unflatten.md Normal file
View File

@ -0,0 +1,17 @@
# unflatten
> Adjust directed graphs to improve the layout aspect ratio.
> Graphviz filters: `acyclic`, `bcomps`, `comps`, `edgepaint`, `gvcolor`, `gvpack`, `mingle`, `nop`, `sccmap`, `tred`, & `unflatten`.
> More information: <https://www.graphviz.org/pdf/unflatten.1.pdf>.
- Adjust one or more directed graphs to improve the layout aspect ratio:
`unflatten {{path/to/input1.gv}} {{path/to/input2.gv ...}} > {{path/to/output.gv}}`
- Use `unflatten` as a preprocessor for `dot` layout to improve aspect ratio:
`unflatten {{path/to/input.gv}} | dot -T {{png}} {{path/to/output.png}}`
- Display help for `unflatten`:
`unflatten -?`