Commit b86200c8 authored by Martin Blix Grydeland's avatar Martin Blix Grydeland

Add man page support to the skeleton

parent 14aabf7d
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = src
SUBDIRS = src man
......@@ -22,6 +22,13 @@ AC_PROG_INSTALL
AC_PROG_LIBTOOL
AC_PROG_MAKE_SET
# Check for rst utilities
AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], "no")
if test "x$RST2MAN" = "xno"; then
AC_MSG_WARN([rst2man not found - not building man pages])
fi
AM_CONDITIONAL(HAVE_RST2MAN, [test "x$RST2MAN" != "xno"])
# Check for pkg-config
PKG_PROG_PKG_CONFIG
......@@ -62,5 +69,6 @@ AC_CONFIG_FILES([
Makefile
src/Makefile
src/tests/Makefile
man/Makefile
])
AC_OUTPUT
#
dist_man_MANS = vmod_example.3
MAINTAINERCLEANFILES = $(dist_man_MANS)
vmod_example.3: vmod_example.rst
if HAVE_RST2MAN
${RST2MAN} vmod_example.rst $@
else
@echo "========================================"
@echo "You need rst2man installed to make dist"
@echo "========================================"
@false
endif
============
vmod_example
============
----------------------
Varnish Example Module
----------------------
:Author: Martin Blix Grydeland
:Date: 2011-05-26
:Version: 1.0
:Manual section: 3
SYNOPSIS
========
import example;
DESCRIPTION
===========
Example Varnish vmod demonstrating how to write an out-of-tree Varnish vmod.
Implements the traditional Hello World as a vmod.
FUNCTIONS
=========
hello
-----
Prototype
hello(STRING S)
Return value
STRING
Description
Returns "Hello, " prepended to S
Example
set resp.http.hello = example.hello("World");
HISTORY
=======
This manual page was released as part of the libvmod-example package,
demonstrating how to create an out-of-tree Varnish vmod.
COPYRIGHT
=========
This document is licensed under the same license as the
libvmod-example project. See LICENSE for details.
* Copyright (c) 2011 Varnish Software
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment