.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VNL-TS 1"
.TH VNL-TS 1 "2019-01-22" "" "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.
.PP
Past that, everything \f(CW\*(C`ts\*(C'\fR does is supported, so see that man page for
detailed documentation.
.SH "BUGS"
.IX Header "BUGS"
This and the other \f(CW\*(C`vnl\-xxx\*(C'\fR tools that wrap standard utilities are written
specifically to work with the Linux kernel. None of these have been tested with
\&\s-1BSD\s0 tools or with non-Linux kernels, and I'm sure things don't just work. It's
probably not too effortful to get that running, but somebody needs to at least
bug me for that. Or better yet, send me nice patches :)
.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 \s-1GNU\s0 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.