Individual actions command-line reference documentation (#942).

docs/Dockerfile

@@ -3,10 +3,10 @@ FROM docker.io/alpine:3.20.1 AS borgmatic
 COPY . /app
 RUN apk add --no-cache py3-pip py3-ruamel.yaml py3-ruamel.yaml.clib
 RUN pip install --break-system-packages --no-cache /app && borgmatic config generate && borgmatic config generate --destination /etc/borgmatic --split && chmod +r /etc/borgmatic/*.yaml
-RUN borgmatic --help > /command-line.txt \
+RUN mkdir /command-line \
+    && borgmatic --help > /command-line/global.txt \
     && for action in repo-create transfer create prune compact check delete extract config "config bootstrap" "config generate" "config validate" export-tar mount umount repo-delete restore repo-list list repo-info info break-lock "key export" "key import" "key change-passphrase" recreate borg; do \
-           echo -e "\n--------------------------------------------------------------------------------\n" >> /command-line.txt \
-           && borgmatic $action --help >> /command-line.txt; done
+           borgmatic $action --help > /command-line/${action/ /-}.txt; done
 RUN /app/docs/fetch-contributors >> /contributors.html
 
 FROM docker.io/node:22.4.0-alpine AS html
@@ -24,7 +24,7 @@ RUN npm install @11ty/eleventy \
     markdown-it-anchor \
     markdown-it-replace-link
 COPY --from=borgmatic /etc/borgmatic/* /source/docs/_includes/borgmatic/
-COPY --from=borgmatic /command-line.txt /source/docs/_includes/borgmatic/command-line.txt
+COPY --from=borgmatic /command-line/* /source/docs/_includes/borgmatic/command-line/
 COPY --from=borgmatic /contributors.html /source/docs/_includes/borgmatic/contributors.html
 COPY . /source
 RUN NODE_ENV=${ENVIRONMENT} npx eleventy --input=/source/docs --output=/output

docs/_includes/components/toc.css

@@ -54,6 +54,16 @@
   display: inline-block;
 }
 
+.elv-toc-list ul ul ul > li::before {
+	content: "•";
+	margin-left: 0.4em;
+	margin-right: -0.2em;
+}
+
+.elv-toc-list ul ul ul > li > a {
+	display: inline-block;
+}
+
 /* List items */
 .elv-toc summary,
 .elv-toc-list a {

docs/reference/command-line/actions/borg.md

@@ -0,0 +1,10 @@
+---
+title: borg
+eleventyNavigation:
+  key: borg
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/borg.txt %}
+```

docs/reference/command-line/actions/break-lock.md

@@ -0,0 +1,10 @@
+---
+title: break-lock
+eleventyNavigation:
+  key: break-lock
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/break-lock.txt %}
+```

docs/reference/command-line/actions/check.md

@@ -0,0 +1,10 @@
+---
+title: check
+eleventyNavigation:
+  key: check
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/check.txt %}
+```

docs/reference/command-line/actions/compact.md

@@ -0,0 +1,10 @@
+---
+title: compact
+eleventyNavigation:
+  key: compact
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/compact.txt %}
+```

docs/reference/command-line/actions/config-bootstrap.md

@@ -0,0 +1,10 @@
+---
+title: config bootstrap
+eleventyNavigation:
+  key: config bootstrap
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/config-bootstrap.txt %}
+```

docs/reference/command-line/actions/config-generate.md

@@ -0,0 +1,10 @@
+---
+title: config generate
+eleventyNavigation:
+  key: config generate
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/config-generate.txt %}
+```

docs/reference/command-line/actions/config-validate.md

@@ -0,0 +1,10 @@
+---
+title: config validate
+eleventyNavigation:
+  key: config validate
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/config-validate.txt %}
+```

docs/reference/command-line/actions/config.md

@@ -0,0 +1,10 @@
+---
+title: config
+eleventyNavigation:
+  key: config
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/config.txt %}
+```

docs/reference/command-line/actions/create.md

