Commit graph

5951 commits

Author SHA1 Message Date
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
14b35ee415 Modifications for the NICE_HEADERS case :
* Increase font size for chapter title.
  * Add a .5pt rule underneath the chapter title, before the content.
2001-07-20 02:53:08 +00:00
Chern Lee
a5c8708c40 Markup Fixes:
Placed sh, bash, csh, tcsh in <command>
  Placed commands in <command>
  Placed options in <option>
  Placed several commands in man entities
  Placed several applications in <application>
  Placed make vars/targets into <makevar>/<maketarget>
  Placed filenames in <filename>
  <literal>chmod()</literal> -> <function>chmod()</function>

Standardize:
  ATT -> AT&amp;T
  endeavour -> endeavor
  tcl -> Tcl

Reviewed by:	murray
2001-07-19 23:18:09 +00:00
Murray Stokely
d78ef2bfe3 Reorganize the Developer's Handbook.
* Add chapter on kernel debugging (repo-copied from the Handbook)
  * Change "Introduction" part with 4 empty chapters to a
    "Introduction" chapter with 4 mostly empty <sect1>s.
  * Combine many of the different <part>s that contain only one empty
    <chapter> into larger <part>s.
  * Add * in front of unfinished chapter names so its very clear what
    needs to be worked on.
  * Added some <filename> tags where appropriate.
2001-07-19 22:06:06 +00:00
Chern Lee
474756bf03 Markup Fixes:
Place some terms in <varname>
Change <emphasis> -> <varname> in some intstances
Place commands in <command> or man entitiy
Place applications in <application>
Place filenames in <filename>
Place hostnames in <hostid>
One instance of <quote> -> <errorname>

Spelling/Terminology Fixes:
ip -> IP address
IPs/ips -> IP addresses
cfg -> config
Unice -> Unix systems

Reviewed by:	murray
2001-07-19 18:38:43 +00:00
Hiroki Sato
d0343abca1 Fix typo. 2001-07-19 17:55:55 +00:00
Hiroki Sato
8ca695247e - Merge Makefiles to build individual chapters in handbook
and the following from the English version:

	(new) -> 1.1    advanced-networking/isdn-bus.eps
	(new) -> 1.1    advanced-networking/isdn-twisted-pair.eps
	(new) -> 1.1    advanced-networking/natd.eps
	1.34  -> 1.35 	backups/chapter.sgml
	1.29  -> 1.30 	basics/chapter.sgml
	1.14  -> 1.15 	boot/chapter.sgml
	1.453 -> 1.456	contrib/chapter.sgml
	1.58  -> 1.60 	eresources/chapter.sgml
	1.31  -> 1.33 	kerneldebug/chapter.sgml
	1.17  -> 1.18 	kernelopts/chapter.sgml
	1.50  -> 1.58 	l10n/chapter.sgml
	1.19  -> 1.21 	policies/chapter.sgml
	1.5   -> 1.7  	sound/chapter.sgml
	1.216 -> 1.225	staff/chapter.sgml
2001-07-19 16:25:29 +00:00
Dima Dorfman
fb12aad004 Remove ``cannot'' from the word list. We aren't building a
dictionary, so it doesn't make sense to list common, every-day words
with well-known spellings.  Besides, "can not" is a proper, albeit
confusing, construct.  For example:

	The quick brown fox can not jump over the lazy dog.

The above isn't saying that the fox isn't capable of jumping over the
dog, but rather that the fox is capable of *not* jumping over it
(e.g., it can walk around it).  It is confusing (and should be
avoided), but nonetheless valid, English.
2001-07-19 14:08:57 +00:00
Dima Dorfman
29eb89e99b Fix two spelling errors. 2001-07-19 13:56:12 +00:00
Dima Dorfman
68694fa912 Fix a spelling error. 2001-07-19 13:55:58 +00:00
Dima Dorfman
f34b8ab126 Rewrite a paragraph to make it less confusing. 2001-07-19 13:55:38 +00:00
Mark Pulford
97827e3906 Add Dmitry for a bugfix to net/rinetd 2001-07-19 12:58:52 +00:00
Dima Dorfman
438606e25d Correct a brain-o.
Submitted by:	Vladimir Tchoukharev <chu@mail.ru>
2001-07-19 12:03:00 +00:00
Dima Dorfman
1011e0acaa Assorted spelling, punctuation, and markup fixes.
PR:		28916
Submitted by:	Alex Kapranoff <kapr@acm.org>
2001-07-19 11:55:05 +00:00
Dima Dorfman
f312a3debb The second argument to DECLARE_MODULE is a moduledata_t, not a
modeventhand_t.
2001-07-19 10:37:35 +00:00
Bill Fumerola
90c1dd3801 there is no such list 'freebsd-commit', it's 'cvs-all'.
Submitted by:	Ashley Penney <ashp@unloved.org>
Reviewed by:	hub:{/etc/aliases,/g/majordomo.lists}
2001-07-19 10:31:01 +00:00
Murray Stokely
ac4e5c00e7 All references were removed to this appendix last week. The content
is now available as two tutorials.
2001-07-19 09:37:01 +00:00
Mark Pulford
2b2e65bb37 Add Adam Kranzel for his update to games/xrisk 2001-07-19 06:30:40 +00:00
Chern Lee
4df284c246 Made <indexterm>'s more specific by adding <filename>, <command>,
and <application> entities.

