diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2022-10-20 06:36:25 -0500 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2022-10-21 21:02:54 -0500 |
commit | 7ae13b8817df5a4c9dc4f4d3c5793973ec8c2d1a (patch) | |
tree | 26427bdad33a11ae844a42dbf95628afbf5a9513 /PROBLEMS | |
parent | 3453d8512cc44383e7554b0a85e94f5137584028 (diff) | |
download | groff-git-7ae13b8817df5a4c9dc4f4d3c5793973ec8c2d1a.tar.gz |
PROBLEMS: Update advice re: a clever man(7) trick.
Diffstat (limited to 'PROBLEMS')
-rw-r--r-- | PROBLEMS | 24 |
1 files changed, 15 insertions, 9 deletions
@@ -248,25 +248,31 @@ in the \n[rst] and \n[rsb] registers; these are groff extensions. ---------------------------------------------------------------------- * While formatting a manual page, groff complains about not being able - to break lines. The problem seems to be caused by a line like: - .TP \w'label'+2 + to break lines. A line like the following seems to cause this. + .TP \w'label'+2 -The -man documentation says that the default scaling indicator for TP -macro is `n'. The groff -man macros implement this correctly, so that -the argument is evaluated as if it were +The groff_man(7) man page says that the default scaling unit for the +`TP` macro is 'n' (ens), and that is how the groff man macros are +implemented. Consequently, the macro argument above is evaluated +equivalently to this expression. \w'label'n+2n -The Unix -man macros don't implement this correctly (probably because -it's hard to do in Unix troff); they just append `n' to the entire -argument, so that it is evaluated as if it were +AT&T troff's man macros don't implement this correctly (probably because +it's hard to do in that troff); instead, they append 'n' to the entire +argument, so that it is evaluated as if it were written as follows. \w'label'u+2n -The solution is to fix the manual page: +The solution is to fix the manual page. .TP \w'label'u+2 +It might be better still to avoid such computations in macro arguments, +however; programs that are not *roff formatters that attempt to +interpret man pages can lack the ability to interpret numeric +expressions. See section "Portability" of groff_man_style(7). + ---------------------------------------------------------------------- * I'm having problems formatting man pages produced by the perl |