Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / RCS / vmh.rf,v
1 head    1.6;
2 access;
3 symbols;
4 locks; strict;
5
6
7 1.6
8 date    92.05.12.22.23.34;      author jromine; state Exp;
9 branches;
10 next    1.5;
11
12 1.5
13 date    90.04.05.15.15.32;      author sources; state Exp;
14 branches;
15 next    1.4;
16
17 1.4
18 date    90.03.22.11.31.54;      author sources; state Exp;
19 branches;
20 next    1.3;
21
22 1.3
23 date    90.03.20.19.42.37;      author sources; state Exp;
24 branches;
25 next    1.2;
26
27 1.2
28 date    90.03.20.17.36.52;      author sources; state Exp;
29 branches;
30 next    1.1;
31
32 1.1
33 date    90.03.20.17.21.32;      author sources; state Exp;
34 branches;
35 next    ;
36
37
38 desc
39 @@
40
41
42 1.6
43 log
44 @fixup for nroff problems
45 @
46 text
47 @.\"    @@(MHWARNING)
48 .\" @@(#)$Id: vmh.rf,v 1.5 1990/04/05 15:15:32 sources Exp jromine $
49 .SC VMH 1
50 .NA
51 vmh \- visual front-end to MH
52 .SY
53 vmh
54 \%[\-prompt\ string]
55 \%[\-vmhproc\ program] \%[\-novmhproc]
56 \%[switches\ for\ \fIvmhproc\fR]
57 \%[\-help]
58 .DE
59 \fIvmh\fR is a program which implements the server side of
60 the \fIMH\fR window management protocol
61 and uses \fIcurses\fR\0(3) routines to maintain a split\-screen interface to
62 any program which implements the client side of the protocol.
63 This latter program, called the \fIvmhproc\fR,
64 is specified using the `\-vmhproc\ program' switch.
65
66 The upshot of all this is that one can run \fImsh\fR on a display terminal
67 and get a nice visual interface.
68 To do this, for example, just add the line
69
70 .ti +.5i
71 mshproc: vmh
72
73 to your \&.mh\(ruprofile.
74 (This takes advantage of the fact that
75 \fImsh\fR is the default \fIvmhproc\fR for \fIvmh\fR.)
76
77 In order to facilitate things,
78 if the `\-novmhproc' switch is given,
79 and \fIvmh\fR can't run on the user's terminal,
80 the \fIvmhproc\fR is run directly without the window management protocol.
81
82 After initializing the protocol,
83 \fIvmh\fR prompts the user for a command to be given to the client.
84 Usually, this results in output being sent to one or more windows.
85 If a output to a window would cause it to scroll,
86 \fIvmh\fR prompts the user for instructions,
87 roughly permitting the capabilities of \fIless\fR or \fImore\fR
88 (e.g., the ability to scroll backwards and forwards):
89
90 .nf
91 .in +.5i
92 .ta \w'RETURN  'u +\w'*  'u
93 SPACE           advance to the next windowful
94 RETURN  *       advance to the next line
95 y       *       retreat to the previous line
96 d       *       advance to the next ten lines
97 u       *       retreat to the previous ten lines
98 g       *       go to an arbitrary line
99                 (preceed g with the line number)
100 G       *       go to the end of the window
101                 (if a line number is given, this acts like `g')
102 CTRL\-L         refresh the entire screen
103 h               print a help message
104 q               abort the window
105 .re
106 .in -.5i
107 .fi
108
109 (A `*' indicates that a numeric prefix is meaningful for this command.)
110
111 Note that if a command resulted in more than one window's worth of
112 information being displayed,
113 and you allow the command which is generating information for the window to
114 gracefully finish
115 (i.e., you don't use the `q' command to abort information being sent to the
116 window),
117 then \fIvmh\fR will give you one last change to peruse the window.
118 This is useful for scrolling back and forth.
119 Just type `q' when you're done.
120
121 To abnormally terminate \fIvmh\fR (without core dump),
122 use <QUIT> (usually CTRL\-\\).
123 For instance,
124 this does the \*(lqright\*(rq thing with \fIbbc\fR and \fImsh\fR.
125 .Fi
126 ^$HOME/\&.mh\(ruprofile~^The user profile
127 .Pr
128 ^Path:~^To determine the user's MH directory
129 .Sa
130 msh(1)
131 .De
132 `\-prompt\ (vmh)\ '
133 .Ds
134 `\-vmhproc\ msh'
135 .Co
136 None
137 .Bu
138 The argument to the `\-prompt' switch must be interpreted as a single token
139 by the shell that invokes \fIvmh\fR.
140 Therefore,
141 one must usually place the argument to this switch inside double\-quotes.
142
143 At present,
144 there is no way to pass signals (e.g., interrupt, quit) to the client.
145 However,
146 generating QUIT when \fIvmh\fR is reading a command from the terminal is
147 sufficient to tell the client to go away quickly.
148
149 Acts strangely (loses peer or botches window management protocol with peer)
150 on random occasions.
151 .En
152 @
153
154
155 1.5
156 log
157 @add ID
158 @
159 text
160 @d2 1
161 a2 1
162 .\" @@(#)$Id:$
163 d5 1
164 a5 1
165 vmh \- visual front\-end to MH
166 @
167
168
169 1.4
170 log
171 @put things back, do .NA stuff another way
172 @
173 text
174 @d2 1
175 @
176
177
178 1.3
179 log
180 @typo
181 @
182 text
183 @d2 2
184 a3 2
185 .TH VMH 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
186 .SH .NA
187 d5 1
188 a5 1
189 .SH .SY
190 @
191
192
193 1.2
194 log
195 @fixup for makewhatis
196 @
197 text
198 @d2 1
199 a2 1
200 .TH VMH 1 [mh.6] MH
201 @
202
203
204 1.1
205 log
206 @Initial revision
207 @
208 text
209 @d2 2
210 a3 2
211 .SC VMH 1
212 .NA
213 d5 1
214 a5 1
215 .SY
216 @