Add diclaimer of copyright to _osname() manual page.
[unix-history] / contrib / xntpd / Config.local.dist
CommitLineData
09169146
GW
1# This is the local configure file (distribution version).
2# You must modify it to fit your particular configuration
3# and name it Config.local
4# The following configuratiions can be auto-generated:
5#
6# make Config.local.green
7# make a Config.local that supports a local clock
8# (i.e. allow fallback to use of the CPU's own clock)
9# make Config.local.NO.clock
10# make a Config.local that supports no clocks
11#
12#
13# NOTE TO GREENHORNS
14#
15# For plug-'n-play and no radios or other complicated gadgetry,
16# use "make Config.local.green" as above.
17#
18# Following defines can be set in the DEFS_OPT= define:
19#
20# The flag -DDEBUG includes some debugging code. To use this, include
21# the define and start the daemon with one or more -d flags, depending
22# on your calibration of pearannoya. The daemon will not detach your
23# terminal in this case. Judicious use of grep will reduce the speaker
24# volume to bearable levels.
25#
26# To change the location of the configuration file, use a
27# -DCONFIG_FILE=\\"/local/etc/ntp.conf\\" or something similar.
28#
29# The -DSYSLOG_FILE defines allows logging messages that are normally
98771864 30# reported via syslog() in a file. The file name can be configured using
09169146
GW
31# the configuration line "logfile <filename>" in CONFIG_FILE.
32#
33# There are three serial port system software interfaces, each of
34# which is peculiar to one or more Unix versions. Define
35# -DHAVE_SYSV_TTYS for basic System V compatibility; define -DSTREAM
36# for POSIX compatibility including System V Streams, and
98771864
GW
37# HAVE_BSD_TTYS for 4.3bsd compatibility.
38# Use HAVE_TERMIOS for POSIX (termios.h) without System V Streams.
39# Only one of these three should be defined. If none are defined,
40# HAVE_BSD_TTYS is assumed.
09169146
GW
41# Usually these defines are already set correctly.
42#
43DEFS_OPT=-DDEBUG
44
45#
46# The DEFS_LOCAL define picks up all flags from DEFS_OPT (do not delete that)
47# and one of the following:
48#
49# The flag -DREFCLOCK causes the basic reference clock support to be
50# compiled into the daemon. If you set this you may also want to
51# configure the particular clock drivers you want in the CLOCKDEFS= line
52# below. This flag affects xntpd only. This define is included by
53# default when using the "make makeconfig" script.
54#
55# The next two sets of defines are meaningful only when radio clock
56# drivers or special 1-pps signals are to be used. For systems without
57# these features, these delicious complexities can be avoided. Ordinarily,
58# the "make makeconfig" script figures out which ones to use, but your
59# mileage may vary.
60#
61# There are three ways to utilize external 1-pps signals. Define
62# -DPPS to include just the pps routine, such as used by the DCF77(PARSE)
63# clock driver. Define -DPPSCLK to include a serial device driver
64# which avoids much of the jitter due to upper level port
65# processing. This requires a dedicated serial port and either the
66# tty_clock line discipline or tty_clk_streams module, both of
67# which are in the ./kernel directory. Define -DPPSCD to include a
68# special driver which intercepts carrier-detect transitions
69# generated by the pps signal. This requires a nondedicated serial
70# port and the ppsclock streams module in the ./kernel directory.
71# Only one of these three flags should be defined.
72#
73# The flag KERNEL_PLL causes code to be compiled for a special feature of
74# the kernel that (a) implements the phase-lock loop and (b) provides
75# a user interface to learn time, maximum error and estimated error.
76# See the file README.kern in the doc directory for further info.
77# This code is activated only if the relevant kernel features have
78# been configured; it does not affect operation of unmodified kernels.
79# To compile it, however, requires a few header files from the
80# special distribution.
81#
82# Note: following line must always start with DEFS_LOCAL= $(DEFS_OPT)
83DEFS_LOCAL= $(DEFS_OPT) #GREEN -DREFCLOCK #TEST -DPPSPPS -DKERNEL_PLL
84
85#
86# Radio clock support definitions (these only make sense if -DREFCLOCK
87# used), which is normally the case. Note that a configuration can include
88# no clocks, more than one type of clock and even multiple clocks of the
89# same type.
90#
91# For most radio clocks operating with serial ports, accuracy can
92# be considerably improved through use of the tty_clk line
93# discipline or tty_clk_STREAMS streams module found in the
94# ./kernel directory. These gizmos capture a timestamp upon
95# occurrence of an intercept character and stuff it in the data
96# stream for the clock driver to munch. To select this mode,
97# postfix the driver name with the string CLK; that is, WWVB
98# becomes WWVBCLK. If more than one clock is in use, the CLK
99# postfix can be used with any or all of them.
100#
101# Alternatively, for the best accuracy, use the ppsclock streams
102# module in the ./ppsclock directory to steal the carrier-detect
103# transition and capture a precision timestamp. At present this
104# works only with SunOS 4.1.1 or later. To select this mode,
105# postfix the driver name with the string PPS; that is, AS2201
106# becomes AS2201PPS. If more than one clock is in use, the PPS
107# postfix should be used with only one of them. If any PPS
108# postfix is defined, the -DPPSPPS define should be used on the
109# DEFS above.
110#
111# Define -DLOCAL_CLOCK for a local pseudo-clock to masquerade as a
112# reference clock for those subnets without access to the real thing.
113# Works in all systems and requires no hardware support. This is defined
114# by default when using the "make makeconfig" script and greenhorn
115# configuraiton.
116#
117# Define -DPST for a PST/Traconex 1020 WWV/H receiver. The driver
118# supports both the CLK and PPS modes. It should work in all systems
119# with a serial port.
120#
121# Define -DWWVB for a Spectracom 8170 or Netclock/2 WWVB receiver. It
122# should work in all systems with a serial port. The driver supports
123# both the CLK and PPS modes if the requisite kernel support is installed.
124#
125# Define -DCHU for a special CHU receiver using an ordinary shortwave
126# radio. This requires the chu_clk line discipline or chu_clk_STREAMS
127# module in the ./kernel directory. At present, this driver works only
128# on SunOS4.1.x; operation in other systems has not been confirmed.
129# Construction details for a suitable modem can be found in the ./gadget
130# directory. The driver supports # neither the CLK nor PPS modes.
131#
132# Define -DPARSE for a DCF77/GPS(GENERIC) receiver. For best performance
133# this requires a special parsestreams STREAMS (SunOS 4.x) module in the
134# ./parse directory. Define -DPARSEPPS for PPS support via the
135# DCF77/GPS (GENERIC) receiver; also, define -DPPS in the DEFS above.
136# Define: -DCLOCK_MEINBERG for Meinberg clocks
137# -DCLOCK_SCHMID for Schmid receivers
138# -DCLOCK_DCF7000 for ELV DCF7000
139# -DCLOCK_RAWDCF for simple receivers (100/200ms pulses on Rx)
140# -DCLOCK_TRIMSV6 for Trimble SV6 GPS receiver
141#
142# Define -DMX4200PPS for a Magnavox 4200 GPS receiver. At present, this
143# driver works only on SunOS4.1.x with CPU serial ports only. The PPS
144# mode is required.
145#
146# Define -DAS2201 for an Austron 2200A or 2201A GPS receiver. It should
147# work in all systems with a serial port. The driver does not support the
148# CLK mode, but does support the PPS mode. If the radio is connected to
149# more than one machine, the PPS mode is required.
150#
151# Define -DGOES for a Kinemetrics/TrueTime 468-DC GOES receiver. This
152# driver is known to work with some other TrueTime products as well,
153# including the GPS-DC GPS receiver. It should work in all systems with
154# a serial port. The driver does not support the CLK mode, but does
155# support the PPS mode.
156#
98771864
GW
157# Define -DGPSTM for a Kinemetrics/TrueTime GPS-TM/TMD receiver. It
158# should work in all systems with a serial port.
159#
09169146
GW
160# Define -DOMEGA for a Kinemetrics/TrueTime OM-DC OMEGA receiver. It
161# should work in all systems with a serial port. The driver does not
162# support the CLK mode, but does support the PPS mode.
163#
164# Define -DTPRO for a KSI/Odetics TPRO-S IRIG-B timecode reader. This
165# requires the SunOS interface driver available from KSI. The driver
166# supports neither the CLK nor PPS modes.
167#
168# Define -DLEITCH for a Leitch CSD 5300 Master Clock System Driver for
169# the HP 5061B Cesium Clock. It should work in all systems with a serial
170# port. The driver does not support the CLK mode, but does support the
171# PPS mode.
172#
173# Define -DMSFEESPPS for an EES M201 MSF receiver. It currently only works
174# under SunOS 4.x with the PPSCD (ppsclock) STREAMS module, but the RCS
175# files on cl.cam.ac.uk still has support for CLK and CBREAK modes.
176#
177# Define -DIRIG for a IRIG-B timecode timecode using the audio codec of
178# the Sun SPARCstations. This requires a modified BSD audio driver and
179# exclusive access to the audio port. A memo describing how it works and
180# how to install the driver is in the README.irig file in the ./doc
181# directory.
182#
183# Note: The following defines result in compilation of all the above radio
184# clocks. This works on a Sun 4.1.x system which has tty_clk, chu_clk and
185# ppsclock STREAMS modules installed. If the trailing CLK and PPS suffixes
186# are removed and the IRIG, PARSE* and CLOCK* deleted, all of the rest compile
187# under Ultrix 4.2a/3. If the MX4200 is removed, all the rest compile on a DEC
188# OSF/1 Alpha.
189#
190CLOCKDEFS= #GREEN -DLOCAL_CLOCK #TEST -DAS2201PPS -DCHU -DGOES -DIRIG -DMX4200PPS -DOMEGA -DPST -DPSTCLK -DTPRO -DWWVBCLK -DMSFEESPPS -DLEITCH -DPARSE -DPARSEPPS -DCLOCK_MEINBERG -DCLOCK_RAWDCF -DCLOCK_SCHMID -DCLOCK_DCF7000 -DCLOCK_TRIMSV6
191
192#
193# Directory into which binaries should be installed (default /usr/local)
194#
195BINDIR= /usr/local/bin