Commit graph

85 commits

Author SHA1 Message Date
Marc Fonvieille
052c24d56a Punctuation fix. 2002-10-28 21:53:41 +00:00
Marc Fonvieille
54f58d175c Keep &man.foo.1; form for -CURRENT manual page in the Handbook.
This will avoid any changes in the sgml files.  In translations, only
freebsd.dsl file will have to be updated.
(revert in part previous commit)
2002-10-18 21:16:33 +00:00
Marc Fonvieille
e2f224d087 Use current attribute for -CURRENT manual pages. It is now possible to
make the difference between -STABLE and -CURRENT manual pages.  We need
this for devfs, device.hints etc. manual pages in our Handbook.

Manual pages entities for -CURRENT should have the form &man.current.foo.1;
Note, this does not concern release notes but only docs.

An "old" man.devfs.5 entity is kept to allow the build of localized docs
till their upgrade.
2002-10-18 19:00:54 +00:00
Marc Fonvieille
7211c97cba Be more explicit, systems without DEVFS are FreeBSD versions before 5.0
PR:		docs/44206
Submitted by:	Victor Sudakov <sudakov@sibptus.tomsk.ru>
2002-10-18 18:27:20 +00:00
Martin Heinen
70ced0286c markup changes,
cpu -> CPU

Approved by:	alex (mentor)
2002-10-10 08:22:26 +00:00
Martin Heinen
e917389fe1 Add <hostid> tags for hostnames and domainnames
Approved by:	alex (mentor)
2002-10-08 07:41:22 +00:00
Giorgos Keramidas
9e38d0ec8b Various minor tweaks in the 'virtual consoles' section.
Submitted by:	ceri
2002-10-05 03:03:51 +00:00
Giorgos Keramidas
8fe87f8e22 Add a section to the "basics" chapter
to describe the virtual consoles of FreeBSD.

PR:		docs/37465
Reviewed by:	blackend
2002-10-04 13:43:05 +00:00
Murray Stokely
f8c25d1364 Use non-breaking spaces, as necessary.
PR:		docs/41546
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-09-30 15:46:55 +00:00
Giorgos Keramidas
25828945c4 It's been a while since we had block devices. 2002-08-31 03:01:52 +00:00
Ceri Davies
bb4c4c0d75 Make consistent use of <userinput> throughout the handbook. 2002-08-18 16:47:22 +00:00
Tom Rhodes
d4b003e30a FreeBSD documentation project prefers to use manual pages over man pages,
hence some documents should reflect this.

Tossed around on: -doc -developers
2002-07-11 19:08:31 +00:00
Jim Mock
279f2c4ab8 Reword a paragraph and wrap DEVFS in <literal></literal> tags.
PR:		39025
Submitted by:	blackend (with suggestions from keramida)
2002-07-03 22:54:03 +00:00
Marc Fonvieille
9bc2bb82e3 Add missing application tags for Netscape
Approved by:	keramida
2002-06-29 20:25:37 +00:00
Marc Fonvieille
5ca1cdd631 Use xref instead of link
Use man entities when appropriate, and add command tags

Approved by:	keramida
2002-06-26 20:57:29 +00:00
Giorgos Keramidas
0e9f20c95f Batch of handbook/basics/chapter.sgml changes from various PRs.
- s/permissions/permission bits/
- s/globing/globbing/
- environment variables is not a "shell function" but a "feature"
- setenv & export are not used to "view" env vars in tcsh & bash,
  but only to "set" them.
