aboutsummaryrefslogtreecommitdiffstats
path: root/cwmrc.5
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--cwmrc.5158
1 files changed, 158 insertions, 0 deletions
diff --git a/cwmrc.5 b/cwmrc.5
new file mode 100644
index 0000000..fa22213
--- /dev/null
+++ b/cwmrc.5
@@ -0,0 +1,158 @@
+.\" $OpenBSD: cwmrc.5,v 1.1 2008/03/23 15:09:21 simon Exp $
+.\"
+.\" Copyright (c) 2004,2005 Marius Aamodt Eriksen <marius@monkey.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.\" The following requests are required for all man pages.
+.Dd $Mdocdate: March 23 2008 $
+.Dt CWMRC 1
+.Os
+.Sh NAME
+.Nm cwmrc
+.Nd calm window manager configuration file
+.Sh DESCRIPTION
+The
+.Xr cwm 1
+window manager configuration file format.
+.Sh OPTIONS
+There are quite a few settings that affect the operation of
+.Xr cwm 1 .
+.Pp
+The following options are accepted in the configuration file:
+.Pp
+.Bl -tag -width Ds
+.It Ic fontname Ar font
+Makes the
+.Xr Xft 3
+font string
+.Ar font
+the default font.
+.It Ic sticky Ic yes Ns \&| Ns Ic no
+Set sticky group mode on.
+The default behavior for new windows is to not assign any group.
+This changes the default behavior to assigning the currrently selected
+group to any newly created windows.
+.It Ic command Ar name Ar path
+Every command entry is shown in the application menu.
+When it is selected, the image is executed with
+.Xr execve 2 .
+.Pp
+The entries
+.Nm term
+and
+.Nm lock
+have a special meaning.
+When they exist they point to the terminal program and screen locking
+programs used by the keybindings specified above.
+The defaults for these are
+.Xr xterm 1
+and
+.Xr xlock 1 ,
+respectively.
+.It Ic autogroup Ar group Dq windowclass
+.It Ic autogroup Ar group Dq windowclass,windowname
+Autogroups are read upon startup and control the
+automatic grouping feature, which is based on the window name and class
+properties.
+The group is a number between 1 and 9.
+.Pp
+To obtain the name and class of a window, use
+.Ql xprop WM_CLASS ,
+then click on the window.
+The first quoted string is the window name; the second one is the
+window class.
+.Pp
+For example, to make all windows in the
+.Xr xterm 1
+class go to the third group:
+.Bd -literal -offset indent
+autogroup 3 XTerm
+.Ed
+.It Ic ignore Ar program
+Ignore programs by that name by not drawing borders around them.
+For example the command
+.Bd -literal -offset indent
+ignore xclock
+.Ed
+will cause any instances of
+.Xr xclock 1
+to not have borders.
+.It Ic bind Ar keys Ar command
+Cause the creation of keyboard shortcuts.
+The default shortcuts will always be created. In case of conflict,
+user-defined shortcuts take precidence.
+The modifier keys come first, followed by a ``-''.
+The following modifiers are recognised:
+.Bl -tag -width Ds
+.It Pa C
+The Control key.
+.It Pa M
+The Meta key.
+.It Pa S
+The Shift key.
+.It Pa 2
+The Mod2 key.
+.It Pa 3
+The Mod3 key.
+.It Pa 4
+The Mod4 key (normally the windows key).
+.El
+The ``-'' should be followed by either a keysym name, taken from
+.Pa /usr/X11R6/include/X11/keysymdef.h ,
+or a numerical keycode value enclosed in ``[]''.
+The command should be either the name of a task from the
+``name_to_kbfunc''
+structure in
+.Pa conf.c ,
+or, alternatively it should be the commandline that is wished to be executed.
+A special case is the ``unmap'' keyword, which causes any bindings using the
+named shortcut to be removed. This can be used to remove a binding which conflicts
+with an application.
+.Pp
+For example, to cause
+.Ic C-M-r
+to add a label to a window:
+.Bd -literal -offset indent
+bind CM-r "label"
+.Ed
+.Pp
+Launch an xterm running
+.Xr top 1
+with C-S-Enter:
+.Bd -literal -offset indent
+bind CS-Return "/usr/X11R6/bin/xterm -e top"
+.Ed
+.Pp
+Remove a keybinding for Mod4-o
+.Bd -literal -offset indent
+bind 4-o "unmap"
+.Ed
+.El
+.Sh SEE ALSO
+.Xr cwm 1
+.Sh AUTHORS
+.An -nosplit
+.Pp
+.Nm
+was initially written by
+.An Marius Aamodt Eriksen Aq marius@monkey.org
+with contributions from
+.An Andy Adamson Aq dros@monkey.org ,
+.An Niels Provos Aq provos@monkey.org ,
+and
+.An Antti Nykänen Aq aon@iki.fi .
+.Sh HISTORY
+.Nm
+first appeared in
+.Ox 4.4 .