author | Brian Utterback <Brian.Utterback@Oracle.COM> |
Fri, 08 Apr 2011 05:28:01 -0700 | |
changeset 172 | 093198acf7d4 |
child 181 | 87e11e685b1f |
permissions | -rw-r--r-- |
172
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
1 |
'\" te |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
2 |
.\" CDDL HEADER START |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
3 |
.\" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
4 |
.\" The contents of this file are subject to the terms of the |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
5 |
.\" Common Development and Distribution License (the "License"). |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
6 |
.\" You may not use this file except in compliance with the License. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
7 |
.\" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
8 |
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
9 |
.\" or http://www.opensolaris.org/os/licensing. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
10 |
.\" See the License for the specific language governing permissions |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
11 |
.\" and limitations under the License. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
12 |
.\" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
13 |
.\" When distributing Covered Code, include this CDDL HEADER in each |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
14 |
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
15 |
.\" If applicable, add the following below this CDDL HEADER, with the |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
16 |
.\" fields enclosed by brackets "[]" replaced with your own identifying |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
17 |
.\" information: Portions Copyright [yyyy] [name of copyright owner] |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
18 |
.\" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
19 |
.\" CDDL HEADER END |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
20 |
.\" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
21 |
.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
22 |
.\" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
23 |
.TH "ntprc" "4" "" "" "File Formats" |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
24 |
.SH NAME |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
25 |
ntprc \- file to initialize perferences for NTP programs |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
26 |
.SH DESCRIPTION |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
27 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
28 |
The \fB\&.ntprc\fR file contains data used to initialize certain parameters |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
29 |
for various NTP related programs. When these programs are started, the current |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
30 |
directory is searched for the existence of the \fB\&.ntprc\fR file. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
31 |
If found, the file is read and searched for a section header that specifies |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
32 |
the program being run. If such a section is found, then the lines in that section are used to initialize the program. If such a section is not found and no |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
33 |
other sections are found, then the whole file is used do the initialization. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
34 |
If the file is not found in the current directory, the users home directory is |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
35 |
searched if found then it is processed as above. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
36 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
37 |
The \fB.ntprc\fR file is a text file, with each line specifying the settings of a command line flag. The flags |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
38 |
are indicated by the use of the flag's long name. Anything after the long name on the line is used to |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
39 |
set the value of the flag if it takes a value. The same file is used by several \fBNTP\fR programs, so to separate |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
40 |
which lines go with which programs, the file is split into sections. Each section is marked with the name |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
41 |
of the corresponding program in all capital letters and inside square brackets. Comments can be given in the |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
42 |
file by beginning the comment line with a "#" in the first column. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
43 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
44 |
The best way to set the lines in the file is to run the command in question with all of the flags the way |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
45 |
you want them and to give the \fB--save-opts\fR \fIfilename\fR flag at the end to save the parameters to a |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
46 |
file. After that, simply edit the resulting file to remove the comments and add the section header and |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
47 |
then append the file to the \fB.ntprc\fR file. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
48 |
.SH EXAMPLES |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
49 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
50 |
\fBExample 1 \fRA Sample \fB\&.ntprc\fR File |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
51 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
52 |
A \fB\&.ntprc\fR file containing the following lines: |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
53 |
.sp |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
54 |
.in +2 |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
55 |
.nf |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
56 |
[NTPQ] |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
57 |
numeric |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
58 |
command rv 0 |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
59 |
[NTPDC] |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
60 |
peers |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
61 |
.fi |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
62 |
.in -2 |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
63 |
|
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
64 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
65 |
will force the \fBntpq\fR program to always execute the "rv 0" command and print the results |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
66 |
with IP addresses and not hostname. It will also cause the \fBntpdc\fR program to always run |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
67 |
as if the \fB--peers\fR option was given. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
68 |
.SH FILES |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
69 |
.sp |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
70 |
.ne 2 |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
71 |
.mk |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
72 |
.na |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
73 |
\fB\fB~/.ntprc\fR\fR |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
74 |
.ad |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
75 |
.RS 12n |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
76 |
.rt |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
77 |
|
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
78 |
.RE |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
79 |
.SH ATTRIBUTES |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
80 |
See |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
81 |
.BR attributes (5) |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
82 |
for descriptions of the following attributes: |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
83 |
.sp |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
84 |
.TS |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
85 |
tab() box; |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
86 |
cw(2.75i) |cw(2.75i) |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
87 |
lw(2.75i) |lw(2.75i) |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
88 |
. |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
89 |
ATTRIBUTE TYPEATTRIBUTE VALUE |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
90 |
_ |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
91 |
Availabilityservice/network/ntp |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
92 |
= |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
93 |
Interface StabilityUncommitted |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
94 |
.TE |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
95 |
.SH SEE ALSO |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
96 |
.LP |
093198acf7d4
7018272 Move NTP to userland
Brian Utterback <Brian.Utterback@Oracle.COM>
parents:
diff
changeset
|
97 |
\fBntpq\fR(1M), \fBntpdc\fR(1M), \fBntp-keygen\fR(1M) |