From 90cd3171e53c7ef4ffb925315e83e03b4719e2c8 Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Mon, 17 May 2021 22:40:23 +0200 Subject: [PATCH] docs --- docs/markdown/_toc.md | 1 + docs/markdown/backend/options.md | 23 +++++++++++++++++++++++ docs/markdown/cli/forget.md | 2 +- docs/markdown/location/options.md | 2 ++ 4 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/markdown/backend/options.md diff --git a/docs/markdown/_toc.md b/docs/markdown/_toc.md index 8b71d51..45997ec 100644 --- a/docs/markdown/_toc.md +++ b/docs/markdown/_toc.md @@ -22,6 +22,7 @@ > > [Overview](/backend/overview) > [Available Backends](/backend/available) +> [Options](/backend/options) > :Collapse label=CLI > diff --git a/docs/markdown/backend/options.md b/docs/markdown/backend/options.md new file mode 100644 index 0000000..10c4561 --- /dev/null +++ b/docs/markdown/backend/options.md @@ -0,0 +1,23 @@ +# Options + +For the `backup` and `forget` commands you can pass any native flags to `restic`. + +> It is also possible to set options for an [a specific location](/location/options). + +```yaml +backend: + foo: + type: ... + path: ... + options: + backup: + tag: + - foo + - bar +``` + +In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command. + +For more detail see the [location docs](/location/options) for options, as they are the same + +> :ToCPrevNext diff --git a/docs/markdown/cli/forget.md b/docs/markdown/cli/forget.md index e17e93a..d9b18e5 100644 --- a/docs/markdown/cli/forget.md +++ b/docs/markdown/cli/forget.md @@ -4,7 +4,7 @@ autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune] ``` -This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget) +This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget). The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data. diff --git a/docs/markdown/location/options.md b/docs/markdown/location/options.md index d2e0782..e0bd0f9 100644 --- a/docs/markdown/location/options.md +++ b/docs/markdown/location/options.md @@ -2,6 +2,8 @@ For the `backup` and `forget` commands you can pass any native flags to `restic`. +> It is also possible to set options for an [entire backend](/backend/options). + ```yaml locations: foo: