docs: A note to cat that hexdump should be used for binary data

The cat command should not be used to print binary data because it can
show bytes not in the binary data and not show bytes that are in the data,
which can lead to confusion. This happens because cat does some processing
of the data stream, namely trying to decode substrings as UTF-8.

Signed-off-by: Glenn Washburn <development@efficientek.com>
Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
This commit is contained in:
Glenn Washburn 2023-07-26 13:50:12 -05:00 committed by Daniel Kiper
parent 7ff4f3c963
commit 711e034235

View File

@ -4507,6 +4507,12 @@ will be displayed as a simple new line. Otherwise, the carriage return will
be displayed as a control character (@samp{<d>}) to make it easier to see
when boot problems are caused by a file formatted using DOS-style line
endings.
Note: @command{cat} can be used to view the contents of devices using the
block list syntax (@pxref{Block list syntax}). However, it is not advised
to view binary data because it will try to decode UTF-8 strings, which can
lead to some bytes missing or added in the output. Instead, use the
@command{hexdump} command (@pxref{hexdump}).
@end deffn