upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-05-28 04:03:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: document good and problematic option placements, see #3356

Browse source
This commit is contained in:
Thomas Waldmann 2017-12-09 02:57:41 +01:00
parent dab45ced20
commit 8db5d1ba90
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/usage.rst
View file

@ -12,6 +12,23 @@ command in detail.
General
-------
Positional Arguments and Options: Order matters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Borg only supports taking options (``-v`` and ``--list`` in the example)
to the left or right of all positional arguments (``repo::archive`` and ``path``
in the example), but not in between them:
::
borg extract -v --list repo::archive path # good and preferred
borg extract repo::archive path -v --list # also works
borg extract -v repo::archive path --list # works, but ugly
borg extract repo::archive -v --list path # BAD
This is due to a problem in the argparse module: http://bugs.python.org/issue15112
Repository URLs
~~~~~~~~~~~~~~~