/contrib/ntp/ntpdc/ntpdc-opts.def

  1/* -*- Mode: Text -*- */
  2
  3autogen definitions options;
  4
  5prog-name      = "ntpdc";
  6prog-title     = "vendor-specific NTP query program";
  7argument       = '[ host ...]';
  8
  9#include copyright.def
 10#include homerc.def
 11#include autogen-version.def
 12
 13test-main;
 14
 15flag = {
 16    name      = ipv4;
 17    value     = 4;
 18    equivalence = ipv4;
 19    descrip   = "Force IPv4 DNS name resolution";
 20    doc = <<-  _EndOfDoc_
 21	Force DNS resolution of following host names on the command line
 22	to the IPv4 namespace.
 23	_EndOfDoc_;
 24};
 25
 26flag = {
 27    name      = ipv6;
 28    value     = 6;
 29    equivalence = ipv4;
 30    descrip   = "Force IPv6 DNS name resolution";
 31    doc = <<-  _EndOfDoc_
 32	Force DNS resolution of following host names on the command line
 33	to the IPv6 namespace.
 34	_EndOfDoc_;
 35};
 36
 37flag = {
 38    name      = command;
 39    value     = c;
 40    arg-type  = string;
 41    descrip   = "run a command and exit";
 42    max       = NOLIMIT;
 43    arg-name  = cmd;
 44    stack-arg;
 45    doc = <<-  _EndOfDoc_
 46	The following argument is interpreted as an interactive format command
 47	and is added to the list of commands to be executed on the specified
 48	host(s).
 49	_EndOfDoc_;
 50};
 51
 52flag = {
 53    name      = listpeers;
 54    value     = l;
 55    descrip   = "Print a list of the peers";
 56    flags-cant = command;
 57    doc = <<-  _EndOfDoc_
 58	Print a list of the peers known to the server as well as a summary of
 59	their state. This is equivalent to the 'listpeers' interactive command.
 60	_EndOfDoc_;
 61};
 62
 63flag = {
 64    name      = peers;
 65    value     = p;
 66    descrip   = "Print a list of the peers";
 67    flags-cant = command;
 68    doc = <<-  _EndOfDoc_
 69	Print a list of the peers known to the server as well as a summary
 70	of their state. This is equivalent to the 'peers' interactive command.
 71	_EndOfDoc_;
 72};
 73
 74flag = {
 75    name      = showpeers;
 76    value     = s;
 77    descrip   = "Show a list of the peers";
 78    flags-cant = command;
 79    doc = <<-  _EndOfDoc_
 80	Print a list of the peers known to the server as well as a summary
 81	of their state. This is equivalent to the 'dmpeers' interactive command.
 82	_EndOfDoc_;
 83};
 84
 85flag = {
 86    name      = interactive;
 87    value     = i;
 88    flags-cant = command, listpeers, peers, showpeers;
 89    descrip   = "Force ntpq to operate in interactive mode";
 90    doc = <<-  _EndOfDoc_
 91	Force ntpq to operate in interactive mode.  Prompts will be written
 92	to the standard output and commands read from the standard input.
 93	_EndOfDoc_;
 94};
 95
 96#include debug-opt.def
 97
 98flag = {
 99    name      = numeric;
100    value     = n;
101    descrip   = "numeric host addresses";
102    doc = <<-  _EndOfDoc_
103	Output all host addresses in dotted-quad numeric format rather than
104	converting to the canonical host names. 
105	_EndOfDoc_;
106};
107
108detail = <<-  _END_DETAIL
109	The
110	[= prog-name =]
111	utility program is used to query an NTP daemon about its
112	current state and to request changes in that state.
113	It uses NTP mode 7 control message formats described in the source code.
114	The program may
115	be run either in interactive mode or controlled using command line
116	arguments.
117	Extensive state and statistics information is available
118	through the
119	[= prog-name =]
120	interface.
121	In addition, nearly all the
122	configuration options which can be specified at startup using
123	ntpd's configuration file may also be specified at run time using
124	[= prog-name =] .
125
126
127	_END_DETAIL;