summaryrefslogtreecommitdiffstats
path: root/mdoc.7
Commit message (Collapse)AuthorAgeFilesLines
...
* 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.
* Use text production macros to document themselves.Ingo Schwarze2013-08-141-5/+15
| | | | | | 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-3/+3
| | | | | | | 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-4/+10
| | | | | | | 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-2/+2
| | | | | - double word fix from jmc@
* 1) Remove documentation of the groff-1.15 compatibility quirkIngo Schwarze2012-08-291-10/+4
| | | | | | | | | | | 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-9/+9
| | | | | | | 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-0/+2
| | | | | 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-36/+14
| | | | | | | | | | | - 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-1/+1
| | | | | unescaped on a macro line, so lets just escape it; noticed by jmc@
* Reorganize part of the content:Ingo Schwarze2011-09-261-644/+444
| | | | | | | | | | | | | 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-0/+124
| | | | | | | 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-0/+2
|
* Fix typos and spelling errors found by demandoc -w | spell -b.Kristaps Dzonsons2011-09-021-3/+3
|
* Order -column lists to have the arguments follow `-column'. From aKristaps Dzonsons2011-08-301-2/+2
| | | | patch by Jason McIntyre.
* Remove unnecessary `Pp'/`-compat' combination for column lists.Kristaps Dzonsons2011-08-301-12/+6
| | | | Directly from a patch by Jason McIntyre.
* Bring man.7's LANGUAGE SYNTAX in line with mdoc.7. While here, changeKristaps Dzonsons2011-08-191-2/+2
| | | | out the \*q escapes. Also fix some spelling typos in both manuals.
* Make LANGUAGE SYNTAX examples a bit more explanatory.Kristaps Dzonsons2011-08-191-13/+19
|
* First, use \(dq instead of \*q for double-quote. Second, use `Li' toKristaps Dzonsons2011-08-191-72/+65
| | | | | | | 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-1/+2
|
* Add example of comments in man.7 and mdoc.7.Kristaps Dzonsons2011-08-171-2/+10
|
* Clean up and normalise the LANGUAGE SYNTAX section in mdoc.7:Kristaps Dzonsons2011-08-171-59/+91
| | | | | | | | - 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-5/+5
| | | | | | 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-51/+165
| | | | ok kristaps@
* Allow `Sx' and `Ss' to have child nodes. Fixes manuals in NetBSD.Kristaps Dzonsons2011-08-101-5/+11
| | | | | | 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-26/+63
| | | | | | 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-44/+90
| | | | | | | | | | 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-4/+38
| | | | | | | | | | | 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-7/+7
| | | | | | * 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-0/+3
|
* Clarify up `Rv' and `Ex' documentation.Kristaps Dzonsons2011-07-181-10/+20
|
* improve documentation of .Bl -column .It TaIngo Schwarze2011-07-151-23/+41
| | | | using feedback from kristaps@, ok jmc@
generated by cgit (git 2.34.1) at 2024-11-17 00:57:46 +0000