History log of /freebsd-10.1-release/share/examples/mdoc/example.4
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
# 272461 02-Oct-2014 gjb

Copy stable/10@r272459 to releng/10.1 as part of
the 10.1-RELEASE process.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation

# 256281 10-Oct-2013 gjb

Copy head (r256279) to stable/10 as part of the 10.0-RELEASE cycle.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation


# 237018 13-Jun-2012 joel

Sync example file with mdoc changes made in rev 235450.


# 162712 27-Sep-2006 danger

Revert my previous change as it does not seem to be entirely correct and
popular.


# 162670 26-Sep-2006 danger

Remove second person from the sentece and rephrase a bit.

Approved by: trhodes (mentor), keramida (mentor)


# 162403 18-Sep-2006 ru

Fix wording to what I intended originally.


# 162396 18-Sep-2006 ru

- Avoid using second person.
- Demonstrate how .Nm can be used without the side effect of causing
a line break in the SYNOPSIS section.


# 158763 20-May-2006 brueffer

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


# 157356 01-Apr-2006 brueffer

Add a standard boilerplate to the SYNOPSIS section that mentions how
to load a kernel module.

MFC after: 3 days


# 145982 07-May-2005 brueffer

Join two lines.


# 140135 12-Jan-2005 keramida

Cross-reference the newly added example.9


# 133944 18-Aug-2004 simon

Add a HARDWARE section to the example section 4 manual page.

Reviewed by: ru
MFC after: 3 days


# 79857 18-Jul-2001 ru

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.


# 79852 18-Jul-2001 sheldonh

Remove an example of bad sentence breaking style.


# 79757 15-Jul-2001 dd

Remove whitespace at EOL.


# 75869 23-Apr-2001 ru

The semantics of the .Os call has been changed. For CURRENT,
this currently implies the default argument of "FreeBSD 5.0".


# 75595 17-Apr-2001 ru

mdoc.samples(7) is superseded by mdoc(7).


# 75228 05-Apr-2001 mpp

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


# 70015 14-Dec-2000 ru

mdoc(7) police: removed history info from the .Os FreeBSD call.


# 68960 20-Nov-2000 ru

mdoc(7) police: use the new features of the Nm macro.


# 54340 08-Dec-1999 mpp

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


# 50535 28-Aug-1999 mpp

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.


# 34984 01-Apr-1998 charnier

.Sh AUTHOR -> .Sh AUTHORS.


# 24066 20-Mar-1997 mpp

Use the .An macro in the AUTHOR section.


# 23199 28-Feb-1997 bde

Synced with the C example copyright. Cosmetic except for removing
clause 3, which was removed on 1996/08/03 in the C example.


# 22853 17-Feb-1997 mpp

These will appear in 2.2, not 3.0.

Pointed out by: wosch


# 22698 14-Feb-1997 jmg

some stylistic changes... "you name here" and "you name" to "your name"

2.2 Candidate


# 21453 09-Jan-1997 mpp

Update the copyright notices to match our bsd-copyright example.


# 21449 09-Jan-1997 mpp

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


# 21235 02-Jan-1997 mpp

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.