aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.7
Commit message (Collapse)AuthorAgeFilesLines
* Use text production macros to document themselves.Ingo Schwarze2013-08-141-7/+17
| | | | | | 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@.
* For citing the names and email addresses of authors,Ingo Schwarze2013-07-131-5/+5
| | | | | | | consistently use the style ".An name Aq Mt email". Triggered by a question from Jan Stary <hans at stare dot cz>, ok jmc@.
* Add .St values for POSIX 1003.1d, 1003.1j, and 1003.1q.Ingo Schwarze2013-06-191-6/+12
| | | | | | | Tweak descriptions of the other POSIX 1003.1<letter> standards. Sort a few others into their proper places. From Philip Guenther@ during t2k13.
* - (mdoc.7) fix Xr to selfIngo Schwarze2013-04-281-4/+4
| | | | | - double word fix from jmc@
* 1) Remove documentation of the groff-1.15 compatibility quirkIngo Schwarze2012-08-291-12/+6
| | | | | | | | | | | of suppressing spacing before a third .Xr argument because that quirk was removed in mdoc_macro.c rev. 1.113. 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@.
* When i moved some low-level stuff from mdoc(7) and man(7)Ingo Schwarze2012-06-201-11/+11
| | | | | | | 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@
* Accommodate for ISO C11. groff applied the same `St' argument onKristaps Dzonsons2012-01-031-2/+4
| | | | | 03/01/2012. From a tweaked patch (isoC-11 -> isoC-2011) by Ulrich Sporlein: thanks!
* Clean up the description of .Dt:Ingo Schwarze2011-11-011-38/+16
| | | | | | | | | | | - 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. Using lots of input from jmc@. Also, state that the list of valid architectures varies by OS. If a downstream distribution wants to provide a specific list, maintaining a local patch is the way to go.
* even though .Bl is not callable, groff complains when it appearsIngo Schwarze2011-09-271-3/+3
| | | | | unescaped on a macro line, so lets just escape it; noticed by jmc@
* Reorganize part of the content:Ingo Schwarze2011-09-261-646/+446
| | | | | | | | | | | | | 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@
* Add a MACRO OVERVIEW, listing all macros ordered by purpose,Ingo Schwarze2011-09-181-2/+126
| | | | | | | each with a one-line discription. Use this when wondering which macro fits best for your particular use case, and whether there are alternatives. feedback ond ok jmc@, ok kristaps@
* support ".St -iso8601"; committing on behalf of jmc@Ingo Schwarze2011-09-161-2/+4
|
* Fix typos and spelling errors found by demandoc -w | spell -b.Kristaps Dzonsons2011-09-021-5/+5
|
* Order -column lists to have the arguments follow `-column'. From aKristaps Dzonsons2011-08-301-3/+3
| | | | patch by Jason McIntyre.
* Remove unnecessary `Pp'/`-compat' combination for column lists.Kristaps Dzonsons2011-08-301-14/+8
| | | | Directly from a patch by Jason McIntyre.
* Bring man.7's LANGUAGE SYNTAX in line with mdoc.7. While here, changeKristaps Dzonsons2011-08-191-3/+3
| | | | out the \*q escapes. Also fix some spelling typos in both manuals.
* Make LANGUAGE SYNTAX examples a bit more explanatory.Kristaps Dzonsons2011-08-191-14/+20
|
* First, use \(dq instead of \*q for double-quote. Second, use `Li' toKristaps Dzonsons2011-08-191-74/+67
| | | | | | | note literal text in "Examples:" parts. Finally, move parts of Quotation related to keeping whitespace into Whitespace and clean up the text to be a bit clearer. Examples can be added back in at will, but now it follows the general layout of explanation followed by examples.
* Replace the old `An'/`Aq' AUTHORS note with `An'/`Mt'.Kristaps Dzonsons2011-08-181-3/+4
|
* Add example of comments in man.7 and mdoc.7.Kristaps Dzonsons2011-08-171-3/+11
|
* Clean up and normalise the LANGUAGE SYNTAX section in mdoc.7:Kristaps Dzonsons2011-08-171-61/+93
| | | | | | | | - make examples trail each section - make explanations more concise - remove references to troff ok Jason McIntyre.
* Replace the .Fl examples by others exhibiting the same features,VERSION_1_11_6Ingo Schwarze2011-08-161-6/+6
| | | | | | 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@.
* More information about lots of macros, many new examples, and various fixes.Ingo Schwarze2011-08-161-53/+167
| | | | ok kristaps@
* Allow `Sx' and `Ss' to have child nodes. Fixes manuals in NetBSD.Kristaps Dzonsons2011-08-101-7/+13
| | | | | | Originally pointed out by joerg@ then again by Thomas Klausner by way of Nicolas Joy. Note: don't use these constructions as you can't link to the sections with `Sx'.
* Add small chunks of new text and better examples written from scratch,Ingo Schwarze2011-08-031-28/+65
| | | | | | filling gaps found by checking the MANUAL DOMAIN chapter in mdoc.samples(7). While here, fix lots of minor issues. feedback and ok jmc@
* The term "reserved terms" is too broad, so narrow it downIngo Schwarze2011-08-021-46/+92
| | | | | | | | | | to "delimiters", and explain which special handling they get as macro arguments. Move the text to a better place and remove a few lies. Postpone figuring out the lists of macros causing that special handling, it would cost too much time right now. feedback and ok jmc@ This also brings the file back in sync with OpenBSD.
* Add some new text written from scratch after checking whether anythingIngo Schwarze2011-08-011-6/+40
| | | | | | | | | | | explained in mdoc.samples(7) is missing from mdoc(7): * Discourage trailing whitespace. * Move all information about quoted arguments to the relevant subsection, shortening it a bit, and adding an example. * Mention that blanks can be quoted with a backslash. * A better .Nd line in the template (verbatim from mdoc.samples(7)). * Explain how to escape callable macro names, and provide examples. ok jmc@
* trivial fixes found while merging to OpenBSD:Ingo Schwarze2011-07-311-8/+8
| | | | | | * ellipsis is an argument to .Ar, not part of the preceding argument * libz, libpam, on, off are not placeholders for arguments * .Rv is not only relevant for system calls, see atexit(3), sem_init(3)
* System III is relevant for string(3) HISTORY.Ingo Schwarze2011-07-311-2/+5
|
* Clarify up `Rv' and `Ex' documentation.Kristaps Dzonsons2011-07-181-12/+22
|
* improve documentation of .Bl -column .It TaIngo Schwarze2011-07-151-25/+43
| | | | using feedback from kristaps@, ok jmc@
* Be more specific about `Dv', `Er', and `Ev'.Kristaps Dzonsons2011-07-111-6/+20
|
* Noticed that our skeleton mdoc.7 had lower-case `Dt'. Fixed and addedKristaps Dzonsons2011-05-261-6/+7
| | | | some language for clarity.
* remove a sentence which isn;t true;Ingo Schwarze2011-05-211-4/+2
| | | | from jmc@
* The semantics of .Bk was described incorrectlyIngo Schwarze2011-04-171-4/+5
| | | | | | for the case of multiple sibling macros on a single input line. Issue found investigating a question from sobrado@. "I like this diff" kristaps@
* First, properly escape periods with \&. Then consistently refer toKristaps Dzonsons2011-04-061-63/+84
| | | | | | | | | | 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-2/+2
| | | | | 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-5/+5
| | | | '...' have a properly-escaped initial dot.
* "Reserved Characters" isn't correct since `\.' and `\*(Ba' aren'tKristaps Dzonsons2011-03-171-11/+14
| | | | characters. Use "Reserved Terms" instead.
* Clean up date handling,Ingo Schwarze2011-03-071-43/+39
| | | | | | | | | | | | 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-2/+3
| | | | 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-6/+8
| | | | ok kristaps@ jmc@.
* If `Ns' is specified on its own line, it should be ignored. This isKristaps Dzonsons2011-02-021-2/+4
| | | | | 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-5/+2
| | | | | | 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-11/+11
| | | | Check prompted by kristaps@.
* If the first character of free-form text is whitespace, then a newlineKristaps Dzonsons2011-01-121-2/+5
| | | | shall precede outputted text (surprise!).
* Moved table stuff from roff.7 into the new tbl.7 (suggested by Jason McIntyre).Kristaps Dzonsons2011-01-041-2/+5
| | | | 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-94/+94
|
* Note `Sx's connection to `Sh' and `Ss'.Kristaps Dzonsons2010-12-271-2/+7
|
* minor tweaks:Ingo Schwarze2010-12-221-7/+9
| | | | | | | | | 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@
generated by cgit v1.2.3-56-ge451 (git 2.39.0) at 2024-06-26 14:18:28 +0000