Return to prompter.rf CVS log

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

Annotation of 43BSD/contrib/mh/conf/doc/prompter.rf, revision 1.1

1.1     ! root        1: .\"    @(MHWARNING)
        !             2: .TH PROMPTER 1 "April 22, 1986" MH [mh.6]
        !             3: .UC 6
        !             4: .SH NAME
        !             5: prompter \- prompting editor front\-end
        !             6: .SH SYNOPSIS
        !             7: .in +.5i
        !             8: .ti -.5i
        !             9: prompter
        !            10: \%[\-erase\ chr]
        !            11: \%[\-kill\ chr]
        !            12: \%[\-prepend] \%[\-noprepend]
        !            13: \%[\-rapid] \%[\-norapid]
        !            14: file
        !            15: \%[\-help]
        !            16: .in -.5i
        !            17: .SH DESCRIPTION
        !            18: This program is normally not invoked directly by users
        !            19: but takes the place of an editor and acts as an editor front\-end.
        !            20: It operates on an 822\-style message draft skeleton specified by file,
        !            21: normally provided by \fIcomp\fR, \fIdist\fR, \fIforw\fR, or \fIrepl\fR.
        !            22: 
        !            23: \fIPrompter\fR is an editor which allows rapid composition of
        !            24: messages.
        !            25: It is particularly useful to network and low\-speed
        !            26: (less than 2400 baud) users of \fIMH\fR.
        !            27: It is an \fIMH\fR program in that
        !            28: it can have its own profile entry with switches,
        !            29: but it is not invoked directly by the user.
        !            30: The commands \fIcomp\fR, \fIdist\fR, \fIforw\fR, and \fIrepl\fR
        !            31: invoke \fIprompter\fR as an editor,
        !            32: either when invoked with `\-editor\ prompter',
        !            33: or by the profile entry \*(lqEditor:\ prompter\*(rq,
        !            34: or when given the command `edit\ prompter' at \*(lqWhat now?\*(rq level.
        !            35: 
        !            36: For each empty component \fIprompter\fR finds in the draft,
        !            37: the user is prompted for a response;
        !            38: A <RETURN> will cause the whole component to be left out.
        !            39: Otherwise,
        !            40: a `\\' preceding a <RETURN> will continue the response on the next line,
        !            41: allowing for multiline components.
        !            42: Continuation lines \fBmust\fR begin with a space or tab.
        !            43: 
        !            44: Each non\-empty component is copied to the draft and displayed on the
        !            45: terminal.
        !            46: 
        !            47: The start of the message body is denoted by a blank line or a line of dashes.
        !            48: If the body is non\-empty, the prompt, which isn't written to the file, is
        !            49: 
        !            50:     \*(lq--------Enter additional text\*(rq,
        !            51: 
        !            52: or (if `\-prepend' was given)
        !            53: 
        !            54:     \*(lq--------Enter initial text\*(rq.
        !            55: 
        !            56: Message\-body typing is terminated with an end\-of\-file (usually CTRL\-D).
        !            57: At this point control is returned to the calling program,
        !            58: where the user is asked \*(lqWhat now?\*(rq.
        !            59: See \fIwhatnow\fR for the valid options to this query.
        !            60: 
        !            61: By using the `\-prepend' switch, the user can add type\-in to the beginning
        !            62: of the message body and have the rest of the body follow.
        !            63: This is useful for the \fIforw\fR command.
        !            64: 
        !            65: By using the `\-rapid' switch,
        !            66: if the draft already contains text in the message\-body,
        !            67: it is not displayed on the user's terminal.
        !            68: This is useful for low\-speed terminals.
        !            69: 
        !            70: The line editing characters for kill and erase may be
        !            71: specified by the user via the arguments `\-kill\ chr' and `\-erase\ chr',
        !            72: where chr may be a character; or `\\nnn', where \*(lqnnn\*(rq is the
        !            73: octal value for the character.
        !            74: 
        !            75: An interrupt (usually CTRL\-C) during component typing will abort
        !            76: \fIprompter\fR and the \fIMH\fR command that invoked it.
        !            77: An interrupt during message\-body typing is equivalent to CTRL\-D,
        !            78: for historical reasons.
        !            79: This means that \fIprompter\fR should finish up and exit.
        !            80: 
        !            81: The first non\-flag argument to \fIprompter\fR
        !            82: is taken as the name of the draft file, and
        !            83: subsequent non\-flag arguments are ignored.
        !            84: .\" (\fIRepl\fR invokes editors with two file arguments:
        !            85: .\" the draft file name and the replied\-to message file name.)
        !            86: .Fi
        !            87: ^$HOME/\&.mh\(ruprofile~^The user profile
        !            88: ^/tmp/prompter*~^Temporary copy of message
        !            89: .Pr
        !            90: prompter\-next:        To name the editor to be used on exit from \fIprompter\fR
        !            91: .Ps
        !            92: ^Msg\-Protect:~^To set mode when creating a new draft
        !            93: .Sa
        !            94: comp(1), dist(1), forw(1), repl(1), whatnow(1)
        !            95: .De
        !            96: `\-prepend'
        !            97: .Ds
        !            98: `\-norapid'
        !            99: .Co
        !           100: None
        !           101: .Bu
        !           102: \fIPrompter\fR uses \fIstdio\fR\0(3), so it will lose if you edit files
        !           103: with nulls in them.
        !           104: .En

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