diff options
author | Junio C Hamano <gitster@pobox.com> | 2009-10-31 06:05:54 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2009-10-31 06:05:54 +0300 |
commit | 92246f6bcf41f1287009e73fc501c36ae9fdeeb4 (patch) | |
tree | 9e10252ce0ac2f502b51e51087189e83575448ce | |
parent | b7eb912b0d3352d43a11c79fab97cd7f92f0646e (diff) | |
parent | 204d363f5a05bba0bdeb13f96a08d5078dcee820 (diff) |
Merge branch 'tr/maint-roff-quote'
* tr/maint-roff-quote:
Quote ' as \(aq in manpages
-rw-r--r-- | Documentation/Makefile | 8 | ||||
-rw-r--r-- | Documentation/manpage-quote-apos.xsl | 16 | ||||
-rw-r--r-- | Makefile | 4 |
3 files changed, 28 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 06b0c57b95..cd5b4396db 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -103,6 +103,14 @@ ifdef DOCBOOK_SUPPRESS_SP XMLTO_EXTRA += -m manpage-suppress-sp.xsl endif +# If your target system uses GNU groff, it may try to render +# apostrophes as a "pretty" apostrophe using unicode. This breaks +# cut&paste, so you should set GNU_ROFF to force them to be ASCII +# apostrophes. Unfortunately does not work with non-GNU roff. +ifdef GNU_ROFF +XMLTO_EXTRA += -m manpage-quote-apos.xsl +endif + SHELL_PATH ?= $(SHELL) # Shell quote; SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) diff --git a/Documentation/manpage-quote-apos.xsl b/Documentation/manpage-quote-apos.xsl new file mode 100644 index 0000000000..aeb8839f33 --- /dev/null +++ b/Documentation/manpage-quote-apos.xsl @@ -0,0 +1,16 @@ +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + +<!-- work around newer groff/man setups using a prettier apostrophe + that unfortunately does not quote anything when cut&pasting + examples to the shell --> +<xsl:template name="escape.apostrophe"> + <xsl:param name="content"/> + <xsl:call-template name="string.subst"> + <xsl:with-param name="string" select="$content"/> + <xsl:with-param name="target">'</xsl:with-param> + <xsl:with-param name="replacement">\(aq</xsl:with-param> + </xsl:call-template> +</xsl:template> + +</xsl:stylesheet> @@ -159,6 +159,10 @@ all:: # Define ASCIIDOC_NO_ROFF if your DocBook XSL escapes raw roff directives # (versions 1.72 and later and 1.68.1 and earlier). # +# Define GNU_ROFF if your target system uses GNU groff. This forces +# apostrophes to be ASCII so that cut&pasting examples to the shell +# will work. +# # Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's # MakeMaker (e.g. using ActiveState under Cygwin). # |