Date: Fri, 6 Aug 2004 19:49:23 +0100 From: Matthew Seaman <m.seaman@infracaninophile.co.uk> To: Tom Munro Glass <gentoo@tmgcon.com> Cc: freebsd-questions@freebsd.org Subject: Re: Updating local copy of documentation Message-ID: <20040806184922.GA91576@happy-idiot-talk.infracaninophile.co.uk> In-Reply-To: <200408061541.19592.gentoo@tmgcon.com> References: <200408061541.19592.gentoo@tmgcon.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--AhhlLboLdkugWU4S
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
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 th=
e=20
> articles and books directories under /usr/share/doc/ including the essent=
ial=20
> handbook.
>=20
> Is there a way of automatically updating this documentation - I thought t=
hat=20
> maybe this was done as a part of cvsup, make buildworld, etc, but apparen=
tly=20
> not? I realise that I can download the latest version with FTP, but it wo=
uld=20
> 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=3DCHANGE_THIS.FreeBSD.org
*default base=3D/usr
*default prefix=3D/usr
*default release=3Dcvs tag=3D.
*default delete use-rel-suffix
*default compress
=20
doc-all
A handy way of doing that is simply to make the following settings in
/etc/make.conf:
SUP_UPDATE=3D yes
#
SUP=3D /usr/local/bin/cvsup
SUPFLAGS=3D -g -L 2
SUPHOST=3D CHANGE_THIS.FreeBSD.org
SUPFILE=3D /usr/share/examples/cvsup/stable-supfile
PORTSSUPFILE=3D /usr/share/examples/cvsup/ports-supfile
DOCSUPFILE=3D /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
--=20
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
--AhhlLboLdkugWU4S
Content-Type: application/pgp-signature
Content-Disposition: inline
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.5 (FreeBSD)
iD8DBQFBE9KyiD657aJF7eIRAmiGAJ9tI7uC82aKyv7hCjyN926H9wPiSACfX5KJ
NC5CO5/Q3A27C2AFxsT2CYE=
=apXp
-----END PGP SIGNATURE-----
--AhhlLboLdkugWU4S--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040806184922.GA91576>