cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page

pages/common/cluster.md

@@ -0,0 +1,24 @@
+# cluster
+
+> Find clusters in a graph and augment the graph with this information.
+> More information: <https://graphviz.org/pdf/cluster.1.pdf>.
+
+- Generate clusters that optimize modularity and print the result to stdout:
+
+`cluster {{input.gv}}`
+
+- Specify a target number of [C]lusters (approximate) to generate (0 by default):
+
+`cluster -C {{5}} {{input.gv}}`
+
+- Use a different [c]lustering method (0: modularity clustering, 1: modularity quality):
+
+`cluster -c {{1}} {{input.gv}}`
+
+- Save the [o]utput to a file:
+
+`cluster -o {{output.gv}} {{input.gv}}`
+
+- Enable [v]erbose mode:
+
+`cluster -v {{input.gv}}`

pages/common/diffimg.md

@@ -0,0 +1,8 @@
+# diffimg
+
+> Generates an image where each pixel is the difference between corresponding pixels in the 2 source images.
+> More information: <https://graphviz.org/pdf/diffimg.1.pdf>.
+
+- Compare two images and output the difference image to `out.png`:
+
+`diffimg {{path/to/image1}} {{path/to/image2}} {{path/to/outimage}}`

pages/common/dijkstra.md

@@ -0,0 +1,20 @@
+# dijkstra
+
+> Compute shortest-path distances from a single source node in a graph.
+> More information: <https://graphviz.org/pdf/dijkstra.1.pdf>.
+
+- Compute distances from a given source node in a graph file:
+
+`dijkstra {{source_node file}}`
+
+- Treat the graph as [d]irected when computing distances:
+
+`dijkstra -d {{source_node file}}`
+
+- Set each node reachable from source_node to it's distance from the `source_node`:
+
+`dijkstra -p {{source_node file}}`
+
+- [a]ssign large distance values to unreachable nodes:
+
+`dijkstra -a {{source_node file}}`

pages/common/dotty.md

@@ -0,0 +1,21 @@
+# dotty
+
+> A customizable interactive graph editor for the X Window System.
+> Note: The dotty tool has been depracated, but this entry is retained to aid anyone still using it.
+> More information: <https://graphviz.org/pdf/dotty.1.pdf>.
+
+- Open a graph file (.gv or .dot) in the Dotty editor:
+
+`dotty {{path/to/graph.gv}}`
+
+- Start Dotty with the [V]ersion information displayed:
+
+`dotty -V`
+
+- Set the [l]ayout [m]ode to synchronous or asynchronous:
+
+`dotty -lmmode {{sync|async}} {{path/to/graph.gv}}`
+
+- Set the message verbosity level (`0` for minimal, `1` for detailed):
+
+`dotty -ellev {{1}} {{path/to/graph.gv}}`

pages/common/gvedit.md

@@ -0,0 +1,20 @@
+# gvedit
+
+> Simple Graphviz graph editor and viewer.
+> More information: <https://graphviz.org/pdf/gvedit.1.pdf>.
+
+- Open a Graphviz file in the editor:
+
+`gvedit {{path/to/graph.gv}}`
+
+- Scale coordinates from points to inches (useful for layouts generated by Graphviz tools):
+
+`gvedit -s {{path/to/graph.gv}}`
+
+- Enable verbose mode:
+
+`gvedit -v {{path/to/graph.gv}}`
+
+- Display help:
+
+`gvedit -?`

pages/common/gvgen.md

@@ -0,0 +1,32 @@
+# gvgen
+
+> Generate simple, structured abstract graphs.
+> More information: <https://graphviz.org/pdf/gvgen.1.pdf>.
+
+- Generate a cycle with 10 vertices and edges:
+
+`gvgen -c {{10}}`
+
+- Generate a 4×3 [g]rid:
+
+`gvgen -g {{4,3}}`
+
+- Generate a binary [t]ree of height 5:
+
+`gvgen -t {{5}}`
+
+- Generate a complete [b]ipartite graph with 3 and 4 vertices:
+
+`gvgen -b {{3,4}}`
+
+- Create a [r]andom graph and [o]utput it to a file:
+
+`gvgen -r {{10,5}} -o {{random.gv}}`
+
+- Generate a [d]irected graph with [v]erbose output:
+
+`gvgen -d -v -c {{6}}`
+
+- Display help:
+
+`gvgen -?`

pages/common/gvmap.md

@@ -0,0 +1,28 @@
+# gvmap
+
+> Finds clusters and creates a geographical map highlighting clusters.
+> More information: <https://graphviz.org/pdf/gvmap.1.pdf>.
+
+- Generate a clustered map layout from a DOT format graph:
+
+`gvmap {{graph.gv}} -o {{output.xdot}}`
+
+- Generate a map using existing cluster subgraphs from the input:
+
+`gvmap -D {{graph.gv}}`
+
+- Include graph edges in the [o]utput map:
+
+`gvmap -e {{graph.gv}} -o {{output.xdot}}`
+
+- Specify a [c]olor scheme (1: pastel, 2: blue-yellow, 3: white-red, etc.):
+
+`gvmap -c {{2}} {{graph.gv}} -o {{output.xdot}}`
+
+- Set the maximum number of [C]lusters (by default 0, meaning there is no limit):
+
+`gvmap -C {{10}} {{graph.gv}} -o {{output.xdot}}`
+
+- Only draw cluster 2 (by default, all clusters are drawn):
+
+`gvmap -highlight={{2}} {{graph.gv}} -o {{output.xdot}}`