=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.107 retrieving revision 1.110 diff -u -p -r1.107 -r1.110 --- mandoc/man.7 2011/08/30 12:16:36 1.107 +++ mandoc/man.7 2011/09/20 22:46:47 1.110 @@ -1,4 +1,4 @@ -.\" $Id: man.7,v 1.107 2011/08/30 12:16:36 kristaps Exp $ +.\" $Id: man.7,v 1.110 2011/09/20 22:46:47 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: August 30 2011 $ +.Dd $Mdocdate: September 20 2011 $ .Dt MAN 7 .Os .Sh NAME @@ -501,7 +501,7 @@ The syntax is as follows: \&.YO \(lBbody...\(rB \(lBbody...\(rB .Ed -.Bl -column -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" +.Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent .It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes .It Sx \&AT Ta <=1 Ta current Ta \& .It Sx \&B Ta n Ta next-line Ta \& @@ -568,7 +568,7 @@ No closure refers to an explicit block closing macro. As a rule, block macros may not be nested; thus, calling a block macro while another block macro scope is open, and the open scope is not implicitly closed, is syntactically incorrect. -.Bl -column -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" +.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes .It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& .It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& @@ -589,6 +589,45 @@ are as mentioned in .Pp If a block macro is next-line scoped, it may only be followed by in-line macros for decorating text. +.Sh MACRO OVERVIEW +This overview is sorted such that macros of similar purpose are listed +together, to help find the best macro for any given purpose. +Deprecated macros are not included in the overview, but can be found +in the alphabetical reference below. +.Ss Page header and footer meta-data +.Bl -column "PP, LP, P" description +.It Sx TH Ta set the title: Ar title section date Op Ar source Op Ar volume +.It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument) +.It Sx UC Ta display BSD version in the page footer (<= 1 argument) +.El +.Ss Sections and paragraphs +.Bl -column "PP, LP, P" description +.It Sx SH Ta section header (one line) +.It Sx SS Ta subsection header (one line) +.It Sx PP , LP , P Ta start an undecorated paragraph (no arguments) +.It Sx RS , RE Ta reset the left margin: Op Ar width +.It Sx IP Ta indented paragraph: Op Ar head Op Ar width +.It Sx TP Ta tagged paragraph: Op Ar width +.It Sx HP Ta hanged paragraph: Op Ar width +.It Sx \&br Ta force output line break in text mode (no arguments) +.It Sx \&sp Ta force vertical space: Op Ar height +.It Sx fi , nf Ta fill mode and no-fill mode (no arguments) +.It Sx in Ta additional indent: Op Ar width +.El +.Ss Physical markup +.Bl -column "PP, LP, P" description +.It Sx B Ta boldface font +.It Sx I Ta italic font +.It Sx R Ta roman (default) font +.It Sx SB Ta small boldface font +.It Sx SM Ta small roman font +.It Sx BI Ta alternate between boldface and italic fonts +.It Sx BR Ta alternate between boldface and roman fonts +.It Sx IB Ta alternate between italic and boldface fonts +.It Sx IR Ta alternate between italic and roman fonts +.It Sx RB Ta alternate between roman and boldface fonts +.It Sx RI Ta alternate between roman and italic fonts +.El .Sh REFERENCE This section is a canonical reference to all macros, arranged alphabetically. @@ -971,6 +1010,14 @@ implementations of the language. .Pp .Bl -dash -compact +.It +Do not depend on +.Sx \&SH +or +.Sx \&SS +to close out a literal context opened with +.Sx \&nf . +This behaviour may not be portable. .It In quoted literals, GNU troff allowed pair-wise double-quotes to produce a standalone double-quote in formatted output.