| 120 | | ||=Examples: =||`--compress` || |
| 121 | | || ||`--compress lzo` || |
| 122 | | || ||`--compress lz4` || |
| 123 | | The `--comp-lzo` option would only enable the LZO compression algorithm. The `--compress` option allows also to use the improved LZ4 algorithm instead. This will allow `--compress` to be pushed by the server on a per-client basis. |
| 124 | | Providing just `--compress` without an algorithm is the equivalent of `--comp-lzo no` which disables compression but enables the packet framing for compression. |
| 125 | | |
| 126 | | Contrary to prior statements `--comp-lzo no` is not compatible with the `--compress` counterpart. Therefore openvpn needs to keep supporting `--comp-lzo no` for backward compatibility. |
| | 120 | ||=Examples: =||(N/A) || |
| | 121 | Compression is not recommended and is a feature users should avoid using. To signal this clearly, `--comp-lzo` and `--compress` are discouraged and considered deprecated features. They will be removed in a future release. |
| | 122 | |
| | 123 | == Option: `--compress` == |
| | 124 | ||=Status =||Currently not planned for removal, see description for details || |
| | 125 | ||=Deprecated in: =||OpenVPN v2.5 || |
| | 126 | ||=To be removed in: =||(not decided) || |
| | 127 | ||=Affects: =||Client and server || |
| | 128 | ||=Result if used: =||OpenVPN will ignore the option and provide a warning|| |
| | 129 | ||=Replaced by: =|| Not replaced || |
| | 130 | ||=Examples: =||(N/A) || |
| | 131 | Compression is not recommended and is a feature users should avoid using. To signal this clearly, `--comp-lzo` and `--compress` are discouraged and considered deprecated features. They will be removed in a future release. |
