Skip to content
Permalink
Browse files

DOC: Refresh manual / typos

  • Loading branch information...
kernc committed Jan 9, 2019
1 parent 76deee9 commit bc63a5ecbb5eae66c75252661b87e94e638d0a8f
Showing with 14 additions and 13 deletions.
  1. +14 −13 doc/xsuspender.1
@@ -113,7 +113,7 @@ Example configuration file shipped with the program.
A desktop session auto-start launcher. A desktop session auto-start launcher.
Disabled by default. Disabled by default.
To enable, copy it into To enable, copy it into
.I .config/autostart .I ~/.config/autostart
directory (or directory (or
.I $XDG_CONFIG_HOME/autostart .I $XDG_CONFIG_HOME/autostart
where applicable) and edit it, setting \fIHidden=false\fR. where applicable) and edit it, setting \fIHidden=false\fR.
@@ -136,16 +136,16 @@ section which all other sections inherit and override on per-key basis.
.PP .PP
Each non-\fB[Default]\fR section constitutes a rule that Each non-\fB[Default]\fR section constitutes a rule that
XSuspender will try to match and follow. XSuspender will try to match and follow.
Sections can define the the following keys (listed with built-in Sections can define the following keys (listed with built-in
default values): default values, if any):
.TP .TP
.B match_wm_name_contains .B match_wm_name_contains
.TQ .TQ
.B match_wm_class_contains .B match_wm_class_contains
.TQ .TQ
.B match_wm_class_group_contains .B match_wm_class_group_contains
These keys order xsuspender to apply the rule only to windows These keys order xsuspender to apply the rule only to windows
that contain the value string verbatim in their that contain the verbatim value string in their
.I WM_NAME .I WM_NAME
and and
.I WM_CLASS .I WM_CLASS
@@ -167,7 +167,7 @@ atom.
.TP .TP
.BR suspend_delay \ =\ 10 .BR suspend_delay \ =\ 10
Integer seconds to wait after the window loses focus Integer seconds to wait after the window loses focus
before it is suspended. before suspending it.
Setting a reasonable value avoids suspending processes too early during Setting a reasonable value avoids suspending processes too early during
rapid task switching. rapid task switching.
If you set this value too low, upon process termination, If you set this value too low, upon process termination,
@@ -188,14 +188,15 @@ Apply the rule only when on battery power. You may wish to set this to
running Windos. running Windos.
.TP .TP
.BR auto_suspend_on_battery \ =\ true .BR auto_suspend_on_battery \ =\ true
If true, automatically apply this rule when on batter power, even if If true, automatically apply this rule when switching to batter power,
the matching window didn't just lose focus. even if the matching window didn't just lose focus (but lost it
some time before).
.TP .TP
.BR suspend_subtree_pattern .BR suspend_subtree_pattern
Extended regular expression. Extended regular expression.
If provided, when XSuspender suspends a process, it will also suspend If provided, when XSuspender suspends a process, it will also suspend
all its descendant processes (children, grandchildren etc.) whose all its descendant processes (children, grandchildren etc.) whose
command line string matches the pattern. command-line string matches the pattern.
Set to \fI.\fR to match and kill all descendants. Set to \fI.\fR to match and kill all descendants.
This setting only applies when This setting only applies when
.B send_signals .B send_signals
@@ -205,7 +206,7 @@ is also true.
.TQ .TQ
.BR exec_resume .BR exec_resume
Before suspending / resuming the process, Before suspending / resuming the process,
execute the string as a command line shell script. execute the string as a command-line shell script.
If the script execution is successful (exit status 0), proceed If the script execution is successful (exit status 0), proceed
with process suspension, otherwise abort it. with process suspension, otherwise abort it.
(Process resumption is never aborted.) (Process resumption is never aborted.)
@@ -228,8 +229,7 @@ key to be of use.
.BR send_signals \ =\ true .BR send_signals \ =\ true
If true, XSuspender kills the matching process with If true, XSuspender kills the matching process with
SIGSTOP / SIGCONT Unix signals. SIGSTOP / SIGCONT Unix signals.
If false, XSuspender sends no signals of its own, deferring to If false, XSuspender sends no signals of its own, deferring to custom
your
.B exec_suspend .B exec_suspend
and and
.B exec_resume .B exec_resume
@@ -250,7 +250,7 @@ by \fIN/(N+1)\fR%, and so on. A value of
.I 0 .I 0
disables downclocking. disables downclocking.
.IP .IP
This is a separate, stand-alone mechanism that limits consumption of, This is a separate, stand-alone mechanism that limits CPU consumption of,
also and in particular, focused windows. also and in particular, focused windows.
.SH BUGS .SH BUGS
The following limitations and quirks are known: The following limitations and quirks are known:
@@ -281,7 +281,8 @@ They require keyboard input focus to resume.
.IP \[bu] 2 .IP \[bu] 2
Processes that take a long time to shut down after their window already Processes that take a long time to shut down after their window already
disappears may be stopped in the middle of their termination routines. disappears may be stopped in the middle of their termination routines.
Avoid with reasonably generous `suspend_delay`. Avoid with a reasonably generous
.B suspend_delay\fR.
.IP \[bu] 2 .IP \[bu] 2
XSuspender won't work in remote X sessions. XSuspender won't work in remote X sessions.
.IP \[bu] 2 .IP \[bu] 2

0 comments on commit bc63a5e

Please sign in to comment.
You can’t perform that action at this time.