psw/norgbackup
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added adjusted cmd line ref

Browse source
This commit is contained in:
Paul Wilde 2024-09-03 11:42:49 +01:00
parent f1db893c86
commit f3c1618b7f
3 changed files with 24 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/content/reference/command_line.md
View file

@ -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. 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. Please use `norg --help` to view all available parameters in your version.
```help ```help
Norg {{ get_source(path="other/command_line.txt",pure=true) }}
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)
``` ```
The `-c`, or `--config`, parameter is required. Failing to provide this will only show the above help information. The `-c`, or `--config`, parameter is required. Failing to provide this will only show the above help information.

2
docs/norgbackupweb

@ -1 +1 @@
Subproject commit 0795f6263f7c25b27713682845ce55f01bc6b4ca Subproject commit a53d569f754acb95daef91071b5f22e4e1da82f9

22
docs/static/other/command_line.txt vendored Normal file
View file

@ -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.