i3-shade/src/help.js

Auto show/hide floating windows in i3

exports.usage = "usage i3-shade [-h|--help] [--peek=<integer>] [--prefix=<string>]\n\
                [--exempt=<string>] [--command=<string>] [--fallback=<string>]\n\
                [--urgent]\n"

exports.helpText = "i3-shade\n\
    -h            Show brief usage summary.\n\
    --help        Show this message.\n\
    --peek=<integer>\n\
                  Defaults to 2. Number of pixels that shaded windows will peek out\n\
                  from the screen edge. Values less than 2 will be set to 2.\n\
    --prefix=<string>\n\
                  Defaults to \"shade\". Included in mark that stores \n\
                  floating window position. No need to set unless default\n\
                  conflicts with other marks.\n\
                  <prefix>_<x>_<y>_<con_id> \n\
    --exempt=<string>\n\
                  Defaults to \"shade_exempt\". Included in mark that exempts\n\
                  containers from shading. No need to set unless default\n\
                  conflicts with other marks.\n\
                  _<exempt>_<con_id> \n\
    --socketpath=<string>\n\
                  Defaults to output of `i3 --get-socketpath`.\n\
    --command=<string>\n\
                  Defaults to \"nop i3-shade-exempt\". The i3 command to toggle\n\
                  the shading exemption for the focused window. \n\
    --fallback=<string>\n\
                  Defaults to null. An i3 command to run if the 'focus mode_toggle'\n\
                  command cannot find an eligible window to focus.\n\
    --urgent\n\
                  EXPERIMENTAL\: Make shaded windows more prominent by marking them\n\
                  urgent. Requires the 'wmctrl' system command.\n"