Date: 6 Oct 1999 14:24:29 -0000 From: nbm@rucus.ru.ac.za To: FreeBSD-gnats-submit@freebsd.org Subject: docs/14165: FDP introduction article Message-ID: <19991006142429.34122.qmail@mithrandr.moria.org>
next in thread | raw e-mail | index | archive | help
>Number: 14165
>Category: docs
>Synopsis: FDP introduction article
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: change-request
>Submitter-Id: current-users
>Arrival-Date: Wed Oct 6 07:50:01 PDT 1999
>Closed-Date:
>Last-Modified:
>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<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
X<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
X%man;
X<!ENTITY % authors PUBLIC "-//FreeBSD//ENTITIES DocBook Author Entities//EN">
X%authors;
X]>
X
X<article>
X <artheader>
X <title>Introduction to FreeBSD Documentation</title>
X
X <author>
X <surname>The FreeBSD Documentation Project</surname>
X <affiliation>
X <address><email>doc@FreeBSD.org</email></address>
X </affiliation>
X </author>
X
X <copyright>
X <year>1999</year>
X <holder role="mailto:doc@FreeBSD.org">The FreeBSD Documentation
X Project</holder>
X </copyright>
X
X <pubdate>September 1999</pubdate>
X
X <abstract>
X <para>This is an overview of the documents in the FreeBSD
X Documentation Project.</para>
X </abstract>
X </artheader>
X
X <sect1>
X <title>Books</title>
X
X <sect2>
X <title>The FreeBSD Handbook</title>
X
X <para>The <ulink url="en_US.ISO_8859-1/books/handbook/">FreeBSD
X Handbook</ulink> is <emphasis>the</emphasis> reference for
X the installation and day-to-day running of the latest FreeBSD
X release.</para>
X
X <para>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.</para>
X </sect2>
X
X <sect2>
X <title>The FreeBSD FAQ</title>
X
X <para>The <ulink url="en_US.ISO_8859-1/books/faq/">FreeBSD
X FAQ</ulink> contains Frequently Asked Questions about
X FreeBSD and the FreeBSD Project, and answers to them.</para>
X </sect2>
X
X <sect2>
X <title>The FreeBSD Documentation Project Primer</title>
X
X <para>Want to contribute to the Documentation Project? Read the
X <ulink url="en_US.ISO_8859-1/books/fdp-primer/">FreeBSD
X Documentation Project Primer</ulink> to learn how!</para>
X </sect2>
X
X <sect2>
X <title>The Pedantic PPP Primer</title>
X
X <para>The <ulink
X url="en_US.ISO_8859-1/books/ppp-primer/">Pedantic PPP
X Primer</ulink> is a step-by-step guide to using user-mode
X ppp, the preferred method to do ppp and dial-up on
X FreeBSD!</para>
X </sect2>
X </sect1>
X
X <sect1>
X <title>Articles</title>
X
X <sect2>
X <title>New Users Guide</title>
X
X <para>The <ulink
X url="en_US.ISO_8859-1/articles/new-users/article.html">New
X Users' Guide</ulink> is an overview of concepts integral to
X understanding FreeBSD and other Unix-like operating system,
X aimed at new users.</para>
X </sect2>
X
X <sect2>
X <title>Installing and using FreeBSD with other operating
X systems</title>
X
X <para>The <ulink
X url="en_US.ISO_8859-1/articles/multi-os/article.html">Multi-Os
X tutorial</ulink> explains how to run multiple operating
X systems on your computer (also known as dual-booting or
X multi-booting).</para>
X </sect2>
X
X <sect2>
X <title>Formatting Media</title>
X
X <para>A how-to on <ulink
X url="en_US.ISO_8859-1/articles/formatting-media/article.html">
X formatting media</ulink> for use with FreeBSD, covering hard
X disks, adding swap space, copying contents of disks, and
X striping disks using CCD.</para>
X </sect2>
X
X <sect2>
X <title>Fonts and FreeBSD</title>
X
X <para>A tutorial on <ulink
X url="en_US.ISO_8859-1/articles/fonts/article.html">using
X fonts in FreeBSD</ulink>, on virtual consoles and in
X applications like X, ghostscript, and groff.</para>
X </sect2>
X
X <sect2>
X <title>MH</title>
X
X <para>The <ulink
X url="en_US.ISO_8859-1/articles/mh/article.html">MH
X primer</ulink> on the use of the suite of mail tools
X included in the application MH.</para>
X </sect2>
X
X <sect2>
X <title>Programming Tools on FreeBSD</title>
X
X <para>An overview of available <ulink
X url="en_US.ISO_8859-1/articles/programming-tools/article.html">Programming
X Tools</ulink> available on FreeBSD, both in the base system,
X and in ports.</para>
X </sect2>
X </sect1>
X
X</article>
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:
>Unformatted:
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?19991006142429.34122.qmail>