tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: some textwidth cleanups 

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2022-05-17 13:55:04 +02:00
parent 5e1b17018b
commit a3b1026753
1 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
docs/backup-client.rst
View File

@ -120,11 +120,11 @@ This will prompt you for a password, then upload a file archive named
(i.e. ``--include-dev /boot/efi``). You can use this option (i.e. ``--include-dev /boot/efi``). You can use this option
multiple times for each mount point that should be included. multiple times for each mount point that should be included.
The ``--repository`` option can get quite long and is used by all The ``--repository`` option can get quite long and is used by all commands. You
commands. You can avoid having to enter this value by setting the can avoid having to enter this value by setting the environment variable
environment variable ``PBS_REPOSITORY``. Note that if you would like this to ``PBS_REPOSITORY``. Note that if you would like this to remain set over
remain set over multiple sessions, you should instead add the below line to your multiple sessions, you should instead add the below line to your ``.bashrc``
``.bashrc`` file. file.
.. code-block:: console .. code-block:: console
@ -159,21 +159,22 @@ device images. To create a backup of a block device, run the following command:
Excluding Files/Directories from a Backup Excluding Files/Directories from a Backup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sometimes it is desired to exclude certain files or directories from a backup archive. Sometimes it is desired to exclude certain files or directories from a backup
To tell the Proxmox Backup client when and how to ignore files and directories, archive. To tell the Proxmox Backup client when and how to ignore files and
place a text file named ``.pxarexclude`` in the filesystem hierarchy. directories, place a text file named ``.pxarexclude`` in the filesystem
Whenever the backup client encounters such a file in a directory, it interprets hierarchy. Whenever the backup client encounters such a file in a directory,
each line as a glob match pattern for files and directories that are to be excluded it interprets each line as a glob match pattern for files and directories that
from the backup. are to be excluded from the backup.
The file must contain a single glob pattern per line. Empty lines and lines The file must contain a single glob pattern per line. Empty lines and lines
starting with ``#`` (indicating a comment) are ignored. starting with ``#`` (indicating a comment) are ignored.
A ``!`` at the beginning of a line reverses the glob match pattern from an exclusion A ``!`` at the beginning of a line reverses the glob match pattern from an
to an explicit inclusion. This makes it possible to exclude all entries in a exclusion to an explicit inclusion. This makes it possible to exclude all
directory except for a few single files/subdirectories. entries in a directory except for a few single files/subdirectories.
Lines ending in ``/`` match only on directories. Lines ending in ``/`` match only on directories.
The directory containing the ``.pxarexclude`` file is considered to be the root of The directory containing the ``.pxarexclude`` file is considered to be the root
the given patterns. It is only possible to match files in this directory and its subdirectories. of the given patterns. It is only possible to match files in this directory and
its subdirectories.
.. Note:: Patterns without a leading ``/`` will also match in subdirectories, .. Note:: Patterns without a leading ``/`` will also match in subdirectories,
while patterns with a leading ``/`` will only match in the current directory. while patterns with a leading ``/`` will only match in the current directory.
@ -185,15 +186,15 @@ the given patterns. It is only possible to match files in this directory and its
the pattern ``**/*.tmp``, it would exclude all files ending in ``.tmp`` within the pattern ``**/*.tmp``, it would exclude all files ending in ``.tmp`` within
a directory and its subdirectories. a directory and its subdirectories.
``[...]`` matches a single character from any of the provided characters within ``[...]`` matches a single character from any of the provided characters within
the brackets. ``[!...]`` does the complementary and matches any single character the brackets. ``[!...]`` does the complementary and matches any single
not contained within the brackets. It is also possible to specify ranges with two character not contained within the brackets. It is also possible to specify
characters separated by ``-``. For example, ``[a-z]`` matches any lowercase ranges with two characters separated by ``-``. For example, ``[a-z]`` matches
alphabetic character, and ``[0-9]`` matches any single digit. any lowercase alphabetic character, and ``[0-9]`` matches any single digit.
The order of the glob match patterns defines whether a file is included or The order of the glob match patterns defines whether a file is included or
excluded, that is to say, later entries override earlier ones. excluded, that is to say, later entries override earlier ones.
This is also true for match patterns encountered deeper down the directory tree, This is also true for match patterns encountered deeper down the directory
which can override a previous exclusion. tree, which can override a previous exclusion.
.. Note:: Excluded directories will **not** be read by the backup client. Thus, .. Note:: Excluded directories will **not** be read by the backup client. Thus,
a ``.pxarexclude`` file in an excluded subdirectory will have no effect. a ``.pxarexclude`` file in an excluded subdirectory will have no effect.
@ -565,10 +566,10 @@ user that has ``Datastore.Modify`` privileges on the datastore.
# proxmox-backup-client change-owner vm/103 john@pbs # proxmox-backup-client change-owner vm/103 john@pbs
This can also be done from within the web interface, by navigating to the This can also be done from within the web interface, by navigating to the
`Content` section of the datastore that contains the backup group and `Content` section of the datastore that contains the backup group and selecting
selecting the user icon under the `Actions` column. Common cases for this could the user icon under the `Actions` column. Common cases for this could be to
be to change the owner of a sync job from ``root@pam``, or to repurpose a change the owner of a sync job from ``root@pam``, or to repurpose a backup
backup group. group.
.. _backup-pruning: .. _backup-pruning: