Skip to contentSkip to conversation

Document "lz4" argument to "compress" config option.

PATCH In review Gert Doering 2 participants 2 messages Jan 6, 2014

lore
Share & tools
lore

Gert Doering

author
#0 lore raw

PATCH 1/1 Document "lz4" argument to "compress" config option.

Signed-off-by Gert Doering <[email protected]...>
---
 doc/openvpn.8 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
doc/openvpn.8 +4 -2
index f06d536..3df7a6f 100644
@@ -2417,9 +2417,11 @@ Enable a compression algorithm.
 
 The
 .B algorithm
-parameter may be "snappy", "lzo", or empty.  Snappy and LZO
+parameter may be "snappy", "lzo", "lz4", or empty.  Snappy, LZO and LZ4
 are different compression algorithms, with Snappy generally
-offering the best performance.
+offering the best performance while LZ4 is faster with less CPU usage.
+For backwards compatibility with OpenVPN versions before 2.4, use "lzo"
+(which is identical to the older option "\-\-comp-lzo yes").
 
 If the
 .B algorithm
Signature · 1 line
1.8.2
#1 lore raw

Am 06.01.14 13:50, schrieb Gert Doering:

Quoted 13 lines
Signed-off-by Gert Doering <[email protected]...>
---
 doc/openvpn.8 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
doc/openvpn.8 +0 -0
index f06d536..3df7a6f 100644
@@ -2417,9 +2417,11 @@ Enable a compression algorithm.
 
 The
 .B algorithm

doc/openvpn.8 Enable a compression algorithm. · line 2427

Quoted 10 lines
doc/openvpn.8 +4 -2
-parameter may be "snappy", "lzo", or empty.  Snappy and LZO
+parameter may be "snappy", "lzo", "lz4", or empty.  Snappy, LZO and LZ4
 are different compression algorithms, with Snappy generally
-offering the best performance.
+offering the best performance while LZ4 is faster with less CPU usage.
+For backwards compatibility with OpenVPN versions before 2.4, use "lzo"
+(which is identical to the older option "\-\-comp-lzo yes").
 
 If the
 .B algorithm

ACK