X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=scrotwm.1;h=72d86bcf6b8587ff5d48da28b11094f7fb4a6636;hb=197abc3a5b33e27488d92df5e2ee85702722a606;hp=c0675d47fdf03b663a46eba6423b742970ef33fc;hpb=28ea6d718416f0eed692f4d78e0e8630632fb62a;p=spectrwm.git

diff --git a/scrotwm.1 b/scrotwm.1
index c0675d4..72d86bc 100644
--- a/scrotwm.1
+++ b/scrotwm.1
@@ -19,7 +19,7 @@
 .Os
 .Sh NAME
 .Nm scrotwm
-.Nd is a small dynamic tiling window manager for X11.
+.Nd small dynamic tiling window manager for X11.
 .Sh SYNOPSIS
 .Nm scrotwm
 .Sh DESCRIPTION
@@ -40,6 +40,8 @@ Meta
 Shift
 .It Ic [Name]
 Named key
+.It Ic M1
+Mouse button 1
 .El
 .Pp
 .Nm
@@ -93,18 +95,83 @@ Destroy current window in workspace.
 Switch to workspace [Number].
 .It Ic M-S-[Number]
 Move current window to workspace [Number].
-.It Ic M-[RighArrow]
+.It Ic M-[Right]
 Switch to next workspace with a window in it.
-.It Ic M-[LeftArrow]
+.It Ic M-[Left]
 Switch to previous workspace with a window in it.
+.It Ic M-S-[Right]
+Move pointer to next region.
+.It Ic M-S-[Left]
+Move pointer to previous region.
+.It Ic M-s
+Take screenshot of entire screen (if enabled).
+.It Ic M-S-s
+Take screenshot of selected window (if enabled).
+.It Ic M1
+Focus window.
 .El
 .Pp
 .Pp
 .Sh FILES
 .Bl -tag -width Ds
 .It Pa ~/.scrotwm.conf
+This file contains user specific settings.
 .It Pa /etc/scrotwm.conf
+This file contains global settings.
 .El
+.Pp
+.Nm
+first tries to open the user specific file.
+If that file is unavailable it tries to open the global file next.
+.Pp
+The format of the file is <keyword> = <setting>.
+E.g. color_focus = red.
+.Pp
+Enabling or disabling an option is done by using 1 or 0 respectively.
+.Pp
+The file supports the following keywords:
+.Bl -tag -width "C-M-EscapeXXX" -offset indent -compact
+.It Ic color_focus
+Border color of the currently focussed window.
+.It Ic color_unfocus
+Border color of unfocussed windows.
+.It Ic bar_enabled
+Enable or disable status bar.
+.It Ic bar_border[x]
+Color of the status bar border in screen x.
+.It Ic bar_color[x]
+Color of the status bar window in screen x.
+.It Ic bar_font_color[x]
+Color of the font in status bar in screen x.
+.It Ic bar_font
+Status bar font.
+.It Ic bar_action
+External script that populates additional information in the status bar such as
+battery life etc.
+.It Ic bar_delay
+Update frequency, in seconds, of external script that populates the status bar.
+.It Ic spawn_term
+External application that gets spawned when M-S-[Return] is used.
+.It Ic dialog_ratio
+Some applications have dialog windows that are too small to be useful.
+This ratio is the screen size as to what they will be resized.
+E.g 0.6 is 60% of the physical screen size.
+.It Ic screenshot_enabled
+Enable or disable screenshot capability.
+.It Ic screenshot_app
+Set to the script that will take screenshots.
+It will be called with "full" or "window" as parameter 1 to indicate what
+screenshot action is expected.
+The script shall handle those cases accordingly.
+.El
+.Pp
+Colors need to be specified per the
+.Xr XQueryColor 4
+specification and fonts need to be specified per the
+.Xr XQueryFont 4
+specification.
+.Sh BUGS
+Currently the menu, invoked with M-p, depends on dmenu.
 .Sh AUTHORS
 .An -nosplit
 .Pp
@@ -116,7 +183,3 @@ and
 .Sh HISTORY
 .Nm
 was inspired by xmonad & dwm.
-.Pp
-.Nm
-first appeared in
-.Ox 4.5 .