git.marmaro.de Git - mmh/blob - man/vmh.man

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