Browse Source

Link to action reference documentation instead of "--help".

Dan Helfman 3 weeks ago
parent
commit
2db5525f72

+ 3 - 2
docs/how-to/extract-a-backup.md

@@ -195,8 +195,9 @@ If you want to extract the configuration file from a specific archive, use the
 borgmatic config bootstrap --repository repo.borg --archive host-2023-01-02T04:06:07.080910 --destination /tmp
 ```
 
-See the output of `config bootstrap --help` for additional flags you may need
-for bootstrapping.
+See the [config bootstrap action
+documentation](https://torsion.org/borgmatic/reference/command-line/actions/config-bootstrap/)
+for additional flags you may need for bootstrapping.
 
 <span class="minilink minilink-addedin">New in version 1.9.3</span>
 If your borgmatic configuration files contain sensitive information you don't

+ 8 - 6
docs/how-to/make-per-application-backups.md

@@ -48,12 +48,14 @@ Additionally, the `~/.config/borgmatic.d/` directory works the same way as
 `/etc/borgmatic.d`.
 
 If you need even more customizability, you can specify alternate configuration
-paths on the command-line with borgmatic's `--config` flag. (See `borgmatic
---help` for more information.) For instance, if you want to schedule your
-various borgmatic backups to run at different times, you'll need multiple
-entries in your [scheduling software of
-choice](https://torsion.org/borgmatic/how-to/set-up-backups/#autopilot),
-each entry using borgmatic's `--config` flag instead of relying on
+paths on the command-line with borgmatic's `--config` flag. (See the
+[command-line
+documentation](https://torsion.org/borgmatic/reference/command-line/) for more
+information.) For instance, if you want to schedule your various borgmatic
+backups to run at different times, you'll need multiple entries in your
+[scheduling software of
+choice](https://torsion.org/borgmatic/how-to/set-up-backups/#autopilot), each
+entry using borgmatic's `--config` flag instead of relying on
 `/etc/borgmatic.d`.
 
 

+ 5 - 1
docs/how-to/set-up-backups.md

@@ -264,7 +264,11 @@ expectations based on your configuration.
 If you'd like to specify an alternate configuration file path, use the
 `--config` flag.
 
-See `borgmatic --help` and `borgmatic create --help` for more information.
+See [command-line
+documentation](https://torsion.org/borgmatic/reference/command-line/) and the
+[create action
+documentation](https://torsion.org/borgmatic/reference/command-line/actions/create/)
+for more information.
 
 
 <a id="default-actions"></a>

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

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

+ 3 - 1
docs/reference/configuration/monitoring/apprise.md

@@ -72,7 +72,9 @@ when a backup finishes or fails.
 
 You can customize the verbosity of the logs that are sent with borgmatic's
 `--monitoring-verbosity` flag. The `--list` and `--stats` flags may also be of
-use. See `borgmatic create --help` for more information.
+use. See [create action
+documentation](https://torsion.org/borgmatic/reference/command-line/actions/create/)
+for more information.
 
 <span class="minilink minilink-addedin">New in version 2.0.0</span>Set the
 defaults for these flags in your borgmatic configuration via the

+ 6 - 5
docs/reference/configuration/monitoring/healthchecks.md

@@ -35,11 +35,12 @@ included for errors that occur when a `create`, `prune`, `compact`, or `check`
 action is run.
 
 You can customize the verbosity of the logs that are sent to Healthchecks with
-borgmatic's `--monitoring-verbosity` flag. The `--list` and `--stats` flags
-may also be of use. See `borgmatic create --help` for more information.
-Additionally, see the [borgmatic configuration
-file](https://torsion.org/borgmatic/reference/configuration/) for
-additional Healthchecks options.
+borgmatic's `--monitoring-verbosity` flag. The `--list` and `--stats` flags may
+also be of use. See [create action
+documentation](https://torsion.org/borgmatic/reference/command-line/actions/create/)
+for more information.  Additionally, see the [borgmatic configuration
+file](https://torsion.org/borgmatic/reference/configuration/) for additional
+Healthchecks options.
 
 <span class="minilink minilink-addedin">New in version 2.0.0</span>Set the
 defaults for these flags in your borgmatic configuration via the

+ 3 - 1
docs/reference/configuration/monitoring/pagerduty.md

@@ -51,7 +51,9 @@ incident UI and corresponding notification emails.
 
 You can customize the verbosity of the logs that are sent with borgmatic's
 `--monitoring-verbosity` flag. The `--list` and `--stats` flags may also be of
-use. See `borgmatic create --help` for more information.
+use. See [create action
+documentation](https://torsion.org/borgmatic/reference/command-line/actions/create/)
+for more information.
 
 <span class="minilink minilink-addedin">New in version 2.0.0</span>Set the
 defaults for these flags in your borgmatic configuration via the