SWAYIMGRC(5)

NAME
swayimgrc - Swayimg configuration file

SYNOPSIS
$XDG_CONFIG_HOME/swayimg/config
$HOME/.config/swayimg/config
$XDG_CONFIG_DIRS/swayimg/config
/etc/xdg/swayimg/config

DESCRIPTION

  General format description
The Swayimg configuration file is a text-based INI file used to override the default settings.

The basic element contained in the INI file is the key or property. Every key has a name and a value, delimited by an equals sign (=). The name appears to the left of the equals sign, and the value to the right. The value can contain any character. Names and values are case sensitive.

The number sign (#) at the beginning of the line indicates a comment. Empty lines and comments are ignored.

  Global properties

scale: initial image scale:
    optimal: 100% or less to fit to window (default);
    fit: fit to window;
    real: real size (100%);

fullscreen: start in full screen mode, yes or [no];

background: background for transparent images:
    none: transparent;
    grid: show grid as background (default);
    #XXXXXX: hexadecimal RGB color.

window: window background:
    none: transparent (default);
    #XXXXXX: hexadecimal RGB color.

antialiasing: enable/disable anti-aliasing, yes or [no];

info: show image meta information: format, size, EXIF, and current scale, yes or [no];

font: font name used for printing image meta info, default is monospace;

font-size: font size (in pt) used to render image info text, default is 14;

font-color: color used to render text, RGB hex format, default is #cccccc;

order: order of the image list:
    none: unsorted;
    alpha: sorted alphabetically (default);
    random: randomize list.

loop: looping file list mode, [yes] or no;

recursive: read directories recursively, yes or [no];

all: always open all files in the same directory, yes or [no];

slideshow: slideshow image duration in seconds, default is 3;

exec: set a command to be executed when the corresponding key is pressed, use % for image path, default is 'echo %';

app_id: set a constant window class/app_id. Setting this may break the window layout;

sway: enable or disable integration with sway WM (window position management), [yes] or no.

  Key bindins

The key bindings are described in the "keys" section. Each line associates a key with some action. The key name can be obtained with the xkbcli tool: `xkbcli interactive-wayland`.

Valid action are: none, first_file, last_file, prev_dir, next_dir, prev_file, next_file, prev_frame, next_frame, animation, slideshow, fullscreen, step_left, step_right, step_up, step_down, zoom_in, zoom_out, zoom_optimal, zoom_fit, zoom_real, zoom_reset, rotate_left, rotate_right, flip_vertical, flip_horizontal, antialiasing, reload, info, exec, quit.

EXAMPLES
    # comment
    scale = fit
    fullscreen = no
    background = none
    window = #112233
    info = yes
    font = monospace 14
    font-color = #b4b3b2
    sway = no
    [keys]
    q = quit

SEE ALSO
swayimg(1)

BUGS
For suggestions, comments, bug reports etc. visit the project homepage (https://github.com/artemsen/swayimg).