tman pages changes - plan9port - [fork] Plan 9 from user space
(HTM) git clone git://src.adamsgaard.dk/plan9port
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 94b5e3ff1dd81855814b66a88a2f8a9b984e90dd
(DIR) parent 1a0954abb80f92cd9940a21f11dd8f3a84518579
(HTM) Author: rsc <devnull@localhost>
Date: Tue, 4 Jan 2005 21:20:04 +0000
man pages changes
Diffstat:
M man/man1/INDEX | 5 +++++
A man/man1/acmeevent.1 | 329 +++++++++++++++++++++++++++++++
A man/man1/clog.1 | 18 ++++++++++++++++++
A man/man1/dial.1 | 30 ++++++++++++++++++++++++++++++
M man/man1/dict.1 | 53 ++++++++++++++++++++++++++++---
M man/man1/map.1 | 2 +-
M man/man1/stats.1 | 2 +-
M man/man1/tr2post.1 | 4 +++-
8 files changed, 436 insertions(+), 7 deletions(-)
---
(DIR) diff --git a/man/man1/INDEX b/man/man1/INDEX
t@@ -19,6 +19,7 @@ bundle bundle.1
cal cal.1
calendar calendar.1
cat cat.1
+nobs cat.1
read cat.1
cleanname cleanname.1
cmp cmp.1
t@@ -106,6 +107,8 @@ pr pr.1
proof proof.1
ps ps.1
psu ps.1
+psdownload psfonts.1
+psfonts psfonts.1
pbd pwd.1
pwd pwd.1
. rc.1
t@@ -141,6 +144,7 @@ spell spell.1
sprog spell.1
split split.1
src src.1
+auxstats stats.1
stats stats.1
strings strings.1
md5sum sum.1
t@@ -154,6 +158,7 @@ test test.1
time time.1
touch touch.1
tr tr.1
+tr2post tr2post.1
nroff troff.1
troff troff.1
tweak tweak.1
(DIR) diff --git a/man/man1/acmeevent.1 b/man/man1/acmeevent.1
t@@ -0,0 +1,329 @@
+.TH ACMEEVENT 1
+.SH NAME
+acmeevent, acme.rc \- shell script support for acme clients
+.SH SYNOPSIS
+.B 9p
+.B read
+.B acme/acme/$winid/event | acmeevent
+.PP
+.B
+\&. /usr/local/plan9/lib/acme.rc
+.PP
+.B newwindow
+.PP
+.B winread
+.I file
+.PP
+.B winwrite
+.I file
+.PP
+.B winctl
+.I cmd
+.PP
+.B windump
+[
+.I dumpdir
+|
+.B -
+]
+[
+.I dumpcmd
+|
+.B -
+]
+.PP
+.B winname
+.I name
+.PP
+.B windel
+[
+.B sure
+]
+.PP
+.B winwriteevent
+.I c1
+.I c2
+.I q0
+.I q1
+[
+.I eq0
+.I eq1
+.I flag
+.I textlen
+.I text
+.I chordarg
+.I chordaddr
+]
+.PP
+.B wineventloop
+.SH DESCRIPTION
+.I Acmeevent
+and
+.I acme.rc
+make it easy to write simple
+.IR acme (1)
+client programs as shell scripts.
+.PP
+.I Acme
+clients read the
+.B event
+files
+(see
+.IR acme (4))
+for the windows they control, reacting to the events.
+The events are presented in a format that is easy to read with C programs
+but hard to read with shell scripts.
+.PP
+.I Acmeevent
+reads an
+.IR acme (4)
+event stream from standard input, printing a shell-friendly
+version of the events, one per line, on standard output.
+Each output line from
+.I acmeevent
+has the form:
+.IP
+.B event
+.I c1
+.I c2
+.I q0
+.I q1
+.I eq0
+.I eq1
+.I flag
+.I textlen
+.I text
+.I chordarg
+.I chordaddr
+.PP
+The fields are:
+.TP
+.I c1
+A character indicating the origin or cause of the action.
+The possible causes are:
+a write to the body or tag file
+.RB ( E ),
+a write to the window's other files
+.RB ( F ),
+input via the keyboard
+.RB ( K ),
+and
+input via the mouse
+.RB ( M ).
+.TP
+.I c2
+A character indicating the type of action.
+The possible types are:
+text deleted from the body
+.RB ( D ),
+text deleted from the tag
+.RB ( d ),
+text inserted in the body
+.RB ( I ),
+text inserted in the tag
+.RB ( i ),
+a button 3 action in the body
+.RB ( L ),
+a button 3 action in the tag
+.RB ( l ),
+a button 2 action in the body
+.RB ( X ),
+and
+a button 2 action in the tag
+.RB ( x ).
+.TP
+.I q0
+
+.TP
+.I q1
+
+.TP
+.I eq0
+
+.TP
+.I eq1
+
+.TP
+.I flag
+
+.TP
+.I textlen
+
+.TP
+.I text
+
+.TP
+.I chordarg
+
+.TP
+.I chordorigin
+
+.PP
+.I Acme.rc
+is a library of
+.IR rc (1)
+shell functions useful for writing acme clients.
+.PP
+.I Newwindow
+creates a new acme window and sets
+.B $winid
+to the new window's id.
+The other commands all use
+.B $winid
+to determine which window to operate on.
+.PP
+.I Winread
+prints the current window's
+.I file
+to standard output.
+It is equivalent to
+.B cat
+.BI /mnt/acme/acme/$winid/ file
+on Plan 9.
+Similarly,
+.I winwrite
+writes standard input to the current window's
+.IR file .
+.I Winread
+and
+.I winwrite
+are useful mainly in building more complex functions.
+.PP
+.I Winctl
+writes
+.I cmd
+to the window's
+.B ctl
+file.
+The most commonly-used command is
+.BR clean ,
+which marks the window as clean.
+See
+.IR acme (4)
+for a full list of commands.
+.PP
+.I Windump
+sets the window's dump directory
+and dump command
+(see
+.IR acme (4)).
+If either argument is omitted or is
+.BR - ,
+that argument is not set.
+.PP
+.I Winname
+sets the name displayed in the window's tag.
+.PP
+.I Windel
+simulates the
+.B Del
+command. If the argument
+.B sure
+is given, it simulates the
+.B Delete
+command.
+.PP
+.I Winwriteevent
+writes an event to the window's event file.
+The event is in the format produced by
+.IR acmeevent .
+Only the first four arguments are necessary:
+the rest are ignored.
+Event handlers should call
+.I winwriteevent
+to pass unhandled button 2 or button 3 events
+back to
+.I acme
+for processing.
+.PP
+.I Wineventloop
+executes the current window's event file, as output by
+.IR acmeevent .
+It returns when the window has been deleted.
+Before running
+.I wineventloop ,
+clients must define a shell function named
+.BR event ,
+which will be run for each incoming event,
+as
+.I rc
+executes the output of
+.IR acmeevent .
+A typical event function need only worry about button 2 and button 3 events.
+Those events not handled should be sent back to
+.I acme
+with
+.IR winwriteevent .
+.SH EXAMPLE
+.IR Adict ,
+a dictionary browser,
+is implemented using
+.I acmeevent
+and
+.IR acme.rc .
+The
+.I event
+handler is:
+.IP
+.EX
+.ta +4n +4n +4n +4n +4n +4n
+fn event {
+ switch($1$2){
+ case Mx MX # button 2 - pass back to acme
+ winwriteevent $*
+ case Ml ML # button 3 - open new window on dictionary or entry
+ {
+ if(~ $dict NONE)
+ dictwin /adict/$7/ $7
+ if not
+ dictwin /adict/$dict/$7 $dict $7
+ } &
+ }
+}
+.EE
+.LP
+Note that the button 3 handler starts a subshell in which to run
+.IR dictwin .
+That subshell will create a new window, set its name,
+possibly fill the window with a dictionary list or dictionary entry,
+mark the window as clean, and run the event loop:
+.IP
+.EX
+fn dictwin {
+ newwindow
+ winname $1
+ dict=$2
+ if(~ $dict NONE)
+ dict -d '?' >[2=1] | sed 1d | winwrite body
+ if(~ $#* 3)
+ dict -d $dict $3 >[2=1] | winwrite body
+ winctl clean
+ wineventloop
+}
+.EE
+.LP
+The script starts with an initial window:
+.IP
+.EX
+dictwin /adict/ NONE
+.EE
+.LP
+Button 3 clicking on a dictionary name in the initial window
+will create a new empty window for that dictionary.
+Typing and button 3 clicking on a word in that window
+will create a new window with the dictionary's entry for that word.
+.PP
+See
+.B /usr/local/plan9/bin/adict
+for the full implementation.
+.SH SOURCE
+.B /usr/local/plan9/src/cmd/acmeevent.c
+.br
+.B /usr/local/plan9/lib/acme.rc
+.SH SEE ALSO
+.IR acme (1),
+.IR acme (4),
+.IR rc (1)
+.SH BUGS
+There is more that could be done to ease the writing
+of complicated clients.
(DIR) diff --git a/man/man1/clog.1 b/man/man1/clog.1
t@@ -0,0 +1,18 @@
+.TH CLOG 1
+.SH NAME
+auxclog \- create date-stamped console log
+.SH SYNOPSIS
+.B auxclog
+.I console
+.I logfile
+.SH DESCRIPTION
+.I Auxclog
+opens the file
+.I console
+and writes every line read from it, prefixed by the ASCII time, to the file
+.IR logfile .
+.SH SOURCE
+.B /usr/local/plan9/src/cmd/auxclog.c
+.SH BUGS
+Should be named
+.IR aux/clog .
(DIR) diff --git a/man/man1/dial.1 b/man/man1/dial.1
t@@ -0,0 +1,30 @@
+.TH DIAL 1
+.SH NAME
+dial \- connect to a remote service
+.SH SYNOPSIS
+.B dial
+[
+.B -e
+]
+.I addr
+.SH DESCRIPTION
+.I Dial
+connects to the network address
+.I addr
+(see
+.IR dial (3))
+and then copies data from the connection to standard output,
+and from standard input to the connection.
+.PP
+By default,
+.I dial
+exits when end of file is reached on standard input or on the network connection.
+The
+.B -e
+flag causes
+.I dial
+to exit only in response to end of file on the network connection.
+.SH SOURCE
+.B /usr/local/plan9/src/cmd/dial.c
+.SH SEE ALSO
+.IR dial (3)
(DIR) diff --git a/man/man1/dict.1 b/man/man1/dict.1
t@@ -1,6 +1,6 @@
.TH DICT 1
.SH NAME
-dict \- dictionary browser
+dict, adict \- dictionary browser
.SH SYNOPSIS
.B dict
[
t@@ -17,6 +17,14 @@ dict \- dictionary browser
[
.I pattern
]
+.B adict
+[
+.B -d
+.I dictname
+]
+[
+.I pattern
+]
.SH DESCRIPTION
.I Dict
is a dictionary browser.
t@@ -31,11 +39,10 @@ The options are
.TP
.BI -d " dictname"
Use the given dictionary.
-The default is
-.BR oed ,
-the second edition of the Oxford English Dictionary.
A list of available dictionaries is printed by option
.BR -d? .
+The default is the first dictionary on the list that is
+installed on the system.
.TP
.BI -c " command"
Execute one command and quit.
t@@ -138,6 +145,42 @@ After an
the default command is
.BR p .
Otherwise, the default command is the previous command.
+.PP
+.I Adict
+is a dictionary browser for
+.IR acme (1).
+When run with no arguments, it creates a new
+.I acme
+window named
+.B /adict/
+listing the installed dictionaries.
+Clicking with button 3 on a dictionary name will create
+a new empty window named
+.BI /adict/ dict /.
+Typing and then clicking on a pattern in this window will
+create a new lookup window named
+.BI /adict/ dict / pattern
+containing the dictionary's definition of
+.IR pattern .
+Clicking with button 3 on any word in this new window will
+create new lookup windows.
+.PP
+If
+.I adict
+is run with a
+.I pattern ,
+it starts with the
+.BI /adict/ dict / pattern
+window.
+.PP
+If
+.I adict
+is run with no pattern but with a
+.B -d
+option,
+it starts with the
+.BI /adict/ dict /
+window.
.SH FILES
.B /lib/dict/oed2
.br
t@@ -149,6 +192,8 @@ Other files in
.IR regexp (7)
.SH SOURCE
.B /usr/local/plan9/src/cmd/dict
+.br
+.B /usr/local/plan9/bin/adict
.SH BUGS
A font with wide coverage of the Unicode Standard
should be used for best results.
(DIR) diff --git a/man/man1/map.1 b/man/man1/map.1
t@@ -1,6 +1,6 @@
.TH MAP 1
.SH NAME
-map, mapdemo \- draw maps on various projections
+map, mapdemo, mapd \- draw maps on various projections
.SH SYNOPSIS
.B map
.I projection
(DIR) diff --git a/man/man1/stats.1 b/man/man1/stats.1
t@@ -1,6 +1,6 @@
.TH STATS 1
.SH NAME
-stats \- display graphs of system activity
+stats, auxstats \- display graphs of system activity
.SH SYNOPSIS
.B stats
[
(DIR) diff --git a/man/man1/tr2post.1 b/man/man1/tr2post.1
t@@ -48,7 +48,9 @@ comments.
It will print fine but will not view correctly in
.IR gv (1)
or
-.IR psv (1).
+.I psv
+(see
+.IR page (1)).
.TP
.BI -o " pagelist
Print only the pages in the