Commit graph

75 commits

Author SHA1 Message Date
Jim Mock
22eb175baf Add references needed for the security chapter. 2000-03-25 00:20:03 +00:00
Neil Blakey-Milner
4dfd8b3329 Fix the new localized dsl stuff for the obj build case. 2000-03-24 19:31:34 +00:00
Nik Clayton
a595525171 Give each language and encoding it's own freebsd.dsl, to contain style
sheet definitions for that language only.  Each file reads in the defaults
from the master share/sgml/freebsd.dsl file, and adds overrides, or new
definitions, as necessary.

Move the per-language hacks from share/sgml/freebsd.dsl in to
<lang>/share/sgml/freebsd.dsl as necessary.

Add links to the -questions and -doc mailing lists to the bottom of the
generated HTML output for some languages.  The -questions link will
become a link to Greg's "Getting the most from questions" document when
I bring that in, but I haven't done that yet, and I didn't want these
patches hanging around my local tree.

This was the real reason for making freebsd.dsl language local, as it
makes it much easier to translate generated text, such as the text of
the links, without polluting share/sgml/freebsd.dsl.

Update doc.docbook.mk to use the new, per-language freebsd.dsl file when
building the docs.  While I'm here, update .pdb generation so that it
creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates
"book.pdb" and "handbook.pdb").  This makes it easier to install more than
one document on a Palm, because two docs called "book.pdb" or "article.pdb"
can not co-exist.
2000-03-23 09:00:17 +00:00
Jim Mock
dad13be17e Add bits needed for the quota section of the disks chapter. 2000-03-20 21:00:59 +00:00
Chris Costello
9a59860a1f Add an entry for fetch(1). 2000-03-12 06:50:10 +00:00
Andrey A. Chernov
5372e2895e Fix value of man.mount.msdos.8 entity
"mount.msdos" -> "mount_msdos"
2000-03-12 04:09:58 +00:00
Neil Blakey-Milner
f563d86a5b manual reference for chflags for miscellaneous cleanups in the handbook. 2000-03-11 19:30:16 +00:00
Alexey Zelkin
ef3c77dc32 Add bunch of entities required for future import of IPv6/IPsec related
handbook sections.
2000-03-10 22:41:32 +00:00
John Baldwin
66be53c66d Amend the section on wheeled mice in X to include a tutorial on installing
and configuring the imwheel port.  Also, add a man-ref entry for imwheel(1).

Reviewed by:	chris, jim
2000-03-09 05:52:04 +00:00
Neil Blakey-Milner
5d2e8b1141 Fix an obj error in the lint/validate target. 2000-03-08 11:21:37 +00:00
Neil Blakey-Milner
b34292794a Add necessary man page entities for users chapter 2000-03-08 11:17:59 +00:00
Nik Clayton
b8a86a79da Add entities for xmodmap(1) and lpd(8).
PR:             docs/16841
Submitted by:   Mark Ovens <mark@ukug.uk.freebsd.org>
2000-03-07 13:33:53 +00:00
Jim Mock
e5cc1d1296 Add the changes needed for the handbook to build correctly after my last
commit to the PPP and SLIP chapter.  Hopefully I caught my stupidity
before it tried to build and ended up failing.
2000-03-02 06:23:23 +00:00
Jim Mock
82843ed876 Add in the bits relevant to the closing of docs/15300. Without these the
build is broken.
2000-02-17 21:20:42 +00:00
Nik Clayton
67c7006408 Back out part of the previous commit; remove the code that generates HTML
expecting to find a docbook.css stylesheet file, which I committed a bit
too soon.

Pointed out by:	jim
2000-02-15 01:57:17 +00:00
Nik Clayton
fc766b7388 Add definitions for the osversionmin, osversionmax, and osversionin
attributes.  We don't use these yet, but they've been hanging around my
tree for ages, and it's time other people got to play with them.

