]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
xz man page: Describe the source file deletion in -z and -d options
authorLasse Collin <lasse.collin@tukaani.org>
Mon, 30 Dec 2024 08:51:26 +0000 (10:51 +0200)
committerLasse Collin <lasse.collin@tukaani.org>
Mon, 30 Dec 2024 08:51:26 +0000 (10:51 +0200)
The DESCRIPTION section always explained it, and the OPTIONS section
only described the differences to the default behavior. However, new
users in a hurry may skip reading DESCRIPTION. The default behavior
is a bit dangerous, thus it's good to repeat in --compress and
--decompress docs that source file is removed after successful operation.

Fixes: https://github.com/tukaani-project/xz/issues/150
src/xz/xz.1

index 5b880e81e8c23bb06fac3db0cc1d3f62bfbe5c98..41a0a48c49154b785d19779044460890268a447d 100644 (file)
@@ -4,7 +4,7 @@
 .\" Authors: Lasse Collin
 .\"          Jia Tan
 .\"
-.TH XZ 1 "2024-04-08" "Tukaani" "XZ Utils"
+.TH XZ 1 "2024-12-30" "Tukaani" "XZ Utils"
 .
 .SH NAME
 xz, unxz, xzcat, lzma, unlzma, lzcat \- Compress or decompress .xz and .lzma files
@@ -351,9 +351,24 @@ the command name (for example,
 .B unxz
 implies
 .BR \-\-decompress ).
+.IP ""
+.\" The DESCRIPTION section already says this but it's good to repeat it
+.\" here because the default behavior is a bit dangerous and new users
+.\" in a hurry may skip reading the DESCRIPTION section.
+After successful compression, the source file is removed
+unless writing to standard output or
+.B \-\-keep
+was specified.
 .TP
 .BR \-d ", " \-\-decompress ", " \-\-uncompress
 Decompress.
+.\" The DESCRIPTION section already says this but it's good to repeat it
+.\" here because the default behavior is a bit dangerous and new users
+.\" in a hurry may skip reading the DESCRIPTION section.
+After successful decompression, the source file is removed
+unless writing to standard output or
+.B \-\-keep
+was specified.
 .TP
 .BR \-t ", " \-\-test
 Test the integrity of compressed