.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "VNL-TS 1"
.TH VNL-TS 1 2024-02-04 "" vnlog
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
vnl\-ts \- add a timestamp to a vnlog stream
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 7
\& $ read_temperature
\& # temperature
\& 29.5
\& 30.4
\& 28.3
\& 22.1
\& ... continually produces data at 1Hz
\&
\& $ read_temperature | vnl\-ts \-s %.s
\& # time\-rel temperature
\& 0.013893 30.2
\& 1.048695 28.6
\& 2.105592 29.3
\& 3.162873 22.0
\& ...
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.Vb 1
\&  Usage: vnl\-ts [\-i | \-s] [\-m] [\-\-vnl\-field t] format < pipe
.Ve
.PP
This tool runs \f(CW\*(C`ts\*(C'\fR on given vnlog streams. \f(CW\*(C`vnl\-ts\*(C'\fR is a wrapper around the
\&\f(CW\*(C`ts\*(C'\fR tool from Joey Hess's moreutils <https://joeyh.name/code/moreutils/>
toolkit. Since this is a wrapper, most commandline options and behaviors of the
\&\f(CW\*(C`ts\*(C'\fR tool are present; consult the \fBts\fR\|(1) manpage for details. The
differences from \f(CW\*(C`ts\*(C'\fR are
.IP \(bu 4
The input and output to this tool are vnlog files, complete with a legend
.IP \(bu 4
The format \fImust\fR be passed-in by the user; no default is assumed.
.IP \(bu 4
The given format \fImust not\fR contain whitespace, so that it fits a single vnlog
field.
.IP \(bu 4
\&\f(CW\*(C`\-r\*(C'\fR is not supported: it assumes input timestamps with whitespace, which is
incompatible with vnlog
.IP \(bu 4
A \f(CW\*(C`vnl\-ts\*(C'\fR\-specific option \f(CW\*(C`\-\-vnl\-field\*(C'\fR is available to set the name of the
new field. If omitted, a reasonable default will be used.
.IP \(bu 4
By default we call the \f(CW\*(C`ts\*(C'\fR tool to do the actual work. If the underlying tool
has a different name or lives in an odd path, this can be specified by passing
\&\f(CW\*(C`\-\-vnl\-tool TOOL\*(C'\fR
.PP
Past that, everything \f(CW\*(C`ts\*(C'\fR does is supported, so see that man page for
detailed documentation.
.SH COMPATIBILITY
.IX Header "COMPATIBILITY"
By default this calls the tool named \f(CW\*(C`ts\*(C'\fR. At least on FreeBSD, it's called
\&\f(CW\*(C`moreutils\-ts\*(C'\fR, so on such systems you should invoke \f(CW\*(C`vnl\-ts \-\-vnl\-tool
moreutils\-ts ...\*(C'\fR
.PP
I use GNU/Linux\-based systems exclusively, but everything has been tested
functional on FreeBSD and OSX in addition to Debian, Ubuntu and CentOS. I can
imagine there's something I missed when testing on non-Linux systems, so please
let me know if you find any issues.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBts\fR\|(1)
.SH REPOSITORY
.IX Header "REPOSITORY"
https://github.com/dkogan/vnlog/
.SH AUTHOR
.IX Header "AUTHOR"
Dima Kogan \f(CW\*(C`<dima@secretsauce.net>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2018 Dima Kogan \f(CW\*(C`<dima@secretsauce.net>\*(C'\fR
.PP
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option) any
later version.