home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / zocbk104.zip / ZOCBOOK.DOC < prev    next >
Text File  |  1994-05-07  |  17KB  |  478 lines
  1.  
  2.  
  3.     ZOCBOOK - ZOC phone book utility, v1.04 94/05/07
  4.  
  5.  
  6. --------------------------------------------------------------------------
  7.  
  8. Contents:
  9.  
  10.     0. WHAT'S NEW?
  11.     1. DISTRIBUTION, COPYRIGHT
  12.     2. INSTALLATION, CALLING
  13.     3. NOTES
  14.     4. VERSION HISTORY
  15.     5. ZOC, THANKS
  16.  
  17. --------------------------------------------------------------------------
  18.  
  19.  
  20. --------------------------------------------------------------------------
  21.     0. WHAT'S NEW?
  22. --------------------------------------------------------------------------
  23.  
  24.     See 4. VERSION HISTORY for new features/bugfixes.
  25.  
  26.  
  27. --------------------------------------------------------------------------
  28.     1. DISTRIBUTION, COPYRIGHT
  29. --------------------------------------------------------------------------
  30.  
  31.     ZOCBOOK is freeware, (C) by Hans Jürgen Rauscher, 1993/94
  32.  
  33.     You may use this software as long, as you find it useful.
  34.     There is (yet) no fee for using it.
  35.  
  36.     No warranty of any kind can be given for damage, data loss, or any
  37.     other inconvenience caused through ZOCBOOK directly or indirectly.
  38.  
  39.     ZOCBOOK may be distributed freely via telecommunication, shareware
  40.     dealers or bundeld with ZOC in form of an unmodified ZIP archive,
  41.     or as unzipped files in an single directory with the name ZOCBOOK
  42.     and with no file added, removed or modified.
  43.  
  44.     The following restrictions apply to distribution.
  45.  
  46.      * ZOCBOOK must not be bundled with any Microsoft(+) product.
  47.  
  48.      * ZOCBOOK must not be sold as shareware for more than $5 / DM 7
  49.        (including shipping). If you purchased ZOCBOOK from a dealer paying
  50.        more (or get knowledge of such a dealer), notify him of this
  51.        regulation.
  52.  
  53.  
  54. --------------------------------------------------------------------------
  55.     2. INSTALLATION, CALLING
  56. --------------------------------------------------------------------------
  57.  
  58.     There are a few things you should know about ZOCBOOK before you
  59.     begin - please read carefully.
  60.  
  61.  
  62.     Unpacking the ZIP file:
  63.     -----------------------
  64.  
  65.     Unpack ZOCBOOK in your preferred directory. It is recommended
  66.     that you unpack it in your ZOC directory for ease of use.
  67.  
  68.  
  69.     If you have problems:
  70.     ---------------------
  71.  
  72.     Read this documentation again, and if this doesn't help contact the
  73.     autor.
  74.  
  75.     FIDO-Net: 2:2440/225.10@FIDO-Classic
  76.     InterNet: Hans-Juergen_Rauscher@project.fido.de
  77.           or: Hans-Juergen_Rauscher@p10.f225.n2440.z2.fidonet.org
  78.     Fax     : +49 (0)2182-850711
  79.  
  80.  
  81.     Starting ZOCBOOK:
  82.     ----------------
  83.  
  84.     ZOCBOOK is a DOS text mode application. So open a OS/2 MDOS-box,
  85.     or use plain DOS for executing ZOCBOOK.
  86.  
  87.  
  88.     ZOCBOOK <command> <zocfile> [other parameters and/or <options>]
  89.  
  90.  
  91.     Available commands:
  92.     -------------------
  93.  
  94.     INFO           = get some info's about ZOC phone book
  95.     SET            = set ZOC phone book entries matching condition to
  96.                      specified parameters
  97.     DELETE         = delete ZOC phone book entries matching condition
  98.     IMPORT         = import phone book entries to ZOC phone book
  99.  
  100.     Only the first three letters of the command are needed. Command is
  101.     not case sensitive.
  102.  
  103.  
  104.     Needed parameters:
  105.     ------------------
  106.  
  107.     - INFO:
  108.  
  109.     Example: ZOCBOOK INFO PHONEBK
  110.  
  111.  
  112.     - SET:
  113.  
  114.     <condition>    = condition ZOC phone book entries must match
  115.     <options>      = options matching ZOC phone book entries will be
  116.                      set to
  117.  
  118.     Example: ZOCBOOK SET PHONEBK EMULATION=TTY /E:ANSI
  119.              will set all ZOC phone book entries with tty emulation to
  120.              ansi emulation
  121.  
  122.  
  123.     - DELETE:
  124.  
  125.     <condition>    = condition ZOC phone book entries must match
  126.  
  127.     Example: ZOCBOOK DEL PHONEBK BOOK=DEFAULT
  128.              will delete all ZOC phone book entries in phone book Default
  129.  
  130.  
  131.     - IMPORT:
  132.  
  133.     <importfile>   = import phone book file name (with optional drive
  134.                      and path)
  135.     <importformat> = import format of import phone book file (ASCII,
  136.                      TELIX, TELEMATE or FIDO)
  137.     <intl-code>    = international dial prefix (e.g. 00 in Germany)
  138.     <country-code> = country dial code (e.g. 1 for USA, 49 for Germany)
  139.     (<intl-code> and <country-code> needed only for FIDO import.)
  140.  
  141.     Examples: ZOCBOOK IMPORT \ZOC\PHONEBK \BBS.LST         ASCII
  142.               will import entries in ASCII format
  143.  
  144.               ZOCBOOK IMPORT \ZOC\PHONEBK \TELIX\TELIX.FON TELIX
  145.               will import entries in Telix(*) format
  146.  
  147.               ZOCBOOK IMPORT \ZOC\PHONEBK \TM\TM.FON       TELEMATE
  148.               will import entries in Telemate(#) format
  149.  
  150.               ZOCBOOK IMPORT \ZOC\PHONEBK \FIDO\NODELIST   FIDO     00 49
  151.               will import entries in FIDO NodeList format, with
  152.               00 int'l dial prefix and 49 country dial code
  153.  
  154.  
  155.     Condition:
  156.     ----------
  157.  
  158.     A ZOC phone book entry must match the specified condition if the
  159.     specified action (set / delete) should apply to it.
  160.  
  161.     In this version of ZOCBOOK you can only specify simple conditions,
  162.     means: only one condition at one time. Maybe one of the next
  163.     ZOCBOOK versions can use multiple conditions.
  164.  
  165.     Condition format:  <name><operator><value>
  166.  
  167.     where:
  168.  
  169.     <name>     = NAME      (bbs name)
  170.                  NUMBER    (phone number)
  171.                  SERIAL    (serial parameters)
  172.                  OPTION    (option file)
  173.                  LOG       (logfile)
  174.                  AUTO      (auto login)
  175.                  BOOK      (phone book section)
  176.                  DIAL      (dial method)
  177.                  QUICK     (quick access)
  178.                  ZONE      (zone)
  179.                  EMULATION (emulation)
  180.                  PASSWORD  (password)
  181.                  MEMO      (memo text)
  182.                  CALLDUE   (calldue, '$' doesn't work)
  183.  
  184.     <operator> = = (equal)
  185.                  # (not equal)
  186.                  $ (contains)
  187.  
  188.     <value>    = the valid value for name, in this version of ZOCBOOK
  189.                  <value> must not have a space in it. This means that
  190.                  <value> is restricted to single word values.
  191.  
  192.     Examples:  book=1
  193.                match all entries which phone book section is "#1"
  194.  
  195.                dial#script
  196.                match all entries which dial method is not "Script"
  197.  
  198.                name$blues
  199.                match all entries which bbs name contains "blues"
  200.  
  201.                password=secret
  202.                match all entries which password is "secret"
  203.  
  204.  
  205.     Options:
  206.     --------
  207.  
  208.     /s:<serial>       = set serial parameters for ZOC entries to <serial>;
  209.                         if not specified each ZOC entry is set to the
  210.                         value pecified in the import phone book entry;
  211.                         if /s: without <serial> is specified, serial
  212.                         parameters are erased, and therefore the ZOC
  213.                         setting serial parameters are used
  214.     /b:<book>         = put ZOC entries into <book> (default, 1, 2 or 3)
  215.     /d:<dial>         = set dialmode for ZOC entries to <dial> (dial,
  216.                         xdial or script)
  217.     /q:<quick-access> = set quick access for ZOC entries to <quick-access>
  218.                         (on or off)
  219.     /z:<zone>         = set zone for ZOC entries to <zone> (a, b, c or d)
  220.     /e:<emulation>    = set terminal emulation for ZOC entries to
  221.                         <emulation> (default, ansi, vt100 or tty)
  222.     /a:<autologin>    = set autologin text for password sending (yes, no)
  223.     /v:<book-version> = use ZOC phone book version (0.98) new phone books
  224.     /p:<password>     = set password for ZOC entries to <password>
  225.     /c:<calldue>      = set calldue for ZOC entries to <calldue>
  226.  
  227.     Feel free to use only the parameters you need. The parameters are
  228.     neither order- nor case sensitive.
  229.  
  230.  
  231.     Defaults:
  232.     ---------
  233.  
  234.     <serial>       = as specified in the entries or as in ZOC setting (FIDO)
  235.     <book>         = Default
  236.     <dial>         = Dial
  237.     <quick-access> = Off
  238.     <zone>         = A
  239.     <emulation>    = as specified in the entries or as in ZOC setting (FIDO)
  240.     <autologin>    = password, as specified in the entries
  241.     <book-version> = 0.98
  242.     <password>     = as specified in the entries
  243.     <calldue>      = 0
  244.  
  245.  
  246.     Extended examples:
  247.     ------------------
  248.  
  249.     ZOCBOOK INFO \ZOC\PHONEBK
  250.       - show ZOC phone book info's
  251.  
  252.     ZOCBOOK SET PHONEBK EMULATION=TTY /E:ANSI /S:57600-8N1 /B:3
  253.       - change all ZOC phone book entries with tty emulation
  254.       * set ZOC emulation to ANSI
  255.       * set serial parameters to baud rate 57600, 8 data bits, no parity,
  256.         1 stop bit
  257.       * put entries in ZOC phone book #3
  258.  
  259.     ZOCBOOK DELETE PHONEBK NAME$foo
  260.       - delete all ZOC phone book entries with bbs name contains "foo"
  261.  
  262.     ZOCBOOK IMPORT PHONEBK TELIX.FON /S:38400-8N1 /B:1 /D:DIAL /Z:C /E:ANSI
  263.       - import Telix(*) phone book
  264.       * use ZOC phone book with file name PHONEBK in current directory
  265.       * use Telix(*) phone book with path/file name \TELIX\TELIX.FON
  266.       * set serial parameters to baud rate 38400, 8 data bits, no parity,
  267.         1 stop bit
  268.       * put the entries in ZOC phone book #1
  269.       * set ZOC dialmode to DIAL
  270.       * set ZOC zone to C
  271.       * set ZOC emulation to ANSI
  272.  
  273.     ZOCBOOK IMPORT PHONEBK NODELIST.365 00 49 /E:TTY /A:YES /P:secret
  274.       - import FIDO NodeList
  275.       * use ZOC phone book with filename PHONEBK
  276.       * use NodeList with filename NODELIST.365
  277.       * int'l dial prefix is 00
  278.       * country dial code is 49 (Germany)
  279.       * set ZOC emulation to TTY
  280.       * set ZOC autologin text to 'W1=sswor|S1=', appends password from
  281.         phone book entry, appends '^M'
  282.       * set password to 'secret'
  283.  
  284.  
  285. --------------------------------------------------------------------------
  286.     3. NOTES
  287. --------------------------------------------------------------------------
  288.  
  289.     ZOC phone book format versions:
  290.     -------------------------------
  291.  
  292.     This version creates ZOC phone book files with the V0.98 phonebook
  293.     format. This is the actual version (together with ZOC 1.00) and I
  294.     hope that future versions of ZOC will read it as well.
  295.  
  296.     With upcoming ZOC v1.22beta / v1.30 phone book has four more fields.
  297.     ZOCBOOK 1.04 (the version included) is able to handle them correctly.
  298.  
  299.  
  300.     ASCII phone book format:
  301.     ------------------------
  302.  
  303.     BBS name    : 32 characters, position 1 to 32
  304.     phone number: 64 characters, position 33 to 96
  305.     password    : 20 characters, position 97 to 116
  306.     baud rate   :  6 characters, position 117 to 122
  307.     data bits   :  1 character, position 123
  308.     parity      :  1 character, position 124
  309.     stop bits   :  1 character, position 125
  310.     emulation   : 10 characters, position 126 to 135
  311.  
  312.     All entries have to be left justified.
  313.  
  314.     Since user intervention, changed in v1.02: the line has only to end
  315.     with cr/lf, instead of (v1.01): line size must be exactly 137 bytes.
  316.     So you don't need to fill up the rest of the line with blanks.
  317.  
  318.     The only two fields needed are BBS name and phone number. The other
  319.     fields are set to default values of in import phone book entry is
  320.     no value (blanks/spaces).
  321.  
  322.  
  323.     Telix(*) phone book format:
  324.     ---------------------------
  325.  
  326.     ZOCBOOK checks for Telix(*) phone book format version. It works
  327.     with ddfHeader version 1; phone book ID should be hex 02E2B291A.
  328.  
  329.  
  330.     Telemate(#) phone book format:
  331.     ------------------------------
  332.  
  333.     ZOCBOOK works with Telemate(*) version 3.x and 4.0 phone book formats.
  334.     I do not know of any other Telemate phone book format, so, if there
  335.     is one, please let me know. Thanks!
  336.  
  337.  
  338.     FIDO Nodelist format:
  339.     ---------------------
  340.  
  341.     ZOCBOOK works with FIDO NodeList format. Remeber that ZOC can hold
  342.     only 128/200 (v1.00/v1.01) entries in his phone book.
  343.  
  344.  
  345.     Existing ZOC phone book:
  346.     ------------------------
  347.  
  348.     If there exists a ZOC phone book file than ZOCBOOK appends all new
  349.     imported phone book entries to it. If no ZOC phonebook file exists,
  350.     a new one will be created.
  351.  
  352.     If you don't want to append to the ZOC phone book file simply specify
  353.     an other ZOC phone book file name.
  354.  
  355.     SET and DELETE commands copy the matching ZOC phone book entries from
  356.     ZOC phone book file to a temporary file called ZOCBOOK.TMP. After
  357.     ending successfully, the original ZOC phone book file will be erased
  358.     and the temporary file ZOCBOOK.TMP will be renamed to the name of
  359.     the original ZOC phone book file.
  360.  
  361.  
  362.     Converted fields:
  363.     -----------------
  364.  
  365.     The following fields are converted from the Telix(*) phone book
  366.     entry to the ZOC phone book entry:
  367.  
  368.  
  369.       ASCII fields               ZOC fields
  370.       ------------               ----------
  371.  
  372.       (BBS) name                 Name
  373.       phone number               Value
  374.       password                   Autologin and/or Password
  375.       baud rate                  Serial parameters
  376.       data bits                        "
  377.       parity                           "
  378.       stop bits                        "
  379.       emulation                  Emulation
  380.  
  381.       If you want to use the Autlogin feature of ZOC you have to
  382.       change the Autologin field manually or use the /A:YES option.
  383.  
  384.  
  385.       Telix(*) fields            ZOC fields
  386.       ---------------            ----------
  387.  
  388.       (BBS) name                 Name
  389.       password                   Autologin and/or Password
  390.       phone number               Value
  391.       line speed                 Serial parameters
  392.       parity                           "
  393.       data bits                        "
  394.       stop bits                        "
  395.       terminal emulation         Emulation
  396.  
  397.       If you want to use the Autlogin feature of ZOC you have to
  398.       change the Autologin field manually or use the /A:YES option.
  399.  
  400.  
  401.       Telemate(#) fields         ZOC fields
  402.       ------------------         ----------
  403.  
  404.       (BBS) name                 Name
  405.       password                   Autologin and/or Password
  406.       phone number               Value
  407.       line speed                 Serial parameters
  408.       parity                           "
  409.       data bits                        "
  410.       stop bits                        "
  411.       terminal emulation         Emulation
  412.  
  413.       If you want to use the Autlogin feature of ZOC you have to
  414.       change the Autologin field manually or use the /A:YES option.
  415.  
  416.  
  417.       FIDO NodeList fields       ZOC fields
  418.       --------------------       ----------
  419.  
  420.       (BBS) name                 Name
  421.       phone number               Value
  422.  
  423.  
  424. --------------------------------------------------------------------------
  425.     4. VERSION HISTORY
  426. --------------------------------------------------------------------------
  427.  
  428.     v1.00  93/12/31  internal (debugging) use only
  429.     v1.01  93/12/31  first official version
  430.     v1.02  94/01/06  fixed: import command doesn't use /e: parameter,
  431.                             set command sets serial parameter to '-'
  432.                               if no /s: option specified,
  433.                             condition debug output removed,
  434.                             upper/lower case sensitive with condition,
  435.                             ZOC entries filled up completly with 0's.
  436.                      added: FIDO NodeList import,
  437.                             improved i/o speed.
  438.     v1.03  94/03/27  only internal release
  439.                      fixed: set command corrupts data due to internal
  440.                             file buffering (which seems to be buggy).
  441.                      added: Telemate(#) password into ZOC Autologin,
  442.                             /A: option for W1/S1 autologin text (works
  443.                             only with import command).
  444.     v1.04  94/05/07  added: /P: and /C: option.
  445.                      added: password, memo and calldue as conditions.
  446.  
  447.     Future extensions (if requested by ZOCBOOK users):
  448.  
  449.       * german documentation.
  450.       * native OS/2 (text mode) version.
  451.       * other import formats (which one do you miss?).
  452.       * scriptfile and optionfile options.
  453.       * a friendly PM front-end.
  454.  
  455.  
  456. --------------------------------------------------------------------------
  457.     5. ZOC, THANKS
  458. --------------------------------------------------------------------------
  459.  
  460.     GET ZOC! THE BEST COMMUNICATIONS PROGRAM FOR OS/2 2.x I KNOW!
  461.  
  462.     Look for ZOC1xx.ZIP on your preferred OS/2 bbs or get it directly
  463.     from the ZOC Infobbs Support BBS +49-911-9933662 (8N1), log in as
  464.     ZOC.
  465.  
  466.     Thanks to Markus Schmidt, the autor of ZOC, for providing the
  467.     structure of the ZOC's phone book and some wise advice.
  468.     Without his help it would have needed much more efforts to make
  469.     ZOCBOOK work.
  470.  
  471.     Also, I thank him for giving ZOC to the OS/2 community.
  472.  
  473. --------------------------------------------------------------------------
  474.  
  475.  (*) Telix is a trademark of deltaComm Development, USA
  476.  (#) Telemate is a trademark of White River Software, Canada
  477.  (+) Microsoft is a trademark of Microsoft, Inc.
  478.