Skip to content

Commit f2df9bf

Browse files
committed
doc: add On compress,zstd; description to the manual
1 parent 49764dc commit f2df9bf

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

doc/manual/statements.tex

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3903,14 +3903,28 @@ \section{on}
39033903
\rightvitem{13cm}{Turns compression mode on. This compression is a
39043904
relatively simple compression that hardly costs extra computer time but
39053905
saves roughly a factor two in disk storage. The old statement was `compress
3906-
on' but this should be avoided in the future. This setting is the default.}
3906+
on' but this should be avoided in the future. This setting is the default if
3907+
\FORM\ has not been compiled with gzip or zstd support.}
39073908

39083909
\leftvitem{3.5cm}{compress,gzip\index{gzip}}
3909-
\rightvitem{13cm}{This option should be followed by a comma or a space and
3910+
\rightvitem{13cm}{This setting is the default, if \FORM\ has been compiled
3911+
with gzip support but not with zstd support.
3912+
This option may be followed by a comma or a space and
39103913
a single digit. It activates the gzip compression for the sort file. This
39113914
compression can make the intermediate sort file considerably shorter at the
3912-
cost of some CPU time. This option can be used when disk space is at a
3913-
premium. The digit indicates the compression level. Zero means no
3915+
cost of some CPU time.
3916+
The digit indicates the compression level. Zero means no
3917+
compression and 9 is the highest level. The default level is 6. Above that
3918+
the compression becomes very slow and doesn't gain very much extra.}
3919+
3920+
\leftvitem{3.5cm}{compress,zstd\index{zstd}}
3921+
\rightvitem{13cm}{This setting is the default, if \FORM\ has been compiled with
3922+
zstd support.
3923+
This option may be followed by a comma or a space and
3924+
a single digit. It activates the zstd compression for the sort file. This
3925+
compression performs better than gzip, both in terms of compression/
3926+
decompression rates and compression ratio.
3927+
The digit indicates the compression level. Zero means no
39143928
compression and 9 is the highest level. The default level is 6. Above that
39153929
the compression becomes very slow and doesn't gain very much extra.}
39163930

0 commit comments

Comments
 (0)