Add (HTML) entity defs for lsquo and rsquo, ` and ' respectively.
2000-02-14 01:30:48 +00:00
Nik Clayton
0aa5ee0c69 Add "legalnotice" to the list of elements that are included on the title
page of articles.  This necessitates duplicating the entire list in the
customisation layer, which will need to be kept up to date as the master
stylesheets change.
2000-02-14 01:29:17 +00:00
Nik Clayton
811a3b7b1f Add system.3 and popen.3. 2000-02-14 01:17:34 +00:00
Jun Kuriyama
4182f5b9e7 Add NO_TIDY variable to disable tidy.
Tidy cannot handle EUC-JP codepoint range correctly with -raw option.
I will try to fix this problem, but temporary disable to use tidy in
Japanese Handbook and FAQ.
2000-02-03 03:10:43 +00:00
Nik Clayton
8be525f5f5 Allow DSLHTML and DSLPRINT to be overridden ("...=" -> "...?=").
Requested by:	Chris Costello
2000-01-24 20:02:50 +00:00
Jim Mock
b9951cd883 Add entry for pcm.4 which is needed for the updates made to
kernelconfig/chapter.sgml
2000-01-21 21:25:26 +00:00
Nik Clayton
120eb24177 Add definition for man.moused.8. 2000-01-19 22:42:15 +00:00
Neil Blakey-Milner
eaba090d03 Add rc.8 for the boot process description 2000-01-14 10:35:17 +00:00
Nik Clayton
e4fb9fb481 Use w3m instead of lynx to format the text versions. It's table handling
is superior, and the various translation teams are fine with it.

Use iSilo instead of pilot-makedoc to produce Palm compatible files.  It
works from the HTML and retains the formatting (including the internal
links) making it much nicer to work with than the output from pilot-makedoc.
1999-12-24 01:25:27 +00:00
Chris Costello
b8b8695fbe Add ch(4) and chio(1) for dark secret FAQ rewriting project. 1999-12-23 18:35:12 +00:00
Jeroen Ruigrok van der Werven
172e589c8f Add missing manual page entity for dd. 1999-12-17 21:25:44 +00:00
Nik Clayton
85eff2b01e Nuke this. It's been superceded by the doc.*.mk files. It should have
been wiped some time ago.
1999-12-14 16:54:32 +00:00
Nik Clayton
535b364c47 Experimental support for building Palm Pilot DOC format files. The result
works, but isn't great (at least in SmartDOC).  Still, if you want to carry
the FreeBSD FAQ on your Palm (or the Handbook for that matter) it's a start.

PR:             docs/13439
Submitted by:   Slaven Rezic <eserte@cs.tu-berlin.de>
1999-12-13 18:14:41 +00:00
Nik Clayton
9b0a980469 Add $FreeBSD$ comment.
Submitted by:   billf
1999-11-15 19:44:15 +00:00
Nik Clayton
2ee8a10ad2 Sample .vimrc and associated files for editing FDP documentation, and
maintaining structure, and so on.

Submitted by:   Robert Brive <brive@freebsd-fr.org
1999-11-15 19:41:09 +00:00
Nik Clayton
d71066fb87 Knew I'd miss something. Add in entities for French <abstract> and
<artheader> elements.
1999-11-14 17:57:31 +00:00
Nik Clayton
212679edca Fix a typo in the French localisation of the stylesheets. 1999-11-10 20:32:58 +00:00
Nik Clayton
ab3a40fe62 Change the invocation of tidy(1) in the index.html target to only update
the .html files that have been built, instead of all of them.  Fixes a bug
where "make FORMATS='html-split html'" would only update the split HTML
files.

Reported by:    Mark Ovens <mark@ukug.uk.FreeBSD.org>
Submitted by:   Neil Blakey-Milner <nbm@mithrandir.moria.org>
1999-11-01 19:41:02 +00:00
Alexey Zelkin
33fd5935c2 Ask jade(1) about additional META in header of Russian FAQ:
<meta http-equiv="Content-Type" content="text/html; charset=koi8-r">

Requested by: wosch
1999-10-31 22:13:58 +00:00
Alexey Zelkin
b9ae21e11c Typo fixes
Remove duplicated DOCDIR description in comments
1999-10-13 00:42:21 +00:00
John Baldwin
8e1a8ece3f A collection of man-ref entries needed for the NIS article, and also the
revamp of the fonts article.

PR:		docs/14193
Submitted by:	Neil Blakey-Milner <nbm@rucus.ru.ac.za>
1999-10-10 17:57:41 +00:00
Jesus Rodriguez Cuesta
f8da7adcf2 Fix handbook symlink install problem with old version installed
PR:		docs/14163
Submitted by:	nbm@rucus.ru.ac.za
1999-10-06 14:00:17 +00:00
John Baldwin
c2f66c7ff1 Add an entity for portlint(1) which is needed by the ports-specific
section of the committers' guide.
1999-09-29 02:09:42 +00:00
Nik Clayton
5aa7029e00 Added entities for
awk(1) date(1) gcc(1) grep(1) script(1) top(1) fastboot(8) ifconfig(8)
    sysctl(8)

Needed for the "make world" section.
1999-09-26 18:34:33 +00:00
Jim Mock
250a692ba9 Added entity for gunzip. This is needed for the updated handbook entry in
docs/13605 that I'll be committing shortly.

Reviewed by:	nik
1999-09-10 00:51:29 +00:00
Wolfram Schneider
40231e0ef1 Use install opiton -C for installing files. 1999-09-09 17:11:28 +00:00
Peter Wemm
5ff728b8ca $Id$ -> $FreeBSD$ 1999-09-06 06:53:43 +00:00
Nik Clayton
10922add2f Rudimentary support for <segmentedlist>. Just builds a table for the
entries, and works for HTML output only.
1999-09-03 17:12:43 +00:00
Nik Clayton
426ed372f6 New entities for make(1), rlogin(1), scp(1), ssh(1), ssh-add(1),
ssh-agent(1), ssh-keygen(1), and telnet(1).  Originally used in the
soon-to-be-added SGML'd committer's guide.
1999-09-03 17:09:02 +00:00
Nik Clayton
bd57358d83 Add a new FPI for the authors.ent file, so that it can be referenced
by different documentation.

Add 3 new FPIs for the French translations.  They're not in the tree
yet, but they will be soon.
1999-09-03 17:08:00 +00:00
Nik Clayton
7d4a994791 New make(1) infrastructure. Split out docproj.docbook.mk into a number
of smaller doc.<foo>.mk files, reflecting the functionality they contain.
Long overdue, kudos to the submitter for the carrying out the work.

Also makes the files independent of the system include files that
normally live in /usr/share/mk, making it easier for non-FreeBSD systems
to download and build our docs (an important factor in making it easier
to share our work with other projects).

Finally, it (in theory) lets you build the docs with a r/o doc/ directory.

Changes to the submitted files:

doc.docbook.mk    The HTML generation depends on ${DSLHTML}, and the
                  print generation depends on ${DSLPRINT}.  Changing
                  these files will force a rebuild (which makes testing
                  changes a little easier).

                  Removed ${DOC}.doc target.  It's a hangover from when
                  I (mistakenly) thought that Jade could generate MS Word
                  .doc files.

                  Added support for using compress(1) to build .Z files
                  (been on my todo list for ages).

                  Fixed a couple of typos.

Submitted by:   Neil Blakey-Milner <nbm@mithrandr.moria.org>
1999-09-03 17:07:19 +00:00
Nik Clayton
de9128a949 Define new LANGCODE variable, which should contain the language name
and encoding for the documentation that's currently being built (e.g.,
'en_US.ISO_8859-1', or 'es_ES.ISO_8859-1').  Used when building packages
to create part of the package file name.  Setting this involves an
'interesting' kludge -- suggestions for how better to achieve this within
make(1) welcomed.

package-*:
    No need to remove PLIST, it's always overwritten.

    Create empty COMMENT and DESCR files if they don't exist.  Makes it
    easier to test this, without committing COMMENT and DESCR files all
    over the tree.

    Use the ${LANGCODE} variable in the package name.  For example,
    the HTML pkg for the FAQ now looks like faq.en_US.ISO_8859-1.html.tgz,
    instead of just faq.html.tgz.
1999-08-28 09:50:49 +00:00
Nik Clayton
ee685fdd2c 1. Fix a subtle bug in the use of ${DOC}. If you ran make(1) and defined
${FORMATS} on the command line then it would assume that you wanted to
   build a document in the current directory, based on the setting of ${DOC}.
   If ${DOC} wasn't set, it defaulted to the name of the current directory.

   Any Makefile that includes this, and expects to have documentation built
   in the current directory must now explicitly define DOC.  All the current
   ones do anyway.  This should be a non-problem when docproj.docbook.mk is
   split out in to smaller, more modular files.

   Move the comments for DOC from the non-mandatory to the mandatory
   section.

2. Clarify the meaning of DESTDIR, it's changed a little bit since it was
   first documented.

3. Initial, tentative support for building pkg_* packages from the
   formatted documentation.  Needs work, but I've had the patch out for
   review for a couple of days, and no comments either way -- so if
   people hate it, this should at least spur them on to say so.

       # cd /path/to/doc/to/turn/into/a/package
       # touch COMMENT DESCR
       # make 'FORMATS=this that and the other' package

   to build 'n' packages, one per format.  "make install" is run as part
   of the package dependency, so this will overwrite documentation you
   have already got installed.

4. Remove DOC_INSTALL_PREFIX.  Should have been DOCDIR from the start.
1999-08-26 19:37:13 +00:00
Nik Clayton
e1302f8644 Remove the comment about <FAQList>, that's been obsoleted by DocBook 3.1.
Default to labelling questions with "Q:" and answers with "A:" when
processing <qandaset>s.  In the HTML output, render questions in a larger,
bolder font than the answers.  Requested by several people on -doc.

Default to numbering sections. Requested by one person on -doc, who
seemed somewhat confused that I hadn't read his mind and done this three
months previously.
cvs: ----------------------------------------------------------------------
1999-08-23 21:02:01 +00:00
Nik Clayton
c98917fd5d Use a conditional assignment "?=" when defining DOC_INSTALL_PREFIX 1999-08-19 00:07:09 +00:00