WAL(1)

NAME
wal - Generate colorschemes on the fly

SYNOPSIS
wal [-hclnqrRstvwe] [-a alpha] [-b background] [--fg foreground] [--backend [backend]] [--out-dir [out_dir]] [--theme /path/to/file or theme_name] [--iterative] [--cols16 [method]] [--recursive] [--saturate 0.0-1.0] [--preview] [--vte] [-i /path/to/img.jpg] [-o script_name] [-p theme_name] [--contrast [1.0-21.0]]

DESCRIPTION
wal is a tool that generates a color palette from the dominant colors in an image. It then applies the colors system-wide and on-the-fly in all of your favourite programs.

OPTIONS

-h, --help
    Print brief usage information to standard output and exit.

-a alpha
    Set terminal background transparency to alpha. The value must be an integer between 0 and 100.
     *Only works in URxvt and terminals that implement the OSC-11 interface*

-b background
    Custom background color to use.

--fg foreground
    Custom foreground color to use.

--backend backend
    Which color backend to use. Use 'wal --backend' to list backends.

--out-dir /path/to/output dir
    Directory to output the built template files. By default wal will export the built templates to $XDG_CACHE_HOME/wal/ The output dir for the templates can also be set with the $PYWAL_CACHE_DIR env var, using this flag overrides the internal CACHE_DIR variable taking precedence over $PYWAL_CACHE_DIR.

-f, --theme /path/to/file or theme_name
    Which colorscheme file to use. Use 'wal --theme' to list builtin and user themes.

--iterative
    When pywal is given a directory as input and this flag is used: Go through the images in order instead of shuffled.

--cols16 method
    Use 16 color mode, this will generate 16 color themes or convert 9 color themes to 16 colors. Method is either darken or lighten default: darken

--recursive
    When pywal is given a directory as input and this flag is used: Search for images recursively in subdirectories instead of the root only.

--saturate [0.0-1.0]
    Set the color saturation.

--preview
    Print the current color palette.

--vte
    Fix text-artifacts printed in VTE terminals.

-c  Delete all cached colorschemes.

-i /path/to/img.jpg
    Which image or directory to use.

-l  Generate a light colorscheme.

-n  Skip setting the wallpaper.

-o script_name
    External script to run after "wal".

-p theme_name
    permanently save theme to $XDG_CONFIG_HOME/wal/colorschemes with the specified theme_name.

-q  Quiet mode, don't print anything.

-r  'wal -r' is deprecated: Use (cat ~/.cache/wal/sequences &) instead.

-R  Restore previous colorscheme.

-s  Skip changing colors in terminals.

-t  Skip changing colors in tty.

-v  Print "wal" version.

-w  Use last used wallpaper for color generation.

-e  Skip reloading xrdb/i3/sway/polybar

--contrast [1.0-21.0]
    Specify a minimum contrast ratio between palette colors and the source image according to W3 contrast specifications. Values between 1.5-4.5 typically work best.

TEMPLATES

Wal supports user defined template files. What this means is that similar to the export files in the $XDG_CACHE_HOME/wal/ directory, you can create your own files which will be processed by pywal and spit out in this directory.

Subdirectories with templates are also supported inside the templates dir.

The user defined files are read from $XDG_CONFIG_HOME/wal/templates/ and are exported to $XDG_CACHE_HOME/wal/ under the same name. Using this feature you can also overwrite the default export files

ORIGINAL AUTHOR
Dylan Araps <dylan.araps at gmail.com>

MAINTAINER
    eylles                 <ed.ylles1997 at gmail.com>

CONTRIBUTORS
    For a list of contributors, run `git shortlog -s` in the nsxiv git repository.

HOMEPAGE

Source code:
    https://github.com/eylles/pywal16