@database ntimed.guide
@author Carsten Larsen
@(c) Carsten Larsen
@$VER: ntimed.guide 1.04 (25.07.2015)
@node Main "User manual"
@title "Ntimed user manual"

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.

It uses the NTP protocol to synchronize the local Amiga clock to a set of 
network servers. Public available NTP servers are reachable through the 
Internet.


    @{"Reference    " link "Reference"} How to use Ntimed
    @{"Timeservers  " link "Timeservers"} Where to find a timeserver
    @{"Online docs  " link "Online"} More information online


Ntimed for the Amiga conforms only with IPv4 networks. Your Amiga needs to be
connected to a network and to have an IPv4 address.

Time servers operate using GMT. Ntimed supports the Amiga Time Zone Database.
Local GMT offset will be used if no time zone is selected.

@endnode
@node Reference "Ntimed reference"
@title "Ntimed reference"

@{b}Format@{ub}
   NTIMED [PARAM <parameter>] [TRACEFILE <file>] {servers} [SYNC] [SAVE]
          [SHOW] [QUIET]

@{b}Template@{ub}
   P=PARAM/K, T=TRACEFILE/K, SERVERS/M/A, SYNC/S, SAVE/S, SHOW/S, QUIET/S

PARAM is 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.

SYNC will tell Ntimed to spent 5-10 seconds synchronizing and then exit. If
SAVE is specified time will be save to the real-time clock (RTC) upon exit.
SHOW will display extended debugging information in the shell.

NTIMED can be stopped with CTRL C.

@{b}Examples@{ub}

Synchronize to NTP servers:
NTIMED ntp1.example.com ntp2.example.com

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:
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:
NTIMED ntp4.example.com SYNC SAVE

@endnode
@node Timeservers "Timeservers"
@title "Timeservers"

@{b}Public available timeservers@{ub}

A list of public available timeservers from ntp.org:
http://support.ntp.org/bin/view/Servers/StratumTwoTimeServers

Instructions of how to use NTP pool servers are at:
http://www.pool.ntp.org/

@endnode
@node Online "Online information"
@title "Online information"

The Ntimed main repository is located at Github:
https://github.com/bsdphk/Ntimed

Poul-Henning Kamp maintains a blog about this project here:
http://phk.freebsd.dk/time

The Amiga and AROS repository is located at:
https://github.com/llsth/Ntimed

Amiga Time Zone Database:
http://aminet.net/package/util/time/tz

Amiga and AROS versions are independent from the official
Ntimed FOSS project.

@endnode