Commit Graph

55 Commits

Author SHA1 Message Date
Mateusz Piotrowski
63fb0d3bc3 Remove misleading macros from -width arguments
Also, remove $FreeBSD$ tag from manual page examples.

MFC after:	1 week
2020-12-28 16:30:55 +01:00
Mateusz Piotrowski
1fb04df956 Remove macros from the width arguments passed to Bl macros
I've not removed the Er macro from one of the lists in example.9, however,
because it seems to be doing some special kind of magic. Let's leave it
there for now.
2020-11-12 17:28:29 +00:00
Mateusz Piotrowski
fff9b47462 Add SPDX tags to example manual pages and POSIX copyright.
Reviewed by:	eadler
Approved by:	mat (mentor)
Differential Revision:	https://reviews.freebsd.org/D14958
2018-07-20 13:45:09 +00:00
Warner Losh
226a9d167b Remove 'All Rights Reserved' from the collection copyright and templates.
The original Berkeley Software Distributions were made in the 1980's
and 1990's. At that time, the Buenos Ares Convention of 1910 was in
force in most of the countries in the Americas. It required an
affirmative statement of rights reservation, typically using 'All
Rights Reserved.' The Regents included this phrase in their copyright
notices to invoke this treaty to ensure maximal copyright protection.

In the 1990's, Latin America coutries ratifeid the Berne Convention on
copyrights which prohibited them from requiring an affirmative
statement to reserve the rights. When Nicaragua ratified in 2000, the
Buenos Ares Convention of 1910 was effectively repealed. This made all
the 'All Rights Reserved' phrases obsolete and legal deadweight most
of the time, and certainly in the cases removed here.

Since it's no longer required, and is in fact meaningless, core has
decided to dropped it from the project's collection copyright and
sample templates. It encourages other rights holders to do the same
after consultation with their legal department.

More see https://en.wikipedia.org/wiki/Buenos_Aires_Convention for
more information.

Approved by: core@ (emaste@, jhb@)
Differential Review:  https://reviews.freebsd.org/D15264
2018-05-09 02:02:49 +00:00
Christian Brueffer
2aea45f0d5 Join excessive split lines.
MFC after:	1 week
2015-09-30 12:40:51 +00:00
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
Pawel Jakub Dawidek
e5cccaf001 - 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
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
Ruslan Ermilov
06d7435baf Added the EXIT STATUS section. 2005-01-16 22:22:28 +00:00
Joseph Koshy
bff0341efe 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
Giorgos Keramidas
c16a777f08 A few more mdoc fixes I missed in the suggestions of Ruslan. 2005-01-12 21:43:09 +00:00
Giorgos Keramidas
4227c68d25 Cross-reference the newly added example.9 2005-01-12 20:56:15 +00:00
Giorgos Keramidas
496ff35d1e Add a sample manpage for section 9.
Suggested by:	simon
Reviewed by:	ru
2005-01-12 20:49:25 +00:00
Ruslan Ermilov
41d22c015d Forgot to submit a fixed version of this script to Simon. 2005-01-10 18:54:55 +00:00
Simon L. B. Nielsen
f1192bffc1 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 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
24c875f96b Update to the 2004 Edition of POSIX. 2004-07-30 08:31:29 +00:00
Ruslan Ermilov
c0cfe3da7d 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
Mike Pritchard
0491095662 Grr. Fixup markup on my last commit. Sorry, I'm a little out of practice :) 2004-06-20 12:51:23 +00:00
Mike Pritchard
8caf8b1799 Sync up ERRORS section with errno.h. 2004-06-20 12:44:42 +00:00
Ruslan Ermilov
fe08efe680 mdoc(7): Use the new feature of the .In macro. 2003-09-08 19:57:22 +00:00
David E. O'Brien
81c6395691 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
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
588a200ce1 .St -ansiC -> .St -isoC 2001-02-26 13:23:47 +00:00
Ruslan Ermilov
d0353b836e mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +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
b92a189eb9 mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:11:48 +00:00
Ruslan Ermilov
7c7fb079b9 mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00
Alexey Zelkin
0d2332f2d1 Suggest to use .Lb macro in 2nd/3rd section manpages. 2000-04-23 14:47:26 +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
Jordan K. Hubbard
e6b43fd1a1 Correct typo.
PR:		4681
Submitted by:	Masahiro Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>
1997-10-03 03:34:00 +00:00
Mike Pritchard
94d6fcba9b Remove some garbage text. 1997-04-02 00:09:14 +00:00
Mike Pritchard
d00f4c321d Use the .An macro in the AUTHOR section. 1997-03-20 16:14:21 +00:00
Mike Pritchard
a238c207df Update to use the .Rv macro now that I know it exists :-). 1997-03-19 21:08:48 +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