@@ -0,0 +1,10 @@
+---
+title: transfer
+eleventyNavigation:
+  key: transfer
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/transfer.txt %}
+```

docs/reference/command-line/actions/delete.md

@@ -0,0 +1,10 @@
+---
+title: delete
+eleventyNavigation:
+  key: delete
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/delete.txt %}
+```

docs/reference/command-line/actions/export-tar.md

@@ -0,0 +1,10 @@
+---
+title: export-tar
+eleventyNavigation:
+  key: export-tar
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/export-tar.txt %}
+```

docs/reference/command-line/actions/extract.md

@@ -0,0 +1,10 @@
+---
+title: extract
+eleventyNavigation:
+  key: extract
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/extract.txt %}
+```

docs/reference/command-line/actions.md → docs/reference/command-line/actions/index.md

@@ -8,6 +8,11 @@ An action in borgmatic is like a subcommand in Borg. The `create` action creates
 a backup, the `list` action shows the files in an archive, and so on.
 
 
+## Available actions
+
+{{ collections.all | eleventyNavigation: "🎬 Actions" | eleventyNavigationToHtml | replace: 'href="/reference/', 'href="/borgmatic/reference/' }}
+
+
 ## Default actions
 
 If you omit `create` and other actions from the command-line, borgmatic runs
@@ -21,6 +26,7 @@ through a set of default actions:
 <span class="minilink minilink-addedin">Prior to version 1.7.9</span> The
 default action ordering was `prune`, `compact`, `create`, and `check`.
 
+
 ### Disabling default actions
 
 If you want to disable this default action behavior and require explicit actions

docs/reference/command-line/actions/info.md

@@ -0,0 +1,10 @@
+---
+title: info
+eleventyNavigation:
+  key: info
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/info.txt %}
+```

docs/reference/command-line/actions/key-change-passphrase.md

@@ -0,0 +1,10 @@
+---
+title: key change-passphrase
+eleventyNavigation:
+  key: key change-passphrase
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/key-change-passphrase.txt %}
+```

docs/reference/command-line/actions/key-export.md

@@ -0,0 +1,10 @@
+---
+title: key export
+eleventyNavigation:
+  key: key export
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/key-export.txt %}
+```

docs/reference/command-line/actions/key-import.md

@@ -0,0 +1,10 @@
+---
+title: key import
+eleventyNavigation:
+  key: key import
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/key-import.txt %}
+```

docs/reference/command-line/actions/list.md

@@ -0,0 +1,10 @@
+---
+title: list
+eleventyNavigation:
+  key: list
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/list.txt %}
+```

docs/reference/command-line/actions/mount.md

@@ -0,0 +1,10 @@
+---
+title: mount
+eleventyNavigation:
+  key: mount
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/mount.txt %}
+```

docs/reference/command-line/actions/prune.md

@@ -0,0 +1,10 @@
+---
+title: prune
+eleventyNavigation:
+  key: prune
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/prune.txt %}
+```

docs/reference/command-line/actions/recreate.md

@@ -0,0 +1,10 @@
+---
+title: recreate
+eleventyNavigation:
+  key: recreate
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/recreate.txt %}
+```

docs/reference/command-line/actions/repo-create.md

@@ -0,0 +1,10 @@
+---
+title: transfer
+eleventyNavigation:
+  key: transfer
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/transfer.txt %}
+```

docs/reference/command-line/actions/repo-delete.md

@@ -0,0 +1,10 @@
+---
+title: repo-delete
+eleventyNavigation:
+  key: repo-delete
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/repo-delete.txt %}
+```

docs/reference/command-line/actions/repo-info.md

@@ -0,0 +1,10 @@
+---
+title: repo-info
+eleventyNavigation:
+  key: repo-info
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/repo-info.txt %}
+```

docs/reference/command-line/actions/repo-list.md

@@ -0,0 +1,10 @@
+---
+title: repo-list
+eleventyNavigation:
+  key: repo-list
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/repo-list.txt %}
+```

