Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 4 Jan 2001 17:12:09 +0000
From:      Nik Clayton <nik@freebsd.org>
To:        "Bruce A. Mah" <bmah@freebsd.org>
Cc:        Nik Clayton <nik@freebsd.org>, sam1600@iname.com, doc@freebsd.org
Subject:   Re: freebsd manual in html format?
Message-ID:  <20010104171209.A4373@canyon.nothing-going-on.org>
In-Reply-To: <200101031838.f03Icjm65863@bmah-freebsd-0.cisco.com>; from bmah@freebsd.org on Wed, Jan 03, 2001 at 10:38:45AM -0800
References:  <001227101708E0.28727@weba4.iname.net> <200012291850.eBTIoHJ24177@bmah-freebsd-0.cisco.com> <20010101213447.A349@canyon.nothing-going-on.org> <200101031838.f03Icjm65863@bmah-freebsd-0.cisco.com>

next in thread | previous in thread | raw e-mail | index | archive | help

--1yeeQ81UyVL57Vl7
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Wed, Jan 03, 2001 at 10:38:45AM -0800, Bruce A. Mah wrote:
> If memory serves me right, Nik Clayton wrote:
> > On Fri, Dec 29, 2000 at 10:50:16AM -0800, Bruce A. Mah wrote:
> > > > Please tell me where I can download the freebsd
> > > > manual in html format.
> > > > 
> > > > I looked here:
> > > > ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/handbook/
> > > 
> > > I'm not sure the handbook is available from the FreeBSD FTP server as a
> > > single HTML file.  
> > 
> > It certainly should be.  See question 17 of the FAQ.
> 
> I agree that it should be, but the original poster said he couldn't 
> find it and I can't either.  This is where I just looked:
> 
> ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/en_US.ISO_8859-1/books/handbook/
> 
> We have versions of the handbook in pdb, pdf, ps, rtf, and txt format, 
> compressed with bz2, gz, and zip.  HTML is not one of these.  :-(  I'm 
> not that familiar with the way we build the docs for our Web site, so I 
> can't comment further.

Bug in my script[1].  Specifically, if you

    make FORMATS=html\ html-split INSTALL_ONLY_COMPRESSED=yes install

it won't do anything.  FORMATS needs to contain html.tar and
html-split.tar, so that the tarballs are built (which makes sense, in a
perverse sort of way).

> One other thing I noticed:  the modification dates for the
> aforementioned files are all "Dec 20 00:47".  Are these files supposed
> to get updated more frequently?

Periodically, when I remember.  Typically, once a week (sometimes a bit
more if I've been on holiday, as I was last week).

I've got a machine inside the uk.bsdi.com domain which keeps an up to
date CVS tree on it.  Periodically I run the attached script, which does
the build.  Then I've got an account on ftp.freesoftware.com, and I run
mirror(1), which brings the updated files on to the FTP site.

The build doesn't happen automatically because the machine I do the
builds on has variable load, and I try and time it so the machine's only
lightly used.  Also, I've had zero time to invest in completely
automating this.  Of course, should anyone want to, this is exactly the
sort of thing that can be cleaned up and put in something like
doc/share/examples/.

N

PS:  'my' script?  The vast majority of this was written by Alexey a
     while ago.  His script, my bug :-)
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery

--1yeeQ81UyVL57Vl7
Content-Type: application/x-sh
Content-Disposition: attachment; filename="build-doc-packages2.sh"

#!/bin/sh
#
# Build an updated package collection of the FreeBSD docs
#
# $FreeBSD$
#

# Responsible.
MAILERRORSTO=nik

# Formats to build
FORMATS="html html-split txt ps pdf rtf pdb"
#FORMATS="html html-split ps pdf txt rtf"

# Build area.  Either set this to something else, or symlink it to a
# directory as necessary.
TMPDIR=/home/nik/doc-build/build

# Subdirectory used to store old logs.
LOGDIR=/home/nik/doc-build/logs

# Current date (format YYMMDD).  Will be used to store logs.
DT=`LANG=C date +%y%m%d`

# Log file names
CVSLOG=$LOGDIR/tmp/cvs.log.$DT
BUILDLOG=$LOGDIR/tmp/build.log.$DT

# Compress logs and move out of the temporary directories
backup_logs () {
    gzip $CVSLOG
    mv $CVSLOG.gz $LOGDIR/
    gzip $BUILDLOG
    mv $BUILDLOG.gz $LOGDIR/
}

# Check log directory for existence.
if [ ! -d $LOGDIR ]; then
    mkdir -p $LOGDIR
    if [ $? != 0 ]; then
        echo mkdir $LOGDIR failed.
        exit 1
    fi
fi

# Remove and re-create temporary log directory for current build logs.
# It will clean up stale logs.
rm -fr $LOGDIR/tmp
mkdir -p $LOGDIR/tmp

# Test for the existence of the build directory, create as necessary,
# and then cd there
if [ ! -d $TMPDIR ]; then
    mkdir -p $TMPDIR
    if [ $? != 0 ]; then
	echo mkdir $TMPDIR failed.
	exit 1
    fi
fi

cd $TMPDIR
if [ $? != 0 ]; then
    echo Could not cd to $TMPDIR.
    exit 1
fi

# Clean out everything that's gone before
rm -rf *
if [ $? != 0 ]; then
    echo rm -rf failed.
    exit 1;
fi

# Check out a fresh tree, then create the package building area
cvs -q -d /home/ncvs checkout -P doc > $CVSLOG 2>&1
cd doc
mkdir packages
mkdir archives

# Do the build.  First, build all the packages
#
# NIK_DOC_BUILD is a hack.  The machine most of the builds are done on
# has 
#
#   .if !defined(NIK_DOC_BUILD)
#   DOC_LANG=en_US.ISO_8859-1
#   .endif
#
# in /etc/make.conf
make -i-DNIK_DOC_BUILD FORMATS="$FORMATS" package > $BUILDLOG 2>&1
if [ $? != 0 ]; then
    tail -100 $BUILDLOG | \
	mail -s "Doc build at `LANG=C date +%y.%m.%d` failed" $MAILERRORSTO
    backup_logs
    exit 1
fi

# Now, build the various other compressed formats.  Should take less time,
# as the stuff's already built.  No need to check for errors either.
make -i -DNIK_DOC_BUILD FORMATS="$FORMATS html.tar html-split.tar" INSTALL_COMPRESSED="gz bz2 zip" INSTALL_ONLY_COMPRESSED=yes DOCDIR=${TMPDIR}/doc/archives install

# Upload (?) updated packages somewhere ?

cd packages

#
#
#

backup_logs

# Remove temporary directories
rm -r $LOGDIR/tmp


--1yeeQ81UyVL57Vl7--


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010104171209.A4373>