diff options
Diffstat (limited to 'src/preproc/eqn/eqn.man')
| -rw-r--r-- | src/preproc/eqn/eqn.man | 238 |
1 files changed, 125 insertions, 113 deletions
diff --git a/src/preproc/eqn/eqn.man b/src/preproc/eqn/eqn.man index bff0e00c..bbdeacaa 100644 --- a/src/preproc/eqn/eqn.man +++ b/src/preproc/eqn/eqn.man @@ -1,5 +1,6 @@ .ig -Copyright (C) 1989-2000, 2001, 2004, 2005 Free Software Foundation, Inc. +Copyright (C) 1989-2000, 2001, 2004, 2005, 2007 + Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -32,13 +33,6 @@ the original English. .. . . -.de TQ -. br -. ns -. TP \\$1 -.. -. -. .\" The BSD man macros can't handle " in arguments to font change macros, .\" so use \(ts instead of ". .tr \(ts" @@ -48,20 +42,11 @@ the original English. . . .SH NAME -@g@eqn \- format equations for troff +@g@eqn \- format equations for troff or MathML . . .SH SYNOPSIS -.nr a \n(.j -.ad l -.nr i \n(.i -.in +\w'\fB@g@eqn 'u -.ti \niu -.B @g@eqn -.de OP -. ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]" -. el .RB "[\ " "\\$1" "\ ]" -.. +.SY @g@eqn .OP \-rvCNR .OP \-d xy .OP \-T name @@ -70,9 +55,8 @@ the original English. .OP \-s n .OP \-p n .OP \-m n -.RI "[\ " files\|.\|.\|. "\ ]" -.br -.ad \na +.RI [ files\|.\|.\|. ] +.YS . .LP It is possible to have whitespace between a command line option and its @@ -97,11 +81,10 @@ The output of GNU .B eqn cannot be processed with Unix troff; it must be processed with GNU troff. -If no files are given on the command line, the standard input -will be read. +If no files are given on the command line, the standard input is read. A filename of .B \- -will cause the standard input to be read. +causes the standard input to be read. . .LP .B eqn @@ -116,7 +99,7 @@ and finally in the standard macro directory .BR @MACRODIR@ . If it exists, .B eqn -will process it before the other input files. +processes it before the other input files. The .B \-R option prevents this. @@ -130,6 +113,7 @@ it does not support low-resolution, typewriter-like devices . . .SH OPTIONS +. .TP .BI \-d xy Specify delimiters @@ -168,7 +152,7 @@ Only one size reduction. The minimum point-size is\~\c .IR n . .B eqn -will not reduce the size of subscripts or superscripts to +does not reduce the size of subscripts or superscripts to a smaller size than\~\c .IR n . . @@ -181,11 +165,11 @@ Normally, the only effect of this is to define a macro with a value of\~\c .BR 1 ; .B eqnrc -will use this to provide definitions appropriate for the output device. -However, if the specified device is "MathML", the output will be +uses this to provide definitions appropriate for the output device. +However, if the specified device is \[lq]MathML\[rq], the output is MathML markup rather than troff commands, and .B eqnrc -will not be loaded at all. +is not loaded at all. The default output device is .BR @DEVICE@ . . @@ -215,7 +199,7 @@ This is equivalent to a command. This option is deprecated. .B eqn -will normally set equations at whatever the current point size +normally sets equations at whatever the current point size is when the equation is encountered. . .TP @@ -226,8 +210,8 @@ points smaller than the surrounding text. This option is deprecated. Normally .B eqn -makes sets subscripts and superscripts at 70% -of the size of the surrounding text. +sets subscripts and superscripts at 70% of the size of the +surrounding text. . . .SH USAGE @@ -238,7 +222,7 @@ and Unix eqn are described here. GNU .B eqn emits Presentation MathML output when invoked with the -,B -T MathML +.B "-T\~MathML" option. . .LP @@ -358,11 +342,20 @@ subsection. . .SS New primitives .TP -.IB big\ e1 +.BI big\ e Enlarges the expression it modifies; intended to have semantics like -CSS 'large'. In troff output, the point size is increased by 5; in -MathML output, the expression is wrapped in an <mstyle mathsize='big'> -pair. +CSS `large'. +In troff output, the point size is increased by\~5; +in MathML output, the expression uses +. +.RS +.IP +.EX +<mstyle \%mathsize='big'> +.EE +.RE +. +.TP .IB e1\ smallover\ e2 This is similar to .BR over ; @@ -404,6 +397,7 @@ is defined as { type "operator" vcenter size +5 \e(*S } .RE . +.IP (Note that vcenter is silently ignored when generating MathML.) . .TP @@ -415,7 +409,7 @@ as an accent over .I e2 is assumed to be at the correct height for a lowercase letter; .I e2 -will be moved down according if +is moved down according to whether .I e1 is taller or shorter than a lowercase letter. For example, @@ -448,7 +442,7 @@ as an accent under .I e2 is assumed to be at the correct height for a character without a descender; .I e2 -will be moved down if +is moved down if .I e1 has a descender. .B utilde @@ -470,8 +464,7 @@ but .I text is not subject to macro expansion because it is quoted; .I text -will be split up and the spacing between individual characters -will be adjusted. +is split up and the spacing between individual characters is adjusted. . .TP .BI nosplit\ text @@ -485,10 +478,10 @@ This has the same effect as .IP but because .I text -is not quoted it will be subject to macro expansion; +is not quoted it is subject to macro expansion; .I text -will not be split up -and the spacing between individual characters will not be adjusted. +is not split up +and the spacing between individual characters is not adjusted. . .TP .IB e\ opprime @@ -504,14 +497,14 @@ with .B opprime the\~\c .B 1 -will be tucked under the prime as a subscript to the\~\c +is tucked under the prime as a subscript to the\~\c .B A (as is conventional in mathematical typesetting), whereas with .B prime the\~\c .B 1 -will be a subscript to the prime character. +is a subscript to the prime character. The precedence of .B opprime is the same as that of @@ -524,7 +517,7 @@ and .BR uaccent . In unquoted text a\~\c .B ' -that is not the first character will be treated like +that is not the first character is treated like .BR opprime . . .TP @@ -538,7 +531,7 @@ macro named When the macro is called, the string .B 0s -will contain the output for\~\c +contains the output for\~\c .IR e , and the number registers .BR 0w , @@ -547,7 +540,7 @@ and the number registers .BR 0skern , and .BR 0skew -will contain the width, height, depth, subscript kern, and skew of\~\c +contain the width, height, depth, subscript kern, and skew of\~\c .IR e . (The .I "subscript kern" @@ -558,7 +551,7 @@ of an object says how far to the right of the center of the object an accent over the object should be placed.) The macro must modify .B 0s -so that it will output the desired result with its origin at the current +so that it outputs the desired result with its origin at the current point, and increase the current horizontal position by the width of the object. The number registers must also be modified so that they correspond to the @@ -732,7 +725,7 @@ definitive. . TP .B minimum_size .B eqn -will not set anything at a smaller point-size than this. +doesn't set anything at a smaller point-size than this. The value is in points. . .TP @@ -742,14 +735,20 @@ The primitive emboldens an equation by overprinting two copies of the equation horizontally offset by this amount. -(This parameter is not used in MathML mode; instead, fat text is -wrapped in an <mstyle mathvariant='bold'> tag pair.) +This parameter is not used in MathML mode; instead, fat text uses +. +.RS +.IP +.EX +<mstyle mathvariant='bold'> +.EE +.RE . .TP .B over_hang -A fraction bar will be longer by twice this amount than +A fraction bar is longer by twice this amount than the maximum of the widths of the numerator and denominator; -in other words, it will overhang the numerator and +in other words, it overhangs the numerator and denominator by at least this amount. . .TP @@ -759,7 +758,7 @@ When or .B under is applied to a single character, -the line will be this long. +the line is this long. Normally, .B bar or @@ -774,7 +773,7 @@ Extensible delimiters produced with the .B left and .B right -primitives will have a combined height and depth of at least this many +primitives have a combined height and depth of at least this many thousandths of twice the maximum amount by which the sub-equation that the delimiters enclose extends away from the axis. . @@ -784,7 +783,7 @@ Extensible delimiters produced with the .B left and .B right -primitives will have a combined height and depth +primitives have a combined height and depth not less than the difference of twice the maximum amount by which the sub-equation that the delimiters enclose extends away from the axis @@ -837,29 +836,29 @@ escape sequence. .B num1 The .B over -command will shift up the numerator by at least this amount. +command shifts up the numerator by at least this amount. . .TP .B num2 The .B smallover -command will shift up the numerator by at least this amount. +command shifts up the numerator by at least this amount. . .TP .B denom1 The .B over -command will shift down the denominator by at least this amount. +command shifts down the denominator by at least this amount. . .TP .B denom2 The .B smallover -command will shift down the denominator by at least this amount. +command shifts down the denominator by at least this amount. . .TP .B sup1 -Normally superscripts will be shifted up by at least this amount. +Normally superscripts are shifted up by at least this amount. . .TP .B sup2 @@ -867,63 +866,63 @@ Superscripts within superscripts or upper limits or numerators of .B smallover fractions -will be shifted up by at least this amount. +are shifted up by at least this amount. This is usually less than sup1. . .TP .B sup3 Superscripts within denominators or square roots -or subscripts or lower limits will be shifted up by at least +or subscripts or lower limits are shifted up by at least this amount. This is usually less than sup2. . .TP .B sub1 -Subscripts will normally be shifted down by at least this amount. +Subscripts are normally shifted down by at least this amount. . .TP .B sub2 When there is both a subscript and a superscript, the subscript -will be shifted down by at least this amount. +is shifted down by at least this amount. . .TP .B sup_drop -The baseline of a superscript will be no more +The baseline of a superscript is no more than this much amount below the top of the object on which the superscript is set. . .TP .B sub_drop -The baseline of a subscript will be at least this much below +The baseline of a subscript is at least this much below the bottom of the object on which the subscript is set. . .TP .B big_op_spacing1 -The baseline of an upper limit will be at least this +The baseline of an upper limit is at least this much above the top of the object on which the limit is set. . .TP .B big_op_spacing2 -The baseline of a lower limit will be at least this +The baseline of a lower limit is at least this much below the bottom of the object on which the limit is set. . .TP .B big_op_spacing3 -The bottom of an upper limit will be at least this much above the +The bottom of an upper limit is at least this much above the top of the object on which the limit is set. . .TP .B big_op_spacing4 -The top of a lower limit will be at least this much below +The top of a lower limit is at least this much below the bottom of the object on which the limit is set. . .TP .B big_op_spacing5 -This much vertical space will be added above and below limits. +This much vertical space is added above and below limits. . .TP .B baseline_sep -The baselines of the rows in a pile or matrix will normally be +The baselines of the rows in a pile or matrix are normally this far apart. In most cases this should be equal to the sum of .B num1 @@ -933,21 +932,21 @@ and .TP .B shift_down The midpoint between the top baseline and the bottom baseline -in a matrix or pile will be shifted down by this much from the axis. +in a matrix or pile is shifted down by this much from the axis. In most cases this should be equal to .BR axis_height . . .TP .B column_sep -This much space will be added between columns in a matrix. +This much space is added between columns in a matrix. . .TP .B matrix_side_sep -This much space will be added at each side of a matrix. +This much space is added at each side of a matrix. . .TP .B draw_lines -If this is non-zero, lines will be drawn using the +If this is non-zero, lines are drawn using the .B \eD escape sequence, rather than with the .B \el @@ -958,7 +957,7 @@ character. .TP .B body_height The amount by which the height of the equation exceeds this -will be added as extra space before the line containing the equation +is added as extra space before the line containing the equation (using .BR \ex ). The default value is 85. @@ -966,7 +965,7 @@ The default value is 85. .TP .B body_depth The amount by which the depth of the equation exceeds this -will be added as extra space after the line containing the equation +is added as extra space after the line containing the equation (using .BR \ex ). The default value is 35. @@ -976,18 +975,18 @@ The default value is 35. If this is non-zero, then .B ndefine -will behave like +behaves like .B define and .B tdefine -will be ignored, +is ignored, otherwise .B tdefine -will behave like +behaves like .B define and .B ndefine -will be ignored. +is ignored. The default value is\~0 (This is typically changed to\~1 by the .B eqnrc @@ -1012,19 +1011,19 @@ In a macro body, where .I n is between 1 and\~9, -will be replaced by the +is replaced by the .IR n-th argument if the macro is called with arguments; if there are fewer than .I n\~\c -arguments, it will be replaced by nothing. +arguments, it is replaced by nothing. A word containing a left parenthesis where the part of the word before the left parenthesis has been defined using the .B define command -will be recognized as a macro call with arguments; +is recognized as a macro call with arguments; characters following the left parenthesis -up to a matching right parenthesis will be treated as comma-separated +up to a matching right parenthesis are treated as comma-separated arguments; commas inside nested parentheses do not terminate an argument. . @@ -1034,7 +1033,7 @@ This is like the .B define command, but .I name -will not be recognized if called with arguments. +is not recognized if called with arguments. . .TP .BI include\ \(ts file \(ts @@ -1052,7 +1051,7 @@ beginning with .B .EQ or .B .EN -will be ignored. +are ignored. . .TP .BI ifdef\ name\ X\ anything\ X @@ -1149,10 +1148,10 @@ You can control which characters are treated as letters command described above. A type of .B letter -will cause a character to be set in italic type. +causea a character to be set in italic type. A type of .B digit -will cause a character to be set in roman type. +causea a character to be set in roman type. . . .SH FILES @@ -1163,12 +1162,15 @@ Initialization file. .SH MATHML MODE LIMITATIONS MathML is designed on the assumption that it cannot know the exact physical characteristics of the media and devices on which it will -be rendered. It does not support fine control of motions and sizes -to the same degree troff does. Thus: +be rendered. +It does not support fine control of motions and sizes to the same +degree troff does. +Thus: +. .IP * .B eqn parameters have no effect on the generated MathML. -.LP +. .IP * The .BR special, @@ -1176,46 +1178,56 @@ The .BR down , .BR fwd , and -.BR back , -operations cannot be implemented, and will yield a -MathML <merror> message instead. +.B back +operations cannot be implemented, and yields a +MathML `<merror>' message instead. +. .IP * The .B vcenter keyword is silently ignored, as centering on the math axis is the MathML default. +. .IP * -Characters that eqn over troff sets extra large - notably the integral -sign - may appear too small and need to have their <mstyle> wrappers +Characters that +.B eqn +over troff sets extra large \(en notably the integral sign \(en +may appear too small and need to have their `<mstyle>' wrappers adjusted by hand. +. .LP As in its troff mode, .B eqn -in MathML mode leaves the .EQ and .EN delimiters in place for -displayed equations, but emits no explicit delimiters around -inline equations. They can, however, be recognized as strings -that begin with <math> and end with </math> and do not cross -line boundaries. +in MathML mode leaves the +.B .EQ +and +.B .EN +delimiters in place for displayed equations, but emits no explicit +delimiters around inline equations. +They can, however, be recognized as strings that begin with `<math>' +and end with `</math>' and do not cross line boundaries. +. .LP See the .B BUGS section for translation limits specific to .BR eqn . . +. .SH BUGS -Inline equations will be set at the point size that is current at the +Inline equations are set at the point size that is current at the beginning of the input line. . In MathML mode, the -.BR mark, +.B mark and .B lineup -features don't work. These could, in theory, be implemented with -<maligngroup> elements. +features don't work. +These could, in theory, be implemented with `<maligngroup>' elements. . In MathML mode, each digit of a numeric literal gets a separate -<mn></mn> pair and decimal points get an <mo></mo>. This is -allowed by the specification, but inefficient. +`<mn>\:</mn>' pair, and decimal points are tagged with `<mo>\:</mo>'. +This is allowed by the specification, but inefficient. . . .SH "SEE ALSO" |