Mercurial > hg > Applications > mh

comparison doc/vmh.me @ 0:bce86c4163a3

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