[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: src/preproc/preconv/*: Improve the license information.
From: |
Bernd Warken |
Subject: |
[groff] 01/01: src/preproc/preconv/*: Improve the license information. |
Date: |
Wed, 17 Sep 2014 23:24:46 +0000 |
bwarken pushed a commit to branch master
in repository groff.
commit e375837773f99ea0de14ebebe5fb69e22b39fb28
Author: Bernd Warken <address@hidden>
Date: Thu Sep 18 01:24:39 2014 +0200
src/preproc/preconv/*: Improve the license information.
---
ChangeLog | 8 ++
src/preproc/pic/pic.man | 33 ++++----
src/preproc/preconv/Makefile.sub | 5 +-
src/preproc/preconv/preconv.cpp | 3 +-
src/preproc/preconv/preconv.man | 159 ++++++++++++++++++++++++++------------
5 files changed, 139 insertions(+), 69 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 491aeaf..b845765 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,9 +1,17 @@
2014-09-18 Bernd Warken <address@hidden>
+ * src/preproc/preconv/*: Improve the license information.
+
+2014-09-18 Bernd Warken <address@hidden>
+
* src/preproc/pic/*: Improve the license information.
2014-09-17 Bernd Warken <address@hidden>
+ * src/preproc/html/*: Improve the license information.
+
+2014-09-17 Bernd Warken <address@hidden>
+
* src/preproc/grn/*: Improve the license information.
2014-09-17 Bernd Warken <address@hidden>
diff --git a/src/preproc/pic/pic.man b/src/preproc/pic/pic.man
index bb8cb5f..e0c5d8f 100644
--- a/src/preproc/pic/pic.man
+++ b/src/preproc/pic/pic.man
@@ -105,7 +105,8 @@ is passed through without change.
.
.
.LP
-It is the user's responsibility to provide appropriate definitions of the
+It is the user\[aq]s responsibility to provide appropriate definitions
+of the
.B PS
and
.B PE
@@ -158,10 +159,10 @@ Unsafe mode; revert the default option
.
.TP
.B \-n
-Don't use the groff extensions to the troff drawing commands.
+Don\[aq]t use the groff extensions to the troff drawing commands.
.
-You should use this if you are using a postprocessor that doesn't support
-these extensions.
+You should use this if you are using a postprocessor that doesn\[aq]t
+support these extensions.
.
The extensions are described in
.BR groff_out (@MAN5EXT@).
@@ -307,7 +308,7 @@ would avoid this.
.
.LP
To make the vbox having a positive height and a depth of zero
-(as used e.g.\& by \*(lx's
+(as used e.g.\& by \*[lx]\[aq]s
.BR \%graphics.sty ),
define the following macro in your document:
.RS
@@ -392,7 +393,8 @@ For the multiplicative case,
.I expr3
must be greater than zero.
.
-If the constraints aren't met, the loop isn't executed.
+If the constraints aren\[aq]t met, the loop isn\[aq]t executed.
+.
.I X
can be any character not occurring in
.IR body .
@@ -756,8 +758,9 @@ For example
.RE
.LP
means draw a line 2\ inches long in the current direction.
-The `i' (or `I') character is ignored; to use another measurement unit,
-set the
+.
+The \[oq]i\[cq] (or \[oq]I\[cq]) character is ignored; to use another
+measurement unit, set the
.I scale
variable to an appropriate value.
.
@@ -852,8 +855,8 @@ The
.B xslanted
and
.B yslanted
-attributes specify the x and y\~offset of the box's upper right corner
-from its default position.
+attributes specify the x and y\~offset of the box\[aq]s upper right
+corner from its default position.
.
.
.LP
@@ -1003,7 +1006,7 @@ All three keywords expect a suffix specifying the color,
for example
.
.
.LP
-Currently, color support isn't available in \*(tx mode.
+Currently, color support isn\[aq]t available in \*(tx mode.
.
Predefined color names for
.B groff
@@ -1097,13 +1100,13 @@ and end points are coincident.
In places where
.IB n th
is allowed
-.BI ` expr 'th
+.BI \[oq] expr \[cq]th
is also allowed.
.
Note that
-.B 'th
+.B \[cq]th
is a single token: no space is allowed between the
-.B '
+.B \[cq]
and the
.BR th .
.
@@ -1112,7 +1115,7 @@ For example,
.ft B
.nf
for i = 1 to 4 do {
- line from `i'th box.nw to `i+1'th box.se
+ line from \[oq]i\[cq]th box.nw to \[oq]i+1\[cq]th box.se
}
.ft
.fi
diff --git a/src/preproc/preconv/Makefile.sub b/src/preproc/preconv/Makefile.sub
index 5dc3712..23f7393 100644
--- a/src/preproc/preconv/Makefile.sub
+++ b/src/preproc/preconv/Makefile.sub
@@ -2,10 +2,7 @@
#
# File position: <groff-source>/src/preproc/preconv/Makefile.sub
#
-# Copyright (C) 2014
-# Free Software Foundation, Inc.
-#
-# Last update: 2 Sep 2014
+# Copyright (C) 2014 Free Software Foundation, Inc.
#
# This file is part of `font utf8' which is part of `groff'.
#
diff --git a/src/preproc/preconv/preconv.cpp b/src/preproc/preconv/preconv.cpp
index d09fc1c..e965fca 100644
--- a/src/preproc/preconv/preconv.cpp
+++ b/src/preproc/preconv/preconv.cpp
@@ -1,6 +1,5 @@
// -*- C++ -*-
-/* Copyright (C) 2005, 2006, 2008, 2009
- Free Software Foundation, Inc.
+/* Copyright (C) 2005-2014 Free Software Foundation, Inc.
Written by Werner Lemberg (address@hidden)
This file is part of groff.
diff --git a/src/preproc/preconv/preconv.man b/src/preproc/preconv/preconv.man
index 87ad067..4d4b768 100644
--- a/src/preproc/preconv/preconv.man
+++ b/src/preproc/preconv/preconv.man
@@ -1,5 +1,11 @@
-.ig
-Copyright (C) 2006-2009, 2014 Free Software Foundation, Inc.
+.TH PRECONV @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
+.SH NAME
+preconv \- convert encoding of input files to something GNU troff understands
+.
+.
+.\" license (copying)
+.de co
+Copyright (C) 2006-2014 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -17,14 +23,10 @@ translations approved by the Free Software Foundation
instead of in
the original English.
..
.
-.TH PRECONV @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
-.
-.
-.SH NAME
-preconv \- convert encoding of input files to something GNU troff understands
-.
-.
+.\" --------------------------------------------------------------------
.SH SYNOPSIS
+.\" --------------------------------------------------------------------
+.
.SY preconv
.OP \-dr
.OP \-e encoding
@@ -42,22 +44,28 @@ preconv \- convert encoding of input files to something GNU
troff understands
.B \-\-version
.YS
.
+.
.PP
It is possible to have whitespace between the
.B \-e
command line option and its parameter.
.
.
+.\" --------------------------------------------------------------------
.SH DESCRIPTION
+.\" --------------------------------------------------------------------
+.
.B preconv
reads
.I files
and converts its encoding(s) to a form GNU
.BR troff (@MAN1EXT@)
can process, sending the data to standard output.
-Currently, this means ASCII characters and `\e[uXXXX]' entities, where
-`XXXX' is a hexadecimal number with four to six digits, representing a
-Unicode input code.
+.
+Currently, this means ASCII characters and \[oq]\e[uXXXX]\[cq]
+entities, where \[oq]XXXX\[cq] is a hexadecimal number with four to
+six digits, representing a Unicode input code.
+.
Normally,
.B preconv
should be invoked with the
@@ -68,7 +76,10 @@ options of
.BR groff .
.
.
+.\" --------------------------------------------------------------------
.SH OPTIONS
+.\" --------------------------------------------------------------------
+.
.TP
.B \-d
Emit debugging messages to standard error (mainly the used encoding).
@@ -80,10 +91,12 @@ Specify default encoding if everything fails (see below).
.TP
.BI \-e encoding
Specify input encoding explicitly, overriding all other methods.
+.
This corresponds to
-.BR groff 's
+.BR groff \[aq]s
.BI \-K encoding
option.
+.
Without this switch,
.B preconv
uses the algorithm described below to select the input encoding.
@@ -105,7 +118,10 @@ Do not add \&.lf requests.
Print version number.
.
.
+.\" --------------------------------------------------------------------
.SH USAGE
+.\" --------------------------------------------------------------------
+.
.B preconv
tries to find the input encoding with the following algorithm.
.
@@ -118,19 +134,22 @@ use it.
Otherwise, check whether the input starts with a
.I Byte Order Mark
(BOM, see below).
+.
If found, use it.
.
.IP 3.
Finally, check whether there is a known
.I coding tag
(see below) in either the first or second input line.
+.
If found, use it.
.
.IP 4.
If everything fails, use a default encoding as given with option
.BR \-D ,
-by the current locale, or `latin1' if the locale is set to `C',
-`POSIX', or empty (in that order).
+by the current locale, or \[oq]latin1\[cq] if the locale is set to
+\[oq]C\[cq], \[oq]POSIX\[cq], or empty (in that order).
+.
.
.PP
Note that the
@@ -140,36 +159,52 @@ program supports a
environment variable which is eventually expanded to option
.BR \-k .
.
+.
+.\" --------------------------------------------------------------------
.SS "Byte Order Mark"
+.\" --------------------------------------------------------------------
+.
The Unicode Standard defines character U+FEFF as the Byte Order Mark
(BOM).
+.
On the other hand, value U+FFFE is guaranteed not be a Unicode character at
all.
+.
This allows to detect the byte order within the data stream (either
-big-endian or lower-endian), and the MIME encodings \%`UTF-16' and
-\%`UTF-32' mandate that the data stream starts with U+FEFF.
-Similarly, the data stream encoded as \%`UTF-8' might start with a BOM (to
-ease the conversion from and to \%UTF-16 and \%UTF-32).
+big-endian or lower-endian), and the MIME encodings \%\[oq]UTF-16\[cq]
+and \%\[oq]UTF-32\[cq] mandate that the data stream starts with U+FEFF.
+.
+Similarly, the data stream encoded as \%\[oq]UTF-8\[cq] might start
+with a BOM (to ease the conversion from and to \%UTF-16 and \%UTF-32).
+.
In all cases, the byte order mark is
.I not
part of the data but part of the encoding protocol; in other words,
-.BR preconv 's
-output doesn't contain it.
+.BR preconv \[aq]s
+output doesn\[aq]t contain it.
+.
.
.PP
-Note that U+FEFF not at the start of the input data actually is emitted;
-it has then the meaning of a `zero width no-break space' character \[en]
-something not needed normally in
+Note that U+FEFF not at the start of the input data actually is
+emitted; it has then the meaning of a \[oq]zero width no-break
+space\[cq] character \[en] something not needed normally in
.BR groff .
.
+.
+.\" --------------------------------------------------------------------
.SS "Coding Tags"
+.\" --------------------------------------------------------------------
+.
Editors which support more than a single character encoding need tags
-within the input files to mark the file's encoding.
+within the input files to mark the file\[aq]s encoding.
+.
While it is possible to guess the right input encoding with the help of
heuristic algorithms for data which represents a greater amount of a natural
language, it is still just a guess.
+.
Additionally, all algorithms fail easily for input which is either too short
-or doesn't represent a natural language.
+or doesn\[aq]t represent a natural language.
+.
.
.PP
For these reasons,
@@ -180,6 +215,7 @@ and
.B XEmacs
(and probably other programs too).
.
+.
.PP
Coding tags in
.B "GNU Emacs"
@@ -187,6 +223,7 @@ and
.B XEmacs
are stored in so-called
.IR "File Variables" .
+.
.B preconv
recognizes the following syntax form which must be put into a troff comment
in the first or second line.
@@ -201,10 +238,12 @@ in the first or second line.
\&.\|.\|.\& \-*\-
.RE
.
+.
.PP
The only relevant tag for
.B preconv
-is `coding' which can take the values listed below.
+is \[oq]coding\[cq] which can take the values listed below.
+.
Here an example line which tells
.B Emacs
to edit a file in troff mode, and to use \%latin2 as its encoding.
@@ -212,10 +251,11 @@ to edit a file in troff mode, and to use \%latin2 as its
encoding.
.RS
.PP
.EX
-\&.\[rs]" \-*\- mode: troff; coding: latin-2 \-*\-
+\&.\[rs]" \-*\- mode: troff; coding: latin-2 \-*\-\""
.EE
.RE
.
+.
.PP
The following list gives all MIME coding tags (either lowercase or
uppercase) supported by
@@ -225,43 +265,49 @@ this list is hard-coded in the source.
.RS
.PP
.ad l
-\%big5, \%cp1047, \%euc-jp, \%euc-kr, \%gb2312, \%iso-8859-1, \%iso-8859-2,
-\%iso-8859-5, \%iso-8859-7, \%iso-8859-9, \%iso-8859-13, \%iso-8859-15,
-\%koi8-r, \%us-ascii, \%utf-8, \%utf-16, \%utf-16be, \%utf-16le
+\%big5, \%cp1047, \%euc-jp, \%euc-kr, \%gb2312, \%iso-8859-1,
+\%iso-8859-2, \%iso-8859-5, \%iso-8859-7, \%iso-8859-9, \%iso-8859-13,
+\%iso-8859-15, \%koi8-r, \%us-ascii, \%utf-8, \%utf-16, \%utf-16be,
+\%utf-16le
.ad
.RE
.
+.
.PP
-In addition, the following hard-coded list of other tags is recognized which
-eventually map to values from the list above.
+In addition, the following hard-coded list of other tags is recognized
+which eventually map to values from the list above.
.
.RS
.PP
.ad l
\%ascii, \%chinese-big5, \%chinese-euc, \%chinese-iso-8bit, \%cn-big5,
\%\%cn-gb, \%cn-gb-2312, \%cp878, \%csascii, \%csisolatin1,
-\%cyrillic-iso-8bit, \%cyrillic-koi8, \%euc-china, \%euc-cn, \%euc-japan,
-\%euc-japan-1990, \%euc-korea, \%greek-iso-8bit, \%iso-10646/utf8,
-\%iso-10646/utf-8, \%iso-latin-1, \%iso-latin-2, \%iso-latin-5,
-\%iso-latin-7, \%iso-latin-9, \%japanese-euc, \%japanese-iso-8bit, \%jis8,
-\%koi8, \%korean-euc, \%korean-iso-8bit, \%latin-0, \%latin1, \%latin-1,
-\%latin-2, \%latin-5, \%latin-7, \%latin-9, \%mule-utf-8, \%mule-utf-16,
-\%mule-utf-16be, \%mule-utf-16-be, \%mule-utf-16be-with-signature,
-\%mule-utf-16le, \%mule-utf-16-le, \%mule-utf-16le-with-signature, \%utf8,
-\%utf-16-be, \%utf-16-be-with-signature, \%utf-16be-with-signature,
-\%utf-16-le, \%utf-16-le-with-signature, \%utf-16le-with-signature
+\%cyrillic-iso-8bit, \%cyrillic-koi8, \%euc-china, \%euc-cn,
+\%euc-japan, \%euc-japan-1990, \%euc-korea, \%greek-iso-8bit,
+\%iso-10646/utf8, \%iso-10646/utf-8, \%iso-latin-1, \%iso-latin-2,
+\%iso-latin-5, \%iso-latin-7, \%iso-latin-9, \%japanese-euc,
+\%japanese-iso-8bit, \%jis8, \%koi8, \%korean-euc, \%korean-iso-8bit,
+\%latin-0, \%latin1, \%latin-1, \%latin-2, \%latin-5, \%latin-7,
+\%latin-9, \%mule-utf-8, \%mule-utf-16, \%mule-utf-16be,
+\%mule-utf-16-be, \%mule-utf-16be-with-signature, \%mule-utf-16le,
+\%mule-utf-16-le, \%mule-utf-16le-with-signature, \%utf8, \%utf-16-be,
+\%utf-16-be-with-signature, \%utf-16be-with-signature, \%utf-16-le,
+\%utf-16-le-with-signature, \%utf-16le-with-signature
.ad
.RE
.
+.
.PP
Those tags are taken from
.B "GNU Emacs"
and
.BR XEmacs ,
together with some aliases.
-Trailing \%`-dos', \%`-unix', and \%`-mac' suffixes of coding tags (which
-give the end-of-line convention used in the file) are stripped off before
-the comparison with the above tags happens.
+.
+Trailing \%\[oq]-dos\[cq], \%\[oq]-unix\[cq], and \%\[oq]-mac\[cq]
+suffixes of coding tags (which give the end-of-line convention used in
+the file) are stripped off before the comparison with the above tags
+happens.
.
.SS "Iconv Issues"
.B preconv
@@ -269,23 +315,31 @@ by itself only supports three encodings: \%latin-1,
cp1047, and \%UTF-8;
all other encodings are passed to the
.B iconv
library functions.
+.
At compile time it is searched and checked for a valid
.B iconv
-implementation; a call to `preconv \-\-version' shows whether
+implementation; a call to \[oq]preconv \-\-version\[cq] shows whether
.B iconv
is used.
.
.
+.\" --------------------------------------------------------------------
.SH BUGS
+.\" --------------------------------------------------------------------
+.
.B preconv
-doesn't support
+doesn\[aq]t support
.I "local variable lists"
yet.
+.
This is a different syntax form to specify local variables at the end of a
file.
.
.
+.\" --------------------------------------------------------------------
.SH "SEE ALSO"
+.\" --------------------------------------------------------------------
+.
.BR groff (@MAN1EXT@)
.br
the
@@ -294,6 +348,15 @@ and
.B XEmacs
info pages
.
+.
+.\" --------------------------------------------------------------------
+.SH COPYING
+.\" --------------------------------------------------------------------
+.
+.co
+.
+.
+.\" Emacs setting
.\" Local Variables:
.\" mode: nroff
.\" End:
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: src/preproc/preconv/*: Improve the license information.,
Bernd Warken <=