Commit graph

215 commits

Author SHA1 Message Date
Jun Kuriyama
f8a4b74cae Add &man.X.1; entry to unbreak handbook/x11/chapter.sgml. 2001-08-11 04:36:32 +00:00
Bruce A. Mah
d0303b94c1 Add entry for nmdm(4). 2001-08-11 02:01:53 +00:00
Murray Stokely
2f6147a6ac Another update to the <authorgroup> / <*info> handling. See the
comment for details.

Hashed out with: chern
2001-08-09 23:18:34 +00:00
Murray Stokely
0128e1ed79 Make author attributions show up in italics at the front of each
chapter/section to match our old way of doing things.  Each <author> in
an <authorgroup> will be attributed with :

   "<contrib> by <author>.  "
2001-08-09 00:28:10 +00:00
Chern Lee
1121738517 port tag links:
http://www.FreeBSD.org/cgi/url.cgi?ports/category/port changed to:
http://www.FreeBSD.org/cgi/url.cgi?ports/category/port/pkg-descr

The CGI returns "port does not exist" for the old instance.

Reviewed by:	murray
2001-08-09 00:14:42 +00:00
Valentino Vaschetto
3b78237508 Materialized Nik's meta bibliography concept.
This adds a seperate book for the bibliography of the docproject. Individual
books can then create dynamic bibliographies containing only the books that
they reference from this master bibliography.

http://www.FreeBSD.org/cgi/getmsg.cgi?fetch=88939+0+/usr/local/www/db/text/2001/freebsd-doc/20010715.freebsd-doc

Approved by:	murray
Kickstarted by: nik
2001-08-08 02:23:43 +00:00
Jesus Rodriguez Cuesta
90a98f9d06 Create BookInfo and stylesheets spanish specific entities 2001-08-05 19:40:38 +00:00
Murray Stokely
d79e4c4fad Turn on justification and hyphenation by default for print output. 2001-08-02 03:24:04 +00:00
Dima Dorfman
33423e8ca2 mp(3) doesn't exist. 2001-08-01 15:00:37 +00:00
Dima Dorfman
a8d7e2bc08 Add libmp man pages. 2001-07-29 13:34:52 +00:00
Murray Stokely
a428d684dd Two sections in the backups chapter were wrapped in a %not.published
entity that is never defined.  Define this entity in freebsd.ent so
that the behavior is as intended.
2001-07-28 04:06:29 +00:00
Murray Stokely
a7fe7f4563 Use DSSSL's (next-match) function to fall through to next most
specific construction rule instead of duplicating code when we want to
conditionally alter the stylsheets.

Suggested by: Norman Walsh
Referenced in: ISO/IEC 10179:1996(E) p180-181
2001-07-27 21:16:55 +00:00
Chern Lee
2da5194780 Make <envar> show up as monospaced font in printed version.
Reviewed by:	murray
2001-07-24 23:09:25 +00:00
Dima Dorfman
59292e255d Introduce a <port> element that answers the question of how to mark up
a port name.  Right now, it renders as monospace, and with a hyperlink
to the port's pkg-descr file if possible.
2001-07-24 11:07:59 +00:00
Bruce A. Mah
5a4e6c5809 Add txp(4). 2001-07-24 00:12:20 +00:00
Murray Stokely
bd3a3ce150 Last commit prevented <ulinks> in the index from showing up properly for
printed output.  This fixes indexterms so that page numbers are
displayed following the indexed word/phrase.
2001-07-21 09:09:59 +00:00
Murray Stokely
383c86289e Wrap author attributions in <sect1info> and <sect2info> as
appropriate.

I've specifically left JKH's attribution for the "FreeBSD History"
section in tact, since this is a first person account of the history
of FreeBSD and as such the author needs to be identified in place.
This could probably be marked up differently, but its clear that this
section is different from all of the other "contributed by XXX" in the
Handbook.

Also add support for <sect1info> and <sect2info> to the stylsheet so
that these attributions get displayed as they have been.
2001-07-21 02:29:59 +00:00
Murray Stokely
a6695a0034 Correctly display local file links in the print stylesheet.
Local-file URLs are encoded as file://localhost/path/file which is
fine for HTML but this looks ugly when printed.

Add a function to chop off the "file://localhost" so that the above
URL would be printed as "/path/file" but still link to
"file://localhost/path/file" for HTML output.
2001-07-20 04:59:28 +00:00
Murray Stokely
2a6d5f6c26 Add handlers for <chapterinfo>.
Also add a handler for <contrib> inside of <author> tags.

