Networking/Utils/NTPSync/NTPSync.txt

   1
   2                         NTPSync V2.3 (03-Feb-2006)
   3
   4
   5 1. INTRODUCTION
   6
   7 Network Time Protocol (NTP) is a protocol for synchronizing clocks in the
   8 Internet. NTPSync is a program that adjusts your Amiga's clock according
   9 to a specified NTP server. Plese see http://www.eecis.udel.edu/~ntp for
  10 more information on NTP and a list of public NTP servers worldwide.
  11
  12
  13 2. REQUIREMENTS
  14
  15 - an Amiga with a kickstart V37 (2.0) or higher (only tested with 3.x),
  16   or a PPC-Amiga with AmigaOS 4.x or MorphOS 1.x
  17 - an AmiTCP 4.0 compatible TCP/IP stack (like Miami, AmiTCP, Genesis,
  18   Roadshow (OS4) or MOSNet (MOS))
  19
  20
  21 3. USAGE
  22
  23 Please read the Disclaimer-section before installing the program.
  24
  25 Select the appropriate binary and rename it into "NTPSync", while
  26 copying it to your disk.
  27 - NTPSync_68k: AmigaOS 2.x/3.x 68k-version
  28 - NTPSync_OS4: AmigaOS 4.x PPC-version
  29 - NTPSync_MOS: MorphOS 1.x PPC-version
  30
  31 Usage: NTPSync [options] <1st server>[:port] [2nd server][:port] [...]
  32
  33 Where options is one or more of the following:
  34    -h          = Print a quick help.
  35
  36    -v          = Turn on verbose mode. Causes NTPSync to print some messages
  37                  while sending the requests and more information about the
  38                  server it connected, and the offset it set the clock and
  39                  the roundtrip delay.
  40
  41    -c          = Set the battery-clock as well as the system clock, no need
  42                  for "SetClock SAVE" anymore.
  43
  44    -d<UTCDiff> = Difference from UTC (= GMT) in minutes.
  45
  46    -t<timeout> = Time to wait for replies in seconds.
  47                  Note that this timeout doesn't work work for the name-server,
  48                  so you might prefer to specifiy the IP address instead.
  49
  50 For example, to set your clock according to nic.funet.fi, you would use the
  51 following line:
  52
  53 NTPSync nic.funet.fi
  54
  55 Or if your locale.library is lying about the UTC offset, which is +2 hours:
  56
  57 NTPSync -d120 nic.funet.fi
  58
  59 Or to set the time according to ntp1.hut.fi or ntp2.hut.fi, whichever replies
  60 first:
  61
  62 NTPSync ntp1.hut.fi ntp2.hut.fi
  63
  64
  65 4. COMPILING
  66
  67 The current version is no longer compiled with SAS/C but with vbcc 0.8i
  68 (using SAS/C for the 68k-version should still work, though). Use the
  69 supplied Makefile to generate versions for all architectures.
  70
  71
  72 5. KNOWN BUGS
  73
  74 There is a problem with the Daylight Saving Time. The time is set incorrectly
  75 when the DST is in use. You must use the -d option to fix the problem
  76 manually. If you have an idea on how to make this better, please send me
  77 some mail.
  78
  79 Also, I wasn't quite sure how to use the battery.resource. I can open it OK,
  80 but I don't know if it should be closed too somehow. Anyway, it shouldn't
  81 cause any trouble.
  82
  83
  84 6. THE AUTHOR
  85
  86 If you find any bugs, have any ideas, have trouble with the program, want
  87 to say your opinion on it etc., don't hesitate to contact me by email or
  88 normal post. You can also get the newest version directly from me. A simple
  89 NTP server program is also in work (or actually I made one already for
  90 debugging NTPSync).
  91
  92 Any feedback is welcome!
  93
  94 Snail-mail: Heikki Linnakangas   (if you can't use E-Mail)
  95             Porvoonkatu 19 A 25
  96             00510 Helsinki
  97             Finland
  98
  99 EMail: Heikki.Linnakangas@iki.fi (the better way)
 100
 101 Check my WWW page at http://www.iki.fi/~hlinnaka for my PGP public key, if
 102 you prefer encrypting your mail.
 103
 104 Author of the OS4 and MorphOS ports:
 105    Frank Wille
 106    EMail: frank@phoenix.owl.de
 107
 108
 109 7. HISTORY
 110
 111 --- V2.3  - ported to AmigaOS4 and MorphOS (Frank Wille).
 112
 113 --- V2.2  - now supports multiple servers
 114           - added the verbose option
 115           - added the timeout option
 116           - can now set the battery-backed clock too
 117           - changed a bit the way the roundtrip delay is calculated
 118           - some other minor changes in the source code
 119           - some changes to the documentation
 120           - the documentation is now .txt, not .doc
 121
 122 --- V2.1  - fixed the date, was one day behind. I thought I fixed that in
 123             an older version already, but now it should be fixed for real
 124
 125 --- V2.0  - fixed a bug that caused the clock run very fast sometimes
 126           - now tries to use another port if 123 is already in use
 127           - now asks the local.library for the UTC diff if not given
 128           - some other minor changes
 129           - now takes the network delay into account
 130
 131 --- V1.1  - added version information for the 'version' command
 132           - added some integrity checks to the reply
 133           - added support for different ports
 134           - now prints stratum of the server when time is set
 135           - added the COMPILATION-section to the document
 136           - better error handling
 137           - fixed a small bug in receiving the reply
 138           - fixed the version number in the document
 139           - date was set incorrectly
 140           - file lengths were incorrect in the document
 141
 142 --- V1.0  - the initial release
 143
 144
 145 8. DISCLAIMER
 146
 147 THE AUTHOR IS NOT LIABLE IN ANY WAY FOR ANY DAMAGE ARISING OUT OF
 148 THE USE OR INABILITY TO USE THE PROGRAM. USE AT YOUR OWN RISK.
 149
 150 This program is FreeWare. You may use and distribute it unless told to not
 151 do so by the author. You may charge a nominal fee to recover distribution
 152 costs. The distribution fee must not exceed 15 FIM nor 3 USD + distribution
 153 expenses. The distribution of an incomplete or changed package is prohibited.
 154
 155 This program may be included in commercial magazines or archives, if a free
 156 copy is sent to the author, or the author is given free access to the archive.
 157
 158 You may copy and distribute this package, as long as the contents of the
 159 package are not changed in any way. The package must include the following
 160 files:
 161
 162   Makefile
 163   NTPSync
 164   NTPSync.txt
 165   NTPSync.c
 166
 167 Distribution of modified versions of any of the files is forbidden. If you
 168 make any enhancements to program, please send the source code to me, and
 169 I will make a new release.