/contrib/ntp/README

https://bitbucket.org/freebsd/freebsd-head/ · #! · 148 lines · 105 code · 43 blank · 0 comment · 0 complexity · 7dd379b684be69bcbe5b611c7c832e1c MD5 · raw file

  1. Submit patches, bug reports, and enhancement requests via
  2. http://bugs.ntp.org
  3. The ntp Distribution Base Directory
  4. This directory and its subdirectories contain the Network Time Protocol
  5. Version 4 (NTP) distribution for Unix and Windows/NT systems. This release
  6. may still work on VxWorks, too.
  7. The contents of the base directory are given in this file. The contents of
  8. subdirectories are given in the README files in each subdirectory.
  9. A complete explanation of the configure, compile and install process, as
  10. well as setting up an NTP subnet, is in the HTML pages in the ./html/
  11. directory. For more information on NTP and how to get a working setup,
  12. read WHERE-TO-START.
  13. For Windows/NT, visit html/build/hints/winnt.html .
  14. The base directory ./ contains the autoconfiguration files, source
  15. directories and related stuff:
  16. COPYRIGHT Excerpt from the HTML file ./html/copyright.html. This file
  17. specifies copyright conditions, together with a list of
  18. major authors and electric addresses.
  19. INSTALL Generic installation instructions for autoconf-based programs.
  20. Unless you really know what you are doing, you should read the
  21. directions in the HTML pages, starting with ./html/index.html.
  22. NEWS What's new in this release.
  23. README This file.
  24. README.bk Instructions for folks who use the BitKeeper-repository
  25. version of NTP.
  26. README.hackers Notes to folks who want to hack on the code.
  27. TODO List of items the NTP developers are working on.
  28. WHERE-TO-START Hints on what to read in order to get a working
  29. configuration.
  30. Makefile.am Automake file configuration file. Edit only if you have the
  31. GNU automake and autoconf utilities installed.
  32. Makefile.in Autoconf make file template for Unix.
  33. adjtimed Directory containing the sources for the adjtime daemon
  34. for HP/UX systems prior to HP-UX 10.0.
  35. authstuff Directory containing sources for miscellaneous programs
  36. to test, calibrate and certify the cryptographic
  37. mechanisms for DES and MD5 based authentication. These
  38. programs do not include the cryptographic routines
  39. themselves, so are free of U.S. export restrictions.
  40. build A script to build the distribution in A.`config.guess`
  41. subdirectory (more or less).
  42. clockstuff Directory containing sources for miscellaneous programs
  43. to test certain auxiliary programs used with some kernel
  44. configurations, together with a program to calculate
  45. propagation delays for use with radio clocks and
  46. national time dissemination services such as WWV/WWVH,
  47. WWVB and CHU.
  48. conf Directory containing a motley collection of
  49. configuration files for various systems. For example only.
  50. config.guess Script used to identify the machine architecture and
  51. operating system.
  52. config.h.in Configuration file generated automatically from
  53. configure.in. Do not edit.
  54. configure Script used to configure the distribution. See the HTML pages
  55. (./html/index.html) for a complete description of the options
  56. available.
  57. configure.in Master configuration template. Edit only if you have the
  58. GNU automake and autoconf utilities installed.
  59. dot.emacs C-mode indentation rules for code "Just the way Dave likes it".
  60. flock_build (UDel only) Build the distribution on a number of
  61. different platforms.
  62. html Directory containing a complete set of documentation on
  63. building and configuring a NTP server or client. The
  64. documentation is in the form of HTML files suitable for
  65. browsing and contains links to additional documentation
  66. at various web sites. If a browser is unavailable, an
  67. ordinary text editor can be used.
  68. include Directory containing include header files used by most
  69. programs in the distribution.
  70. install-sh Script to install a program, script or data file.
  71. kernel Directory containing sources for kernel programs such as
  72. line disciplines and STREAMS modules used with the CHU
  73. decoder and precision PPS signals.
  74. libntp Directory containing library source code used by most
  75. programs in the distribution.
  76. ntpdate Directory containing sources for a program to set the
  77. local machine time from one or more remote machines
  78. running NTP. Operates like rdate, but much more accurate.
  79. ntpq Directory containing sources for a utility program to
  80. query local and remote NTP peers for state variables and
  81. related timekeeping information. This program conforms
  82. to Appendix A of the NTP Version 3 Specification RFC 1305.
  83. ntptrace Directory containing sources for a utility program that
  84. can be used to reveal the chain of NTP peers from a
  85. designated peer to the primary server at the root of the
  86. timekeeping subnet.
  87. parse Directory containing files belonging to the generic
  88. parse reference clock driver. For reasonably simple
  89. clocks it is possible to get away with about 3-4Kb of
  90. code. additionally the SunOS 4.x/Solaris 5.3 streams
  91. module for parse squats here.
  92. patches Directory containing patches already applied to this
  93. distribution. These are included for record and to help
  94. in possible porting problems.
  95. scripts Directory containing scripts to build the configuration
  96. files in this directory and then the makefiles used in
  97. various dependent directories. the subdirectories
  98. monitoring and support hold various perl and shell
  99. scripts for visualizing synchronization and daemon startup.
  100. stamp.h.in Configuration file generated automatically from configure.in.
  101. Do not edit.
  102. util Directory containing sources for various utility and
  103. testing programs.
  104. David L. Mills (mills@udel.edu)
  105. 21 June 1998