summaryrefslogtreecommitdiffstats
path: root/mdoc.7
Commit message (Collapse)AuthorAgeFilesLines
* Sync to OpenBSD: More precise description of .Xo, and don't talkIngo Schwarze2010-12-181-3/+7
| | | | | | | | about deprecation, because there are cases were choosing .Xo or backslash line continuation is merely a matter of taste, not a difference in readability, and well-used .Xo is even slightly more portable. OK jmc@
* Import changes by schwarze@ and Jason McIntyre into manuals. These areKristaps Dzonsons2010-12-061-9/+4
| | | | | | | | | | for the new libroff macros, the new libman macros, and for the sake of general clarity. Note that `ft' documentation is NOT included, as I've kept it in -man: it's highly confusing to have it in roff.7 when it's not implemented for both -man and -mdoc, as at least in theory, roff.7 should include only macros recognised by BOTH formats.
* Merge schwarze@'s changes allowing nested displays. Tweak the patch byKristaps Dzonsons2010-12-051-0/+5
| | | | | | | making sure output doesn't add a superfluous newline with the nested displays. Also add a COMPATIBILITY note. Rename a macro (DATESIZ) to be in line with OpenBSD (DATESIZE).
* Restore the Id tag that i clobbered in my previous commit,Ingo Schwarze2010-11-301-1/+1
| | | | as pointed out by kristaps@. Sorry!
* Merge OpenBSD mdoc.7 rev. 1.56 and 1.57:Ingo Schwarze2010-11-301-15/+25
| | | | | | | | Define the terms "callable" and "parsed" with more precision. Be more specific about what .Xo can be used for. Be more specific about what "historic groff" refers to. Explicitely mention the nine argument limit below COMPATIBILITY. feedback and ok jmc@
* Migrate `Nm' and `Pa' handling from mdoc_action.c into mdoc_validate.c.Kristaps Dzonsons2010-11-291-0/+3
| | | | Document that `Pa' is replaced by a tilde, just like `Mt'.
* Move `Mt', `Ar', and `Li' handling from mdoc_action.c into mdoc_validate.c.Kristaps Dzonsons2010-11-291-0/+3
| | | | | | | | Clarify that `Mt' gets a default `~' (as per groff 1.20) and document it in mdoc.7. Made `Lk' be removed in mdoc_macro.c if it has no arguments. This fixes segfaults in mdoc_{term,html}.c that nobody's managed to raise yet.
* Referring to terms explained in other manuals, always use .Xr.Ingo Schwarze2010-10-291-2/+2
| | | | | | Otherwise, hyperlinks can't be produced and people will likely miss the additional information available. Suggested by deraadt@.
* When mentioning a function documented elsewhere, .Xr is often better than .Fn.Ingo Schwarze2010-10-241-0/+3
| | | | Prodded by guenther@, ok jmc@.
* Suppress whitespace following Pp, Lp, sp, and the other newline-emittingKristaps Dzonsons2010-09-271-1/+2
| | | | macros within an unfilled or literal `Bd'.
* Added MIPS64. From a patch by Jason McIntyre.Kristaps Dzonsons2010-09-271-0/+1
|
* sync to OpenBSD:Ingo Schwarze2010-09-261-1/+3
| | | | | | note that IMPLEMENTATION NOTES is not used in OpenBSD add missing comma in "sections 1, 6, & 8 only" below EXIT STATUS below SEE ALSO, add an .Xr to man(1), and from man(7) to mdoc(7)
* Clarified EXIT STATUS sections. Discussed among schwarze@, Thomas, andKristaps Dzonsons2010-09-041-1/+1
| | | | Jason. Patch by Jason.
* Remove overstrike `\o'. This isn't the best solution because we reallyKristaps Dzonsons2010-08-291-0/+2
| | | | | should be printing the contents, but for the time being, this is good enough.
* Move mdoc/man template "The next is for" into the section itself. AddedKristaps Dzonsons2010-08-281-6/+8
| | | | OpenBSD compatibility notes. Based on a patch by Jason McIntyre.
* Fixed HISTORY to note mdoc's rewrite in groff-1.17, not groff-1.20.Kristaps Dzonsons2010-08-241-1/+1
|
* Strip out `\k' escape.Kristaps Dzonsons2010-08-241-0/+2
|
* Stripping out of `\w' groff escape. Yet another for pod2man...Kristaps Dzonsons2010-08-241-2/+3
|
* Strip out the `\z' escape. This is the first recursive sequence,Kristaps Dzonsons2010-08-241-0/+2
| | | | getting mandoc ready to handle pod2man's complex escapes.
* Add a short HISTORY section to mdoc.7. Facts provided by schwarze@'sKristaps Dzonsons2010-08-221-0/+11
| | | | detective-work in the UNIX archives.
* Sort COMPATIBILITY in mdoc(7) (from schwarze@).Kristaps Dzonsons2010-08-221-110/+103
| | | | Update escape COMPATIBILITY in mdoc(7) and man(7) (ok schwarze@).
* Correctly make quotes around `Lk' link-name argument. Noted by AldisKristaps Dzonsons2010-08-091-2/+6
| | | | Berzoja. Also note COMPATIBILITY of groff misformatting `Lk'.
* Removed cross-reference to groff(1) in favour of simply mentioning GNUKristaps Dzonsons2010-08-071-1/+1
| | | | troff. This removes the last groff(1) `Xr'.
* Added serial comma.Kristaps Dzonsons2010-08-071-5/+5
| | | | Put "remarks" for `%C' into COMPATIBILITY.
* `In' comes before `Vt' in function example of SYNOPSIS.Kristaps Dzonsons2010-08-071-1/+1
|
* Clarify that predefined strings aren't groff-isms, they're troff-isms.Kristaps Dzonsons2010-08-071-1/+1
|
* tweaks from jmc@:Ingo Schwarze2010-08-061-36/+41
| | | | | | | * correct a few obvious mistakes * adopt some of jmc@'s recent changes to man(7) * cut down just a little on the awful tendency to stick a hyphen between two words.
* merge from OpenBSD:Ingo Schwarze2010-08-061-5/+3
| | | | | | - HISTORY is interesting even when there are STANDARDS - more precise instructions what to put into AUTHORS - add the version argument to the mdoc(7) .Os macro
* Note that `Dd' can be empty. This found following a thread on discuss@Kristaps Dzonsons2010-07-261-3/+9
| | | | started by Sascha Wildner, 07/25/2010 06:30 AM.
* Merge schwarze@'s pass over mdoc.7. Fixed small new-sentence-new-lineKristaps Dzonsons2010-07-261-222/+230
| | | | | | nit noted by Jason McIntyre. "your diff looks ok" (Jason McIntyre)
* All macros in mdoc.7 are now documented.Kristaps Dzonsons2010-07-191-14/+52
|
* Finished document -mdoc macros. Note `br' and `sp' remain.Kristaps Dzonsons2010-07-191-6/+120
| | | | | Noted in arch.in and st.in that mdoc.7 must be updated if entries are added.
* Added documentation for several more macros. Only a few remaining!Kristaps Dzonsons2010-07-191-109/+170
| | | | | | | | | Applied "new-sentence, new-line" here and there. Refer to "whitespace", not "white-space". Remove long-commented-out CAVEATS, all of which have been addressed or at least discussed to some extent or another.
* Note discarding of \m, \M, and \s in COMPATIBILITY sections.Kristaps Dzonsons2010-07-191-1/+4
|
* Removed \s documentation, as we (1) never supported it, and (2) neverKristaps Dzonsons2010-07-191-22/+1
| | | | | | will. Also whack the dot-separator from the embedded man.7 manual.
* Fixed dquote to be \*q.Kristaps Dzonsons2010-07-161-2/+2
|
* document .Sm; prodded by kristaps@Ingo Schwarze2010-07-151-0/+12
|
* Clarified `Bk' operation in mdoc.7.Kristaps Dzonsons2010-07-061-10/+12
|
* Documented `En', `Es', `Hf', `Ic', `Lp', `Nd', `No', `Oc', `Oo', `Op',Kristaps Dzonsons2010-07-061-0/+109
| | | | `Pa', `Pc', `Po', `Pq', `Pp', and `Va'.
* Manual clean-ups. Add syntax message for `Bd', `Bk', and `Bl'.Kristaps Dzonsons2010-07-051-15/+56
| | | | Document `Eo' and `Ec'. Add context-end notes `Ec' and `Fc'.
* Assert my copyright, making it explicit that i'm granting the same licenseIngo Schwarze2010-07-041-1/+2
| | | | | on those parts of the code and text that i have written as Kristaps is. "fine with me" kristaps@
* Add documentation for Bf/Ef.Kristaps Dzonsons2010-07-021-0/+38
|
* Improve .Nm indentation in the SYNOPSIS;Ingo Schwarze2010-07-011-0/+60
| | | | | | | kristaps@ will do the missing HTML part soon. "looks nicer" jmc@ "seems perfect to me" sobrado@ "slap it in" kristaps@
* Document .Bk and .Ek; reminded by kristaps@.Ingo Schwarze2010-06-271-0/+21
|
* Removed stipulation that an empty `Bd -offset' will default to 6n. NotKristaps Dzonsons2010-06-121-16/+9
| | | | | | | sure where this came about. Added regression tests to convince myself that this is so. Also consolidated COMPATIBILITY notes regarding `Bd'. Added COMPATIBILITY note to the effect that old groff pukes on `Bd -compact -ragged' (regression test will fail on old groff).
* Added enum mdoc_disp (similar to enum mdoc_list). Display types are nowKristaps Dzonsons2010-06-121-0/+6
| | | | | | | | | | | only calculated once in mdoc_validate.c. Noted that `Bd -file xxx' is not supported: it now raises a fatal warning. This is noted in mdoc.7. Empty `Bd' now defaults to LIST_ragged, which is not quite what groff does, but close enough (gross just throws away the `Bd' and gets upset when it encounters an `Ed').
* Added version bits for 1.10.1.Kristaps Dzonsons2010-06-071-6/+6
| | | | Spell-checked manuals.
* I really should run -Tlint on my own manuals before committing them.Kristaps Dzonsons2010-06-071-2/+2
| | | | EOLN whitespace fixed.
* Normalise SYNOPSIS behaviour after I gave up on following groff'sKristaps Dzonsons2010-06-071-45/+46
| | | | | | | | | | | | | | | | | | | | | inconsistent behaviour. In short: Some macros are displayed differently in the SYNOPSIS section, particularly Nm, Cd, Fd, Fn, Fo, In, Vt, and Ft. All of these macros are output on their own line. If two such dissimilar macros are pair-wise invoked (except for Ft before Fo or Fn), they are separated by a vertical space, unless in the case of Fo, Fn, and Ft, which are always separated by vertical space. Behaviour ok Jason McIntyre, ingo@. Fallout will be treated case-by-case. I had to clear out some regressions that were testing against groff's stranger behaviours: these will now break, as we don't care about such invocations. Also removed the newline for `Cd' invocation in a non-SYNOPSIS context.
* Small fix to preserve trailing semicolons in examples.Kristaps Dzonsons2010-06-061-3/+3
|
generated by cgit (git 2.34.1) at 2024-11-15 14:37:16 +0000