home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BUSINESS / VNDNFO10.ZIP / VENDEDIT.DOC < prev    next >
Text File  |  1994-01-05  |  74KB  |  2,007 lines
  1.  
  2.     
  3.  
  4.  
  5.  
  6.  
  7.                   +----------------------------------------+
  8.                   |                                        |
  9.                   |                                        |
  10.                   |              User's Guide              |
  11.                   |                                        |
  12.                   |          VendEdit(TM) Editor           |
  13.                   |   for creating VENDINFO(TM) records    |
  14.                   |              Version 1.00              |
  15.                   |                                        |
  16.                   |                                        |
  17.                   |      Last updated: December 1993       |
  18.                   |                                        |
  19.                   |                                        |
  20.                   |  Copyright 1993 Rams' Island Software  |
  21.                   |          All rights reserved           |
  22.                   |                                        |
  23.                   +----------------------------------------+
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.    Rams' Island Software
  45.    7644 E. Lakecliff Way                   _______
  46.    Parker, CO 80134-5904 (USA)        ____|__     |                (R)
  47.                                    --|       |    |-------------------
  48.    Voice: (303) 841-2848             |   ____|__  |  Association of
  49.    BBS:   (303) 841-6269             |  |       |_|  Shareware
  50.    CompuServe: 76244,324             |__|   o   |    Professionals
  51.                                    -----|   |   |---------------------
  52.    FidoNet:  1:104/333                  |___|___|    MEMBER
  53.    RIME:     RAMSISLE
  54.    Internet: 76244.324@CompuServe.Com
  55.  
  56.  
  57.                                                                            
  58.  
  59.  
  60.  
  61.  
  62.    VendEdit User's Guide                                           VendEdit
  63.  
  64.  
  65.                               +-----------------+
  66.                               | Acknowledgments |
  67.                               +-----------------+
  68.  
  69.    Many people have helped to mold the VENDINFO vision, and to provide
  70.    support and encouragement throughout its development process. Thanks are
  71.    given to all those who have reviewed the Concept Paper or the VENDINFO
  72.    standard, or who have otherwise made suggestions regarding the project.
  73.  
  74.    The author is especially grateful to Fred Hill and Richard Holler, for
  75.    long-term support and help with VENDINFO.
  76.  
  77.    While many have reviewed parts of the VENDINFO documentation, special
  78.    thanks go to Jim Green, for helping us avoid a wrong direction; to Bob
  79.    Ostrander for a simple but particularly powerful idea; and to Daan van
  80.    Rooijen, for really studying the standard and providing many, many
  81.    useful suggestions.
  82.  
  83.    Many people have also helped in beta testing the VENDINFO tools, and
  84.    we're grateful to them all. Special thanks are given to Steve Estvanik
  85.    and Jerry Stern, for really giving things a workout, and tirelessly
  86.    reporting the results.
  87.  
  88.    The VENDINFO team is grateful to the following shareware trade associa-
  89.    tions for their endorsements of VENDINFO:
  90.  
  91.       Association of Shareware Professionals (ASP)
  92.       Association of Shareware Authors and Distributors (ASAD)
  93.       Shareware Trade Association and Resources (STAR)
  94.       Educational Software CoOperative (ESC)
  95.  
  96.    Finally, we particularly appreciate the 30-or-so software development
  97.    teams (mostly BBS-related) whose early commitment to support the VEN-
  98.    DINFO standard in their software products has helped provide momentum
  99.    and visibility to this effort.
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.    VENDINFO, VendEdit, VendPrcs, VendView, and VendLib are trademarks of
  112.    Rams' Island Software.
  113.  
  114.  
  115.  
  116.    VendEdit Editor v1.00             -ii-                          Dec 1993
  117.  
  118.  
  119.  
  120.  
  121.    VendEdit User's Guide                                  Table of Contents
  122.  
  123.  
  124.                              +-------------------+
  125.                              | Table of Contents |
  126.                              +-------------------+
  127.  
  128.  
  129.     The VENDINFO System ................................................  1
  130.        Components of the System ........................................  1
  131.        Structure of a VENDINFO File ....................................  2
  132.        A Little Background .............................................  3
  133.        Industry Support and Endorsements ...............................  4
  134.        Other VENDINFO Documents and Packages ...........................  5
  135.  
  136.     Installation .......................................................  6
  137.        Quick Start .....................................................  6
  138.        Detailed Contents of the VendEdit Package .......................  7
  139.        Special Tips for the Inexperienced Shareware Author .............  9
  140.        Warranty and License ............................................  9
  141.        Technical Support for VendEdit ..................................  9
  142.  
  143.     Overview of the VendEdit Process ................................... 11
  144.  
  145.     Making a VENDINFO Intermediate File ................................ 13
  146.        Prepare Text Materials .......................................... 13
  147.        Packaging Directory(s) .......................................... 14
  148.        Invoke VendEdit ................................................. 15
  149.        Edit a New File ................................................. 15
  150.        Edit Author/Publisher Information ............................... 16
  151.        Edit Product Information ........................................ 16
  152.        Edit Order Information .......................................... 17
  153.        Edit Distributor Information .................................... 17
  154.        Edit Support Information ........................................ 18
  155.        Edit Price/Benefit Information .................................. 18
  156.        Edit General (Channel-Independent) Distribution Policy .......... 18
  157.        Edit Channel-Specific Distribution Policy ....................... 19
  158.        Edit Front Text ................................................. 19
  159.  
  160.     Verifying the Intermediate File .................................... 20
  161.  
  162.     Exporting VENDINFO.DIZ and Other Files ............................. 21
  163.  
  164.     Checking the Results ............................................... 22
  165.  
  166.     The VENDINFO Product Registry ...................................... 23
  167.  
  168.     A Bit of Philosophy ................................................ 25
  169.        Philosophy Regarding Distribution Restrictions .................. 25
  170.        Algorithm Used for Distribution Permission Tests ................ 26
  171.        Legal Matters ................................................... 27
  172.  
  173.  
  174.  
  175.    VendEdit Editor v1.00             -iii-                         Dec 1993
  176.  
  177.  
  178.  
  179.  
  180.    VendEdit User's Guide                                  Table of Contents
  181.  
  182.  
  183.     Security ........................................................... 29
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.    VendEdit Editor v1.00             -iv-                          Dec 1993
  235.  
  236.  
  237.  
  238.  
  239.    VendEdit User's Guide                           Introduction to VENDINFO
  240.  
  241.  
  242.     
  243.                             +---------------------+
  244.                             | The VENDINFO System |
  245.                             +---------------------+
  246.  
  247.       VENDINFO is a system for conveying software product information and
  248.       distribution permissions from the author to distributors. A standard
  249.       (public) file format allows a VENDINFO.DIZ file to carry extensive
  250.       information in a compressed, efficient form. The associated toolset
  251.       aids the author in constructing the record, and allows the dis-
  252.       tributor to extract portions of the record, or to make distribution
  253.       decisions based on its content, in a highly automated way.
  254.  
  255.       VENDINFO provides unprecedented capabilities for
  256.  
  257.            o  Communication of product information and distribution
  258.               policies from author to distributor.
  259.  
  260.            o  Automation of many aspects of package handling by shareware
  261.               distributors of all types.
  262.  
  263.  
  264.  
  265.    Components of the System
  266.    ------------------------
  267.  
  268.       The VENDINFO "record" is the key. This is an efficiently compressed
  269.       file (VENDINFO.DIZ) containing a great deal of information about the
  270.       product, the author, and the product's distribution policies.
  271.  
  272.       The VendEdit editor allows the author to construct a complete
  273.       VENDINFO record in just a few minutes, assuming that the necessary
  274.       descriptive texts have already been prepared.
  275.  
  276.       The VendPrcs (pronounced "vend process") processor is a batch program
  277.       allowing automated decisions based on VENDINFO content, and automated
  278.       extraction of VENDINFO information.
  279.  
  280.       VendView is a simple viewer allowing the end-user to see relevant
  281.       portions of the VENDINFO data. This program should be available by
  282.       February 1994. Even without VendView, an ordinary text viewer will
  283.       display a good deal of useful information.
  284.  
  285.       The Product Registry is a collection of VENDINFO records available
  286.       for searches and queries by subscription, BBS login, or mail-order
  287.       query. This service will begin in January 1994.
  288.  
  289.       The VendLib Library allows software developers to build VENDINFO
  290.       access directly into such products as BBS programs and upload proces-
  291.  
  292.  
  293.    VendEdit Editor v1.00              -1-                          Dec 1993
  294.  
  295.  
  296.  
  297.  
  298.    VendEdit User's Guide                           Introduction to VENDINFO
  299.  
  300.  
  301.       sors. This library is already in the hands of some 30 vendors of
  302.       BBSes, BBS utility software, and other relevant software.
  303.  
  304.       The file-format standard describing the VENDINFO file is public, and
  305.       draft versions have been published since July 1993. The final version
  306.       1.00 has been released, and is the basis for the current toolset.
  307.  
  308.       VendPrcs Plus, a non-shareware version of VendPrcs, is planned for
  309.       release by Spring 1994. It will have a full-screen interface, using
  310.       scripts for easier, more efficient information extraction, and
  311.       templates for easier description of decision situations. It will also
  312.       allow management of a library of VENDINFO files, and will provide
  313.       automated access to the Product Registry BBS.
  314.  
  315.       Additional services for authors, users, and distributors are under
  316.       consideration.
  317.  
  318.  
  319.    Structure of a VENDINFO File
  320.    ----------------------------
  321.  
  322.       The VENDINFO.DIZ file contains two sections. A human-readable front
  323.       section contains information about how to use the VENDINFO file, and
  324.       presents most of the basic information about the product in readable
  325.       form.
  326.  
  327.       The second section is a binary data record, compressed with a PKZIP
  328.       1.10 algorithm, and appended to the file after the first section.
  329.       This record has some 750 fields of information about such things as
  330.  
  331.            o  Product name, date, and version
  332.  
  333.            o  Preferred package filename, other parts of product, replaced
  334.               versions
  335.  
  336.            o  Product descriptions of varying length, categories, keywords
  337.  
  338.            o  Required platform (CPU, operating system, memory, disk,
  339.               features)
  340.  
  341.            o  Contact information for author, for registering, for tech
  342.               support
  343.  
  344.            o  Registration prices and benefits, acceptable forms of payment
  345.  
  346.            o  Warranty and trial-use license
  347.  
  348.            o  Detailed distribution policy, in general and by distribution
  349.               channel
  350.  
  351.  
  352.    VendEdit Editor v1.00              -2-                          Dec 1993
  353.  
  354.  
  355.  
  356.  
  357.    VendEdit User's Guide                           Introduction to VENDINFO
  358.  
  359.  
  360.            o  Information about regional distributors and registration
  361.               services.
  362.  
  363.  
  364.  
  365.    A Little Background
  366.    -------------------
  367.  
  368.       The author of the VENDINFO standard and tools, Rudy Ramsey, has been
  369.       agitating since early 1992 for the development of an improved
  370.       mechanism for conveying product information and permissions from
  371.       authors to distributors. Initially, the intent was to make this a
  372.       purely volunteer-based effort, probably conducted within the auspices
  373.       of the Association of Shareware Professionals. However, others were
  374.       slow to respond to the idea (with the exception of Richard Holler and
  375.       Fred Hill), and it gradually became clear that it would have to be
  376.       done as an "extracurricular" effort, if at all.
  377.  
  378.       In the Spring of 1993, Rudy began the VENDINFO effort in earnest, by
  379.       preparing the CONCEPT.DOC concept paper and distributing it to a few
  380.       key shareware industry figures for comment. (At this time, he still
  381.       imagined VENDINFO as an all-volunteer effort.) The reviewers were
  382.       uniformly excited about the idea, and greatly encouraging. Most felt
  383.       that it was an idea whose time had come, and that the technical
  384.       approach described in the concept paper was very appropriate.
  385.  
  386.       Their second response, however, was that the effort contained the
  387.       seeds of its own failure. It might provide all the necessary incen-
  388.       tives for participation by authors, distributors, and users. But if
  389.       it didn't also provide an incentive for continued development and
  390.       support by its own development team, it would fail. It was simply too
  391.       big an activity for successful execution by volunteers.
  392.  
  393.       As a result of that input, a decision was made to regard VENDINFO as
  394.       partly a business opportunity. Although this makes a few people
  395.       suspicious, most agree it's in the best interest of the VENDINFO
  396.       effort itself, and of the industry. In fact, VENDINFO has developed
  397.       rapidly, partly because it has been a full-time focus of its author
  398.       for many months. That wouldn't have been possible in an all-volunteer
  399.       effort.
  400.  
  401.       The VENDINFO file-format standard is public. A substantial period was
  402.       provided for public comment on the concept paper, and then on the
  403.       standard, and public input is always welcome. Some of the tools that
  404.       make use of the standard are free (a viewer for end users, and the
  405.       processor when used by single-line, noncommercial BBSes). Most are
  406.       low-cost shareware. There will also be much-enhanced, non-shareware
  407.       programs later, for special purposes, but none of them are necessary
  408.       to achieve the benefits of the VENDINFO system.
  409.  
  410.  
  411.    VendEdit Editor v1.00              -3-                          Dec 1993
  412.  
  413.  
  414.  
  415.  
  416.    VendEdit User's Guide                           Introduction to VENDINFO
  417.  
  418.  
  419.    Industry Support and Endorsements
  420.    ---------------------------------
  421.  
  422.       Support for the VENDINFO concept has been extraordinarily high
  423.       throughout the industry. Authors, disk vendors, CD-ROM publishers,
  424.       Sysops, and BBS software manufacturers have all expressed their
  425.       support, and many have pledged to build VENDINFO capability into
  426.       their own software products.
  427.  
  428.       The following shareware trade groups have formally endorsed the
  429.       VENDINFO file-format standard as a means of conveying product and
  430.       product-distribution information from authors to users and dis-
  431.       tributors.
  432.  
  433.          Association of Shareware Professionals (ASP)
  434.          Shareware Trade Association and Resources (STAR)
  435.          Association of Shareware Authors and Developers (ASAD)
  436.          Educational Software CoOperative (ESC)
  437.  
  438.       The ASP has licensed the VENDINFO toolset for use by all 1700 of its
  439.       members. This will greatly accelerate the use -- and the usefulness
  440.       -- of VENDINFO.
  441.  
  442.       The following software manufacturers have "committed in principle" to
  443.       support VENDINFO in their own software offerrings by mid-1994. In the
  444.       context of these products, "support" for VENDINFO means extracting
  445.       relevant descriptive information automatically from VENDINFO files.
  446.       It does not necessarily mean making decisions based on the product's
  447.       distribution policy. VendPrcs will provide that capability.
  448.  
  449.          BBSes
  450.  
  451.             PCBoard, Clark Development Co.
  452.             Wildcat!, Mustang Software, Inc.
  453.             Major BBS, Galacticomm
  454.             RBBS, RBBS Development Team
  455.             Searchlight BBS, Searchlight Software
  456.             TBBS, eSoft
  457.             Auntie BBS, Wes Meier
  458.             Executive Host BBS, Steve Wood
  459.             MainLine BBS, Scott Green, City Limits Software
  460.             OmegaComm BBS, Larry Loiselle
  461.             PowerBBS for Windows, Russell Frey
  462.             ProBoard BBS, Philippe Leybaert
  463.             Sapphire BBS, Pinnacle Software
  464.             Tinyhost, Bruce Krobusek
  465.             UltraBBS, UltraBBS Software
  466.             Windowed Modem Environment, Jason Fesler
  467.  
  468.  
  469.  
  470.    VendEdit Editor v1.00              -4-                          Dec 1993
  471.  
  472.  
  473.  
  474.  
  475.    VendEdit User's Guide                           Introduction to VENDINFO
  476.  
  477.  
  478.          File Upload Processors
  479.  
  480.             CatScan, Mike Ortiz
  481.             CheckZip, Bill Hull
  482.             DIZIT, Robert Neal/CorpSoft
  483.             HoboScan, Floyd Hobson
  484.             TransScan, Craig Dunstan
  485.  
  486.          File Distribution Processors
  487.  
  488.             WCFF, Online Computer Resources
  489.  
  490.          Other Products
  491.  
  492.            *BBSee Disk Cataloger, Martin Vallevand
  493.            *Catalog-on-a-Disk, EmmaSoft Software Company, Inc.
  494.             Colorado Utilities Disk Manager, Micro Systems Solutions
  495.             SmartCat Disk Cataloger, Oakley Data Services
  496.  
  497.       * Test versions are known to exist which support VENDINFO
  498.  
  499.  
  500.    Other VENDINFO Documents and Packages
  501.    -------------------------------------
  502.  
  503.       The VENDINFO idea is documented in a concept paper and in the VEN-
  504.       DINFO file-format standard. These two documents are available in the
  505.       VENDINFO package, usually named VNDINFxx.ZIP. It can be obtained from
  506.       the Rams' Island BBS on first login or by FidoNet or RIME file re-
  507.       quest (magic name VENDINFO). It is also available in the CompuServe
  508.       SHAREWARE and UKSHARE forums; the ASP Hub Network BBSes, many local
  509.       BBSes, from some disk vendors, and on the ASP CD-ROM.
  510.  
  511.       If necessary, the concept paper and evaluation versions of the basic
  512.       toolset can be obtained on diskette from Rams' Island Software for
  513.       US$ 8.00 plus $2.00 shipping and handling in North America, $4.00
  514.       elsewhere (starting January 1994). Payment is accepted by
  515.       Visa/MasterCard, check in U.S. dollars drawn on a U.S. bank, cash in
  516.       any hard currency (registered mail suggested), and various other
  517.       forms.
  518.  
  519.       An article about the VENDINFO system will appear in the
  520.       November/December 1993 issue of Shareware Magazine.
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.    VendEdit Editor v1.00              -5-                          Dec 1993
  530.  
  531.  
  532.  
  533.  
  534.    VendEdit User's Guide                                       Installation
  535.  
  536.  
  537.        
  538.                                +--------------+
  539.                                | Installation |
  540.                                +--------------+
  541.  
  542.       To install the VENDINFO Basic Toolset, simply unzip or copy all files
  543.       into a single directory, which will be devoted to VendEdit. If you
  544.       are an author, or you expect to create VENDINFO records for testing
  545.       purposes, you should plan to leave all these files in that directory.
  546.       If you are a distributor, and plan to use only VendPrcs, then it will
  547.       eventually be appropriate for you to place VENDPRCS.EXE on your path,
  548.       and many of these materials will not be needed after your
  549.       familiarization with the toolset is complete.
  550.  
  551.       Once you've installed this package:
  552.  
  553.          o  If you're an author, or wish to try out VendEdit, simply
  554.             execute the command "VENDEDIT" WHILE IN THE VendEdit DIRECTORY.
  555.             Select "Help", and read through the first few items in the
  556.             help index.  You should find all the information you need.
  557.  
  558.          o  If you're a distributor, or wish to try out VendPrcs, you
  559.             should begin by reading VENDPRCS.DOC.  For authors, the
  560.             basic VendPrcs functions are executed automatically from
  561.             VendEdit.
  562.  
  563.  
  564.    Quick Start
  565.    -----------
  566.  
  567.       If you want to try using VendEdit with the absolute minimum of in-
  568.       struction it is suggested that you read the following chapters of
  569.       this User Guide
  570.  
  571.          Introduction to VENDINFO (earlier in this user guide)
  572.  
  573.          Overall Process of Using VendEdit (later in this user guide)
  574.  
  575.       Alternatively, you can read the corresponding sections of the
  576.       VendEdit help text. Just go to the VendEdit directory, invoke
  577.       VENDEDIT.EXE, and press Alt-H for the help system index. You can then
  578.       place the cursor on the section you want to read, and press ENTER.
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.    VendEdit Editor v1.00              -6-                          Dec 1993
  589.  
  590.  
  591.  
  592.  
  593.    VendEdit User's Guide                                       Installation
  594.  
  595.  
  596.       Once you've read this introductory material, simply invoke VENDEDIT
  597.       and follow this simple instruction:
  598.  
  599.            ───────────────────────────────────────────────────┐
  600.           │  Work your way left-to-right, and top-to-bottom,  │
  601.           │       through the VendEdit menu structure.        │
  602.           └───────────────────────────────────────────────────┘
  603.  
  604.       You should be prepared to make extensive use of the context-sensitive
  605.       help that's available throughout VendEdit. Even the menu items that
  606.       only lead to other menu items have useful help text. Just press F1.
  607.  
  608.  
  609.    Detailed Contents of the VendEdit Package
  610.    -----------------------------------------
  611.  
  612.       The VENDINFO toolset package includes the following files that are
  613.       specifically relevant to the VendEdit editor:
  614.  
  615.          VENDEDIT.DOC   This document.
  616.  
  617.          REGISTER.FRM   Registration form for VendEdit, and several other
  618.                         products and services associated with the VENDINFO
  619.                         system.
  620.  
  621.          VENDEDIT.EXE   The executable program for VendEdit.
  622.  
  623.          VENDEDIT.HLP   Help file used by VendEdit.
  624.  
  625.          STATUS.DAT     A text file used by VendEdit for status messages.
  626.  
  627.          VERIFY.DAT     A text file used by VendEdit for testing the infor-
  628.                         mation you provide in your VENDINFO file.
  629.  
  630.          VENDPACK.EXE   A small compression program used by VendEdit.
  631.  
  632.          CATEGORY.INF   Product category data file used by VendEdit and
  633.                         VendPrcs.
  634.  
  635.          EXTRACT.BAT    A batch file used for extracting all fields from a
  636.                         VENDINFO.DIZ record. This batch file is invoked
  637.                         automatically by VendEdit's <T>est <C>ontents
  638.                         command, but may also be used separately.
  639.  
  640.          EXTRDIST.BAT   A batch file used for extracting distribution
  641.                         policy information for a single channel from a
  642.                         VENDINFO.DIZ file. This batch file is called from
  643.                         EXTRACT.BAT.
  644.  
  645.  
  646.  
  647.    VendEdit Editor v1.00              -7-                          Dec 1993
  648.  
  649.  
  650.  
  651.  
  652.    VendEdit User's Guide                                       Installation
  653.  
  654.  
  655.          EXTRREGL.BAT   A batch file used for extracting information about
  656.                         distributors of your registered version. This batch
  657.                         file is called from EXTRACT.BAT.
  658.  
  659.          TESTDIST.BAT   A batch file used to perform a variety of distribu-
  660.                         tion policy tests on a VENDINFO.DIZ file. This
  661.                         batch file is invoked automatically by VendEdit's
  662.                         <T>est <P>olicy command, but may also be used
  663.                         separately.
  664.  
  665.       It also includes these files, which are relevant to the VendPrcs
  666.       processor, which distributors will use to access information from
  667.       your VENDINFO.DIZ files:
  668.  
  669.          VENDPRCS.EXE   The VendPrcs program itself.
  670.  
  671.          VENDPRCS.DOC   The VendPrcs User Guide.
  672.  
  673.          VPRESULT.CFG   A sample of the configuration file used to control
  674.                         part of the VendPrcs behavior.
  675.  
  676.          EXAMPLES.ZIP   A PKZIP-compressed file containing samples of other
  677.                         batch files that can be used with VendPrcs, sample
  678.                         VENDINFO.DIZ files, and the corresponding printouts
  679.                         of their content.
  680.  
  681.       Finally, the package contains these files, which describe the entire
  682.       VENDINFO toolset package:
  683.  
  684.          VENDINFO.DIZ   The VENDINFO.DIZ file that describes this whole
  685.                         VENDINFO toolset package. As a further introduc-
  686.                         tion, it's worth viewing with a text viewer.
  687.  
  688.          FILE_ID.DIZ    A small file containing a description of this
  689.                         package, currently used by many BBS and BBS-utility
  690.                         programs to automatically load such descriptions
  691.                         into their files databases. VENDINFO will even-
  692.                         tually render this convention obsolete, but
  693.                         FILE_ID.DIZ files should continue to be used, for
  694.                         now.
  695.  
  696.          VENDOR.DOC     A small "stub" pointing the distributor to
  697.                         VENDINFO.DIZ for information.
  698.  
  699.          READ_ME.1ST    A small "stub" pointing the user to VENDINFO.DIZ
  700.                         for information.
  701.  
  702.  
  703.  
  704.  
  705.  
  706.    VendEdit Editor v1.00              -8-                          Dec 1993
  707.  
  708.  
  709.  
  710.  
  711.    VendEdit User's Guide                                       Installation
  712.  
  713.  
  714.    Special Tips for the Inexperienced Shareware Author
  715.    ---------------------------------------------------
  716.  
  717.       Aside from its ability to produce VENDINFO records, the VendEdit
  718.       editor can be a serious educational tool for the beginning shareware
  719.       author. Both the VENDINFO record and the VendEdit help text contain a
  720.       wealth of information about the description and distribution of
  721.       shareware. To take full advantage of this capability, it is suggested
  722.       that you read all the material in the help system, either by select-
  723.       ing Help and working your way through the index, or (perhaps better)
  724.       by working your way sequentially through the menu system, pressing F1
  725.       everywhere. Even the menu items, such as Edit and Verify, that only
  726.       lead to other menu items have useful help text associated with them.
  727.  
  728.  
  729.    Warranty and License
  730.    --------------------
  731.  
  732.       VendEdit and VendPrcs are shareware products, which you may fully
  733.       evaluate before deciding whether or not you wish to purchase them.
  734.       The Warranty and License governing your use of these products will be
  735.       found in the VENDINFO.DIZ file (read it or print it with the tools
  736.       you use for ordinary text files). Or, if you prefer, you'll find
  737.       these materials in the VendEdit help system.
  738.  
  739.  
  740.    Technical Support for VendEdit
  741.    ------------------------------
  742.  
  743.       If you have a problem with installation or use of this product, and
  744.       the documentation doesn't provide the help you need, you are welcome
  745.       to contact us. You can do this in any of several ways.
  746.  
  747.       RAMS' ISLAND BBS
  748.  
  749.       The Rams' Island BBS is a bulletin board system, accessible to you if
  750.       if you have a modem and communication software. On our BBS, you will
  751.       always find the latest version of the program, and you will be able
  752.       to ask technical questions of us and of our other users. We also
  753.       offer additional utilities, class definitions, application notes, and
  754.       other assistance to registered users via the BBS. The BBS phone
  755.       number is 303-841-6269.
  756.  
  757.       COMPUSERVE INFORMATION SYSTEM
  758.  
  759.       We also support this product on the CompuServe information system.
  760.       The latest version of the program is always available there in the
  761.       SHAREWARE and UKSHARE forums, and technical questions and support
  762.       requests may be sent to us via electronic mail there or on the
  763.  
  764.  
  765.    VendEdit Editor v1.00              -9-                          Dec 1993
  766.  
  767.  
  768.  
  769.  
  770.    VendEdit User's Guide                                       Installation
  771.  
  772.  
  773.       CompuServe SHAREWARE and UKSHARE forums. Our CompuServe user ID is
  774.       76244,324.
  775.  
  776.       BBS NETWORK FORUMS
  777.  
  778.       We have established VENDINFO support forums on both the FidoNet and
  779.       RIME networks. We are investigating a VENDINFO forum on GlobalNet.
  780.  
  781.       OTHER ELECTRONIC ADDRESSES
  782.  
  783.       You can reach us through three other computer networks (you can
  784.       usually find a local BBS that's also on these networks).
  785.  
  786.          Our FidoNet address is 1:104/333.
  787.          Our RIME address is 1235 or RAMSISLE.
  788.          Our Internet address is 76244.324@compuserve.com.
  789.  
  790.       VOICE TELEPHONE
  791.  
  792.       You may reach us by voice telephone at 303-841-2848.
  793.  
  794.       MAIL
  795.  
  796.       You may contact us by mail at
  797.  
  798.          Rams' Island Software
  799.          7644 E. Lakecliff Way
  800.          Parker, Colorado 80134-5904
  801.          USA
  802.  
  803.  
  804.  
  805.  
  806.  
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.  
  820.  
  821.  
  822.  
  823.  
  824.    VendEdit Editor v1.00             -10-                          Dec 1993
  825.  
  826.  
  827.  
  828.  
  829.    VendEdit User's Guide                                    Overall Process
  830.  
  831.  
  832.        
  833.                      +----------------------------------+
  834.                      | Overview of the VendEdit Process |
  835.                      +----------------------------------+
  836.  
  837.       Here's the short form of the instructions for using VendEdit to
  838.       prepare a VENDINFO-equipped package:
  839.  
  840.            ───────────────────────────────────────────────────┐
  841.           │  Work your way left-to-right, and top-to-bottom,  │
  842.           │       through the VendEdit menu structure.        │
  843.           └───────────────────────────────────────────────────┘
  844.  
  845.       Here's a more detailed description of the procedure:
  846.  
  847.          o  If text materials already exist which you would like to use in
  848.             product descriptions, or in the Read-Me, Installation, War-
  849.             ranty, License, etc., use a normal text editor to prepare *.TXT
  850.             files containing these materials. This will work best if you
  851.             use a separate file for each of these, and a separate file for
  852.             each product description.
  853.  
  854.          o  Use VendEdit to prepare the VENDINFO information for the
  855.             product. The simplest approach is to work left-to-right and
  856.             top-to-bottom through the entire VendEdit menu structure, from
  857.             <P>repare through <V>erify. The additional menu items, e<X>port
  858.             and <T>est, will be discussed separately below.
  859.  
  860.          o  Assign a directory for "packaging" the product. Place the files
  861.             that make up the package in this directory. If the product
  862.             involves multiple packages (e.g., multiple diskettes or ZIPs),
  863.             each package should have its own directory. In this case, the
  864.             package directories must be subdirectories within a common
  865.             directory. In any case, each package directory must have the
  866.             package name that will be associated with the released ZIP
  867.             (e.g., the files that make up INCXT11A.ZIP will be in the
  868.             INCXT11A subdirectory). This step can be done sooner, but, in
  869.             any case, it must be done before an actual VENDINFO.DIZ file
  870.             can be prepared.
  871.  
  872.          o  Now start down the items in the e<X>port menu. First, select
  873.             <S>etup to start preparation of the final package. You will
  874.             tell VendEdit where the package directories are, and whether or
  875.             not you want a standard date/time stamp on files that are
  876.             created by VendEdit. You can also look over the files in the
  877.             package from here.
  878.  
  879.          o  The next several items in the e<X>port menu are optional files
  880.             that you might or might not want to include in the package. You
  881.  
  882.  
  883.    VendEdit Editor v1.00             -11-                          Dec 1993
  884.  
  885.  
  886.  
  887.  
  888.    VendEdit User's Guide                                    Overall Process
  889.  
  890.  
  891.             may direct VendEdit to produce FILE_ID.DIZ and DESC.SDI files
  892.             (we recommend the former, for sure). Since the VENDINFO.DIZ
  893.             file will contain Read-Me and Vendor.Doc style information, you
  894.             may want to point unfamiliar users and vendors to VENDINFO.DIZ.
  895.             For this purpose, VendEdit will product small "stub" files
  896.             READ_ME.1ST and VENDOR.DOC or VENDOR.TXT, which simply refer
  897.             the user to VENDINFO.DIZ. Finally, you may produce a small
  898.             READ_ME.BAT file, if you wish, which will invoke the DOS "more"
  899.             command on VENDINFO.DIZ to allow the novice user to easily read
  900.             the VENDINFO front text.
  901.  
  902.          o  At this point (proceeding down the items on the e<X>port menu),
  903.             you'll be given a chance to check the package. You must get the
  904.             files in their FINAL CONDITION before producing VENDINFO.DIZ
  905.             files. That's because the VENDINFO.DIZ file contains a Packing
  906.             List, which can be checked against the package actually
  907.             received by your distributor. If any file differs in name,
  908.             size, date, time, or CRC from those present when you created
  909.             the VENDINFO file, your package might be rejected.
  910.  
  911.          o  Export the VENDINFO.DIZ file.
  912.  
  913.          o  Perform the operations on the <T>est menu, to verify that the
  914.             VENDINFO file you created says what you think it does. THIS IS
  915.             VERY IMPORTANT!
  916.  
  917.       Your distribution package is now ready.
  918.  
  919.       When you release your product, you'll also want to send a copy of the
  920.       VENDINFO.DIZ file to our Product Registry. That will make it avail-
  921.       able to many distributors and end-users who may otherwise not know
  922.       about your product, and it can even generate income for you (see the
  923.       chapter, "The VENDINFO Product Registry" for details).
  924.  
  925.  
  926.  
  927.  
  928.  
  929.  
  930.  
  931.  
  932.  
  933.  
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.  
  942.    VendEdit Editor v1.00             -12-                          Dec 1993
  943.  
  944.  
  945.  
  946.  
  947.    VendEdit User's Guide                           Making Intermediate File
  948.  
  949.  
  950.        
  951.                     +-------------------------------------+
  952.                     | Making a VENDINFO Intermediate File |
  953.                     +-------------------------------------+
  954.  
  955.  
  956.  
  957.    Prepare Text Materials
  958.    ----------------------
  959.  
  960.       VendEdit has the ability to import existing text files into several
  961.       areas:
  962.  
  963.          o  Product descriptions
  964.          o  Read-Me text
  965.          o  Installation instructions
  966.          o  "Other" author material for readable front text
  967.          o  Product warranty
  968.          o  License for use and distribution
  969.  
  970.       If you're preparing a VENDINFO record for a product that has already
  971.       been released, you almost certainly have this text written. Even if
  972.       your product is new, you may find it more convenient to prepare this
  973.       material with your preferred text editor, and then import it into
  974.       VendEdit. On the other hand, the text editor inside VendEdit is
  975.       rather capable, so you certainly don't have to do it this way.
  976.  
  977.       If you decide to prepare the text files before using VendEdit, it is
  978.       suggested that you prepare several different files, using any desired
  979.       filename and the filename extension TXT. These files can be placed
  980.       anywhere, but they will be most easily found if they're placed in the
  981.       VendEdit directory. Possible filenames, with their purposes, are:
  982.  
  983.          DESC250.TXT   Product description of not more than 250 bytes
  984.          DESC450.TXT   Product description of 450 bytes (FILE_ID.DIZ size)
  985.          DESC750.TXT   Product description of not more than 750 bytes
  986.          DESC1500.TXT  Product description of not more than 1500 bytes
  987.          READ_ME.TXT   "Read-Me" text for front of VENDINFO.DIZ
  988.          INSTALL.TXT   Installation instructions
  989.          WARRANTY.TXT  Product warranty
  990.          LICENSE.TXT   License for use and distribution, but note that there
  991.                        are special requirements for the Distribution License
  992.                        in a VENDINFO file.
  993.          OTHER.TXT     Other text sections which the author wants in the
  994.                        VENDINFO front text.
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.    VendEdit Editor v1.00             -13-                          Dec 1993
  1002.  
  1003.  
  1004.  
  1005.  
  1006.    VendEdit User's Guide                           Making Intermediate File
  1007.  
  1008.  
  1009.       There are some minor format constraints:
  1010.  
  1011.  
  1012.          o  The product descriptions should use a block paragraph structure
  1013.             (no indentation, one blank line between paragraphs). It must
  1014.             use no special formatting (tables, lists that must align like
  1015.             the text you're now reading, boxes around text, etc.). This is
  1016.             because it will be extracted with word-wrapping, and refor-
  1017.             matted using automated tools by the distributor.
  1018.  
  1019.          o  It also must contain no high-ASCII or special low-ASCII charac-
  1020.             ters (all the characters on a normal keyboard are acceptable).
  1021.             This is because it will be printed in catalogs, entered in
  1022.             databases, etc., and such characters are useless or even damag-
  1023.             ing in such situations. If a file containing such characters is
  1024.             read in, all "illegal" characters will be converted to "*", but
  1025.             you may find that less satisfactory than converting such text
  1026.             yourself.
  1027.  
  1028.          o  The "front text" files ("Read-Me", etc.) should be no wider
  1029.             than 73 characters, but they do not have the formatting or
  1030.             character-set limitations of the product descriptions. If you
  1031.             import a text file wider than 73 characters, be sure to refor-
  1032.             mat each paragraph to the proper width (F5 will do a simple
  1033.             paragraph reformat automatically for you).
  1034.  
  1035.       When you have prepared these files, or decided not to, you're ready
  1036.       to <E>dit your first VENDINFO file.
  1037.  
  1038.  
  1039.    Packaging Directory(s)
  1040.    ----------------------
  1041.  
  1042.       There is one other preparation step you should be aware of, though it
  1043.       isn't necessary that it be done before preparing the VENDINFO inter-
  1044.       mediate record. That step is preparation of the directory(s) for your
  1045.       distribution package(s). Before VendEdit can actually produce a
  1046.       VENDINFO.DIZ file, it will need access to a directory containing all
  1047.       the files in your distribution package. Among other things the VEN-
  1048.       DINFO file contains a Packing List that has filenames, sizes, dates,
  1049.       and CRCs for all the files in your package. VendEdit makes two as-
  1050.       sumptions about these distribution package directory(s):
  1051.  
  1052.          o  It is assumed that the files for a given package are in a
  1053.             directory whose name is the prefix of the package name that
  1054.             will be used. For example, the first package of InContext is
  1055.             INCXT11A.ZIP. The files that make up this package are in the
  1056.             directory INCXT11A.
  1057.  
  1058.  
  1059.  
  1060.    VendEdit Editor v1.00             -14-                          Dec 1993
  1061.  
  1062.  
  1063.  
  1064.  
  1065.    VendEdit User's Guide                           Making Intermediate File
  1066.  
  1067.  
  1068.          o  If there are multiple packages for the product, it is assumed
  1069.             that their package directories are all subdirectories of the
  1070.             same directory.
  1071.  
  1072.       You might save a little time if you plan your product package con-
  1073.       struction in this way. It is perfectly acceptable to place these
  1074.       package directories under the VendEdit directory, though you may find
  1075.       it preferable to keep things organized by product. After you have
  1076.       entered the information that VendEdit requires about your product,
  1077.       you'll reach an e<X>port <S>etup menu in which you'll specify the
  1078.       directory under which you've placed the package directories.
  1079.  
  1080.  
  1081.    Invoke VendEdit
  1082.    ---------------
  1083.  
  1084.       To invoke VendEdit, simply go to the directory in which you've in-
  1085.       stalled the VENDINFO toolset, and execute the command
  1086.  
  1087.          vendedit
  1088.  
  1089.       Once you've created a VendEdit intermediate file for your product,
  1090.       you can invoke VendEdit on it from the command line, by adding the
  1091.       filename to the command. For example,
  1092.  
  1093.          vendedit INCXT11.PRD
  1094.  
  1095.  
  1096.    Edit a New File
  1097.    ---------------
  1098.  
  1099.       When you begin editing a new VENDINFO intermediate record, you'll be
  1100.       asked to provide a few basic pieces of information which VendEdit can
  1101.       use to automatically fill in a number of fields in the VENDINFO
  1102.       record. You'll save yourself work if you provide this information
  1103.       carefully, but ALL of it is still subject to change later, if neces-
  1104.       sary (use the <E>dit <P>roduct command).
  1105.  
  1106.       In particular, you'll be asked to decide upon file naming conventions
  1107.       for your distribution packages, using some standard conventions. One
  1108.       possibility, for example, is that you'll distribute your product as a
  1109.       compressed file named MYPROD10.ZIP, where "MYPROD" is probably a
  1110.       portion of your product name, and "10" represents version number
  1111.       1.00. You are not required to use the standard file naming conven-
  1112.       tions, but they are very helpful to distributors, and are strongly
  1113.       recommended.
  1114.  
  1115.       Once you're in the "Edit a New Record" data-entry screen, use the
  1116.       help system to access more detailed, and highly relevant, informa-
  1117.  
  1118.  
  1119.    VendEdit Editor v1.00             -15-                          Dec 1993
  1120.  
  1121.  
  1122.  
  1123.  
  1124.    VendEdit User's Guide                           Making Intermediate File
  1125.  
  1126.  
  1127.       tion. To see field-relevant help information, just press F1, the
  1128.       "Help" key. You'll be shown help information that's relevent to the
  1129.       field the cursor was on as you pressed F1.
  1130.  
  1131.  
  1132.    Edit Author/Publisher Information
  1133.    ---------------------------------
  1134.  
  1135.       This section of the VENDINFO record identifies the author/publisher
  1136.       and allows very complete contact information to be provided, if
  1137.       desired. Trade association memberships are also noted here.
  1138.  
  1139.       This section should be completed first, and in a single session. The
  1140.       contact information will be copied automatically into the "Orders"
  1141.       and "Support" sections as you exit the Author section. While this may
  1142.       occasionally be unhelpful, it will usually save a good deal of work,
  1143.       since these three sections usually contain much the same information.
  1144.       The trade association information also affects default product
  1145.       descriptions in the "Product" section.
  1146.  
  1147.       The bold exclamation point symbols ("!") on the display call your
  1148.       attention to particularly important help information. There is useful
  1149.       help information associated with virtually every field, but those
  1150.       marked with the "!" symbol should be read even if you skip the
  1151.       others.
  1152.  
  1153.       The "Company Name" and "Queries" (phone) fields have special sig-
  1154.       nificance, and are mandatory (see the help text).
  1155.  
  1156.       Once you have created your first VENDINFO file, you need not enter
  1157.       the Author information again. The F4 (import) key can read a whole
  1158.       "Author" section from an existing file.
  1159.  
  1160.  
  1161.    Edit Product Information
  1162.    ------------------------
  1163.  
  1164.       This section will describe your product in various ways. You will
  1165.       provide information about the product name and version, and filename
  1166.       information for the compressed package(s) in which you distribute it.
  1167.       You will construct (or read from existing text files) product
  1168.       descriptions of various lengths, and select descriptive categories
  1169.       and keywords.
  1170.  
  1171.       The product name, version, and filename information is important to
  1172.       the correct behavior of the VENDINFO tools. Please provide this
  1173.       information carefully, with special attention to the help text as-
  1174.       sociated with the fields marked with an "!".
  1175.  
  1176.  
  1177.  
  1178.    VendEdit Editor v1.00             -16-                          Dec 1993
  1179.  
  1180.  
  1181.  
  1182.  
  1183.    VendEdit User's Guide                           Making Intermediate File
  1184.  
  1185.  
  1186.       A special section of the Product information is devoted to the Plat-
  1187.       form needs of your product. Here, you can indicate the basic type of
  1188.       computer required, and both minimal and recommended levels of CPU,
  1189.       operating system, memory, clock speed, etc. You can also indicate
  1190.       which of a long list of system features are relevant to your product.
  1191.  
  1192.  
  1193.    Edit Order Information
  1194.    ----------------------
  1195.  
  1196.       This section of the VENDINFO record contains contact information to
  1197.       enable users to purchase the registered version and other products
  1198.       and services. It also indicates the various forms of payment you
  1199.       accept, and other sources of registered versions, if any.
  1200.  
  1201.       The contact portion of this section is very similar in structure to
  1202.       the Author section, though the content you provide may differ. If you
  1203.       edited the Author section first, the Order section will initially
  1204.       contain information from there.
  1205.  
  1206.       Once you have created your first VENDINFO file, you need not enter
  1207.       the Order information again. From within the Order section, the F4
  1208.       (import) key can read a whole "Order" section from an existing
  1209.       VENDINFO file.
  1210.  
  1211.  
  1212.    Edit Distributor Information
  1213.    ----------------------------
  1214.  
  1215.       Within the Orders section, there is an "Other Distributors of Regis-
  1216.       tered Version" area. Many authors will make no use of that area.
  1217.       However, if you have distributors who handle registrations for you --
  1218.       either world-wide or in specified geographical areas -- you will want
  1219.       to list them there. This will help users in their region -- and
  1220.       journalists and other distributors, if appropriate -- to get in
  1221.       contact with them. The help text for that section contains more
  1222.       detailed information.
  1223.  
  1224.       One special capability is worth noting. Distributors can use VendEdit
  1225.       to prepare information about themselves in the form of a *.DST file.
  1226.       You can then import the contents of such a file into your VENDINFO
  1227.       file using the F4 key. This allows you to provide your users with
  1228.       good contact information for the distributor, and even information
  1229.       about credit cards and other acceptable forms of payment. See the
  1230.       help text for more information.
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236.  
  1237.    VendEdit Editor v1.00             -17-                          Dec 1993
  1238.  
  1239.  
  1240.  
  1241.  
  1242.    VendEdit User's Guide                           Making Intermediate File
  1243.  
  1244.  
  1245.    Edit Support Information
  1246.    ------------------------
  1247.  
  1248.       This section of the VENDINFO record contains contact information to
  1249.       enable your users (and reviewers of your product, etc.) to obtain
  1250.       technical support. This section is very similar in structure to the
  1251.       Author section, though the content you provide may differ. If you
  1252.       edited the Author section first, the Support section will initially
  1253.       contain information from there.
  1254.  
  1255.       Once you have created your first VENDINFO file, you need not enter
  1256.       the Support information again. The F4 (import) key can read a whole
  1257.       "Support" section from an existing file.
  1258.  
  1259.  
  1260.    Edit Price/Benefit Information
  1261.    ------------------------------
  1262.  
  1263.       This section contains information about registration prices and
  1264.       benefits (both a minimum and a maximum registration package can be
  1265.       described, if you have multiple packages). Shipping and handling
  1266.       charges are here, as is information about site licenses, dealer
  1267.       discounts, royalty requirements, and availability of alternative Non-
  1268.       Shareware Versions (NSVs) and Low-Cost Retail (LCR) versions.
  1269.  
  1270.  
  1271.    Edit General (Channel-Independent) Distribution Policy
  1272.    ------------------------------------------------------
  1273.  
  1274.       In this section, you specify your distribution policy, to the extent
  1275.       that it is independent of specific distribution channels. You specify
  1276.       which basic distribution category it falls into:
  1277.  
  1278.          "Commercial" product, not distributable as shareware
  1279.          "Commercial" product, intended for distribution with other products
  1280.          Registered version, not distributable as shareware
  1281.          Registered version, intended for distribution with other products
  1282.          Shareware, subject to distribution restrictions
  1283.          Shareware, freely distributable by all channels
  1284.          Freeware, copyrighted but freely distributable and useable
  1285.          Demonstration product, freely distributable by all channels
  1286.          Public domain, freely distributable by all channels
  1287.          Retired product, removal from distribution requested
  1288.          Test version of product, not for further distribution
  1289.  
  1290.       You also specify what changes, if any, you allow to the outer com-
  1291.       pression wrapper and to the files in the package. You can also
  1292.       specify whether or not the distributor is allowed to bundle this
  1293.       product with others, and distribute the bundle.
  1294.  
  1295.  
  1296.    VendEdit Editor v1.00             -18-                          Dec 1993
  1297.  
  1298.  
  1299.  
  1300.  
  1301.    VendEdit User's Guide                           Making Intermediate File
  1302.  
  1303.  
  1304.       You can provide royalty information, if applicable, and indicate the
  1305.       availability of site licenses, dealer discounts, low-cost retail
  1306.       versions, and non-shareware versions.
  1307.  
  1308.  
  1309.    Edit Channel-Specific Distribution Policy
  1310.    -----------------------------------------
  1311.  
  1312.       In this section, you specify your product's distribution policy for
  1313.       each of 13 distribution channels:
  1314.  
  1315.          Distribution to End User by BBS
  1316.          Distribution to BBSes by File-Distribution Network
  1317.          Distribution to End User by Mail-Order Disk Vendor
  1318.          Distribution to End User by CD-ROM
  1319.          Distribution to End User by Single-Site Rack
  1320.          Distribution to Seller by Rackware Distributor
  1321.          Distribution to End User in Book Enclosure Diskette
  1322.          Distribution to End User by Subscription Service
  1323.          Distribution to End User by Magazine "Cover" Disk
  1324.          Distribution to End User by TV/cable/satellite Broadcast
  1325.          Distribution to End User by 1-900-Type Phone Service
  1326.          Product Installation by Distributor on End User's Machine
  1327.          Distribution by Substantially Different Means
  1328.  
  1329.       Simply select the channels, one at a time, and fill in or adjust the
  1330.       fields that define your distribution policy. Frequent use of the F1
  1331.       (Help) key can assist you with this.
  1332.  
  1333.  
  1334.    Edit Front Text
  1335.    ---------------
  1336.  
  1337.       The five front sections allow you to convey a great deal of informa-
  1338.       tion to the user or distributor even before he installs your product.
  1339.       The text of these sections is supplied by you. Before you start your
  1340.       own text for a section, though, it is recommended that you import the
  1341.       "suggested" text and at least read it for ideas. To import this text,
  1342.       just press F3.
  1343.  
  1344.       The License is especially important, and will be somewhat different
  1345.       under the VENDINFO system than your previous licenses have been. It
  1346.       is very important that you consult the help text before completing
  1347.       the text of this section.
  1348.  
  1349.  
  1350.  
  1351.  
  1352.  
  1353.  
  1354.  
  1355.    VendEdit Editor v1.00             -19-                          Dec 1993
  1356.  
  1357.  
  1358.  
  1359.  
  1360.    VendEdit User's Guide                        Verifying Intermediate File
  1361.  
  1362.  
  1363.        
  1364.                       +---------------------------------+
  1365.                       | Verifying the Intermediate File |
  1366.                       +---------------------------------+
  1367.  
  1368.       The <V>erify menu gives you access to the error-detection capability
  1369.       of VendEdit. Obviously, there are lots of errors the editor can't
  1370.       reasonably be expected to detect, but it can help you avoid certain
  1371.       common mistakes.
  1372.  
  1373.       The <V>erify menu allows you to test for "Errors only", "Warnings and
  1374.       above", or "Comments and above". Before you export a VENDINFO.DIZ
  1375.       file into your package, it is suggested that you use the "Comments"
  1376.       level, and satisfy yourself that the file is OK.
  1377.  
  1378.  
  1379.  
  1380.  
  1381.  
  1382.  
  1383.  
  1384.  
  1385.  
  1386.  
  1387.  
  1388.  
  1389.  
  1390.  
  1391.  
  1392.  
  1393.  
  1394.  
  1395.  
  1396.  
  1397.  
  1398.  
  1399.  
  1400.  
  1401.  
  1402.  
  1403.  
  1404.  
  1405.  
  1406.  
  1407.  
  1408.  
  1409.  
  1410.  
  1411.  
  1412.  
  1413.  
  1414.    VendEdit Editor v1.00             -20-                          Dec 1993
  1415.  
  1416.  
  1417.  
  1418.  
  1419.    VendEdit User's Guide                                    Exporting Files
  1420.  
  1421.  
  1422.        
  1423.                   +----------------------------------------+
  1424.                   | Exporting VENDINFO.DIZ and Other Files |
  1425.                   +----------------------------------------+
  1426.  
  1427.       Once your VENDINFO information is complete, you can begin to export
  1428.       the various files the VendEdit can produce. It is suggested that you
  1429.       consider the e<X>port menu choices in order, top-to-bottom.
  1430.  
  1431.       The first step, <S>etup, allows you to tell VendEdit the location of
  1432.       your distribution package(s). Be sure to consult the help text if you
  1433.       have any doubt about how this works. VendEdit currently expects your
  1434.       distribution files to be in a directory whose name matches the
  1435.       package filename prefix.
  1436.  
  1437.       Next, you can decide which, if any, of the optional exported files
  1438.       you want. We suggest FILE_ID.DIZ, READ_ME.1ST, and VENDOR.DOC, but
  1439.       you'll have to decide for yourself.
  1440.  
  1441.       Once those are done, you need to verify that your distribution
  1442.       package contains all the files you want it to have, and that they all
  1443.       have the desired date/time stamps if you care about those. The final
  1444.       export step is VENDINFO.DIZ itself, and it will contain a list of all
  1445.       the other files, each with name, size, date, time and CRC value. This
  1446.       will be used at the distributor end to check for changes, par-
  1447.       ticularly those that might violate your distribution license.
  1448.       Naturally, if *you* change a file after VENDINFO.DIZ is constructed,
  1449.       and don't rebuild the VENDINFO.DIZ file, your distributors will be
  1450.       told that the package has been altered. The processor can't tell who
  1451.       made the change.
  1452.  
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458.  
  1459.  
  1460.  
  1461.  
  1462.  
  1463.  
  1464.  
  1465.  
  1466.  
  1467.  
  1468.  
  1469.  
  1470.  
  1471.  
  1472.  
  1473.    VendEdit Editor v1.00             -21-                          Dec 1993
  1474.  
  1475.  
  1476.  
  1477.  
  1478.    VendEdit User's Guide                                   Checking Results
  1479.  
  1480.  
  1481.        
  1482.                            +----------------------+
  1483.                            | Checking the Results |
  1484.                            +----------------------+
  1485.  
  1486.       The <T>est menu allows you to perform three separate tests on the
  1487.       VENDINFO.DIZ file you've generated:
  1488.  
  1489.            o  Visually inspect the readable front text of the VENDINFO.DIZ
  1490.               file, as it will be seen by users and distributors.
  1491.  
  1492.            o  Use the VendPrcs distributor's tool to extract all the infor-
  1493.               mation from the data record into a readable file, and display
  1494.               it.
  1495.  
  1496.            o  Use the VendPrcs distributor's tool to perform a variety of
  1497.               distribution-policy tests, and display the results as they
  1498.               would be seen by a distributor.
  1499.  
  1500.       These tests are VERY IMPORTANT! The VENDINFO file will be the first
  1501.       thing many users and distributors will see about your product. You
  1502.       will also be conveying legally binding distribution rights via the
  1503.       data record. You have a strong interest in making sure it's correct.
  1504.  
  1505.       Once you've done this, your distribution package is complete and
  1506.       ready to be compressed or copied to diskette. Remember to use the
  1507.       correct filename for the compressed package.
  1508.  
  1509.  
  1510.  
  1511.  
  1512.  
  1513.  
  1514.  
  1515.  
  1516.  
  1517.  
  1518.  
  1519.  
  1520.  
  1521.  
  1522.  
  1523.  
  1524.  
  1525.  
  1526.  
  1527.  
  1528.  
  1529.  
  1530.  
  1531.  
  1532.    VendEdit Editor v1.00             -22-                          Dec 1993
  1533.  
  1534.  
  1535.  
  1536.  
  1537.    VendEdit User's Guide                                   Product Registry
  1538.  
  1539.  
  1540.        
  1541.                        +-------------------------------+
  1542.                        | The VENDINFO Product Registry |
  1543.                        +-------------------------------+
  1544.  
  1545.       The Product Registry is a service that accepts VENDINFO.DIZ files
  1546.       from authors and makes them available to distributors and even end
  1547.       users. There is no charge to the author for this service, and under
  1548.       some circumstances it can even generate a small amount of income for
  1549.       you.
  1550.  
  1551.       Distributors can pay to subscribe to the entire Product Registry
  1552.       collection, either by monthly mailing or by access to the Product
  1553.       Registry BBS. On-line and mail-order queries will be possible by
  1554.       Spring 1994. We can imagine users looking for a particular type of
  1555.       product by category and machine configuration. Or distributors look-
  1556.       ing for business programs they don't have, and which allow distribu-
  1557.       tion by their particular preferred method.
  1558.  
  1559.       In many cases, queries will be paid for on a charge-per-hit basis.
  1560.       One-third of the revenues from such hit charges will be paid to the
  1561.       authors whose products are "hit", so this can not only cause your
  1562.       product to be noticed, but it can even generate a little income for
  1563.       you. No special arrangements are necessary for this payment to occur.
  1564.       It will be paid quarterly; no payments will ever be made until your
  1565.       balance exceeds $15.
  1566.  
  1567.       We're trying hard to make the Product Registry work for everyone. We
  1568.       hope you'll support it by sending us your VENDINFO files.
  1569.  
  1570.       Please send only the MAIN VENDINFO.DIZ file for each product version.
  1571.       If you product has multiple packages, this is the VENDINFO file from
  1572.       the first package. DO NOT send your whole package -- it will be
  1573.       rejected.
  1574.  
  1575.       If you're sending VENDINFO files for more than one product, please
  1576.       rename them using the product filename prefix and the filename exten-
  1577.       sion "DIZ" (e.g., INCXT11.DIZ).
  1578.  
  1579.       VENDINFO files can be uploaded directly to our BBS (the preferred
  1580.       method), mailed on diskette, or sent by CompuServe e-mail or FidoNet
  1581.       crash mail. If you're sending them electronically, please compress
  1582.       them using PKZIP or LHA. Please add your Product Registry key (one of
  1583.       the registration codes you were given when you registered VendEdit)
  1584.       to the cover message to assure us that you're the sender. Our
  1585.       electronic and mail addresses are on the front cover of this manual.
  1586.  
  1587.       On an experimental basis, we are also going to try to maintain a
  1588.       collection of screenshots of your products. This will provide a
  1589.  
  1590.  
  1591.    VendEdit Editor v1.00             -23-                          Dec 1993
  1592.  
  1593.  
  1594.  
  1595.  
  1596.    VendEdit User's Guide                                   Product Registry
  1597.  
  1598.  
  1599.       useful service for distributors and journalists who may need shots of
  1600.       your products for catalogs, articles, or perhaps even BBS displays. A
  1601.       screenshot might also help distributors or even end users to decide
  1602.       whether or not to seek out your product. Whether or not we continue
  1603.       this service will depend on its popularity with distributors. We have
  1604.       a fair amount of disk space, however, and should be able to give it a
  1605.       fair test before we decide.
  1606.  
  1607.       If you want to submit screenshots, here's the procedure. You may
  1608.       submit up to three screenshots in each of two graphical formats.
  1609.       Prepare a separate ZIP file (use PKZIP) for each format. Place in it
  1610.       only the screenshots for that format, along with a FILE_ID.DIZ in-
  1611.       dicating what the files are, and identifying your product by name,
  1612.       version, and release date. Rename the ZIP file in the following way.
  1613.       For the filename prefix, use your product filename prefix. For the
  1614.       filename extension, use the filename extension associated with the
  1615.       graphical file format contained in the ZIP, then substitute the
  1616.       letter "Z" for the first character. Thus, INCXT11.ZIF would be a ZIP
  1617.       file containing GIF screenshots for the product "INCXT11". If you're
  1618.       sending screenshots, you must mail them on diskette. They will not be
  1619.       accepted by CompuServe e-mail, as the cost is prohibitive.
  1620.  
  1621.       Distributors are also asked to submit *.DST files for use by their
  1622.       authors. This will make it easy for all your authors to include very
  1623.       detailed information about you with very little effort, so it's in
  1624.       your interest to make these available. You may use an unregistered
  1625.       version of VendEdit to produce these, and they may be sent by any of
  1626.       the methods useable for VENDINFO.DIZ files.
  1627.  
  1628.  
  1629.  
  1630.  
  1631.  
  1632.  
  1633.  
  1634.  
  1635.  
  1636.  
  1637.  
  1638.  
  1639.  
  1640.  
  1641.  
  1642.  
  1643.  
  1644.  
  1645.  
  1646.  
  1647.  
  1648.  
  1649.  
  1650.    VendEdit Editor v1.00             -24-                          Dec 1993
  1651.  
  1652.  
  1653.  
  1654.  
  1655.    VendEdit User's Guide                                A Bit of Philosophy
  1656.  
  1657.  
  1658.        
  1659.                             +---------------------+
  1660.                             | A Bit of Philosophy |
  1661.                             +---------------------+
  1662.  
  1663.  
  1664.  
  1665.    Philosophy Regarding Distribution Restrictions
  1666.    ----------------------------------------------
  1667.  
  1668.       Both authors and distributors will make more effective use of the
  1669.       VENDINFO system if they understand the point of view from which the
  1670.       system was designed. That point of view is outlined below.
  1671.  
  1672.       Regarding distribution restrictions by author/publishers:
  1673.  
  1674.            o  The author should be able to express any possible distribu-
  1675.               tion restrictions, regardless of whether or not such restric-
  1676.               tions are well-advised.
  1677.  
  1678.            o  Common and/or reasonable restrictions should be encoded in
  1679.               the VENDINFO record in such a way that automated tools can
  1680.               deal with them.
  1681.  
  1682.            o  Other distribution restrictions should be expressible in text
  1683.               form, even if their presence will force conscientious dis-
  1684.               tributors to handle the package manually.
  1685.  
  1686.            o  None of this should be taken as an encouragement for authors
  1687.               to impose distribution restrictions. In many cases, the
  1688.               documentation and help text of the VendEdit editor explicitly
  1689.               discourage restrictions. As an example, the author is advised
  1690.               to consider carefully before imposing ANY restriction on BBS
  1691.               distribution.
  1692.  
  1693.            o  Authors will especially be warned against unnecessary use of
  1694.               options that force manual handling by distributors.
  1695.  
  1696.       Regarding testing for distribution permission:
  1697.  
  1698.            o  In general, a proposed distribution is assumed to be NOT
  1699.               allowed until the distributor clearly addresses each condi-
  1700.               tion required by a product's distribution policy. This isn't
  1701.               done to constrain distribution or to make life difficult for
  1702.               distributors. It is done to protect all parties from acci-
  1703.               dents, misunderstanding, and even legal liability. Thus, if a
  1704.               product can be distributed by a disk vendor only if the per-
  1705.               disk charge is less than $10, VendPrcs will not "OK" the
  1706.               distribution because the vendor fails to mention the amount
  1707.  
  1708.  
  1709.    VendEdit Editor v1.00             -25-                          Dec 1993
  1710.  
  1711.  
  1712.  
  1713.  
  1714.    VendEdit User's Guide                                A Bit of Philosophy
  1715.  
  1716.  
  1717.               charged.
  1718.  
  1719.  
  1720.  
  1721.    Algorithm Used for Distribution Permission Tests
  1722.    ------------------------------------------------
  1723.  
  1724.       Based on the information you provide on the VendPrcs command line,
  1725.       and the distribution policy specified in the VENDINFO file, VendPrcs
  1726.       determines whether or not your proposed distribution satisfies the
  1727.       author's requirements. To do this, VendPrcs looks at the author's
  1728.       policy for the particular distribution channel you've indicated, as
  1729.       well as the channel-independent ("general") distribution restrictions
  1730.       in the VENDINFO file. The actual decision process works as follows.
  1731.       (The important thing to understand is the last step, but you may find
  1732.       it useful to understand the whole decision process.)
  1733.  
  1734.            o  If distribution via the proposed channel is prohibited, then
  1735.               "reject".
  1736.  
  1737.            o  See if distributor is "qualified". The author might indicate
  1738.               that all distributors are qualified. If not, you must meet at
  1739.               least one of the author's qualification criteria to be in
  1740.               this set. Example criteria are: ASP member, non-profit user
  1741.               group, agreeing to "fully inform" your customers.
  1742.  
  1743.            o  If distributor is "qualified", see if any specific behavior
  1744.               removes this "qualified" status, such as charging customers
  1745.               more than allowed.
  1746.  
  1747.            o  Distributor is now either "qualified" or "disqualified". The
  1748.               meaning of this distinction is specified by the author. There
  1749.               are three possibilities:
  1750.  
  1751.                  1. Qualified may distribute without written permission.
  1752.                     Disqualified may distribute only with written
  1753.                     permission.
  1754.  
  1755.                  2. Qualified may distribute without written permission.
  1756.                     Disqualified may not distribute at all. (Obviously,
  1757.                     with the author's written permission, you can do
  1758.                     anything you want; what the author is really telling
  1759.                     you is that written permission won't be given.)
  1760.  
  1761.                  3. Qualified must still have written permission.
  1762.                     Others may not distribute at all.
  1763.  
  1764.            o  Based on your qualified/disqualified status, VendPrcs deter-
  1765.               mines whether or not you need written permission, and whether
  1766.  
  1767.  
  1768.    VendEdit Editor v1.00             -26-                          Dec 1993
  1769.  
  1770.  
  1771.  
  1772.  
  1773.    VendEdit User's Guide                                A Bit of Philosophy
  1774.  
  1775.  
  1776.               or not your proposed distribution is prohibited. If written
  1777.               permission is required, VendPrcs determines whether or not
  1778.               you've obtained it; if not, this requirement is noted in the
  1779.               log and will affect the errorlevel returned by VendPrcs.
  1780.  
  1781.            o  If the distribution is allowed, either with or without writ-
  1782.               ten permission, VendPrcs looks for any additional author-
  1783.               specified conditions you must satisfy, and determines from
  1784.               the command-line flags whether or not you've satisfied them.
  1785.               If any conditions remain unsatisfied (including conditions
  1786.               specified by the author in text form), they are noted in the
  1787.               log and will affect the errorlevel returned by VendPrcs.
  1788.  
  1789.            o  Unless you've disabled VendPrcs testing of executables, all
  1790.               *.EXE, *.COM, *.DLL, *.LIB, etc. files in the package are
  1791.               scanned for VENDINFO records, and a similar decision process
  1792.               is applied to any that are found. This feature is used to
  1793.               detect registered-user versions and commercial and other
  1794.               software not intended for further distribution. (See the
  1795.               later section, "Testing for VENDINFO-Branded Executables".
  1796.  
  1797.            o  VendPrcs now informs you by DOS errorlevel (and in the log-
  1798.               file) that:
  1799.  
  1800.                  1. Distribution is prohibited by the VENDINFO file.
  1801.                  2. Distribution is prohibited by some included executable.
  1802.                  3. Distribution is OK if you satisfy additional
  1803.                     requirements.
  1804.                  4. Distribution is OK if you obtain written permission.
  1805.                  5. Distribution is OK if you obtain written permission AND
  1806.                     satisfy additional requirements.
  1807.                  6. Distribution is approved as-is.
  1808.  
  1809.  
  1810.  
  1811.    Legal Matters
  1812.    -------------
  1813.  
  1814.       The License Agreement for the VENDINFO toolset is a little more
  1815.       complicated than most, and it is important that you familiarize
  1816.       yourself with it. You'll find it in the VENDINFO.DIZ file that came
  1817.       with the toolset, as well as in the VendEdit help system.
  1818.  
  1819.       In addition to the normal functions of a license agreement, this one
  1820.       serves an important role in the VENDINFO system. By requiring dis-
  1821.       tributors to agree to a few simple conditions, it helps protect the
  1822.       rights of authors and the confidence with which authors can use the
  1823.       VENDINFO system. Similarly, authors must agree to a few conditions
  1824.       that help protect the distributor. Details are explained in the
  1825.  
  1826.  
  1827.    VendEdit Editor v1.00             -27-                          Dec 1993
  1828.  
  1829.  
  1830.  
  1831.  
  1832.    VendEdit User's Guide                                           Security
  1833.  
  1834.  
  1835.       license itself.
  1836.  
  1837.  
  1838.  
  1839.  
  1840.  
  1841.  
  1842.  
  1843.  
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850.  
  1851.  
  1852.  
  1853.  
  1854.  
  1855.  
  1856.  
  1857.  
  1858.  
  1859.  
  1860.  
  1861.  
  1862.  
  1863.  
  1864.  
  1865.  
  1866.  
  1867.  
  1868.  
  1869.  
  1870.  
  1871.  
  1872.  
  1873.  
  1874.  
  1875.  
  1876.  
  1877.  
  1878.  
  1879.  
  1880.  
  1881.  
  1882.  
  1883.  
  1884.  
  1885.  
  1886.    VendEdit Editor v1.00             -28-                          Dec 1993
  1887.  
  1888.  
  1889.  
  1890.  
  1891.    VendEdit User's Guide                                           Security
  1892.  
  1893.  
  1894.        
  1895.                                  +----------+
  1896.                                  | Security |
  1897.                                  +----------+
  1898.  
  1899.       The security features of VENDINFO make no claim to be hack-proof, but
  1900.       they should be sufficient to:
  1901.  
  1902.            o  Eliminate manual editing of VENDINFO records, which could do
  1903.               serious accidental or deliberate damage.
  1904.  
  1905.            o  Eliminate casual hacking.
  1906.  
  1907.            o  Require effort on the part of a serious hacker that exceeds
  1908.               any likely gain.
  1909.  
  1910.       Some of the security features in the initial release of VENDINFO are:
  1911.  
  1912.            o  The structure, complexity, and internal checks associated
  1913.               with the VENDINFO record are such that it is difficult to
  1914.               produce without a specialized VENDINFO editor.
  1915.  
  1916.            o  The editor cannot edit a distributed VENDINFO file. It
  1917.               produces such files from an intermediate file -- which the
  1918.               author keeps -- in a one-way operation.
  1919.  
  1920.            o  Both the text and data portions of the VENDINFO records are
  1921.               checked for size and CRC.
  1922.  
  1923.            o  VENDINFO records can contain two "authentication" keys that
  1924.               help verify the source and unaltered content of the record.
  1925.  
  1926.            o  The editor will produce "authenticated" VENDINFO records only
  1927.               in the presence of an author-specific key that is not con-
  1928.               tained in the distributed VENDINFO record.
  1929.  
  1930.  
  1931.       Planned capabilities for a subsequent VENDINFO release include:
  1932.  
  1933.            o  If the author chooses, an abbreviated VENDINFO record can be
  1934.               embedded in any or all executable programs. This insures that
  1935.               basic identification and distribution policy information is
  1936.               present and automatically testable even if the VENDINFO
  1937.               record is removed from the distribution package.
  1938.  
  1939.            o  If the author chooses, the executable VENDINFO record can
  1940.               require the presence of a specific VENDINFO file (identified
  1941.               by a CRC-like value). This would allow automatic detection of
  1942.               the removal of the VENDINFO file from the distribution
  1943.  
  1944.  
  1945.    VendEdit Editor v1.00             -29-                          Dec 1993
  1946.  
  1947.  
  1948.  
  1949.  
  1950.    VendEdit User's Guide                                           Security
  1951.  
  1952.  
  1953.               package. It would also allow automatic detection of the
  1954.               substitution of a VENDINFO file in the distribution package
  1955.               even if the file itself passed all security checks.
  1956.  
  1957.            o  If the author places the executable VENDINFO record inside
  1958.               his/her own protective CRC envelope, a complete understanding
  1959.               of the VENDINFO security scheme would not be enough to defeat
  1960.               it. A hacker would also have to defeat the author's own
  1961.               security layer.
  1962.  
  1963.            o  A separate mechanism exists which allows a central site (the
  1964.               Product Registry) to verify the authenticity of a VENDINFO
  1965.               record based on private keys.
  1966.  
  1967.            o  A provision for author tracking brands in the uncompressed
  1968.               front-text of the VENDINFO.DIZ file. These brands will be
  1969.               visible to a file viewer, easily accessible to the author's
  1970.               own software, and defended against modification by in-
  1971.               dividuals other than the author.
  1972.  
  1973.  
  1974.  
  1975.  
  1976.  
  1977.  
  1978.  
  1979.  
  1980.  
  1981.  
  1982.  
  1983.  
  1984.  
  1985.  
  1986.  
  1987.  
  1988.  
  1989.  
  1990.  
  1991.  
  1992.  
  1993.  
  1994.  
  1995.  
  1996.  
  1997.  
  1998.  
  1999.  
  2000.  
  2001.  
  2002.  
  2003.  
  2004.    VendEdit Editor v1.00             -30-                          Dec 1993
  2005.  
  2006.  
  2007.