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

Docu: first proof reading

Browse Source 
This is a first proof reading of the currently existing documentation.

fixes (hopefully all):
* spelling
* grammar

Tries to increase readabilty and ease of understanding by simplifying
and restructing some sentences and paragraphs. Filler words which add
to the cognitive load but don't add anything are removed
(most notably `also`).
This commit is contained in:
Aaron Lauterer
2020-04-14 17:12:47 +02:00
committed by Dietmar Maurer
parent 9a328319dd
commit 4f3db187cf
6 changed files with 239 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/pxar/description.rst
View File

@ -1,15 +1,15 @@
Description
^^^^^^^^^^^
``pxar`` is a command line utility used to create and manipulate archives in the
``pxar`` is a command line utility to create and manipulate archives in the
:ref:`pxar-format`.
It is inspired by `casync file archive format
<http://0pointer.net/blog/casync-a-tool-for-distributing-file-system-images.html>`_,
which has a similar use-case.
The ``.pxar`` format is adapted to fulfill the specific needs of the proxmox
backup server, for example efficient storage of hardlinks.
which caters to a similar use-case.
The ``.pxar`` format is adapted to fulfill the specific needs of the Proxmox
Backup Server, for example, efficient storage of hardlinks.
The format is designed to reduce storage space needed on the server by achieving
high de-duplication.
a high level of de-duplication.
Creating an Archive
^^^^^^^^^^^^^^^^^^^
@ -20,23 +20,23 @@ Run the following command to create an archive of a folder named ``source``:
# pxar create archive.pxar source
This will create a new archive called ``archive.pxar`` from the contents of the
This will create a new archive called ``archive.pxar`` with the contents of the
``source`` folder.
.. NOTE:: ``pxar`` will not overwrite any existing archives. If an archive with
the same name is already present in the target folder, the creation will
fail.
By default, ``pxar`` will skip certain mountpoints and not follow device
By default, ``pxar`` will skip certain mountpoints and will not follow device
boundaries. This design decision is based on the primary use case of creating
archives for backups, where it makes no sense to store the content of certain
archives for backups. It is sensible to not back up the contents of certain
temporary or system specific files.
In order to alter this behavior and follow device boundaries, use the
To alter this behavior and follow device boundaries, use the
``--all-file-systems`` flag.
It is possible to exclude certain files and/or folders from the archive by
passing glob match patterns as additional parameters. Whenever a file is matched
by one of the patterns, you will get a warning saying that this file is skipped
by one of the patterns, you will get a warning stating that this file is skipped
and therefore not included in the archive.
For example, you can exclude all files ending in ``.txt`` from the archive
@ -50,7 +50,7 @@ Be aware that the shell itself will try to expand all of the glob patterns befor
invoking ``pxar``.
In order to avoid this, all globs have to be quoted correctly.
It is also possible to pass a list of match pattern to fulfill more complex
It is possible to pass a list of match patterns to fulfill more complex
file exclusion/inclusion behavior, although it is recommended to use the
``.pxarexclude`` files instead for such cases.
@ -67,7 +67,7 @@ All the glob pattern are relative to the ``source`` directory.
previous ones. Permutations of the same patterns lead to different results.
``pxar`` will store the list of glob match patterns passed as parameters via the
command line in a file called ``.pxarexclude-cli`` and store it at the root of
command line in a file called ``.pxarexclude-cli`` and stores it at the root of
the archive.
If a file with this name is already present in the source folder during archive
creation, this file is not included in the archive and the file containing the
@ -79,9 +79,9 @@ It is possible to create and place these files in any directory of the filesyste
tree.
These files must contain one pattern per line, again later patterns win over
previous ones.
The patterns control file exclusion of files present within the given directory
The patterns control file exclusions of files present within the given directory
or further below it in the tree.
The behaviour is the same as described in :ref:`creating-backups`.
The behavior is the same as described in :ref:`creating-backups`.
Extracting an Archive
^^^^^^^^^^^^^^^^^^^^^
@ -96,7 +96,7 @@ with the following command:
If no target is provided, the content of the archive is extracted to the current
working directory.
In order to restore only part of an archive or single files and/or folders,
In order to restore only parts of an archive, single files and/or folders,
it is possible to pass the corresponding glob match patterns as additional
parameters or use the patterns stored in a file:
@ -109,8 +109,8 @@ sub-folders in the archive ``etc.pxar`` to the target ``/restore/target/etc``.
A path to the file containing match patterns can be specified using the
``--files-from`` parameter.
List the Content of an Archive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
List the Contents of an Archive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To display the files and directories contained in an archive ``archive.pxar``,
run the following command:
@ -126,7 +126,7 @@ Mounting an Archive
^^^^^^^^^^^^^^^^^^^
``pxar`` allows you to mount and inspect the contents of an archive via _`FUSE`.
In order to mount an archive named ``archive.pxar`` to the mountpoint ``mnt``,
In order to mount an archive named ``archive.pxar`` to the mountpoint ``/mnt``,
run the command:
.. code-block:: console