summaryrefslogtreecommitdiffstats
path: root/mdoc.7
Commit message (Collapse)AuthorAgeFilesLines
* First, properly escape periods with \&. Then consistently refer toKristaps Dzonsons2011-04-061-61/+82
| | | | | | | | | | non-macro lines as "text lines" (after defining them as such). Clean up notion of font scope. Note comma usage in multiple `Nm's. Note ordering of SYNOPSIS section stuff. Add some bits about DESCRIPTION syntax (brief description, then args). Note that `Bl' can also contain HEAD. Finally, fix some `Cm' entries to be properly `Ar'. Ok Jason McIntyre.
* In reality `In' only accepts one argument. Subsequent ones are notKristaps Dzonsons2011-04-011-1/+1
| | | | | included in the brackets. We really should have a warning about this, but that'll wait for another day.
* Properly quote arguments in `Fn' documentation. Also make standaloneKristaps Dzonsons2011-04-011-3/+3
| | | | '...' have a properly-escaped initial dot.
* "Reserved Characters" isn't correct since `\.' and `\*(Ba' aren'tKristaps Dzonsons2011-03-171-9/+12
| | | | characters. Use "Reserved Terms" instead.
* Clean up date handling,Ingo Schwarze2011-03-071-41/+37
| | | | | | | | | | | | as a first step to get rid of the frequent petty warnings in this area: - always store dates as strings, not as seconds since the Epoch - for input, try the three most common formats everywhere - for unrecognized format, just pass the date though verbatim - when there is no date at all, still use the current date Originally triggered by a one-line patch from Tim van der Molen, <tbvdm at xs4all dot nl>, which is included here. Feedback and OK on manual parts from jmc@. "please check this in" kristaps@
* Add stub for eqn.7 manual and flip it on. Also note COMPATIBILITY issueKristaps Dzonsons2011-02-091-0/+1
| | | | of how we considered .TS (etc.) macros and how the preprocessors do.
* The macro .Ns has no effect at the beginning of an input line;Ingo Schwarze2011-02-071-4/+6
| | | | ok kristaps@ jmc@.
* If `Ns' is specified on its own line, it should be ignored. This isKristaps Dzonsons2011-02-021-0/+2
| | | | | shitty groff behaviour. Do the same, but raise a warning to this effect. This from a TODO noted by schwarze@.
* As noticed by deraadt@, it goes without saying that text filesIngo Schwarze2011-01-251-3/+0
| | | | | | on a UNIX system use UNIX conventions, and UNIX tools working on them expect that. ok jmc@
* Lots of in-line macros require arguments but were not marked as such.Ingo Schwarze2011-01-221-9/+9
| | | | Check prompted by kristaps@.
* If the first character of free-form text is whitespace, then a newlineKristaps Dzonsons2011-01-121-0/+3
| | | | shall precede outputted text (surprise!).
* Moved table stuff from roff.7 into the new tbl.7 (suggested by Jason McIntyre).Kristaps Dzonsons2011-01-041-0/+3
| | | | Added cross-links to tbl.7 from other manuals.
* In mdoc.7, don't use `D1' in place of `Dl' for code examples.Kristaps Dzonsons2010-12-291-92/+92
|
* Note `Sx's connection to `Sh' and `Ss'.Kristaps Dzonsons2010-12-271-0/+5
|
* minor tweaks:Ingo Schwarze2010-12-221-5/+7
| | | | | | | | | 1. improve .Bl wording (from jmc@) 2. jmc@ noted that the .Mt default (the same as in groff) makes no sense, and there is no better default we could use; thus, regard it as implementation dependent and do not document it 3. fix formatting of one COMPATIBILITY note: move "and" out of .Sx ok kristaps@, jmc@
* 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.
generated by cgit (git 2.34.1) at 2024-11-14 17:31:20 +0000