root/trunk/freewrt/scripts/genhtman.sh

# $FreeWRT: src/share/misc/licence.template,v 1.20 2006/12/11 21:04:56 tg Rel $
#-
# Copyright (c) 2007
#       Thorsten Glaser <tg@mirbsd.de>
#
# Provided that these terms and disclaimer and all copyright notices
# are retained or reproduced in an accompanying document, permission
# is granted to deal in this work without restriction, including un-
# limited rights to use, publicly perform, distribute, sell, modify,
# merge, give away, or sublicence.
#
# Advertising materials mentioning features or use of this work must
# display the following acknowledgement:
#       This product includes material provided by Thorsten Glaser.
#
# This work is provided "AS IS" and WITHOUT WARRANTY of any kind, to
# the utmost extent permitted by applicable law, neither express nor
# implied; without malicious intent or gross negligence. In no event
# may a licensor, author or contributor be held liable for indirect,
# direct, other damage, loss, or other issues arising in any way out
# of dealing in the work, even if advised of the possibility of such
# damage or existence of a defect, except proven that it results out
# of said person's immediate fault when using the work as intended.
#-
# Scan $1 (${WRKINST}) for man and catman pages and convert them in-
# to HTML man pages; generate a per-package index in $2/wman/

sd=$1
dd=$2/wman

. $(dirname "$0")/roff2htm

