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

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

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

Sync example file with mdoc changes made in rev 235450.

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

- Use existing functions mtx_lock() and mtx_unlock().
- Change variable name to 'error', as this is what is mostly used for
functions that return an error.
- Add mutex(9) to the SEE ALSO section.
- Bump the date.

I don't really like the example code. I'd prefer symmetry where possible, eg.

mtx_lock(&example_lock);
error = example(NULL, EXAMPLE_ONE);
mtx_unlock(&example_lock);
if (error != 0)
return (error);

But I'll leave it as it is for now.

Reviewed by: simon

Remove second person from the sentece and rephrase a bit.

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

Fix wording to what I intended originally.

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

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

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

MFC after: 3 days

Join two lines.

Added the EXIT STATUS section.

Move the LOCKING section to before the EXAMPLES section.
Make example locking calls in the EXAMPLES section.

Reviewed by: keramida

A few more mdoc fixes I missed in the suggestions of Ruslan.

Cross-reference the newly added example.9

Add a sample manpage for section 9.

Suggested by: simon
Reviewed by: ru

Forgot to submit a fixed version of this script to Simon.

Add support files for using text from the POSIX specification in
FreeBSD manual pages:

- POSIX-copyright contains copyright text to be used in manual pages
which has POSIX text inserted.
- deshallify.sh is a shell script which removes many of the ``shall''
statements from the POSIX text and therefore making the text more
readable.

Real work to make this happen by: nectar, ru

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

Reviewed by: ru
MFC after: 3 days

Update to the 2004 Edition of POSIX.

Bumped document date for the recent changes here.
Fixed bad example of how to start a new sentence.
Added missing punctuation.
Fixed cut-n-paste error in the STANDARDS section.
Mention modern POSIX and C standards.

Grr. Fixup markup on my last commit. Sorry, I'm a little out of practice :)

Sync up ERRORS section with errno.h.

mdoc(7): Use the new feature of the .In macro.

It appears we really shouldn't be following this example man page -- one
should not use a `%' in examples.

I don't know if this is the consensus of doc@, or just a unilateral decision
of committer that corrected my following of this example. Maybe a docs
person could review these files and see if they still show current guidelines.

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.

Remove an example of bad sentence breaking style.

Remove whitespace at EOL.

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

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

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

.St -ansiC -> .St -isoC

mdoc(7) police: split punctuation characters + misc fixes.

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

mdoc(7) police: Er macro usage cleanup.

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

Suggest to use .Lb macro in 2nd/3rd section manpages.

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

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.

.Sh AUTHOR -> .Sh AUTHORS.

Correct typo.
PR: 4681
Submitted by: Masahiro Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>

Remove some garbage text.

Use the .An macro in the AUTHOR section.

Update to use the .Rv macro now that I know it exists :-).

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

These will appear in 2.2, not 3.0.

Pointed out by: wosch

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

2.2 Candidate

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

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

Correct one minor style point.

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.