commit 1d176ce7b5f8d94ac05aaa4c447759bbace0a652
parent 4af4c3825fad7381288400ef15944ebe85bb71bf
Author: Kris Maglione <jg@suckless.org>
Date: Mon, 28 Sep 2009 13:11:11 -0400
Update wmii.1
Diffstat:
4 files changed, 82 insertions(+), 13 deletions(-)
diff --git a/man/Makefile b/man/Makefile
@@ -9,7 +9,7 @@ TARG = wmii.1 \
wmiir.1:
true
-$(TARG): Makefile $(ROOT)/mk/wmii.mk
+$(TARG): Makefile $(ROOT)/mk/wmii.mk header.t2t
FILTER = sed "s|CONFPREFIX|$(ETC)|g; \
s|CONFVERSION|$(CONFVERSION)|g; \
diff --git a/man/header.t2t b/man/header.t2t
@@ -5,16 +5,18 @@
% have to be post-processed. The _italic_ hack is necessary for
% italicising things like /_foo_/, which txt2tags will ignore.
% The others need to work in ``` lines.
-%!postproc(man): (<.*?>) \\fI\1\\fR
-%!postproc(man): _(.*?)_ \\fI\1\\fR
-%!postproc(man): `(.*?)` \\fB\1\\fR
-%!postproc(man): (\[.*?\]) \\fI\1\\fR
-%!postproc(man): \+$ \n.P
+%!postproc(man): (<.*?>) \\fI\1\\fR
+%!postproc(man): \b_(.*?)_ \\fI\1\\fR
+%!postproc(man): `(.*?)` \\fB\1\\fR
+%!postproc(man): (\[.*?\]) \\fI\1\\fR
+%!postproc(man): \+$ \n.P
+%!postproc(man): (\$[a-zA-Z_]+) \\fB\1\\fR
+%!postproc(man): (\${[a-zA-Z_]+)(.*?)} \\fB\1\\fR\2\\fB}\\fR
-%!postproc(html): (<.*?>) (:arg \1:)
-%!postproc(html): _(.*?)_ (:emph \1:)
-%!postproc(html): `(.*?)` (:code \1:)
-%!postproc(html): \+$ <br/>
+%!postproc(html): (<.*?>) (:arg \1:)
+%!postproc(html): \b_(.*?)_ (:emph \1:)
+%!postproc(html): `(.*?)` (:code \1:)
+%!postproc(html): \+$ <br/>
%!postproc(html) \(:(\w+)\s*(.*):\) <span class="\1">\2</span>
diff --git a/man/wmii.1 b/man/wmii.1
@@ -45,6 +45,49 @@ of the core window manager.
the bar, which are described in detail in the
\fBTerminology\fR section.
+.SS Command Line Arguments
+.TP
+\-a \fI<address>\fR
+
+.RS
+Specifies the address on which \fBwmii\fR should listen for
+connections. The address takes the form
+\fB\fI<protocol>\fR!\fI<address>\fR\fR. The default is of the form:
+.RE
+
+.RS
+.RS
+unix!/tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR/wmii
+.RE
+.RE
+
+.RS
+which opens a unix socket per Plan 9 Port conventions. To
+open a TCP socket, listening at port 4332 on the loopback
+interface, use:
+.RE
+
+.RS
+.RS
+tcp!localhost!4332
+.RE
+.RE
+
+.RS
+\fB$WMII_NAMESPACE\fR is automatically set to this value.
+.RE
+
+.TP
+\-r \fI<wmiirc>\fR
+
+.RS
+Specifies which rc script to run. If \fI<wmiirc>\fR consists of a
+single argument, \fB$WMII_CONFPATH\fR is searched before \fB$PATH\fR.
+Otherwise, it is passed to the shell for evaluation. The
+environment variables \fB$WMII_ADDRESS\fR and \fB$WMII_CONFPATH\fR are
+preset for the script.
+.RE
+
.SS Terminology
.TP
Display
@@ -131,7 +174,7 @@ An action is a shell script in the default setup, but it can
actually be any executable file. It is executed usually by
selecting it from the actions menu. You can customize an action
by copying it from the global action directory
-\&'/home/kris/wmiiinst/etc/wmii\-3.5' to '$HOME/.wmii\-3.5' and then
+\&'/home/kris/wmiiinst/etc/wmii\-3.5' to '\fB$HOME\fR/.wmii\-3.5' and then
editing the copy to fit your needs. Of course you can also
create your own actions there; make sure that they are
executable.
@@ -479,13 +522,13 @@ them.
.SH FILES
.TP
-/tmp/ns.$USER.${DISPLAY%.0}/wmii
+/tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR/wmii
The wmii socket file which provides a 9P service.
.TP
/home/kris/wmiiinst/etc/wmii\-3.5
Global action directory.
.TP
-$HOME/.wmii\-3.5
+\fB$HOME\fR/.wmii\-3.5
User\-specific action directory. Actions are first searched here.
diff --git a/man/wmii.man1 b/man/wmii.man1
@@ -46,6 +46,30 @@ of the core window manager.
the bar, which are described in detail in the
**Terminology** section.
+== Command Line Arguments ==
+
+: -a <address>
+ Specifies the address on which `wmii` should listen for
+ connections. The address takes the form
+ `<protocol>!<address>`. The default is of the form:
+
+ unix!/tmp/ns.$USER.${DISPLAY%.0}/wmii
+
+ which opens a unix socket per Plan 9 Port conventions. To
+ open a TCP socket, listening at port 4332 on the loopback
+ interface, use:
+
+ tcp!localhost!4332
+
+ $WMII_NAMESPACE is automatically set to this value.
+
+: -r <wmiirc>
+ Specifies which rc script to run. If <wmiirc> consists of a
+ single argument, $WMII_CONFPATH is searched before $PATH.
+ Otherwise, it is passed to the shell for evaluation. The
+ environment variables $WMII_ADDRESS and $WMII_CONFPATH are
+ preset for the script.
+
== Terminology ==
: Display
