Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

services.gromit-mpx.enable

Whether to enable Gromit-MPX annotation tool.

Type: boolean

Default:

false

Example:

true

Declared by:

services.gromit-mpx.package

The gromit-mpx package to use.

Type: package

Default:

pkgs.gromit-mpx

Declared by:

services.gromit-mpx.hotKey

A keysym or raw keycode that toggles the activation state of gromit-mpx. Set to null to disable the hotkey in which case you’ll have to activate gromit-mpx manually using the command line.

Type: null or string or (positive integer, meaning >0)

Default:

"F9"

Example:

"Insert"

Declared by:

services.gromit-mpx.opacity

Opacity of the drawing overlay.

Type: float between 0.0 and 1.0 (inclusive)

Default:

0.75

Example:

1.0

Declared by:

services.gromit-mpx.tools

Tool definitions for gromit-mpx to use.

Type: list of (submodule)

Default:

[
  {
    color = "red";
    device = "default";
    size = 5;
    type = "pen";
  }
  {
    color = "blue";
    device = "default";
    modifiers = [
      "SHIFT"
    ];
    size = 5;
    type = "pen";
  }
  {
    color = "yellow";
    device = "default";
    modifiers = [
      "CONTROL"
    ];
    size = 5;
    type = "pen";
  }
  {
    arrowSize = 1;
    color = "green";
    device = "default";
    modifiers = [
      "2"
    ];
    size = 6;
    type = "pen";
  }
  {
    device = "default";
    modifiers = [
      "3"
    ];
    size = 75;
    type = "eraser";
  }
]

Declared by:

services.gromit-mpx.tools.*.arrowSize

If not null, automatically draw an arrow at the end of a stroke with the given size.

Type: null or (positive integer, meaning >0)

Default:

null

Example:

2

Declared by:

services.gromit-mpx.tools.*.color

The stroke (or recolor) color of the tool.

Type: string

Default:

"red"

Example:

"#ff00ff"

Declared by:

services.gromit-mpx.tools.*.device

Use this tool with the given xinput device. The device with the name default works with any input.

Type: string

Example:

"default"

Declared by:

services.gromit-mpx.tools.*.modifiers

Only activate this tool if the given modifiers are also active.

Type: list of (one of “1”, “2”, “3”, “4”, “5”, “SHIFT”, “CONTROL”, “ALT”, “META”)

Default:

[ ]

Example:

[
  "SHIFT"
]

Declared by:

services.gromit-mpx.tools.*.size

The tool size.

Type: positive integer, meaning >0

Default:

5

Example:

3

Declared by:

services.gromit-mpx.tools.*.type

Which type of tool this is.

Type: one of “pen”, “eraser”, “recolor”

Default:

"pen"

Example:

"eraser"

Declared by:

services.gromit-mpx.undoKey

A keysym or raw keycode that causes gromit-mpx to undo the last stroke. Use this key along with the shift key to redo an undone stoke. Set to null to disable the undo hotkey.

Type: null or string or (positive integer, meaning >0)

Default:

"F10"

Declared by: