diff options
Diffstat (limited to 'contrib/libxo/libxo/xo_set_version.3')
-rw-r--r-- | contrib/libxo/libxo/xo_set_version.3 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/contrib/libxo/libxo/xo_set_version.3 b/contrib/libxo/libxo/xo_set_version.3 new file mode 100644 index 000000000000..888aef5e61ff --- /dev/null +++ b/contrib/libxo/libxo/xo_set_version.3 @@ -0,0 +1,59 @@ +.\" # +.\" # Copyright (c) 2015, Juniper Networks, Inc. +.\" # All rights reserved. +.\" # This SOFTWARE is licensed under the LICENSE provided in the +.\" # ../Copyright file. By downloading, installing, copying, or +.\" # using the SOFTWARE, you agree to be bound by the terms of that +.\" # LICENSE. +.\" # Phil Shafer, July 2014 +.\" +.Dd December 4, 2014 +.Dt LIBXO 3 +.Os +.Sh NAME +.Nm xo_set_version +.Nd record content version information in encoded output +.Sh LIBRARY +.Lb libxo +.Sh SYNOPSIS +.In libxo/xo.h +.Ft void +.Fn xo_set_version "const char *version" +.Ft void +.Fn xo_set_version_h "xo_handle_t *xop" "const char *version" +.Sh DESCRIPTION +The +.Nm xo_set_version +function records a version number to be emitted as +part of the data for encoding styles (XML and JSON). +This version number is suitable for tracking changes in the content, +allowing a user of the data to discern which version of the data model +is in use. +.Sh ADDITIONAL DOCUMENTATION +Complete documentation can be found on github: +.Bd -literal -offset indent +http://juniper.github.io/libxo/libxo-manual.html +.Ed +.Pp +.Nm libxo +lives on github as: +.Bd -literal -offset indent +https://github.com/Juniper/libxo +.Ed +.Pp +The latest release of +.Nm libxo +is available at: +.Bd -literal -offset indent +https://github.com/Juniper/libxo/releases +.Ed +.Sh SEE ALSO +.Xr xo_emit 3 , +.Xr libxo 3 +.Sh HISTORY +The +.Nm libxo +library was added in +.Fx 11.0 . +.Sh AUTHOR +Phil Shafer |