README.adoc

   1 = The NTPsec distribution base directory =
   2
   3 This directory and its subdirectories contain NTPSec, a
   4 security-hardened implementation of Network Time Protocol Version 4.
   5 You can browse a summary of differences from legacy NTP here:
   6
   7 https://docs.ntpsec.org/latest/ntpsec.html
   8
   9 The contents of the base directory are given in this file. The contents of
  10 subdirectories are usually given in the README files in each subdirectory.
  11
  12 The base directory ./ contains the configuration files, source
  13 directories and related stuff:
  14
  15 INSTALL.adoc::  Generic installation instructions.
  16
  17 NEWS.adoc::     What's new in this release.
  18
  19 README.adoc::   This file.
  20
  21 LICENSES/::     License texts in REUSE format. See http://reuse.software
  22
  23 VERSION::       The version stamp, to be used by scripts and programs.
  24
  25 attic/::        Directory containing source code that is *not* part of a
  26                 normal installation. Things can disappear from here at any
  27                 time.
  28
  29 buildprep::     Executable script for fetching installation prerequisites.
  30
  31 contrib/::      Directory containing contributed scripts, dragons dwell here.
  32                 Some of this might eventually move to being supported code.
  33
  34 devel/::        Documentation and small tools aimed at developers.
  35                 Includes a hacking guide and a tour of the internals.
  36
  37 docs/::         Directory containing a complete set of documentation on
  38                 building and configuring a NTP server or client. The files
  39                 are in asciidoc markup.  This replaces the 'html' directory
  40                 of previous versions, but html can be generated from it.
  41
  42 etc/::          Directory containing a motley collection of configuration files
  43                 and launch scripts for various systems. For example
  44                 only.
  45
  46 include/::      Directory containing include header files used by most
  47                 programs in the distribution.
  48
  49 libjsmn/::      A minimal JSON library used by the GPSD-JSON driver.
  50
  51 libntp/::       Directory containing library source code used by most
  52                 programs in the distribution.
  53
  54 libparse/::     This directory contains the files making up the parser for
  55                 the parse refclock driver. For reasonably sane clocks
  56                 this refclock drivers allows a refclock implementation
  57                 by just providing a conversion routine and the
  58                 appropriate NTP parameters
  59
  60 ntpclients/::   Directory containing sources for clients - utility programs
  61                 to query local and remote NTP installations for log status,
  62                 state variables, and other timekeeping information.  The term
  63                 "clients" is used quite loosely here; any tool that is not a
  64                 multi-file C program probably lives in this directory.
  65
  66 ntpd/::         Sources for the main time-synchronization daemon.
  67
  68 ntpfrob/::      The ntpfrob utility collects several small diagnostic
  69                 functions for reading and tweaking the local clock
  70                 hardware, including reading the clock tick rate,
  71                 precision, and jitter.
  72
  73 ntptime/::      Directory containing a utility for reading and modifying
  74                 kernel parameters related to the local clock.
  75
  76 packaging/::    Parts and guidance for distribution packagers.
  77
  78 pylib/::        Installable Python helper modules for scripts.
  79
  80 tests/::        Self-test code.
  81
  82 waf::           A copy of the waf builder.  This is the engine used to configure
  83                 and build the codebase.
  84
  85 wafhelpers/::   A library of Python procedures used by the waf build system.
  86
  87 wscript::       NTP-specific waf rules.
  88
  89 www/::          Sample ntpviz files
  90
  91 // end