From 26848c93457606b350f57d6d313112a745a0cf3d Mon Sep 17 00:00:00 2001 From: David du Colombier <0intro@gmail.com> Date: Sat, 30 Sep 2023 22:56:22 +0200 Subject: [PATCH] man: regenerate manuals with txt2tags 3.3 --- man/wihack.1 | 13 ++---- man/wimenu.1 | 19 +------- man/wistrut.1 | 14 ++---- man/witray.1 | 13 +----- man/wmii.1 | 118 ++++++++++++++++++++++++++---------------------- man/wmii9menu.1 | 16 ++----- man/wmiir.1 | 39 +++++++--------- 7 files changed, 94 insertions(+), 138 deletions(-) diff --git a/man/wihack.1 b/man/wihack.1 index ec447b3e..475a90f0 100644 --- a/man/wihack.1 +++ b/man/wihack.1 @@ -3,19 +3,17 @@ .SH NAME .P wihack \- The wmii window hack - .SH SYNOPSIS .P -wihack \fI[\-transient \fI\fR]\fR \fI[\-type \fI\fR]\fR \fI[\-tags \fI\fR]\fR \fI\fR - +wihack [\fI\-transient \fI\fR\fR] [\fI\-type \fI\fR\fR] [\fI\-tags \fI\fR\fR] \fI\fR .SH DESCRIPTION .P \fBwihack\fR is a program which alters the windows created by an arbitrary program. It has the name \fBwihack\fR because it is just that: a hack. It uses LD_PRELOAD to override certain Xlib calls and add properties to newly created windows. - .SH ARGUMENTS + .TP \-transient \fI\fR Marks created windows as transient for a given \fI\fR. @@ -50,18 +48,13 @@ The created window opens on the given tags. .SH BUGS .P It is a hack. - .P It doesn't work for setuid programs. - .P It doesn't work for non\-Xlib programs. - .SH SEE ALSO .P wmii(1) - -.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net) +.\" man code generated by txt2tags 3.3 (http://txt2tags.org) .\" cmdline: txt2tags -o- wihack.man1 - diff --git a/man/wimenu.1 b/man/wimenu.1 index 5dca71e3..d7aee541 100644 --- a/man/wimenu.1 +++ b/man/wimenu.1 @@ -1,29 +1,21 @@ .TH "WIMENU" 1 "Oct, 2009" "wmii-@VERSION@" - .SH NAME - .P wimenu \- The wmii menu program - .SH SYNOPSIS - .P wimenu [\fI\-i\fR] [\fI\-h \fI\fR\fR] [\fI\-n \fI\fR\fR] [\fI\-p \fI\fR\fR] .P wimenu \-v - .SH DESCRIPTION - .P \fBwimenu\fR is \fBwmii\fR's standard menu program. It's used extensively by \fBwmii\fR and related programs to prompt the user for input. The standard configuration uses it to launch programs, select views, and perform standard actions. It supports basic item completion and history searching. - .SH BASIC ARGUMENTS - .P Normal use of \fBwimenu\fR shouldn't require any arguments other than the following. More advanced options are documented below. @@ -89,9 +81,7 @@ Causes each input item to be split at the first occurance of as a menu option, and the text to the right is displayed when a selection is made. .RE - .SH KEY BINDINGS - .P \fBwimenu\fR's default key bindings are based largely on the movement keys of vi and the standard UNIX shell input bindings. @@ -170,7 +160,6 @@ End, A\-S\-g Select the last completion page. .SH CUSTOM COMPLETION - .P Custom, multipart completion data may be proveded by an external application. When the standard input is not a TTY, @@ -183,7 +172,6 @@ line containing a single decimal number specifying where the new completion results are to be spliced into the input. When an item is selected, text from this position to the position of the caret is replaced. - .SS ARGUMENTS .TP @@ -194,7 +182,6 @@ user inputs a character, as such: \fI\fR\en\fI\fR\en .SS EXAMPLE - .P Let's assume that a script would like to provide a menu with completions first for a command name, then for arguments @@ -220,7 +207,6 @@ baz .RS 7, 8, 9 .RE - .P the following script provides the appropriate completions: @@ -272,7 +258,6 @@ wimenu -c \fR... +wistrut [\fI\-HV\fR] \fI\fR... .P wistrut \-v - .SH DESCRIPTION .P \fBwistrut\fR automatically sets EWMH struts on windows for programs @@ -20,10 +18,8 @@ free by wmii, provided it is less than half of the screen width or height. Struts are automatically updated when the managed windows are moved or resized, and are only applied if the window is touching an edge of the screen. - .P \fBwistrut\fR may be used with any EWMH compatible window manager. - .SH ARGUMENTS .P All non\-option arguments constitute window IDs or regular @@ -41,29 +37,27 @@ window, provided it is touching a screen edge. With this option set, they will always be allocated on either the left or right of the screen. Never the top or bottom. .RE + .TP \-V .RS Only set vertical struts. See \-H. .RE + .TP \-v .RS Display version information. .RE - .SH BUGS .P There is no way to remove struts from a window other than to move it away from the edge of the screen and kill \fBwistrut\fR. - .SH SEE ALSO .P wmii(1) - -.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net) +.\" man code generated by txt2tags 3.3 (http://txt2tags.org) .\" cmdline: txt2tags -o- wistrut.man1 - diff --git a/man/witray.1 b/man/witray.1 index fae886ac..c35b48ab 100644 --- a/man/witray.1 +++ b/man/witray.1 @@ -1,20 +1,14 @@ .TH "WITRAY" 1 "May, 2010" "wmii-@VERSION@" - .SH NAME - .P witray \- The wmii system tray - .SH SYNOPSIS - .P witray [\fI\-a \fI
\fR\fR] [\fI\-NESW\fR] [\fI\-HV\fR] [\fI\-p \fI\fR\fR] [\fI\-s \fI\fR\fR] \-t (tags) .P witray \-v - .SH DESCRIPTION - .P \fBwitray\fR is a simple system tray program meant to be used with wmii. It supports the Freedesktop System Tray Protocol Specification @@ -23,7 +17,6 @@ tray is only visible when applications require it. While there are many standalone system tray applications, this one is explicitly tailored to wmii. It's simple, stays out of the user's way, is easy to configure, and generally Just Works. - .SH ARGUMENTS .TP @@ -83,16 +76,12 @@ The tags on which to open. Default: \fI/./\fR .RS Display version information. .RE - .SH CAVEATS - .P \fBwitray\fR is not XRandR aware. - .SH SEE ALSO - .P wmii(1), wimenu(1) -.\" man code generated by txt2tags 2.6 (http://txt2tags.org) +.\" man code generated by txt2tags 3.3 (http://txt2tags.org) .\" cmdline: txt2tags -o- witray.man1 diff --git a/man/wmii.1 b/man/wmii.1 index 4c99e834..c59790ae 100644 --- a/man/wmii.1 +++ b/man/wmii.1 @@ -3,13 +3,11 @@ .SH NAME .P wmii \- Window Manager Improved² - .SH SYNOPSIS .P -wmii \fI[\-a \fI
\fR]\fR \fI[\-r \fI\fR]\fR +wmii [\fI\-a \fI
\fR\fR] [\fI\-r \fI\fR\fR] .P wmii \-v - .SH DESCRIPTION .SS Overview .P @@ -20,7 +18,6 @@ applications are used at the same time. The window manager adapts to the current environment and fits to the needs of the user, rather than forcing him to use a preset, fixed layout and trying to shoehorn all windows and applications into it. - .P \fBwmii\fR supports classic and tiled window management with extended keyboard and mouse control. Classic window management @@ -30,7 +27,6 @@ vertical columns. Each column holds an arbitrary number arbitrary windows and arranges them vertically in a non\-overlapping manner. They can then be moved and resized, among and within columns, at will. - .P \fBwmii\fR provides a virtual filesystem which represents the internal state similar to the procfs of Unix operating systems. @@ -39,26 +35,30 @@ of the window manager. The virtual filesystem service can be accessed through 9P\-capable client programs, like wmiir(1). This allows simple and powerful remote control of the core window manager. - .SS Command Line Arguments + .TP \-a \fI
\fR Specifies the address on which \fBwmii\fR should listen for connections. The address takes the form \fB\fI\fR!\fI
\fR\fR. The default is of the form: + .nf - unix!/tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR/wmii + unix!/tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR/wmii .fi + which opens a unix socket per Plan 9 Port conventions. To open a TCP socket, listening at port 4332 on the loopback interface, use: + .nf - tcp!localhost!4332 + tcp!localhost!4332 .fi + \fB$WMII_NAMESPACE\fR is automatically set to this value. .TP @@ -70,6 +70,7 @@ environment variables \fB$WMII_ADDRESS\fR and \fB$WMII_CONFPATH\fR are preset for the script. .SS Terminology + .TP Display A running X server instance consisting of input @@ -127,7 +128,6 @@ special file in the filesystem of \fBwmii\fR, such as a mouse button press, a key press, or a message written by a different 9P\-client. - .SS Basic window management .P Running a raw \fBwmii\fR process without a wmiirc(1) script provides @@ -138,17 +138,14 @@ and resize clients with the mouse, but not to change their tags or to switch views. Other interactions, such as customizing the style, killing or retagging clients, and grabbing keys, cannot be achieved without accessing the filesystem. - .P The filesystem can be accessed by connecting to the \fIaddress\fR of \fBwmii\fR with any 9P\-capable client, such as wmiir(1) - .SS Actions .P The default configuration provides for a special menu of actions. These consist of either shell scripts in \fB$WMII_CONFPATH\fR or action definitions included in wmiirc. - .P Here is a list of the default actions: @@ -167,8 +164,8 @@ tab(^); ll. All of the provided \fBwmiirc\fR scripts accept at least the following key bindings. They should also provide a \fBshowkeys\fR action to open a key binding quick\-reference. - .SS Moving Around + .TS tab(^); ll. \fBKey\fR^\fBAction\fR @@ -180,10 +177,11 @@ tab(^); ll. Mod\-t \fI\fR^Move to the view of the given \fI\fR Mod\-n^Move to the next view Mod\-b^Move to the previous view - Mod\-\fI\fI[0\-9]\fR\fR^Move to the view with the given number + Mod\-\fI[\fI0\-9\fR]\fR^Move to the view with the given number .TE .SS Moving Things Around + .TS tab(^); ll. \fBKey\fR^\fBAction\fR @@ -193,10 +191,11 @@ tab(^); ll. Mod\-Shift\-k^Move the current window above the window above it. Mod\-Shift\-space^Toggle the current window between the managed and floating layer Mod\-Shift\-t \fI\fR^Move the current window to the view of the given \fI\fR - Mod\-Shift\-\fI\fI[0\-9]\fR\fR^Move the current window to the view with the given number + Mod\-Shift\-\fI[\fI0\-9\fR]\fR^Move the current window to the view with the given number .TE .SS Miscellaneous + .TS tab(^); ll. \fBKey\fR^\fBAction\fR @@ -216,18 +215,16 @@ customize (as described above) the \fBwmiirc\fR action. This action is executed at the end of the \fBwmii\fR script and does all the work of setting up the window manager, the key bindings, the bar labels, etc. - .SS Filesystem .P Most aspects of \fBwmii\fR are controlled via the filesystem. It is usually accessed via the wmiir(1) command, but it can be -accessed by any 9P, including plan9port's 9P\fI[1]\fR, and can be -mounted natively on Linux via v9fs\fI[1]\fR, and on Inferno (which man +accessed by any 9P, including plan9port's 9P[\fI1\fR], and can be +mounted natively on Linux via v9fs[\fI1\fR], and on Inferno (which man run on top of Linux). All data in the filesystem, including filenames, is UTF\-8 encoded. However, when accessed via wmiir(1), text is automatically translated to and from your locale encoding. - .P The filesystem is, as are many other 9P filesystems, entirely synthetic. The files exist only in memory, and are not written @@ -238,8 +235,8 @@ are updated and returned exactly as written), though writing them has side\-effects (such as changing key bindings). A description of the filesystem layout and control commands follows. - .SS Hierarchy + .TP / Global control files @@ -253,24 +250,28 @@ View control files /lbar/, /rbar/ Files representing the contents of the bottom bar - .SS The / Hierarchy + .TP colrules The \fIcolrules\fR file contains a list of rules which affect the width of newly created columns. Rules have the form: + .nf - /\fI\fR/ -> \fI\fR\fI[+\fI\fR]\fR* + /\fI\fR/ -> \fI\fR[\fI+\fI\fR\fR]* .fi + Where, + .nf - \fI\fR := \fI\fR | \fI\fRpx + \fI\fR := \fI\fR | \fI\fRpx .fi + When a new column, \fI\fR, is created on a view whose name matches \fI\fR, it is given the \fI\fRth supplied \fI\fR. If there is no \fI\fRth width, it is given 1/\fI\fRth of the @@ -284,10 +285,12 @@ The \fIrules\fR file contains a list of rules that may be used to automatically set properties of new clients. Rules are specified as: + .nf - /\fI\fR/ \fI\fR=\fI\fR ... + /\fI\fR/ \fI\fR=\fI\fR ... .fi + where each \fI\fR represents a command in the clients \fIctl\fR file, and each \fI\fR represents the value to assign to it. The rules are applied when the client is first started and @@ -323,14 +326,14 @@ The \fIevent\fR file never returns EOF while as they occur. Included among them are: .RS 8 .TP -\fI[Not]\fRUrgent \fI\fR \fI[Manager|Client]\fR +[\fINot\fR]Urgent \fI\fR [\fIManager|Client\fR] \fI\fR's urgent hint has been set or -unset. The second arg is \fI[Client]\fR if it's -been set by the client, and \fI[Manager]\fR if +unset. The second arg is [\fIClient\fR] if it's +been set by the client, and [\fIManager\fR] if it's been set by \fBwmii\fR via a control message. .TP -\fI[Not]\fRUrgentTag \fI\fR \fI[Manager|Client]\fR +[\fINot\fR]UrgentTag \fI\fR [\fIManager|Client\fR] A client on \fI\fR has had its urgent hint set, or the last urgent client has had its urgent hint unset. @@ -339,13 +342,13 @@ Client\fI\fR \fI\fR \fI