Commit graph

306 commits

Author SHA1 Message Date
Murray Stokely
1246adb2b2 Pass the TEXCMDS variable to pdftex when generating a PDF file, so
that optional features such as two-sided output and justification work
for PDF files, not just PostScript.

PR:		docs/32849
Submitted by:	Peter Johnson <freebsd@bilogic.org>
2002-01-01 08:41:19 +00:00
Murray Stokely
79c09bbbdf Add a command variable for 'LATEX' so we can draw figures using LATEX
and then convert them to .eps files with dvips -E.
2002-01-01 05:30:49 +00:00
Joseph Koshy
7f7f0a3c52 Add a bibliography entry for ``FreeBSD Unleashed'' by Brian Tiemann and
Michael Urban.
2001-12-21 10:22:07 +00:00
Murray Stokely
c0e16ca1e7 Back out r1.59 until I have time to fix this properly
Requested by: bmah
2001-12-20 13:52:16 +00:00
Bruce A. Mah
9820bd6b8c Add entities for mount_smbfs(8) and smbutil(1). 2001-12-18 16:25:31 +00:00
Alexey Zelkin
987c1c8bed Add new make target 'cleanall'. Its responsibility is to remove *all*
possible generated files (make clean is called for all known formats).

It can be useful when default FORMATS for document has different value
than was used in build.

