summaryrefslogtreecommitdiff
path: root/share/man/man7/mdoc.7
AgeCommit message (Collapse)Author
2015-03-13remove the first comma from constructs like ", and," and ", or,": you can useJason McIntyre
"and" and "or" to join sentence clauses, and you can use commas, but both hinders reading;
2015-02-23improve NAME section diagnostics;Ingo Schwarze
confusing messages reported by Jan Stary <hans at stare dot cz>
2015-02-15Tweak the wording to avoid the possible misunderstanding that .InIngo Schwarze
could only be used in the SYNOPSIS section. It is fine anywhere. Issue noticed by bentley@.
2015-01-29Radical cleanup of COMPATIBILITY sections:Ingo Schwarze
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.
2015-01-20change spelling of centre to center. consistent with other man pages,Ted Unangst
the name of the macro being described, and look(1). ok jmc
2015-01-03Given the excessively technical description in the old mdoc_samples(7)Ingo Schwarze
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>.
2014-12-31describe .Ql more precisely;Ingo Schwarze
defect pointed out by Steffen Nurpmeso <sdaoden at yandex dot com>
2014-12-28Improve documentation of the header/footer macros .Dt, .Os, .TH:Ingo Schwarze
* 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.
2014-11-30delete three standard abbreviations that areIngo Schwarze
* no longer used in our tree * not used in any of NetBSD, FreeBSD, or DragonFly * not supported by groff
2014-11-28Retire support for CSRG supplementary document titles. These areIngo Schwarze
long obsolete and were never written in mdoc(7) in the first place. Removes 100 lines from source files.
2014-11-27Fix the obsolete .Db (toggle debug mode) macro to ignore its argumentsIngo Schwarze
and not trigger an assertion when there is more than one argument; the latter found by jsg@ with afl.
2014-11-16Delete five standards that are:Ingo Schwarze
* 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@
2014-10-30Major bugsquashing with respect to -offset and -width:Ingo Schwarze
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@.
2014-10-20improve documentation of .Fa, .Va, and .Vt;Ingo Schwarze
inspired by a discussion with matthew@
2014-10-12Clarify: SEE ALSO sections are sorted case insensitively.Anthony J. Bentley
ok jmc@ schwarze@
2014-09-17Five year old typo reported by Theo Buehler at math dot ethz dot ch, thanks.Ingo Schwarze
I nearly asked: ``What's wrong with it? It formats as "intended".'' (However, what Kristaps intended to write was "indented".)
2014-08-28Support .St -susv1 and .St -susv4. Illumos wants to use this,Ingo Schwarze
and it's illogical anyway to have -susv2 and -susv3 but not -susv4.
2014-08-14Clarify that .Em and .Sy are physical, not semantic markup,Ingo Schwarze
explain appropriate usage, and provide some examples. ok jmc@
2014-08-08some corrections and improvements with respect to prologue macros;Ingo Schwarze
found while working on mandoc(1) messages
2014-07-13Unconfuse .Fa documentation:Ingo Schwarze
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@.
2014-07-02When .Sm is called without an argument, groff toggles the spacing mode,Ingo Schwarze
so let us do the same for compatibility. Using this feature is of course not recommended except in manual page obfuscation contests.
2014-07-02Implement the obsolete macros .En .Es .Fr .Ot for backward compatibility,Ingo Schwarze
since this is hardly more complicated than explicitly ignoring them as we did in the past. Of course, do not use them!
2014-06-24Deprecate .Tn and .Ux, and make it clearer that .Bt and .Ud are deprecated.Ingo Schwarze
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.
2014-06-22Minimal COMPATIBILITY cleanup:Ingo Schwarze
* 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.
2014-03-30i suggested a CONTEXT section for kernel manpages that describesDavid Gwynne
which contexts you can call functions in. deraadt@ encouraged me to pursue it. ive applied it to a few pages and i think it is worth moving forward with. this specific diff was requested by schwartz@ while we were discussing it before 5.5. tweaks from jmc@ schwartz@ ok schwartz@
2014-03-18Retire hp300, mvme68k and mvme88k ports. These ports have no users, keepingMiod Vallat
this hardware alive is becoming increasingly difficult, and I should heed the message sent by the three disks which have died on me over the last few days. Noone sane will mourn these ports anyway. So long, and thanks for the fish.
2014-02-16After Werner Lemberg accepted and committed some updates to the manualIngo Schwarze
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@
2014-01-24Supplement the documentation of the .St macro by minimal commentaryIngo Schwarze
regarding the content and relationships of the various standards, and sort and group them. tweaks and ok guenther@, ok millert@ sobrado@ jmc@
2014-01-20Change markup of some fixed strings from .Ar to .Cm.Ingo Schwarze
2013-12-30Support .St -p1003.1-2013, "IEEE Std 1003.1-2008/Cor 1-2013".Ingo Schwarze
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@.
2013-12-25Support .St -xsh4.2, the System Interfaces part of the original SingleIngo Schwarze
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.
2013-11-02While answering a question asked by espie@, i noticed that .Fd is notIngo Schwarze
completely obsolete, but still somewhat useful for listing preprocessor directives, in particular in the SYNOPSIS.
2013-10-06Fix an .Lb example in two respects:Ingo Schwarze
As noticed by Sascha Wildner (DragonFly), .Lb wants a "lib" prefix. And mdoc(3) was merged into mandoc(3) long ago.
2013-09-04Beagle has been replaced by armv7.Patrick Wildt
2013-08-14Use text production macros to document themselves.Ingo Schwarze
Part of the patch was sent in by Jan Stary <hans at stare dot cz>, another part was added by jmc@, the rest was added by myself; ok jmc@.
2013-07-13For citing the names and email addresses of authors,Ingo Schwarze
consistently use the style ".An name Aq Mt email". Triggered by a question from Jan Stary <hans at stare dot cz>, ok jmc@.
2013-06-17Add .St values for POSIX 1003.1d, 1003.1j, and 1003.1qPhilip Guenther
Tweak descriptions of the other POSIX 1003.1<letter> standards Sort a few others into their proper places Discussed with schwarze@ at t2k13
2013-04-27- (mdoc.7) fix Xr to selfJason McIntyre
- double word fix
2013-03-26bits for octeon (will format as OCTEON in Dt);Jason McIntyre
2013-03-26no more palm;Jason McIntyre
2012-08-291) Remove documentation of the groff-1.15 compatibility quirkIngo Schwarze
of suppressing spacing before a third .Xr argument because that quirk was removed in mdoc_macro.c rev. 1.72. 2) Mark the "section" argument to .Xr as (syntactically) optional, but still do not encourage omitting it. The missing .Op was reported by espie@. Wording tweaked by and ok jmc@, ok millert@.
2012-06-20no more mac68k; ok schwarzeJason McIntyre
2012-06-20When i moved some low-level stuff from mdoc(7) and man(7)Ingo Schwarze
to roff(7) some time ago, i forgot to adjust the cross-references. Reported by Tim van der Molen <tbvdm at xs4all dot nl>, thanks. ok jmc@
2012-01-03Support .St -isoC-2011 to refer to ISO C11.Ingo Schwarze
From Ulrich Spoerlein, tweaked by kristaps@. Werner Lemberg added the same .St argument to groff today.
2011-11-01Clean up the description of .Dt:Ingo Schwarze
- Volume and arch are both optional and not alternatives. - Zap verbiage about what's obvious from the synopsis. - For fixed argument strings, use .Cm, not .Ar. - Update the list of architectures for OpenBSD. Using lots of input from jmc@.
2011-09-27even though .Bl is not callable, groff complains when it appearsIngo Schwarze
unescaped on a macro line, so lets just escape it; noticed by jmc@
2011-09-26Reorganize part of the content:Ingo Schwarze
1) Move the LANGUAGE SYNTAX from mdoc(7) and man(7) to roff(7), it's common to both and it's actually roff syntax. 2) Move the MACRO SYNTAX down to the bottom, such that the less technical parts MANUAL STRUCTURE and MACRO OVERVIEW get to the top. Getting everything to again fit together after the reshuffling required various adjustments; also adjust and improve the DESCRIPTIONS while there. feedback and "go ahead" jmc@ kristaps@
2011-09-26Replace the .Fl examples by others exhibiting the same features,Ingo Schwarze
but avoiding use of .Nm, because letting .Nm call other macros is unusual style, and we don't want unusual style in examples. Issue brought up by kristaps@.
2011-09-18sync to version 1.11.7 from kristaps@Ingo Schwarze
main new feature: support the roff(7) .tr request plus various bugfixes and some refactoring regressions are so minor that it's better to get this in and fix them in the tree
2011-09-18sync to mandoc 1.11.5:Ingo Schwarze
document eqn(7) and many other improvements from kristaps@ no objection from deraadt@ against adding an eqn.7 page