Commit Graph

29 Commits

Author SHA1 Message Date
Baptiste Daroussin
bd0891ceb3 use .Mt to mark up email addresses consistently (part1)
PR:		191174
Submitted by:	Franco Fichtner  <franco@lastsummer.de>
2014-06-20 09:40:43 +00:00
Joel Dahl
ea1dbd78a3 Sync example file with mdoc changes made in rev 235450. 2012-06-13 19:08:00 +00:00
Daniel Gerzo
eb2d52f4b8 Revert my previous change as it does not seem to be entirely correct and
popular.
2006-09-27 21:28:44 +00:00
Daniel Gerzo
19ee36f1e5 Remove second person from the sentece and rephrase a bit.
Approved by: trhodes (mentor), keramida (mentor)
2006-09-26 19:59:52 +00:00
Ruslan Ermilov
584eddcad1 Fix wording to what I intended originally. 2006-09-18 15:18:54 +00:00
Ruslan Ermilov
ad9fae588f - 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
Christian Brueffer
8a2f6186a8 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
Christian Brueffer
c541fe558c 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
Christian Brueffer
839ba87af6 Join two lines. 2005-05-07 11:02:34 +00:00
Giorgos Keramidas
4227c68d25 Cross-reference the newly added example.9 2005-01-12 20:56:15 +00:00
Simon L. B. Nielsen
8e244f403d 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
Ruslan Ermilov
d72ca9ddd1 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
Sheldon Hearn
03e563d7dc Remove an example of bad sentence breaking style. 2001-07-18 08:51:04 +00:00
Dima Dorfman
02c4d9cff7 Remove whitespace at EOL. 2001-07-15 08:21:37 +00:00
Ruslan Ermilov
9fdcafcf45 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
Ruslan Ermilov
1837dd5db5 mdoc.samples(7) is superseded by mdoc(7). 2001-04-17 12:49:42 +00:00
Mike Pritchard
0a0869f618 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
Ruslan Ermilov
ed40311694 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
Ruslan Ermilov
7c7fb079b9 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00
Mike Pritchard
ed0bfbe5c7 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
Mike Pritchard
7dc5a4da76 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
Philippe Charnier
facbd4876f .Sh AUTHOR -> .Sh AUTHORS. 1998-04-01 06:24:20 +00:00
Mike Pritchard
d00f4c321d Use the .An macro in the AUTHOR section. 1997-03-20 16:14:21 +00:00
Bruce Evans
374334e411 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
Mike Pritchard
9cb8091ff0 These will appear in 2.2, not 3.0.
Pointed out by: wosch
1997-02-17 16:39:53 +00:00
John-Mark Gurney
4a093a9156 some stylistic changes... "you name here" and "you name" to "your name"
2.2 Candidate
1997-02-14 04:16:19 +00:00
Mike Pritchard
9d2592273f Update the copyright notices to match our bsd-copyright example. 1997-01-09 07:26:05 +00:00
Mike Pritchard
81fba91b52 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
Mike Pritchard
9a78dbdeb7 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