wmutils

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

commit 68f9cf71d12a3d5f75818678f8fc9752012f2a78
parent cd1f081e7af2a7e65154cb84f14c742090e383f6
Author: z3bra <willy@mailoo.org>
Date:   Fri Dec 12 20:12:31 2014

you get a manpage, you get a manpage. EVERYONE GET A MANPAGE

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 +---------------
 man/chwb.1             | 36 +++++++++++++++++++++++++++++++-
 man/chwso.1            | 34 +++++++++++++++++++++++++++++-
 man/ignw.1             | 35 ++++++++++++++++++++++++++++++-
 man/killw.1            | 18 +++++++++++++++-
 man/lsw.1              | 47 ++++++++++++++++++++++++++++++++++++++++-
 man/mapw.1             | 32 +++++++++++++++++++++++++++-
 man/pfw.1              | 18 +++++++++++++++-
 man/wattr.1            | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 man/wmv.1              | 29 +++++++++++++++++++++++++-
 man/wname.1            | 19 ++++++++++++++++-
 man/wrs.1              | 29 +++++++++++++++++++++++++-
 man/wtf.1              | 19 ++++++++++++++++-
 man/wtp.1              | 36 +++++++++++++++++++++++++++++++-
 26 files changed, 412 insertions(+), 231 deletions(-)

