mirrors/wmii
1
0
Fork 0
mirror of https://github.com/0intro/wmii synced 2024-11-21 21:31:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

man: regenerate manuals with txt2tags 3.3

Browse Source
This commit is contained in:
David du Colombier 2023-09-30 22:56:22 +02:00
parent d3b212ad29
commit 26848c9345
7 changed files with 94 additions and 138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
man/wihack.1
View File

@ -3,19 +3,17 @@
.SH NAME .SH NAME
.P .P
wihack \- The wmii window hack wihack \- The wmii window hack
.SH SYNOPSIS .SH SYNOPSIS
.P .P
wihack \fI[\-transient \fI<window>\fR]\fR \fI[\-type \fI<ewmh window type>\fR]\fR \fI[\-tags \fI<tags>\fR]\fR \fI<program>\fR wihack [\fI\-transient \fI<window>\fR\fR] [\fI\-type \fI<ewmh window type>\fR\fR] [\fI\-tags \fI<tags>\fR\fR] \fI<program>\fR
.SH DESCRIPTION .SH DESCRIPTION
.P .P
\fBwihack\fR is a program which alters the windows created by an \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: 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 a hack. It uses LD_PRELOAD to override certain Xlib calls and add
properties to newly created windows. properties to newly created windows.
.SH ARGUMENTS .SH ARGUMENTS
.TP .TP
\-transient \fI<window>\fR \-transient \fI<window>\fR
Marks created windows as transient for a given \fI<window>\fR. Marks created windows as transient for a given \fI<window>\fR.
@ -50,18 +48,13 @@ The created window opens on the given tags.
.SH BUGS .SH BUGS
.P .P
It is a hack. It is a hack.
.P .P
It doesn't work for setuid programs. It doesn't work for setuid programs.
.P .P
It doesn't work for non\-Xlib programs. It doesn't work for non\-Xlib programs.
.SH SEE ALSO .SH SEE ALSO
.P .P
wmii(1) wmii(1)
.\" man code generated by txt2tags 3.3 (http://txt2tags.org)
.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
.\" cmdline: txt2tags -o- wihack.man1 .\" cmdline: txt2tags -o- wihack.man1

19
man/wimenu.1
View File

@ -1,29 +1,21 @@
.TH "WIMENU" 1 "Oct, 2009" "wmii-@VERSION@" .TH "WIMENU" 1 "Oct, 2009" "wmii-@VERSION@"
.SH NAME .SH NAME
.P .P
wimenu \- The wmii menu program wimenu \- The wmii menu program
.SH SYNOPSIS .SH SYNOPSIS
.P .P
wimenu [\fI\-i\fR] [\fI\-h \fI<history file>\fR\fR] [\fI\-n \fI<history count>\fR\fR] [\fI\-p \fI<prompt>\fR\fR] wimenu [\fI\-i\fR] [\fI\-h \fI<history file>\fR\fR] [\fI\-n \fI<history count>\fR\fR] [\fI\-p \fI<prompt>\fR\fR]
.P .P
wimenu \-v wimenu \-v
.SH DESCRIPTION .SH DESCRIPTION
.P .P
\fBwimenu\fR is \fBwmii\fR's standard menu program. It's used \fBwimenu\fR is \fBwmii\fR's standard menu program. It's used
extensively by \fBwmii\fR and related programs to prompt the user extensively by \fBwmii\fR and related programs to prompt the user
for input. The standard configuration uses it to launch for input. The standard configuration uses it to launch
programs, select views, and perform standard actions. It programs, select views, and perform standard actions. It
supports basic item completion and history searching. supports basic item completion and history searching.
.SH BASIC ARGUMENTS .SH BASIC ARGUMENTS
.P .P
Normal use of \fBwimenu\fR shouldn't require any arguments other than the Normal use of \fBwimenu\fR shouldn't require any arguments other than the
following. More advanced options are documented below. 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 as a menu option, and the text to the right is displayed when a
selection is made. selection is made.
.RE .RE
.SH KEY BINDINGS .SH KEY BINDINGS
.P .P
\fBwimenu\fR's default key bindings are based largely on the \fBwimenu\fR's default key bindings are based largely on the
movement keys of vi and the standard UNIX shell input bindings. movement keys of vi and the standard UNIX shell input bindings.
@ -170,7 +160,6 @@ End, A\-S\-g
Select the last completion page. Select the last completion page.
.SH CUSTOM COMPLETION .SH CUSTOM COMPLETION
.P .P
Custom, multipart completion data may be proveded by an Custom, multipart completion data may be proveded by an
external application. When the standard input is not a TTY, 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 new completion results are to be spliced into the input. When
an item is selected, text from this position to the position an item is selected, text from this position to the position
of the caret is replaced. of the caret is replaced.
.SS ARGUMENTS .SS ARGUMENTS
.TP .TP
@ -194,7 +182,6 @@ user inputs a character, as such:
\fI<text before caret>\fR\en\fI<text after caret>\fR\en \fI<text before caret>\fR\en\fI<text after caret>\fR\en
.SS EXAMPLE .SS EXAMPLE
.P .P
Let's assume that a script would like to provide a menu with Let's assume that a script would like to provide a menu with
completions first for a command name, then for arguments completions first for a command name, then for arguments
@ -220,7 +207,6 @@ baz
.RS .RS
7, 8, 9 7, 8, 9
.RE .RE
.P .P
the following script provides the appropriate completions: the following script provides the appropriate completions:
@ -272,7 +258,6 @@ wimenu -c <fifo | awk '
In theory, this facility can be used for myriad purposes, In theory, this facility can be used for myriad purposes,
including hijacking the programmable completion facilities of including hijacking the programmable completion facilities of
most shells. See also the provided examples[\fI1\fR]. most shells. See also the provided examples[\fI1\fR].
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
@ -284,14 +269,12 @@ The namespace directory to use if no address is
provided. provided.
.SH SEE ALSO .SH SEE ALSO
.P .P
wmii(1), wmiir(1), wistrug(1), wmii9menu(1), dmenu(1) wmii(1), wmiir(1), wistrug(1), wmii9menu(1), dmenu(1)
.P .P
[\fI1\fR] http://www.suckless.org/wiki/wmii/tips/9p_tips [\fI1\fR] http://www.suckless.org/wiki/wmii/tips/9p_tips
.P .P
[\fI2\fR] @EXAMPLES@ [\fI2\fR] @EXAMPLES@
.\" man code generated by txt2tags 2.6 (http://txt2tags.org) .\" man code generated by txt2tags 3.3 (http://txt2tags.org)
.\" cmdline: txt2tags -o- wimenu.man1 .\" cmdline: txt2tags -o- wimenu.man1

