Add a stub manpage modeled over the libexpat one to explain to users not to use
this library outside of base. Requested by: simon
This commit is contained in:
parent
f0916543a6
commit
ec87b7d323
@ -7,6 +7,7 @@ SHLIB_MAJOR= 0
|
||||
INCS= bsdyml.h
|
||||
SRCS= api.c dumper.c emitter.c loader.c \
|
||||
parser.c reader.c scanner.c writer.c
|
||||
MAN= libbsdyml.3
|
||||
|
||||
.PATH: ${LIBYAML}/src ${LIBYAML}/include
|
||||
CLEANFILES= bsdyml.h
|
||||
|
61
lib/libyaml/libbsdyml.3
Normal file
61
lib/libyaml/libbsdyml.3
Normal file
@ -0,0 +1,61 @@
|
||||
.\" Copyright (c) 2013 Baptiste Daroussin <bapt@FreeBSD.org>
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd March 05, 2013
|
||||
.Dt LIBBSDYML 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm libbsdyml
|
||||
.Nd LibYAML library for parsing and emitting YAML
|
||||
.Sh SYNOPSIS
|
||||
.In bsdyml.h
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm
|
||||
library is a verbatim copy of the LibYAML version 0.1.4
|
||||
.Pp
|
||||
The
|
||||
.Nm
|
||||
library is intended to be used within the
|
||||
.Fx
|
||||
base system only.
|
||||
Use of the
|
||||
.Nm
|
||||
library for other purposes is not supported and discouraged.
|
||||
.Pp
|
||||
To avoid version and autoconfiguration issues, the library has been
|
||||
renamed to
|
||||
.Nm
|
||||
rather than retain the original LibYAML library and include file names
|
||||
to prevent confusion and autoconfiguration issues for 3rd party
|
||||
software.
|
||||
.Sh SEE ALSO
|
||||
For full documentation, please see the LibYAML webpage at
|
||||
.Pa http://pyyaml.org/wiki/LibYAML .
|
||||
.Sh AUTHORS
|
||||
.An -nosplit
|
||||
The original LibYAML was written by
|
||||
.An Kirill Simonov Aq xi@resolvent.net .
|
Loading…
Reference in New Issue
Block a user