Return to show.me CVS log

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

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

1.1     ! root        1: .\"    This file is automatically generated.  Do not edit!
        !             2: .TH SHOW 1 "April 22, 1986" MH [mh.6]
        !             3: .UC 6
        !             4: .SH NAME
        !             5: show \- show (list) messages
        !             6: .SH SYNOPSIS
        !             7: .in +.5i
        !             8: .ti -.5i
        !             9: show
        !            10: \%[+folder] \%[msgs]
        !            11: \%[\-draft]
        !            12: \%[\-header] \%[\-noheader]
        !            13: \%[\-showproc\ program] \%[\-noshowproc]
        !            14: \%[switches\ for\ \fIshowproc\fR]
        !            15: \%[\-help]
        !            16: .in -.5i
        !            17: .SH DESCRIPTION
        !            18: \fIShow\fR lists each of the specified messages to the standard
        !            19: output (typically, the terminal).
        !            20: Typically, the messages are listed exactly
        !            21: as they are, with no reformatting.
        !            22: A program named by the \fIshowproc\fR profile component is
        !            23: invoked to do the listing, and any switches not recognized by
        !            24: \fIshow\fR are passed along to that program.
        !            25: The default program is known as \fImore\fR\0(1).
        !            26: To override the default and the \fIshowproc\fR profile component,
        !            27: use the `\-showproc\ program' switch.
        !            28: For example, `\-show\ pr' will cause the \fIpr\fR\0(1) program to list the
        !            29: messages.
        !            30: The \fIMH\fR command \fImhl\fR can be used as a \fIshowproc\fR
        !            31: to show messages in a more uniform format.
        !            32: Normally, this program is specified as the \fIshowproc\fR is the user's
        !            33: \&.mh\(ruprofile.
        !            34: See \fImhl\fR\0(1) for the details.
        !            35: If the `\-noshowproc' option is specified,
        !            36: `/bin/cat' is used instead of \fIshowproc\fR.
        !            37: 
        !            38: The `\-header' switch tells \fIshow\fR to display a one\-line
        !            39: description of the message being shown.
        !            40: This description includes the folder and the message number.
        !            41: 
        !            42: If no `msgs' are specified, the current message is used.
        !            43: If more than one message is specified,
        !            44: \fImore\fR will prompt for a <RETURN> prior to listing each message.
        !            45: \fImore\fR will list each message, a page at a time.
        !            46: When the end of
        !            47: page is reached, \fImore\fR will ring the bell and wait for a <SPACE>
        !            48: or <RETURN>.
        !            49: If a <RETURN> is entered, \fImore\fR will print the next line,
        !            50: whereas <SPACE> will print the next screenful.
        !            51: To exit \fImore\fR, type \*(lqq\*(rq.
        !            52: 
        !            53: If the standard output is not a terminal, no queries are made,
        !            54: and each file is listed with a one\-line header and two lines of
        !            55: separation.
        !            56: 
        !            57: \*(lqshow \-draft\*(rq will list the file <mh\-dir>/draft if it
        !            58: exists.
        !            59: 
        !            60: If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
        !            61: then \fIshow\fR will remove each of the messages shown from each
        !            62: sequence named by the profile entry.
        !            63: This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
        !            64: by all \fIMH\fR commands which take `msgs' or `msg' arguments.
        !            65: .Fi
        !            66: ^$HOME/\&.mh\(ruprofile~^The user profile
        !            67: .Pr
        !            68: ^Path:~^To determine the user's MH directory
        !            69: .Ps
        !            70: ^Current\-Folder:~^To find the default current folder
        !            71: .Ps
        !            72: ^Unseen\-Sequence:~^To name sequences denoting unseen messages
        !            73: .Ps
        !            74: ^showproc:~^Program to show messages
        !            75: .Sa
        !            76: mhl(1), more(1), next(1), pick(1), prev(1), scan(1)
        !            77: .De
        !            78: `+folder' defaults to the current folder
        !            79: .Ds
        !            80: `msgs' defaults to cur
        !            81: .Ds
        !            82: `\-format'
        !            83: .Ds
        !            84: `\-header'
        !            85: .Co
        !            86: If a folder is given, it will become the current folder.
        !            87: The last message shown will become the current message.
        !            88: .Bu
        !            89: The `\-header' switch doesn't work when `msgs' expands to more than
        !            90: one message.
        !            91: If the \fIshowproc\fR is \fImhl\fR,
        !            92: then is problem can be circumvented by referencing
        !            93: the \*(lqmessagename\*(rq field in the \fImhl\fR format file.
        !            94: 
        !            95: \fIShow\fR updates the user's context before showing the message.
        !            96: Hence if \fIshow\fR will mark messages as seen prior to the user
        !            97: actually seeing them.
        !            98: This is generally not a problem,
        !            99: unless the user relies on the \*(lqunseen\*(rq messages mechanism,
        !           100: and interrupts \fIshow\fR while it is showing \*(lqunseen\*(rq messages.
        !           101: 
        !           102: If \fIshowproc\fR is \fImhl\fR,
        !           103: then \fIshow\fR uses a built\-in \fImhl\fR:
        !           104: it does not actually run the \fImhl\fR program.
        !           105: Hence, if you define your own \fIshowproc\fR,
        !           106: don't call it \fImhl\fR since \fIshow\fR won't run it.
        !           107: 
        !           108: If \fImore\fR\0(1) is your showproc (the default),
        !           109: then avoid running \fIshow\fR in the background
        !           110: with only its standard output piped to another process, as in
        !           111: 
        !           112: .ti +.5i
        !           113: show | imprint &
        !           114: 
        !           115: Due to a bug in \fImore\fR,
        !           116: show will go into a \*(lqtty input\*(rq state.
        !           117: To avoid this problem,
        !           118: re\-direct \fIshow\fR's diagnostic output as well.
        !           119: For users of \fIcsh\fR:
        !           120: 
        !           121: .ti +.5i
        !           122: show |& imprint &
        !           123: 
        !           124: For users of \fIsh\fR:
        !           125: 
        !           126: .ti +.5i
        !           127: show 2>&1 | imprint &
        !           128: .En

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