[mirror_ovs.git] / build-aux / dist-docs

#! /bin/sh

set -e

# Check command line.
if test ! -d "$1" || test $# -lt 2; then
    cat <<EOF
$0: HTML documentation generator for Open vSwitch
usage: $0 srcdir docfile...

The VERSION environment variable should be set to the Open vSwitch version.
Must be invoked from an Open vSwitch build directory.
Most conveniently invoked via "make dist-docs".
EOF
    exit 1
fi

# Parse command line.
srcdir=$1
shift

# Check for programs we'll need.
search_path () {
    save_IFS=$IFS
    IFS=:
    for dir in $PATH; do
        IFS=$save_IFS
        if test -x "$dir/$1"; then
            return 0
        fi
    done
    IFS=$save_IFS
    echo >&2 "$0: $1 not found in \$PATH, please install and try again"
    exit 1
}
search_path man
search_path ps2pdf

# Create dist-docs directory.
distdir=dist-docs
abs_distdir=`pwd`/dist-docs
rm -rf $distdir
mkdir $distdir

# Install manpages.
${MAKE-make} install-man mandir="$abs_distdir"/man
(cd $distdir && mv `find man -type f` . && rm -rf man)
manpages=`cd $distdir && echo *`

# Start writing index.html.
exec 3>$distdir/index.html
cat >&3 <<EOF
<html><head>
  <meta charset="UTF-8"></head>
  <link rel="stylesheet" type="text/css" href="style.css">
  <title>Open vSwitch $VERSION Documentation</title>
</head><body>
<h1>Open vSwitch $VERSION Manpages</h1>
<table>
EOF

# Add manpages to index.html, translating them into PDF, HTML, and plain text.
# The HTML is just slightly marked up from the plain text version; although
# groff supports better HTML output, on my system some of the OVS manpages
# cause the groff HTML output engine to segfault (!).
(cd $distdir
 for manpage in $manpages; do
     man -l -Tps $manpage | ps2pdf - > $manpage.pdf
     GROFF_NO_SGR=1 man -l -Tutf8 $manpage | sed 's/.\b//g' > $manpage.txt
     (echo '<html><head><meta charset="UTF-8"></head><body><pre>'
      GROFF_NO_SGR=1 man -l -Tutf8 $manpage | sed '
s/&/&amp;/g
s/</&lt;/g
s/>/&gt;/g
s,\(.\)\b\1,<b>\1</b>,g
s,_\b\(.\),<u>\1</u>,g'
      echo '</pre></body></html>'
     ) > $manpage.html

     name=`echo $manpage | sed 's/\.\([0-9]\)$/(\1)/'`
     echo "  <tr><td>$name</td><td><a href=\"$manpage.pdf\">PDF</a>, <a href=\"$manpage.html\">HTML</a>, <a href=\"$manpage.txt\">plain text</a></td></tr>"
 done
) >&3
cat >&3 <<EOF
</table>
</body></html>
EOF

# Create CSS style file.
cat >$distdir/style.css <<'EOF'
div { vertical-align:top; }
p {
    vertical-align:baseline;
}
a {
    text-decoration: none;
    font-weight: 700;
}
a:hover {
    color:#444;
}
a:visited {
    color:#447099;
}
a:link {
    color:#447099;
}

