From f3c1618b7f638e6822af18f1a5cfc2b49efb7de7 Mon Sep 17 00:00:00 2001 From: Paul Wilde Date: Tue, 3 Sep 2024 11:42:49 +0100 Subject: [PATCH] added adjusted cmd line ref --- docs/content/reference/command_line.md | 21 +-------------------- docs/norgbackupweb | 2 +- docs/static/other/command_line.txt | 22 ++++++++++++++++++++++ 3 files changed, 24 insertions(+), 21 deletions(-) create mode 100644 docs/static/other/command_line.txt diff --git a/docs/content/reference/command_line.md b/docs/content/reference/command_line.md index f466c22..b917463 100644 --- a/docs/content/reference/command_line.md +++ b/docs/content/reference/command_line.md @@ -6,26 +6,7 @@ Here are the available norg command line parameters for the most recent version. If you are using an older version of norg some of these parameters may not work. Please use `norg --help` to view all available parameters in your version. ```help -Norg -A portable borg backup wrapper utility - -Usage: - [options] [command] [further_args ...] - -Arguments: - [command] The command to run, defaults to 'create' which will perform a backup. (default: create) - [further_args ...] - Any further arguments to send onto borg or restic. - -Options: - -h, --help - -c, --config=CONFIG Config file to use. - -d, --destination=DESTINATION - Destination when extracting backup - -r, --repository=REPOSITORY - Define an explicit repository to work on by either label or path. - -a, --archive=ARCHIVE The archive or snapshot to operate on - -s, --stats Provides statistics at the end of a backup (Borg only) +{{ get_source(path="other/command_line.txt",pure=true) }} ``` The `-c`, or `--config`, parameter is required. Failing to provide this will only show the above help information. diff --git a/docs/norgbackupweb b/docs/norgbackupweb index 0795f62..a53d569 160000 --- a/docs/norgbackupweb +++ b/docs/norgbackupweb @@ -1 +1 @@ -Subproject commit 0795f6263f7c25b27713682845ce55f01bc6b4ca +Subproject commit a53d569f754acb95daef91071b5f22e4e1da82f9 diff --git a/docs/static/other/command_line.txt b/docs/static/other/command_line.txt new file mode 100644 index 0000000..5d2e059 --- /dev/null +++ b/docs/static/other/command_line.txt @@ -0,0 +1,22 @@ +Norg -- v0.1.8 +A portable borg backup wrapper utility. + +Usage: + [options] [command] [further_args ...] + +Arguments: + [command] The command to run, defaults to 'create' which will perform a backup. (default: create) + [further_args ...] + Any further arguments to send onto borg or restic. + +Options: + -h, --help + -c, --config=CONFIG Config file to use. + -d, --destination=DESTINATION + Destination when extracting backup, + -r, --repository=REPOSITORY + Define an explicit repository to work on by either label or path. + -a, --archive=ARCHIVE The archive or snapshot to operate on. + -s, --stats Provides statistics at the end of a backup (Borg only). + -v, --version Shows the current norg version. +