Updated documentation
This commit is contained in:
parent
b5ac372061
commit
c76afd960d
27
README.rst
27
README.rst
|
@ -8,37 +8,34 @@ Ntimed is a network time synchronization client for the Amiga. It is based on th
|
|||
|
||||
It uses the NTP protocol to synchronize the local Amiga clock to a set of network server. Public available NTP servers are reachable through the Internet. Ntimed for the Amiga conforms only to 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.
|
||||
|
||||
Reference
|
||||
~~~~~~~~~
|
||||
|
||||
Format
|
||||
NTIMED [PARAM <parameter>] [TRACEFILE <file>] [TIMEZONE <zone>] {servers} [SYNC] [SAVE] [QUIET]
|
||||
NTIMED [PARAM <parameter>] [TRACEFILE <file>] {servers} [SYNC] [SAVE] [SHOW] [QUIET]
|
||||
|
||||
Template
|
||||
P=PARAM/K,T=TRACEFILE/K,Z=TIMEZONE/K,SERVERS/M,SYNC/S,SAVE/S,QUIET/S
|
||||
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.
|
||||
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.
|
||||
|
||||
TIMEZONE is used to specify local time zone. If no value is given, time will be synchronized to Coordinated Universal Time (UTC). A list of parameters will be shown when using question mark. {servers} is a list of NTP time servers.
|
||||
|
||||
SYNC will tell Ntimed to spend 5-10 seconds synchronizing and then exit. If SAVE is specified, time will be saved to the real-time clock (RTC) upon exit.
|
||||
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.
|
||||
|
||||
Example 1
|
||||
Synchronize to NTP servers
|
||||
NTIMED ntp1.example.com ntp2.example.com
|
||||
|
||||
Example 2
|
||||
NTIMED TRACEFILE=RAM:trace TIMEZONE=CEST ntp1.example.com
|
||||
Synchronize to single NTP server and put trace in RAM
|
||||
NTIMED TRACEFILE=RAM:trace ntp1.example.com
|
||||
|
||||
Example 3
|
||||
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
|
||||
|
||||
Example 4
|
||||
NTIMED Z EST ntp4.example.com SYNC
|
||||
|
||||
Example 5
|
||||
NTIMED Z=?
|
||||
Synchronize 10 seconds to single NTP server and save result to RTC
|
||||
NTIMED ntp4.example.com SYNC SAVE
|
||||
|
||||
Public available timeservers
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
|
@ -23,7 +23,7 @@ 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.
|
||||
Locale GMT offset will be used if no time zone is selected.
|
||||
Local GMT offset will be used if no time zone is selected.
|
||||
|
||||
@endnode
|
||||
@node Reference "Ntimed reference"
|
||||
|
|
Loading…
Reference in New Issue