/contrib/ntp/ntpdc/ntpdc-opts.texi
https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 278 lines · 227 code · 51 blank · 0 comment · 0 complexity · 3ff5a428bdc0086756e687cb1f6be12d MD5 · raw file
- @node ntpdc Invocation
- @section Invoking ntpdc
- @pindex ntpdc
- @cindex vendor-specific NTP query program
- @ignore
- #
- # EDIT THIS FILE WITH CAUTION (ntpdc-opts.texi)
- #
- # It has been AutoGen-ed Tuesday December 8, 2009 at 08:14:02 AM EST
- # From the definitions ntpdc-opts.def
- # and the template file aginfo.tpl
- @end ignore
- This program has no explanation.
- The
- [= prog-name =]
- utility program is used to query an NTP daemon about its
- current state and to request changes in that state.
- It uses NTP mode 7 control message formats described in the source code.
- The program may
- be run either in interactive mode or controlled using command line
- arguments.
- Extensive state and statistics information is available
- through the
- [= prog-name =]
- interface.
- In addition, nearly all the
- configuration options which can be specified at startup using
- ntpd's configuration file may also be specified at run time using
- [= prog-name =] .
- This section was generated by @strong{AutoGen},
- the aginfo template and the option descriptions for the @command{ntpdc} program. It documents the ntpdc usage text and option meanings.
- This software is released under a specialized copyright license.
- @menu
- * ntpdc usage:: ntpdc usage help (-?)
- * ntpdc command:: command option (-c)
- * ntpdc debug-level:: debug-level option (-d)
- * ntpdc interactive:: interactive option (-i)
- * ntpdc ipv4:: ipv4 option (-4)
- * ntpdc ipv6:: ipv6 option (-6)
- * ntpdc listpeers:: listpeers option (-l)
- * ntpdc numeric:: numeric option (-n)
- * ntpdc peers:: peers option (-p)
- * ntpdc set-debug-level:: set-debug-level option (-D)
- * ntpdc showpeers:: showpeers option (-s)
- @end menu
- @node ntpdc usage
- @subsection ntpdc usage help (-?)
- @cindex ntpdc usage
- This is the automatically generated usage text for ntpdc:
- @exampleindent 0
- @example
- ntpdc - vendor-specific NTP query program - Ver. 4.2.5p247-RC
- USAGE: ntpdc [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
- 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
- -c Str command run a command and exit
- - may appear multiple times
- -l no listpeers Print a list of the peers
- - prohibits these options:
- command
- -p no peers Print a list of the peers
- - prohibits these options:
- command
- -s no showpeers Show a list of the peers
- - prohibits these options:
- command
- -i no interactive Force ntpq to operate in interactive mode
- - prohibits these options:
- command
- listpeers
- peers
- showpeers
- -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
- -n no numeric numeric host addresses
- opt version Output version information and exit
- -? no help Display extended usage information and exit
- -! no more-help Extended usage information passed thru pager
- -> opt save-opts Save the option state to a config file
- -< Str load-opts Load options from a config file
- - disabled as --no-load-opts
- - may appear multiple times
- 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:
- - reading file /users/stenn/.ntprc
- - reading file /deacon/backroom/snaps/ntp-stable/ntpdc/.ntprc
- - examining environment variables named NTPDC_*
- The
- [= prog-name =]
- utility program is used to query an NTP daemon about its
- current state and to request changes in that state.
- It uses NTP mode 7 control message formats described in the source code.
- The program may
- be run either in interactive mode or controlled using command line
- arguments.
- Extensive state and statistics information is available
- through the
- [= prog-name =]
- interface.
- In addition, nearly all the
- configuration options which can be specified at startup using
- ntpd's configuration file may also be specified at run time using
- [= prog-name =] .
- please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
- @end example
- @exampleindent 4
- @node ntpdc ipv4
- @subsection ipv4 option (-4)
- @cindex ntpdc-ipv4
- This is the ``force ipv4 dns name resolution'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- is a member of the ipv4 class of options.
- @end itemize
- Force DNS resolution of following host names on the command line
- to the IPv4 namespace.
- @node ntpdc ipv6
- @subsection ipv6 option (-6)
- @cindex ntpdc-ipv6
- This is the ``force ipv6 dns name resolution'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- is a member of the ipv4 class of options.
- @end itemize
- Force DNS resolution of following host names on the command line
- to the IPv6 namespace.
- @node ntpdc command
- @subsection command option (-c)
- @cindex ntpdc-command
- This is the ``run a command and exit'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- may appear an unlimited number of times.
- @end itemize
- The following argument is interpreted as an interactive format command
- and is added to the list of commands to be executed on the specified
- host(s).
- @node ntpdc listpeers
- @subsection listpeers option (-l)
- @cindex ntpdc-listpeers
- This is the ``print a list of the peers'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- must not appear in combination with any of the following options:
- command.
- @end itemize
- Print a list of the peers known to the server as well as a summary of
- their state. This is equivalent to the 'listpeers' interactive command.
- @node ntpdc peers
- @subsection peers option (-p)
- @cindex ntpdc-peers
- This is the ``print a list of the peers'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- must not appear in combination with any of the following options:
- command.
- @end itemize
- Print a list of the peers known to the server as well as a summary
- of their state. This is equivalent to the 'peers' interactive command.
- @node ntpdc showpeers
- @subsection showpeers option (-s)
- @cindex ntpdc-showpeers
- This is the ``show a list of the peers'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- must not appear in combination with any of the following options:
- command.
- @end itemize
- Print a list of the peers known to the server as well as a summary
- of their state. This is equivalent to the 'dmpeers' interactive command.
- @node ntpdc interactive
- @subsection interactive option (-i)
- @cindex ntpdc-interactive
- This is the ``force ntpq to operate in interactive mode'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- must not appear in combination with any of the following options:
- command, listpeers, peers, showpeers.
- @end itemize
- Force ntpq to operate in interactive mode. Prompts will be written
- to the standard output and commands read from the standard input.
- @node ntpdc debug-level
- @subsection debug-level option (-d)
- @cindex ntpdc-debug-level
- This is the ``increase output debug message level'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- may appear an unlimited number of times.
- @item
- must be compiled in by defining @code{DEBUG} during the compilation.
- @end itemize
- Increase the debugging message output level.
- @node ntpdc set-debug-level
- @subsection set-debug-level option (-D)
- @cindex ntpdc-set-debug-level
- This is the ``set the output debug message level'' option.
- This option has some usage constraints. It:
- @itemize @bullet
- @item
- may appear an unlimited number of times.
- @item
- must be compiled in by defining @code{DEBUG} during the compilation.
- @end itemize
- Set the output debugging level. Can be supplied multiple times,
- but each overrides the previous value(s).
- @node ntpdc numeric
- @subsection numeric option (-n)
- @cindex ntpdc-numeric
- This is the ``numeric host addresses'' option.
- Output all host addresses in dotted-quad numeric format rather than
- converting to the canonical host names.