Turn on -Tutf8 in the frontend. Here we go!

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 25b07f26b16cc9d6cbd4a151bc604d4d2baf3095..7cf9ca5c9b2f5cf4bb17c6cbff2b0d68a6278e73 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc.1,v 1.83 2010/12/20 13:57:49 kristaps Exp $
+.\"    $Id: mandoc.1,v 1.88 2011/05/20 15:51:18 kristaps Exp $

 .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\"
 .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"


@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: December 20 2010 $
+.Dd $Mdocdate: May 20 2011 $

 .Dt MANDOC 1
 .Os
 .Sh NAME
 .Dt MANDOC 1
 .Os
 .Sh NAME


@@ -158,6 +158,15 @@ utility accepts the following
 .Fl T
 arguments, which correspond to output modes:
 .Bl -tag -width Ds
 .Fl T
 arguments, which correspond to output modes:
 .Bl -tag -width Ds

+.It Fl T Ns Cm utf8
+Encode output in the UTF-8 multi-byte format.
+See
+.Xr UTF-8 Output .
+.It Fl T Ns Cm locale
+Encode output using the current
+.Xr locale 1 .
+See
+.Sx Locale Output .

 .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output.
 This is the default.
 .It Fl T Ns Cm ascii
 Produce 7-bit ASCII output.
 This is the default.


@@ -189,6 +198,23 @@ See
 .Pp
 If multiple input files are specified, these will be processed by the
 corresponding filter in-order.
 .Pp
 If multiple input files are specified, these will be processed by the
 corresponding filter in-order.

+.Ss UTF-8 Output
+Use
+.Fl T Ns Cm utf8
+to force a UTF-8 locale.
+See
+.Sx Locale Output
+for details and options.
+.Ss Locale Output
+Locale-depending output encoding is triggered with
+.Fl T Ns Cm locale .
+This option is not available on all systems: systems without locale
+support, or those whose internal representation is not natively UCS-4,
+will fall back to
+.Fl T Ns Cm ascii .
+See
+.Sx ASCII Output
+for font style specification and available command-line arguments.

 .Ss ASCII Output
 Output produced by
 .Fl T Ns Cm ascii ,
 .Ss ASCII Output
 Output produced by
 .Fl T Ns Cm ascii ,


@@ -209,6 +235,9 @@ Emboldened characters are rendered as
 The special characters documented in
 .Xr mandoc_char 7
 are rendered best-effort in an ASCII equivalent.
 The special characters documented in
 .Xr mandoc_char 7
 are rendered best-effort in an ASCII equivalent.

+If no equivalent is found,
+.Sq \&?
+is used instead.

 .Pp
 Output width is limited to 78 visible columns unless literal input lines
 exceed this limit.
 .Pp
 Output width is limited to 78 visible columns unless literal input lines
 exceed this limit.


@@ -460,6 +489,13 @@ Each input and output format is separately noted.
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It
 .Ss ASCII Compatibility
 .Bl -bullet -compact
 .It

+Unrenderable unicode codepoints specified with
+.Sq \e[uNNNN]
+escapes are printed as
+.Sq \&?
+in mandoc.
+In GNU troff, these raise an error.
+.It

 The
 .Sq \&Bd \-literal
 and
 The
 .Sq \&Bd \-literal
 and


@@ -470,7 +506,7 @@ in
 .Fl T Ns Cm ascii
 are synonyms, as are \-filled and \-ragged.
 .It
 .Fl T Ns Cm ascii
 are synonyms, as are \-filled and \-ragged.
 .It

-In GNU troff, the
+In historic GNU troff, the

 .Sq \&Pa
 .Xr mdoc 7
 macro does not underline when scoped under an
 .Sq \&Pa
 .Xr mdoc 7
 macro does not underline when scoped under an


@@ -495,8 +531,6 @@ macro in
 has no effect.
 .It
 Words aren't hyphenated.
 has no effect.
 .It
 Words aren't hyphenated.

-.It
-Sentences are unilaterally monospaced.

 .El
 .Ss HTML/XHTML Compatibility
 .Bl -bullet -compact
 .El
 .Ss HTML/XHTML Compatibility
 .Bl -bullet -compact


@@ -529,9 +563,12 @@ and
 lists render similarly.
 .El
 .Sh SEE ALSO
 lists render similarly.
 .El
 .Sh SEE ALSO

+.Xr eqn 7 ,

 .Xr man 7 ,
 .Xr mandoc_char 7 ,
 .Xr man 7 ,
 .Xr mandoc_char 7 ,

-.Xr mdoc 7
+.Xr mdoc 7 ,
+.Xr roff 7 ,
+.Xr tbl 7

 .Sh AUTHORS
 The
 .Nm
 .Sh AUTHORS
 The
 .Nm