Updating local copy of documentation

[Matthew Seaman]

On Fri, Aug 06, 2004 at 03:41:19PM +1200, Tom Munro Glass wrote:
> When you install FreeBSD, lots of useful documentation is installed in the 
> articles and books directories under /usr/share/doc/ including the essential 
> handbook.
> 
> Is there a way of automatically updating this documentation - I thought that 
> maybe this was done as a part of cvsup, make buildworld, etc, but apparently 
> not? I realise that I can download the latest version with FTP, but it would 
> be nice if this could be done as part of the normal maintenance tasks.

Yes, you can update the doc sources using cvsup(1), and build them
locally.  You need to install one of the textproc/docproj ports
(install one with jadetex if you want to be able to create PDF
output), and use a supfile like so:

    *default host=CHANGE_THIS.FreeBSD.org
    *default base=/usr
    *default prefix=/usr
    *default release=cvs tag=.
    *default delete use-rel-suffix
    *default compress
    
    doc-all

A handy way of doing that is simply to make the following settings in
/etc/make.conf:

    SUP_UPDATE=     yes
    #
    SUP=            /usr/local/bin/cvsup
    SUPFLAGS=       -g -L 2
    SUPHOST=        CHANGE_THIS.FreeBSD.org
    SUPFILE=        /usr/share/examples/cvsup/stable-supfile
    PORTSSUPFILE=   /usr/share/examples/cvsup/ports-supfile
    DOCSUPFILE=     /usr/share/examples/cvsup/doc-supfile

Then you can just type 'make update' in either /usr/src or in /usr/doc
to pull down the latest sources.

Note that will bring down the sources for all of the different
language versions of the docs. If you just want the English versions,
you can use a refuse file like:

    doc/bn_*
    doc/da_*
    doc/de_*
    doc/el_*
    doc/es_*
    doc/fr_*
    doc/it_*
    doc/ja_*
    doc/nl_*
    doc/no_*
    doc/pl_*
    doc/pt_*
    doc/ru_*
    doc/sr_*
    doc/tr_*
    doc/zh_*

As ever, start by reading the documentation, in this the FreeBSD
Documentation Project Primer:

    http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/index.html

Note that locally built copies of the documentation end up somewhere
below /usr/doc/en_US.ISO8859-1, unlike the copy of the handbook
installed with the system in /usr/share/doc

	Cheers,

	Matthew

-- 
Dr Matthew J Seaman MA, D.Phil.                       26 The Paddocks
                                                      Savill Way
PGP: http://www.infracaninophile.co.uk/pgpkey         Marlow
Tel: +44 1628 476614                                  Bucks., SL7 1TH UK
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/freebsd-questions/attachments/20040806/3a830c7e/attachment-0001.bin