☰

如何使用粗体等转义码生成联机帮助页？

tag-icon • tag-icon man less groff roff
如何使用粗体等转义码生成联机帮助页？

检查时的源代码less，我注意到包含的联机帮助页 ( less.man) 使用终端转义码来显示粗体文本：

^[[1mNAME^[[0m
       less - opposite of more

^[[1mSYNOPSIS^[[0m
       ^[[1mless -?^[[0m
       ^[[1mless --help^[[0m
       ^[[1mless -V^[[0m
       ^[[1mless --version^[[0m
       ^[[1mless [-[+]aABcCdeEfFgGiIJKLmMnNqQrRsSuUVwWX~]^[[0m

用于生成的命令显然是nroff -man：

$ head Makefile.aut 
# Makefile for authoring less.

EMAIL = [email protected]
HOMEPAGE = http://www.greenwoodsoftware.com/less
SHELL = /bin/sh
RCS = rcs
NROFF = nroff -man

然而，如果我运行nroff -man less.nro，我会使用退格键获得（通常的）联机帮助页输出：

N^HNA^HAM^HME^HE
       less - opposite of more

S^HSY^HYN^HNO^HOP^HPS^HSI^HIS^HS
       l^Hle^Hes^Hss^Hs -^H-?^H?
       l^Hle^Hes^Hss^Hs -^H--^H-h^Hhe^Hel^Hlp^Hp
       l^Hle^Hes^Hss^Hs -^H-V^HV
       l^Hle^Hes^Hss^Hs -^H--^H-v^Hve^Her^Hrs^Hsi^Hio^Hon^Hn

如何生成第一个表格？

答案1

“第一形式”是......的特征groff。如果您的“nroff”不是 的包装groff，您将只能看到第二种形式。

手册页中提到了该功能grotty（用于类似打字机的设备的 groff 驱动程序）：

默认情况下， 糟糕的 发出 SGR 转义序列（来自 ISO 6429，也称为 ANSI 颜色转义）来更改文本属性（粗体、斜体、颜色）。这使得可以有八种不同的背景背景色和前景色；此外，还可以使用粗体和斜体属性同时 （使用 BI 字体）。

在实践中，它效果不佳，例如，看看相同的注释（后处理这些序列）是如何的此处误传:

默认情况下，糟糕的发出 SGR 转义序列（来自 ISO 6429，也称为 ANSI 颜色转义）来更改文本属性（粗体、斜体、颜色）。这使得有可能有​​八种不同的M[绿色]背景M[]和m[红色]前景m[]颜色;此外，还可以使用粗体和斜体属性BI]同时]（使用 BI 字体）。

因此，一些开发人员选择不使用它（例如，这次讨论来自 Emacs 邮件列表）。

然而，正如手册页所说“默认情况下”。所以，如果你有 groff，那么它应该生成那些转义序列。

打包者可以应用补丁来修改程序。 @muru 的评论提到了 Debian 中的版本（请参阅错误报告和包装页）。包变更日志是这样说的：

 -- Colin Watson <[email protected]>  Sat, 27 Jul 2002 18:41:46 +0100
groff (1.18-1) unstable; urgency=low 

  * Disable the new ANSI colour/bold/underline escapes in nroff mode,
    because most pagers either fail to cope with it or need special options
    to do so. It can be re-enabled by editing /etc/groff/man.local and
    /etc/groff/mdoc.local, or by setting the environment variable GROFF_SGR
    to something non-empty.

然而，groff 来源没有提到GROFF_SGR;它只引用了GROFF_NO_SGR:

./NEWS:1108:  for the GROFF_NO_SGR environment variable also.
./NEWS:1450:o If the environment variable GROFF_NO_SGR is set, SGR output is disa...
./PROBLEMS:33:  1. Set the GROFF_NO_SGR environment variable.
./doc/webpage.ms:1920:.  URL #GROFF_NO_SGR GROFF_NO_SGR
./doc/webpagewebpage.ms:1922:. nop GROFF_NO_SGR
./doc/webpagewebpage.ms:2437:.TAG GROFF_NO_SGR        
./doc/webpagewebpage.ms:2439:If the environment variable GROFF_NO_SGR is set, SGR output is 
./src/devices/grotty/grotty.man:126:.B GROFF_NO_SGR
./src/devices/grotty/grotty.man:394:.B GROFF_NO_SGR
./src/devices/grotty/tty.cpp:864:  if (getenv("GROFF_NO_SGR"))

并且更改日志（ChangeLog.118）没有给出任何线索：

2002-02-12  Werner LEMBERG  <[email protected]>

        * src/libs/libgroff/Makefile.sub (snprintf.o): Don't use
        $(COMPILE.c) to not include groff's assert.h.        
        * src/drivers/grotty/tty.cc (main): Add GROFF_NO_SGR environment
        variable.                           
        * NEWS, src/drivers/grotty/grotty.man: Document it.

设置GROFF_NO_SGR不会给出 SGR 序列（手册页是正确的）。Debian 变更日志注释引用了 中的这个块/etc/groff/man.local，其中 Debian 添加了对变量的检查GROFF_SGR：

.  \" Debian: Disable the use of SGR (ANSI colour) escape sequences by
.  \" grotty. 
.  if '\V[GROFF_SGR]'' \
.    output x X tty: sgr 0

设置环境变量确实会生成粗体的 SGR 序列等。

相关内容