14
man/wistrut.1
View File

@ -3,13 +3,11 @@
.SH NAME .SH NAME
.P .P
wistrut \- The wmii EWMH strut manager wistrut \- The wmii EWMH strut manager
.SH SYNOPSIS .SH SYNOPSIS
.P .P
wistrut \fI[\-HV]\fR \fI<window|class>\fR... wistrut [\fI\-HV\fR] \fI<window|class>\fR...
.P .P
wistrut \-v wistrut \-v
.SH DESCRIPTION .SH DESCRIPTION
.P .P
\fBwistrut\fR automatically sets EWMH struts on windows for programs \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 height. Struts are automatically updated when the managed windows
are moved or resized, and are only applied if the window is touching are moved or resized, and are only applied if the window is touching
an edge of the screen. an edge of the screen.
.P .P
\fBwistrut\fR may be used with any EWMH compatible window manager. \fBwistrut\fR may be used with any EWMH compatible window manager.
.SH ARGUMENTS .SH ARGUMENTS
.P .P
All non\-option arguments constitute window IDs or regular 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 option set, they will always be allocated on either the left
or right of the screen. Never the top or bottom. or right of the screen. Never the top or bottom.
.RE .RE
.TP .TP
\-V \-V
.RS .RS
Only set vertical struts. See \-H. Only set vertical struts. See \-H.
.RE .RE
.TP .TP
\-v \-v
.RS .RS
Display version information. Display version information.
.RE .RE
.SH BUGS .SH BUGS
.P .P
There is no way to remove struts from a window other than to move it 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. away from the edge of the screen and kill \fBwistrut\fR.
.SH SEE ALSO .SH SEE ALSO
.P .P
wmii(1) wmii(1)
.\" man code generated by txt2tags 3.3 (http://txt2tags.org)
.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
.\" cmdline: txt2tags -o- wistrut.man1 .\" cmdline: txt2tags -o- wistrut.man1

13
man/witray.1
View File

@ -1,20 +1,14 @@
.TH "WITRAY" 1 "May, 2010" "wmii-@VERSION@" .TH "WITRAY" 1 "May, 2010" "wmii-@VERSION@"
.SH NAME .SH NAME
.P .P
witray \- The wmii system tray witray \- The wmii system tray
.SH SYNOPSIS .SH SYNOPSIS
.P .P
witray [\fI\-a \fI<address>\fR\fR] [\fI\-NESW\fR] [\fI\-HV\fR] [\fI\-p \fI<padding>\fR\fR] [\fI\-s \fI<iconsize>\fR\fR] \-t (tags) witray [\fI\-a \fI<address>\fR\fR] [\fI\-NESW\fR] [\fI\-HV\fR] [\fI\-p \fI<padding>\fR\fR] [\fI\-s \fI<iconsize>\fR\fR] \-t (tags)
.P .P
witray \-v witray \-v
.SH DESCRIPTION .SH DESCRIPTION
.P .P
\fBwitray\fR is a simple system tray program meant to be used with wmii. \fBwitray\fR is a simple system tray program meant to be used with wmii.
It supports the Freedesktop System Tray Protocol Specification 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 many standalone system tray applications, this one is explicitly
tailored to wmii. It's simple, stays out of the user's way, is easy tailored to wmii. It's simple, stays out of the user's way, is easy
to configure, and generally Just Works. to configure, and generally Just Works.
.SH ARGUMENTS .SH ARGUMENTS
.TP .TP
@ -83,16 +76,12 @@ The tags on which to open. Default: \fI/./\fR
.RS .RS
Display version information. Display version information.
.RE .RE
.SH CAVEATS .SH CAVEATS
.P .P
\fBwitray\fR is not XRandR aware. \fBwitray\fR is not XRandR aware.
.SH SEE ALSO .SH SEE ALSO
.P .P
wmii(1), wimenu(1) 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 .\" cmdline: txt2tags -o- witray.man1