rm -rf $dd
mkdir -p $dd/{{man,cat}{1,2,3,3p,4,5,6,7,8,9,n},htman/pkgs}
# copy over manual pages (source and catman): ordinary files and hardlinks
find $sd -type f -a \( -path \*/man\* -o -path \*/cat\* \) | while read f; do
        if [[ $f = *.gz ]]; then
                f=${f%.gz}
                gzip -cdf <$f.gz >$f
        fi
        case $f {
        (*.1)           ln $f $dd/man1/ ;;
        (*.2)           ln $f $dd/man2/ ;;
        (*.3)           ln $f $dd/man3/ ;;
        (*.3p)          ln $f $dd/man3p/ ;;
        (*.4)           ln $f $dd/man4/ ;;
        (*.5)           ln $f $dd/man5/ ;;
        (*.6)           ln $f $dd/man6/ ;;
        (*.7)           ln $f $dd/man7/ ;;
        (*.8)           ln $f $dd/man8/ ;;
        (*.9)           ln $f $dd/man9/ ;;
        (*.n)           ln $f $dd/mann/ ;;
        (*.1tbl)        tbl <$f >$dd/man1/${f%tbl} ;;
        (*.2tbl)        tbl <$f >$dd/man2/${f%tbl} ;;
        (*.3tbl)        tbl <$f >$dd/man3/${f%tbl} ;;
        (*.4tbl)        tbl <$f >$dd/man4/${f%tbl} ;;
        (*.5tbl)        tbl <$f >$dd/man5/${f%tbl} ;;
        (*.6tbl)        tbl <$f >$dd/man6/${f%tbl} ;;
        (*.7tbl)        tbl <$f >$dd/man7/${f%tbl} ;;
        (*.8tbl)        tbl <$f >$dd/man8/${f%tbl} ;;
        (*.9tbl)        tbl <$f >$dd/man9/${f%tbl} ;;
        (*.1eqn)        neqn <$f | tbl >$dd/man1/${f%eqn} ;;
        (*.2eqn)        neqn <$f | tbl >$dd/man2/${f%eqn} ;;
        (*.3eqn)        neqn <$f | tbl >$dd/man3/${f%eqn} ;;
        (*.4eqn)        neqn <$f | tbl >$dd/man4/${f%eqn} ;;
        (*.5eqn)        neqn <$f | tbl >$dd/man5/${f%eqn} ;;
        (*.6eqn)        neqn <$f | tbl >$dd/man6/${f%eqn} ;;
        (*.7eqn)        neqn <$f | tbl >$dd/man7/${f%eqn} ;;
        (*.8eqn)        neqn <$f | tbl >$dd/man8/${f%eqn} ;;
        (*.9eqn)        neqn <$f | tbl >$dd/man9/${f%eqn} ;;
        (*/cat1/*.0)    ln $f $dd/cat1/ ;;
        (*/cat2/*.0)    ln $f $dd/cat2/ ;;
        (*/cat3/*.0)    ln $f $dd/cat3/ ;;
        (*/cat3p/*.0)   ln $f $dd/cat3p/ ;;
        (*/cat4/*.0)    ln $f $dd/cat4/ ;;
        (*/cat5/*.0)    ln $f $dd/cat5/ ;;
        (*/cat6/*.0)    ln $f $dd/cat6/ ;;
        (*/cat7/*.0)    ln $f $dd/cat7/ ;;
        (*/cat8/*.0)    ln $f $dd/cat8/ ;;
        (*/cat9/*.0)    ln $f $dd/cat9/ ;;
        (*/catn/*.0)    ln $f $dd/catn/ ;;
        (*)             print -u2 "file looks like manpage but ignored: ${f#$sd/}"
                        continue ;;
        }
        print -u2 "processing manual page: ${f#$sd/}"
done
# copy over manual pages (source and catman): symbolic links
find $sd -type l -a \( -path \*/man\* -o -path \*/cat\* \) | while read f; do
        t=$(readlink -f $f)
        case $t {
        (*.[123456789n]|*.3p)
                t=${t##*/}
                t=man${t##*.}/$t
                ;;
        (*.[123456789n]tbl)
                t=${t##*/}
                t=${t%tbl}
                t=man${t##*.}/$t
                ;;
        (*.[123456789n]eqn)
                t=${t##*/}
                t=${t%eqn}
                t=man${t##*.}/$t
                ;;
        (*/cat[123456789n]/*.0|*/cat3p/*.0)
                x=${t%/*}
                t=${t##*/}
                t=cat${x##*cat}/$t
                ;;
        (*)
                print -u2 "bad target '${t#$sd/}' for link '${f#$sd/}' ignored"
                continue ;;
        }
        case $f {
        (*.[123456789n]|*.3p)
                f=${f##*/}
                f=man${f##*.}/$f
                ;;
        (*.[123456789n]tbl)
                f=${f##*/}
                f=${f%tbl}
                f=man${f##*.}/$f
                ;;
        (*.[123456789n]eqn)
                f=${f##*/}
                f=${f%eqn}
                f=man${f##*.}/$f
                ;;
        (*/cat[123456789n]/*.0|*/cat3p/*.0)
                x=${f%/*}
                f=${f##*/}
                f=cat${x##*cat}/$f
                ;;
        (*)
                print -u2 "link looks like manpage but ignored: ${f#$sd/}"
                continue ;;
        }
        if ! ln $dd/$t $dd/$f 2>/dev/null; then
                print -u2 "cannot link $f ← $t"
                rm -f $dd/$f
        fi
done

# look for which nroff to use
if whence -p nroff >/dev/null; then
        if whence -p nrcon >/dev/null; then
                NROFF="nroff -Tcol -mandoc"
        elif [[ "$(print | nroff -v 2>&1)" = *GNU* ]]; then
                NROFF="nroff -c -Tascii -mandoc"
        else
                NROFF="nroff -man"
        fi
elif whence -p gnroff >/dev/null; then
        NROFF="gnroff -c -Tascii -mandoc"
elif whence -p groff >/dev/null; then
        NROFF="groff -c -Tascii -mandoc"
else
        NROFF=cat
        print -u2 warning: no nroff found, install GNU groff please
fi

# convert manpages from source format to catman pages
for sect in 1 2 3 3p 4 5 6 7 8 9 n; do
        cd $dd/man$sect
        for file in *; do
                [[ -e $file ]] || continue
                typeset -Uui ino=$(stat $roff2htm_statarg %i $file 2>/dev/null)
                typeset dn=$sect/${file%.*}.0

                (( ino )) && if [[ -n ${roff2htm_inodecache[ino]} ]]; then
                        print -u2 linking page $dn ← ${roff2htm_inodecache[ino]}
                        ln -f $dd/cat${roff2htm_inodecache[ino]} $dd/cat$dn
                        continue
                else
                        roff2htm_inodecache[ino]=$dn
                fi
                print -nu2 formatting manual page ${file%.*}.$sect ...
                $NROFF $file >$dd/cat$dn
                print -u2 \ done
        done
done

# empty the inode cache again
set -A roff2htm_inodecache

# convert all catman pages to HTML
cd $dd; convert_all . ./htman

# generate an index page for the package
haveany=0
{
        output_header | \
            sed -e "/<title>/s/()/for package $3/" -e '/<h1>/d'
        print "<h1>FreeWRT $3 package manual</h1>
<p>The $3 package comes with the following manual pages:</p><ul>"
        (cd $dd/htman; find man* -name \*.htm | sort -f) |&
        while read -p file; do
                haveany=1
                bn=${file%.htm}
                sect=${file#man}
                print "<li><a href=\"../$file\">${bn#*/}(${sect%/*})</a></li>"
        done
        print '</ul>'
        #XXX TODO: insert link to package ${HOMEPAGE} here once we have it
        output_footer | \
            sed -e '/<tt>/s
</tt>
& and <tt>$Id$&
'
} >$dd/htman/pkgs/$3.htm
[[ $haveany = 1 ]] || rm -f $dd/htman/pkgs/$3.htm

exit 0