소스 검색

Updates to quickstart.rst, including sshfs locking warning

Dan Christensen 11 년 전
부모
커밋
2d4382b2ee
1개의 변경된 파일11개의 추가작업 그리고 7개의 파일을 삭제
  1. 11 7
      docs/quickstart.rst

+ 11 - 7
docs/quickstart.rst

@@ -11,7 +11,7 @@ The next section continues by showing how backups can be automated.
 A step by step example
 A step by step example
 ----------------------
 ----------------------
 
 
-1. Before any backup can be taken a repository has to be initialized::
+1. Before a backup can be made a repository has to be initialized::
 
 
     $ attic init /somewhere/my-backup.attic
     $ attic init /somewhere/my-backup.attic
 
 
@@ -25,8 +25,8 @@ A step by step example
     $ attic create -v --stats /somwhere/my-backup.attic::second-backup ~/src ~/Documents
     $ attic create -v --stats /somwhere/my-backup.attic::second-backup ~/src ~/Documents
 
 
    This backup will be a lot quicker and a lot smaller since only new never
    This backup will be a lot quicker and a lot smaller since only new never
-   before seen data is stored. The ``--stats`` causes |project_name| to output
-   statistics about the newly created archive such as the amount of unique
+   before seen data is stored. The ``--stats`` option causes |project_name| to
+   output statistics about the newly created archive such as the amount of unique
    data (not shared with other archives).
    data (not shared with other archives).
 
 
 4. List all archives in the repository::
 4. List all archives in the repository::
@@ -49,7 +49,7 @@ A step by step example
 Automating backups
 Automating backups
 ------------------
 ------------------
 
 
-The following example script backups up ``/home`` and
+The following example script backs up ``/home`` and
 ``/var/www`` to a remote server. The script also uses the
 ``/var/www`` to a remote server. The script also uses the
 :ref:`attic_prune` subcommand to maintain a certain number
 :ref:`attic_prune` subcommand to maintain a certain number
 of old archives::
 of old archives::
@@ -65,14 +65,14 @@ of old archives::
         /var/www                                    \
         /var/www                                    \
         --exclude /home/*/.cache                    \
         --exclude /home/*/.cache                    \
         --exclude /home/Ben/Music/Justin\ Bieber    \
         --exclude /home/Ben/Music/Justin\ Bieber    \
-        --exclude *.pyc
+        --exclude '*.pyc'
 
 
     # Use the `prune` subcommand to maintain 7 daily, 4 weekly
     # Use the `prune` subcommand to maintain 7 daily, 4 weekly
     # and 6 monthly archives.
     # and 6 monthly archives.
     attic prune -v $REPOSITORY --daily=7 --weekly=4 --monthly=6
     attic prune -v $REPOSITORY --daily=7 --weekly=4 --monthly=6
 
 
 .. Note::
 .. Note::
-    This script assumes the repository has already been initalized with
+    This script assumes the repository has already been initialized with
     :ref:`attic_init`.
     :ref:`attic_init`.
 
 
 .. _encrypted_repos:
 .. _encrypted_repos:
@@ -80,7 +80,7 @@ of old archives::
 Repository encryption
 Repository encryption
 ---------------------
 ---------------------
 
 
-Repository encryption is enabled at repository encryption time::
+Repository encryption is enabled at repository creation time::
 
 
     $ attic init --encryption=passphrase|keyfile PATH
     $ attic init --encryption=passphrase|keyfile PATH
 
 
@@ -130,3 +130,7 @@ mounting the remote filesystem, for example, using sshfs::
   $ sshfs user@hostname:/path/to/folder /tmp/mymountpoint
   $ sshfs user@hostname:/path/to/folder /tmp/mymountpoint
   $ attic init /tmp/mymountpoint/repository.attic
   $ attic init /tmp/mymountpoint/repository.attic
   $ fusermount -u /tmp/mymountpoint
   $ fusermount -u /tmp/mymountpoint
+
+However, be aware that sshfs doesn't fully implement POSIX locks, so
+you must be sure to not have two processes trying to access the same
+repository at the same time.