body {
    font-family: Arial,Helvetica,sans-serif;
    font-size: 14px;
    line-height: 1.5em;
    color: #444;
    background-color:#f5f5f5;
}
EOF
Commit	Line	Data
4441a01c BP	1	#! /bin/sh
	2
	3	set -e
	4
	5	# Check command line.
	6	if test ! -d "$1" \|\| test $# -lt 2; then
	7	cat <<EOF
	8	$0: HTML documentation generator for Open vSwitch
	9	usage: $0 srcdir docfile...
	10
	11	The VERSION environment variable should be set to the Open vSwitch version.
	12	Must be invoked from an Open vSwitch build directory.
	13	Most conveniently invoked via "make dist-docs".
	14	EOF
	15	exit 1
	16	fi
	17
	18	# Parse command line.
	19	srcdir=$1
	20	shift
	21
	22	# Check for programs we'll need.
	23	search_path () {
	24	save_IFS=$IFS
	25	IFS=:
	26	for dir in $PATH; do
a36bb334 RB	27	IFS=$save_IFS
	28	if test -x "$dir/$1"; then
	29	return 0
	30	fi
4441a01c BP	31	done
	32	IFS=$save_IFS
	33	echo >&2 "$0: $1 not found in \$PATH, please install and try again"
	34	exit 1
	35	}
	36	search_path man
4441a01c BP	37	search_path ps2pdf
	38
	39	# Create dist-docs directory.
	40	distdir=dist-docs
	41	abs_distdir=`pwd`/dist-docs
	42	rm -rf $distdir
	43	mkdir $distdir
	44
	45	# Install manpages.
6b304335	46	${MAKE-make} install-man mandir="$abs_distdir"/man
4441a01c BP	47	(cd $distdir && mv `find man -type f` . && rm -rf man)
	48	manpages=`cd $distdir && echo *`
	49
	50	# Start writing index.html.
	51	exec 3>$distdir/index.html
	52	cat >&3 <<EOF
	53	<html><head>
	54	<meta charset="UTF-8"></head>
	55	<link rel="stylesheet" type="text/css" href="style.css">
	56	<title>Open vSwitch $VERSION Documentation</title>
	57	</head><body>
c431227e	58	<h1>Open vSwitch $VERSION Manpages</h1>
4441a01c BP	59	<table>
	60	EOF
	61
	62	# Add manpages to index.html, translating them into PDF, HTML, and plain text.
	63	# The HTML is just slightly marked up from the plain text version; although
	64	# groff supports better HTML output, on my system some of the OVS manpages
	65	# cause the groff HTML output engine to segfault (!).
	66	(cd $distdir
	67	for manpage in $manpages; do
	68	man -l -Tps $manpage \| ps2pdf - > $manpage.pdf
0e7850eb	69	GROFF_NO_SGR=1 man -l -Tutf8 $manpage \| sed 's/.\b//g' > $manpage.txt
4441a01c	70	(echo '<html><head><meta charset="UTF-8"></head><body><pre>'
0e7850eb	71	GROFF_NO_SGR=1 man -l -Tutf8 $manpage \| sed '
4441a01c BP	72	s/&/&/g
	73	s/</</g
	74	s/>/>/g
	75	s,\(.\)\b\1,<b>\1</b>,g
	76	s,_\b\(.\),<u>\1</u>,g'
	77	echo '</pre></body></html>'
	78	) > $manpage.html
	79
	80	name=`echo $manpage \| sed 's/\.\([0-9]\)$/(\1)/'`
	81	echo " <tr><td>$name</td><td><a href=\"$manpage.pdf\">PDF</a>, <a href=\"$manpage.html\">HTML</a>, <a href=\"$manpage.txt\">plain text</a></td></tr>"
	82	done
	83	) >&3
	84	cat >&3 <<EOF
	85	</table>
	86	</body></html>
	87	EOF
	88
	89	# Create CSS style file.
	90	cat >$distdir/style.css <<'EOF'
	91	div { vertical-align:top; }
	92	p {
	93	vertical-align:baseline;
	94	}
	95	a {
	96	text-decoration: none;
	97	font-weight: 700;
	98	}
	99	a:hover {
	100	color:#444;
	101	}
	102	a:visited {
	103	color:#447099;
	104	}
	105	a:link {
	106	color:#447099;
	107	}
	108
	109	body {
	110	font-family: Arial,Helvetica,sans-serif;
	111	font-size: 14px;
	112	line-height: 1.5em;
	113	color: #444;
	114	background-color:#f5f5f5;
	115	}
	116	EOF