From fb6217d868be29964b8d42bfa5afa1621d246288 Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Thu, 28 Oct 2021 18:09:38 +0200 Subject: [PATCH] docs for global flags --- docs/markdown/backend/options.md | 8 +----- docs/markdown/location/options.md | 46 ++++++++++++++++++++++++++++--- 2 files changed, 43 insertions(+), 11 deletions(-) diff --git a/docs/markdown/backend/options.md b/docs/markdown/backend/options.md index 2a49a56..63227dc 100644 --- a/docs/markdown/backend/options.md +++ b/docs/markdown/backend/options.md @@ -1,8 +1,6 @@ # 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). +> ℹ️ For more detail see the [location docs](/location/options) for options, as they are the same. ```yaml backend: @@ -18,8 +16,4 @@ backend: 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. - -> For flags without arguments you can set them to `true`. They will be handled accordingly. - > :ToCPrevNext diff --git a/docs/markdown/location/options.md b/docs/markdown/location/options.md index 7ac90c6..16d0260 100644 --- a/docs/markdown/location/options.md +++ b/docs/markdown/location/options.md @@ -1,8 +1,32 @@ # Options -For the `backup` and `forget` commands you can pass any native flags to `restic`. +For the `backup` and `forget` commands you can pass any native flags to `restic`. In addition you can specify flags for every command with `all`. -> It is also possible to set options for an [entire backend](/backend/options). +If flags don't start with `-` they will get prefixed with `--`. + +Flags without arguments can be set to `true`. They will be handled accordingly. + +> ℹ️ It is also possible to set options for an [entire backend](/backend/options) or globally (see below). + +```yaml +locations: + foo: + # ... + options: + all: + some-flag: 123 + # Equivalent to + --some-flag: 123 + backup: + boolean-flag: true + tag: + - foo + - bar +``` + +## Example + +In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command. ```yaml locations: @@ -16,8 +40,22 @@ locations: - bar ``` -In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command. +## Global Options -> For flags without arguments you can set them to `true`. They will be handled accordingly. +It is possible to specify global flags that will be run every time restic is invoked. To do so specify them under `global` in your config file. + +```yaml +global: + all: + cache-dir: ~/restic + backup: + tag: + - foo + +backends: + # ... +locations: + # ... +``` > :ToCPrevNext