Return to README.opt2 CVS log

Up to [Research Unix] / researchv10dc / cmd / library

Annotation of researchv10dc/cmd/library/README.opt2, revision 1.1

1.1     ! root        1: # *************************************************************** 
        !             2: # *    Copyright (c) 1990 AT&T                                 *
        !             3: # *     All Rights Reserved                                    *
        !             4: # *    THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF AT&T     *
        !             5: # *    The copyright notice above does not                     *
        !             6: # *    evidence any actual or intended                         *
        !             7: # *    publication of such source code.                        *
        !             8: # ***************************************************************
        !             9: Option 2 is where generic requests that can be described by a template are
        !            10: handled. The template files have a name starting with "2." and are in
        !            11: library's directory.
        !            12:   The template file divides into 2 pieces.  The top control part, and the
        !            13: bottom template part.  The two parts are separated by a dashed line starting
        !            14: with at least 10 dashes. Lines anywhere starting with a # are comment lines.
        !            15: 
        !            16:   Top / control part of template:
        !            17: 
        !            18: If the first line starts with a capital w (W), then the rest of the line 
        !            19: is what this selection type is called on the welcome menu of library.
        !            20: If there is no W line, this type of request is named by the filename,
        !            21: which follows the "2.". For example, take the file 2.photo-cp.  If it
        !            22: did not start with a W line, it would say on the menu that "photo-cp"
        !            23: were available. 
        !            24:   Once the user selects option 2, they are displayed a new menu of what is 
        !            25: available. This is controlled by the template file's D lines. If there
        !            26: is no D line (anywhere in the top part) then the selection is numbered and
        !            27: is named by the file's name as above.  Note that this is unwise since the
        !            28: numbering of the selections have no meaning and can change as new templates
        !            29: arrive. The D line has the format
        !            30:        D <selection alpha-numeric> Description.
        !            31: If the single letter <selection alnum> is not there, then the selection is
        !            32: numbered as above.  If the description isn't there then the filename is used.
        !            33:    All the lines in the top of the template starting with a ? are displayed
        !            34: when the user does a ? about the selection.
        !            35:    All the lines starting with a H are displayed before the first instance
        !            36: of the selection is done.
        !            37:    The M line says where to send mail connected with this selection. Note that
        !            38: the default is mhuxd!techlib where most of library() requests go.  
        !            39: You may, however, specify other destinations for machine-specific products.
        !            40: However, if you add machine-specific products and want them handled through
        !            41: mhuxd!techlib, you must contact the AT&T Library Network first.
        !            42: See the README.info for the person to call.
        !            43: 
        !            44:    The S line says what to Send to mark the selection taken .
        !            45:    A control line saying "ONE" says only one request will be taken.
        !            46: 
        !            47: 
        !            48:   Bottom / actual template part of template:
        !            49: 
        !            50:     Lines here fall into several classes:
        !            51:   - lines ending with +number or *number.  These are the actual template lines.
        !            52:     The user is prompted with this lines preceded by the word "Enter ". If the
        !            53:     line ends with +number, a response is required and can be at most <number>
        !            54:     lines. If it ends with *number, the response is optional.
        !            55:   - lines starting with ?.  These are displayed when the user types a ? at
        !            56:     one of the prompts.  Generally it is a good idea to have these. Note that
        !            57:     it displays all the ? lines between the present prompt and the next
        !            58:     prompt line.
        !            59:   - Other lines are simply displayed as they are scanned over.

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