summaryrefslogtreecommitdiffstats
path: root/mdoc.7
Commit message (Collapse)AuthorAgeFilesLines
* 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@.
* improve documentation of .Fa, .Va, and .Vt;Ingo Schwarze2014-10-201-8/+20
| | | | inspired by a discussion with matthew@
* Clarify: SEE ALSO sections are sorted case insensitively.Ingo Schwarze2014-10-131-1/+1
| | | | Patch from bentley@, ok jmc@.
* Five year old typo reported by Theo Buehler at math dot ethz dot ch, thanks.Ingo Schwarze2014-09-171-1/+1
| | | | | I nearly asked: ``What's wrong with it? It formats as "intended".'' (However, what Kristaps intended to write was "indented".)
* Support .St -susv1 and .St -susv4. Illumos wants to use this,Ingo Schwarze2014-08-281-2/+6
| | | | and it's illogical anyway to have -susv2 and -susv3 but not -susv4.
* Clarify that .Em and .Sy are physical, not semantic markup,Ingo Schwarze2014-08-141-12/+39
| | | | | explain appropriate usage, and provide some examples. ok jmc@
* When .Sm is called without an argument, groff toggles the spacing mode,Ingo Schwarze2014-08-081-3/+8
| | | | | so let us do the same for compatibility. Using this feature is of course not recommended except in manual page obfuscation contests.
* some corrections and improvements with respect to prologue macros;Ingo Schwarze2014-08-081-18/+16
| | | | found while working on mandoc(1) messages
* Unconfuse .Fa documentation:Ingo Schwarze2014-07-131-7/+19
| | | | | | | You can use .Fa with just a type, without a name, but when you give both, which is the usual case, they need to go into one single .Fa argument. Observed by bentley@; ok jmc@ bentley@.
* Implement the obsolete macros .En .Es .Fr .Ot for backward compatibility,Ingo Schwarze2014-07-021-16/+29
| | | | | since this is hardly more complicated than explicitly ignoring them as we did in the past. Of course, do not use them!
* Deprecate .Tn and .Ux, and make it clearer that .Bt and .Ud are deprecated.Ingo Schwarze2014-06-241-46/+22
| | | | | | | | | Do not use these macros in new documents, they provide no value. Instead, usually no macro and no markup is needed at all. Of course, they remain supported for compatibility with existing manuals. Jason McIntyre (OpenBSD), Thomas Klausner (NetBSD) and Franco Fichtner (DragonFly) are OK with this documentation change.
* Minimal COMPATIBILITY cleanup:Ingo Schwarze2014-06-221-34/+5
| | | | | | | | * Mention that the list is incomplete. * I implemented %C for groff -current, and it was accepted. * Font family is \F, not \f. * Escapes and scaling widths are documented in roff(7), not here. * Quoting quotes by doubling them is now supported.
* Support the CONTEXT section for kernel manual pages found in Solaris andIngo Schwarze2014-03-311-0/+5
| | | | | OpenBSD manuals. It describes which contexts you can call functions in. from dlg@, ok jmc@ deraadt@
* After Werner Lemberg accepted and committed some updates to the manualIngo Schwarze2014-02-161-9/+15
| | | | | | page template contained in groff_mdoc(7), catch up with our own stuff. In particular, allow ERRORS in section 4 and DIAGNOSTICS in section 9. ok jmc@
* Supplement the documentation of the .St macro by minimal commentaryIngo Schwarze2014-01-241-73/+201
| | | | | | regarding the content and relationships of the various standards, and sort and group them. tweaks and ok guenther@, ok millert@ sobrado@ jmc@
* Change markup of some fixed strings from .Ar to .Cm.Ingo Schwarze2014-01-201-31/+31
|
* Support .St -p1003.1-2013, "IEEE Std 1003.1-2008/Cor 1-2013".Ingo Schwarze2013-12-311-0/+2
| | | | | | | | | | | | | | Note that the POSIX-2008 standard remains in force, so please refrain from wholesale 2008 -> 2013 replacements. Make sure to only use the new -p1003.1-2013 argument for cases where "IEEE Std 1003.1(TM)-2008/ Cor 1-2013, IEEE Standard for Information Technology--Portable Operating System Interface (POSIX(R)), Technical Corrigendum 1" actually changes something in the standard with respect to the specific function documented in the manual you touch. Otherwise, please continue using .St -p1003.1-2008. Triggered by a similar, but slightly incorrect patch from jmc@; ok guenther@.
* Support .St -xsh4.2, the System Interfaces part of the original SingleIngo Schwarze2013-12-251-1/+3
| | | | | | | | UNIX Specification. As this one appears to be used in the wild and we already have -xpg4.2 and even -xsh5, it makes sense to add this one. Note that calling the original SUS XPG4.2 appears to be more common than calling it SUSv1, so it's ok that we don't have .St -susv1. From Sascha Wildner <saw at online dot de> (DragonFly) via Franco Fichtner.
* While answering a question asked by espie@, i noticed that .Fd is notIngo Schwarze2013-11-021-7/+28
| | | | | completely obsolete, but still somewhat useful for listing preprocessor directives, in particular in the SYNOPSIS.
* The .Lb arguments wants a "lib" prefix;Ingo Schwarze2013-10-061-1/+1
| | | | | from Sascha Wildner via Franco Fichtner (DragonFly); also fixing the same in the mdoc(7) example while i'm about it.
generated by cgit (git 2.34.1) at 2024-11-05 15:21:05 +0000