Submitted by:	Valentino Vaschetto <valentino.vaschetto@windriver.com>
Reviewed by:	murray
2001-07-19 01:11:52 +00:00
Ben Smithurst
9bb625166b Update my PGP key. 2001-07-18 19:57:36 +00:00
Hiroki Sato
f8f6502569 - Merge the following from the English version:
1.30  -> 1.40 	Makefile
	1.163 -> 1.172	authors.ent
	1.97  -> 1.106	book.sgml
	1.9   -> 1.15 	chapters.ent
	1.29  -> 1.34 	backups/chapter.sgml
	1.24  -> 1.29 	basics/chapter.sgml
	1.31  -> 1.33 	bibliography/chapter.sgml
	1.10  -> 1.14 	boot/chapter.sgml
	1.425 -> 1.453	contrib/chapter.sgml
	1.61  -> 1.76 	cutting-edge/chapter.sgml
	1.37  -> 1.41 	hw/chapter.sgml
	1.24  -> 1.33 	serialcomms/chapter.sgml

- a portion merged only needed to avoid breakage of building process:

	advanced-networking/chapter.sgml
2001-07-18 19:29:10 +00:00
Alexander Langer
1ab80fd709 Sync with FreeBSD German Documentation Project:
Bring this file in sync with original rev. 1.33.

Submitted by:	Frank Gruender <elwood@mc5sys.in-berlin.de>
2001-07-18 16:50:47 +00:00
Chern Lee
4593015dcc Modified existing <indexterm>'s to make them more specific using
<filename>, <command>, and <application> tags.

Submitted by:	Valentino Vaschetto <valentino.vaschetto@windriver.com>
Approved by:	murray
2001-07-17 23:33:28 +00:00
Chern Lee
3e8d98b70a Standardize:
TCL -> Tcl
ethernet -> Ethernet
ftp (noun) -> FTP

Approved by:	murray
2001-07-17 22:20:51 +00:00
Murray Stokely
93321474e5 Wrap author attribution in <chapterinfo>.
Reword a couple of run-on sentences to use better subject-verb
agreement.

Terminate all items in a list with a period, not just some of
them.

Add <username> and <application> tags as appropriate.

"pw(8) has the information"

doesn't look well without the benefits of a hyperlink.  Reword this to:

"For more information, please see pw(8)."

Update example to change shells to zsh since tcsh is now in the base
system.
2001-07-17 21:35:41 +00:00
Chern Lee
6dbf07d805 Fix/Standardize:
internet -> Internet
can not -> cannot
CD-ROM -> CDROM
cdrom -> CDROM
UNIX -> Unix

To be standardized with the rest of the doc tree.

Approved by:	murray
2001-07-17 20:51:52 +00:00
Alexey Zelkin
005639d0fb backout rev 1.4, usage of <email> here has made <legalnotice> header just ugly.
Obtained from:	The FreeBSD Russian Documentation Project
2001-07-17 07:54:18 +00:00
Murray Stokely
568e399b34 Enclose contributors in <sect1info> tags.
Remove extra prompts from <screen> examples.

Remove lame text telling the user to "Forget about it" if a port is
broken.

