Update documentation a bit more

This commit is contained in:
Miroslav Lichvar 2009-12-04 12:57:26 +01:00
parent 1f6e508a3d
commit 6031b35a7a
8 changed files with 30 additions and 26 deletions

View file

@ -71,11 +71,11 @@ If you want chrony to appear in the top level info directory listing, you need
to run the install-info command manually after this step. install-info takes 2
arguments. The first is the path to the chrony.info file you have just
installed. This will be the argument you gave to --prefix when you configured
(/usr/local by default), with /info/chrony.info on the end. The second
(/usr/local by default), with /share/info/chrony.info on the end. The second
argument is the location of the file called 'dir'. This will typically be
/usr/info/dir. So the typical command line would be
/usr/share/info/dir. So the typical command line would be
install-info /usr/local/info/chrony.info /usr/info/dir
install-info /usr/local/share/info/chrony.info /usr/share/info/dir
Now that the software is successfully installed, the next step is to
set up a configuration file. The contents of this depend on the

7
README
View file

@ -103,11 +103,8 @@ by sending mail with the subject "subscribe" to
chrony-announce-request@chrony.tuxfamily.org
These messages will be copied to chrony-users (see below). I also try
to announce new versions on Freshmeat (http://freshmeat.net/).
I don't reliably announce via news any more - I don't tend to keep up
with news as I haven't enough time.
These messages will be copied to chrony-users (see below). New versions
are announced also on Freshmeat (http://freshmeat.net/).
How can I get support for chrony?
and where can I discuss new features, possible bugs etc?

View file

@ -1,4 +1,4 @@
.TH CHRONY 1 "August 10, 2001" chrony "User's Manual"
.TH CHRONY 1 "December 04, 2009" chrony "User's Manual"
.SH NAME
chrony \- programs for keeping computer clocks accurate
@ -30,7 +30,7 @@ gains or loses time and uses this information to keep it accurate
between measurements from the reference.
The reference time can be derived from either Network Time Protocol
(NTP) servers (preferred), or wristwatch-and-keyboard (via \fIchronyc\fR).
(NTP) servers, reference clocks, or wristwatch-and-keyboard (via \fIchronyc\fR).
The main source of information about the Network Time Protocol is
\fIhttp://www.eecis.udel.edu/~ntp\fR.
@ -49,6 +49,8 @@ On an ethernet LAN : 100-200 microseconds, often much better
On a V32bis dial-up modem connection : 10's of milliseconds (from one
session to the next)
With a good reference clock the accuracy can reach one microsecond.
\fIchronyd\fR can also operate as an RFC1305-compatible NTP server and peer.
.SH "SEE ALSO"

View file

@ -1,4 +1,4 @@
.TH chrony.conf 5 "August 10, 2001" chrony "Configuration Files"
.TH chrony.conf 5 "December 04, 2009" chrony "Configuration Files"
.SH NAME
chrony.conf \- chronyd configuration file
@ -37,7 +37,7 @@ useful configuration file would look something like
.SH "SEE ALSO"
.BR chrony(1),
.BR chronyc(1),
.BR chronyd(1)
.BR chronyd(8)
.I http://chrony.tuxfamily.org/

View file

@ -424,12 +424,12 @@ to run the @command{install-info} command manually after this step.
@command{install-info} takes 2 arguments. The first is the path to the
@file{chrony.info} file you have just installed. This will be the argument you
gave to --prefix when you configured (@file{/usr/local} by default), with
@file{/info/chrony.info} on the end. The second argument is the location of
the file called @file{dir}. This will typically be @file{/usr/info/dir}. So
@file{/share/info/chrony.info} on the end. The second argument is the location of
the file called @file{dir}. This will typically be @file{/usr/share/info/dir}. So
the typical command line would be
@example
install-info /usr/local/info/chrony.info /usr/info/dir
install-info /usr/local/share/info/chrony.info /usr/share/info/dir
@end example
Now that the software is successfully installed, the next step is to
@ -488,7 +488,7 @@ This defines the directory containing the @file{libncurses.a} or
The configure and make procedures have some extra options that may be useful if
you are building a distribution package for chrony.
The --infodir=DIR option to configure specifies a different install directory
The --infodir=DIR option to configure specifies an install directory
for the info files. This overrides the @file{info} subdirectory of the
argument to the --prefix option. For example, you might use
@ -496,7 +496,7 @@ argument to the --prefix option. For example, you might use
./configure --prefix=/usr --infodir=/usr/share/info
@end example
The --mandir=DIR option to configure specifies a different install directory
The --mandir=DIR option to configure specifies an install directory
for the man pages. This overrides the @file{man} subdirectory of the
argument to the --prefix option.

View file

@ -1,4 +1,4 @@
.TH CHRONYC 1 "August 10, 2001" chrony "User's Manual"
.TH CHRONYC 1 "December 04, 2009" chrony "User's Manual"
.SH NAME
chronyc \- command-line interface for chronyd
@ -47,7 +47,7 @@ interactively.
1.24
.SH BUGS
To report bugs, please contact the author and/or visit \fIhttp://chrony.tuxfamily.org
To report bugs, please visit \fIhttp://chrony.tuxfamily.org\fR
.SH "SEE ALSO"
.BR chronyd(8),

View file

@ -1,4 +1,4 @@
.TH CHRONYD 8 "August 10, 2001" chrony "System Administration"
.TH CHRONYD 8 "December 04, 2009" chrony "System Administration"
.SH NAME
chronyd \- chrony background daemon
@ -105,10 +105,10 @@ Resolve hostnames only to IPv6 addresses.
\fI/etc/chrony.conf\fR
.SH VERSION
Version 1.17
Version 1.24
.SH BUGS
To report bugs, please contact the author and/or visit \fIhttp://chrony.tuxfamily.org/\fR
To report bugs, please visit \fIhttp://chrony.tuxfamily.org/\fR
.SH "SEE ALSO"
\fBchronyd\fR is documented in detail in the documentation supplied with the

View file

@ -1,9 +1,8 @@
#######################################################################
# $Header: /cvs/src/chrony/examples/chrony.conf.example,v 1.2 2002/02/03 21:46:29 richard Exp $
#
# This is an example chrony configuration file. You should copy it to
# /etc/chrony.conf after uncommenting and editing the options that you
# want to enable. I have not included the more obscure options. Refer
# want to enable. The more obscure options are not included. Refer
# to the documentation for these.
#
# Copyright 2002 Richard P. Curnow
@ -157,8 +156,8 @@ commandkey 1
! logdir /var/log/chrony
! log measurements statistics tracking
If you have real time clock support enabled (see below), you might want
this line instead:
# If you have real time clock support enabled (see below), you might want
# this line instead:
! log measurements statistics tracking rtc
@ -209,6 +208,12 @@ this line instead:
! noclientlog
# The clientlog size is limited to 512KB by default. If you have many
# clients, especially in many different subnets, you might want to
# increase the limit.
! clientloglimit 4194304
#######################################################################
### REPORTING BIG CLOCK CHANGES
# Perhaps you want to know if chronyd suddenly detects any large error