zswap-cli - Man Page

Print help message and exit.

Print version information and exit.

Get options from the configuration file instead of the cmdline.

Get options from the environment variables instead of the cmdline.

Get statistics and current settings of ZSwap kernel module.

Supported values:

• 0 (default) - print both ZSwap kernel module settings and debug information;
• 1 - print ZSwap kernel module settings;
• 2 - print ZSwap kernel module usage summary;
• 3 - print ZSwap kernel module debug information.

Enable or disable ZSwap kernel module.

Enable or disable memory pages deduplication.

The maximum percentage of memory that the compressed pool can occupy.

The default compression algorithm.

The kernel’s zpool type.

The threshold at which ZSwap would start accepting pages again after it became full.

• ZSWAP_ENABLED_VALUE - enable (Y) or disable (N) ZSwap kernel module.
• ZSWAP_SAME_FILLED_PAGES_ENABLED_VALUE - enable (Y) or disable (N) memory pages deduplication.
• ZSWAP_MAX_POOL_PERCENT_VALUE - the maximum percentage of memory that the compressed pool can occupy (integer from 1 to 100).
• ZSWAP_COMPRESSOR_VALUE - the default compression algorithm.
• ZSWAP_ZPOOL_VALUE - the kernel’s zpool type.
• ZSWAP_ACCEPT_THRESHOLD_PERCENT_VALUE - the threshold at which ZSwap would start accepting pages again after it became full (integer from 1 to 100).

Export environment options using export command:

export ZSWAP_ENABLED_VALUE=Y
export ZSWAP_SAME_FILLED_PAGES_ENABLED_VALUE=Y
export ZSWAP_MAX_POOL_PERCENT_VALUE=60
export ZSWAP_COMPRESSOR_VALUE=zstd
export ZSWAP_ZPOOL_VALUE=z3fold
export ZSWAP_ACCEPT_THRESHOLD_PERCENT_VALUE=40

Start application with --env command-line argument:

sudo zswap-cli --env

• enabled - enable (Y) or disable (N) ZSwap kernel module.
• same_filled_pages_enabled - enable (Y) or disable (N) memory pages deduplication.
• max_pool_percent - the maximum percentage of memory that the compressed pool can occupy (integer from 1 to 100).
• compressor - the default compression algorithm.
• zpool - the kernel’s zpool type.
• accept_threshold_percent - the threshold at which ZSwap would start accepting pages again after it became full (integer from 1 to 100).

Start application with --config command-line argument:

sudo zswap-cli --config /path/to/zswap-cli.conf

All settings are stored in the /etc/zswap-cli/zswap-cli.conf configuration file. It uses standard key-value systax.

Enable systemd-unit and run it on system startup:

sudo systemctl enable --now zswap-cli.service

Disable systemd-unit and stop runing it on system startup:

sudo systemctl disable zswap-cli.service

You can also run systemd-unit without adding it to startup.

Start unit and enable ZSwap:

sudo systemctl start zswap-cli.service

Stop unit and disable ZSwap:

sudo systemctl stop zswap-cli.service