This should allow us to more formally define contributors to the
Handbook.
2001-07-17 02:22:29 +00:00
Murray Stokely
213a66a8d3 Introduce a 'NICE_HEADERS' tuneable knob that creates customized
chapter headers that you may find more aesthetically pleasing than the
rather spartan chapter headers in Norm's print stylesheets.  This
option only effects print output formats for English language books.

Also move the local-en-label-title-sep customization from share/sgml
to en_blah/share/sgml since the best values for this customization
depend on the locale.

This changes (make FORMATS=ps) :

    Chapter 7. Users and Basic Account Management

    7.1. Synopsis

into (make NICE_HEADERS=1 FORMATS=ps) :

    Chapter 7
    /Users and Basic Account Management/

    7.1  Synopsis

More work needs to be done for the NICE_HEADERS case to enhance the
output, but I think its an improvement.
2001-07-16 05:00:21 +00:00
Murray Stokely
b05f2d4e5b Add an entity &os.numports;, currently set to "5,400", so that we
don't have to keep this number updated at N different places
throughout the doc tree.

Update 3 instances of "4,000" in the Handbook to use this new entity.
2001-07-14 23:09:20 +00:00
Murray Stokely
5c47dd8654 Introduce a new handbook-specific knob ``WITH_PGPKEYS'' and add the
relevant functions to the DSSSL stylesheet.