100
man/wmii.1
View File

@ -3,13 +3,11 @@
.SH NAME .SH NAME
.P .P
wmii \- Window Manager Improved² wmii \- Window Manager Improved²
.SH SYNOPSIS .SH SYNOPSIS
.P .P
wmii \fI[\-a \fI<address>\fR]\fR \fI[\-r \fI<wmiirc>\fR]\fR wmii [\fI\-a \fI<address>\fR\fR] [\fI\-r \fI<wmiirc>\fR\fR]
.P .P
wmii \-v wmii \-v
.SH DESCRIPTION .SH DESCRIPTION
.SS Overview .SS Overview
.P .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 adapts to the current environment and fits to the needs of the
user, rather than forcing him to use a preset, fixed layout and user, rather than forcing him to use a preset, fixed layout and
trying to shoehorn all windows and applications into it. trying to shoehorn all windows and applications into it.
.P .P
\fBwmii\fR supports classic and tiled window management with \fBwmii\fR supports classic and tiled window management with
extended keyboard and mouse control. Classic window management 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 arbitrary windows and arranges them vertically in a
non\-overlapping manner. They can then be moved and resized, non\-overlapping manner. They can then be moved and resized,
among and within columns, at will. among and within columns, at will.
.P .P
\fBwmii\fR provides a virtual filesystem which represents the \fBwmii\fR provides a virtual filesystem which represents the
internal state similar to the procfs of Unix operating systems. 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 accessed through 9P\-capable client programs, like
wmiir(1). This allows simple and powerful remote control wmiir(1). This allows simple and powerful remote control
of the core window manager. of the core window manager.
.SS Command Line Arguments .SS Command Line Arguments
.TP .TP
\-a \fI<address>\fR \-a \fI<address>\fR
Specifies the address on which \fBwmii\fR should listen for Specifies the address on which \fBwmii\fR should listen for
connections. The address takes the form connections. The address takes the form
\fB\fI<protocol>\fR!\fI<address>\fR\fR. The default is of the form: \fB\fI<protocol>\fR!\fI<address>\fR\fR. The default is of the form:
.nf .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 .fi
which opens a unix socket per Plan 9 Port conventions. To which opens a unix socket per Plan 9 Port conventions. To
open a TCP socket, listening at port 4332 on the loopback open a TCP socket, listening at port 4332 on the loopback
interface, use: interface, use:
.nf .nf
tcp!localhost!4332 tcp!localhost!4332
.fi .fi
\fB$WMII_NAMESPACE\fR is automatically set to this value. \fB$WMII_NAMESPACE\fR is automatically set to this value.
.TP .TP
@ -70,6 +70,7 @@ environment variables \fB$WMII_ADDRESS\fR and \fB$WMII_CONFPATH\fR are
preset for the script. preset for the script.
.SS Terminology .SS Terminology
.TP .TP
Display Display
A running X server instance consisting of input 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 mouse button press, a key press, or a message written by
a different 9P\-client. a different 9P\-client.
.SS Basic window management .SS Basic window management
.P .P
Running a raw \fBwmii\fR process without a wmiirc(1) script provides 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 or to switch views. Other interactions, such as customizing the
style, killing or retagging clients, and grabbing keys, cannot style, killing or retagging clients, and grabbing keys, cannot
be achieved without accessing the filesystem. be achieved without accessing the filesystem.
.P .P
The filesystem can be accessed by connecting to the \fIaddress\fR The filesystem can be accessed by connecting to the \fIaddress\fR
of \fBwmii\fR with any 9P\-capable client, such as wmiir(1) of \fBwmii\fR with any 9P\-capable client, such as wmiir(1)
.SS Actions .SS Actions
.P .P
The default configuration provides for a special menu of The default configuration provides for a special menu of
actions. These consist of either shell scripts in \fB$WMII_CONFPATH\fR actions. These consist of either shell scripts in \fB$WMII_CONFPATH\fR
or action definitions included in wmiirc. or action definitions included in wmiirc.
.P .P
Here is a list of the default actions: 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 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 bindings. They should also provide a \fBshowkeys\fR action to open a
key binding quick\-reference. key binding quick\-reference.
.SS Moving Around .SS Moving Around
.TS .TS
tab(^); ll. tab(^); ll.
\fBKey\fR^\fBAction\fR \fBKey\fR^\fBAction\fR
@ -180,10 +177,11 @@ tab(^); ll.
Mod\-t \fI<tag>\fR^Move to the view of the given \fI<tag>\fR Mod\-t \fI<tag>\fR^Move to the view of the given \fI<tag>\fR
Mod\-n^Move to the next view Mod\-n^Move to the next view
Mod\-b^Move to the previous 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 .TE
.SS Moving Things Around .SS Moving Things Around
.TS .TS
tab(^); ll. tab(^); ll.
\fBKey\fR^\fBAction\fR \fBKey\fR^\fBAction\fR
@ -193,10 +191,11 @@ tab(^); ll.
Mod\-Shift\-k^Move the current window above the window above it. 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\-space^Toggle the current window between the managed and floating layer
Mod\-Shift\-t \fI<tag>\fR^Move the current window to the view of the given \fI<tag>\fR Mod\-Shift\-t \fI<tag>\fR^Move the current window to the view of the given \fI<tag>\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 .TE
.SS Miscellaneous .SS Miscellaneous
.TS .TS
tab(^); ll. tab(^); ll.
\fBKey\fR^\fBAction\fR \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 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, all the work of setting up the window manager, the key bindings,
the bar labels, etc. the bar labels, etc.
.SS Filesystem .SS Filesystem
.P .P
Most aspects of \fBwmii\fR are controlled via the filesystem. It is Most aspects of \fBwmii\fR are controlled via the filesystem. It is
usually accessed via the wmiir(1) command, but it can be 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 accessed by any 9P, including plan9port's 9P[\fI1\fR], and can be
mounted natively on Linux via v9fs\fI[1]\fR, and on Inferno (which man mounted natively on Linux via v9fs[\fI1\fR], and on Inferno (which man
run on top of Linux). All data in the filesystem, including run on top of Linux). All data in the filesystem, including
filenames, is UTF\-8 encoded. However, when accessed via filenames, is UTF\-8 encoded. However, when accessed via
wmiir(1), text is automatically translated to and from your wmiir(1), text is automatically translated to and from your
locale encoding. locale encoding.
.P .P
The filesystem is, as are many other 9P filesystems, entirely The filesystem is, as are many other 9P filesystems, entirely
synthetic. The files exist only in memory, and are not written 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 them has side\-effects (such as changing key bindings). A
description of the filesystem layout and control commands description of the filesystem layout and control commands
follows. follows.
.SS Hierarchy .SS Hierarchy
.TP .TP
/ /
Global control files Global control files
@ -253,24 +250,28 @@ View control files
/lbar/, /rbar/ /lbar/, /rbar/
Files representing the contents of the bottom bar Files representing the contents of the bottom bar
.SS The / Hierarchy .SS The / Hierarchy
.TP .TP
colrules colrules
The \fIcolrules\fR file contains a list of The \fIcolrules\fR file contains a list of
rules which affect the width of newly created columns. rules which affect the width of newly created columns.
Rules have the form: Rules have the form:
.nf .nf
/\fI<regex>\fR/ -> \fI<width>\fR\fI[+\fI<width>\fR]\fR* /\fI<regex>\fR/ -> \fI<width>\fR[\fI+\fI<width>\fR\fR]*
.fi .fi
Where, Where,
.nf .nf
\fI<width>\fR := \fI<percent of screen>\fR | \fI<pixels>\fRpx \fI<width>\fR := \fI<percent of screen>\fR | \fI<pixels>\fRpx
.fi .fi
When a new column, \fI<n>\fR, is created on a view whose name When a new column, \fI<n>\fR, is created on a view whose name
matches \fI<regex>\fR, it is given the \fI<n>\fRth supplied \fI<width>\fR. matches \fI<regex>\fR, it is given the \fI<n>\fRth supplied \fI<width>\fR.
If there is no \fI<n>\fRth width, it is given 1/\fI<ncol>\fRth of the If there is no \fI<n>\fRth width, it is given 1/\fI<ncol>\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 to automatically set properties of new clients. Rules are
specified as: specified as:
.nf .nf
/\fI<regex>\fR/ \fI<key>\fR=\fI<value>\fR ... /\fI<regex>\fR/ \fI<key>\fR=\fI<value>\fR ...
.fi .fi
where each \fI<key>\fR represents a command in the clients \fIctl\fR where each \fI<key>\fR represents a command in the clients \fIctl\fR
file, and each \fI<value>\fR represents the value to assign to it. file, and each \fI<value>\fR represents the value to assign to it.
The rules are applied when the client is first started and 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: as they occur. Included among them are:
.RS 8 .RS 8
.TP .TP
\fI[Not]\fRUrgent \fI<client>\fR \fI[Manager|Client]\fR [\fINot\fR]Urgent \fI<client>\fR [\fIManager|Client\fR]
\fI<client>\fR's urgent hint has been set or \fI<client>\fR's urgent hint has been set or
unset. The second arg is \fI[Client]\fR if it's unset. The second arg is [\fIClient\fR] if it's
been set by the client, and \fI[Manager]\fR if been set by the client, and [\fIManager\fR] if
it's been set by \fBwmii\fR via a control it's been set by \fBwmii\fR via a control
message. message.
.TP .TP
\fI[Not]\fRUrgentTag \fI<tag>\fR \fI[Manager|Client]\fR [\fINot\fR]UrgentTag \fI<tag>\fR [\fIManager|Client\fR]
A client on \fI<tag>\fR has had its urgent hint A client on \fI<tag>\fR has had its urgent hint
set, or the last urgent client has had its set, or the last urgent client has had its
urgent hint unset. urgent hint unset.
@ -339,13 +342,13 @@ Client\fI<Click|MouseDown>\fR \fI<client>\fR \fI<button>\fR
A client's titlebar has either been clicked or A client's titlebar has either been clicked or
has a button pressed over it. has a button pressed over it.
.TP .TP
\fI[Left|Right]\fRBar\fI[Click|MouseDown]\fR \fI<button>\fR \fI<bar>\fR [\fILeft|Right\fR]Bar[\fIClick|MouseDown\fR] \fI<button>\fR \fI<bar>\fR
A left or right bar has been clicked or has a A left or right bar has been clicked or has a
button pressed over it. button pressed over it.
.RS -8 .RS -8
For a more comprehensive list of available events, see For a more comprehensive list of available events, see
\fIwmii.pdf\fR\fI[2]\fR \fIwmii.pdf\fR[\fI2\fR]
.TP .TP
ctl ctl
@ -365,7 +368,6 @@ spawn \fI<prog>\fR
Spawn a new program, as if by the \fI\-r\fR flag. Spawn a new program, as if by the \fI\-r\fR flag.
.RS -8 .RS -8
.SS The /client/ Hierarchy .SS The /client/ Hierarchy
.P .P
Each directory under '/client/' represents an X11 client. Each directory under '/client/' represents an X11 client.
@ -453,7 +455,6 @@ string written begins with \fB+\fR, \fB^\fR, or \fB\-\fR, the
written tags are added to or removed from the client's written tags are added to or removed from the client's
set, otherwise the set is overwritten. set, otherwise the set is overwritten.
.SS The /tag/ Hierarchy .SS The /tag/ Hierarchy
.P .P
Each directory under '/tag/' represents a view, containing Each directory under '/tag/' represents a view, containing
@ -469,9 +470,9 @@ following commands:
.TP .TP
select select
Select a client: Select a client:
select \fI[left|right|up|down]\fR select [\fIleft|right|up|down\fR]
.P .P
select \fI[\fI<row number>\fR|sel]\fR \fI[\fI<frame number>\fR]\fR select [\fI\fI<row number>\fR|sel\fR] [\fI\fI<frame number>\fR\fR]
.P .P
select client \fI<client>\fR select client \fI<client>\fR
.TP .TP
@ -479,12 +480,12 @@ send
Send a client somewhere: Send a client somewhere:
.RS 8 .RS 8
.TP .TP
send \fI[\fI<client>\fR|sel]\fR \fI[up|down|left|right]\fR send [\fI\fI<client>\fR|sel\fR] [\fIup|down|left|right\fR]
.TP .TP
send \fI[\fI<client>\fR|sel]\fR \fI<area>\fR send [\fI\fI<client>\fR|sel\fR] \fI<area>\fR
Send \fI<client>\fR to the \fIn\fRth \fI<area>\fR Send \fI<client>\fR to the \fIn\fRth \fI<area>\fR
.TP .TP
send \fI[\fI<client>\fR|sel]\fR toggle send [\fI\fI<client>\fR|sel\fR] toggle
Toggle \fI<client>\fR between the floating and managed layer. Toggle \fI<client>\fR between the floating and managed layer.
.RS -8 .RS -8
.TP .TP
@ -495,18 +496,22 @@ Swap a client with another. Same syntax as send.
grow grow
Grow or shrink a client. Grow or shrink a client.
.nf .nf
grow \fI<frame>\fR \fI<direction>\fR \fI[\fI<amount>\fR]\fR grow \fI<frame>\fR \fI<direction>\fR [\fI\fI<amount>\fR\fR]
.fi .fi
.TP .TP
nudge nudge
Nudge a client in a given direction. Nudge a client in a given direction.
.nf .nf
grow \fI<frame>\fR \fI<direction>\fR \fI[\fI<amount>\fR]\fR grow \fI<frame>\fR \fI<direction>\fR [\fI\fI<amount>\fR\fR]
.fi .fi
.RS -8 .RS -8
Where the arguments are defined as follows: Where the arguments are defined as follows:
.RS 8 .RS 8
@ -514,35 +519,43 @@ Where the arguments are defined as follows:
area area
Selects a column or the floating area. Selects a column or the floating area.
.nf .nf
area ::= \fI<area_spec>\fR | \fI<screen_spec>\fR:\fI<area_spec>\fR area ::= \fI<area_spec>\fR | \fI<screen_spec>\fR:\fI<area_spec>\fR
.fi .fi
When \fI<screen_spec>\fR is omitted and \fI<area_spec>\fR is not "sel", When \fI<screen_spec>\fR is omitted and \fI<area_spec>\fR is not "sel",
0 is assumed. "sel" by itself represents the selected client no 0 is assumed. "sel" by itself represents the selected client no
matter which screen it is on. matter which screen it is on.
.nf .nf
area_spec ::= "~" | \fI<number>\fR | "sel" area_spec ::= "~" | \fI<number>\fR | "sel"
.fi .fi
Where "~" represents the floating area and \fI<number>\fR represents a column Where "~" represents the floating area and \fI<number>\fR represents a column
index, starting at one. index, starting at one.
.nf .nf
screen_spec ::= \fI<number>\fR screen_spec ::= \fI<number>\fR
.fi .fi
Where \fI<number>\fR representes the 0\-based Xinerama screen number. Where \fI<number>\fR representes the 0\-based Xinerama screen number.
.TP .TP
frame frame
Selects a client window. Selects a client window.
.nf .nf
frame ::= \fI<area>\fR \fI<index>\fR | \fI<area>\fR sel | client \fI<window-id>\fR frame ::= \fI<area>\fR \fI<index>\fR | \fI<area>\fR sel | client \fI<window-id>\fR
.fi .fi
Where \fI<index>\fR represents the nth frame of \fI<area>\fR or \fI<window\-id>\fR is Where \fI<index>\fR represents the nth frame of \fI<area>\fR or \fI<window\-id>\fR is
the X11 window id of the given client. the X11 window id of the given client.
@ -550,10 +563,12 @@ the X11 window id of the given client.
amount amount
The amount to grow or nudge something. The amount to grow or nudge something.
.nf .nf
amount ::= \fI<number>\fR | \fI<number>\fRpx amount ::= \fI<number>\fR | \fI<number>\fRpx
.fi .fi
If "px" is given, \fI<number>\fR is interperated as an exact pixel count. If "px" is given, \fI<number>\fR is interperated as an exact pixel count.
Otherwise, it's interperated as a "reasonable" amount, which is Otherwise, it's interperated as a "reasonable" amount, which is
usually either the height of a window's title bar, or its sizing usually either the height of a window's title bar, or its sizing
@ -563,7 +578,6 @@ increment (as defined by X11) in a given direction.
index index
Read for a description of the contents of a tag. Read for a description of the contents of a tag.
.SS The /rbar/, /lbar/ Hierarchy .SS The /rbar/, /lbar/ Hierarchy
.P .P
The files under '/rbar/' and '/lbar/' represent the The files under '/rbar/' and '/lbar/' represent the
@ -572,13 +586,12 @@ items of the bar at the bottom of the screen. Files under
under '/rbar/' appear on the right, with the leftmost item under '/rbar/' appear on the right, with the leftmost item
occupying all extra available space. The items are sorted occupying all extra available space. The items are sorted
lexicographically. lexicographically.
.P .P
The files may be read or written to obtain or alter the colors The files may be read or written to obtain or alter the colors
and text of the bars. The format is similar to the various \fIctl\fR and text of the bars. The format is similar to the various \fIctl\fR
files and should be self explanitory. files and should be self explanitory.
.SH FILES .SH FILES
.TP .TP
/tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR/wmii /tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR/wmii
The wmii socket file which provides a 9P service. The wmii socket file which provides a 9P service.
@ -589,8 +602,8 @@ Global action directory.
@LOCALCONF@ @LOCALCONF@
User\-specific action directory. Actions are first searched here. User\-specific action directory. Actions are first searched here.
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
\fB$HOME\fR, \fB$DISPLAY\fR \fB$HOME\fR, \fB$DISPLAY\fR
See the section \fBFILES\fR above. See the section \fBFILES\fR above.
@ -616,13 +629,10 @@ wimenu(1), wmii9menu(1), witray(1), wmiir(1), wihack(1)
.P .P
@DOCDIR@/wmii.pdf @DOCDIR@/wmii.pdf
@DOCDIR@/FAQ @DOCDIR@/FAQ
.P .P
\fI[1]\fR http://www.suckless.org/wiki/wmii/tips/9p_tips [\fI1\fR] http://www.suckless.org/wiki/wmii/tips/9p_tips
.P .P
\fI[2]\fR @DOCDIR@/wmii.pdf [\fI2\fR] @DOCDIR@/wmii.pdf
.\" man code generated by txt2tags 3.3 (http://txt2tags.org)
.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
.\" cmdline: txt2tags -o- wmii.man1 .\" cmdline: txt2tags -o- wmii.man1

