docs: update docs

.github/workflows/checks.yml

@@ -10,26 +10,26 @@ on:
 jobs:
   check-manpage:
     runs-on: ubuntu-20.04
-    name: Check manpage
+    name: Check docs
     steps:
       - uses: actions/checkout@v3
 
       - name: Install build dependencies
         run: |
           sudo apt-get update
-          sudo apt-get -y install libunwind-dev binutils-dev libiberty-dev help2man
+          sudo apt-get -y install libunwind-dev binutils-dev libiberty-dev help2man inkscape
 
       - name: Compile Austin
         run: |
           autoreconf --install
           ./configure
           make
 
-      - name: Generate manpage
-        run: bash doc/genman.sh
+      - name: Generate docs
+        run: bash doc/gen.sh
 
-      - name: Check manpage
-        run: git diff -I".* DO NOT MODIFY.*" -I"[.]TH AUSTIN.*" --exit-code src/austin.1
+      - name: Check docs
+        run: git diff -I".* DO NOT MODIFY.*" -I"[.]TH AUSTIN.*" --exit-code src/austin.1 doc/cheatsheet.png
 
   cppcheck-linux:
     runs-on: ubuntu-20.04

doc/gen.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+help2man \
+    -n "Frame stack sampler for CPython" \
+    -i doc/examples.troff \
+    src/austin > src/austin.1
+
+inkscape \
+    --export-type="png" \
+    --export-filename="doc/cheatsheet.png" \
+    --export-dpi=192 \
+    doc/cheatsheet.svg
+
+inkscape \
+    --export-type="pdf" \
+    --export-filename="doc/cheatsheet.pdf" \
+    doc/cheatsheet.svg

src/austin.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
-.TH AUSTIN "1" "February 2024" "austin 3.7.0" "User Commands"
+.TH AUSTIN "1" "October 2024" "austin 3.7.0" "User Commands"
 .SH NAME
 austin \- Frame stack sampler for CPython
 .SH SYNOPSIS