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.xsuspender.enable

Whether to enable XSuspender.

Type: boolean

Default:

false

Example:

true

Declared by:

services.xsuspender.package

The xsuspender package to use.

Type: package

Default:

pkgs.xsuspender

Declared by:

services.xsuspender.debug

Whether to enable debug output.

Type: boolean

Default:

false

Declared by:

services.xsuspender.defaults

XSuspender defaults.

Type: submodule

Default:

{ }

Declared by:

services.xsuspender.defaults.autoSuspendOnBattery

Whether to auto-apply rules when switching to battery power even if the window(s) didn’t just lose focus.

Type: boolean

Default:

true

Declared by:

services.xsuspender.defaults.downclockOnBattery

Limit CPU consumption for this factor when on battery power. Value 1 means 50% decrease, 2 means 66%, 3 means 75% etc.

Type: signed integer

Default:

0

Declared by:

services.xsuspender.defaults.execResume

Before resuming, execute this shell script. Resume the process regardless script failure.

Type: null or string

Default:

null

Example:

"echo resuming ..."

Declared by:

services.xsuspender.defaults.execSuspend

Before suspending, execute this shell script. If it fails, abort suspension.

Type: null or string

Default:

null

Example:

"echo \"suspending window $XID of process $PID\""

Declared by:

services.xsuspender.defaults.matchWmClassContains

Match windows that wm class contains string.

Type: null or string

Default:

null

Declared by:

services.xsuspender.defaults.matchWmClassGroupContains

Match windows where wm class group contains string.

Type: null or string

Default:

null

Declared by:

services.xsuspender.defaults.matchWmNameContains

Match windows where wm name contains string.

Type: null or string

Default:

null

Declared by:

services.xsuspender.defaults.onlyOnBattery

Whether to enable process suspend only on battery.

Type: boolean

Default:

false

Declared by:

services.xsuspender.defaults.resumeEvery

Resume interval in seconds.

Type: signed integer

Default:

50

Declared by:

services.xsuspender.defaults.resumeFor

Resume duration in seconds.

Type: signed integer

Default:

5

Declared by:

services.xsuspender.defaults.sendSignals

Whether to send SIGSTOP / SIGCONT signals or not. If false just the exec scripts are run.

Type: boolean

Default:

true

Declared by:

services.xsuspender.defaults.suspendDelay

Initial suspend delay in seconds.

Type: signed integer

Default:

5

Declared by:

services.xsuspender.defaults.suspendSubtreePattern

Also suspend descendant processes that match this regex.

Type: null or string

Default:

null

Declared by:

services.xsuspender.rules

Attribute set of XSuspender rules.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  Chromium = {
    matchWmClassContains = "chromium-browser";
    suspendDelay = 10;
    suspendSubtreePattern = "chromium";
  };
}

Declared by:

services.xsuspender.rules.<name>.autoSuspendOnBattery

Whether to auto-apply rules when switching to battery power even if the window(s) didn’t just lose focus.

Type: boolean

Default:

true

Declared by:

services.xsuspender.rules.<name>.downclockOnBattery

Limit CPU consumption for this factor when on battery power. Value 1 means 50% decrease, 2 means 66%, 3 means 75% etc.

Type: signed integer

Default:

0

Declared by:

services.xsuspender.rules.<name>.execResume

Before resuming, execute this shell script. Resume the process regardless script failure.

Type: null or string

Default:

null

Example:

"echo resuming ..."

Declared by:

services.xsuspender.rules.<name>.execSuspend

Before suspending, execute this shell script. If it fails, abort suspension.

Type: null or string

Default:

null

Example:

"echo \"suspending window $XID of process $PID\""

Declared by:

services.xsuspender.rules.<name>.matchWmClassContains

Match windows that wm class contains string.

Type: null or string

Default:

null

Declared by:

services.xsuspender.rules.<name>.matchWmClassGroupContains

Match windows where wm class group contains string.

Type: null or string

Default:

null

Declared by:

services.xsuspender.rules.<name>.matchWmNameContains

Match windows where wm name contains string.

Type: null or string

Default:

null

Declared by:

services.xsuspender.rules.<name>.onlyOnBattery

Whether to enable process suspend only on battery.

Type: boolean

Default:

false

Declared by:

services.xsuspender.rules.<name>.resumeEvery

Resume interval in seconds.

Type: signed integer

Default:

50

Declared by:

services.xsuspender.rules.<name>.resumeFor

Resume duration in seconds.

Type: signed integer

Default:

5

Declared by:

services.xsuspender.rules.<name>.sendSignals

Whether to send SIGSTOP / SIGCONT signals or not. If false just the exec scripts are run.

Type: boolean

Default:

true

Declared by:

services.xsuspender.rules.<name>.suspendDelay

Initial suspend delay in seconds.

Type: signed integer

Default:

5

Declared by:

services.xsuspender.rules.<name>.suspendSubtreePattern

Also suspend descendant processes that match this regex.

Type: null or string

Default:

null

Declared by: