summaryrefslogtreecommitdiffstats
path: root/man.7
Commit message (Collapse)AuthorAgeFilesLines
* Massively reduce the amount of text, cutting it down to what is neededIngo Schwarze2018-08-181-369/+72
| | | | | | | | | | | to understand existing man(7) code and deleting parts that would only be useful for writing new documents, which we strongly discourage: * Delete the MANUAL STRUCTURE section which merely duplicates mdoc(7). * Delete internal cross references only useful for writing new code. * Delete many instances of "included only for compatibility" as the whole language is only provided for compatibility. * Fix a few minor errors and omissions.
* implement the GNU man-ext .SY/.YS (synopsis block) macro in man(7),Ingo Schwarze2018-08-181-1/+18
| | | | used in most manual pages of the groff package
* implement the GNU man-ext .TQ macro in man(7),Ingo Schwarze2018-08-161-0/+6
| | | | used for example by groff_diff(7)
* Stop documenting the non-portable .R man(7) macro. Neither groffIngo Schwarze2018-04-051-15/+2
| | | | | nor the heirloom-doctools support it. Adding it was a mistake in the first place.
* add support for the MT and ME mailto macros, used for example in wg(8);Ingo Schwarze2017-06-251-0/+14
| | | | patch from bentley@
* implement .DT in terms of .ta; needed for print/ghostview, for exampleIngo Schwarze2017-05-071-2/+6
|
* Shorten the description of .sp and move it to roff(7).Ingo Schwarze2017-05-051-26/+1
| | | | | If is not a macro but a low-level roff request and not recommended for use in manual pages.
* Clean up docs after today's .br and .ft code cleanup; simpler.Ingo Schwarze2017-05-051-9/+3
|
* Radical cleanup of COMPATIBILITY sections:Ingo Schwarze2015-01-291-47/+0
| | | | | | | | 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.
* Strangely, ignoring the roff(7) .na request was implemented in the man(7)Ingo Schwarze2015-01-241-6/+2
| | | | | parser. Simplify the code by moving it into the roff(7) parser, also making it work for mdoc(7).
* change .Cm to .Ar for macro argumentsIngo Schwarze2015-01-241-18/+18
|
* Support .RE with an argument; needed for audio/pms(1).Ingo Schwarze2015-01-241-2/+22
|
* Improve documentation of the header/footer macros .Dt, .Os, .TH:Ingo Schwarze2014-12-281-1/+7
| | | | | | * 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.
* Minimal cleanup of the COMPATIBILITY section:Ingo Schwarze2014-06-221-38/+9
| | | | | | | | | | * Mention that the list is incomplete. * Quoting quotes by doubling them is documented in the Ossanna/Kernighan/Ritter Nroff/Troff User's Manual, Section 7.3. * Our roff(7) manual documents handling of escape sequences; besides, we partially support \w and \z now. * Scaling widths are documented in roff(7) as well, and f is not \f. * Negative arguments to .sp are handled now.
* 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@
* sync to OpenBSD: .ft is a roff(7) request, not a man(7) macro,Ingo Schwarze2014-03-171-6/+0
| | | | and it is not even used frequently in man(7)
* After Werner Lemberg accepted and committed some updates to the manualIngo Schwarze2014-02-161-12/+18
| | | | | | 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@
* use .At where appropriate; from Jan Stary <hans at stare dot cz>Ingo Schwarze2014-02-141-1/+1
|
* Joerg Sonnenberger contributed copyrightable amounts of text toIngo Schwarze2014-01-061-0/+1
| | | | | | some files. To make it clear that he also put his contributions under the ISC license, with his explicit permission, add his Copyright notice to the relevant files. No code change.
* Add missing description of .UR/.UE.Ingo Schwarze2013-12-311-1/+20
| | | | While here, also add .EX/.EE and .PD to the MACRO SYNTAX table.
* use the .Bx macro; from Jan Stary via jmc@Ingo Schwarze2013-09-161-1/+2
|
* For citing the names and email addresses of authors,Ingo Schwarze2013-07-131-2/+1
| | | | | | | consistently use the style ".An name Aq Mt email". Triggered by a question from Jan Stary <hans at stare dot cz>, ok jmc@.
* document .PD; related to man_term.c rev. 1.134Ingo Schwarze2012-07-291-1/+32
| | | | OpenBSD man.7 rev. 1.30
* When i moved some low-level stuff from mdoc(7) and man(7)Ingo Schwarze2012-06-201-11/+15
| | | | | | | 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@
* Minimal implementation of .EX and .EE for GNU compatibility.Ingo Schwarze2012-06-021-0/+12
| | | | | Do not use this, it is not portable and only defined in esr's man-ext. For example, sox(1) wants these macros.
* update Copyright years according to the CVS logs; no code changeIngo Schwarze2012-05-271-1/+1
|
* Discourage the use of esr's man-ext macros:Ingo Schwarze2012-04-151-5/+2
| | | | | | If man(7) has any advantage compared to mdoc(7), it's portability, and using man-ext would needlessly give that advantage away. ok kristaps@
* Add support for `OP', one of the extended man macros. This also requiresKristaps Dzonsons2012-01-031-0/+27
| | | | some man(7) changes to accomodate for the an-ext compatibility.
* In man(7), when no explicit volume name is given, use the defaultIngo Schwarze2011-12-021-0/+13
| | | | | | | | | | | | volume name for the respective manual section, just like in mdoc(7). This gives us nicer page headers for cvs(1), lynx(1), tic(1), mkhybrid(8), and many curses(3) manuals. ok kristaps@ To not break compatibility, i wrote a corresponding patch for GNU troff which Werner Lemberg accepted upstream at rev. 1.65 of: http://cvs.savannah.gnu.org/viewvc/groff/tmac/an-old.tmac?root=groff
* Reorganize part of the content:Ingo Schwarze2011-09-261-396/+177
| | | | | | | | | | | | | 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 section, similar to the one in mdoc(7);Ingo Schwarze2011-09-201-0/+39
| | | | writing this for man(7), too, was suggested by kristaps@
* It's unknown whether `SH' and `SS' closing out `nf' literalism isKristaps Dzonsons2011-09-061-0/+8
| | | | portable, so document it in COMPATIBILITY.
* 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-4/+2
| | | | Directly from a patch by Jason McIntyre.
* Bring man.7's LANGUAGE SYNTAX in line with mdoc.7. While here, changeKristaps Dzonsons2011-08-191-59/+75
| | | | out the \*q escapes. Also fix some spelling typos in both manuals.
* 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-0/+8
|
* Sync man.7's LANGUAGE SYNTAX (was INPUT ENCODING) with mdoc.7.Kristaps Dzonsons2011-08-171-47/+119
| | | | | While here, fix the scaling widths example that incorrectly used `br' (it now correctly uses `sp').
* Clarify the role of `RS' in man(7) and also fix a bogus cross-reference.Kristaps Dzonsons2011-07-081-5/+8
|
* Fix a TODO noted by schwarze@, originally by Christian Weisgerber:Kristaps Dzonsons2011-07-031-0/+4
| | | | | literal mode (`nf') is ended by SH (and, it turns out, SS as well). Noted the updated behaviour in man.7 as well.
* Noticed that our skeleton mdoc.7 had lower-case `Dt'. Fixed and addedKristaps Dzonsons2011-05-261-4/+8
| | | | some language for clarity.
* Clean up date handling,Ingo Schwarze2011-03-071-25/+17
| | | | | | | | | | | | 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.
* 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@
* Better explain roff(7) macro argument quoting;Ingo Schwarze2011-01-241-0/+7
| | | | ok jmc@.
* 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-1/+3
| | | | Added cross-links to tbl.7 from other manuals.
* Use `Dl' instead of `D1' for code examples.Kristaps Dzonsons2010-12-291-2/+2
|
* Remove `i' and `r' macro handlers. These macros, originally part of theKristaps Dzonsons2010-12-081-39/+6
| | | | | | | | me package, aren't recognised by "groff -mandoc" so we don't need to do so either. Discussed on tech@ with schwarze@. While at it, remove references to `b' in man.7. As far as I know, this was never supported anyway.
* Add support for `ft' macro found in groff(7). Based on a patch byKristaps Dzonsons2010-12-061-1/+6
| | | | | schwarze@, but without the -T[x]html handling, which structurally does not work. Also add man.7 documentation (not in original patch).
generated by cgit (git 2.34.1) at 2024-11-14 11:23:04 +0000