Commit graph

134 commits

Author SHA1 Message Date
Ceri Davies
f589c4e5a5 Grammar police: "setup" is not a verb. 2003-11-05 10:36:56 +00:00
Ceri Davies
5a504dc6c3 Change references to /dev/cua[il]0X to read /dev/cua[il]aX.
Submitted by:	Sergey Zaikov <Sergey_Zaikov@p66.f5.klax.tsu.tula.ru>
Reviewed by:	simon
2003-08-28 23:41:03 +00:00
Simon L. B. Nielsen
0064207a88 handbook/*
- Use trademark entities.
 - Add trademark attributions.
 - Always use correct case for trademarks.
 - Don't join trademarks with other words, e.g. using hyphens.
 - Don't use trademarks as nouns (e.g. don't use "Windows NT's").

diskless-x/article.sgml:
 - While I'm here anyway add trademark tags for all trademarks, now
   that the stylesheet handles it right.

trademark.ent:
 - Add entities for more trademarks / companies.

Also rename the 3Com trademark entity from t3com to tm.3com.  This
should make the entity naming convention a bit more consitent.  This is
done now since the entity is not used too many places yet.
2003-08-28 16:30:39 +00:00
Ceri Davies
583831606d Capitalise titles as per the Chicago Manual of Style. 2003-07-13 20:36:54 +00:00
Tom Rhodes
52da88130a Kill whitespace. 2003-05-21 00:17:14 +00:00
Tom Rhodes
4e1ba4d813 Minor caps change on a <title>. 2003-05-21 00:06:56 +00:00
Tom Rhodes
93186b6e72 Convert the mini-FAQ into a more formal troubleshooting guide. 2003-05-21 00:04:30 +00:00
Ceri Davies
a9e91411de Add an XXX item. There is a need for an update or a note here after
rc.serial's demise.
2003-05-19 18:15:27 +00:00
Ceri Davies
510ecfc386 Whitespace cleanup from r1.74.
Translators may ignore both this revision and 1.74.
2003-05-19 18:11:48 +00:00
Ceri Davies
42191db277 Apply some grammatical improvements in the early part of this file. 2003-05-19 18:10:24 +00:00
Martin Heinen
01d1ce59db I won't do copy'n'paste again: s!verbunden mit!connects to!
Submitted by:	jesper
2002-12-24 11:40:32 +00:00
Martin Heinen
ec20a60249 Use a common null-modem cable pinout which supports hardware flow control.
PR:		docs/35280
Submitted by:	mheinen
2002-12-23 22:35:53 +00:00
Marc Fonvieille
4b5857eeec Use quote tags and manual page entity where needed. 2002-11-30 21:30:36 +00:00
Marc Fonvieille
2c0d613996 Start the update of serial console section: the kernel syntax was
updated from 3.X to 4.X syntax, 5.X one will be added soon with all
needed fixes (device.hints etc.).
2002-11-27 20:17:50 +00:00
Marc Fonvieille
0d828456b5 Use of quote tags where needed. 2002-11-24 11:49:50 +00:00
Marc Fonvieille
5605398b3c Punctuation fix. 2002-11-23 12:34:51 +00:00
Marc Fonvieille
d74b8872d3 Fix the kernel configuration lines for serial ports: the 2.X syntax was
used.  Use of 4.X and 5.X syntax and point 5.X user to
/boot/device.hints file.

PR:		docs/45375
Submitted by:	Valentin Nechayev <netch@netch.kiev.ua>
2002-11-23 12:24:17 +00:00
Murray Stokely
d548b181fa Use non-breaking spaces.
PR:		docs/41546
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-09-30 15:34:24 +00:00
Marc Fonvieille
c21277446b Add a missing word
Submitted by:	Dan Langille <dan@langille.org>
2002-08-09 16:53:22 +00:00
Jim Mock
5b38e4c0f7 Add a missing space.
Submitted by:	trhodes on -doc
2002-07-30 02:40:52 +00:00
Giorgos Keramidas
062383f8a1 Update the instructions for rebuilding the boot blocks and loader.
PR:		kern/37127
Submitted by:	Johan Karlsson <k@numeri.campus.luth.se>
2002-07-02 03:47:06 +00:00
Murray Stokely
a00a4fe5a1 Add additional troubleshooting information about serial connections.
Specifically, mention the 3wire terminal entry to ignore hardware
handshaking.

PR:		docs/37120
Submitted by:	Doyle Myers <doylem@mac.com>
2002-05-30 07:49:50 +00:00
Tom Rhodes
78335e92ee Add some markup to the dial-in section
PR:		37069
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-05-14 19:24:18 +00:00
Tom Rhodes
16455935dd Remove a period at the end of a few title's.
PR:		37854
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-05-09 19:54:25 +00:00
Ceri Davies
5693e26a0d Whitespace cleanup from last commit.
No content changes.

Approved by:	murray
2002-04-29 12:22:30 +00:00
Ceri Davies
35716bf6ec Wrap root in <username>.
PR:		docs/37532
Submitted by:	Martin Heinen <martin@sumuk.de>
Approved by:	murray
2002-04-29 12:14:08 +00:00
Giorgos Keramidas
4d56544381 Commit forgotten part of PR.
a lines like this -> lines like these

PR:		docs/36625
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-04-02 21:39:00 +00:00
Giorgos Keramidas
771653bb34 Change CTS/RTS to RTS/CTS. A google search, a grep on the doc/*
files, and a grep on all the manpages shows that this is used more
often.  Try to be a tiny bit more consistent.

PR:		docs/36624
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-04-02 01:05:02 +00:00
Giorgos Keramidas
76c169c4ef Correct various typos in the Handbook.
PR:		docs/36614
Submitted by:	Martin Karlsson <martin.karlsson@visit.se>
2002-04-01 14:39:29 +00:00
Dima Dorfman
1c4177c1b9 In the words of the submitter:
Some parts of the documentation are using COM1:
        instead of COM1 to describe the first serial interface
        in MS-DOS.  The device name should be COM1, ':' was used
        as separator by the mode command.

PR:		36010
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-03-24 04:06:54 +00:00
Giorgos Keramidas
cc006c5ed9 Correct a few places where ';' was used instead of ':' above samples.
Inspired by: a patch by Priit Piipuu <priit@bsd.ee>
2002-02-28 03:47:08 +00:00
Giorgos Keramidas
e7655d4598 Whitespace fixes.
Punctuation chars should not be preceded by spaces.
2002-02-14 22:31:00 +00:00
Murray Stokely
e0432ef7e9 * Correct links
* s/freebsd.org/FreeBSD.org
* Use relative links wherever possible

PR:		docs/31447
Submitted by:	Cyrille Lefevre <clefevre@citeweb.net>
Found by:	linbot
2001-10-23 22:12:46 +00:00
Murray Stokely
2b01a16746 s/4.0-CURRENT/4.0/
Submitted by:	chern
2001-10-16 19:33:03 +00:00
Chern Lee
dd01434120 Fix prepositional phrases in Sypnosis:
* After reading this chapter you will know:
   -> After reading this chapter, you will know:
 * Before reading this chapter you should:
   -> Before reading this chapter, you should:
2001-10-08 20:30:51 +00:00
Tom Hukins
12ba3337f4 Clean up some links and references 2001-10-08 12:53:11 +00:00
Chern Lee
186db00629 * Reword some sentences for consistency
* Place an item in <note>, clarify PID 1 in a <note>
* Place a set of questions into a <qandaset>
* Minor markup changes
2001-09-24 23:31:29 +00:00
Valentino Vaschetto
4623c525db CTRL -> <keycap>Ctrl</keycap>
SPACE -> <keycap>Space</keycap>
ALT -> <keycap>Alt</keycap>
ENTER -> <keycap>Enter</keycap>
and so on...

Reviewed by:	chern
2001-08-30 22:44:37 +00:00
Murray Stokely
c42ea2c2ae Terminate synopsis listitems with a period.
Also give more information about prerequisites :

 "* Understand Unix permissions and processes (Chapter 3)."

instead of :

 "* Read chapter 3"
2001-08-22 05:37:50 +00:00
Chern Lee
6c21f4c1e9 Change all contractions to proper form.
don't -> do not
isn't -> is not
let's -> let us
... and so on
2001-08-16 18:35:08 +00:00
Chern Lee
d9b1288ac8 Markup Changes, place terms in:
* <application>
 * <username>
 * <command>
 * <literal>
 * <devicename>

Reviewed by:	murray
2001-08-14 22:06:11 +00:00
Jim Mock
40274f387b Change "manpage" and "man page" to "manual pages". 2001-08-11 21:34:53 +00:00
Chern Lee
205cf1b49a Standardize capitalization of titles:
* First and last word uppercase
* Prepositions, articles, and short conjunctions lowercase
* The word 'to' lowercase
* Preserved capitalization for program/command names

Reviewed by:	murray
2001-08-10 22:58:17 +00:00
Chern Lee
2b61014302 Properly markup contributions in <chapterinfo>/<sect1info>/<sect2info> tags
according to recent changes for entire Handbook.

Reviewed by:	murray
2001-08-09 23:42:35 +00:00
Valentino Vaschetto
6cf123d6cf Closed a couple of open tags which were not closed.
Reviewed by:	murray
2001-08-09 22:50:10 +00:00
Murray Stokely
2a14ff14f4 - Add an <example> and use a calloutlist for the /etc/ttys section
instead of creating a new subsection for each field.  The output is
  much more succinct and legible.
- Add a note about FreeBSD 5.0 and devfs that obviates the 'Making
  Device Special Files' section.
- Remove reference to a book that we don't have any bibliographical
  information for and that is a bit tangential to the subject at hand
  (RS-232 Bible).
- Add missing words to make complete sentences.
- Simplify discussion of null-modem and "straight" serial cables.
- Consistently use a replaceable 'N' for the last character of
  terminal devices instead of interspersing ? and X.
- Remove duplicate 'See the sio(4) manual page for more information.'
  lines.  One of these is quite sufficient per section.
- Remove more duplicate information that is unnecessary since this
  chapter has been reorganized.
- Enclose a hint in the <tip> tag.

This chapter still needs work.
2001-08-08 06:42:18 +00:00
Chern Lee
c20dd61362 Spelling Changes:
* OSs -> Operating Systems
* commmunications -> communications
* realise -> realize
* customising -> customizing
* customise -> customize
* realise -> realize
* behaviour -> behavior

British to American spelling for some of the above words only in the
Handbook as discussed on -doc.

Reviewed by:	murray
2001-08-06 21:25:28 +00:00
Murray Stokely
565a2b3a46 This chapter was a very unnatural union of several good tutorials.
Many of the sections in this chapter contained duplicate information
(about FreeBSD 1.1.5.1, mind you).

This commit adds a more substantial introduction section with
information about terminology, cables and ports, kernel configuration
of serial devices, and using stty for serial configuration.  The
remaining sections ("terminals", "dial-in service", "dial-out
service", and "setting up a serial console") can then refer to this
earlier section instead of duplicating how to setup /etc/ttys and HUP
init, etc. in each one.

Also contains a couple more markup fixes for <keycode>s.

PR:		19481
2001-08-06 12:36:16 +00:00
Murray Stokely
2237f3e894 First step of a major overhaul of this chapter. Split into multiple
commits to make it slightly easier on the translation teams.

  * Add a standard synopsis
  * Remove references to FreeBSD 1.1.5.1 and FreeBSD 1.1.  Document
    the behavior of 4.x / 5.x and ignore the paleontology.
  * Move <indexterm>s around so that printed output looks better.
  * Reference other chapters in the Handbook instead of duplicating
    information.
  * Rephrase many sentences to be more concise.
  * <filename> -> <command>
  * Refer to the text as "this chapter" instead of "this document"
  * Refer to manual pages consistently.
  * Turns a couple of question and answer entries into more formal
    paragraphs.
  * Don't intersperse example commands inside paragraphs as often.
    Instead, talk about something and then provide an example.
  * Mark up contributors in <sectNinfo>.
  * Remove synopsis-like information from one of the individual
    sections, since this has been expanded at the front of the
    chapter.
  * Mark up keys in <keycode>
  * Remove acknowledgments section.  This is inappropriate for a book
    chapter and the acknowledged person has been moved to the
    <sectNinfo> as an additional contributor.
  * Remove "information integrated from FAQ", that describes much of
    our documentation.
  * Remove troubleshooting entry about needing to be in a specific
    group to run tip or cu, since this is no longer the case.

PR:		19481
2001-08-06 12:17:47 +00:00
Murray Stokely
2fdac55c46 * Combine singular/plural index terms.
* Add a few section id's so that the printed index can find the page
  number.

Submitted by:	Valentino Vaschetto <valentino.vaschetto@windriver.com>
2001-07-30 17:18:54 +00:00