[hackers] [wmii] Update wmii.1 || Kris Maglione

changeset: 2486:8dff6c281eb4
user: Kris Maglione <jg_AT_suckless.org>
date: Mon Sep 28 13:11:11 2009 -0400
files: man/Makefile man/header.t2t man/wmii.1 man/wmii.man1
description:
Update wmii.1

diff -r 424202a307a9 -r 8dff6c281eb4 man/Makefile
--- a/man/Makefile Thu Sep 17 09:27:11 2009 -0400
+++ b/man/Makefile Mon Sep 28 13:11:11 2009 -0400
@@ -9,7 +9,7 @@
 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 -r 424202a307a9 -r 8dff6c281eb4 man/header.t2t
--- a/man/header.t2t Thu Sep 17 09:27:11 2009 -0400
+++ b/man/header.t2t Mon Sep 28 13:11:11 2009 -0400
@@ -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 -r 424202a307a9 -r 8dff6c281eb4 man/wmii.1
--- a/man/wmii.1 Thu Sep 17 09:27:11 2009 -0400
+++ b/man/wmii.1 Mon Sep 28 13:11:11 2009 -0400
@@ -45,6 +45,49 @@
 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 @@
 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 @@
 
 .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 -r 424202a307a9 -r 8dff6c281eb4 man/wmii.man1
--- a/man/wmii.man1 Thu Sep 17 09:27:11 2009 -0400
+++ b/man/wmii.man1 Mon Sep 28 13:11:11 2009 -0400
@@ -46,6 +46,30 @@
 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
Received on Mon Sep 28 2009 - 17:43:45 UTC