Date: Thu, 19 Aug 1999 01:04:01 +0400 (MSD) From: "Alexey M. Zelkin" <phantom@cris.net> To: nik@FreeBSD.ORG (Nik Clayton) Cc: doc@FreeBSD.ORG Subject: Re: Default FDP docs installation directory? Message-ID: <199908182104.BAA04851@scorpion.crimea.ua> In-Reply-To: <19990818121931.A4266@kilt.nothing-going-on.org> from Nik Clayton at "Aug 18, 99 12:19:31 pm"
next in thread | previous in thread | raw e-mail | index | archive | help
hi,
> Historically, the documentation has been installed in to /usr/doc. This
Maybe /usr/share/doc ?
> includes the standard BSD documentation, and the FreeBSD specific
> stuff, such as the FAQ and the Handbook.
> The Makefile's I've committed so far install the docs in to
>
> /usr/local/share/doc/fdp/<lang>/<type>/<doc name>/
Why /usr/local/share/doc ? Only ports documentation is going there as I
remember. Really I don't see any reason to install documentation to new
location, because of it's not 3rd party product docs.
Next point: if we're still using /usr/share/doc we need not to
add new entity - "fdp". I sure that it's better to enter
$ lynx file:///usr/share/doc/en/
than
$ lynx file:///usr/local/share/doc/fdp/en/
First is more intuitive, I think.
> where
>
> <lang> en_US.ISO_8859-1 and friends
>
> <type> books/, articles/, man/
>
> <doc name> faq/, handbook/, programming-tools/
>
> In addition, a language compatability symlink is installed. So
> /usr/local/share/doc/fdp/en is a symlink to
> /usr/local/share/doc/fdp/en_US.ISO_8859-1, and
> /usr/local/share/doc/fdp/ja_JP.eucJP is a symlink to
> /usr/local/share/doc/fdp/ja (yes, Japanese team, I hadn't forgotten your
> comments and concerns).
Just idea: make something like "default" handbook, FAQ, tutorial (sure that it
should be english handbook by default)
.../doc/en/handbook -> .../doc/handbook
.../doc/en/FAQ -> .../doc/FAQ
.../doc/en/tutorial -> .../doc/tutorial
> This is the best scheme I could come up. It keeps the FDP stuff
> away from documentation from other packages that might be installed (for
> example, /usr/local/share/doc/{mutt,apache,jade,bzip2} and others all exist
> on my system), and it's extendable.
Looks like FreeBSD Documentaion is going to stay port. :-)
> One more thing -- A mid-term goal is for the pre-built docs (HTML, PS, PDF
> and so on) to be distributed as binary packages, to be managed using the
> pkg_* family. I'm pretty certain this precludes putting the documentation
> anywhere other than a subdirectory of /usr/local/, so the old /usr/doc/
> directory is right out.
$LOCALBASE variable will help you, I hope. By default it setting in
/usr/local, but it can be overridden to i.e. /usr/share.
--
Sincerely Yours, | phantom@crimea.edu (primary)
Alexey Zelkin | phantom@scorpion.crimea.ua (home)
| ICQ: #6196584, FIDO: 2:460/12.26
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?199908182104.BAA04851>