Date: Fri, 5 Jan 2001 09:49:05 +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: <20010105094905.B9043@canyon.nothing-going-on.org> In-Reply-To: <200101041921.f04JLln10537@bmah-freebsd-0.cisco.com>; from bmah@FreeBSD.ORG on Thu, Jan 04, 2001 at 11:21:47AM -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> <20010104171209.A4373@canyon.nothing-going-on.org> <200101041921.f04JLln10537@bmah-freebsd-0.cisco.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Jan 04, 2001 at 11:21:47AM -0800, Bruce A. Mah wrote: > If memory serves me right, Nik Clayton wrote: > > > 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). > > Hmmm. Interesting. Guess when/if I understand more about the > doc-building process I'll know why. The $FORMATS variable contains a space separated list of document formats that you want to build. If you specify 'html' or 'html-split' then HTML output is produced. However, unlike *every other format*, these are not self contained. For example, you might need to bundle up images with it before you can transport them. For this reason, we also have the 'html.tar' and 'html-split.tar' formats, which produce a tarball containing everything required to transport the documentation. When you do "make INSTALL_ONLY_COMPRESSED=yes install" compressed versions of the documents are generated and installed. book.ps.gz, book.rtf.gz, book.txt.gz, and so on. If the formats are 'html' or 'html-split' it makes no sense to compress them. Granted, you could install a book.html.gz, but what if that document uses images? Do you compress them first as well? And if the format is 'html-split', do you compress each individual .html file? It's for this reason that if you do "make INSTALL_ONLY_COMPRESSED=yes install" the html and html-split FORMATS are ignored. You have to explicitly include html.tar and html-split.tar in the list of formats, which will give you a book.html.tar.gz and book.html-split.tar.gz file. > > 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. > > OK, got it. For some reason I thought that since the Web pages got > rebuilt automatically, the doc files did too. The documentation on the web site is built twice daily. It's just the files under doc/ on the FTP site that get built manually once a week or so. N -- 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 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?20010105094905.B9043>