1 '\" te

     2 .\" CDDL HEADER START

     3 .\"

     4 .\" The contents of this file are subject to the terms of the

     5 .\" Common Development and Distribution License (the "License").

     6 .\" You may not use this file except in compliance with the License.

     7 .\"

     8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

     9 .\" or http://www.opensolaris.org/os/licensing.

    10 .\" See the License for the specific language governing permissions

    11 .\" and limitations under the License.

    12 .\"

    13 .\" When distributing Covered Code, include this CDDL HEADER in each

    14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.

    15 .\" If applicable, add the following below this CDDL HEADER, with the

    16 .\" fields enclosed by brackets "[]" replaced with your own identifying

    17 .\" information: Portions Copyright [yyyy] [name of copyright owner]

    18 .\"

    19 .\" CDDL HEADER END

    20 .\"

    21 .\" Copyright 2009 Sun Microsystems, Inc.  All rights reserved.

    22 .\" Use is subject to license terms.

    23 .\"

    24 .\" #ident	"@(#)ntprc.4	1.1	09/05/17 SMI"

    25 .\"

    26 .TH "ntprc" "4" "" "" "File Formats"

    27 .SH NAME

    28 ntprc \- file to initialize perferences for NTP programs

    29 .SH DESCRIPTION

    30 .LP

    31 The \fB\&.ntprc\fR file contains data used to initialize certain parameters 

    32 for various NTP related programs. When these programs are started, the current

    33 directory is searched for the existence of the \fB\&.ntprc\fR file.

    34 If found, the file is read and searched for a section header that specifies

    35 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

    36 other sections are found, then the whole file is used do the initialization.

    37 If the file is not found in the current directory, the users home directory is

    38 searched if found then it is processed as above.

    39 .LP

    40 The \fB.ntprc\fR file is a text file, with each line specifying the settings of a command line flag. The flags

    41 are indicated by the use of the flag's long name. Anything after the long name on the line is used to 

    42 set the value of the flag if it takes a value. The same file is used by several \fBNTP\fR programs, so to separate

    43 which lines go with which programs, the file is split into sections. Each section is marked with the name

    44 of the corresponding program in all capital letters and inside square brackets.  Comments can be given in the

    45 file by beginning the comment line with a "#" in the first column. 

    46 .LP 

    47 The best way to set the lines in the file is to run the command in question with all of the flags the way 

    48 you want them and to give the \fB--save-opts\fR \fIfilename\fR flag at the end to save the parameters to a

    49 file. After that, simply edit the resulting file to remove the comments and add the section header and

    50 then append the file to the \fB.ntprc\fR file.  

    51 .SH EXAMPLES

    52 .LP

    53 \fBExample 1 \fRA Sample \fB\&.ntprc\fR File

    54 .LP

    55 A \fB\&.ntprc\fR file containing the following lines:

    56 .sp

    57 .in +2

    58 .nf

    59 [NTPQ]

    60 numeric

    61 command rv 0

    62 [NTPDC]

    63 peers

    64 .fi

    65 .in -2

    66 

    67 .LP

    68 will force the \fBntpq\fR program to always execute the "rv 0" command and print the results

    69 with IP addresses and not hostname. It will also cause the \fBntpdc\fR program to always run

    70 as if the \fB--peers\fR option was given.

    71 .SH FILES

    72 .sp

    73 .ne 2

    74 .mk

    75 .na

    76 \fB\fB~/.ntprc\fR\fR

    77 .ad

    78 .RS 12n

    79 .rt  

    80 

    81 .RE

    82 .SH ATTRIBUTES

    83 See

    84 .BR attributes (5)

    85 for descriptions of the following attributes:

    86 .sp

    87 .TS

    88 tab() box;

    89 cw(2.75i) |cw(2.75i)

    90 lw(2.75i) |lw(2.75i)

    91 .

    92 ATTRIBUTE TYPEATTRIBUTE VALUE

    93 _

    94 AvailabilitySUNWntpu

    95 =

    96 Interface StabilityUncommitted

    97 .TE

    98 .SH SEE ALSO

    99 .LP

   100 \fBntpq\fR(1M), \fBntpdc\fR(1M), \fBntp-keygen\fR(1M)