From nbm@mithrandr.moria.org Wed Oct 6 07:49:14 1999 Return-Path: Received: from terrapin.ru.ac.za (terrapin.ru.ac.za [146.231.128.6]) by hub.freebsd.org (Postfix) with ESMTP id 6A4F7155B3 for ; Wed, 6 Oct 1999 07:49:05 -0700 (PDT) (envelope-from nbm@mithrandr.moria.org) Received: from duca.dialup.ru.ac.za ([146.231.98.24] helo=mithrandr.moria.org) by terrapin.ru.ac.za with esmtp (Exim 3.03 #1) id 11YsNJ-000LXv-00 for FreeBSD-gnats-submit@freebsd.org; Wed, 06 Oct 1999 16:49:01 +0200 Received: (qmail 34123 invoked by uid 1001); 6 Oct 1999 14:24:29 -0000 Message-Id: <19991006142429.34122.qmail@mithrandr.moria.org> Date: 6 Oct 1999 14:24:29 -0000 From: nbm@rucus.ru.ac.za Sender: nbm@mithrandr.moria.org Reply-To: nbm@rucus.ru.ac.za To: FreeBSD-gnats-submit@freebsd.org Subject: FDP introduction article X-Send-Pr-Version: 3.2 >Number: 14165 >Category: docs >Synopsis: FDP introduction article >Confidential: no >Severity: non-critical >Priority: low >Responsible: nbm >State: closed >Quarter: >Keywords: >Date-Required: >Class: change-request >Submitter-Id: current-users >Arrival-Date: Wed Oct 6 07:50:01 PDT 1999 >Closed-Date: Wed Aug 13 03:03:46 PDT 2003 >Last-Modified: Wed Aug 13 03:03:46 PDT 2003 >Originator: Neil Blakey-Milner >Release: FreeBSD 4.0-CURRENT i386 >Organization: Rhodes University Computer Users' Society >Environment: FreeBSD mithrandr.moria.org 4.0-CURRENT FreeBSD 4.0-CURRENT #2: Wed Sep 29 17:30:21 SAST 1999 root@mithrandr.moria.org:/usr/src/sys/compile/MITHRANDR i386 >Description: This provides an index of the (English) documentation provided by the FreeBSD Documentation Project. It installs as /usr/share/doc/index.en_US.ISO_8859-1.html, and index.html is symlinked to it, if English is the primary language. This could be used as an index for a web server whose root is /usr/share/doc (which is what I have). >How-To-Repeat: >Fix: # This is a shell archive. Save it in a file, remove anything before # this line, and then unpack it by entering "sh file". Note, it may # create directories; files and directories will be owned by you and # have default permissions. # # This archive contains: # # introduction # introduction/article.sgml # introduction/Makefile # echo c - introduction mkdir -p introduction > /dev/null 2>&1 echo x - introduction/article.sgml sed 's/^X//' >introduction/article.sgml << 'END-of-introduction/article.sgml' X X%man; X X%authors; X]> X X
X X Introduction to FreeBSD Documentation X X X The FreeBSD Documentation Project X X
doc@FreeBSD.org
X X X X X 1999 X The FreeBSD Documentation X Project X X X September 1999 X X X This is an overview of the documents in the FreeBSD X Documentation Project. X X X X X Books X X X The FreeBSD Handbook X X The FreeBSD X Handbook is the reference for X the installation and day-to-day running of the latest FreeBSD X release. X X It also covers the history of the FreeBSD Project, and the X names of contributors and developers, and contact addresses X for various important people and mailing lists. X X X X The FreeBSD FAQ X X The FreeBSD X FAQ contains Frequently Asked Questions about X FreeBSD and the FreeBSD Project, and answers to them. X X X X The FreeBSD Documentation Project Primer X X Want to contribute to the Documentation Project? Read the X FreeBSD X Documentation Project Primer to learn how! X X X X The Pedantic PPP Primer X X The Pedantic PPP X Primer is a step-by-step guide to using user-mode X ppp, the preferred method to do ppp and dial-up on X FreeBSD! X X X X X Articles X X X New Users Guide X X The New X Users' Guide is an overview of concepts integral to X understanding FreeBSD and other Unix-like operating system, X aimed at new users. X X X X Installing and using FreeBSD with other operating X systems X X The Multi-Os X tutorial explains how to run multiple operating X systems on your computer (also known as dual-booting or X multi-booting). X X X X Formatting Media X X A how-to on X formatting media for use with FreeBSD, covering hard X disks, adding swap space, copying contents of disks, and X striping disks using CCD. X X X X Fonts and FreeBSD X X A tutorial on using X fonts in FreeBSD, on virtual consoles and in X applications like X, ghostscript, and groff. X X X X MH X X The MH X primer on the use of the suite of mail tools X included in the application MH. X X X X Programming Tools on FreeBSD X X An overview of available Programming X Tools available on FreeBSD, both in the base system, X and in ports. X X X X
END-of-introduction/article.sgml echo x - introduction/Makefile sed 's/^X//' >introduction/Makefile << 'END-of-introduction/Makefile' X# X# $FreeBSD$ X# X# Build the Introducation to FreeBSD Documentation X# X XMAINTAINER= nbm@rucus.ru.ac.za X XMASTERDOC?= ${.CURDIR}/article.sgml XDOC?= index.${LANGCODE} X XFORMATS?= html XLANGCODE= en_US.ISO_8859-1 X XINSTALL_COMPRESSED?= XINSTALL_ONLY_COMPRESSED?= X X# SGML content XSRCS= article.sgml X XDESTDIR?= ${DOCDIR}/ X XDOC_PREFIX?= ${.CURDIR}/../../.. X.include "${DOC_PREFIX}/share/mk/doc.project.mk" X Xsymlinks: X.if ${PRI_LANG} == ${LANGCODE} X.for _tmp in ${FORMATS} X (cd ${DOCDIR} && ln -sf ${DOC}.${_tmp} ${DOC:R:R}.${_tmp}) X.endfor X.endif X END-of-introduction/Makefile exit >Release-Note: >Audit-Trail: From: Nik Clayton To: nbm@rucus.ru.ac.za Cc: FreeBSD-gnats-submit@freebsd.org Subject: Re: docs/14165: FDP introduction article Date: Tue, 26 Oct 1999 21:51:25 +0100 On Wed, Oct 06, 1999 at 02:24:29PM -0000, nbm@rucus.ru.ac.za wrote: > >Synopsis: FDP introduction article <...> > >Description: > > This provides an index of the (English) documentation provided by > the FreeBSD Documentation Project. It installs as > /usr/share/doc/index.en_US.ISO_8859-1.html, and index.html is > symlinked to it, if English is the primary language. Assuming for the moment that the effort underway to automatically generate a hyperlinked list of pointers to documentation about ports/packages available on the local machine succeeds (I hope it does), and further assuming that this effort will need to read files in /var/db/pkg (COMMENT and DESCR, to name two) in order to build this list, and knowing that the documentation is now pkg_add'able. . . . . . would we not be better off massaging the package target to automatically pull out the title and/or from each document, as text for COMMENT and DESCR files (assuming they didn't already exist). "make install" could be tweaked to do the install, and then put the necessary files in /var/db/pkg (I'm somewhat hazy about how the ports system does this). The docs would then automatically appear on this automatically generated list of links to documentation. The list would also be up to date with respect to the documentation the user had actually installed. Thoughts? N Responsible-Changed-From-To: freebsd-doc->nbm Responsible-Changed-By: asmodai Responsible-Changed-When: Wed Dec 22 07:53:44 PST 1999 Responsible-Changed-Why: Let Neil use his commit bit to close his own PR's. =) State-Changed-From-To: open->closed State-Changed-By: nbm State-Changed-When: Wed Aug 13 03:02:56 PDT 2003 State-Changed-Why: No use having this relic of mine hang about. http://www.freebsd.org/cgi/query-pr.cgi?pr=14165 >Unformatted: