diff --git a/docs/man/borg.1 b/docs/man/borg.1 index 78b7bb1c0..49256fa6a 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -54,7 +54,7 @@ it does not matter when or where archives were created (e.g. different hosts). .SS A step\-by\-step example .INDENT 0.0 .IP 1. 3 -Before a backup can be made a repository has to be initialized: +Before a backup can be made, a repository has to be initialized: .INDENT 3.0 .INDENT 3.5 .sp @@ -91,7 +91,7 @@ $ borg \-r /path/to/repo create \-\-stats Tuesday ~/src ~/Documents .UNINDENT .UNINDENT .sp -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 \fB\-\-stats\fP option causes Borg to output statistics about the newly created archive such as the deduplicated size (the amount of unique data not shared with other archives): @@ -189,7 +189,7 @@ $ borg \-r /path/to/repo compact \fBNOTE:\fP .INDENT 0.0 .INDENT 3.5 -Borg is quiet by default (it works on WARNING log level). +Borg is quiet by default (it defaults to WARNING log level). You can use options like \fB\-\-progress\fP or \fB\-\-list\fP to get specific reports during command execution. You can also add the \fB\-v\fP (or \fB\-\-verbose\fP or \fB\-\-info\fP) option to adjust the log level to INFO to diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 0a7fb49bf..de3c8bb05 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -77,7 +77,7 @@ access the repository using the same user account**. If you want to back up files of other users or the operating system, running borg as root likely will be required (otherwise you get `Permission denied` errors). -If you only back up your own files, run it as your normal user (no root). +If you only back up your own files, run it as your normal user (i.e. not root). For a local repository always use the same user to invoke borg. @@ -263,7 +263,7 @@ the sudoers(5) man page. Passphrase notes ---------------- -If you use encryption (or authentication), Borg will interactively ask you +If you use encryption (or authentication), Borg will ask you interactively for a passphrase to encrypt/decrypt the keyfile / repokey. A passphrase should be a single line of text. Any trailing linefeed will be diff --git a/docs/quickstart_example.rst.inc b/docs/quickstart_example.rst.inc index 12aff3d74..3d140f0f0 100644 --- a/docs/quickstart_example.rst.inc +++ b/docs/quickstart_example.rst.inc @@ -1,4 +1,4 @@ -1. Before a backup can be made a repository has to be initialized:: +1. Before a backup can be made, a repository has to be initialized:: $ borg -r /path/to/repo rcreate --encryption=repokey-aes-ocb @@ -11,7 +11,7 @@ $ borg -r /path/to/repo create --stats Tuesday ~/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`` option causes Borg to output statistics about the newly created archive such as the deduplicated size (the amount of unique data not shared with other archives):: @@ -58,7 +58,7 @@ $ borg -r /path/to/repo compact .. Note:: - Borg is quiet by default (it works on WARNING log level). + Borg is quiet by default (it defaults to WARNING log level). You can use options like ``--progress`` or ``--list`` to get specific reports during command execution. You can also add the ``-v`` (or ``--verbose`` or ``--info``) option to adjust the log level to INFO to