From 735339c20949f528228ac1b8c16f73016d36e764 Mon Sep 17 00:00:00 2001 From: Marian Beermann Date: Mon, 17 Jul 2017 00:11:30 +0200 Subject: [PATCH] docs: streamline installation: platforms table --- docs/installation.rst | 72 -------------------------------------- docs/usage_general.rst.inc | 72 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 72 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 026aad1c3..de7a582aa 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -117,78 +117,6 @@ the old version using the same steps as shown above. .. _pyinstaller: http://www.pyinstaller.org .. _releases: https://github.com/borgbackup/borg/releases -.. _platforms: - -Features & platforms --------------------- - -Besides regular file and directory structures, |project_name| can preserve - -* Symlinks (stored as symlink, the symlink is not followed) -* Special files: - - * Character and block device files (restored via mknod) - * FIFOs ("named pipes") - * Special file *contents* can be backed up in ``--read-special`` mode. - By default the metadata to create them with mknod(2), mkfifo(2) etc. is stored. -* Hardlinked regular files, devices, FIFOs (considering all items in the same archive) -* Timestamps in nanosecond precision: mtime, atime, ctime -* Permissions: - - * IDs of owning user and owning group - * Names of owning user and owning group (if the IDs can be resolved) - * Unix Mode/Permissions (u/g/o permissions, suid, sgid, sticky) - -On some platforms additional features are supported: - -.. Yes/No's are grouped by reason/mechanism/reference. - -+------------------+----------+-----------+------------+ -| Platform | ACLs | xattr | Flags | -| | [#acls]_ | [#xattr]_ | [#flags]_ | -+==================+==========+===========+============+ -| Linux x86 | Yes | Yes | Yes [1]_ | -+------------------+ | | | -| Linux PowerPC | | | | -+------------------+ | | | -| Linux ARM | | | | -+------------------+----------+-----------+------------+ -| Mac OS X | Yes | Yes | Yes (all) | -+------------------+----------+-----------+ | -| FreeBSD | Yes | Yes | | -+------------------+----------+-----------+ | -| OpenBSD | n/a | n/a | | -+------------------+----------+-----------+ | -| NetBSD | n/a | No [2]_ | | -+------------------+----------+-----------+------------+ -| Solaris 11 | No [3]_ | n/a | -+------------------+ | | -| OpenIndiana | | | -+------------------+----------+-----------+------------+ -| Windows (cygwin) | No [4]_ | No | No | -+------------------+----------+-----------+------------+ - -Some Distributions (e.g. Debian) run additional tests after each release, these -are not reflected here. - -Other Unix-like operating systems may work as well, but have not been tested at all. - -Note that most of the platform-dependent features also depend on the file system. -For example, ntfs-3g on Linux isn't able to convey NTFS ACLs. - -.. [1] Only "nodump", "immutable", "compressed" and "append" are supported. - Feature request :issue:`618` for more flags. -.. [2] Feature request :issue:`1332` -.. [3] Feature request :issue:`1337` -.. [4] Cygwin tries to map NTFS ACLs to permissions with varying degress of success. - -.. [#acls] The native access control list mechanism of the OS. This normally limits access to - non-native ACLs. For example, NTFS ACLs aren't completely accessible on Linux with ntfs-3g. -.. [#xattr] extended attributes; key-value pairs attached to a file, mainly used by the OS. - This includes resource forks on Mac OS X. -.. [#flags] aka *BSD flags*. The Linux set of flags [1]_ is portable across platforms. - The BSDs define additional flags. - .. _source-install: From Source diff --git a/docs/usage_general.rst.inc b/docs/usage_general.rst.inc index 77301b02b..94b92a3c1 100644 --- a/docs/usage_general.rst.inc +++ b/docs/usage_general.rst.inc @@ -354,3 +354,75 @@ Network (only for client/server operation): operations used for transaction support also go over the connection. If you backup multiple sources to one target repository, additional traffic happens for cache resynchronization. + +.. _platforms: + +Support for file metadata +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Besides regular file and directory structures, |project_name| can preserve + +* Symlinks (stored as symlink, the symlink is not followed) +* Special files: + + * Character and block device files (restored via mknod) + * FIFOs ("named pipes") + * Special file *contents* can be backed up in ``--read-special`` mode. + By default the metadata to create them with mknod(2), mkfifo(2) etc. is stored. +* Hardlinked regular files, devices, FIFOs (considering all items in the same archive) +* Timestamps in nanosecond precision: mtime, atime, ctime +* Permissions: + + * IDs of owning user and owning group + * Names of owning user and owning group (if the IDs can be resolved) + * Unix Mode/Permissions (u/g/o permissions, suid, sgid, sticky) + +On some platforms additional features are supported: + +.. Yes/No's are grouped by reason/mechanism/reference. + ++------------------+----------+-----------+------------+ +| Platform | ACLs | xattr | Flags | +| | [#acls]_ | [#xattr]_ | [#flags]_ | ++==================+==========+===========+============+ +| Linux x86 | Yes | Yes | Yes [1]_ | ++------------------+ | | | +| Linux PowerPC | | | | ++------------------+ | | | +| Linux ARM | | | | ++------------------+----------+-----------+------------+ +| Mac OS X | Yes | Yes | Yes (all) | ++------------------+----------+-----------+ | +| FreeBSD | Yes | Yes | | ++------------------+----------+-----------+ | +| OpenBSD | n/a | n/a | | ++------------------+----------+-----------+ | +| NetBSD | n/a | No [2]_ | | ++------------------+----------+-----------+------------+ +| Solaris 11 | No [3]_ | n/a | ++------------------+ | | +| OpenIndiana | | | ++------------------+----------+-----------+------------+ +| Windows (cygwin) | No [4]_ | No | No | ++------------------+----------+-----------+------------+ + +Some Distributions (e.g. Debian) run additional tests after each release, these +are not reflected here. + +Other Unix-like operating systems may work as well, but have not been tested at all. + +Note that most of the platform-dependent features also depend on the file system. +For example, ntfs-3g on Linux isn't able to convey NTFS ACLs. + +.. [1] Only "nodump", "immutable", "compressed" and "append" are supported. + Feature request :issue:`618` for more flags. +.. [2] Feature request :issue:`1332` +.. [3] Feature request :issue:`1337` +.. [4] Cygwin tries to map NTFS ACLs to permissions with varying degress of success. + +.. [#acls] The native access control list mechanism of the OS. This normally limits access to + non-native ACLs. For example, NTFS ACLs aren't completely accessible on Linux with ntfs-3g. +.. [#xattr] extended attributes; key-value pairs attached to a file, mainly used by the OS. + This includes resource forks on Mac OS X. +.. [#flags] aka *BSD flags*. The Linux set of flags [1]_ is portable across platforms. + The BSDs define additional flags.