Skip to content

Commit

Permalink
xz man page: Describe the source file deletion in -z and -d options
Browse files Browse the repository at this point in the history
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: #150
  • Loading branch information
Larhzu committed Dec 30, 2024
1 parent bb79f79 commit 653732b
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion src/xz/xz.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 653732b

Please sign in to comment.