.\" -*- 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-GEN-HEADER 1"
.TH VNL-GEN-HEADER 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\-gen\-header \- create definition for vnlog output from C
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& $ vnl\-gen\-header \*(Aqint w\*(Aq \*(Aquint8_t x\*(Aq \*(Aqchar* y\*(Aq \*(Aqdouble z\*(Aq > vnlog_fields_generated.h
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
We provide a simple C library to produce vnlog output. The fields this
library outputs must be known at compile time, and are specified in a header
created by this tool. Please see the vnlog documentation for instructions on
how to use the library
.SH ARGUMENTS
.IX Header "ARGUMENTS"
This tool needs to be given a list of field definitions. First we look at the
commandline, and if the definitions are not available there, we look on STDIN.
Each definition is a string \f(CW\*(C`type name\*(C'\fR (one def per argument on the
commandline or per line on STDIN). If reading from STDIN, we ignore blank lines,
and treat any line starting with \f(CW\*(C`#\*(C'\fR as a comment.
.PP
Each def represents a single output field. Each such field spec in a C\-style
variable declaration with a type followed by a name. Note that these field specs
contain whitespace, so each one must be quoted before being passed to the shell.
.PP
The types can be basic scalars, possibly with set widths (\f(CW\*(C`char\*(C'\fR, \f(CW\*(C`double\*(C'\fR,
\&\f(CW\*(C`int\*(C'\fR, \f(CW\*(C`uint32_t\*(C'\fR, \f(CW\*(C`unsigned int\*(C'\fR, ...), a NULL-terminated string (\f(CW\*(C`char*\*(C'\fR)
or a generic chunk of binary data (\f(CW\*(C`void*\*(C'\fR).
.PP
The names must consist entirely of letters, numbers or \f(CW\*(C`_\*(C'\fR, like variables in
C.
.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 2016 California Institute of Technology.
.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.