Return to vmh.me CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / mh / doc

Annotation of 43BSD/contrib/mh/doc/vmh.me, revision 1.1

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

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.