Home | History | Annotate | only in /src/share/doc/smm
History log of /src/share/doc/smm
RevisionDateAuthorComments
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 21-Mar-1993  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 19-Jun-1994  cgd new doc set from Lite
 1.1.1.1 21-Mar-1993  cgd initial import of 386bsd-0.1 sources
 1.21 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.20 29-Nov-2007  mjf branches: 1.20.34; 1.20.46;
Commit Caldera licensed documentation from 4.4BSD. This was taken from the
OpenBSD tree.

No objections on netbsd-docs.
 1.19 11-Jan-2004  lukem branches: 1.19.22;
check MKDOC instead of MKSHARE
 1.18 10-Jul-2003  lukem Rename a large chunk of the make(1) variables which refer to a
program/tool from "FOO" to "TOOL_FOO". The new variables are:
TOOL_ASN1_COMPILE TOOL_CAP_MKDB TOOL_CAT TOOL_CKSUM TOOL_COMPILE_ET
TOOL_CONFIG TOOL_CRUNCHGEN TOOL_CTAGS TOOL_DB TOOL_EQN TOOL_FGEN
TOOL_GENCAT TOOL_GROFF TOOL_HEXDUMP TOOL_INDXBIB TOOL_INSTALLBOOT
TOOL_INSTALL_INFO TOOL_M4 TOOL_MAKEFS TOOL_MAKEINFO TOOL_MAKEWHATIS
TOOL_MDSETIMAGE TOOL_MENUC TOOL_MKCSMAPPER TOOL_MKESDB
TOOL_MKLOCALE TOOL_MKMAGIC TOOL_MKTEMP TOOL_MSGC TOOL_MTREE
TOOL_PAX TOOL_PIC TOOL_PREPMKBOOTIMAGE TOOL_PWD_MKDB TOOL_REFER
TOOL_ROFF_ASCII TOOL_ROFF_DVI TOOL_ROFF_HTML TOOL_ROFF_PS
TOOL_ROFF_RAW TOOL_RPCGEN TOOL_SOELIM TOOL_SUNLABEL TOOL_TBL
TOOL_UUDECODE TOOL_VGRIND TOOL_ZIC

For each, provide default in <bsd.sys.mk> of the form:
TOOL_FOO?= foo
and for the ${USETOOLS}=="yes" case in <bsd.own.mk>, provide override:
TOOL_FOO= ${TOOLDIR}/bin/${_TOOL_PREFIX}foo

Document all of these in bsd.README.

