diff --git a/pages/common/cluster.md b/pages/common/cluster.md new file mode 100644 index 00000000000000..611bca17ea655e --- /dev/null +++ b/pages/common/cluster.md @@ -0,0 +1,24 @@ +# cluster + +> Find clusters in a graph and augment the graph with this information. +> More information: . + +- 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}}` diff --git a/pages/common/diffimg.md b/pages/common/diffimg.md new file mode 100644 index 00000000000000..e0dfaa779bb43c --- /dev/null +++ b/pages/common/diffimg.md @@ -0,0 +1,8 @@ +# diffimg + +> Generate an image where each pixel is the difference between corresponding pixels in the 2 source images. +> More information: . + +- Compare two images and output the difference image to `out.png`: + +`diffimg {{path/to/image1}} {{path/to/image2}} {{path/to/outimage}}` diff --git a/pages/common/dijkstra.md b/pages/common/dijkstra.md new file mode 100644 index 00000000000000..9b6f2401177f37 --- /dev/null +++ b/pages/common/dijkstra.md @@ -0,0 +1,20 @@ +# dijkstra + +> Compute shortest-path distances from a single source node in a graph. +> More information: . + +- 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}}` + +- Record the [p]revious closest node for each node on the shortest path: + +`dijkstra -p {{source_node file}}` + +- [a]ssign large distance values to unreachable nodes: + +`dijkstra -a {{source_node file}}` diff --git a/pages/common/dotty.md b/pages/common/dotty.md new file mode 100644 index 00000000000000..07801e016898a5 --- /dev/null +++ b/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: . + +- 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 -lm {{sync|async}} {{path/to/graph.gv}}` + +- Set the m[e]ssage verbosity [l]evel (`0` for minimal, `1` for detailed): + +`dotty -el {{0|1}} {{path/to/graph.gv}}` diff --git a/pages/common/gvedit.md b/pages/common/gvedit.md new file mode 100644 index 00000000000000..c3c1065d32d5d0 --- /dev/null +++ b/pages/common/gvedit.md @@ -0,0 +1,20 @@ +# gvedit + +> Simple Graphviz graph editor and viewer. +> More information: . + +- Open a Graphviz file in the editor: + +`gvedit {{path/to/graph.gv}}` + +- [s]cale coordinates from points to inches (useful for layouts generated by Graphviz tools): + +`gvedit -s {{path/to/graph.gv}}` + +- Enable [v]erbose mode: + +`gvedit -v {{path/to/graph.gv}}` + +- Display help: + +`gvedit -?` diff --git a/pages/common/gvgen.md b/pages/common/gvgen.md new file mode 100644 index 00000000000000..1a3de9cc59c241 --- /dev/null +++ b/pages/common/gvgen.md @@ -0,0 +1,32 @@ +# gvgen + +> Generate simple, structured abstract graphs. +> More information: . + +- Generate a [c]ycle 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 -?` diff --git a/pages/common/gvmap.md b/pages/common/gvmap.md new file mode 100644 index 00000000000000..4c6cfa649c5619 --- /dev/null +++ b/pages/common/gvmap.md @@ -0,0 +1,28 @@ +# gvmap + +> Finds clusters and creates a geographical map highlighting clusters. +> More information: . + +- 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}}`