stamp: New program.

[misc] / stamp.1

diff --git a/stamp.1 b/stamp.1
new file mode 100644 (file)
index 0000000..5cbe9f0
--- /dev/null
+++ b/stamp.1
@@ -0,0 +1,54 @@
+.\" -*-nroff-*-
+.TH stamp 1 "11 August 2006" "Straylight/Edgeware"
+.SH NAME
+stamp \- copy files, prefixing each line with a datestamp
+.SH SYNOPSIS
+.B stamp
+.RB [ \-z ]
+.RB [ \-f
+.IR format ]
+.RI [ file ...]
+.SH DESCRIPTION
+Copies files, like
+.BR cat (1),
+except that it prefixes each line with a datestamp indicating when the
+line was recieved.  The datestamp is formatted using
+.BR strftime (3),
+and can use any formatting codes permitted by that function.
+.PP
+Options available:
+.TP
+.B \-h, \-\-help
+Show a help message for
+.BR stamp .
+.TP
+.B \-v, \-\-version
+Show version number for
+.BR stamp .
+.TP
+.B \-u, \-\-usage
+Show usage message for
+.BR stamp .
+.TP
+.BI "\-f, \-\-format=" format
+Use 
+.I format
+as the 
+.BR strftime (3)
+format string for the datestamps.  Note that if the datestamp is meant
+to be separated from the rest of the line by anything, then that
+separator should be part of the format string.
+.TP
+.B \-z, \-\-utc, \-\-zulu
+Use UTC (Zulu time) instead of local time for datestamps.
+.SH BUGS
+While
+.B stamp
+ensures that its input is line-buffered only, it's possible that
+whatever is providing that input delays it arbitrarily due to its own
+buffering.  There's not much to be done about this.
+.SH AUTHOR
+Mark Wooding, <mdw@distorted.org.uk>
+.SH SEE ALSO
+.BR cat (1),
+.BR strftime (3).