This cleans up a chunk of potential (and actual) namespace collision
within our build infrastructure, as well as improves consistency in
the share/mk documentation and provision of appropriate defaults for
each of these variables.
 1.17 14-Feb-1999  lukem yet *more* bsd.own.mk stuff i missed... :(
 1.16 13-Feb-1999  lukem convert from NOxxx= to MKxxx=no.
include <bsd.own.mk> if testing a MKxxx variable.
 1.15 27-Sep-1998  lukem don't install in /usr/share if NOSHARE is defined
 1.14 21-Dec-1997  christos Timed and timedops are in /usr/src/usr.sbin/timed/SMM.doc, not missing.
 1.13 17-Oct-1997  mrg merge lite-2.
 1.12 13-Oct-1997  lukem rcsid fascism
 1.11 24-Mar-1997  christos - Makefile cleanups
 1.10 18-Oct-1996  thorpej Use ${INSTALL}.
 1.9 05-Apr-1996  cgd SMM '03.fsck' has been renamed '03.fsck_ffs'
 1.8 25-Jun-1994  cgd slight mod to the way in-source docs are handled
 1.7 19-Jun-1994  cgd make it work
 1.6 19-Jun-1994  cgd clean up import
 1.5 10-Feb-1994  cgd kill bogus install -d's, and clean slightly
 1.4 30-Sep-1993  jtc Always use `install -d' to make sure destination directory exists & has
correct ownership and permissions.
 1.3 31-Jul-1993  mycroft Add RCS indentifiers.
 1.2 09-Apr-1993  cgd make sure directory to install stuff exists before installing
 1.1 21-Mar-1993  cgd branches: 1.1.1;
Initial revision
 1.1.1.3 28-Apr-1995  mrg 4.4BSD-Lite2
 1.1.1.2 19-Jun-1994  cgd new doc set from Lite
 1.1.1.1 21-Mar-1993  cgd initial import of 386bsd-0.1 sources
 1.19.22.1 09-Jan-2008  matt sync with HEAD
 1.20.46.1 10-Aug-2014  tls Rebase.
 1.20.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.4 01-Oct-2014  christos apply the roman numeral page number fix from psd/Title
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 21-Mar-1993  cgd branches: 1.1.1;
Initial revision
 1.1.1.3 08-Aug-1994  mrg 4.4BSD-Lite2
 1.1.1.2 19-Jun-1994  cgd new doc set from Lite
 1.1.1.1 21-Mar-1993  cgd initial import of 386bsd-0.1 sources
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 17-Oct-1997  mrg 4.4BSD-Lite2
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.4 13-Feb-2004  wiz Uppercase CPU, plural is CPUs.
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 17-Oct-1997  mrg 4.4BSD-Lite2
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.5 16-Dec-2010  wiz Observe the following spelling:
- wide character (noun)
- wide-character (adjective)

Inspired by jmc@OpenBSD.
 1.4 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.3 10-Jan-1998  perry get rid of secretmail residue -- suggested in pr-4568 from Carl Shapiro
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 17-Oct-1997  mrg 4.4BSD-Lite2
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.8 13-Feb-2004  wiz Uppercase CPU, plural is CPUs.
 1.7 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.6 11-Mar-2001  hubertf fix typo
 1.5 10-Jan-1998  perry branches: 1.5.10;
get rid of secretmail residue -- suggested in pr-4568 from Carl Shapiro
 1.4 09-Jan-1998  perry RCS Id Police.
 1.3 17-Oct-1997  mrg merge lite-2.
 1.2 23-Sep-1994  mycroft Use POSIX form of kill(1).
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 28-Apr-1995  mrg 4.4BSD-Lite2
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.5.10.3 13-Mar-2001  he Pull up revision 1.6 (requested by hubertf):
Fixes to documents and build procedure so that ``make paper.ps''
works without errors or warnings.
 1.5.10.2 11-Mar-2001  hubertf revert rev. 1.5.10.1, committed to wrong branch
 1.5.10.1 11-Mar-2001  hubertf fix typo
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.5 13-Feb-2004  wiz Uppercase CPU, plural is CPUs.
 1.4 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.3 03-May-2003  wiz DMA, not dma nor Dma.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 17-Oct-1997  mrg 4.4BSD-Lite2
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.13 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.12 10-Jul-2003  lukem branches: 1.12.60; 1.12.72;
Rename a large chunk of the make(1) variables which refer to a
program/tool from "FOO" to "TOOL_FOO". The new variables are:
TOOL_ASN1_COMPILE TOOL_CAP_MKDB TOOL_CAT TOOL_CKSUM TOOL_COMPILE_ET
TOOL_CONFIG TOOL_CRUNCHGEN TOOL_CTAGS TOOL_DB TOOL_EQN TOOL_FGEN
TOOL_GENCAT TOOL_GROFF TOOL_HEXDUMP TOOL_INDXBIB TOOL_INSTALLBOOT
TOOL_INSTALL_INFO TOOL_M4 TOOL_MAKEFS TOOL_MAKEINFO TOOL_MAKEWHATIS
TOOL_MDSETIMAGE TOOL_MENUC TOOL_MKCSMAPPER TOOL_MKESDB
TOOL_MKLOCALE TOOL_MKMAGIC TOOL_MKTEMP TOOL_MSGC TOOL_MTREE
TOOL_PAX TOOL_PIC TOOL_PREPMKBOOTIMAGE TOOL_PWD_MKDB TOOL_REFER
TOOL_ROFF_ASCII TOOL_ROFF_DVI TOOL_ROFF_HTML TOOL_ROFF_PS
TOOL_ROFF_RAW TOOL_RPCGEN TOOL_SOELIM TOOL_SUNLABEL TOOL_TBL
TOOL_UUDECODE TOOL_VGRIND TOOL_ZIC

For each, provide default in <bsd.sys.mk> of the form:
TOOL_FOO?= foo
and for the ${USETOOLS}=="yes" case in <bsd.own.mk>, provide override:
TOOL_FOO= ${TOOLDIR}/bin/${_TOOL_PREFIX}foo

Document all of these in bsd.README.

This cleans up a chunk of potential (and actual) namespace collision
within our build infrastructure, as well as improves consistency in
the share/mk documentation and provision of appropriate defaults for
each of these variables.
 1.11 02-Jun-2002  pooka Reflect bsd.doc.mk rev 1.52 here, and make sure that ROFF uses MACROS.
This has the effect of the postscript output actually being readable.
 1.10 09-Jan-1998  perry branches: 1.10.12;
RCS Id Police.
 1.9 21-Dec-1997  christos Make them use objdirs.
 1.8 24-Mar-1997  christos - Makefile cleanups
 1.7 18-Oct-1996  thorpej Use ${INSTALL}.
 1.6 19-Jun-1994  cgd some more things not in Lite
 1.5 24-Jan-1994  cgd PRINTER -> PRINTER_TYPE
 1.4 31-Jul-1993  mycroft Add RCS indentifiers.
 1.3 04-Jul-1993  cgd allow docs to make an obj dir and build properly with it.
 1.2 09-Jun-1993  cgd make documentation build into ps files. this works, mostly...
 1.1 21-Mar-1993  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 19-Jun-1994  cgd new doc set from Lite
 1.1.1.1 21-Mar-1993  cgd initial import of 386bsd-0.1 sources
 1.10.12.1 05-Jun-2002  lukem Pull up revision 1.11 (requested by pooka in ticket #143):
Reflect bsd.doc.mk rev 1.52 here, and make sure that ROFF uses MACROS.
This has the effect of the postscript output actually being readable.
 1.12.72.1 10-Aug-2014  tls Rebase.
 1.12.60.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.2 10-Jan-1998  perry get rid of secretmail residue -- suggested in pr-4568 from Carl Shapiro
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.9 05-Jul-2014  dholland Reorg docs, part 1:
Move all the reference manuals to subdirs of /usr/share/doc/reference.
We have subdirs ref1-ref9, corresponding to man page sections 1-9.

Everything that's the reference manual for a program (sections 1, 6,
8), C interface (sections 2, 3), driver or file system (section 4),
format or configuration (section 5), or kernel internal interface
(section 9) belongs in here.

Section 7 is a little less clear: some things that might go in section
7 if they were a man page aren't really reference manuals. So I'm only
putting things in reference section 7 that are (to me) clearly
reference material, rather than e.g. tutorials, guides, FAQs, etc.
This obviously leaves some room for debate, especially without first
editing the docs with this distinction in mind, but if people hate
what I've done things can always be moved again.

Note also that while roff macro man pages traditionally go in section
7, I have put all the roff documentation (macros, tools, etc.) in one
place in reference/ref1/roff. This will make it easier to find and
also easier to edit it into some kind of coherent form.
 1.8 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.7 09-Jan-1998  perry branches: 1.7.72; 1.7.84;
RCS Id Police.
 1.6 19-Jun-1994  cgd clean up import
 1.5 24-Jan-1994  cgd PRINTER -> PRINTER_TYPE
 1.4 31-Jul-1993  mycroft Add RCS indentifiers.
 1.3 04-Jul-1993  cgd allow docs to make an obj dir and build properly with it.
 1.2 09-Jun-1993  cgd make documentation build into ps files. this works, mostly...
 1.1 21-Mar-1993  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 19-Jun-1994  cgd new doc set from Lite
 1.1.1.1 21-Mar-1993  cgd initial import of 386bsd-0.1 sources
 1.7.84.1 10-Aug-2014  tls Rebase.
 1.7.72.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.7 14-Aug-2012  dholland Some edits, prompted by suggestions from Edgar Fuss.
 1.6 21-May-2012  wiz Typos, capitalization, and file systems.
(Not reviewed at the content level.)
 1.5 21-May-2012  dholland Update. comments/suggestions/edits please.

This should be pulled up to netbsd-6 once the dust (if any) settles.
 1.4 13-Feb-2004  wiz branches: 1.4.54; 1.4.56;
Uppercase CPU, plural is CPUs.
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 21-Mar-1993  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 19-Jun-1994  cgd new doc set from Lite
 1.1.1.1 21-Mar-1993  cgd initial import of 386bsd-0.1 sources
 1.4.56.1 15-Aug-2012  riz Pull up following revision(s) (requested by dholland in ticket #499):
share/doc/smm/04.quotas/quotas.ms: revision 1.5
share/doc/smm/04.quotas/quotas.ms: revision 1.6
share/doc/smm/04.quotas/quotas.ms: revision 1.7
Update. comments/suggestions/edits please.
This should be pulled up to netbsd-6 once the dust (if any) settles.
Typos, capitalization, and file systems.
(Not reviewed at the content level.)
Some edits, prompted by suggestions from Edgar Fuss.
 1.4.54.2 30-Oct-2012  yamt sync with head
 1.4.54.1 23-May-2012  yamt sync with head.
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.2 29-Apr-1995  mrg 4.4BSD-Lite2
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.7 05-Jul-2014  dholland Reorg docs, part 3:
Move the documents that are papers to /usr/share/doc/papers.
Give them suitable names (including the author and year).

The key property of papers that distinguishes them from documentation
is that they're historical: they're published at a particular time and
aren't updated or maintained. (Except cosmetically.)

We should only ship papers that are of interest to users, either for
historical perspective or because they're the original research
writeup of stuff that went into the system and is still pertinent.

The ffs papers clearly meet this standard; the other one here (about
passwords, in 1978) is probably past its sell-by date.
 1.6 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.5 10-Jul-2003  lukem branches: 1.5.60; 1.5.72;
Rename a large chunk of the make(1) variables which refer to a
program/tool from "FOO" to "TOOL_FOO". The new variables are:
TOOL_ASN1_COMPILE TOOL_CAP_MKDB TOOL_CAT TOOL_CKSUM TOOL_COMPILE_ET
TOOL_CONFIG TOOL_CRUNCHGEN TOOL_CTAGS TOOL_DB TOOL_EQN TOOL_FGEN
TOOL_GENCAT TOOL_GROFF TOOL_HEXDUMP TOOL_INDXBIB TOOL_INSTALLBOOT
TOOL_INSTALL_INFO TOOL_M4 TOOL_MAKEFS TOOL_MAKEINFO TOOL_MAKEWHATIS
TOOL_MDSETIMAGE TOOL_MENUC TOOL_MKCSMAPPER TOOL_MKESDB
TOOL_MKLOCALE TOOL_MKMAGIC TOOL_MKTEMP TOOL_MSGC TOOL_MTREE
TOOL_PAX TOOL_PIC TOOL_PREPMKBOOTIMAGE TOOL_PWD_MKDB TOOL_REFER
TOOL_ROFF_ASCII TOOL_ROFF_DVI TOOL_ROFF_HTML TOOL_ROFF_PS
TOOL_ROFF_RAW TOOL_RPCGEN TOOL_SOELIM TOOL_SUNLABEL TOOL_TBL
TOOL_UUDECODE TOOL_VGRIND TOOL_ZIC

For each, provide default in <bsd.sys.mk> of the form:
TOOL_FOO?= foo
and for the ${USETOOLS}=="yes" case in <bsd.own.mk>, provide override:
TOOL_FOO= ${TOOLDIR}/bin/${_TOOL_PREFIX}foo

Document all of these in bsd.README.

This cleans up a chunk of potential (and actual) namespace collision
within our build infrastructure, as well as improves consistency in
the share/mk documentation and provision of appropriate defaults for
each of these variables.
 1.4 02-Jun-2002  pooka Reflect bsd.doc.mk rev 1.52 here, and make sure that ROFF uses MACROS.
This has the effect of the postscript output actually being readable.
 1.3 09-Jan-1998  perry branches: 1.3.12;
RCS Id Police.
 1.2 21-Dec-1997  christos Make them use objdirs.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3.12.1 05-Jun-2002  lukem Pull up revision 1.4 (requested by pooka in ticket #143):
Reflect bsd.doc.mk rev 1.52 here, and make sure that ROFF uses MACROS.
This has the effect of the postscript output actually being readable.
 1.5.72.1 10-Aug-2014  tls Rebase.
 1.5.60.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.4 05-Jul-2014  dholland Reorg docs, part 1:
Move all the reference manuals to subdirs of /usr/share/doc/reference.
We have subdirs ref1-ref9, corresponding to man page sections 1-9.

Everything that's the reference manual for a program (sections 1, 6,
8), C interface (sections 2, 3), driver or file system (section 4),
format or configuration (section 5), or kernel internal interface
(section 9) belongs in here.

Section 7 is a little less clear: some things that might go in section
7 if they were a man page aren't really reference manuals. So I'm only
putting things in reference section 7 that are (to me) clearly
reference material, rather than e.g. tutorials, guides, FAQs, etc.
This obviously leaves some room for debate, especially without first
editing the docs with this distinction in mind, but if people hate
what I've done things can always be moved again.

Note also that while roff macro man pages traditionally go in section
7, I have put all the roff documentation (macros, tools, etc.) in one
place in reference/ref1/roff. This will make it easier to find and
also easier to edit it into some kind of coherent form.
 1.3 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.2 09-Jan-1998  perry branches: 1.2.72; 1.2.84;
RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.2.84.1 10-Aug-2014  tls Rebase.
 1.2.72.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 05-Jul-2014  dholland Reorg docs, part 3:
Move the documents that are papers to /usr/share/doc/papers.
Give them suitable names (including the author and year).

The key property of papers that distinguishes them from documentation
is that they're historical: they're published at a particular time and
aren't updated or maintained. (Except cosmetically.)

We should only ship papers that are of interest to users, either for
historical perspective or because they're the original research
writeup of stuff that went into the system and is still pertinent.

The ffs papers clearly meet this standard; the other one here (about
passwords, in 1978) is probably past its sell-by date.
 1.2 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.1 29-Nov-2007  mjf branches: 1.1.4; 1.1.36; 1.1.48;
Commit Caldera licensed documentation from 4.4BSD. This was taken from the
OpenBSD tree.

No objections on netbsd-docs.
 1.1.48.1 10-Aug-2014  tls Rebase.
 1.1.36.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.4.2 09-Jan-2008  matt sync with HEAD
 1.1.4.1 29-Nov-2007  matt file Makefile was added on branch matt-armv6 on 2008-01-09 01:38:47 +0000
 1.2 02-Jun-2024  andvar Fix triple l typos in warning message and documentation.
 1.1 29-Nov-2007  mjf branches: 1.1.4;
Commit Caldera licensed documentation from 4.4BSD. This was taken from the
OpenBSD tree.

No objections on netbsd-docs.
 1.1.4.2 09-Jan-2008  matt sync with HEAD
 1.1.4.1 29-Nov-2007  matt file password.ms was added on branch matt-armv6 on 2008-01-09 01:38:47 +0000
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.4 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.3 05-Feb-2003  perry "Utilize" has exactly the same meaning as "use," but it is more
difficult to read and understand. Most manuals of English style
therefore say that you should use "use".
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.4 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.3 05-Feb-2003  perry "Utilize" has exactly the same meaning as "use," but it is more
difficult to read and understand. Most manuals of English style
therefore say that you should use "use".
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.6 05-Feb-2019  christos comment out the IFF_TRAILERS stuff that is no longer relevant and add
the missing flags.
 1.5 07-Aug-2003  agc branches: 1.5.96;
Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.4 03-May-2003  wiz DMA, not dma nor Dma.
 1.3 05-Feb-2003  perry "Utilize" has exactly the same meaning as "use," but it is more
difficult to read and understand. Most manuals of English style
therefore say that you should use "use".
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.5.96.1 10-Jun-2019  christos Sync with HEAD
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.7 05-Jul-2014  dholland Reorg docs, part 1:
Move all the reference manuals to subdirs of /usr/share/doc/reference.
We have subdirs ref1-ref9, corresponding to man page sections 1-9.

Everything that's the reference manual for a program (sections 1, 6,
8), C interface (sections 2, 3), driver or file system (section 4),
format or configuration (section 5), or kernel internal interface
(section 9) belongs in here.

Section 7 is a little less clear: some things that might go in section
7 if they were a man page aren't really reference manuals. So I'm only
putting things in reference section 7 that are (to me) clearly
reference material, rather than e.g. tutorials, guides, FAQs, etc.
This obviously leaves some room for debate, especially without first
editing the docs with this distinction in mind, but if people hate
what I've done things can always be moved again.

Note also that while roff macro man pages traditionally go in section
7, I have put all the roff documentation (macros, tools, etc.) in one
place in reference/ref1/roff. This will make it easier to find and
also easier to edit it into some kind of coherent form.
 1.6 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.5 10-Jul-2003  lukem branches: 1.5.60; 1.5.72;
Rename a large chunk of the make(1) variables which refer to a
program/tool from "FOO" to "TOOL_FOO". The new variables are:
TOOL_ASN1_COMPILE TOOL_CAP_MKDB TOOL_CAT TOOL_CKSUM TOOL_COMPILE_ET
TOOL_CONFIG TOOL_CRUNCHGEN TOOL_CTAGS TOOL_DB TOOL_EQN TOOL_FGEN
TOOL_GENCAT TOOL_GROFF TOOL_HEXDUMP TOOL_INDXBIB TOOL_INSTALLBOOT
TOOL_INSTALL_INFO TOOL_M4 TOOL_MAKEFS TOOL_MAKEINFO TOOL_MAKEWHATIS
TOOL_MDSETIMAGE TOOL_MENUC TOOL_MKCSMAPPER TOOL_MKESDB
TOOL_MKLOCALE TOOL_MKMAGIC TOOL_MKTEMP TOOL_MSGC TOOL_MTREE
TOOL_PAX TOOL_PIC TOOL_PREPMKBOOTIMAGE TOOL_PWD_MKDB TOOL_REFER
TOOL_ROFF_ASCII TOOL_ROFF_DVI TOOL_ROFF_HTML TOOL_ROFF_PS
TOOL_ROFF_RAW TOOL_RPCGEN TOOL_SOELIM TOOL_SUNLABEL TOOL_TBL
TOOL_UUDECODE TOOL_VGRIND TOOL_ZIC

For each, provide default in <bsd.sys.mk> of the form:
TOOL_FOO?= foo
and for the ${USETOOLS}=="yes" case in <bsd.own.mk>, provide override:
TOOL_FOO= ${TOOLDIR}/bin/${_TOOL_PREFIX}foo

Document all of these in bsd.README.

This cleans up a chunk of potential (and actual) namespace collision
within our build infrastructure, as well as improves consistency in
the share/mk documentation and provision of appropriate defaults for
each of these variables.
 1.4 02-Jun-2002  pooka Reflect bsd.doc.mk rev 1.52 here, and make sure that ROFF uses MACROS.
This has the effect of the postscript output actually being readable.
 1.3 09-Jan-1998  perry branches: 1.3.12;
RCS Id Police.
 1.2 21-Dec-1997  christos Make them use objdirs.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3.12.1 05-Jun-2002  lukem Pull up revision 1.4 (requested by pooka in ticket #143):
Reflect bsd.doc.mk rev 1.52 here, and make sure that ROFF uses MACROS.
This has the effect of the postscript output actually being readable.
 1.5.72.1 10-Aug-2014  tls Rebase.
 1.5.60.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.4 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.3 05-Feb-2003  perry "Utilize" has exactly the same meaning as "use," but it is more
difficult to read and understand. Most manuals of English style
therefore say that you should use "use".
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 07-Aug-2003  agc Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.
 1.2 09-Jan-1998  perry RCS Id Police.
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.1 19-Jun-1994  cgd branches: 1.1.1;
Initial revision
 1.1.1.1 19-Jun-1994  cgd new doc set from Lite
 1.3 06-Jul-2014  dholland New sentence, new line.
 1.2 06-Jul-2014  dholland Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 0.t was added on branch matt-armv6 on 2008-01-09 01:38:48 +0000
 1.3 06-Jul-2014  dholland New sentence, new line.
 1.2 06-Jul-2014  dholland Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 1.t was added on branch matt-armv6 on 2008-01-09 01:38:48 +0000
 1.3 06-Jul-2014  dholland New sentence, new line.
 1.2 06-Jul-2014  dholland Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 2.t was added on branch matt-armv6 on 2008-01-09 01:38:48 +0000
 1.3 06-Jul-2014  dholland New sentence, new line.
 1.2 06-Jul-2014  dholland Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 3.t was added on branch matt-armv6 on 2008-01-09 01:38:49 +0000
 1.3 06-Jul-2014  dholland New sentence, new line.
 1.2 06-Jul-2014  dholland Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 4.t was added on branch matt-armv6 on 2008-01-09 01:38:49 +0000
 1.2 06-Jul-2014  dholland New sentence, new line.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 5.t was added on branch matt-armv6 on 2008-01-09 01:38:50 +0000
 1.3 06-Jul-2014  dholland New sentence, new line.
 1.2 06-Jul-2014  dholland Minor updates - I've attempted to catch the most glaringly outdated
statements but haven't made any effort yet to rewrite the main content.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file 6.t was added on branch matt-armv6 on 2008-01-09 01:38:50 +0000
 1.3 05-Jul-2014  dholland Reorg docs, part 1:
Move all the reference manuals to subdirs of /usr/share/doc/reference.
We have subdirs ref1-ref9, corresponding to man page sections 1-9.

Everything that's the reference manual for a program (sections 1, 6,
8), C interface (sections 2, 3), driver or file system (section 4),
format or configuration (section 5), or kernel internal interface
(section 9) belongs in here.

Section 7 is a little less clear: some things that might go in section
7 if they were a man page aren't really reference manuals. So I'm only
putting things in reference section 7 that are (to me) clearly
reference material, rather than e.g. tutorials, guides, FAQs, etc.
This obviously leaves some room for debate, especially without first
editing the docs with this distinction in mind, but if people hate
what I've done things can always be moved again.

Note also that while roff macro man pages traditionally go in section
7, I have put all the roff documentation (macros, tools, etc.) in one
place in reference/ref1/roff. This will make it easier to find and
also easier to edit it into some kind of coherent form.
 1.2 05-Jul-2014  dholland Rework /usr/share/doc.

Update the <bsd.doc.mk> infrastructure, and update the docs to match
the new infrastructure.

- Build and install text, ps, pdf, and/or html, not roff sources.

- Don't wire the chapter numbers into the build system, or use them in
the installed pathnames. This didn't matter much when the docs were a
museum, but now that we're theoretically going to start maintaining
them again, we're going to add and remove documents periodically and
having the chapter numbers baked in creates a lot of thrashing for no
purpose.

- Specify the document name explicitly, rather than implicitly in a
path. Use this name (instead of other random strings) as the name
of the installed files.

- Specify the document section, which is the subdirectory of
/usr/share/doc to install into.

- Allow multiple subdocuments. (That is, multiple documents in one
output directory.)

- Enumerate the .png files groff emits along with html so they can be
installed.

- Remove assorted hand-rolled rules for running roff and roff widgetry
and add enough variable settings to make these unnecessary. This
includes support for
- explicit use of soelim
- refer
- tbl
- pic
- eqn

- Forcibly apply at least minimal amounts of sanity to certain
autogenerated roff files.

- Don't exclude USD.doc, SMM.doc, and PSD.doc directories from the
build, as they now actually do stuff.

Note: currently we can't generate pdf. This turns out to be a
nontrivial problem with no immediate solution forthcoming. So for now,
as a workaround, install compressed .ps as the printable form.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file Makefile was added on branch matt-armv6 on 2008-01-09 01:38:50 +0000
 1.2 06-Jul-2014  dholland New sentence, new line.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file a.t was added on branch matt-armv6 on 2008-01-09 01:38:51 +0000
 1.2 06-Jul-2014  dholland New sentence, new line.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file b.t was added on branch matt-armv6 on 2008-01-09 01:38:51 +0000
 1.1 18-Dec-2007  garbled branches: 1.1.2;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file c.t was added on branch matt-armv6 on 2008-01-09 01:38:51 +0000
 1.2 06-Jul-2014  dholland New sentence, new line.
 1.1 18-Dec-2007  garbled branches: 1.1.2; 1.1.34; 1.1.46;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.46.1 10-Aug-2014  tls Rebase.
 1.1.34.1 20-Aug-2014  tls Rebase to HEAD as of a few days ago.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file d.t was added on branch matt-armv6 on 2008-01-09 01:38:52 +0000
 1.1 18-Dec-2007  garbled branches: 1.1.2;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file e.t was added on branch matt-armv6 on 2008-01-09 01:38:52 +0000
 1.1 18-Dec-2007  garbled branches: 1.1.2;
Import the config documentation from FreeBSD into the smm. Rather than
name the directory "02.config" as it historically was, name it config, so
that if we ever want to update this book for the modern age, we can move
chapters around, delete them, etc, without mass confusion.
 1.1.2.2 09-Jan-2008  matt sync with HEAD
 1.1.2.1 18-Dec-2007  matt file spell.ok was added on branch matt-armv6 on 2008-01-09 01:38:52 +0000

RSS XML Feed