update man pages / usage docs

1 files changed, 33 insertions, 4 deletions

diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1
index 2b0e16fc7..65c3a4e5e 100644
--- a/docs/man/borg-delete.1
+++ b/docs/man/borg-delete.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-DELETE 1 "2017-11-25" "" "borg backup tool"
+.TH BORG-DELETE 1 "2018-07-14" "" "borg backup tool"
 .SH NAME
 borg-delete \- Delete an existing repository or archives
 .
@@ -36,13 +36,28 @@ borg [common options] delete [options] [TARGET] [ARCHIVE...]
 .SH DESCRIPTION
 .sp
 This command deletes an archive from the repository or the complete repository.
-Disk space is reclaimed accordingly. If you delete the complete repository, the
-local cache for it (if any) is also deleted.
+.sp
+Important: When deleting archives, repository disk space is \fBnot\fP freed until
+you run \fBborg compact\fP\&.
+.sp
+If you delete the complete repository, the local cache for it (if any) is
+also deleted. Alternatively, you can delete just the local cache with the
+\fB\-\-cache\-only\fP option.
 .sp
 When using \fB\-\-stats\fP, you will get some statistics about how much data was
 deleted \- the "Deleted data" deduplicated size there is most interesting as
 that is how much your repository will shrink.
 Please note that the "All archives" stats refer to the state after deletion.
+.sp
+You can delete multiple archives by specifying their common prefix, if they
+have one, using the \fB\-\-prefix PREFIX\fP option. You can also specify a shell
+pattern to match multiple archives using the \fB\-\-glob\-archives GLOB\fP option
+(for more info on these patterns, see \fBborg help patterns\fP). Note that these
+two options are mutually exclusive.
+.sp
+To avoid accidentally deleting archives, especially when using glob patterns,
+it might be helpful to use the \fB\-\-dry\-run\fP to test out the command without
+actually making any changes to the repository.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
@@ -58,6 +73,9 @@ archives to delete
 .SS optional arguments
 .INDENT 0.0
 .TP
+.B \-n\fP,\fB  \-\-dry\-run
+do not change repository
+.TP
 .B \-s\fP,\fB  \-\-stats
 print statistics for the deleted archive
 .TP
@@ -96,6 +114,17 @@ consider last N archives after other filters were applied
 .ft C
 # delete a single backup archive:
 $ borg delete /path/to/repo::Monday
+# actually free disk space:
+$ borg compact /path/to/repo
+
+# delete all archives whose names begin with the machine\(aqs hostname followed by "\-"
+$ borg delete \-\-prefix \(aq{hostname}\-\(aq /path/to/repo
+
+# delete all archives whose names contain "\-2012\-"
+$ borg delete \-\-glob\-archives \(aq*\-2012\-*\(aq /path/to/repo
+
+# see what would be deleted if delete was run without \-\-dry\-run
+$ borg delete \-v \-\-dry\-run \-a \(aq*\-May\-*\(aq /path/to/repo
 
 # delete the whole repository and the related local cache:
 $ borg delete /path/to/repo
@@ -110,7 +139,7 @@ Type \(aqYES\(aq if you understand this and want to continue: YES
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fIborg\-common(1)\fP
+\fIborg\-common(1)\fP, \fIborg\-compact(1)\fP
 .SH AUTHOR
 The Borg Collective
 .\" Generated by docutils manpage writer.