From 653732bd6f06d8f465bf353bf6e1c16f1405b906 Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Mon, 30 Dec 2024 10:51:26 +0200 Subject: [PATCH] xz man page: Describe the source file deletion in -z and -d options 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 | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/xz/xz.1 b/src/xz/xz.1 index 5b880e81..41a0a48c 100644 --- a/src/xz/xz.1 +++ b/src/xz/xz.1 @@ -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