16
man/wmii9menu.1
View File

@ -3,12 +3,10 @@
.SH NAME .SH NAME
.P .P
wmii9menu \- The wmii menu program wmii9menu \- The wmii menu program
.SH SYNOPSIS .SH SYNOPSIS
.P .P
wmii9menu \fI[\-a \fI<address>\fR]\fR \fI[\-i \fI<initial>\fR]\fR \fI<item>\fR\fI[:\fI<command>\fR]\fR... wmii9menu [\fI\-a \fI<address>\fR\fR] [\fI\-i \fI<initial>\fR\fR] \fI<item>\fR[\fI:\fI<command>\fR\fR]...
wmii9menu \-v wmii9menu \-v
.SH DESCRIPTION .SH DESCRIPTION
.P .P
\fBwmii9menu\fR is \fBwmii\fR's standard clickable menu program. It's used \fBwmii9menu\fR is \fBwmii\fR's standard clickable menu program. It's used
@ -16,8 +14,8 @@ extensively by \fBwmii\fR and related programs to display clickable
menus, namely for window titlebars and bar items. The name, along menus, namely for window titlebars and bar items. The name, along
with the code, derives from the 9menu program, which in turn derives with the code, derives from the 9menu program, which in turn derives
its name from Plan 9's style of clickable menus. its name from Plan 9's style of clickable menus.
.SH ARGUMENTS .SH ARGUMENTS
.TP .TP
\-a \-a
The address at which to connect to \fBwmii\fR. The address at which to connect to \fBwmii\fR.
@ -31,7 +29,6 @@ so that the mouse pointer is centered on said item.
.RE .RE
.P .P
: :
.SH USAGE .SH USAGE
.P .P
\fBwmii9menu\fR is invoked with a list of arguments, each of which is \fBwmii9menu\fR is invoked with a list of arguments, each of which is
@ -43,8 +40,8 @@ selection. Otherwise, a mouse press will do the same. When a
selection is made, \fBwmii9menu\fR prints the result. If the selected selection is made, \fBwmii9menu\fR prints the result. If the selected
item initially contained a \fI:\fR, the text following it is printed. item initially contained a \fI:\fR, the text following it is printed.
Otherwise, the item text itself is printed. Otherwise, the item text itself is printed.
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
\fB$WMII_ADDRESS\fR \fB$WMII_ADDRESS\fR
The address at which to connect to wmii. The address at which to connect to wmii.
@ -56,11 +53,8 @@ provided.
.SH SEE ALSO .SH SEE ALSO
.P .P
wmii(1), wmiir(1), wimenu(1) wmii(1), wmiir(1), wimenu(1)
.P .P
\fI[1]\fR http://www.suckless.org/wiki/wmii/tips/9p_tips [\fI1\fR] http://www.suckless.org/wiki/wmii/tips/9p_tips
.\" man code generated by txt2tags 3.3 (http://txt2tags.org)
.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
.\" cmdline: txt2tags -o- wmii9menu.man1 .\" cmdline: txt2tags -o- wmii9menu.man1

