From eeaeb5754b5a570554da031f9f7a9a669551175b Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Sat, 8 Jul 2023 22:07:17 -0700
Subject: doc: document crc32 parameters.

* txr.1: Specify which crc32 is implemented: which polynomial,
bit direction, and complementation of the output.
---
 txr.1 | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/txr.1 b/txr.1
index 3e187c85..603a7b8c 100644
--- a/txr.1
+++ b/txr.1
@@ -67909,6 +67909,15 @@ The
 .code crc32
 function returns the calculated CRC-32 as a nonnegative integer.
 
+The parameters of the algorith are as follows. The polynomial is
+.codn #x04C11DB7 ;
+the input and result are reflected; the initial value is
+.codn #xFFFFFFFF ;
+and the final value is bitwise
+.IR xor -ed
+with
+.codn #xFFFFFFFF .
+
 .TP* Examples:
 
 .mono
-- 
cgit v1.2.3