Commit graph

3247 commits

Author SHA1 Message Date
Jun Kuriyama
60af523f19 MFen:
1.1  -> 1.5	Makefile
	1.1  -> 1.4	books/faq/Makefile
	1.21 -> 1.24	books/handbook/Makefile
1999-08-31 15:00:04 +00:00
Jun Kuriyama
da4bea1cab We have used ${VAR}, not $(VAR ) . :- ) 1999-08-31 14:59:48 +00:00
Satoshi Asami
4b2e4fe173 $Id$ -> $FreeBSD$ in contents (mostly sample Makefiles).
Note I didn't touch the $Id$ line for the sgml file itself, I'm assuming Nik
or someone is going to convert all the doc files in one pass.
1999-08-31 11:34:17 +00:00
Joseph Koshy
120dadff23 Typo fix.
PR:		docs/13490
Submitted by:	Peng HaiJie <phj@cn.FreeBSD.org>
1999-08-31 10:33:26 +00:00
Jun Kuriyama
a43f1199ce Catching up to 3.2-19990827-STABLE.
Reviewed by:	Japanese Online Manual Project <man-jp@jp.FreeBSD.ORG>
Submitted by:	Kazuo Horikawa <k-horik@yk.rim.or.jp>
1999-08-30 14:53:36 +00:00
John Baldwin
6c26ae8336 Fix a broken tag. </para> -> </title>
PR:		docs/13465
Submitted by:	Mark Ovens <mark@ukug.uk.freebsd.org>
1999-08-30 11:53:03 +00:00
Joseph Koshy
854403a247 New FAQ entry on how to allow users to mount devices.
Reviewed by:	-doc (content), nik (DocBook expertise)
1999-08-30 05:33:19 +00:00
John Baldwin
7c3a7085f5 Fix a mistyped tag: <row> -> </row>
PR:		docs/13457
Submitted by:	jack@germanium.xtalwind.net
1999-08-29 18:31:09 +00:00
Nik Clayton
93695393f6 List books/ subdirectory, remove FAQ/ subdirectory.
Remove kludge to build the installation directory.
1999-08-29 16:52:23 +00:00
Nik Clayton
6f2072d82b Makefile infrastructure for Russian books. 1999-08-29 16:51:58 +00:00
Nik Clayton
33f5092d1c Russian FAQ, converted to DocBook.
Submitted by:   Andrey Zakhvatov <andy@icc.surw.chel.su>
1999-08-29 16:51:17 +00:00
John Baldwin
cd08f5c92f Lots of [fF]ree(bsd|BSD).(org|ORG) -> FreeBSD.org fixups.
A few doc@FreeBSD.org -> freebsd-doc@FreeBSD.org fixes.

One freebsd -> FreeBSD name fix.

Reviewed by:	nik
1999-08-29 16:08:47 +00:00
Brian Feldman
efb2b82b9f Update for 320002. 1999-08-29 14:10:04 +00:00
Jun Kuriyama
0c9d7180a3 Catching up to 3.2-19990824-STABLE (without pam_radius.8).
Reviewed by:	Japanese Online Manual Project <man-jp@jp.FreeBSD.ORG>
Submitted by:	Kazuo Horikawa <k-horik@yk.rim.or.jp>
1999-08-29 02:00:32 +00:00
John Baldwin
9c6e695ef1 Make the doc/en_* makefiles repect ${DOC_PREFIX} when they include
${DOC_PREFIX}/share/mk/docproj.docbook.mk instead of using hard-coded
paths.

Reviewed partially by:	nik, billf
1999-08-29 00:02:23 +00:00
John Baldwin
81fb662a55 FreeBSD.ORG -> FreeBSD.org for the MAINTAINERS e-mail address.
Translators can ignore this commit.

Reviewed by:	billf, nik
1999-08-28 19:49:39 +00:00
Nik Clayton
1114afe19a Remove "FAQ" from SUBDIR. We'll keep the old FAQ around for a couple of
days before cvs remove'ing it, just in case.
1999-08-28 10:15:02 +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
d1b17042d0 Set the {JADE,TIDY}FLAGS variables in Makefile.inc, rather than in the
lower level Makefiles.  This should stop this problem happening for
new documentation under this part of the tree.
1999-08-28 09:48:29 +00:00
Jim Mock
a99dcb84c0 Add Yin-Jieh Chen for the icqnix port. 1999-08-28 03:02:06 +00:00
Mark J. Taylor
6647e72130 Add myself to the list of committers. 1999-08-27 15:40:37 +00:00
Foxfair Hu
0a8232cc30 Cleanup my last commit, add an "Original revision" to indicate English FAQ's
version.
1999-08-27 15:03:57 +00:00
Foxfair Hu
c066bde440 Add a comment to point rcs version out. 1999-08-27 14:55:49 +00:00
Jim Mock
5af0c18496 Added Egeny Kuzakov <CoreDumped@lab321.ru> for the tircproxy port. 1999-08-26 23:43:50 +00:00
Chris Piazza
db46587229 Add Chris D. Faulhaber <jedgar@fxp.org> for the p5-IRC port 1999-08-26 20:41:45 +00:00
Nik Clayton
5d61c67118 When making the compatability symlink, do it in the parent directory
to both directories, and make it relative, rather than absolute.

This fixes the case where you might install the docs under one directory
/foo/bar/..., and then want to migrate them elsewhere (to /usr/share/).

With the old scheme, the symlink would start /foo/bar/..., and would
therefore be broken.

