Invoking ntpdsim
================

This program has no explanation.

This section was generated by AutoGen, the aginfo template and the option descriptions for the ntpdsim program.  It documents the ntpdsim usage text and option meanings.

This software is released under a specialized copyright license.

ntpdsim usage help (-?)
-----------------------

This is the automatically generated usage text for ntpdsim:

     ntpd - NTP daemon program - Ver. 4.2.5p247-RC
     USAGE:  ntpdsim [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
       Flg Arg Option-Name    Description
        -4 no  ipv4           Force IPv4 DNS name resolution
                                     - prohibits these options:
                                     ipv6
        -6 no  ipv6           Force IPv6 DNS name resolution
                                     - prohibits these options:
                                     ipv4
        -a no  authreq        Require crypto authentication
                                     - prohibits these options:
                                     authnoreq
        -A no  authnoreq      Do not require crypto authentication
                                     - prohibits these options:
                                     authreq
        -b no  bcastsync      Allow us to sync to broadcast servers
        -c Str configfile     configuration file name
        -d no  debug-level    Increase output debug message level
                                     - may appear multiple times
        -D Str set-debug-level Set the output debug message level
                                     - may appear multiple times
        -f Str driftfile      frequency drift file name
        -g no  panicgate      Allow the first adjustment to be Big
                                     - may appear multiple times
        -i --- jaildir        built without --enable-clockctl or --enable-linuxcaps
        -I Str interface      Listen on an interface name or address
                                     - may appear multiple times
        -k Str keyfile        path to symmetric keys
        -l Str logfile        path to the log file
        -L no  novirtualips   Do not listen to virtual interfaces
        -n no  nofork         Do not fork
        -N no  nice           Run at high priority
        -p Str pidfile        path to the PID file
        -P Num priority       Process priority
        -q no  quit           Set the time and quit
        -r Str propagationdelay Broadcast/propagation delay
           Str saveconfigquit Save parsed configuration and quit
        -s Str statsdir       Statistics file location
        -t Str trustedkey     Trusted key number
                                     - may appear multiple times
        -u --- user           built without --enable-clockctl or --enable-linuxcaps
        -U Num updateinterval interval in seconds between scans for new or dropped interfaces
           Str var            make ARG an ntp variable (RW)
                                     - may appear multiple times
           Str dvar           make ARG an ntp variable (RW|DEF)
                                     - may appear multiple times
        -x no  slew           Slew up to 600 seconds
           opt version        Output version information and exit
        -? no  help           Display extended usage information and exit
        -! no  more-help      Extended usage information passed thru pager

     Options are specified by doubled hyphens and their name
     or by a single hyphen and the flag character.

     The following option preset mechanisms are supported:
      - examining environment variables named NTPD_*

     please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org

ipv4 option (-4)
----------------

This is the ``force ipv4 dns name resolution'' option.

This option has some usage constraints.  It:

  * is a member of the ipv4 class of options.

Force DNS resolution of following host names on the command line to the IPv4 namespace.

ipv6 option (-6)
----------------

This is the ``force ipv6 dns name resolution'' option.

This option has some usage constraints.  It:

  * is a member of the ipv4 class of options.

Force DNS resolution of following host names on the command line to the IPv6 namespace.

authreq option (-a)
-------------------

This is the ``require crypto authentication'' option.

This option has some usage constraints.  It:

  * must not appear in combination with any of the following options: authnoreq.

Require cryptographic authentication for broadcast client, multicast client and symmetric passive associations. This is the default.

authnoreq option (-A)
---------------------

This is the ``do not require crypto authentication'' option.

This option has some usage constraints.  It:

  * must not appear in combination with any of the following options: authreq.

Do not require cryptographic authentication for broadcast client, multicast client and symmetric passive associations. This is almost never a good idea.

bcastsync option (-b)
---------------------

This is the ``allow us to sync to broadcast servers'' option.

simbroadcastdelay option (-B)
-----------------------------

This is the ``simulator broadcast delay'' option.

configfile option (-c)
----------------------

This is the ``configuration file name'' option. The name and path of the configuration file, /etc/ntp.conf by default.

phasenoise option (-C)
----------------------

This is the ``phase noise level'' option.

debug-level option (-d)
-----------------------

This is the ``increase output debug message level'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

  * must be compiled in by defining DEBUG during the compilation.

Increase the debugging message output level.

set-debug-level option (-D)
---------------------------

This is the ``set the output debug message level'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

  * must be compiled in by defining DEBUG during the compilation.

Set the output debugging level.  Can be supplied multiple times, but each overrides the previous value(s).

driftfile option (-f)
---------------------

This is the ``frequency drift file name'' option. The name and path of the frequency file, /etc/ntp.drift by default. This is the same operation as the driftfile driftfile configuration specification in the /etc/ntp.conf file.

panicgate option (-g)
---------------------

This is the ``allow the first adjustment to be big'' option. Normally, ntpd exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that, ntpd will exit with a message to the system log. This option can be used with the -q and -x options. See the tinker configuration file directive for other options.

simslew option (-H)
-------------------

This is the ``simuator slew'' option.

jaildir option (-i)
-------------------

This is the ``jail directory'' option. Chroot the server to the directory jaildir . This option also implies that the server attempts to drop root privileges at startup (otherwise, chroot gives very little additional security), and it is only available if the OS supports to run the server without full root privileges. You may need to also specify a -u option.

interface option (-I)
---------------------

This is the ``listen on interface'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

keyfile option (-k)
-------------------

This is the ``path to symmetric keys'' option. Specify the name and path of the symmetric key file. /etc/ntp.keys is the default. This is the same operation as the keys keyfile configuration file directive.

logfile option (-l)
-------------------

This is the ``path to the log file'' option. Specify the name and path of the log file. The default is the system log file. This is the same operation as the logfile logfile configuration file directive.

novirtualips option (-L)
------------------------

This is the ``do not listen to virtual ips'' option. Do not listen to virtual IPs. The default is to listen.

modifymmtimer option (-M)
-------------------------

This is the ``modify multimedia timer (windows only)'' option.

This option has some usage constraints.  It:

  * must be compiled in by defining SYS_WINNT during the compilation.

Set the Windows Multimedia Timer to highest resolution.

nofork option (-n)
------------------

This is the ``do not fork'' option.

nice option (-N)
----------------

This is the ``run at high priority'' option. To the extent permitted by the operating system, run ntpd at the highest priority.

servertime option (-O)
----------------------

This is the ``server time'' option.

pidfile option (-p)
-------------------

This is the ``path to the pid file'' option. Specify the name and path of the file used to record ntpd's process ID. This is the same operation as the pidfile pidfile configuration file directive.

priority option (-P)
--------------------

This is the ``process priority'' option. To the extent permitted by the operating system, run ntpd at the specified sched_setscheduler(SCHED_FIFO) priority.

quit option (-q)
----------------

This is the ``set the time and quit'' option. ntpd will exit just after the first time the clock is set. This behavior mimics that of the ntpdate program, which is to be retired. The -g and -x options can be used with this option. Note: The kernel time discipline is disabled with this option.

propagationdelay option (-r)
----------------------------

This is the ``broadcast/propagation delay'' option. Specify the default propagation delay from the broadcast/multicast server to this client. This is necessary only if the delay cannot be computed automatically by the protocol.

updateinterval option (-U)
--------------------------

This is the ``interval in seconds between scans for new or dropped interfaces'' option. Give the time in seconds between two scans for new or dropped interfaces. For systems with routing socket support the scans will be performed shortly after the interface change has been detected by the system. Use 0 to disable scanning.

statsdir option (-s)
--------------------

This is the ``statistics file location'' option. Specify the directory path for files created by the statistics facility. This is the same operation as the statsdir statsdir configuration file directive.

endsimtime option (-S)
----------------------

This is the ``simulation end time'' option.

trustedkey option (-t)
----------------------

This is the ``trusted key number'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

Add a key number to the trusted key list.

freqerr option (-T)
-------------------

This is the ``simulation frequency error'' option.

walknoise option (-W)
---------------------

This is the ``simulation random walk noise'' option.

user option (-u)
----------------

This is the ``run as userid (or userid:groupid)'' option. Specify a user, and optionally a group, to switch to. This option is only available if the OS supports to run the server without full root privileges. Currently, this option is supported under NetBSD (configure with --enable-clockctl ) and Linux (configure with --enable-linuxcaps ).

var option (-v)
---------------

This is the ``make arg an ntp variable (rw)'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

dvar option (-V)
----------------

This is the ``make arg an ntp variable (rw|def)'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

slew option (-x)
----------------

This is the ``slew up to 600 seconds'' option. Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold. This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually. Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s. Thus, an adjustment as much as 600 s will take almost 14 days to complete. This option can be used with the -g and -q options. See the tinker configuration file directive for other options. Note: The kernel time discipline is disabled with this option.

ndelay option (-Y)
------------------

This is the ``simulation network delay'' option.

pdelay option (-Z)
------------------

This is the ``simulation processing delay'' option.