37
man/wmiir.1
View File

@ -3,22 +3,19 @@
.SH NAME .SH NAME
.P .P
wmiir \- The wmii 9P filesystem client wmiir \- The wmii 9P filesystem client
.SH SYNOPSIS .SH SYNOPSIS
.P .P
wmiir \fI[\-a \fI<address>\fR]\fR \fI[\-b]\fR {create | ls \fI[\-dlp]\fR | read | remove | write} \fI<file>\fR wmiir [\fI\-a \fI<address>\fR\fR] [\fI\-b\fR] {create | ls [\fI\-dlp\fR] | read | remove | write} \fI<file>\fR
.P .P
wmiir \fI[\-a \fI<address>\fR]\fR \fI[\-b]\fR xwrite \fI<file>\fR \fI<data>\fR ... wmiir [\fI\-a \fI<address>\fR\fR] [\fI\-b\fR] xwrite \fI<file>\fR \fI<data>\fR ...
.P .P
wmiir \-v wmiir \-v
.SH DESCRIPTION .SH DESCRIPTION
.P .P
\fBwmiir\fR is a simple 9P filesystem client which ships with \fBwmii\fR, and connects \fBwmiir\fR is a simple 9P filesystem client which ships with \fBwmii\fR, and connects
to its virtual filesystem by default. \fBwmiir\fR is most often used to query and to its virtual filesystem by default. \fBwmiir\fR is most often used to query and
issue commands to \fBwmii\fR, both from the command line and from its \fBsh\fR\-based issue commands to \fBwmii\fR, both from the command line and from its \fBsh\fR\-based
configuration scripts. configuration scripts.
.P .P
Since the default encoding of 9P filesystems is UTF\-8, \fBwmiir\fR Since the default encoding of 9P filesystems is UTF\-8, \fBwmiir\fR
assumes that all data read and written is text data and assumes that all data read and written is text data and
@ -26,8 +23,8 @@ translates to or from your locale character encoding as
necessary. When working with non\-text data in a non\-UTF\-8 necessary. When working with non\-text data in a non\-UTF\-8
locale, the \fI\-b\fR flag should be specified to disable this locale, the \fI\-b\fR flag should be specified to disable this
behavior. behavior.
.SH ARGUMENTS .SH ARGUMENTS
.TP .TP
\-a \-a
The address at which to connect to \fBwmii\fR. The address at which to connect to \fBwmii\fR.
@ -40,7 +37,6 @@ write is treated as binary data.
.RE .RE
.P .P
: :
.SH COMMANDS .SH COMMANDS
.P .P
The following commands deal with 9P filesystems. The following commands deal with 9P filesystems.
@ -51,7 +47,7 @@ Creates a new file or directory in the filesystem. Permissions and
file type are inferred by \fBwmii\fR. The contents of the standard input file type are inferred by \fBwmii\fR. The contents of the standard input
are written to the new file. are written to the new file.
.TP .TP
ls \fI[\-dlp]\fR \fI<path>\fR ls [\fI\-dlp\fR] \fI<path>\fR
Lists the contents of \fI<path>\fR. Lists the contents of \fI<path>\fR.
Flags: Flags:
@ -85,7 +81,6 @@ Writes the contents of the standard input to \fI<file>\fR.
xwrite \fI<file>\fR \fI<data>\fR ... xwrite \fI<file>\fR \fI<data>\fR ...
Writes each argument after \fI<file>\fR to the latter. Writes each argument after \fI<file>\fR to the latter.
.P .P
Additionally, wmiir provides the following utility commands relevant Additionally, wmiir provides the following utility commands relevant
to scripting wmii: to scripting wmii:
@ -99,17 +94,17 @@ equivalent to /tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR, but possibly
different depending on the value of \fB$NAMESPACE\fR and different depending on the value of \fB$NAMESPACE\fR and
\fB$WMII_NAMESPACE\fR. \fB$WMII_NAMESPACE\fR.
.RE .RE
.RS .RS
Synonyms: \fBns\fR Synonyms: \fBns\fR
.RE .RE
.TP .TP
setsid \fI[\-0 \fI<argv0>\fR]\fR \fI[\-f]\fR \fI<command>\fR setsid [\fI\-0 \fI<argv0>\fR\fR] [\fI\-f\fR] \fI<command>\fR
.RS .RS
Executes the given command after setting the session id (see Executes the given command after setting the session id (see
setsid(2)). If \fI\-0\fR is given, the command is run with the setsid(2)). If \fI\-0\fR is given, the command is run with the
given value as argv\fI[0]\fR. For instance, to run sh as a login given value as argv[\fI0\fR]. For instance, to run sh as a login
shell, one might run shell, one might run
.RE .RE
@ -117,18 +112,20 @@ shell, one might run
wmiir setsid -0 -sh sh wmiir setsid -0 -sh sh
.fi .fi
.RS .RS
If \fI\-f\fR is given, wmiir will fork into the background before If \fI\-f\fR is given, wmiir will fork into the background before
executing the command. executing the command.
.RE .RE
.TP .TP
proglist \fI[\-\-]\fR \fI<directory>\fR ... proglist [\fI\-\-\fR] \fI<directory>\fR ...
.RS .RS
Lists all executable commands in the given directories. Lists all executable commands in the given directories.
.RE .RE
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
\fB$WMII_ADDRESS\fR \fB$WMII_ADDRESS\fR
The address at which to connect to wmii. The address at which to connect to wmii.
@ -137,17 +134,13 @@ The address at which to connect to wmii.
The namespace directory to use if no address is The namespace directory to use if no address is
provided. provided.
.SH SEE ALSO .SH SEE ALSO
.P .P
wmii(1), libixp\fI[2]\fR wmii(1), libixp[\fI2\fR]
.P .P
\fI[1]\fR http://www.suckless.org/wiki/wmii/tips/9p_tips [\fI1\fR] http://www.suckless.org/wiki/wmii/tips/9p_tips
.P .P
\fI[2]\fR http://libs.suckless.org/libixp [\fI2\fR] http://libs.suckless.org/libixp
.\" man code generated by txt2tags 3.3 (http://txt2tags.org)
.\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
.\" cmdline: txt2tags -o- wmiir.man1 .\" cmdline: txt2tags -o- wmiir.man1