contrib/libxo/libxo/xo_set_version.3

   1 .\" #
   2 .\" # Copyright (c) 2015, Juniper Networks, Inc.
   3 .\" # All rights reserved.
   4 .\" # This SOFTWARE is licensed under the LICENSE provided in the
   5 .\" # ../Copyright file. By downloading, installing, copying, or
   6 .\" # using the SOFTWARE, you agree to be bound by the terms of that
   7 .\" # LICENSE.
   8 .\" # Phil Shafer, July 2014
   9 .\"
  10 .Dd December 4, 2014
  11 .Dt LIBXO 3
  12 .Os
  13 .Sh NAME
  14 .Nm xo_set_version , xo_set_version_h
  15 .Nd record content-version information in encoded output
  16 .Sh LIBRARY
  17 .Lb libxo
  18 .Sh SYNOPSIS
  19 .In libxo/xo.h
  20 .Ft void
  21 .Fn xo_set_version "const char *version"
  22 .Ft void
  23 .Fn xo_set_version_h "xo_handle_t *xop" "const char *version"
  24 .Sh DESCRIPTION
  25 The
  26 .Nm xo_set_version
  27 function records a version number to be emitted as
  28 part of the data for encoding styles (XML and JSON).
  29 This version number is suitable for tracking changes in the content,
  30 allowing a user of the data to discern which version of the data model
  31 is in use.
  32 .Sh SEE ALSO
  33 .Xr xo_emit 3 ,
  34 .Xr libxo 3
  35 .Sh HISTORY
  36 The
  37 .Nm libxo
  38 library first appeared in
  39 .Fx 11.0 .
  40 .Sh AUTHORS
  41 .Nm libxo
  42 was written by
  43 .An Phil Shafer Aq Mt phil@freebsd.org .
  44