Convert xml-protected spaces to real spaces
[odt2txt.git] / odt2txt.1
blob9b1e5da1c08e3c329cb71dd1a6542838951df027
1 .TH ODT2TXT "1" "2008-06-23" "odt2txt 0.5" "User Commands"
2 .SH NAME
3 odt2txt \- a simple converter from OpenDocument Text to plain text
4 .SH SYNOPSIS
5 .B odt2txt
6 [OPTIONS] FILENAME
7 .SH DESCRIPTION
8 odt2txt is a command-line tool which extracts the text out of
9 OpenDocument Texts, as produced by OpenOffice.org, KOffice,
10 StarOffice and others.
11 .PP
12 odt2txt can also extract text from some file formats similar to
13 OpenDocument Text, such as OpenOffice.org XML (*.sxw), which was
14 used by OpenOffice.org version 1.x and older StarOffice versions.
15 To a lesser extent, odt2txt may be useful to extract content from
16 OpenDocument spreadsheets (*.ods) and OpenDocument presentations
17 (*.odp).
18 .PP
19 The FILENAME argument is mandatory.
20 .SH OPTIONS
21 .TP
22 \fB\-\-width\fR=\fIWIDTH\fR
23 Wrap text lines after \fIWIDTH\fR characters. The default value is
24 \fI65\fR, which means that any words which would extend beyond
25 column \fI65\fR are moved to a new line.
26 .IP
27 If \fIWIDTH\fR is set to \fI\-1\fR then no lines will be broken
28 .TP
29 \fB\-\-output\fR=\fIFILE\fR
30 Write output to \fIFILE\fR and not to standard output.
31 .TP
32 \fB\-\-subst\fR=\fISUBST\fR
33 Select which non\-ascii characters shall be replaced by ascii
34 look\-a\-likes. Valid values for \fISUBST\fR are \fIall\fR,
35 \fIsome\fR and \fInone\fR.
36 .IP
37 \fB\-\-subst\fR=\fIall\fR
38 Substitute all characters for which substitutions are known
39 .IP
40 \fB\-\-subst\fR=\fIsome\fR
41 Substitute all characters which the output charset does not contain
42 This is the default
43 .IP
44 \fB\-\-subst\fR=\fInone\fR
45 Substitute no characters
46 .TP
47 \fB\-\-encoding\fR=\fIX\fR
48 Do not try to autodetect the terminal encoding, but convert the
49 document to encoding \fIX\fR unconditionally To find out, which terminal
50 encoding will be used in automatic mode, use
51 \fB\-\-encoding\fR=\fIshow\fR
52 .TP
53 \fB\-\-raw\fR
54 Print raw XML
55 .TP
56 \fB\-\-raw-input\fR
57 Input file is a raw XML (fodt, fods, ...)
58 .TP
59 \fB\-\-version\fR
60 Show version and copyright information
61 .SH COPYRIGHT
62 Copyright \(co 2006,2007 Dennis Stosberg <dennis@stosberg.net>
63 .br
64 Uses parts of the kunzip library, Copyright 2005,2006 by Michael Kohn
65 .PP
66 This program is free software; you can redistribute it and/or
67 modify it under the terms of the GNU General Public License,
68 version 2 as published by the Free Software Foundation
69 .SH SEE ALSO
70 .TP
71 https://github.com/dstosberg/odt2txt