aboutsummaryrefslogtreecommitdiff
path: root/share/examples/mdoc
Commit message (Collapse)AuthorAgeFilesLines
* example.3: Show updated library macro usageAlexander Ziaee2025-12-171-3/+2
| | | | | | | The LIBRARY section has been deprecated by upstream. Show the updated usage of the Lb macro in SYNOPSIS. Fixes: 4c07abdbacf49 (mandoc: Vendor import of upstream at 2025-06-13)
* examples/mdoc: Remove document description quotesAlexander Ziaee2025-12-174-4/+4
| | | | | | | Quotes in roff do not work the way quotes in shell do, remove them from the examples to hopefully lead less people astray. MFC after: 3 days
* example.4: Bump deprecation example to FreeBSD 17Ed Maste2025-11-171-1/+1
| | | | | | | The deprecation notice should indicate that the driver or feature will be removed in a future release, not one that's nearly EOL. Sponsored by: The FreeBSD Foundation
* Document the DEPRECATION NOTICE section for kernel interfacesDavid E. O'Brien2025-10-291-0/+3
|
* examples/mdoc: Remove text of BSD-2-Clause from mdoc examplesMateusz Piotrowski2025-10-244-88/+4
| | | | | | | | | | | We live in the SPDX world now and our example manual pages should reflect that. Also, fix the order of the SPDX and copyright lines as per style(9). Reviewed by: ziaee MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D53335
* Remove $FreeBSD$: two-line nroff patternWarner Losh2023-08-161-2/+0
| | | | Remove /^\.\\"\n\.\\"\s*\$FreeBSD\$$\n/
* Remove $FreeBSD$: one-line sh patternWarner Losh2023-08-161-1/+0
| | | | Remove /^\s*#[#!]?\s*\$FreeBSD\$.*$\n/
* spdx: The BSD-2-Clause-FreeBSD identifier is obsolete, drop -FreeBSDWarner Losh2023-05-125-5/+5
| | | | | | | | | The SPDX folks have obsoleted the BSD-2-Clause-FreeBSD identifier. Catch up to that fact and revert to their recommended match of BSD-2-Clause. Discussed with: pfg MFC After: 3 days Sponsored by: Netflix
* Remove misleading macros from -width argumentsMateusz Piotrowski2020-12-284-10/+2
| | | | | | Also, remove $FreeBSD$ tag from manual page examples. MFC after: 1 week
* Remove macros from the width arguments passed to Bl macrosMateusz Piotrowski2020-11-124-6/+6
| | | | | | | | | 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. Notes: svn path=/head/; revision=367621
* Add SPDX tags to example manual pages and POSIX copyright.Mateusz Piotrowski2018-07-205-0/+15
| | | | | | | | | Reviewed by: eadler Approved by: mat (mentor) Differential Revision: https://reviews.freebsd.org/D14958 Notes: svn path=/head/; revision=336546
* Remove 'All Rights Reserved' from the collection copyright and templates.Warner Losh2018-05-095-5/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 Notes: svn path=/head/; revision=333391
* Join excessive split lines.Christian Brueffer2015-09-301-5/+3
| | | | | | | MFC after: 1 week Notes: svn path=/head/; revision=288419
* use .Mt to mark up email addresses consistently (part1)Baptiste Daroussin2014-06-204-4/+4
| | | | | | | | PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> Notes: svn path=/head/; revision=267667
* Sync example file with mdoc changes made in rev 235450.Joel Dahl2012-06-131-2/+0
| | | | Notes: svn path=/head/; revision=237018
* Revert my previous change as it does not seem to be entirely correct andDaniel Gerzo2006-09-271-6/+8
| | | | | | | popular. Notes: svn path=/head/; revision=162712
* - Use existing functions mtx_lock() and mtx_unlock().Pawel Jakub Dawidek2006-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 Notes: svn path=/head/; revision=162692
* Remove second person from the sentece and rephrase a bit.Daniel Gerzo2006-09-261-8/+6
| | | | | | | Approved by: trhodes (mentor), keramida (mentor) Notes: svn path=/head/; revision=162670
* Fix wording to what I intended originally.Ruslan Ermilov2006-09-181-4/+5
| | | | Notes: svn path=/head/; revision=162403
* - Avoid using second person.Ruslan Ermilov2006-09-181-4/+7
| | | | | | | | - Demonstrate how .Nm can be used without the side effect of causing a line break in the SYNOPSIS section. Notes: svn path=/head/; revision=162396
* Make this example more real world usable: When the manpage first appearedChristian Brueffer2006-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 Notes: svn path=/head/; revision=158763
* Add a standard boilerplate to the SYNOPSIS section that mentions howChristian Brueffer2006-04-011-1/+13
| | | | | | | | | to load a kernel module. MFC after: 3 days Notes: svn path=/head/; revision=157356
* Join two lines.Christian Brueffer2005-05-071-2/+1
| | | | Notes: svn path=/head/; revision=145982
* Added the EXIT STATUS section.Ruslan Ermilov2005-01-161-2/+3
| | | | Notes: svn path=/head/; revision=140363
* Move the LOCKING section to before the EXAMPLES section.Joseph Koshy2005-01-151-18/+22
| | | | | | | | | Make example locking calls in the EXAMPLES section. Reviewed by: keramida Notes: svn path=/head/; revision=140302
* A few more mdoc fixes I missed in the suggestions of Ruslan.Giorgos Keramidas2005-01-121-2/+2
| | | | Notes: svn path=/head/; revision=140139
* Cross-reference the newly added example.9Giorgos Keramidas2005-01-123-3/+6
| | | | Notes: svn path=/head/; revision=140135
* Add a sample manpage for section 9.Giorgos Keramidas2005-01-121-0/+338
| | | | | | | | Suggested by: simon Reviewed by: ru Notes: svn path=/head/; revision=140133
* Forgot to submit a fixed version of this script to Simon.Ruslan Ermilov2005-01-101-4/+71
| | | | Notes: svn path=/head/; revision=139992
* Add support files for using text from the POSIX specification inSimon L. B. Nielsen2005-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 Notes: svn path=/head/; revision=139989
* Add a HARDWARE section to the example section 4 manual page.Simon L. B. Nielsen2004-08-181-1/+12
| | | | | | | | Reviewed by: ru MFC after: 3 days Notes: svn path=/head/; revision=133944
* Update to the 2004 Edition of POSIX.Ruslan Ermilov2004-07-301-2/+2
| | | | Notes: svn path=/head/; revision=132878
* Bumped document date for the recent changes here.Ruslan Ermilov2004-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. Notes: svn path=/head/; revision=131751
* Grr. Fixup markup on my last commit. Sorry, I'm a little out of practice :)Mike Pritchard2004-06-201-6/+6
| | | | Notes: svn path=/head/; revision=130784
* Sync up ERRORS section with errno.h.Mike Pritchard2004-06-201-0/+14
| | | | Notes: svn path=/head/; revision=130783
* mdoc(7): Use the new feature of the .In macro.Ruslan Ermilov2003-09-081-1/+1
| | | | Notes: svn path=/head/; revision=119893
* It appears we really shouldn't be following this example man page -- oneDavid E. O'Brien2001-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. Notes: svn path=/head/; revision=80807
* Removed the comment that required all FreeBSD manpagesRuslan Ermilov2001-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. Notes: svn path=/head/; revision=79857
* Remove an example of bad sentence breaking style.Sheldon Hearn2001-07-183-15/+12
| | | | Notes: svn path=/head/; revision=79852
* Remove whitespace at EOL.Dima Dorfman2001-07-153-6/+6
| | | | Notes: svn path=/head/; revision=79757
* The semantics of the .Os call has been changed. For CURRENT,Ruslan Ermilov2001-04-233-12/+3
| | | | | | | this currently implies the default argument of "FreeBSD 5.0". Notes: svn path=/head/; revision=75869
* mdoc.samples(7) is superseded by mdoc(7).Ruslan Ermilov2001-04-173-7/+4
| | | | Notes: svn path=/head/; revision=75595
* We don't use the "pseudo-device" configuration option any longer,Mike Pritchard2001-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 Notes: svn path=/head/; revision=75228
* .St -ansiC -> .St -isoCRuslan Ermilov2001-02-262-2/+2
| | | | Notes: svn path=/head/; revision=73088
* mdoc(7) police: split punctuation characters + misc fixes.Ruslan Ermilov2001-02-011-1/+2
| | | | Notes: svn path=/head/; revision=71895
* mdoc(7) police: removed history info from the .Os FreeBSD call.Ruslan Ermilov2000-12-143-3/+3
| | | | Notes: svn path=/head/; revision=70015
* mdoc(7) police: Er macro usage cleanup.Ruslan Ermilov2000-11-221-2/+2
| | | | Notes: svn path=/head/; revision=69052
* mdoc(7) police: use the new features of the Nm macro.Ruslan Ermilov2000-11-202-2/+2
| | | | Notes: svn path=/head/; revision=68960
* Suggest to use .Lb macro in 2nd/3rd section manpages.Alexey Zelkin2000-04-231-0/+3
| | | | Notes: svn path=/head/; revision=59541
* Make share/examples/mdoc and share/misc/mdoc.template internallyMike Pritchard1999-12-083-44/+56
| | | | | | | | | consistent, and consistent with mdoc(7) and mdoc.samples(7). PR: doc/15352, doc/15353 Notes: svn path=/head/; revision=54340
generated by cgit v1.3 (git 2.53.0) at 2026-09-12 18:59:41 +0000