Codebase list teckit / 9ae875e
manpage for sfconv Daniel Glassey 8 years ago
2 changed file(s) with 48 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 .TH sfconv "1" "13th November 2015" "2.5.4"
1 .SH NAME
2 sfconv \- A tool for converting the encoding of Standard Format (SF) files
3 .SH SYNOPSIS
4 .SS "8-bit to Unicode:"
5 .TP
6 sfconv \fB\-8u\fR [\-utf8|\-be|\-le] [\-bom] \fB\-c\fR ControlFile [\-d MappingDirectory] \fB\-i\fR InFile \fB\-o\fR OutFile
7 .SS "Unicode to 8-bit:"
8 .TP
9 sfconv \fB\-u8\fR [\-utf8|\-be|\-le] \fB\-c\fR ControlFile [\-d MappingDirectory] \fB\-i\fR InFile \fB\-o\fR OutFile
10 .SH "DESCRIPTION"
11 A tool for converting Standard Format (SF) files is included in the current TECkit package.
12 This is \fBsfconv\fR , a command-line tool that uses an XML “control file” to specify the
13 mappings associated with the various markers in an SF file. Note that the current SFconv tool
14 should be considered a prototype rather than a full solution to the issue of SF conversions. A
15 more complete tool with an improved user interface would be desirable.
16 .SH "OPTIONS"
17 The SFconv utility uses command-line options to specify the conversion direction,
18 control file, and input and output files. The required arguments are:
19 .TP
20 .BR \-8u | \-u8
21 conversion direction: 8-bit to Unicode or vice versa
22 .TP
23 .BR \-c controlFile
24 specifies XML control file
25 .TP
26 .BR \-i inFile
27 specifies filename of input SF file
28 .TP
29 .BR \-o outFile
30 specifies filename for converted output
31
32 In addition, the following optional arguments may be used if appropriate:
33 .TP
34 .BR \-d mappingDir
35 directory where mapping files ( .tec files) are to be found
36 .TP
37 .BR \-utf8 | \-be | \-le
38 Unicode encoding form: UTF-8, UTF-16BE, or UTF16-LE (default is UTF8 for output, or detected from input file if BOM is present)
39 .TP
40 .BR \-bom
41 (only when mapping to Unicode) write initial BOM to the output file
42 .TP
43 .BR \-nfc | \-nfd
44 (only when mapping to Unicode) normalize to NFC or NFD
45 .SH Further Information
46 For further information see the document TECkit_version_2.1.doc.pdf found in /usr/share/doc/teckit on a Debian system.
0 debian/man/sfconv.1