diff options
Diffstat (limited to 'Build/source/libs/teckit/TECkit-src/docs')
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/Makefile.am | 4 | ||||
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/TECkit_Binary_Format.pdf | bin | 0 -> 506905 bytes | |||
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/TECkit_Language.pdf | bin | 0 -> 437872 bytes | |||
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/TECkit_Tools.pdf | bin | 0 -> 293255 bytes | |||
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/sfconv.1 | 48 | ||||
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/teckit_compile.1 | 28 | ||||
-rw-r--r-- | Build/source/libs/teckit/TECkit-src/docs/txtconv.1 | 50 |
7 files changed, 130 insertions, 0 deletions
diff --git a/Build/source/libs/teckit/TECkit-src/docs/Makefile.am b/Build/source/libs/teckit/TECkit-src/docs/Makefile.am new file mode 100644 index 00000000000..8d435bcff5a --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/Makefile.am @@ -0,0 +1,4 @@ +dist_man1_MANS = teckit_compile.1 txtconv.1 sfconv.1 +EXTRA_DIST = TECkit_Binary_Format.pdf +EXTRA_DIST += TECkit_Language.pdf +EXTRA_DIST += TECkit_Tools.pdf diff --git a/Build/source/libs/teckit/TECkit-src/docs/TECkit_Binary_Format.pdf b/Build/source/libs/teckit/TECkit-src/docs/TECkit_Binary_Format.pdf Binary files differnew file mode 100644 index 00000000000..a7492863bd3 --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/TECkit_Binary_Format.pdf diff --git a/Build/source/libs/teckit/TECkit-src/docs/TECkit_Language.pdf b/Build/source/libs/teckit/TECkit-src/docs/TECkit_Language.pdf Binary files differnew file mode 100644 index 00000000000..d2239a48bb7 --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/TECkit_Language.pdf diff --git a/Build/source/libs/teckit/TECkit-src/docs/TECkit_Tools.pdf b/Build/source/libs/teckit/TECkit-src/docs/TECkit_Tools.pdf Binary files differnew file mode 100644 index 00000000000..142a4ed8e32 --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/TECkit_Tools.pdf diff --git a/Build/source/libs/teckit/TECkit-src/docs/sfconv.1 b/Build/source/libs/teckit/TECkit-src/docs/sfconv.1 new file mode 100644 index 00000000000..667804d6067 --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/sfconv.1 @@ -0,0 +1,48 @@ +.TH SFCONV 1 "2015-11-13" "TECkit" +.SH NAME +sfconv \- A tool for converting the encoding of Standard Format (SF) files +.SH SYNOPSIS +.SS "8-bit to Unicode:" +.TP +sfconv \fB\-8u\fR [\-utf8|\-be|\-le] [\-bom] \fB\-c\fR ControlFile [\-d MappingDirectory] \fB\-i\fR InFile \fB\-o\fR OutFile +.SS "Unicode to 8-bit:" +.TP +sfconv \fB\-u8\fR [\-utf8|\-be|\-le] \fB\-c\fR ControlFile [\-d MappingDirectory] \fB\-i\fR InFile \fB\-o\fR OutFile +.SH "DESCRIPTION" +A tool for converting Standard Format (SF) files is included in the current TECkit package. +This is \fBsfconv\fR , a command-line tool that uses an XML “control file” to specify the +mappings associated with the various markers in an SF file. Note that the current SFconv tool +should be considered a prototype rather than a full solution to the issue of SF conversions. A +more complete tool with an improved user interface would be desirable. +.SH "OPTIONS" +The SFconv utility uses command-line options to specify the conversion direction, +control file, and input and output files. The required arguments are: +.TP +.BR \-8u | \-u8 +conversion direction: 8-bit to Unicode or vice versa +.TP +.BR \-c controlFile +specifies XML control file +.TP +.BR \-i inFile +specifies filename of input SF file +.TP +.BR \-o outFile +specifies filename for converted output + +In addition, the following optional arguments may be used if appropriate: +.TP +.BR \-d mappingDir +directory where mapping files ( .tec files) are to be found +.TP +.BR \-utf8 | \-be | \-le +Unicode encoding form: UTF-8, UTF-16BE, or UTF16-LE (default is UTF8 for output, or detected from input file if BOM is present) +.TP +.BR \-bom +(only when mapping to Unicode) write initial BOM to the output file +.TP +.BR \-nfc | \-nfd +(only when mapping to Unicode) normalize to NFC or NFD +.SH Further Information +For further information see the document TECkit_Tools.pdf. +On a Debian system, this can be found in /usr/share/doc/teckit. diff --git a/Build/source/libs/teckit/TECkit-src/docs/teckit_compile.1 b/Build/source/libs/teckit/TECkit-src/docs/teckit_compile.1 new file mode 100644 index 00000000000..618a19325b7 --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/teckit_compile.1 @@ -0,0 +1,28 @@ +.TH TECKIT_COMPILE 1 "2015-11-14" "TECkit" +.SH NAME +teckit_compile \- manual page for command line error at --version +.SH SYNOPSIS +.B teckit_compile +[\fI\,-u\/\fR] [\fI\,-x\/\fR] [\fI\,-z\/\fR] \fI\,mapping_description \/\fR[\fI\,-o compiled_table\/\fR] +.SH OPTIONS +Required argument: +.IP +\fBsource\fR mapping description (.map) file +.PP +Optional arguments: +.TP +.BR \fB\-o\fR file +output compiled table (.tec) file ("\-" for stdout) +.TP +.BR \fB\-u\fR +read source text as UTF8 even if no BOM found +.TP +.BR \fB\-x\fR +generate XML representation rather than compiled table +.TP +.BR \fB\-z\fR +generate uncompressed table format +.SH Further Information +For further information see the document TECkit_Tools.pdf. +A description of the mapping description language used by the compiler, with examples, is found in TECkit_Language.pdf. +On a Debian system, these can be found in /usr/share/doc/teckit. diff --git a/Build/source/libs/teckit/TECkit-src/docs/txtconv.1 b/Build/source/libs/teckit/TECkit-src/docs/txtconv.1 new file mode 100644 index 00000000000..125528976c3 --- /dev/null +++ b/Build/source/libs/teckit/TECkit-src/docs/txtconv.1 @@ -0,0 +1,50 @@ +.TH TXTCONV 1 "2015-11-13" "TECkit" +.SH NAME +txtconv \- A tool to apply TECkit mappings to convert the encoding of a plain text file +.SH SYNOPSIS +.B txtconv +\fI\,-i inFile -o outFile \/\fR[\fI\,-t tecFile\/\fR] [\fI\,-r\/\fR] [\fI\,-if inForm\/\fR] [\fI\,-of outForm\/\fR] [\fI\,-nobom\/\fR] [\fI\,-nf\/\fR[\fI\,cd\/\fR]] [\fI\,-u n\/\fR] +.SH "OPTIONS" +\fBRequired arguments:\fR +.TP +\fB\-i\fR <file> +input file +.TP +\fB\-o\fR <file> +output file +.PP +\fBOptional arguments:\fR +.TP +\fB\-t\fR <file> +compiled TECkit mapping (.tec) file +.TP +\fB\-r\fR +reverse (RHS\->LHS, or Unicode\->Byte) mapping +.TP +\fB\-if\fR <form> +input encoding form +.TP +\fB\-of\fR <form> +output encoding form +.TP +\fB\-nobom\fR +don't write a BOM to Unicode output +.TP +\fB\-nf[cd]\fR +apply NFC or NFD normalization to Unicode output +.TP +\fB\-u\fR <n> +handling of unmappable input: +.IP +\(bu 0 = use replacement character +\.IP +\(bu 1 = use replacement but generate warning +\.IP +\(bu 2 = stop conversion +.PP +\fBEncoding forms:\fR +.IP +bytes utf8 utf16be utf16le utf16 utf32be utf32le utf32 +.SH Further Information +For further information see the document TECkit_Tools.pdf. +On a Debian system, this can be found in /usr/share/doc/teckit. |