Commit Graph

24 Commits

Author SHA1 Message Date
ru
033894c029 - Avoid using second person.
- Demonstrate how .Nm can be used without the side effect of causing
  a line break in the SYNOPSIS section.
2006-09-18 11:56:51 +00:00
brueffer
efe16a4faf Make this example more real world usable: When the manpage first appeared
is not interesting, when the driver appeared is.  Most people who use this
example leave the manpage appearance date in and the driver date out.

MFC after:	3 days
2006-05-20 09:49:05 +00:00
brueffer
7426a2a8f4 Add a standard boilerplate to the SYNOPSIS section that mentions how
to load a kernel module.

MFC after:	3 days
2006-04-01 10:10:36 +00:00
brueffer
817f64ce9c Join two lines. 2005-05-07 11:02:34 +00:00
keramida
a80074d407 Cross-reference the newly added example.9 2005-01-12 20:56:15 +00:00
simon
ae25ac2907 Add a HARDWARE section to the example section 4 manual page.
Reviewed by:	ru
MFC after:	3 days
2004-08-18 07:05:35 +00:00
ru
f24cad11ff Removed the comment that required all FreeBSD manpages
to have the $FreeBSD$ keyword, as this is now enforced
by the CVSROOT/commit_prep.pl script.

Fold multi-word macro arguments into a single argument
by putting the surrounding double quotes - this speeds
up the -mdoc processing drastically (of course if used
systematically).

Use the new features of -mdoc: exact -width specifiers,
.In macro as an ``.Fd #include'' replacement.
2001-07-18 10:04:34 +00:00
sheldonh
e59281e64f Remove an example of bad sentence breaking style. 2001-07-18 08:51:04 +00:00
dd
50bf70a85d Remove whitespace at EOL. 2001-07-15 08:21:37 +00:00
ru
f09768cd33 The semantics of the .Os call has been changed. For CURRENT,
this currently implies the default argument of "FreeBSD 5.0".
2001-04-23 15:15:49 +00:00
ru
fa75077aa7 mdoc.samples(7) is superseded by mdoc(7). 2001-04-17 12:49:42 +00:00
mpp
d86e393136 We don't use the "pseudo-device" configuration option any longer,
so update the example to use the correct definition.

Add an example for documenting kernel compile options, along with
a small example of how to reference them in the main text of the
man page (I.e. the .Dv macro).

Inspired-by:  a brief exchange I saw in in the commit messages mail
2001-04-05 09:37:55 +00:00
ru
c23c39b3a4 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
ru
ea31070695 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00
mpp
417fa30de6 Make share/examples/mdoc and share/misc/mdoc.template internally
consistent, and consistent with mdoc(7) and mdoc.samples(7).

PR:		doc/15352, doc/15353
1999-12-08 22:15:09 +00:00
mpp
367b0a1e65 Add $FreeBSD$ lines to these example man pages, along with a note
that says all man pages should contain a FreeBSD revision control
id to make it easier for translation teams.
1999-08-28 23:32:12 +00:00
charnier
25cfad1aac .Sh AUTHOR -> .Sh AUTHORS. 1998-04-01 06:24:20 +00:00
mpp
36c0c94721 Use the .An macro in the AUTHOR section. 1997-03-20 16:14:21 +00:00
bde
129e9bbfe8 Synced with the C example copyright. Cosmetic except for removing
clause 3, which was removed on 1996/08/03 in the C example.
1997-02-28 10:09:09 +00:00
mpp
440508194b These will appear in 2.2, not 3.0.
Pointed out by: wosch
1997-02-17 16:39:53 +00:00
jmg
06b2e5746c some stylistic changes... "you name here" and "you name" to "your name"
2.2 Candidate
1997-02-14 04:16:19 +00:00
mpp
649560e2de Update the copyright notices to match our bsd-copyright example. 1997-01-09 07:26:05 +00:00
mpp
fe9d880f17 Add some real example diagnostics to example.[14]
Add all of the possible errno's to example.3.

Show examples of the .Bx (BSD) and .At (AT&T UNIX) macros
in the various HISTORY sections.

Add some .Rs/.Re (used for referencing things other
than man pages) in the SEE ALSO sections.

Suggested by: wollman
1997-01-09 06:32:22 +00:00
mpp
6ee379ab9e Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc,
since it seemed like a better place, and the makefiles for
/usr/share/examples didn't need to be fussed with.

The old stuff can be removed from the Attic.
1997-01-02 20:37:25 +00:00