The default behavior is for print output formats to just display PGP
fingerprints unless you use `make WITH_PGPKEYS=1 FORMATS=ps'.  This new
default behavior reduces the size of Appendix E from 52 pages to 9
pages, and that could be trimmed down more with a more efficient
layout for the fingerprints (does each entry really warrant a new
section header?)

Knob requested by: Chris Costello
Discussed on: -doc
2001-07-12 01:40:31 +00:00
Murray Stokely
53ea803f4b Add entities for XFree86.1 and startx.1 2001-07-11 15:57:19 +00:00
Bruce A. Mah
ec901c396a Add fsck_msdosfs(8). 2001-07-09 21:22:06 +00:00
Bruce A. Mah
710a8dd6f0 Add an entry for awi(4). 2001-07-04 05:31:29 +00:00
Dima Dorfman
09a79a5a75 Sort this and add a comment describing how things should be sorted. 2001-06-30 21:15:00 +00:00
Dima Dorfman
470b174633 Correct a paste-o. 2001-06-30 06:13:08 +00:00
Dima Dorfman
ac501794e7 8 != 2 (fix last commit) 2001-06-30 06:02:57 +00:00
Dima Dorfman
b59050bc52 Add entity for kldconfig(8) 2001-06-30 06:01:49 +00:00
Murray Stokely
78c6c53ba0 Image support has been mangled since the move to docbook.css. This
adds a new mediaobject handler to simplify the output HTML so that
images no longer overlap the text and other nearby images.

The output HTML used to look like this :

      <div class="MEDIAOBJECT">
        <p><img src="fig2.png"></p>
      </div>

The problem was that the image would be displayed on top of nearby
text or image elements completely obscuring the previous contents
rather than doing proper page layout.  With this change, the above now
simply looks like this :

      <img src="fig2.png">

An alternative solution would be to fix docbook.css, but I think that
the problem stems from the way that different browsers implement CSS.
It is easier to just fix it here at the DSSSL level.
2001-06-24 02:46:40 +00:00
Bruce A. Mah
d46e1a628f Add getprogname(3) and setprogname(3). 2001-06-22 17:00:57 +00:00
Bruce A. Mah
19045ad358 Add entry for mdmfs(8). 2001-06-22 15:48:31 +00:00
Chris Costello
5881b7b9ec Remove "Mailing List Entities" from this catalog file, as it belongs in
the individual doc/<lang>/share/sgml/catalog files.
2001-06-21 02:56:51 +00:00
Nik Clayton
e705f83469 Turn on the use of the stylesheet. Remove the code that caries out
special formatting for questions, as the stylesheets now do this.

Interested parties can look at http://people.freebsd.org/~nik/faq-css/
for an idea of how the new stylesheets render.
2001-06-18 14:29:16 +00:00
Nik Clayton
53c24748d7 Select the right .index file depending on whether the output is being
chunked or not.
2001-06-16 21:30:11 +00:00
Bruce A. Mah
5b0709c6e3 Add entry for orm(4). 2001-06-14 17:03:22 +00:00
Andrey A. Chernov
f749b200c1 ISO_* -> ISO* rename 2001-06-11 01:20:40 +00:00
Dima Dorfman
786c87df58 Introduce &os;, &os.current;, and &os.stable; entities. The names
should speak for themselves.  Using these will significantly improve
consistency through the doc tree.  Right now--before most of the
documents use these--there are five or six different spellings of
"FreeBSD-STABLE", even in the same document!  &os; was added for
completeness.

Approved by:	-doc
2001-06-08 01:12:28 +00:00
Bruce A. Mah
a80eb47ee4 Add manpage entry for diskcheckd(8). 2001-06-04 17:52:54 +00:00
Dima Dorfman
c99472149c The problem is with nested links; quite frankly, they don't work.
This isn't normally an issue because no one in their right mind will
stick a <link> inside another <link>.  However, we have entities which
create links, such as &man.*;, &a.*;, etc.  It's nice to be able to
use these inside links.  To deal with this..

Introduce a create-link procedure which will be used to replace (make
element gi: "A" ...) constructs.  This procedure creates a link as
specified only if the can-link-here procecure (described below)
returns #t.  If the latter returns #f, it will print the link text
without the link.

The (also new) can-link-here procedure returns #t if it determines
that it's okay to make a link in the current context, and #f
otherwise.  Currently, it does its check by figuring out whether the
current context is within a <title> or <question> tag.  This is not
ideal because it doesn't catch all cases, but it's a lot better than
nothing.  As the other cases are discovered, this procedure can be
modified.
2001-06-02 23:02:13 +00:00
Bruce A. Mah
0a95fdfc90 Add entry for new lge(4) driver. 2001-06-01 15:21:17 +00:00
Bruce A. Mah
73b129b694 Add new isdn4bsd drivers. 2001-05-25 17:22:16 +00:00
Dima Dorfman
94eb26771b Introduce a <groupname> tag similar to <username>. I don't forsee it
being rendered any differently than <username>, but it's very
confusing to write markup with both user and group names in close
proximity, and both marked up with <username>.
2001-05-22 03:32:17 +00:00
Udo Erdelhoff
f777871dce Add the framework for using <bibliography>. Use the title of the Book
in the text and let it be a link to the bibliography entry.
Note: The functionality needs JADEFLAGS=-Vbiblio-xref-title in the Makefile

Reviewed by:	nik, freebsd-doc (original version)
Original by:	nik
2001-05-20 17:30:44 +00:00
Bruce A. Mah
b2457ddfbd Add fdread(1) entity. 2001-05-14 21:54:48 +00:00
Bruce A. Mah
50d3137f88 Add an entry for the new nge(4) driver. 2001-05-12 03:46:53 +00:00
Udo Erdelhoff
509f575bfd Keep the spirit of PR docs/20130 alive and add a couple hundred entities
for manpages added since then.

PR:		in memoriam of docs/20130
Reviewed by:	alex
2001-05-07 17:45:24 +00:00
Bruce A. Mah
ac51406db0 New entity for nl(1). 2001-05-04 20:10:02 +00:00
Bruce A. Mah
576b38134b New manpage entities for sftp(1) and ssh-keyscan(1). 2001-05-04 14:38:07 +00:00
Bruce A. Mah
4f7f11d9e8 Add an entry for fmtcheck(3). 2001-04-27 14:43:49 +00:00
Bruce A. Mah
f1b8d9df68 Add manpage references for fsck_ffs(8) and fsck_ufs(8). 2001-04-24 22:51:50 +00:00
Dima Dorfman
796d703e73 mkisofs is in section 8, not section 1. A grep through the
translations shows that they don't use this.
2001-04-21 21:34:39 +00:00
Nik Clayton
6b9ded6e4c Fix a typo, and make sure that ISBN numbers in the front matter are
included.
2001-04-09 20:35:47 +00:00
Nik Clayton
82d52622d4 Add a default $create-refentry-xref-link$ function. 2001-04-05 13:19:59 +00:00
Bruce A. Mah
9b288c1e49 Commit a few manpage entries for recent release notes. 2001-03-29 20:21:22 +00:00
Nik Clayton
8e5b858d5b Add a new variable, %refentry-xref-link% which determines whether or not
man page references (&man.ls.1;, etc) are converted in to links to the
man->HTML CGI on freebsd.org.  Defaults to off.

Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 09:40:24 +00:00
Dima Dorfman
fbecbd3f16 Add an entry for links(1).
Approved by:	nik
2001-03-13 23:10:25 +00:00
Nik Clayton
59595c172d In the print stylesheet, keep the ToC to 3 levels of depth or less, and
don't indent body text.  This reduces the size of the Handbook's PS file
by about 1MB, and has similar (although less dramatic) effects on the
other documents.
2001-03-04 18:05:19 +00:00
Nik Clayton
1629d37bce Add an entry for xdm(1). 2001-02-26 21:47:23 +00:00
Bruce A. Mah
bc7949d00e Entries for some new manpages. 2001-02-21 22:47:15 +00:00
Nik Clayton
2aa8b87288 Oops. That last commit bought in some more stuff from my development
tree that I wasn't quite ready for.  It may as well stay in now though.

In order.

 1.  Pull out the code that deals with <segmentedlist>, the regular
     stylesheets handle that now.

 2.  Change how $email-footer$ is handled.  This requires changes to the
     <lang>/share/sgml/freebsd.dsl files, to come very shortly.

 3.  Redo warning and caution label support.  This is no-op, as Norm's
     sheets don't support this the way I want yet.

 4.  Remove a useless comment.

 5.  Pull out the experimental docinfo stuff, it doesn't work.

 6.  Pull out the special handling of <literallayout>, the regular
     stylesheets handle that now too.
2001-02-20 19:38:25 +00:00
Nik Clayton
ebb3148dbd Turn off the 'heading level characteristic' option. It breaks the Handbook
PDF build.
2001-02-20 19:17:26 +00:00
Nik Clayton
cfce6aed38 Add an FPI for the FreeBSD/DocBook 4.1 DTD. 2001-02-20 19:10:47 +00:00
Nik Clayton
e06261c405 FreeBSD customisation layer of the DocBook 4.1 DTD. 2001-02-20 19:10:26 +00:00
Nik Clayton
18f94d697b Hack to select the right image scaling based on the 'format' attribute
of the 'imagedata' element.
2001-02-20 19:09:50 +00:00
Nik Clayton
4e9b64c5f7 Turn on %generate-legalnotice-link%. This makes the word "Copyright" in
generated HTML link to the legalnotice, if the document has one.

Requested by several people on -doc (all of whom probably thought this
would be quite a lot of effort, heh heh heh).
2001-02-13 19:21:31 +00:00
Bruce A. Mah
fe8bbd1aca Add a few more entries that crept in from recent release notes. 2001-01-29 23:08:31 +00:00
Nik Clayton
5a65a99ceb Set the heading-level characteristic to '2' if we're generating PDF output.
This has the useful side effect of generating bookmarks in the PDF file,
which programs like Adobe Acrobat Reader can use to provide a navigable
table of contents in a side window.  This only seems to work with OpenJade,
but the option doesn't cause Jade any problems.
2001-01-08 12:40:52 +00:00
Alexander Langer
81329ff230 Use a document independent list of translators.
Obtained from:	FreeBSD German Documentation Project
Obtained from:	FreeBSD French Documentation Project
2001-01-06 18:39:27 +00:00
Alexander Langer
0e17cb35be Add entries for the German translation. 2001-01-06 18:26:46 +00:00
Alexander Langer
c26577ed14 Add "bdquo", which is supposed to be used in German texts.
Submitted by:	nik, months ago
2001-01-06 18:26:11 +00:00
Bruce A. Mah
1500794443 A few more entries in man-refs.ent. 2001-01-03 23:38:28 +00:00
Bruce A. Mah
3204d89866 Restore the removed svr4(8) and linux(8) entries, and add one for the
now-deprecated osf1(8).  -CURRENT doesn't have these anymore, but the
-STABLE branches do; plus it's a little odd to try to write about the
scripts' removal without these entries.
2001-01-02 23:57:50 +00:00
Bruce A. Mah
7f046f705f Add in a few more manual pages. 2001-01-02 23:54:59 +00:00
Bruce A. Mah
3242c4fb74 Add another handful of manpage entities, culled from the release notes. 2000-12-20 22:38:40 +00:00
Bruce A. Mah
d3cb48cf21 Add a handful of manpage entities. 2000-12-19 20:27:11 +00:00
Jim Mock
78991380db Add the cvs-committers and developers mailing lists to the Who's Who
section of the committer's guide.  While I'm here, change some
instances of freebsd.org to FreeBSD.org.

Submitted by:	obrien
2000-12-05 21:39:14 +00:00
Sheldon Hearn
3c1a15236c Revert rev 1.56 for fear of breaing translations.
Reported by:	nik
2000-11-29 15:27:17 +00:00
Sheldon Hearn
8b9852e397 Remove the entry for the soon-to-be-removed ibcs2(8). 2000-11-29 10:43:41 +00:00
Sheldon Hearn
b4676be084 Replace the entry for the soon-to-be-removed svr4(8) with the new
svr4(4).
2000-11-29 10:39:50 +00:00
John Baldwin
4a58f51374 Add manual references needed for the kernel locking chapter of the
developer's handbook.
2000-11-29 04:14:02 +00:00
Ben Smithurst
5fc5caec39 imake(1) 2000-11-23 11:27:59 +00:00
Nik Clayton
71197e65e9 Add "IP6Addr" as a valid option for the role attribute on <hostid>. Nothing
uses this yet, but lets try and stay ahead of the curve for a change :-)
2000-11-20 10:43:53 +00:00
Bruce A. Mah
b92d604c5a Add entries for pcn(4) and mly(4). 2000-11-03 23:17:11 +00:00
Sheldon Hearn
9e6e37ef9e Retire the joy(8) script. Using shell scripts to load kernel loadable
modules is out of fashion.

There is still a joy(4) manual page to clue people into the existence of
the joy of FreeBSD.
2000-11-02 14:15:30 +00:00
Sheldon Hearn
49882e8444 The linux(8) page has been retired. The recently add linux(4) takes
its place, although neither appears to be used in the doc tree.
2000-11-02 14:04:47 +00:00
Nik Clayton
6c424d3554 Put down the crack pipe long enough to revert back to labelling questions
with a number, and not just a big "Q".  No idea what the hell I was
thinking when I did that.

Override generate-anchor in the master stylesheets, so that the names
(i.e., the <a name="...">) in the HTML output for questions is Qx.y.,
where x.y is the question number.  This is much less likely to change
than the AENxxxx format, which changes with every addition or deletion
to the FAQ, so it's much easier for people to link to specific questions
within the FAQ now.

A few whitespace/indentation changes with existing code.
2000-10-28 21:14:44 +00:00
Nik Clayton
b5fbe0e00e Remove a gratuitous output.print.pdf section, a hang over from some of my
earlier testing.

Redefine the literallayout element handling, so that 'class=monospaced' is
handled properly.
2000-10-23 14:41:46 +00:00
Nik Clayton
749c7f2deb Initial image support. 2000-10-08 19:15:54 +00:00
Nik Clayton
895a6d904c Reorganise things a little bit.
Redefine two functions in <[ %output.print; [ ... ]]> to support image
handling.
2000-10-08 19:15:06 +00:00
Neil Blakey-Milner
1c78f1c07d a) "Fix" out-of-tree builds by not hard-coding locations of dsl files
with SYSTEM, and using instead PUBLIC entities gained from the catalog
in the directory of the language the document belongs to, or the
language-neutral entity.  Now we always use default.dsl as our dsl
master, and it grabs the necessary magic from the catalogs.

b) Fix the always-out-of-date imagelib problem with some make(1)-fu.

Approved by:	nik (ages ago)
2000-09-28 23:29:48 +00:00
Ben Smithurst
bc7dd81816 Add emacs(1). 2000-08-25 18:34:30 +00:00
Jun Kuriyama
61306ad2cc Add &man.vim.1; entry.
Fix bugs in using <screen> element.
Use $FreeBSD$ instead of $Date$.
2000-08-15 01:39:52 +00:00
Ben Smithurst
a1a8a70906 Fix some entities added in rev 1.45. ("c" -> "c++", likewise for lex++,
flex++ and g++)
2000-07-27 19:17:31 +00:00
Ben Smithurst
a3ab85bc59 Fix the doc build by adding back less(1) and more(1), which were
mysteriously removed in the last commit.
2000-07-26 22:09:55 +00:00
Jim Mock
3b254dbc55 Add entities for the few thousand man pages not already in this file.
PR:		20130
Submitted by:	Udo Erdelhoff <ue@nathan.ruhr.de>
2000-07-26 20:04:20 +00:00
Ben Smithurst
e1ae582ceb Add more(1) and less(1), which will be needed when I add des' mini
CVS primer to the committers-guide.
2000-07-26 00:57:20 +00:00
Ben Smithurst
846c848b3d Add some magic which puts double quotes around <errorname> text.
Submitted by:	nik
2000-07-25 18:23:45 +00:00
Nik Clayton
c0ca318851 Turn on callout graphics. Forgot this from about a week ago. 2000-07-25 10:31:35 +00:00
Ben Smithurst
7047aab304 Add crontab(5). 2000-07-20 00:14:29 +00:00