Reviewed by:	nik
2001-12-13 23:51:26 +00:00
Alexey Zelkin
54cf68eab2 Force tidy(1) to use '-raw' and newly added '-preserve' options
to process generated HTML. This not cause any side effects except
leaving some character entities in their numeric form instead
converting them into alphabetical notation (&#60; instead of &lt;),
but since all browsers understand such cases it is not a problem.

This commit should make all translations tidy clean, since
tidy should not arise entities conversion problem as it did
for long time before. Therefore all occurences of manual settings
of TIDYFLAGS and NO_TIDY declarations for translations are removed.

No objections from: -doc
Requested by: Russian and Japanese translation teams
2001-12-12 11:49:38 +00:00
Bruce A. Mah
e553d32777 Add em(4). 2001-12-04 06:50:37 +00:00
Bruce A. Mah
a5349c9339 Entity-ize the release notes and hardware notes and change a reference
in the FAQ to use these.  (Presumably there'll be others.)

While I'm here, add an entity for the current release's errata file.

Heavily based on the last patch in the PR, modified to be consistent
with the way that the Website build defines similar entities.

PR:		30202
Submitted by:	Michael Lucas <mwlucas@blackhelicopters.org>
2001-11-26 01:47:20 +00:00
Bruce A. Mah
f9a4fd18c4 Add entities for lomac(4) and ugen(4). 2001-11-21 19:29:40 +00:00
Murray Stokely
0361e0a8d3 Rework our index support.
* Add a new document-specific variable, HAS_INDEX, to specify if a
    given document is marked up with <indexterm> entries.

  * Rework the index support so that both HAS_INDEX and GEN_INDEX are
    checked before trying to generate an index for a document.

  * Only create index.sgml if both HAS_INDEX and GEN_INDEX are set.

This allows us to recursively build the documentation tree with
GEN_INDEX=1 and have it only try to create an index (very time
consuming) for the few documents that are ready for this.  Previously,
running "make GEN_INDEX=1" from the top of the doc tree would look for
index terms in every single document.

With this, I hope we can start building our docs with GEN_INDEX set on
freefall so that users browsing the HTML docs will get the benefit of
the index we've been hiding in CVS for 6 months.
2001-11-19 06:11:16 +00:00
Bruce A. Mah
009b5b0055 Add entry for ipfs(8). 2001-11-16 01:43:14 +00:00
Bruce A. Mah
7bf53aa2c1 Update count of ports for documentation purposes.
Submitted by:	mwlucas@blackhelicopters.org
2001-11-10 02:04:26 +00:00
Murray Stokely
c9252fd82e Fix typo in last commit. 2001-11-06 04:27:39 +00:00
Murray Stokely
f646abd75f Add a ISO8879 catalog entry.
Submitted by:	Cyrille Lefevre <clefevre@citeweb.net>
2001-11-05 10:43:17 +00:00
Murray Stokely
4ffcb3417b Make the TIDYFLAGS/TIDYOPTS usage homologous to the rest of the make
variables in the doc infrastructure.  Fixes several small bugs.

PR:		docs/31703
Submitted by:	Akio Morita <amorita@FreeBSD.org>
2001-11-05 10:33:38 +00:00
Bruce A. Mah
1a1f4c5ed1 Add entity for ng_eth(4). 2001-10-31 16:37:36 +00:00
Bruce A. Mah
274215c5ca Unbreak PDF file building. 2001-10-30 21:37:53 +00:00
Murray Stokely
58a809138a Add a declaration missing from the last commit. 2001-10-29 10:52:52 +00:00
Murray Stokely
f92319a1b1 Make build/install /usr/obj prefix clean.
Also fix several minor bugs here, such as leftover files not being
deleted after 'make clean'.

PR:		docs/31131
Submitted by:	Cyrille Lefevre <clefevre@citeweb.net>
2001-10-29 09:21:53 +00:00
Bruce A. Mah
f8cc94fd62 Add entity for conscontrol(8). 2001-10-25 20:45:43 +00:00
Bruce A. Mah
eb966a6b37 Add entity for isdnphone(8). 2001-10-19 16:29:39 +00:00
Bruce A. Mah
aaf33169d4 Add an entity for gx(4). 2001-10-19 14:48:45 +00:00
Murray Stokely
f55eaf1468 Properly define entities for [ OK ] and [ CANCEL ] and use these
entities throughout the install chapter.  These need to be defined
with &nbsp; so that these buttons don't wrap across lines.

This prevents :

"Press the [
OK ] button"

from showing up in the print or HTML output.
2001-10-18 20:48:57 +00:00
Murray Stokely
0b61dde25e Correctly use the \url{} macro for ulinks without any content.
So <ulink url="bla"></ulink> will be displayed properly.
2001-10-13 01:07:24 +00:00
Bruce A. Mah
fd1172c3fd Add entities for strnstr(3) and strcasestr(3). 2001-10-13 00:24:17 +00:00
Chern Lee
ec98517d74 Add an entry for xvidtune(1) 2001-10-08 22:37:18 +00:00
Bruce A. Mah
56119bda39 Add an entity for eaccess(2). 2001-10-06 05:09:30 +00:00
Bruce A. Mah
b175ae6a93 Add entities for rp(4) and agp(4) manpages. 2001-10-05 22:26:43 +00:00
Murray Stokely
04a95c21db Fix `make lint' for the handbook by hiding the index behind a
parameter entity.
2001-10-04 09:40:31 +00:00
Bruce A. Mah
64bd20c67d Add vlan(4). 2001-09-28 18:29:32 +00:00
Bruce A. Mah
2935b0aacf Add manpage entities for bge(4) and some new netgraph nodes. 2001-09-28 00:37:37 +00:00
Murray Stokely
f1f42b3785 Add an entity for the month of the last -RELEASE version. This will
make it easier for us to keep things updated with future releases.

Submitted by:	tom
2001-09-27 10:15:51 +00:00
Murray Stokely
492963ce88 Move the current release entity so that it can be used by all of our
documentation, not just the Handbook.
2001-09-27 01:08:57 +00:00
Murray Stokely
6cfb4c7134 Add entity for amdpm(4). 2001-09-18 04:50:22 +00:00
Murray Stokely
2a18b45f52 Move the newsgroup entities out of the Handbook directory and create a
catalog entry for them.  These entities are not specific to the
Handbook.
2001-09-18 04:14:44 +00:00
Murray Stokely
8577fa90a4 Add a knob to trace TeX's memory usage. This is useful when you're
using tons of different macro packages (like we do) and something is
misbehaving. ``make TRACE=1 book.ps''
2001-09-17 09:45:01 +00:00
Murray Stokely
24818905cc Silence a warning for HTML output, and add some more special handling
for the justified print output case.
2001-09-13 07:34:57 +00:00
Murray Stokely
f7fcffd6d4 Add support for cascading stylesheets and images for documents with
HTML as a source format.
2001-09-13 07:26:48 +00:00
Dima Dorfman
2fbe82ba36 Add klxref(8). 2001-09-11 12:46:57 +00:00
Murray Stokely
f0a4faa9b7 Whitespace change only. 2001-09-11 08:56:52 +00:00
Murray Stokely
2f6155eed2 Use a formatting-instruction to work around the problem where Jade
thinks that it must never output something like "_" to the TeX
backend, and should instead use \char{95}.  The package we are using
to hyphenate URLs, url.sty, is designed to allow URLs without worrying
about such things, and will literally display the \char{95} without
this patch.
2001-09-11 08:47:53 +00:00
Murray Stokely
486bf4abfd Turn on -ioutput.print.twoside in the TWO_SIDE=1 case (which is also
the BOOK_OUTPUT=1 case).
2001-09-11 02:32:32 +00:00
Murray Stokely
621456e13d Add a new parameter entity output.print.twoside, which redefines some
of the functions to get correct page numbering for two sided output.
This code will also have to insert some blank pages to make sure part
and chapter headers always start on a verso page.  This is an
improvement, but it is also a work in progress that should be in the
tree so others can experiment with it.

The most visible impact is that the Chapter 1 now starts on page 2
instead of page 1.  Part I now starts on page 1 instead of xviii.
When this is done properly, Chapter 1 will start on page 3.
2001-09-11 02:31:50 +00:00
Murray Stokely
45c7fe1389 Wrap <filename> in \url{...} if justification is turned on. This
prevents the majority of the remaining margin overflows.  However,
this solution isn't very elegant in that it completely ignores
<replaceable>s inside of a <filename> element.  The normal TeX that
gets output inside of \url{..} confuses TeX, so we must simply process
the children of replaceable without doing any additional formatting
inside of the \url{..} (such as putting the text into italics).

More work needs to be done on this.
2001-09-11 02:06:03 +00:00
Murray Stokely
2bd7f72656 Add justification to the list of features that
'make BOOK_OUTPUT=1 book.ps' gives you.
2001-09-11 00:38:32 +00:00
Murray Stokely
872e454400 Add a formatting instruction to wrap URLs in \url{} for the print
backend.  This allows JUSTIFY=1 to look much nicer.  Filenames still
aren't handled, but there is another TeX package for that that I will
use shortly.
2001-09-08 02:21:19 +00:00
Murray Stokely
eca1d05330 Add a new option 'JUSTIFY' which can be used to tell the TeX backend
to make the paragraphs right justified using TeX's default hyphenation
rules.  We still must add some hooks to certain elements (URLs) to
deal with special cases that TeX can't hyphenate well.
2001-09-08 01:59:22 +00:00
Murray Stokely
7f68ef77e2 We don't want to label the preface sections, if present. 2001-09-07 22:26:45 +00:00
Murray Stokely
a36b0de6c7 Add two new options to our documentation infrastructure.
TWO_SIDE    - If defined, two sided output will be created.  This
                  means that new chapters will only start on odd
                  numbered (aka right side, aka recto) pages and the
                  headers and footers will be aligned appropriately
                  for double sided paper.  Blank pages may be added as
                  needed.

    BOOK_OUTPUT - If defined, this will set all of the other
                  print-output options that can significantly increase
                  the build time, but make for much nicer looking
                  output.

To implement the two sided output, we need to override a TeX variable
to control the behavior of the JadeTeX macro package.  So this also
introduces a TEXCMDS variable that can be set with additional TeX
commands that should be run before processing the input TeX document.
In the TWO_SIDE case, we simply set it to \def\PageTwoSide{1}
2001-09-07 10:21:41 +00:00