improved indentation and whitespace for markdown code blocks

All code blocks in markdown have been intended by at least 4 spaces.

We add `--tab-stop=8` to all `pandoc(1)` executions in order to set
a better tab stop indentation, especially for tab intended code blocks.

Changed `bin/pandoc-wrapper.sh` VERSION from "1.5.3 2024-03-26"
to "1.6 2024-03-31".

Fixed `1991/brnstnd/sorta.README.md` so that the sorta code
is code blocks.

Removed unneeded paragraph group in copyright in `inc/footer.default.html`.

Fixed excess whitespace after list Author on entry `index.html` page.

Changed `bin/output-index-author.sh` VERSION from "1.5.2 2024-03-26"
to "1.6 2024-03-31".

Performed `make www` to perform the above and test under macOS.

TODO: Fix the problem of the initial line of code being extra intended.
TODO: Fix excess whitespace around code that is inline.
This commit is contained in:
Landon Curt Noll committed 2024-04-01 04:48:48 -07:00
1 parent b84c27ce02
commit a996f8d2b8
734 files changed
+16723 -16963

No files matched your search

+34 -35
View File
@@ -1,32 +1,32 @@
## To build:
```sh
make all
make all
```
## To use:
```sh
./tomtorfs filename bitwidth polynom reflected init xor
./tomtorfs filename bitwidth polynom reflected init xor
```
where:
```
filename : file to calculate the CRC of
bitwidth : width of the CRC in bits (decimal)
polynom : polynomial used for the CRC (hexadecimal)
reflected : 0 if the CRC is not reflected, 1 if it is
init : initial value for the CRC (hexadecimal)
xor : value to xor the final CRC with (hexadecimal)
filename : file to calculate the CRC of
bitwidth : width of the CRC in bits (decimal)
polynom : polynomial used for the CRC (hexadecimal)
reflected : 0 if the CRC is not reflected, 1 if it is
init : initial value for the CRC (hexadecimal)
xor : value to xor the final CRC with (hexadecimal)
```
## Try:
```sh
./try.sh
./try.sh
```
@@ -40,15 +40,15 @@ archiver that uses the CRC-32 algorithm.
## Author's remarks:
```
Usage:
./tomtorfs filename bitwidth polynom reflected init xor
Usage:
./tomtorfs filename bitwidth polynom reflected init xor
filename : file to calculate the CRC of
bitwidth : width of the CRC in bits (decimal)
polynom : polynomial used for the CRC (hexadecimal)
reflected : 0 if the CRC is not reflected, 1 if it is
init : initial value for the CRC (hexadecimal)
xor : value to xor the final CRC with (hexadecimal)
filename : file to calculate the CRC of
bitwidth : width of the CRC in bits (decimal)
polynom : polynomial used for the CRC (hexadecimal)
reflected : 0 if the CRC is not reflected, 1 if it is
init : initial value for the CRC (hexadecimal)
xor : value to xor the final CRC with (hexadecimal)
```
### Examples
@@ -57,7 +57,7 @@ xor : value to xor the final CRC with (hexadecimal)
#### CRC-16:
```sh
./tomtorfs filename 16 1021 0 FFFF 0000
./tomtorfs filename 16 1021 0 FFFF 0000
```
@@ -65,22 +65,21 @@ xor : value to xor the final CRC with (hexadecimal)
```sh
./tomtorfs filename 32 04C11DB7 1 FFFFFFFF FFFFFFFF
./tomtorfs filename 32 04C11DB7 1 FFFFFFFF FFFFFFFF
```
#### XMODEM:
```sh
./tomtorfs filename 16 8408 1 0000 0000
./tomtorfs filename 16 8408 1 0000 0000
```
#### ARC:
```sh
./tomtorfs filename 16 8005 1 0000 0000
./tomtorfs filename 16 8005 1 0000 0000
```
@@ -110,22 +109,22 @@ The variable names are not very descriptive. They have the
following meanings:
```
a = argc
A = argv
a = argc
A = argv
b = array of unsigned long variables
b[0] = bit-width of the CRC (argv[2])
b[1] = CRC polynomial (argv[3])
b[2] = nonzero if CRC is reflected (argv[4])
b[3] = initial value of CRC (argv[5])
b[4] = value final CRC is XORed with (argv[6])
b[5] = CRC value
b[6] = byte from file
b[7] = counter
b = array of unsigned long variables
b[0] = bit-width of the CRC (argv[2])
b[1] = CRC polynomial (argv[3])
b[2] = nonzero if CRC is reflected (argv[4])
b[3] = initial value of CRC (argv[5])
b[4] = value final CRC is XORed with (argv[6])
b[5] = CRC value
b[6] = byte from file
b[7] = counter
B = FILE * through which the file argv[1] is opened
B = FILE * through which the file argv[1] is opened
C = typedef for unsigned long
C = typedef for unsigned long
```
The first `for` loop simply reads the command-line arguments