aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/tools
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2022-06-25 21:52:54 +0200
committerJohannes Stoelp <johannes.stoelp@gmail.com>2022-06-25 21:52:54 +0200
commit6b252dbc87462a5ccfd31c8fc6c27195646365dd (patch)
treed301ee6b62cf569c9cae1cfec9b88ee0249d2b8a /src/tools
parentf33fbacc6aaa54599458ac3eb375708650656010 (diff)
downloadnotes-6b252dbc87462a5ccfd31c8fc6c27195646365dd.tar.gz
notes-6b252dbc87462a5ccfd31c8fc6c27195646365dd.zip
[dot]: added copy & paste dot example graph
Diffstat (limited to 'src/tools')
-rw-r--r--src/tools/README.md1
-rw-r--r--src/tools/dot.md54
2 files changed, 55 insertions, 0 deletions
diff --git a/src/tools/README.md b/src/tools/README.md
index 8d3baa6..d6b0a21 100644
--- a/src/tools/README.md
+++ b/src/tools/README.md
@@ -13,3 +13,4 @@
- [radare2](./radare2.md)
- [qemu](./qemu.md)
- [pacman](./pacman.md)
+- [dot](./dot.md)
diff --git a/src/tools/dot.md b/src/tools/dot.md
new file mode 100644
index 0000000..d3d7ac8
--- /dev/null
+++ b/src/tools/dot.md
@@ -0,0 +1,54 @@
+# dot(1)
+
+Example `dot` file to copy & paste from.
+
+Can be rendered to `svg` with the following command.
+```bash
+dot -T svg -o g.svg g.dot
+```
+
+Example `dot` file.
+```dot
+// file: g.dot
+digraph {
+ // Render ranks from left to right.
+ rankdir=LR
+ // Make background transparent.
+ bgcolor=transparent
+
+ // Global node attributes.
+ node [shape=box]
+ // Global edge attributes.
+ edge [style=dotted,color=red]
+
+ // Add nodes & edge.
+ stage1 -> stage2
+ // Add multiple edges at once.
+ stage2 -> { stage3_1, stage3_2 }
+ // Add edge with custom attributes.
+ stage3_2 -> stage4 [label="some text"]
+
+ // Set custom attributes for specific node.
+ stage4 [color=green,fillcolor=lightgray,style="filled,dashed",label="s4"]
+
+ // Create a subgraph. This can be used to group nodes/edges or as scope for
+ // global node/edge attributes.
+ // If the name starts with 'cluster' a border is drawn.
+ subgraph cluster_1 {
+ stage5_1
+ stage5_2
+ }
+
+ // Add some edges to subgraph nodes.
+ stage3_1 -> { stage5_1, stage5_2 }
+}
+```
+
+Rendered `svg` file.
+![g.svg](/assets/g.svg)
+
+## References
+- [DOT language](https://graphviz.org/doc/info/lang.html)
+- [Attributes](https://graphviz.org/doc/info/attrs.html)
+- [Node shapes](https://graphviz.org/doc/info/shapes.html)
+- [Colors](https://graphviz.org/doc/info/colors.html)