Commit Graph

50 Commits

Author SHA1 Message Date
bapt
42044eb342 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
5878934020 Sync example file with mdoc changes made in rev 235450. 2012-06-13 19:08:00 +00:00
danger
1584e18eed Revert my previous change as it does not seem to be entirely correct and
popular.
2006-09-27 21:28:44 +00:00
pjd
e2d5d5e15d - 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
2006-09-27 08:39:00 +00:00
danger
990490fa5f Remove second person from the sentece and rephrase a bit.
Approved by: trhodes (mentor), keramida (mentor)
2006-09-26 19:59:52 +00:00
ru
90595a0fc9 Fix wording to what I intended originally. 2006-09-18 15:18:54 +00:00
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
ru
f4ba20999d Added the EXIT STATUS section. 2005-01-16 22:22:28 +00:00
jkoshy
e2a9113a2b Move the LOCKING section to before the EXAMPLES section.
Make example locking calls in the EXAMPLES section.

Reviewed by:	keramida
2005-01-15 16:01:19 +00:00
keramida
4b344b0b27 A few more mdoc fixes I missed in the suggestions of Ruslan. 2005-01-12 21:43:09 +00:00
keramida
a80074d407 Cross-reference the newly added example.9 2005-01-12 20:56:15 +00:00
keramida
aebf880d1a Add a sample manpage for section 9.
Suggested by:	simon
Reviewed by:	ru
2005-01-12 20:49:25 +00:00
ru
cae75ee299 Forgot to submit a fixed version of this script to Simon. 2005-01-10 18:54:55 +00:00
simon
7dc1b0c123 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
2005-01-10 18:09:17 +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
f6f4f5a17b Update to the 2004 Edition of POSIX. 2004-07-30 08:31:29 +00:00
ru
e318fd8a91 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.
2004-07-07 18:59:33 +00:00
mpp
320404766f Grr. Fixup markup on my last commit. Sorry, I'm a little out of practice :) 2004-06-20 12:51:23 +00:00
mpp
7b08e91e2d Sync up ERRORS section with errno.h. 2004-06-20 12:44:42 +00:00
ru
1c23ef339b mdoc(7): Use the new feature of the .In macro. 2003-09-08 19:57:22 +00:00
obrien
e3e1b0bdbc 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.
2001-08-01 04:27:48 +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
3ff23f918d .St -ansiC -> .St -isoC 2001-02-26 13:23:47 +00:00
ru
8a6f8b5fe4 mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00
ru
c23c39b3a4 mdoc(7) police: removed history info from the .Os FreeBSD call. 2000-12-14 11:52:05 +00:00
ru
e75ab20d6b mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:11:48 +00:00
ru
ea31070695 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00
phantom
cc05420259 Suggest to use .Lb macro in 2nd/3rd section manpages. 2000-04-23 14:47:26 +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
jkh
c2a5ed6b42 Correct typo.
PR:		4681
Submitted by:	Masahiro Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>
1997-10-03 03:34:00 +00:00
mpp
74212b970b Remove some garbage text. 1997-04-02 00:09:14 +00:00
mpp
36c0c94721 Use the .An macro in the AUTHOR section. 1997-03-20 16:14:21 +00:00
mpp
c945093abc Update to use the .Rv macro now that I know it exists :-). 1997-03-19 21:08:48 +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
ae3a5816ec Correct one minor style point. 1997-01-02 21:10:30 +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