wmutils

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

commit d6ab5516915e86fbdadfaa03993f62f47142cbd1
parent 9f23581ac80d8f05889277bb209a3d5e77990f01
Author: dead cat <dcat@users.noreply.github.com>
Date:   Wed Dec 17 11:53:54 2014

Merge pull request #8 from bentley/mdoc

Convert the manpages to use semantic mdoc(7) macros.
Diffstat:
 man/chwb.1  |  76 +++++++++++++++++-----------------
 man/chwso.1 |  67 ++++++++++++++----------------
 man/ignw.1  |  72 ++++++++++++++++-----------------
 man/killw.1 |  36 ++++++++--------
 man/lsw.1   |  90 +++++++++++++++++++----------------------
 man/mapw.1  |  64 ++++++++++++++---------------
 man/pfw.1   |  34 +++++++--------
 man/wattr.1 | 135 +++++++++++++++++++++++++++++++++----------------------------
 man/wmv.1   |  61 ++++++++++++++--------------
 man/wname.1 |  37 ++++++++---------
 man/wrs.1   |  51 +++++++++--------------
 man/wtf.1   |  38 ++++++++---------
 man/wtp.1   |  63 ++++++++++++----------------
 13 files changed, 412 insertions(+), 412 deletions(-)

diff --git a/man/chwb.1 b/man/chwb.1 @@ -1,36 +1,40 @@ -.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) +.Dd December 13, 2014 +.Dt CHWB 1 +.Os wmutils +.Sh NAME +.Nm chwb +.Nd change window borders +.Sh SYNOPSIS +.Nm chwb +.Op Fl c Ar color +.Op Fl s Ar size +.Ar wid Op Ar ... +.Sh DESCRIPTION +.Nm +changes the border size or color of the window +.Ar wid . +.Bl -tag -width Ds +.It Fl c Ar color +Set border color of +.Ar wid +to +.Ar color . +Colors should be passed as numerical values (see +.Xr strtoul 3 ) +in RGB format. +.It Fl s Ar size +Set border width of +.Ar wid +to +.Ar size . +.El +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. +.Sh EXAMPLES +Set the border color to 128 red, 100 green, 204 blue: +.Dl $ chwb -c 0x8064cc +.Sh SEE ALSO +.Xr strtoul 3 diff --git a/man/chwso.1 b/man/chwso.1 @@ -1,34 +1,33 @@ -.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. +.Dd December 13, 2014 +.Dt CHWSO 1 +.Os wmutils +.Sh NAME +.Nm chwso +.Nd change window stacking order +.Sh SYNOPSIS +.Nm chwso +.Op Fl ilr +.Ar wid +.Sh DESCRIPTION +.Nm +will change the place of a window in the server\(cqs window stack, +putting it in either the foreground or the background. +.Bl -tag -width Ds +.It Fl i +Invert +.Ar wid Ns \(cqs +position in the window stack. +.It Fl l +Put +.Ar wid +at the bottom of the window stack. +.It Fl r +Put +.Ar wid +on top of the window stack. +.El +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/ignw.1 b/man/ignw.1 @@ -1,35 +1,37 @@ -.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) +.Dd December 13, 2014 +.Dt IGNW 1 +.Os wmutils +.Sh NAME +.Nm ignw +.Nd ignore window +.Sh SYNOPSIS +.Nm ignw +.Fl rs +.Ar wid Op ... +.Sh DESCRIPTION +.Nm +changes the value of the +.Em override_redirect +attribute of a window to either 0 or 1. +This affects whether the window manager ignores the window. +.Bl -tag -width Ds +.It Fl r +Reset +.Ar wid Ns \(cqs +.Em override_redirect +value to 0, unignoring the window. +.It Fl s +Set +.Ar wid Ns \(cqs +.Em override_redirect +value to 1, ignoring the window. +.El +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. +.Sh SEE ALSO +.Xr lsw 1 , +.Xr wattr 1 , +.Xr xcb_get_window_attributes 3 diff --git a/man/killw.1 b/man/killw.1 @@ -1,18 +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. +.Dd December 13, 2014 +.Dt KILLW 1 +.Os wmutils +.Sh NAME +.Nm killw +.Nd kill windows +.Sh SYNOPSIS +.Nm killw +.Ar wid Op ... +.Sh DESCRIPTION +.Nm +kills the window +.Ar wid . +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/lsw.1 b/man/lsw.1 @@ -1,47 +1,43 @@ -.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) +.Dd December 13, 2014 +.Dt LSW 1 +.Os wmutils +.Sh NAME +.Nm lsw +.Nd list child windows +.Sh SYNOPSIS +.Nm lsw +.Op Fl arou +.Op Ar wid ... +.Sh DESCRIPTION +.Nm +lists child windows of the given window. +If no windows are given, +.Nm +lists the children of the root window. +.Pp +By default, +.Nm +lists only windows that are mapped (visible) and with the +.Em override_redirect +value set to 0 (i.e., unignored). +.Bl -tag -width Ds +.It Fl a +List all windows. +.It Fl r +Print the ID of the root window. +.It Fl o +List windows whose +.Em override_redirect +attribute is set to 1. +.It Fl u +List unmapped (invisible) windows. +.El +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. +.Sh SEE ALSO +.Xr ignw 1 , +.Xr mapw 1 , +.Xr xargs 1 diff --git a/man/mapw.1 b/man/mapw.1 @@ -1,32 +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) +.Dd December 13, 2014 +.Dt MAPW 1 +.Os wmutils +.Sh NAME +.Nm mapw +.Nd map or unmap window +.Sh SYNOPSIS +.Nm mapw +.Op Fl mtu +.Ar wid Op ... +.Sh DESCRIPTION +.Nm +will either map or unmap a window from the screen, +thus modifying the visibility state of the window. +.Bl -tag -width Ds +.It Fl m +Map (show) +.Ar wid . +.It Fl t +Toggle +.Ar wid Ns \(cqs visibility. +.It Fl u +Unmap (hide) +.Ar wid . +.El +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. +.Sh SEE ALSO +.Xr lsw 1 diff --git a/man/pfw.1 b/man/pfw.1 @@ -1,18 +1,16 @@ -.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. +.Dd December 13, 2014 +.Dt PFW 1 +.Os wmutils +.Sh NAME +.Nm pfw +.Nd print focused window +.Sh SYNOPSIS +.Nm pfw +.Sh DESCRIPTION +Print the ID of the currently focused window to +.Dv stdout . +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/wattr.1 b/man/wattr.1 @@ -1,60 +1,75 @@ -.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. +'\" e +.Dd December 13, 2014 +.Dt WATTR 1 +.Os wmutils +.Sh NAME +.Nm wattr +.Nd get window attributes +.Sh SYNOPSIS +.Nm wattr +.Op Cm bmhwxy +.Ar wid +.Sh DESCRIPTION +.Nm +prints information about the window +.Ar wid +to +.Dv stdout . +.Pp +What information is presented depends on the commands given to +.Nm . +The queried arguments are printed in the order they are requested, +separated by a space. +If no commands are given, +.Nm +will return 0 if +.Ar wid +exists, and 1 otherwise. +.Bl -tag -width Ds +.It Cm b +Print +.Ar wid Ns \(cqs border width. +.It Cm x +Print +.Ar wid Ns \(cqs +.EQ +x +.EN +offset. +.It Cm y +Print +.Ar wid Ns \(cqs +.EQ +y +.EN +offset. +.It Cm w +Print +.Ar wid Ns \(cqs width. +.It Cm h +Print +.Ar wid Ns \(cqs +height. +.It Cm m +.Nm +returns 0 if +.Ar wid +is mapped on screen, and 1 otherwise. +.El +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. +.Sh EXAMPLES +.Dl $ wattr m 0x01000006 && echo ismapped +.Dl ismapped +.Pp +.Dl $ wattr whxy 0x01000006 +.Dl 484 244 756 166 +.Pp +.Dl $ wattr xyhw 0x01000006 +.Dl 756 166 244 484 +.Pp +.Dl $ wattr 0x00000000 ; echo $? +.Dl 1 diff --git a/man/wmv.1 b/man/wmv.1 @@ -1,29 +1,32 @@ -.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. +'\" e +.Dd December 13, 2014 +.Dt WMV 1 +.Os wmutils +.Sh NAME +.Nm wmv +.Nd move windows (relatively) +.Sh SYNOPSIS +.Nm wmv +.Ar x y wid +.Sh DESCRIPTION +.Nm wmv +repositions +.Ar wid +relatively, +.Ar x +pixels in the +.EQ +x +.EN +direction and +.Ar y +pixels in the +.EQ +y +.EN +direction. +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/wname.1 b/man/wname.1 @@ -1,19 +1,18 @@ -.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. +.Dd December 13, 2014 +.Dt WNAME 1 +.Os wmutils +.Sh NAME +.Nm wname +.Nd print window name +.Sh SYNOPSIS +.Nm wname +.Ar wid Op ... +.Sh DESCRIPTION +.Nm +prints the name of the window IDs given as arguments, +one name per line. +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/wrs.1 b/man/wrs.1 @@ -1,29 +1,22 @@ -.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. +.Dd December 13, 2014 +.Dt WRS 1 +.Os wmutils +.Sh NAME +.Nm wrs +.Nd resize windows (relatively) +.Sh SYNOPSIS +.Nm wrs +.Ar x y wid Op ... +.Sh DESCRIPTION +.Nm +resizes the window +.Ar wid +based on the relative pixel values +.Ar x +and +.Ar y . +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/wtf.1 b/man/wtf.1 @@ -1,19 +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. +.Dd December 13, 2014 +.Dt WTF 1 +.Os wmutils +.Sh NAME +.Nm wtf +.Nd transfer window focus +.Sh SYNOPSIS +.Nm wtf +.Ar wid +.Sh DESCRIPTION +.Nm +sets the keyboard input focus to the window +.Ar wid +if it exists and is viewable. +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable. diff --git a/man/wtp.1 b/man/wtp.1 @@ -1,36 +1,27 @@ -.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. +.Dd December 13, 2014 +.Dt WTP 1 +.Os wmutils +.Sh NAME +.Nm wtp +.Nd teleport window (absolutely) +.Sh SYNOPSIS +.Nm wtp +.Ar x y w h wid +.Sh DESCRIPTION +.Nm +moves (or teleports) the window +.Ar wid +to the position given by +.Ar x +and +.Ar y , +and resize it to width +.Ar w +and height +.Ar h . +Value are absolute value from the the upper-left-hand corner. +.Sh ENVIRONMENT +.Nm +acts on the X display specified by the +.Ev DISPLAY +variable.