Commit graph

114 commits

Author SHA1 Message Date
Marc Fonvieille
819a08a54a Add missing items in Synopsis and remove some other one.
PR:		docs/56929 & docs/56930
Submitted by:	Marco Trentini <mark@remotelab.org>
2003-09-17 07:40:06 +00:00
Marc Fonvieille
cc1f38618d DEVFS is not only used on 5.0 but also on following versions.
While I'm there, use a manual page entity where needed.

PR:		docs/56592
Submitted by:	Denis Peplin <info@volginfo.ru>
2003-09-08 16:39:23 +00:00
Marc Fonvieille
7eb746701d To be consistent, add a space between prompts and commands. 2003-08-21 10:52:58 +00:00
Simon L. B. Nielsen
d122695827 Add trademark symbols:
- Add trademark tags for all trademarks now that the stylesheet
   handles it right.
 - Always use correct case for trademarks.
 - Don't join trademarks with other words, e.g. using hyphens.
2003-08-20 22:38:04 +00:00
Marc Fonvieille
e894b1e1a3 Add some application and filename tags. 2003-08-20 14:02:52 +00:00
Marc Fonvieille
a7233c083d Avoid application tags for Operating Systems. 2003-08-20 09:52:04 +00:00
Marc Fonvieille
29fc580865 Use of acronym tags instead of filename tags for ELF. 2003-08-19 17:11:10 +00:00
Murray Stokely
e30f0850e4 Use <replaceable> rather than <literal> so that example filenames are
rendered more appropriately with slanted text rather than just
monospace text.
2003-07-31 02:32:15 +00:00
Murray Stokely
e06bad48b3 Add the 'frame="none"' attribute to the only table in this chapter
without it.  Tables are rendered better with our current docbook
stylesheets if they omit the frames around each cell.
2003-07-31 02:23:14 +00:00
Murray Stokely
9521538be2 * Spell 'referred' properly.
* Fix singular/plural agreement of a sentence.
* Switch transposed words in a sentence "most with" -> "with most".

Sponsored by:	FreeBSD Mall, Inc.
2003-07-31 02:14:17 +00:00
Ceri Davies
fa4c3e2914 Capitalise titles as per the Chicago Manual of Style. 2003-07-13 18:10:11 +00:00
Tom Rhodes
9c516b2b01 Add a section on symbolic permissions to our Unix Basics chapter.
Reviewed by:	ceri, Simon L. Nielsen <simon@nitro.dk>
2003-06-23 16:39:55 +00:00
Michael Lucas
6fa84d219b Add "Binary Formats" section to Unix Basics chapter.
I don't like this here, but it sucks less than having it in any other
sections.

This text bears a *very* suspicious similarity to the binary format
questions in the FAQ.
2003-06-12 17:17:21 +00:00
Chern Lee
41f84184b8 Move "File System Access Control Lists" from Unix Basics chapter to Security
chapter.  It is more appropriate there.

Discussed on:	freebsd-doc
2003-06-03 19:46:01 +00:00
Martin Heinen
a0293ec921 Clean up some index entries:
- capitalize IP and FORTRAN,
- move entries in singular to the corresponding plural entries,
- fix AT&T index entry,
- move composite entries into the primary index entry and
  add a secondary entry when necessary,
- move indexterm elements in the proper section.
2003-05-21 21:25:35 +00:00
Tom Rhodes
b28e47038e Start producing output in the form of <chapter name><section id>.html.
Not objected to by:	-doc
Reviewed by:		ceri, hrs, brueffer
2003-05-20 14:45:34 +00:00
Peter Pentchev
1f359cbbab /tmp/msg 2003-01-12 18:20:55 +00:00
Tom Rhodes
6266c5544f Run through aspell. 2003-01-06 06:26:30 +00:00
Marc Fonvieille
b341d7163f - Typos fixing
- Remove contractions
- s/I/we
2003-01-01 15:37:54 +00:00
Marc Fonvieille
d2a14426bc Typo: s/sporting/supporting 2003-01-01 12:04:52 +00:00
Marc Fonvieille
88393fac80 Add a missing para tag and a little rewording in Synopsis to be
consistent with all items.
2003-01-01 11:21:27 +00:00
Tom Rhodes
b793dc47bc Add a directory output where ACL use is shown. Document how to tell when
ACLs are being used.

Requested by:	rwatson (who also provided this output)
2002-12-30 22:39:44 +00:00
Tom Rhodes
5e44403f62 Add the ACLs section under the permissions section.
Requested by:	rwatson
2002-12-24 01:40:27 +00:00
Tom Rhodes
946df26473 Fix a typo in the 'Unix Basics' chapter.
Noticed by:	<kamidesu@hotpop.com>
2002-11-06 04:03:12 +00:00
Marc Fonvieille
b402f34751 Typo: s/form/from 2002-10-28 22:20:26 +00:00
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
Nik Clayton
5fbffac4b6 Add 5 new images to supplant some ASCII art of directory hierarchies.
The images were created using graphviz, and the .dot files are included
for reference.
2002-06-30 10:10:47 +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