Documentation

Advanced

The following uses of Mirage are not something a user will typically utilize, but are available nonetheless as more advanced features.

Custom Actions

Custom actions allow a user to hook external programs or calls into Mirage and bind these actions to a shortcut. Custom actions can make use of various supported image parameters and operations (see Edit > Custom Actions for the current listing). Custom actions can also be implemented that act on all images in the list (batch mode).

Four default actions are provided with Mirage as examples: Open in GIMP, Create thumbnail, Create thumbnails (batch), and Move to favorites.

Custom actions can consist of shell commands and external executables. Multiple lines can be specified as needed, with a semicolon (";") separating the lines. The custom action is simply executed by the shell, so you can use pipelines and redirections as well as simple commands. Filenames with spaces or special shell characters are escaped correctly for security reasons before they're passed to the shell.

Commandline Arguments

    Usage: mirage [OPTION]... FILES|FOLDERS...

    Options:
    -h, --help           Show this help and exit
    -v, --version        Show version information and exit
    -V, --verbose        Show more detailed information
    -R, --recursive      Recursively include all images found in
                         subdirectories of FOLDERS
    -s, --slideshow      Start in slideshow mode
    -f, --fullscreen     Start in fullscreen mode
    -o, --onload 'cmd'   Execute 'cmd' when an image is loaded
                         (uses same syntax as custom actions,
                         i.e. mirage -o 'echo file is %F')
				

For example, to load all images in your home directory and all its subdirectories:

    mirage -R ~

To automatically open a directory of images in fullscreen and slideshow mode:

    mirage -fs ~/miami-pics/

Listing of Shortcuts >