borg/docs/usage/general/repository-locations.rst.inc

Repository Locations / Archive names
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Many commands need to know the repository location, give it via ``-r`` / ``--repo``
or use the ``BORG_REPO`` environment variable.

Commands needing one or two archive names usually get them as positional argument.

Commands working with an arbitrary amount of archives, usually take ``-a ARCH_GLOB``.

Archive names must not contain the ``/`` (slash) character. For simplicity,
maybe also avoid blanks or other characters that have special meaning on the
shell or in a filesystem (borg mount will use the archive name as directory
name).
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`Repository Locations / Archive names`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
[DOCS] #4587 – Make Sphinx warnings break docs build general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label". To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels. 2020-03-16 18:17:16 +00:00
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			Many commands need to know the repository location, give it via ``-r`` / ``--repo``
			or use the ``BORG_REPO`` environment variable.

			`Commands needing one or two archive names usually get them as positional argument.`

			Commands working with an arbitrary amount of archives, usually take ``-a ARCH_GLOB``.
[DOCS] #4587 – Make Sphinx warnings break docs build general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label". To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels. 2020-03-16 18:17:16 +00:00
			Archive names must not contain the ``/`` (slash) character. For simplicity,
			`maybe also avoid blanks or other characters that have special meaning on the`
			`shell or in a filesystem (borg mount will use the archive name as directory`
			`name).`