docs/build.adoc

   1 = Building and Installing the Distribution
   2 include::include-html.ad[]
   3
   4 [cols="10%,90%",frame="none",grid="none",style="verse"]
   5 |==============================
   6 |image:pic/beaver.gif[]|
   7 {millshome}pictures.html[from 'Pogo', Walt Kelly]
   8
   9 For putting out compiler fires.
  10
  11 |==============================
  12
  13 == Related Links
  14
  15 include::includes/install.adoc[]
  16
  17 == Table of Contents
  18
  19 * link:#waf[Autoconf has been replaced with waf]
  20 * link:#build[Building and Installing the Distribution]
  21 * link:#unix[Building and Installing for Unix]
  22 * link:#conf[Configuration]
  23 * link:#prob[If You Have Problems]
  24 * link:#additional[Additional +waf+ Commands]
  25
  26 '''''
  27
  28 [[waf]]
  29 === Autoconf has been replaced with waf
  30
  31 The autoconf build system used in NTP Classic has been replaced with
  32 waf, a more modern and much faster build engine.  It is not necessary
  33 to install any separate waf package; the build engine is a Python
  34 script included in your NTPsec distribution.
  35
  36 [[build]]
  37 == Building and Installing the Distribution
  38
  39 It is not possible in a software distribution such as this to support
  40 every individual computer and operating system with a common
  41 executable, even with the same system but different versions and
  42 options. Therefore, it is necessary to configure, build and install
  43 for each system and version. In almost all cases, these procedures are
  44 completely automatic, The user types +./waf configure+, +./waf build+,
  45 and +./waf install+ in that order and the build system does the
  46 rest. There are some exceptions, as noted below.
  47
  48 This page provides only a general introduction to building the code.
  49 Please consult the INSTALL file in the distribution root for the
  50 most detailed information on build-time dependencies and configuration
  51 options.
  52
  53 [[unix]]
  54 == Building and Installing for Unix
  55
  56 This distribution uses common compilers and tools that come with most
  57 Unix distributions. Not all of these tools exist in the standard
  58 distribution of modern Unix versions (compilers are likely to be an
  59 add-on product). If this is the case, consider using the GNU tools and
  60 +gcc+ compiler included as freeware in some systems. For a successful
  61 build, all of these tools should be accessible via the current path.
  62
  63 The first thing to do is uncompress the distribution and extract the
  64 source tree. In the distribution base directory use the
  65 +./waf configure+ command to perform an automatic configuration procedure.
  66 This command inspects the hardware and software environment and
  67 configures the build process accordingly. Use the +./waf build+ command to
  68 compile and link the distribution and the +./waf install+ command to install
  69 the executables by default in +/usr/local/bin+. It may be necessary to run
  70 +ldconfig+ on Linux systems if using the FFI library (default).
  71
  72 [[conf]]
  73 == Configuration
  74
  75 You are now ready to configure the daemon. You will need to create an NTP
  76 configuration file by default in +{ntpconfpath}+. Newbies should see the
  77 link:quick.html[Client Quick Start Guide].  Seasoned
  78 veterans can start with the link:ntpd.html[+ntpd+ - Network Time Protocol
  79 (NTP) Daemon] and link:ntp_conf.html[+ntpd+ Configuration File] pages and
  80 move on to the specific configuration option pages.
  81
  82 [[prob]]
  83 == If You Have Problems
  84
  85 If you have problems with your hardware and software environment,
  86 a tutorial on debugging technique is in
  87 the link:debug.html[NTP Debugging Technique] page. A list of important
  88 system log messages is on the link:msyslog.html[+ntpd+ System Log
  89 Messages] page.
  90
  91 The first line of general assistance is the NTPsec web site
  92 {project-weblink} and the helpful documents resident
  93 there. Requests for assistance of a general nature and of interest to
  94 other timekeepers should be sent to the NTP newsgroup
  95 comp.protocols.time.ntp.
  96
  97 Users are invited to report bugs and offer suggestions via the
  98 link:bugs.html[NTP Bug Reporting Procedures] page.
  99
 100 [[additional]]
 101 == Additional +waf+ commands
 102
 103 +./waf clean+::
 104   Cleans out object files, programs and temporary files.
 105 +./waf distclean+::
 106   Removes the build directory.
 107
 108 '''''
 109
 110 include::includes/footer.adoc[]