summaryrefslogtreecommitdiffstats
path: root/mdoc.7
Commit message (Collapse)AuthorAgeFilesLines
* Tedu support for the -xsh4.2 argument to the mdoc(7) .St macroIngo Schwarze2022-01-131-5/+2
| | | | | | | | | | | because all of the following hold: * It is an alias for a part of an ancient standard that is no longer important. * To refer to that old standard, -xpg4.2 is readily available and portable. * It is unused in OpenBSD, FreeBSD, and NetBSD. * Groff never supported it. I agreed with G. Branden Robinson that deleting this from mandoc is preferable to adding it to groff.
* merge OpenBSD commit by jmc@:Ingo Schwarze2021-12-061-1/+1
| | | | sytle -> style; adapted from changes by SAITOH masanobu (NetBSD)
* manually tag the macro names that have false positivesIngo Schwarze2021-07-291-0/+71
|
* Improve the description of .Fl in multiple respects and in paricularIngo Schwarze2021-07-291-11/+17
| | | | | | | improve the .Fl examples in multiple respects, including better demonstrating long options. Prompted by a question from espie@. Feedback and OK jmc@.
* s/The arguments are as follows:/The options are as follows:/Ingo Schwarze2021-07-041-1/+1
| | | | | because that's what the example is talking about; patch from kn@
* remove stray byte from broken escape sequence; diff from jmc@Ingo Schwarze2021-05-121-1/+1
|
* typo; diff from fcambus@Ingo Schwarze2021-05-121-1/+1
|
* Briefly mention groff_mdoc(7) below SEE ALSO. While both authoritativeIngo Schwarze2020-06-251-3/+9
| | | | | | | manual pages document the same content, comparing can occasionally help in cases of doubt, and some people may prefer one style, some the other. While here, modernize a few .Lks from http:// to https://. OK jmc@
* Mention that the .Dd "date" argument is the date of the last change.Ingo Schwarze2020-02-131-15/+2
| | | | | | Triggered by a question from Jason A. Donenfeld. While here, delete three COMPATIBILITY entries that i fixed some time ago.
* Introduce a new mdoc(7) macro .Tg ("tag") to explicitly mark a placeIngo Schwarze2020-01-191-1/+46
| | | | | | | | | | | | | | | as defining a term. Please only use it when automatic tagging does not work. Manual page authors will not be required to add the new macro; using it remains optional. HTML output is still rudimentary in this version and will be polished later. Thanks to kn@ for reminding me that i have been considering since BSDCan 2014 whether something like this might be useful. Given that possibilities of making automatic tagging better are running out and there are still several situations where automatic tagging cannot do the job, i think the time is now ripe. Feedback and no objection from millert@; OK espie@ inoguchi@ kn@.
* explain escaping of end-of-sentence characters;Ingo Schwarze2019-07-151-0/+7
| | | | missing info reported by Ian <ropers at gmail dot com> on misc@
* clarify the difference between .Cm and .Ic;Ingo Schwarze2019-04-241-8/+10
| | | | triggered by a question from Fabio Scotoni
* clarify how .%P is conventionally used;Ingo Schwarze2019-04-231-1/+8
| | | | triggered by a question from Fabio Scotoni <fabio at esse dot ch>
* style improvement from jmc@, no output change;Ingo Schwarze2019-02-071-4/+2
| | | | | | | | | | original commit message: .Pp .Bd ... -compact is better written as .Bd ...
* Remove the misleading statement ".No takes no arguments".Ingo Schwarze2019-02-061-2/+2
| | | | | In facts, i works very similarly to .Em and .Sy. Triggered by a question from Kurt Mosiejczuk <kurt at cranky dot work>.
* Finally, stop abusing .Ss and .Sx to mark up macros, use .Ic insteadIngo Schwarze2018-12-231-795/+682
| | | | | | since these are clearly commands in a domain-specific language. As a nice side effect, the resulting list allows including the synopsis for each macro in the item head, reducing some repetitive verbiage.
* Simplify and clarify instructions for .Ql, and deprecate .Li.Ingo Schwarze2018-12-231-34/+20
| | | | | | The macros .Ql, .Dl, and .Bd -literal leave no room for any valid use case for .Li whatsoever. General direction discussed with jmc@.
* Deprecate .Lp, use .Pp instead.Ingo Schwarze2018-12-231-2/+2
| | | | | Simplicity matters, and fewer macros is simpler. OK jmc@
* Issue a STYLE message when normalizing the date format in .Dd/.TH.Ingo Schwarze2018-07-281-4/+4
| | | | | | | | Leah Neukirchen pointed out that mdoclint(1) used to warn about a leading zero before the day number, so we know that both NetBSD and Void Linux want the message. It does no harm on OpenBSD because Mdocdate always does the right thing anyway. jmc@ agrees that it makes sense in contexts not using Mdocdate.
* Modernize documentation of .Ao and .Aq.Ingo Schwarze2017-10-231-15/+39
| | | | | | | | | | | | I looked through our whole tree and failed to find a single use that is really convincing, except those with .Mt. Putting it around character and key names is somewhat widespread and maybe acceptable, even if hardly useful. So for now, delete the bogus examples and explain what these macros are really used for. Discourage the most common abuses. Triggered by a question from Raf Czlonka <rczlonka at gmail dot com>.
* more renaming from mdocml to mandocIngo Schwarze2017-07-201-1/+1
|
* nits about trailing punctuation found with mandoc -TlintIngo Schwarze2017-07-051-3/+3
|
* Clarify that .Ta as a line macro is a portability problem,Ingo Schwarze2017-06-291-3/+3
| | | | | even though mandoc(1) handles it; triggered by a question from Yuri Pankov (illumos).
* Delete .St -p1003.1-2013.Ingo Schwarze2017-06-241-5/+0
| | | | | | | It is an OpenBSD addition that did not get used a single time in three years, and groff did not pick it up either, so removing it does not affect any existing manuals anywhere. Cleanup suggested by jmc@, OK bentley@.
* minor markup simplificationsIngo Schwarze2017-06-101-1/+1
|
* Shorten the description of .sp and move it to roff(7).Ingo Schwarze2017-05-051-17/+0
| | | | | If is not a macro but a low-level roff request and not recommended for use in manual pages.
* Clean up docs after today's .br and .ft code cleanup; simpler.Ingo Schwarze2017-05-051-10/+0
|
* Surprisingly, groff does not support scaling units in .Bl -columnIngo Schwarze2017-02-161-4/+2
| | | | | | column width specifiers, so stop supporting them, too. As a side effect, this fixes an assertion failure that tb@ found with afl(1), triggered by: .Bl -column -4n
* document output spacing near delimitersIngo Schwarze2017-02-051-1/+3
|
* Clarify how tabs after .It workIngo Schwarze2017-01-091-6/+18
| | | | | | | because this is a really nasty trap for the unwary. Triggered by a question from Abhinav Upadhyay <er dot abhinav dot upadhyay at gmail dot com> (NetBSD) on discuss@.
* Make the second, section number argument of .Xr mandatory.Ingo Schwarze2016-12-281-4/+3
| | | | | | In fact, we have been requiring it for many years. The only reason to not warn when it was missing was excessive traditionalism - it was optional in 4.4BSD.
* link to http://mdocml.bsd.lv/mdoc/ below SEE ALSO;Ingo Schwarze2016-10-111-0/+6
| | | | tweak and OK jmc@
* specify option ordering in the DESCRIPTION section;Ingo Schwarze2015-11-051-0/+5
| | | | from guenther@, ok and tweaks jmc@
* Mention that the first argument of .Pf does not need escaping.Ingo Schwarze2015-10-111-4/+8
| | | | | While here, make the first sentence regarding .Pf more concise. OK jmc@
* typos; found and fixed by sobrado@Ingo Schwarze2015-09-241-1/+1
|
* Avoid .Ns right after .Pf, it's pointless.Ingo Schwarze2015-09-141-1/+1
|
* Remove the first comma from constructs like ", and," and ", or,":Ingo Schwarze2015-03-131-1/+1
| | | | | | You can use "and" and "or" to join sentence clauses, and you can use commas, but both hinders reading; patch from jmc@.
* improve NAME section diagnostics;Ingo Schwarze2015-02-231-5/+3
| | | | confusing messages reported by Jan Stary <hans at stare dot cz>
* Tweak the wording to avoid the possible misunderstanding that .InIngo Schwarze2015-02-151-5/+6
| | | | | could only be used in the SYNOPSIS section. It is fine anywhere. Issue noticed by bentley@.
* Radical cleanup of COMPATIBILITY sections:Ingo Schwarze2015-01-291-100/+17
| | | | | | | | Remove lots of lies, dozens of irrelevant implementation details, and all references to groff versions older than 1.17. Move relevant information to the pages where it belongs, and out of mandoc(1) in particular. Add some missing general remarks to roff(7), where it fits the character and purpose of the page much better.
* change spelling of centre to center: consistent with other man pagesIngo Schwarze2015-01-201-3/+3
| | | | and the name of the syntax elements being described; from tedu@
* Given the excessively technical description in the old mdoc_samples(7)Ingo Schwarze2015-01-031-6/+15
| | | | | | | | | | manual and its successor groff_mdoc(7), i always considered .Ql as purely physical markup, but it turns out describing it better allows to give it a semantic meaning (in-line literal display) that doesn't contradict existing usage. One less physical, one more semantic macro, yay! Found in a discussion with Steffen Nurpmeso <sdaoden at yandex dot com>.
* describe .Ql more precisely;Ingo Schwarze2014-12-311-2/+5
| | | | defect pointed out by Steffen Nurpmeso <sdaoden at yandex dot com>
* Improve documentation of the header/footer macros .Dt, .Os, .TH:Ingo Schwarze2014-12-281-25/+21
| | | | | | * State the defaults for .Os and the fourth .TH argument. * Sync the section titles, and stop advertising obscure sections that aren't actually fully supported and certainly not recommended for use.
* delete three standard abbreviations that areIngo Schwarze2014-11-301-12/+2
| | | | | | * no longer used in OpenBSD * not used in any of NetBSD, FreeBSD, or DragonFly * not supported by groff
* Retire support for CSRG supplementary document titles. These areIngo Schwarze2014-11-281-32/+2
| | | | | long obsolete and were never written in mdoc(7) in the first place. Removes 100 lines from source files.
* Drop useless architecture table. Validating architecture namesIngo Schwarze2014-11-281-6/+1
| | | | | | is a job for makewhatis(8)/mandoc.db(5), not for the parser. Removes 150 lines from source files and 4k (1%) from the binary. Bloat found by deraadt@.
* Fix the obsolete .Db (toggle debug mode) macro to ignore its argumentsIngo Schwarze2014-11-271-7/+6
| | | | | and not trigger an assertion when there is more than one argument; the latter found by jsg@ with afl.
* Delete five standards that are:Ingo Schwarze2014-11-161-19/+0
| | | | | | | | | * not supported by groff * not used in any OpenBSD, NetBSD, DragonFly or FreeBSD base manual * superseded or retracted * and more than ten years old Triggered by a question from Carsten Kunze (Heirloom troff). OK guenther@ jmc@
* Major bugsquashing with respect to -offset and -width:Ingo Schwarze2014-10-301-2/+5
| | | | | | | | | 1. Support specifying the .Bd and .Bl -offset as a macro default width; while here, simplify the code handling the same for .Bl -width. 2. Correct handling of .Bl -offset arguments: unlike .Bd -offset, the arguments "left", "indent", and "indent-two" have no special meaning. 3. Fix the scaling of string length -offset and -width arguments in -Thtml. Triggered by an incomplete documentation patch from bentley@.
generated by cgit (git 2.34.1) at 2024-11-16 02:21:12 +0000