summaryrefslogtreecommitdiff
path: root/share/man/man7/man.7
AgeCommit message (Collapse)Author
2019-07-09The non-standard .EX/.EE macro pair was invented for Version 9 AT&T UNIXIngo Schwarze
and only got adopted by GNU two decades later. Thanks to Doug McIlroy <doug at cs dot dartmouth dot edu> for pointing out the error.
2019-03-02Do not open a subsection for each and every macro.Ingo Schwarze
Instead, use a tagged list and the canonical .Ic macro as it is natural for such purposes. While here, also delete heaps of needless escaping.
2019-01-01Now that .nf and .fi are implemented in the roff(7) parser and formattersIngo Schwarze
rather than in the man(7) parser and formatters, document them in the roff(7) manual, where they belong, rather than in the man(7) manual. Mention that they imply an output line break, and mention which macros imply these requests.
2018-12-16The .HP macro was deprecated by groff, and that makes senseIngo Schwarze
because it serves no real purpose and works poorly with HTML. While here, describe the section argument of .TH, clarify the syntax display of .TP, and polish some wordings.
2018-08-18Massively reduce the amount of text, cutting it down to what is neededIngo Schwarze
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.
2018-08-18implement the GNU man-ext .SY/.YS (synopsis block) macro in man,Ingo Schwarze
used in most manual pages of the groff package
2018-08-16implement the GNU man-ext .TQ macro in man(7),Ingo Schwarze
used for example by groff_diff(7)
2018-04-05Stop documenting the non-portable .R man(7) macro. Neither groffIngo Schwarze
nor the heirloom-doctools support it. Adding it was a mistake in the first place.
2017-06-25Add support for the MT and ME mailto macros, used for example in wg(8).Anthony J. Bentley
feedback and ok schwarze@
2017-05-07implement .DT in terms of .ta; needed for print/ghostview, for exampleIngo Schwarze
2017-05-05Shorten the description of .sp and move it to roff(7).Ingo Schwarze
If is not a macro but a low-level roff request and not recommended for use in manual pages.
2017-05-05Clean up docs after today's .br and .ft code cleanup; simpler.Ingo Schwarze
2015-01-29Radical cleanup of COMPATIBILITY sections:Ingo Schwarze
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.
2015-01-24Strangely, ignoring the roff(7) .na request was implemented in the man(7)Ingo Schwarze
parser. Simplify the code by moving it into the roff(7) parser, also making it work for mdoc(7).
2015-01-24change .Cm to .Ar for macro argumentsIngo Schwarze
2015-01-24Support .RE with an argument; needed for audio/pms(1).Ingo Schwarze
2014-12-28Improve documentation of the header/footer macros .Dt, .Os, .TH:Ingo Schwarze
* 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.
2014-06-22Minimal cleanup of the COMPATIBILITY section:Ingo Schwarze
* 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.
2014-03-30i suggested a CONTEXT section for kernel manpages that describesDavid Gwynne
which contexts you can call functions in. deraadt@ encouraged me to pursue it. ive applied it to a few pages and i think it is worth moving forward with. this specific diff was requested by schwartz@ while we were discussing it before 5.5. tweaks from jmc@ schwartz@ ok schwartz@
2014-02-16After Werner Lemberg accepted and committed some updates to the manualIngo Schwarze
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@
2014-02-14use .At where appropriate; from Jan Stary <hans at stare dot cz>Ingo Schwarze
2014-01-06Joerg Sonnenberger contributed copyrightable amounts of text toIngo Schwarze
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.
2013-12-31Oops, add missing end of block.Ingo Schwarze
2013-12-31Add missing description of .UR/.UE.Ingo Schwarze
While here, also add .EX/.EE and .PD to the MACRO SYNTAX table.
2013-08-14some Bx/Ox conversion;Jason McIntyre
From: Jan Stary
2013-07-13For citing the names and email addresses of authors,Ingo Schwarze
consistently use the style ".An name Aq Mt email". Triggered by a question from Jan Stary <hans at stare dot cz>. Somehow, i missed these two files, jmc@ agrees with the principle.
2012-07-29document .PD; related to man_term.c rev. 1.88Ingo Schwarze
2012-06-20When i moved some low-level stuff from mdoc(7) and man(7)Ingo Schwarze
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@
2012-06-02Minimal implementation of .EX and .EE for GNU compatibility.Ingo Schwarze
Do not use this, it is not portable and only defined in esr's man-ext. For example, sox(1) wants these macros.
2012-02-26Support .OP, one of the extended man macros; from kristaps@.Ingo Schwarze
Do not use this GNU extension, we take it for compatibility only.
2011-12-02In man(7), when no explicit volume name is given, use the defaultIngo Schwarze
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
2011-09-26Reorganize part of the content:Ingo Schwarze
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@
2011-09-26note that section macro end literal mode;Ingo Schwarze
from kristaps@
2011-09-20add a MACRO OVERVIEW section, similar to the one in mdoc(7);Ingo Schwarze
writing this for man(7), too, was suggested by kristaps@
2011-09-18sync to mandoc 1.11.5:Ingo Schwarze
document eqn(7) and many other improvements from kristaps@ no objection from deraadt@ against adding an eqn.7 page
2011-08-30in column lists, enforce the following ordering:Jason McIntyre
.Bl -column header1 header2 ... <Bl flags> mixing things up confuses mandoc, and adding flags in can screw up the list. this hopefully just makes things a bit safer (and more consistent). (one more bit of work left and all column lists should format how we want)
2011-08-30remove some pointless Pp/-compact combinations; either ingo or kristapsJason McIntyre
will update mandoc repo
2011-07-15Clarify the role of .RS and fix a bogus cross-reference;Ingo Schwarze
from kristaps@.
2011-06-07bring in lots of improvements from kristaps@;Ingo Schwarze
jmc@ agrees that it's easiest to first commit it, then tweak it in the tree
2011-03-07Clean up date handling,Ingo Schwarze
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@
2011-01-25As noticed by deraadt@, it goes without saying that text filesIngo Schwarze
on a UNIX system use UNIX conventions, and UNIX tools working on them expect that. ok jmc@
2011-01-24Better explain roff(7) macro argument quoting;Ingo Schwarze
ok jmc@.
2011-01-16If the first character of a free-form text input line is whitespace,Ingo Schwarze
then it will start a new output line; from kristaps@.
2011-01-09Add and install tbl(7);Ingo Schwarze
written by kristaps@, looked over by jmc@.
2011-01-09Sync to bsd.lv:Ingo Schwarze
* one additional pair of .Sx cross references * prefer .Dl over .D1 for code examples
2010-12-19Sync to bsd.lv (except that i'm not adding .ft documentation,Ingo Schwarze
which we have in roff.7): Remove documentation of the bogus macros .i and .r (which we just removed from mandoc and which never worked in groff), of .b (which never existed at all), and of the commented-out chunks for .PD, .Sp, .Vb, and .Ve (the latter three occur in the pod2man preamble and are now handled by roff.7 .de).
2010-09-26sync to bsd.lv:Ingo Schwarze
note that \k, \o, \w, \z roff escapes are ignored by mandoc(1) add a short HISTORY to mdoc(7) move the sentence telling which sections use LIBRARY in man(7)
2010-09-04EXIT STATUS is allowed for section 6 pages too (even though none of ourJason McIntyre
section 6 pages currently contain this information);
2010-08-31this diff does two things (usually a bad sign):Jason McIntyre
- note which section headings (.Sh) are not used by openbsd - move the description of the section heading to under the heading, rather than before it: a much more logical way to read diffs mailed upstream...
2010-08-22* sort COMPATIBILITY in mdoc(7); ok kristaps@Ingo Schwarze
* update escape COMPATIBILITY in mdoc(7) and man(7); from kristaps@