- remove punctuation from <title>
- wrap `man' in <command> tags

PR:		docs/38975, docs/38976, docs/39024, docs/39064 and docs/39089
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-12 00:39:15 +00:00
Giorgos Keramidas
9b77fe7ea0 Markup a couple of commands in <command> tags.
PR:		docs/39092
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-12 00:12:40 +00:00
Giorgos Keramidas
fcf228fd93 Reword the part that explains exceptions to hier(7).
Submitted as a followup to:

PR:		docs/39161
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-11 23:46:00 +00:00
Bruce A. Mah
222082aa93 Fix up a paragraph on file permissions, also tidy up some awkward
wording.

Based on the patch from the PR.

PR:		38976
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-11 01:00:53 +00:00
Ceri Davies
175491812b Various typo fixes (and an extra one while I'm here).
PR:		docs/39058
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-09 14:31:25 +00:00
Ceri Davies
116f818e20 Grammar fix
PR:		docs/39057
Submitted by:	Marc Fonvieille <marc@blackend.org>
2002-06-09 10:44:24 +00:00
Giorgos Keramidas
1a5bf5d3ff - Add a couple of <keycap> tags.
- Reword the part about editors of the base system and the ports.

PR:		docs/38851
Submitted by:	Marc Fonvieille <marc@blackend.org>

--- chapter.sgml.diff begins here ---
--- chapter.sgml.org	Mon Jun  3 12:38:09 2002
+++ chapter.sgml	Mon Jun  3 12:46:40 2002
@@ -1256,9 +1256,9 @@
       <command>ee</command>, all of the
       commands for manipulating the editor's functions are listed at the
       top of the display. The caret <literal>^</literal> character means
-      the control key on the keyboard, so ^e expands to pressing the
-      control key plus the letter <literal>e</literal>.  To leave
-      <application>ee</application>, hit the escape key, then choose leave
+      the <keycap>Ctrl</keycap> key on the keyboard, so <literal>^e</literal> expands to the key combination
+      <keycombo action="simul"><keycap>Ctrl</keycap><keycap>e</keycap></keycombo>.  To leave
+      <application>ee</application>, hit the <keycap>Esc</keycap> key, then choose leave
       editor.  The editor will prompt you to save any changes if the file
       has been modified.</para>

@@ -1277,9 +1277,9 @@
       <secondary><command>emacs</command></secondary>
     </indexterm>
     <para>FreeBSD also comes with more powerful text editors such as
-      <command>vi</command> as part of the base system, and
-      <command>emacs</command> and <command>vim</command>
-      as part of the FreeBSD Ports Collection.  These editors offer much
+      <command>vi</command> as part of the base system, while other editors, like
+      <command>emacs</command> and <command>vim</command>,
+      are part of the FreeBSD Ports Collection.  These editors offer much
       more functionality and power at the expense of being a little more
       complicated to learn.  However if you plan on doing a lot of text
       editing, learning a more powerful editor such as
2002-06-05 00:47:40 +00:00
Tom Rhodes
9ba764ae23 Consistancy checks: s/file system/filesystem/g 2002-05-16 01:42:28 +00:00
Ceri Davies
5ae67b1827 Where appropriate, s/in to/into/. 2002-05-04 14:22:35 +00:00
Giorgos Keramidas
0ec0f04efe Markup fixes. Use <literal> for literal text and <command> for an
instance of "echo".

PR:		docs/37067
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-04-15 15:18:21 +00:00
Giorgos Keramidas
67a1702cec Remove almost all instances of "try and <verb>" from the docs.
There is one remaining place in the fdp-primer, but that needs
a bit more work.

Inspired by:	docs/36462 (Gary W. Swearingen <swear@blarg.net>)
Reviewed by:	ceri, trhodes
2002-04-07 23:52:37 +00:00
Murray Stokely
3615d4e14e Quote attribute values. XSLT tools do not like unquoted attributes. 2002-03-26 23:37:38 +00:00
Ceri Davies
623bb6aa0d Correct an erroneous description of directory permissions and how they work.
Approved by:	murray
Submitted by:	Salvo Bartolotta <bartequi@neomedia.it>
PR:		docs/36241
2002-03-24 00:47:01 +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
Michael Lucas
739c8028f5 Correct number of processes available.
Submitted by:	Marian Cerny <cerny@spnv.sk>
Confirmed by:	roam
PR:		docs/34155
2002-01-22 13:20:40 +00:00
Giorgos Keramidas
10a7ec0db4 Break up the description of dumpfreq' and passno' fields of fstab(5)
to two separate items.  The text of `passno' is a bit more verbose now
than the old one.

PR:		docs/33043
Submitted by:	Ashley Penney <ashp@unloved.org>
2002-01-11 02:50:21 +00:00
Giorgos Keramidas
0efd38263b Expand most of the contractions found in the Handbook. 2001-12-08 12:08:44 +00:00
Murray Stokely
d6b6e478fb Add <command> tag.
PR:		31886
Submitted by:	Michael Lucas <mwlucas@blackhelicopters.org>
2001-11-14 15:45:47 +00:00
Bruce A. Mah
9a59b793ed Mention the risks of umount -f.
PR:		31883
Submitted by:	Michael Lucas <mwlucas@blackhelicopters.org>
2001-11-13 03:32:27 +00:00
Bruce A. Mah
7a04c68be7 Update shells description.
While I'm here delete some not-quite-as-applicable-as-it-once-was
text about shells in ports having "much more power".

PR:		31884
Submitted by:	mwlucas@blackhelicopters.org
2001-11-10 19:56:58 +00:00
Tom Hukins
c462aeab22 Improve use of English
Submitted by:	Jostein Trondal <jostein.trondal@sikkerhet.no>
2001-10-26 08:07:59 +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
Murray Stokely
950b084ea1 Correct the description of /etc/mail.
PR:		docs/30931
Submitted by:	Martin Heinen <mheinen0@wiesbaden-online.de>
2001-10-02 06:09:56 +00:00
Chern Lee
a4aab17018 Add short section about devices and device nodes.
Reviewed by:	murray
2001-09-20 21:48:49 +00:00
Chern Lee
6cfc9d250f Move section on mounting and unmounting filesystems from
Storage chapter to Basics.

Suggested by: nik and murray
2001-09-13 00:05:59 +00:00
Murray Stokely
55c4e2da8f * Rewrite the 'Directory Structure' section, and include descriptions
of a small subset of the directories listed in hier(7) that a newbie
  should really be familiar with.  Continue to point the user to
  hier(7) for an exaustive description of the directory hierarchy.
* Fix a couple of typos
* Enclose commands in <command> tags.

Partially Submitted by:	logo
2001-09-08 00:12:38 +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
3719fb1927 Add a standard synopsis. 2001-08-22 07:16:36 +00:00
Murray Stokely
141a46306d Fix typo to form a complete sentence. 2001-08-21 23:42: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
Jim Mock
40274f387b Change "manpage" and "man page" to "manual pages". 2001-08-11 21:34:53 +00:00
Jim Mock
7c6fc33233 ##MB -> ## MB
webserver -> web server
2001-08-11 20:39:17 +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
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