upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-04-29 10:01:06 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Various minor documentation updates: mention sshfs, Linux packages,

Browse source 
minor changes to prose, etc.
This commit is contained in:
Dan Christensen 2014-02-03 21:26:36 -05:00
parent 6b639e4c22
commit 0b9969d162
4 changed files with 30 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/global.rst.inc
View file

@ -13,6 +13,7 @@
.. _OpenSSL: https://www.openssl.org/
.. _Python: http://www.python.org/
.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
.. _llfuse: https://pypi.python.org/pypi/llfuse/
.. _homebrew: http://mxcl.github.io/homebrew/
.. _issue tracker: https://github.com/jborg/attic/issues
.. _userspace filesystems: https://en.wikipedia.org/wiki/Filesystem_in_Userspace

14
docs/index.rst
View file

@ -5,7 +5,7 @@ Welcome to Attic
|project_name| is a deduplicating backup program written in Python.
The main goal of |project_name| is to provide an efficient and secure way
to backup data. The data deduplication technique used makes |project_name|
suitable for daily backups since only actual changes are stored.
suitable for daily backups since only the changes are stored.
Easy to use
@ -44,17 +44,17 @@ User's Guide
Getting help
============
If you've found a bug or have a concrete feature request you can add your bug
report or feature request directly to the project `issue tracker`_. For more
general questions or discussions a post to the mailing list is preferred.
If you've found a bug or have a concrete feature request, you can add your bug
report or feature request directly to the project's `issue tracker`_. For more
general questions or discussions, a post to the mailing list is preferred.
Mailing list
------------
There is a mailing list for Attic on librelist_ you can use for feature
There is a mailing list for Attic on librelist_ that you can use for feature
requests and general discussions about Attic. A mailing list archive is
available `here <http://librelist.com/browser/attic/>`_.
To subscribe to the list send an email to attic@librelist.com and reply
to the confirmation mail. Likevise To unsubscribe send an email to
To subscribe to the list, send an email to attic@librelist.com and reply
to the confirmation mail. Likewise, to unsubscribe, send an email to
attic-unsubscribe@librelist.com and reply to the confirmation mail.

13
docs/installation.rst
View file

@ -5,7 +5,7 @@ Installation
============
|project_name| requires Python_ 3.2 or above to work. Even though Python 3 is
not the default Python version on most Linux distributions it is usually
not the default Python version on most Linux distributions, it is usually
available as an optional install.
Other dependencies:
@ -16,6 +16,9 @@ Other dependencies:
The OpenSSL version bundled with Mac OS X and FreeBSD is most likey too old.
Newer versions are available from homebrew_ on OS X and from FreeBSD ports.
The llfuse_ python package is also required if you wish to mount an
archive as a FUSE filesystem.
Installing from PyPI using pip
------------------------------
::
@ -39,5 +42,11 @@ Installing from git
$ cd attic
$ python setup.py install
Please not that when installing from git Cython_ is required to generate some files that
Please note that when installing from git, Cython_ is required to generate some files that
are normally bundled with the release tarball.
Packages
--------
|project_name| is also part of the Debian_, Ubuntu_ and `Arch Linux`_
distributions of GNU/Linux.

15
docs/quickstart.rst
View file

@ -113,13 +113,20 @@ Key file based encryption
Remote repositories
-------------------
|project_name| can initialize and access repositories on remote hosts as the
host is accessible using SSH and |project_name| is installed.
The following syntax is used to address remote repositories::
|project_name| can initialize and access repositories on remote hosts if the
host is accessible using SSH. This is fastest and easiest when |project_name|
is installed on the remote host, in which case the following syntax is used::
$ attic init user@hostname:repository.attic
or::
$ attic init ssh://user@hostname:port/repository.attic
If it is not possible to install |project_name| on the remote host,
it is still possible to use the remote host to store a repository by
mounting the remote filesystem, for example, using sshfs::
$ sshfs user@hostname:/path/to/folder /tmp/mymountpoint
$ attic init /tmp/mymountpoint/repository.attic
$ fusermount -u /tmp/mymountpoint