mandoc/preconv.1 - diff

Return to preconv.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/preconv.1 between version 1.2 and 1.7

version 1.2, 2011/05/26 12:14:46

version 1.7, 2013/07/13 19:41:16

Line 38 or other troff system supporting the

escape sequence

.Pc

input.

.Pp

By default, it parses from standard output, determining encoding as

described in

.Sx Algorithm .

.Pp

Its arguments are as follows:

.Bl -tag -width Ds

.It Fl D Ar enc

The default encoding.

This is case-insensitive.

See

.Sx Algorithm

and

.Sx Encodings .

.It Fl e Ar enc

The document's encoding.

This is case-insensitive.

See

.Sx Algorithm

and

.Sx Encodings .

.It Ar file

The input file.

.El

.Pp

The recoded input is written to standard output: Unicode characters in

.Ar file

the ASCII range are printed as regular ASCII characters, while those

is not provided,

above this range are printed using the

.Nm

accepts standard input.

Output is written to standard output.

Unicode characters in the ASCII range are printed as regular ASCII

characters; those above this range are printed using the

.Sq \e[uNNNN]

format documented in

.Xr mandoc_char 7 .

.Pp

If input bytes are improperly formed in the current encoding, they're

passed unmodified to standard output.

.Ss Encodings

For some encodings, such as UTF-8, unrecoverable input sequences will

The

cause

.Nm

utility accepts the

to stop processing and exit.

.Ar utf\-8 ,

.Ar us\-ascii ,

and

.Ar latin\-1

encodings as arguments to

.Fl D Ar enc

.Fl e Ar enc .

.Ss Algorithm

An encoding is chosen according to the following steps:

.Bl -enum

Line 91 An encoding is chosen according to the following steps

Line 73 An encoding is chosen according to the following steps

From the argument passed to

.Fl e Ar enc .

.It

If a BOM exists, utf\-8 encoding is selected.

If a BOM exists, UTF\-8 encoding is selected.

.It

From the coding tags parsed from

.Qq File Variables

on the first two lines of input.

A file variable is an input line of the form

.Pp

.Dl \%.\e\(dq -*- key: val [; key: val ]* -*-

.Pp

A coding tag variable is where

.Cm key

.Qq coding

and

.Cm val

is the name of the encoding.

A typical file variable with a coding tag is

.Pp

.Dl \%.\e\(dq -*- mode: troff; coding: utf-8 -*-

.It

From the argument passed to

.Fl D Ar enc .

.It

If all else fails, Latin\-1 is used.

.El

.Pp

The

.Nm

utility recognises the UTF\-8, us\-ascii, and latin\-1 encodings as

passed to the

.Fl e

and

.Fl D

arguments, or as coding tags.

Encodings are matched case-insensitively.

.\" .Sh IMPLEMENTATION NOTES

.\" Not used in OpenBSD.

.\" .Sh RETURN VALUES

Line 107 If all else fails, Latin\-1 is used.

Line 117 If all else fails, Latin\-1 is used.

.\" .Sh FILES

.Sh EXIT STATUS

.Ex -std

.\" .Sh EXAMPLES

.Sh EXAMPLES

Explicitly page a UTF\-8 manual

.Pa foo.1

in the current locale:

.Pp

.Dl $ preconv \-e utf\-8 foo.1 | mandoc -Tlocale | less

.\" .Sh DIAGNOSTICS

.\" For sections 1, 4, 6, 7, & 8 only.

.\" .Sh ERRORS

Line 135 utility appeared in May 2011.

Line 150 utility appeared in May 2011.

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@bsd.lv .

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.\" .Sh CAVEATS

.\" .Sh BUGS

.\" .Sh SECURITY CONSIDERATIONS

CVSweb