wmutils

X windows manipulation utilities
git clone git://z3bra.org/wmutils
Log | Files | Refs | LICENSE

commit 4662d2794e6e368f709d892bd1cdc225d01f2c7b
parent 1e8097d716bbd2a320a799126da9f3153ed97021
Author: z3bra <willy@mailoo.org>
Date:   Thu Dec  4 00:18:04 2014

added documentation for each tool

Diffstat:
 documentation/chwb.md  | 23 +++++++++++++++++++++++
 documentation/chwso.md | 15 +++++++++++++++
 documentation/ignw.md  | 18 ++++++++++++++++++
 documentation/killw.md | 11 +++++++++++
 documentation/lsw.md   | 21 +++++++++++++++++++++
 documentation/mapw.md  | 19 +++++++++++++++++++
 documentation/pfw.md   | 13 +++++++++++++
 documentation/wattr.md | 40 ++++++++++++++++++++++++++++++++++++++++
 documentation/wmv.md   | 14 ++++++++++++++
 documentation/wname.md | 11 +++++++++++
 documentation/wrs.md   | 14 ++++++++++++++
 documentation/wtf.md   | 14 ++++++++++++++
 documentation/wtp.md   | 18 ++++++++++++++++++
 13 files changed, 231 insertions(+), 0 deletions(-)

diff --git a/documentation/chwb.md b/documentation/chwb.md @@ -0,0 +1,23 @@ +NAME +---- +chwb - change window borders + +SYNOPSIS +-------- + chwb [-sc <arg>] <wid> [wid..] + + -s <arg> : set border width of <wid> to <arg> + -c <arg> : set border color of <wid> to <arg> + +COLOR SPECIFICATION +------------------- +Colors should be passed in hexadecimal value, as specified by strtoul(3) +(namely, "rrggbb"). + +ENVIRONMENT +----------- +chwb follows the variable `DISPLAY` to set X.org display to act on. + +SEE ALSO +-------- +strtoul(3) diff --git a/documentation/chwso.md b/documentation/chwso.md @@ -0,0 +1,15 @@ +NAME +---- +chwso - change window stacking order + +SYNOPSIS +-------- + chwso -rli <wid> + + -r : put <wid> on top of the window stack + -l : put <wid> at the bottom of the window stack + -i : invert <wid> position in the window stack + +ENVIRONMENT +----------- +chwso follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/ignw.md b/documentation/ignw.md @@ -0,0 +1,18 @@ +NAME +---- +ignw - ignore window + +SYNOPSIS +-------- + ignw -sr <wid> [wid..] + + -s : set override_redirect value to 1 for <wid> (ignore window) + -r : set override_redirect value to 0 for <wid> (unignore window) + +ENVIRONMENT +----------- +ignw follows the variable `DISPLAY` to set X.org display to act on. + +SEE ALSO +-------- +lsw(1), xcb_get_window_attributes(3) diff --git a/documentation/killw.md b/documentation/killw.md @@ -0,0 +1,11 @@ +NAME +---- +killw - kill windows + +SYNOPSIS +-------- + killw <wid> [wid..] + +ENVIRONMENT +----------- +ignw follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/lsw.md b/documentation/lsw.md @@ -0,0 +1,21 @@ +NAME +---- +lsw - list child windows + +SYNOPSIS +-------- + lsw [-air] [wid..] + + -a : list all windows (both mapped and unmapped) + -i : include ignored windows (cf. ignw(1)) + -r : print root window id + +If no window id is given, lsw will return all child windows of root window. + +ENVIRONMENT +----------- +lsw follows the variable `DISPLAY` to set X.org display to act on. + +SEE ALSO +-------- +mapw(1), ignw(1), xargs(1) diff --git a/documentation/mapw.md b/documentation/mapw.md @@ -0,0 +1,19 @@ +NAME +---- +mapw - map or unmap window + +SYNOPSIS +-------- + mapw [-mut <wid> [wid..]] + + -m : map (show) windows + -u : unmap (hide) windows + -t : toggle windows visibility + +ENVIRONMENT +----------- +mapw follows the variable `DISPLAY` to set X.org display to act on. + +SEE ALSO +-------- +lsw(1) diff --git a/documentation/pfw.md b/documentation/pfw.md @@ -0,0 +1,13 @@ +NAME +---- +pfw - print focused window + +SYNOPSIS +-------- + pfw + +sorry, we couldn't make simpler + +ENVIRONMENT +----------- +pfw follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/wattr.md b/documentation/wattr.md @@ -0,0 +1,40 @@ +NAME +---- +wattr - get windows attributes + +SYNOPSIS +-------- + wattr [bmwhxy] <wid> + + b : print <wid> borderwidth + x : print <wid> X offset + y : print <wid> Y offset + w : print <wid> width + h : print <wid> height + m : returns 0 if window is mapped on screen, 1 otherwise + +When run without querying an attribute, `wattr` will return 0 if the window +exists, 1 otherwise. + +Attributes can be chained, they will be printed in the order specified, +separated by spaces. + +EXAMPLE +------- + $ wattr m 0x01000006 && echo ismapped + ismapped + + $ wattr whxy 0x01000006 + 484 244 756 166 + + $ wattr xyhw 0x01000006 + 756 166 244 484 + + $ wattr 0x00000000 + $ echo $? + 1 + + +ENVIRONMENT +----------- +wattr follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/wmv.md b/documentation/wmv.md @@ -0,0 +1,14 @@ +NAME +---- +wmv - move windows (relatively) + +SYNOPSIS +-------- + wmv <x> <y> <wid> + + x : how much pixel <wid> should move on the X axis + y : how much pixel <wid> should move on the Y axis + +ENVIRONMENT +----------- +wmv follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/wname.md b/documentation/wname.md @@ -0,0 +1,11 @@ +NAME +---- +wname - print window name + +SYNOPSIS +-------- + wname <wid> + +ENVIRONMENT +----------- +wname follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/wrs.md b/documentation/wrs.md @@ -0,0 +1,14 @@ +NAME +---- +wrs - resize windows (relatively) + +SYNOPSIS +-------- + wrs <x> <y> <wid> [wid..] + + x : how much pixel <wid> should be the X axis + y : how much pixel <wid> should be the Y axis + +ENVIRONMENT +----------- +wrs follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/wtf.md b/documentation/wtf.md @@ -0,0 +1,14 @@ + +NAME +---- +wtf - transfert window focus + +SYNOPSIS +-------- + wtf <wid> + +Transfert input focus to <wid> + +ENVIRONMENT +----------- +wtf follows the variable `DISPLAY` to set X.org display to act on. diff --git a/documentation/wtp.md b/documentation/wtp.md @@ -0,0 +1,18 @@ +NAME +---- +wtp - teleport window (absolutely) + +SYNOPSIS +-------- + wtp <x> <y> <w> <h> <wid> + + x : X offset to set for <wid> + y : Y offset to set for <wid> + w : width to set for <wid> + h : height to set for <wid> + +This command use absolute values, and teleport `<wid>` to this geometry. + +ENVIRONMENT +----------- +wtp follows the variable `DISPLAY` to set X.org display to act on.