diff --git a/documentation/chwb.md b/documentation/chwb.md @@ -1,23 +0,0 @@ -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 @@ -1,15 +0,0 @@ -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 @@ -1,18 +0,0 @@ -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 @@ -1,11 +0,0 @@ -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 @@ -1,21 +0,0 @@ -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 @@ -1,19 +0,0 @@ -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 @@ -1,13 +0,0 @@ -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 @@ -1,40 +0,0 @@ -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 @@ -1,14 +0,0 @@ -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 @@ -1,11 +0,0 @@ -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 @@ -1,14 +0,0 @@ -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 @@ -1,14 +0,0 @@ - -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 @@ -1,18 +0,0 @@ -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. diff --git a/man/chwb.1 b/man/chwb.1 @@ -0,0 +1,36 @@ +.TH CHWB 1 "December 2014" wmutils + +.SH NAME +chwb - change window borders + +.SH SYNOPSIS +.B chwb +.RB [ -sc +.IR arg ]\ <wid>\ [ wid.. ] + +.SH DESCRIPTION +.B chwb +change the border size and color of the given window IDs +.TP +.BI -s\ <arg> +set border width of +.IR <wid>\ to\ <arg> +.TP +.BI -c\ <arg> +set border color of +.IR <wid>\ to\ <arg> +(see COLOR SPECIFICATION below) + +.SH COLOR SPECIFICATION +Colors should be passed in hexadecimal value, as specified by +.B strtoul(3) +(for example, "0x8064cc"). + +.SH ENVIRONMENT +.B chwb +follows the variable +.I DISPLAY +to set X.org display to act on. + +.SH SEE ALSO +.BR strtoul (3) diff --git a/man/chwso.1 b/man/chwso.1 @@ -0,0 +1,34 @@ +.TH chwso 1 "December 2014" wmutils + +.SH NAME +chwso - change window stacking order + +.SH SYNOPSIS +.B chwso +.BI -rli\ <wid> + +.SH DESCRIPTION +.B chwso +will change the place of a window in the server's window stack, putting it +either in the foreground or the background +.TP +.B -r +put +.I <wid> +on top of the window stack +.TP +.B -l +put +.I <wid> +at the bottom of the window stack +.TP +.B -i +invert +<wid> +position in the window stack + +.SH ENVIRONMENT +.B chwso +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/ignw.1 b/man/ignw.1 @@ -0,0 +1,35 @@ +.TH IGNW 1 "December 2014" wmutils + +.SH NAME +ignw - ignore window + +.SH SYNOPSIS +.B ignw -sr +.IR <wid>\ [ wid.. ] + +.SH DESCRIPTION +.B ignw +will change the value of the +.I override_redirect +attribute of a window to either 0 or 1. This will result in the window manager +ignoring the window or not + +.TP +.B -s +set override_redirect value to 1 for +.I <wid> +(ignore window) +.TP +.B -r +set override_redirect value to 0 for +.I <wid> +(unignore window) + +.SH ENVIRONMENT +.B ignw +follows the variable +.I DISPLAY +to set X.org display to act on. + +.SH SEE ALSO +.BR lsw (1),\ wattr (1),\ xcb_get_window_attributes (3) diff --git a/man/killw.1 b/man/killw.1 @@ -0,0 +1,18 @@ +.TH KILLW 1 "December 2014" wmutils + +.SH NAME +killw - kill windows + +.SH SYNOPSIS +.B killw +.IR <wid>\ [ wid.. ] + +.SH DESCRIPTION +.B killw +will simply kill the client(s) passed as arguments + +.SH ENVIRONMENT +.B killw +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/lsw.1 b/man/lsw.1 @@ -0,0 +1,47 @@ +.TH LSW 1 "December 2014" wmutils + +.SH NAME +lsw - list child windows + +.SH SYNOPSIS +.B lsw +.RB [ -oura ] +.RI [ wid.. ] + +.SH DESCRIPTION +.B lsw +will list all the children of the window passed as arguments. In case no +argument is given, +.B lsw +will list the children of the root window. + +Without any flag, +.B lsw +will only list the windows that a mapped (visible) and with the +.I override_redirect +value set to 0 (non ignored) + +.TP +.B -o +list windows having the +.I override_redirect +attribute set to 1 +.TP +.B -u +list unmapped (invisible) windows +.TP +.B -r +print root window id +.TP +.B -a +list all windows +.TP + +.SH ENVIRONMENT +.B lsw +follows the variable +.I DISPLAY +to set X.org display to act on. + +.SH SEE ALSO +.BR mapw (1),\ ignw (1),\ xargs (1) diff --git a/man/mapw.1 b/man/mapw.1 @@ -0,0 +1,32 @@ +.TH MAPW 1 "December 2014" wmutils + +.SH NAME +mapw - map or unmap window + +.SH SYNOPSIS +.BR mapw\ [ -mut +.IR <wid>\ [ wid.. ]] + +.SH DESCRIPTION +.B mapw +will either map or unmap a window from the screen, which will toggle the +visibility state of a window. + +.TP +.B -m +map (show) windows +.TP +.B -u +unmap (hide) windows +.TP +.B -t +toggle windows visibility + +.SH ENVIRONMENT +.B mapw +follows the variable +.I DISPLAY +to set X.org display to act on. + +.SH SEE ALSO +.BR lsw (1) diff --git a/man/pfw.1 b/man/pfw.1 @@ -0,0 +1,18 @@ +.TH PFW 1 "December 2014" wmutils + +.SH NAME +pfw - print focused window + +.SH SYNOPSIS +.B pfw + +.SH DESCRIPTION +.P +Print the ID of the currently focused window to stdout. Sorry, we couldn't make +simpler + +.SH ENVIRONMENT +.B pfw +follows the variable +.B DISPLAY +to set X.org display to act on. diff --git a/man/wattr.1 b/man/wattr.1 @@ -0,0 +1,60 @@ +.TH WATTR 1 "December 2014" wmutils + +.SH NAME +wattr - get windows attributes + +.SH SYNOPSIS +.B wattr +.RI [ bmwhxy ]\ <wid> + +.SH DESCRIPTION +.B wattr +will print the argument queried about the window to stdout, in the order they +are requested, separated by a space. + +When run without querying an attribute, +.B 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. + + +.TP +.B b +print <wid> borderwidth +.TP +.B x +print <wid> X offset +.TP +.B y +print <wid> Y offset +.TP +.B w +print <wid> width +.TP +.B h +print <wid> height +.TP +.B m +returns 0 if window is mapped on screen, 1 otherwise + +.SH 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 + +.SH ENVIRONMENT +.B wattr +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/wmv.1 b/man/wmv.1 @@ -0,0 +1,29 @@ +.TH WMV 1 "December 2014" wmutils + +.SH NAME +wmv - move windows (relatively) + +.SH SYNOPSIS +.B wmv +.I <x> <y> <wid> + +.SH DESCRIPTION +.B wmv +will move a window to another position using relative coordinates + +.TP +.I <x> +much pixel +.I <wid> +should move on the X axis +.TP +.I <y> +much pixel +.I <wid> +should move on the Y axis + +.SH ENVIRONMENT +.B wmv +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/wname.1 b/man/wname.1 @@ -0,0 +1,19 @@ +.TH WNAME 1 "December 2014" wmutils + +.SH NAME +wname - print window name + +.SH SYNOPSIS +.B wname +.IR <wid>\ [ wid.. ] + +.SH DESCRIPTION +.B wname +will print the name of the windows given as arguments, printing one name per +line + +.SH ENVIRONMENT +.B wname +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/wrs.1 b/man/wrs.1 @@ -0,0 +1,29 @@ +.TH WRS 1 "December 2014" wmutils + +.SH NAME +wrs - resize windows (relatively) + +.SH SYNOPSIS +.B wrs +.I <x> <y> <wid> +.RI [ wid.. ] + +.SH DESCRIPTION +will resize a window to another position using relative coordinates + +.TP +.I <x> +how much pixel +.I <wid> +should be the X axis +.TP +.I <y> +how much pixel +.I <wid> +should be the Y axis + +.SH ENVIRONMENT +.B wrs +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/wtf.1 b/man/wtf.1 @@ -0,0 +1,19 @@ +.TH WTF 1 "December 2014" wmutils + +.SH NAME +wtf - transfert window focus + +.SH SYNOPSIS +.BI wtf\ <wid> + +.SH DESCRIPTION +.B wtf +will set the keyboardi input focus to the window +.I <wid> +if it exists and is viewable + +.SH ENVIRONMENT +.B wtf +follows the variable +.I DISPLAY +to set X.org display to act on. diff --git a/man/wtp.1 b/man/wtp.1 @@ -0,0 +1,36 @@ +.TH WTP 1 "December 2014" wmutils + +.SH NAME +wtp - teleport window (absolutely) + +.SH SYNOPSIS +.B wtp +.I <x> <y> <w> <h> <wid> + +.SH DESCRIPTION +.B wtp +will move (or teleport) a window to the position given as arguments, and set +its size accordingly. Value are absolute value from the the left hand-corner + +.TP +.B <x> +X offset to set for +.I <wid> +.TP +.B <y> +Y offset to set for +.I <wid> +.TP +.B <w> +width to set for +.I <wid> +.TP +.B <h> +height to set for +.I <wid> + +.SH ENVIRONMENT +.B wtp +follows the variable +.I DISPLAY +to set X.org display to act on.