[logging] Add new "log timestamp precision" command for subsecond timestamps

2007-04-29 Andrew J. Schorr <ajschorr@alumni.princeton.edu>

	* basic.texi: Document the new 'log timestamp precision' command.

diff --git a/doc/ChangeLog b/doc/ChangeLog
index 3511613c0df15683a95e6d044b1517d3561174c9..c84730c0a93afeec5200fee2bc7c70ce44e6e2c4 100644 (file)
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2007-04-29 Andrew J. Schorr <ajschorr@alumni.princeton.edu>
+
+       * basic.texi: Document the new 'log timestamp precision' command.
+
 2007-03-21 Andrew J. Schorr <ajschorr@alumni.princeton.edu>
 
        * Makefile.am: Patch rule for draft-zebra-00.txt to work

diff --git a/doc/basic.texi b/doc/basic.texi
index 9c6b59a48155adeb0a223e3187e68d5e833249e8..77fceee1ed4ed406a808ce725fc522a9a50b925d 100644 (file)
--- a/doc/basic.texi
+++ b/doc/basic.texi
@@ -166,6 +166,25 @@ versions of syslogd (including Solaris) can be configured to include
 the facility and level in the messages emitted.
 @end deffn
 
+@deffn Command {log timestamp precision @var{<0-6>}} {}
+@deffnx Command {no log timestamp precision} {}
+This command sets the precision of log message timestamps to the
+given number of digits after the decimal point.  Currently,
+the value must be in the range 0 to 6 (i.e. the maximum precision
+is microseconds).
+To restore the default behavior (1-second accuracy), use the
+@code{no} form of the command, or set the precision explicitly to 0.
+
+@example
+@group
+log timestamp precision 3
+@end group
+@end example
+
+In this example, the precision is set to provide timestamps with
+millisecond accuracy.
+@end deffn
+
 @deffn Command {service password-encryption} {}
 Encrypt password.
 @end deffn