Updating local copy of documentation

2004-08-06 Thread Tom Munro Glass
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.

Regards,

Tom Munro Glass
___
[EMAIL PROTECTED] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-questions
To unsubscribe, send any mail to [EMAIL PROTECTED]


Re: Updating local copy of documentation

2004-08-06 Thread Kevin D. Kinsey, DaleCo, S.P.
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.

Regards,
Tom Munro Glass
 

You'd do it in similar fashion; in fact you could rather easily
script it, I suppose.
$cvsup doc-all[*]  
$cd /usr/doc  make install clean

*see /usr/share/examples/cvsup/doc-supfile for details.
HTH,
Kevin Kinsey
DaleCo, S.P.
___
[EMAIL PROTECTED] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-questions
To unsubscribe, send any mail to [EMAIL PROTECTED]


Re: Updating local copy of documentation

2004-08-06 Thread 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


pgpxkNBN0Ya6X.pgp
Description: PGP signature


Re: Updating local copy of documentation

2004-08-06 Thread Daniel Bye
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.

You can get the latest version of hte docs using CVSup.  This is the
CVSUP file I use for that very purpose:

## BEGIN
*default host=cvsup.uk.FreeBSD.org
*default base=/usr
*default prefix=/usr
*default release=cvs tag=.
*default delete use-rel-suffix
*default compress
doc-all
## END

Naturally, you will want to change the host= to one near to you.

To have the docs updated when you do a `make update', you need to ensure
that you have `DOCSUPFILE=/path/to/doc-supfile' set in /etc/make.conf.

To save time and disk space, you can also tell the build system to only
build docs in one language, using `DOC_LANG=en_US.ISO8859-1' in
/etc/make.conf

Once you have gotten the latest sources, 

# cd /usr/doc
# make all install clean

and all should be well.  Note that you will need to install the
textproc/docproj port to be able to build the docs from the source.  You
can get more info at
http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/

HTH

Dan

-- 
Daniel Bye

PGP Key: ftp://ftp.slightlystrange.org/pgpkey/dan.asc
PGP Key fingerprint: 3B9D 8BBB EB03 BA83 5DB4 3B88 86FC F03A 90A1 BE8F
 _
  ASCII ribbon campaign ( )
 - against HTML, vCards and  X
- proprietary attachments in e-mail / \


pgphYNnMWmak3.pgp
Description: PGP signature


Re: Updating local copy of documentation

2004-08-06 Thread Lowell Gilbert
Tom Munro Glass [EMAIL PROTECTED] writes:

 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.

You can build it from source (see the Documentation Project Handbook),
but it would be a lot less work to just download the prebuilt ones.
It should be a pretty simple matter to do that in a script that you
can add to your normal maintenance tasks.

Note that building the documentation requires you to install quite a
bit of software.  There's a port for it, of course, but if you're not
going to use jadetex (as one obvious example) for anything else, it's
overkill.  Especially if you're not going to try modifying the docs,
but just build them occasionally.
___
[EMAIL PROTECTED] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-questions
To unsubscribe, send any mail to [EMAIL PROTECTED]


Re: Updating local copy of documentation

2004-08-06 Thread Tom Munro Glass
On Saturday 07 August 2004 07:44, Lowell Gilbert wrote:
 You can build it from source (see the Documentation Project Handbook),
 but it would be a lot less work to just download the prebuilt ones.
 It should be a pretty simple matter to do that in a script that you
 can add to your normal maintenance tasks.

 Note that building the documentation requires you to install quite a
 bit of software.  There's a port for it, of course, but if you're not
 going to use jadetex (as one obvious example) for anything else, it's
 overkill.  Especially if you're not going to try modifying the docs,
 but just build them occasionally.

Thanks to all who replied - this list is SO helpful.

Tom
___
[EMAIL PROTECTED] mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-questions
To unsubscribe, send any mail to [EMAIL PROTECTED]