]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
doc: cksum: clarify support of --text and --binary
authorPádraig Brady <P@draigBrady.com>
Fri, 7 Nov 2025 14:38:51 +0000 (14:38 +0000)
committerPádraig Brady <P@draigBrady.com>
Fri, 7 Nov 2025 16:36:08 +0000 (16:36 +0000)
Make the documentation more accurate following v9.3-80-g5e1e0993b

* doc/coreutils.texi (cksum common options): State that --text and
--binary are actually supported, but only to support emulation
of the legacy utils.

doc/coreutils.texi

index 012dd719eb2967b4b399a7d5cf84959e62e27a52..b4206069db3ececf9b7b11a8d01be1d28ac9adca 100644 (file)
@@ -4284,8 +4284,6 @@ This does not identify the digest algorithm used for the checksum.
 @opindex -b
 @opindex --binary
 @cindex binary input files
-This option is not supported by the @command{cksum} command,
-as it operates in binary mode exclusively.
 Treat each input file as binary, by reading it in binary mode and
 outputting a @samp{*} flag.  This is the inverse of @option{--text}.
 On systems like GNU that do not distinguish between binary
@@ -4293,6 +4291,12 @@ and text files, this option merely flags each input mode as binary:
 the checksum is unaffected.  This option is the default on systems
 like MS-DOS that distinguish between binary and text files, except
 for reading standard input when standard input is a terminal.
+@macro cksumTextMode
+This option is deprecated and not documented in @command{cksum --help}.
+It is only supported by the @command{cksum} command to support emulation
+of the legacy standalone checksumming utilities.
+@end macro
+@cksumTextMode
 
 @item -c
 @itemx --check
@@ -4383,13 +4387,13 @@ The @command{cksum} command, uses @option{--tag} as its default output format.
 @opindex -t
 @opindex --text
 @cindex text input files
-This option is not supported by the @command{cksum} command.
 Treat each input file as text, by reading it in text mode and
 outputting a @samp{ } flag.  This is the inverse of @option{--binary}.
 This option is the default on systems like GNU that do not
 distinguish between binary and text files.  On other systems, it is
 the default for reading standard input when standard input is a
 terminal.  This mode is never defaulted to if @option{--tag} is used.
+@cksumTextMode
 
 @item -w
 @itemx --warn