home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / ttrxid14.lha / TrapTrxID.doc.english < prev    next >
Text File  |  1993-04-07  |  9KB  |  263 lines
  1.  
  2.  
  3.                \\\\\\\\\\\\\\\\\\\\////////////////////
  4.                               TrapTrxID
  5.                                  v1.4
  6.                           Time Synchronizer
  7.  
  8.                              User Manual
  9.  
  10.                                   by
  11.                            Giuseppe Vicari
  12.                        2:331/105.4@Fidonet.Org
  13.                ////////////////////\\\\\\\\\\\\\\\\\\\\
  14.  
  15.  
  16.  
  17.  
  18. ****    Index                                                     Line
  19.  
  20.       . What is it?                                                 38
  21.       . What's this tool for?                                       46
  22.       . Why to use TrapTrxID?                                       55
  23.       . How to use?                                                 79
  24.       . Special notes about TrapDoor?                              124
  25.       . How does it work?                                          137
  26.       . Bugs and troubles?                                         163
  27.       . How to reach me in case of troubles?                       176
  28.       . History of TrapTrxID?                                      184
  29.       . How much is it?                                            219
  30.       . Who I'd like to thank?                                     238
  31.       . How to check out this is the original program?             252
  32.       . End of the document                                        262
  33.  
  34.  
  35. ****    End of the index
  36.  
  37.  
  38. >>>>    What is it?
  39.  
  40.     TrapTrxID is a tiny tool be used in conjunction with TrapDoor.  It
  41. allows  to  syncronize  the  system  clock  by  using  the information
  42. included in TrapDoor log file.  Such information is recorded during an
  43. EMSI connection to the node you want to synchronize with.
  44.  
  45.  
  46. >>>>    What's this tool for?
  47.  
  48.     Some  nodes  may  have  their  system  time  synchronized with the
  49. "famous"  atomic clocks (either by using special devices or connecting
  50. to other nodes.  In this way, you may have your clock set at the right
  51. time.   How connect to the node you want to synchronize with TrapDoor,
  52. then run TrapTrxID and, automagically, you'll get it!
  53.  
  54.  
  55. >>>>    Why to use TrapTrxID?
  56.  
  57.     There  are  a  lot  of  interesting  features  that other existing
  58. programs do not offer, such as:
  59.  
  60.     1. It has been built to be the shortest and fastest program on the
  61.        earth ;-)
  62.  
  63.     2. Full  scanning  of the log file:  it avoids loosing data if the
  64.        last session had been very long.
  65.  
  66.     3. It  tells  the  system  when  a synchronization takes place, by
  67.        writing a line in the log file.
  68.  
  69.     4. It  does  not repeat the synchronization if you run the program
  70.        several times and such a line exists in the log file.
  71.  
  72.     5. It can syncronize the internal clock.
  73.  
  74.     6. It's a PURE program, i.e.  it can be made resident.  This means
  75.        you  can  run  it many times without having to load it from the
  76.        storage memory.
  77.  
  78.  
  79. >>>>    How to use?
  80.  
  81.     TrapTrxID  can  be run either from CLI (from a script file such as
  82. User-StartUp  or  StartUp-Sequence) or just after an EMSI session.  In
  83. this  second way, a synchronization takes place at each session:  this
  84. can  be  done  using  the TrapDoor option AFTERSESSION (look documents
  85. that come along with TrapDoor package).
  86.  
  87.  
  88.     TrapTrxID takes five arguments:
  89.  
  90. 1)  the  file  name of TrapDoor log file (add the path, if necessary);
  91.     you MUST supply this parameter
  92.  
  93. 2)  the  number of the node you want to synchronize with.  If you omit
  94.     this  parameter, TrapTrxID synchronizes with the last node you had
  95.     a EMSI connection with.
  96.  
  97. 3)  the size of the internal buffer
  98.  
  99. 4)  the ASK flag, if you want TrapTrxID to request confirmation before
  100.     setting the clock
  101.  
  102. 5)  the SET flag, if you want to synchronize also the internal clock.
  103.  
  104.     Here it is the string of the parser:
  105.  
  106. "LOGNAME/A,NODE,ASK/S,SET/S,BUFFER/N".
  107.  
  108.  
  109.     Example (from CLI):
  110.  
  111. TrapTrxID Mail:Logs/TrapDoor.log 2:333/100.0
  112.  
  113.     Add  a  line  like  this  one  in  a  script file or use it to run
  114. TrapTrxID from the CLI.
  115.  
  116.     Example (from TrapDoor):
  117.  
  118. AFTERSESSION "TrapTrxID %l 2:333/100.0"
  119.  
  120.     Add a line like this one in TrapDoor configuration file.  TrapDoor
  121. will replace the string %l with the (full) name of the log file.
  122.  
  123.  
  124. >>>>    Special notes about TrapDoor?
  125.  
  126.     This  version  of  TrapDoor  was  developed using and referring to
  127. TrapDoor version 1.83.  Neverthless, previous releases of TrapDoor can
  128. do  as well, as long as they allow the reception of TrxID, Name or AKA
  129. messages  (examine  TrapDoor  documentation to find out wheter this is
  130. case fit to you or not).
  131.  
  132.     TrapDoor configuration file is something I really must talk about.
  133. In  order  to  let TrapTrxID to work properly, it is required a string
  134. LOGLEVEL 8:n (n>2) to appear in the file.
  135.  
  136.  
  137. >>>>    How does it work?
  138.  
  139.     TrapTrxID  search  in  the  log  file for lines like the following
  140. ones:
  141.  
  142. : 26-Dec-92 12:11:01   Name: Nome BBS (2:334/155.0)
  143. : 26-Dec-92 12:11:01    AKA: 2:23331/1.0 3:1/1.0
  144.  
  145. then  it compares the address given as argument with the ones in these
  146. lines.  If they match, it means that the next line of type
  147.  
  148. : 26-Dec-92 12:11:01  TrxID: 2b3c4bd0/2b3c4ad7
  149.  
  150. will  be  good to get the time difference between our system clock and
  151. the   remote   one:   it  evaluate  the  difference  between  the  two
  152. hexadecimal  parameters  on  the  line  just after the keyword TrxID:.
  153. Hence  it  gets the difference (in seconds) between the local node and
  154. the  remote  one.   Of course this operation concern the last session.
  155. After updating the clock, TrapTrxID add a line of kind
  156.  
  157. " 26-Dec-92 12:34:24  TrapTrxID v1.4 Adjusted by -4:09 (3:1/1.0)
  158.  
  159. in  order  to  prevent TrapTrxID from re-updating the time until a new
  160. EMSI session takes place.
  161.  
  162.  
  163. >>>>    Bugs and troubles?
  164.  
  165.     No  known  bugs  exists  or,  at  least, they never showed up till
  166. today.  Though, there is a slim problem:  the program tends to be slow
  167. as  the  log file gets bigger.  This is due to the fact that TrapTrxID
  168. analyzes  the whole file to ensure a right parsing of the log file (Oh
  169. yeah!  There are programs that seem to do the same much faster...  but
  170. are  you  sure  their parsing is not bugged?).  I'd suggest to use the
  171. BUFFER  option if you have got a fast computer or the log file is on a
  172. slow  peripheral:   this  option  increases  the  size of the internal
  173. buffer for the file and reduces the disk accesses.
  174.  
  175.  
  176. >>>>    How to reach me in case of troubles?
  177.  
  178.     In  case  of  troubles  or bugs, you can reach me at the following
  179. e-mail address:
  180.  
  181.                Giuseppe Vicari 2:331/105.4@Fidonet.Org
  182.  
  183.  
  184. >>>>    History of TrapTrxID?
  185.  
  186.     . v1.4 7 Apr 93:
  187.  
  188.         New   coding   using  the  typical  AmigaDOS  functions:   the
  189.     executable  code  got considerably shorter and more efficient; the
  190.     line   parser  is  AmigaDOS  compatible;  changed  the  text  line
  191.     TrapTrxID  writes  in the log file (it's still compatible with the
  192.     older  releases);  added  the BUFFER option; added the ASK and SET
  193.     flags; an english manual is now available.
  194.         Try 'version TrapTrxID' ;-)
  195.  
  196.     . v1.3 31 Jan 93:
  197.  
  198.         Fixed  a bug that caused the computer to crash.  It was not my
  199.         fault, but compiler-optimizer's.
  200.  
  201.     . v1.2 30 Jan 93:
  202.  
  203.         Now  you can avoid specifying the name of the node you want to
  204.     perform  the  synchronization:   it  will  take  the last one.  If
  205.     TrapTrxID  runs from WorkBench, it opens a small window, shows the
  206.     syntax  and  closes  it  after  5  seconds.  Replaced the function
  207.     main() with the _main():  got a shorter code.
  208.  
  209.     . v1.1 22 Jan 93:
  210.  
  211.         Fixed  a  very  insignificant  bug, added an error message and
  212.     optimized some parts of the program.
  213.  
  214.     . v1.0 3 Jan 93
  215.  
  216.         First version.
  217.  
  218.  
  219. >>>>    How much is it?
  220.  
  221.     This  program  is  Freely Distributable and Usable.  Permission is
  222. given  to freely distibute this program provided no fee is charged and
  223. no  changes  or  modification of the code and of the documentation are
  224. made.   In  other  words,  this  is  a  FD (Freely Distributable).  Of
  225. course, I won't be disappointed if you send me any money donation $-).
  226. Furthermore,  I'd  like  get  a  nice  postcard  from your country (oh
  227. well...   a *very* nice postcard!).  Send whatever kind of donation to
  228. the following address:
  229.  
  230.                            Giuseppe Vicari
  231.                              via Torni, 7
  232.                         I-21051 Arcisate (VA)
  233.                                 ITALIA
  234.  
  235.     Thanks in advance for your generosity.
  236.  
  237.  
  238. >>>>    Who I'd like to thank?
  239.  
  240.     I'd like to thank the following people:
  241.  
  242. Matteo Taveggia
  243.     for the revision and english translation of this manual.
  244.  
  245. Flavio Stanchina and Maurizio Frizzo
  246.     for their suggestions.
  247.  
  248. Maximilian Hantsch e Martin J. Laubach
  249.     for their superb programma TrapDoor.
  250.  
  251.  
  252. >>>>    How to check out this is the original program?
  253.  
  254.     In  the  archive  there  is program called CheckFiles.  This is an
  255. useful  tool  to verify that the files in the archive are the original
  256. ones.  After you extracted the files from the archive, from inside the
  257. directory  where  such files are run CheckFiles (it is case-sensitive,
  258. so  type  it paying attention!):  it will automatically tell you which
  259. (if any) files had been altered.
  260.  
  261.  
  262. >>>>    End of the document
  263.