Updated README

This commit is contained in:
Carsten Larsen 2016-08-19 19:06:37 +00:00
parent d0534b7299
commit c1354f1524
1 changed files with 19 additions and 13 deletions

View File

@ -1,7 +1,7 @@
Ntimed -- Network Time Synchronization
======================================
## Introduction
### Introduction
Ntimed is a network time synchronization client for the Amiga. It is based on the Ntimed free and open-source software by Poul-Henning Kamp, sponsored by the Linux Foundation.
@ -9,13 +9,15 @@ It uses the NTP protocol to synchronize the local Amiga clock to a set of networ
Time servers operate using GMT. Ntimed supports the Amiga Time Zone Database. Local GMT offset will be used if no time zone is selected.
## Reference
### Reference
Format
NTIMED [PARAM <parameter>] [TRACEFILE <file>] {servers} [SYNC] [SAVE] [SHOW] [QUIET]
#### Format
Template
P=PARAM/K,T=TRACEFILE/K,SERVERS/M/A,SYNC/S,SAVE/S,SHOW/S,QUIET/S
NTIMED [PARAM <parameter>] [TRACEFILE <file>] {servers} [SYNC] [SAVE] [SHOW] [QUIET]
#### Template
P=PARAM/K,T=TRACEFILE/K,SERVERS/M/A,SYNC/S,SAVE/S,SHOW/S,QUIET/S
PARAM are used to show and set internal Ntimed parameters. A list of parameters will be shown when using question mark. TRACEFILE can be specified to write a full blow-by-blow trace file for analysis and debugging. {servers} is a list of NTP time servers.
@ -23,31 +25,35 @@ SYNC will tell Ntimed to spent 5-10 seconds synchronizing and then exit. If SAVE
NTIMED can be stopped with CTRL C.
Synchronize to NTP servers
#### Synchronize to NTP servers
NTIMED ntp1.example.com ntp2.example.com
Synchronize to single NTP server and put trace in RAM:
#### Synchronize to single NTP server and put trace in RAM:
NTIMED TRACEFILE=RAM:trace ntp1.example.com
Synchronize to single NTP server with modified parameters and put trace in T:
#### Synchronize to single NTP server with modified parameters and put trace in T:
NTIMED P "foo=20,poll_rate=25" T T:trace ntp7.example.com
Synchronize 10 seconds to single NTP server and save result to RTC
#### Synchronize 10 seconds to single NTP server and save result to RTC
NTIMED ntp4.example.com SYNC SAVE
## Public available timeservers
### Public available timeservers
A list of public available timeservers from [support.ntp.org](http://support.ntp.org/bin/view/Servers/StratumTwoTimeServers)
Instructions on how to use NTP pool servers are at [www.pool.ntp.org](http://www.pool.ntp.org/)
## How to compile
### How to compile
Pull the source code over to the machine you want to play on, and::
sh configure AMIGA (or sh configure AROS)
make
## Ntimed Project
### Ntimed Project
The official Ntimed project is hosted by [Network Time Foundation](http://nwtime.org/projects/ntimed)