Use absolute links since relative links don't mean much in PostScript
form.
2001-07-17 02:45:19 +00:00
Murray Stokely
20ac95335e Enclose contributor names in <chapterinfo> tags.
Properly markup command names.
2001-07-17 02:31:55 +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
741499c6ac Remove references to Kernel Debugging and Source Policies chapters.
These will be moving to the Developer's Handbook shortly.
2001-07-17 01:37:39 +00:00
Dave Zarzycki
66f396ae7d Added myself. 2001-07-17 01:27:18 +00:00
Chern Lee
24f820a21d Add Internet, MHz, and Unix to official word list.
Approved by:	murray
2001-07-17 01:24:58 +00:00
Chern Lee
69768b937c Misplaced "contributed by" line under a sub-section of XFree86 4.X
Configuration.  Placed this in the beginning of the chapter.

Approved by:	murray
2001-07-17 01:22:35 +00:00
Mike Barcroft
68760b5c86 Add myself to staff, remove from additional contributers.
Approved by: des
2001-07-17 01:09:40 +00:00
Chern Lee
80fd6d362f Added 43 indexterms to users chapter.
Submitted by:	Valentino Vaschetto <valentino.vaschetto@windriver.com>
Approved by:	murray
2001-07-17 00:21:21 +00:00
Chern Lee
7001f29865 Standardize:
UNIX -> Unix
UNIX's -> Unixes (one instance)

Unix is a proper noun, not an acronym.  Also conforms to O'Reilly's word list.

Approved by:	murray
2001-07-17 00:11:24 +00:00
Chern Lee
7cb71c2883 Add indexterms for serialcomms chapter.
Submitted by:	Valentino Vaschetto <valentino.vaschetto@windriver.com>
Approved by:	murray
2001-07-16 23:39:49 +00:00
Murray Stokely
c193d7d3ea Add 4 new signatures to my key from Usenix.
While I'm here, add Chris Shumway's key since I suspect I'm not the
only one who occasionally needs it for freebsd.org admin issues.
2001-07-16 23:32:45 +00:00
Nik Clayton
65d647eb30 Add markup around a few filenames and literal text.
Fix the markup choice in a few instances.

Cuddle up the ending </programlisting> with the previous line.

Turn $FreeBSD$ in to $FreeBSD&dollar; to prevent expansion.

Add Emacs local variables section.
2001-07-16 20:49:02 +00:00
Nik Clayton
b72caddbbc <literallayout> -> <literallayout class="monospaced"> 2001-07-16 20:35:38 +00:00
Alexander Langer
e3b505c95d Sync with FreeBSD German Documentation Project:
- Add the translated "disks" chapter.

Submitted by:	Martin Heinen <mheinen0@wiesbaden-online.de>
2001-07-16 17:59:27 +00:00
Alexander Langer
4cd321c6fc Sync with FreeBSD German Documentation Project:
- style + header fix
2001-07-16 17:53:59 +00:00
Nik Clayton
4e3d3f0e7f Bump the (c) year -- my God, did I really start this over three years ago?
Submitted by:	Felix-Antoine Paradis <reel@sympatico.ca>
2001-07-16 16:04:53 +00:00
Nik Clayton
1627346a2d Add the serial-uart/ and storage-devices/ directories. 2001-07-16 15:42:02 +00:00
Nik Clayton
563344e601 Add an entry for myself in to "Who's Who".
This originally wasn't going to be quite so self-serving a commit.  But I
see that Dima has already committed the other patches to this file while
I wasn't paying attention. . .
2001-07-16 15:33:07 +00:00
Nik Clayton
08b0d4b4bc Use <prompt> in a couple of places it's appropriate. 2001-07-16 15:12:18 +00:00
Nik Clayton
9524fc725a Add JADEFLAGS to the nsgmls command line, so that any special "-i" settings
get passed down properly.  This fixes "make lint" for the Handbook, now that
the chapters are individually buildable.
2001-07-16 15:11:54 +00:00
Nik Clayton
7d44b5e448 + xref closes with '/>'. This causes a trailing '>'
at the end of the reference.  Removed the '/'.

+ Marked up 'log' and 'spool' as filenames
  in the discussion of the 'var' directory.

+ Changed fdisk to show up as command.

+ Marked up vn as device.

+ Marked up "sysinstall" using a man.systinstall.8; entity.

PR:		docs/28989
Submitted by:	Martin Heinen <mheinen0@wiesbaden-online.de>
2001-07-16 15:02:50 +00:00
Nik Clayton
b30b3464f5 Add a "Quick Start" section, based on one of my messages to -doc. 2001-07-16 14:45:56 +00:00