A good example of this happening is "make release" :-)
1999-08-26 19:42:13 +00:00
Nik Clayton
816f75506c Support using the DOC_LANG variable to specify which languages and
encodings to install.  It is synonymous with SUBDIR, and can probably
disappear when this functionality is 'tweaked' in the release build.
1999-08-26 19:40:04 +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
cba99c4bed JADEOPTS -> JADEFLAGS (see same change in ../faq/Makefile). 1999-08-26 19:11:32 +00:00
Nik Clayton
21d1b45894 JADEOPTS -> JADEFLAGS. Should fix the FAQ not appearing in the right
encoding.  This is a band aid fix, just to get it built, and will be fixed
properly in the next day or so, when I can properly analyze the problem.

Now to read the e-mail this has generated. . .
1999-08-26 19:01:18 +00:00
Mark J. Taylor
8ff3d7886a Add myself to the list of committers. 1999-08-25 20:38:52 +00:00
Nik Clayton
d1b7c1d82e Sync with English 1.14. The conversion to DocBook can now start.
PR:             docs/13366
Submitted by:   Andrey Zakhvatov <andy@icc.surw.chel.su>
1999-08-25 18:47:25 +00:00
Foxfair Hu
a3ff85c28a o Give the TIDYFLAGS in the Makefile to make the building procedure right.
It will give the understandable result now.

  Discussed with : nik.

o Fix some ANCHOR error, modify some format.

  Obtained from : English version 1.6, PR: docs/13349
  (Actually English version of FAQ still has some wrong link, I'll send-PR
  when free. Any taker?)
1999-08-25 05:29:44 +00:00
Nik Clayton
5ec01e841f Change the internal links to use <link ...> rather than <xref ...>.
This stops the (non-fatal) errors, and generates useful links.

PR:             docs/13349
Submitted by:   Neil Blakely-Milner <nbm@rucus.ru.ac.za>
1999-08-24 19:05:16 +00:00
Nik Clayton
1ca335c3e7 "is is" -> "it is"
Submitted by:   Kelly Yancey <kbyanc@posi.net>
1999-08-24 19:01:16 +00:00
Chris Costello
e5ebbaedba Cosmetic: <ulink URL=...' -> <ulink url=...' according to the doc proj
primer.
1999-08-24 13:20:40 +00:00
Foxfair Hu
5e80a9983e 1. Typo fixed,submitted by: Tzu-hsien Yu <thyu@camel.ck.tp.edu.tw>
o FAQ 2.29 : fiald -> failed
  o FAQ 3.x : Make the title more easier to read.(Of course, it is Chinese
              title)
  o FAQ 10.13 : Delete a extra "W".
  o FAQ 12.x : Style police. Use 2-bytes punctuation rather than one. Cleanup
    some paragraph.

2. Sync with English version 1.5 (Tue,Aug 24 1999).
1999-08-24 10:23:25 +00:00
Joseph Koshy
613d6c2cc6 Make the question I added on TERM mismatches when logging onto remote systems
clearer.
1999-08-24 08:54:28 +00:00
Chris Piazza
a938e63860 Re-remove Chris Costello from additional contributors: he's
a committer now.
1999-08-24 06:14:33 +00:00
Joseph Koshy
ecdbbeb3a7 Add a few people to the additional contributors section:
Rich Wood   <rich@FreeBSD.org.uk>    for docs/13336
    Chris Costello <chris@calldei.com>   for docs/12990
    Kiril Mitev <kiril@ideaglobal.com>   for docs/12985
1999-08-24 06:03:34 +00:00
Joseph Koshy
2371fff5df Add trailing slashes to URLs.
PR:		docs/13336
Submitted by:	Rich Wood <rich@FreeBSD.org.uk>
1999-08-24 05:01:13 +00:00
John Baldwin
60b17bf4c3 Move myself from the contributors list to the committers list in the
handbook.

Reviewed by:	billf
1999-08-24 03:22:22 +00:00
Chris Piazza
38949d4e41 Fix a typo (accellerator -> accelerator) and a missing space.
PR:		13208
Submitted by:	Mark Ovens <mark@ukug.uk.freebsd.org>
1999-08-24 02:35:59 +00:00
Nik Clayton
122d319794 "../handbook.sgml" -> "../book.sgml" in Emacs local variables section. 1999-08-23 21:24:10 +00:00
Nik Clayton
4e9bf8757d "../handbook.sgml" -> "../book.sgml" in Emacs local variables section.
Fix up the list of questions and answers as a <qandaset> instead of
an <itemizedlist>.  This entails converting the <itemizedlist> element
to a <qandaset>, and wrapping each question paragraph in a <question>
and </question> pair, and each answer in a <answer>...</answer> pair.

Then, search and replace for all the "Q.  " and "A.  " and remove them,
because the stylesheet adds these for you.

Finally, some of the questions are entered as

    <para><anchor id="foo">...

Delete the anchor element, and put the id attribute on the para instead,
so you have

    <para id="foo">...

I'm not entirely sure why, but if you have that in the first form then
the stylesheets don't include the links properly in the table of
questions.  If you have it in the second form then everything works fine.
1999-08-23 21:06:02 +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
Jun Kuriyama
e894e169bc Catching up to 3.2-19990816-STABLE.
Reviewed by:	Japanese Online Manual Project <man-jp@jp.FreeBSD.ORG>
Submitted by:	Kazuo Horikawa <k-horik@yk.rim.or.jp>
1999-08-23 16:04:43 +00:00
Jun Kuriyama
73649de8e6 Add Japanese local options. 1999-08-23 15:33:55 +00:00
Nik Clayton
fc4b2ab2a2 Sync with English 1.2
PR:             docs/13094
Submitted by:   Andrey Zakhvatov <andy@icc.surw.chel.su>
1999-08-23 13:41:01 +00:00
Nik Clayton
4394bcaa66 Sync with English 1.3
PR:             docs/13101
Submitted by:   Andrey Zakhvatov <andy@icc.surw.chel.su>
1999-08-23 13:40:12 +00:00