docs/reference/command-line/actions/restore.md

@@ -0,0 +1,10 @@
+---
+title: restore
+eleventyNavigation:
+  key: restore
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/restore.txt %}
+```

docs/reference/command-line/actions/transfer.md

@@ -0,0 +1,10 @@
+---
+title: transfer
+eleventyNavigation:
+  key: transfer
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/transfer.txt %}
+```

docs/reference/command-line/actions/umount.md

@@ -0,0 +1,10 @@
+---
+title: umount
+eleventyNavigation:
+  key: umount
+  parent: 🎬 Actions
+---
+
+```bash
+{% include borgmatic/command-line/umount.txt %}
+```

docs/reference/command-line/index.md

@@ -5,18 +5,22 @@ eleventyNavigation:
   parent: Reference guides
   order: 1
 ---
-Here are all of the available borgmatic command-line flags for the [most
+Here are all of the available global borgmatic command-line flags for the [most
 recent version of
 borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/releases),
 including the separate flags for each action (sub-command). Most of the flags
-listed here do not have equivalents in borgmatic's [configuration
+listed here have equivalents in borgmatic's [configuration
 file](https://torsion.org/borgmatic/reference/configuration/).
 
+Also see the [actions
+documentation](https://torsion.org/borgmatic/reference/command-line/actions/)
+for the command-line flags for individual actions.
+
 If you're using an older version of borgmatic, some of these flags may not be
 present in that version and you should instead use `borgmatic --help` or
 `borgmatic [action name] --help` (where `[action name]` is the name of an
 action like `list`, `create`, etc.).
 
 ```
-{% include borgmatic/command-line.txt %}
+{% include borgmatic/command-line/global.txt %}
 ```

docs/reference/configuration/credentials/container.md

@@ -1,7 +1,7 @@
 ---
 title: Container secrets
 eleventyNavigation:
-  key: • Container
+  key: Container
   parent: 🔒 Credentials
 ---
 <span class="minilink minilink-addedin">New in version 1.9.11</span> When

docs/reference/configuration/credentials/file.md

@@ -1,7 +1,7 @@
 ---
 title: File-based credentials
 eleventyNavigation:
-  key: • File
+  key: File
   parent: 🔒 Credentials
 ---
 <span class="minilink minilink-addedin">New in version 1.9.11</span> borgmatic

docs/reference/configuration/credentials/keepassxc.md

@@ -1,7 +1,7 @@
 ---
 title: KeePassXC passwords
 eleventyNavigation:
-  key: • KeePassXC
+  key: KeePassXC
   parent: 🔒 Credentials
 ---
 <span class="minilink minilink-addedin">New in version 1.9.11</span> borgmatic

docs/reference/configuration/credentials/systemd.md

@@ -1,7 +1,7 @@
 ---
 title: systemd service credentials
 eleventyNavigation:
-  key: • systemd
+  key: systemd
   parent: 🔒 Credentials
 ---
 <span class="minilink minilink-addedin">New in version 1.9.10</span> borgmatic

docs/reference/configuration/data-sources/btrfs.md

@@ -1,7 +1,7 @@
 ---
 title: Btrfs
 eleventyNavigation:
-  key: • Btrfs
+  key: Btrfs
   parent: 🗄️ Data sources
 ---
 <span class="minilink minilink-addedin">New in version 1.9.4</span> <span

docs/reference/configuration/data-sources/index.md

@@ -9,19 +9,11 @@ plain filesystem data, can pull data directly from database servers and
 filesystem snapshots.
 
 In the case of supported database systems, borgmatic dumps your configured
-databases, streaming them directly to Borg when creating a backup. Here are the
-supported databases and how to configure their borgmatic integrations:
+databases, streaming them directly to Borg when creating a backup. And for
+supported filesystems / volume managers, borgmatic takes on-demand snapshots of
+configured source directories and feeds them to Borg.
 
- * [MariaDB](https://torsion.org/borgmatic/reference/configuration/data-sources/mariadb/)
- * [MongoDB](https://torsion.org/borgmatic/reference/configuration/data-sources/mongodb/)
- * [MySQL](https://torsion.org/borgmatic/reference/configuration/data-sources/mysql/)
- * [PostgreSQL](https://torsion.org/borgmatic/reference/configuration/data-sources/postgresql/)
- * [SQLite](https://torsion.org/borgmatic/reference/configuration/data-sources/sqlite/)
+Here are the supported data sources and how to configure their borgmatic
+integrations:
 
-For supported filesystems, borgmatic takes on-demand snapshots of configured
-source directories and feeds them to Borg. Here are the supported filesystems /
-volume managers and how to configure their borgmatic integrations:
-
- * [Btrfs](https://torsion.org/borgmatic/reference/configuration/data-sources/btrfs/)
- * [LVM](https://torsion.org/borgmatic/reference/configuration/data-sources/lvm/)
- * [ZFS](https://torsion.org/borgmatic/reference/configuration/data-sources/zfs/)
+{{ collections.all | eleventyNavigation: "🗄️ Data sources" | eleventyNavigationToHtml | replace: 'href="/reference/', 'href="/borgmatic/reference/' }}

docs/reference/configuration/data-sources/lvm.md

@@ -1,7 +1,7 @@
 ---
 title: LVM
 eleventyNavigation:
-  key: • LVM
+  key: LVM
   parent: 🗄️ Data sources
 ---
 <span class="minilink minilink-addedin">New in version 1.9.4</span> <span

docs/reference/configuration/data-sources/mariadb.md

@@ -1,7 +1,7 @@
 ---
 title: MariaDB
 eleventyNavigation:
-  key: • MariaDB
+  key: MariaDB
   parent: 🗄️ Data sources
 ---
 

docs/reference/configuration/data-sources/mongodb.md

@@ -1,7 +1,7 @@
 ---
 title: MongoDB
 eleventyNavigation:
-  key: • MongoDB
+  key: MongoDB
   parent: 🗄️ Data sources
 ---
 

docs/reference/configuration/data-sources/mysql.md

@@ -1,7 +1,7 @@
 ---
 title: MySQL
 eleventyNavigation:
-  key: • MySQL
+  key: MySQL
   parent: 🗄️ Data sources
 ---
 

docs/reference/configuration/data-sources/postgresql.md

@@ -1,7 +1,7 @@
 ---
 title: PostgreSQL
 eleventyNavigation:
-  key: • PostgreSQL
+  key: PostgreSQL
   parent: 🗄️ Data sources
 ---
 

docs/reference/configuration/data-sources/sqlite.md

@@ -1,7 +1,7 @@
 ---
 title: SQLite
 eleventyNavigation:
-  key: • SQLite
+  key: SQLite
   parent: 🗄️ Data sources
 ---
 <span class="minilink minilink-addedin">New in version 1.7.9</span> To backup

docs/reference/configuration/data-sources/zfs.md

@@ -1,7 +1,7 @@
 ---
 title: ZFS
 eleventyNavigation:
-  key: • ZFS
+  key: ZFS
   parent: 🗄️ Data sources
 ---
 <span class="minilink minilink-addedin">New in version 1.9.3</span> <span

docs/reference/configuration/monitoring/apprise.md

@@ -1,7 +1,7 @@
 ---
 title: Apprise
 eleventyNavigation:
-  key: • Apprise
+  key: Apprise
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.8.4</span>

docs/reference/configuration/monitoring/cronhub.md

@@ -1,7 +1,7 @@
 ---
 title: Cronhub
 eleventyNavigation:
-  key: • Cronhub
+  key: Cronhub
   parent: 🚨 Monitoring
 ---
 [Cronhub](https://cronhub.io/) provides "instant alerts when any of your

docs/reference/configuration/monitoring/cronitor.md

@@ -1,7 +1,7 @@
 ---
 title: Cronitor
 eleventyNavigation:
-  key: • Cronitor
+  key: Cronitor
   parent: 🚨 Monitoring
 ---
 [Cronitor](https://cronitor.io/) provides "Cron monitoring and uptime healthchecks

docs/reference/configuration/monitoring/healthchecks.md

@@ -1,7 +1,7 @@
 ---
 title: Healthchecks
 eleventyNavigation:
-  key: • Healthchecks
+  key: Healthchecks
   parent: 🚨 Monitoring
 ---
 [Healthchecks](https://healthchecks.io/) is a service that provides "instant

docs/reference/configuration/monitoring/index.md

@@ -11,15 +11,4 @@ interval (if supported). While these services and libraries offer different
 features, you probably only need to use one of them at most. See their
 documentation for configuration information:
 
- * [Apprise](https://torsion.org/borgmatic/reference/configuration/monitoring/apprise/)
- * [Cronhub](https://torsion.org/borgmatic/reference/configuration/monitoring/cronhub/)
- * [Cronitor](https://torsion.org/borgmatic/reference/configuration/monitoring/cronitor/)
- * [Grafana Loki](https://torsion.org/borgmatic/reference/configuration/monitoring/loki/)
- * [Healthchecks](https://torsion.org/borgmatic/reference/configuration/monitoring/healthchecks/)
- * [ntfy](https://torsion.org/borgmatic/reference/configuration/monitoring/ntfy/)
- * [PagerDuty](https://torsion.org/borgmatic/reference/configuration/monitoring/pagerduty/)
- * [Pushover](https://torsion.org/borgmatic/reference/configuration/monitoring/pushover/)
- * [Sentry](https://torsion.org/borgmatic/reference/configuration/monitoring/sentry/)
- * [Uptime Kuma](https://torsion.org/borgmatic/reference/configuration/monitoring/uptime-kuma/)
- * [Zabbix](https://torsion.org/borgmatic/reference/configuration/monitoring/zabbix/)
-
+{{ collections.all | eleventyNavigation: "🚨 Monitoring" | eleventyNavigationToHtml | replace: 'href="/reference/', 'href="/borgmatic/reference/' }}

docs/reference/configuration/monitoring/loki.md

@@ -1,7 +1,7 @@
 ---
 title: Loki
 eleventyNavigation:
-  key: • Loki
+  key: Loki
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.8.3</span> [Grafana

docs/reference/configuration/monitoring/ntfy.md

@@ -1,7 +1,7 @@
 ---
 title: ntfy
 eleventyNavigation:
-  key: • ntfy
+  key: ntfy
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.6.3</span>

docs/reference/configuration/monitoring/pagerduty.md

@@ -1,7 +1,7 @@
 ---
 title: PagerDuty
 eleventyNavigation:
-  key: • PagerDuty
+  key: PagerDuty
   parent: 🚨 Monitoring
 ---
 In case you're new here: [borgmatic](https://torsion.org/borgmatic/) is

docs/reference/configuration/monitoring/pushover.md

@@ -1,7 +1,7 @@
 ---
 title: Pushover
 eleventyNavigation:
-  key: • Pushover
+  key: Pushover
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.9.2</span>

docs/reference/configuration/monitoring/sentry.md

@@ -1,7 +1,7 @@
 ---
 title: Sentry
 eleventyNavigation:
-  key: • Sentry
+  key: Sentry
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.9.7</span>

docs/reference/configuration/monitoring/uptime-kuma.md

@@ -1,7 +1,7 @@
 ---
 title: Uptime Kuma
 eleventyNavigation:
-  key: • Uptime Kuma
+  key: Uptime Kuma
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.8.13</span> [Uptime

docs/reference/configuration/monitoring/zabbix.md

@@ -1,7 +1,7 @@
 ---
 title: Zabbix
 eleventyNavigation:
-  key: • Zabbix
+  key: Zabbix
   parent: 🚨 Monitoring
 ---
 <span class="minilink minilink-addedin">New in version 1.9.0</span>