summaryrefslogtreecommitdiffstats
path: root/share/examples/mdoc
Commit message (Collapse)AuthorAgeFilesLines
* Revert my previous change as it does not seem to be entirely correct anddanger2006-09-271-6/+8
| | | | popular.
* - Use existing functions mtx_lock() and mtx_unlock().pjd2006-09-271-8/+9
| | | | | | | | | | | | | | | | | | | - 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.danger2006-09-261-8/+6
| | | | Approved by: trhodes (mentor), keramida (mentor)
* Fix wording to what I intended originally.ru2006-09-181-4/+5
|
* - Avoid using second person.ru2006-09-181-4/+7
| | | | | - 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 appearedbrueffer2006-05-201-1/+1
| | | | | | | 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 howbrueffer2006-04-011-1/+13
| | | | | | to load a kernel module. MFC after: 3 days
* Join two lines.brueffer2005-05-071-2/+1
|
* Added the EXIT STATUS section.ru2005-01-161-2/+3
|
* Move the LOCKING section to before the EXAMPLES section.jkoshy2005-01-151-18/+22
| | | | | | Make example locking calls in the EXAMPLES section. Reviewed by: keramida
* A few more mdoc fixes I missed in the suggestions of Ruslan.keramida2005-01-121-2/+2
|
* Cross-reference the newly added example.9keramida2005-01-123-3/+6
|
* Add a sample manpage for section 9.keramida2005-01-121-0/+338
| | | | | Suggested by: simon Reviewed by: ru
* Forgot to submit a fixed version of this script to Simon.ru2005-01-101-4/+71
|
* Add support files for using text from the POSIX specification insimon2005-01-102-0/+45
| | | | | | | | | | | | 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.simon2004-08-181-1/+12
| | | | | Reviewed by: ru MFC after: 3 days
* Update to the 2004 Edition of POSIX.ru2004-07-301-2/+2
|
* Bumped document date for the recent changes here.ru2004-07-071-13/+14
| | | | | | | 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 :)mpp2004-06-201-6/+6
|
* Sync up ERRORS section with errno.h.mpp2004-06-201-0/+14
|
* mdoc(7): Use the new feature of the .In macro.ru2003-09-081-1/+1
|
* It appears we really shouldn't be following this example man page -- oneobrien2001-08-011-1/+1
| | | | | | | | 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 manpagesru2001-07-183-45/+36
| | | | | | | | | | | | | 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.sheldonh2001-07-183-15/+12
|
* Remove whitespace at EOL.dd2001-07-153-6/+6
|
* The semantics of the .Os call has been changed. For CURRENT,ru2001-04-233-12/+3
| | | | this currently implies the default argument of "FreeBSD 5.0".
* mdoc.samples(7) is superseded by mdoc(7).ru2001-04-173-7/+4
|
* We don't use the "pseudo-device" configuration option any longer,mpp2001-04-051-1/+6
| | | | | | | | | | 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 -isoCru2001-02-262-2/+2
|
* mdoc(7) police: split punctuation characters + misc fixes.ru2001-02-011-1/+2
|
* mdoc(7) police: removed history info from the .Os FreeBSD call.ru2000-12-143-3/+3
|
* mdoc(7) police: Er macro usage cleanup.ru2000-11-221-2/+2
|
* mdoc(7) police: use the new features of the Nm macro.ru2000-11-202-2/+2
|
* Suggest to use .Lb macro in 2nd/3rd section manpages.phantom2000-04-231-0/+3
|
* Make share/examples/mdoc and share/misc/mdoc.template internallympp1999-12-083-44/+56
| | | | | | 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 notempp1999-08-283-3/+12
| | | | | that says all man pages should contain a FreeBSD revision control id to make it easier for translation teams.
* .Sh AUTHOR -> .Sh AUTHORS.charnier1998-04-013-6/+6
|
* Correct typo.jkh1997-10-031-1/+1
| | | | | PR: 4681 Submitted by: Masahiro Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>
* Remove some garbage text.mpp1997-04-021-1/+0
|
* Use the .An macro in the AUTHOR section.mpp1997-03-203-6/+6
|
* Update to use the .Rv macro now that I know it exists :-).mpp1997-03-191-6/+1
|
* Synced with the C example copyright. Cosmetic except for removingbde1997-02-283-18/+12
| | | | clause 3, which was removed on 1996/08/03 in the C example.
* These will appear in 2.2, not 3.0.mpp1997-02-173-6/+6
| | | | Pointed out by: wosch
* some stylistic changes... "you name here" and "you name" to "your name"jmg1997-02-143-6/+6
| | | | 2.2 Candidate
* Update the copyright notices to match our bsd-copyright example.mpp1997-01-093-15/+3
|
* Add some real example diagnostics to example.[14]mpp1997-01-093-14/+269
| | | | | | | | | | | | 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.mpp1997-01-021-1/+1
|
* Moved these from /usr/share/misc/mdoc to /usr/share/examples/mdoc,mpp1997-01-023-0/+335
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.
OpenPOWER on IntegriCloud