annotate doc/vmh.me @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" This file is automatically generated. Do not edit!
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC VMH 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 vmh \- visual front-end to MH
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 vmh
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[\-prompt\ string]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-vmhproc\ program] \%[\-novmhproc]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[switches\ for\ \fIvmhproc\fR]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \fIvmh\fR is a program which implements the server side of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 the \fIMH\fR window management protocol
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 and uses \fIcurses\fR\0(3) routines to maintain a split\-screen interface to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 any program which implements the client side of the protocol.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 This latter program, called the \fIvmhproc\fR,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 is specified using the `\-vmhproc\ program' switch.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 The upshot of all this is that one can run \fImsh\fR on a display terminal
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 and get a nice visual interface.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 To do this, for example, just add the line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 .ti +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 mshproc: vmh
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 to your \&.mh\(ruprofile.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 (This takes advantage of the fact that
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 \fImsh\fR is the default \fIvmhproc\fR for \fIvmh\fR.)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 In order to facilitate things,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 if the `\-novmhproc' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 and \fIvmh\fR can't run on the user's terminal,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 the \fIvmhproc\fR is run directly without the window management protocol.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 After initializing the protocol,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 \fIvmh\fR prompts the user for a command to be given to the client.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 Usually, this results in output being sent to one or more windows.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 If a output to a window would cause it to scroll,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 \fIvmh\fR prompts the user for instructions,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 roughly permitting the capabilities of \fIless\fR or \fImore\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 (e.g., the ability to scroll backwards and forwards):
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 .in +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 .ta \w'RETURN 'u +\w'* 'u
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 SPACE advance to the next windowful
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 RETURN * advance to the next line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 y * retreat to the previous line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 d * advance to the next ten lines
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 u * retreat to the previous ten lines
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 g * go to an arbitrary line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 (preceed g with the line number)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 G * go to the end of the window
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 (if a line number is given, this acts like `g')
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 CTRL\-L refresh the entire screen
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 h print a help message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 q abort the window
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 .re
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 .in -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 (A `*' indicates that a numeric prefix is meaningful for this command.)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 Note that if a command resulted in more than one window's worth of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 information being displayed,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 and you allow the command which is generating information for the window to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 gracefully finish
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 (i.e., you don't use the `q' command to abort information being sent to the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 window),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 then \fIvmh\fR will give you one last change to peruse the window.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 This is useful for scrolling back and forth.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 Just type `q' when you're done.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 To abnormally terminate \fIvmh\fR (without core dump),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 use <QUIT> (usually CTRL\-\\).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 For instance,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 this does the \*(lqright\*(rq thing with \fIbbc\fR and \fImsh\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 msh(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 `\-prompt\ (vmh)\ '
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 `\-vmhproc\ msh'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 The argument to the `\-prompt' switch must be interpreted as a single token
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 by the shell that invokes \fIvmh\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 Therefore,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 one must usually place the argument to this switch inside double\-quotes.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 At present,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 there is no way to pass signals (e.g., interrupt, quit) to the client.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 However,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 generating QUIT when \fIvmh\fR is reading a command from the terminal is
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 sufficient to tell the client to go away quickly.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 Acts strangely (loses peer or botches window management protocol with peer)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 on random occasions.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 .En