Docs/antiword.1

   1 .TH ANTIWORD 1 "Oct 29, 2005" "Antiword 0.37" "Linux User's Manual"
   2 .SH NAME
   3 antiword - show the text and images of MS Word documents
   4 .SH SYNOPSIS
   5 .B antiword
   6 [
   7 .I options
   8 ]
   9 .I wordfiles
  10 .SH DESCRIPTION
  11 .I Antiword
  12 is an application that displays the text and the images of Microsoft Word
  13 documents.
  14 .br
  15 A wordfile named - stands for a Word document read from the standard input.
  16 .br
  17 Only documents made by MS Word version 2 and version 6 or later are supported.
  18 .SH OPTIONS
  19 .TP
  20 .BI "\-a " papersize
  21 Output in Adobe PDF form. Printable on paper of the specified size: 10x14,
  22 a3, a4, a5, b4, b5, executive, folio, legal, letter, note, quarto, statement
  23 or tabloid.
  24 .TP
  25 .B \-f
  26 Output in formatted text form. That means that bold text is printed like
  27 *bold*, italics like /italics/ and underlined text as _underlined_.
  28 .TP
  29 .B \-h
  30 Give a help message.
  31 .TP
  32 .BI "\-i " "image level"
  33 The image level determines how images will be shown.
  34 .RS
  35 .TP 3
  36 0:
  37 Use non-standard extensions from Ghostscript. This output may not print on
  38 any PostScript printer, but is useful in case no hard copy is needed. It is
  39 also useful when Ghostscript is used as a filter to print a PostScript file to
  40 a non-PostScript printer.
  41 .TP 3
  42 1:
  43 Show no images.
  44 .TP 3
  45 2:
  46 PostScript level 2 compatible. (default)
  47 .TP 3
  48 3:
  49 PostScript level 3 compatible. (EXPERIMENTAL, Portable Network Graphics (PNG)
  50 images are not printed correctly)
  51 .RE
  52 .TP
  53 .BI "\-m " "mapping file"
  54 This file is used to map Unicode characters to your local character set.
  55 The default mapping file depends on the locale.
  56 .TP
  57 .BI "\-p " papersize
  58 Output in PostScript form. Printable on paper of the specified size: 10x14,
  59 a3, a4, a5, b4, b5, executive, folio, legal, letter, note, quarto, statement
  60 or tabloid.
  61 .TP
  62 .B \-r
  63 Include text removed by the revisioning system.
  64 .TP
  65 .B \-s
  66 Include text with the so-called "hidden text" attribute.
  67 .TP
  68 .B \-t
  69 Output in text form. (default)
  70 .TP
  71 .BI "\-w " width
  72 In text mode this is the line width in characters. A value of zero puts an
  73 entire paragraph on a line, useful when the text is to used as input for
  74 another wordprocessor. This value is ignored in PostScript mode.
  75 .TP
  76 .BI "\-x " "document type definition"
  77 Output in XML form. Currently the only document type definition is db
  78 (for DocBook).
  79 .TP
  80 .B \-L
  81 In PostScript mode: use landscape mode.
  82 .RE
  83 .SH FILES
  84 .TP
  85 Mapping files like 8859-1.txt
  86 .br
  87 Antiword looks for its mapping files in three directories, in the order given:
  88 .br
  89 (1) The directory specified by $ANTIWORDHOME
  90 .br
  91 (2) The directory specified by $HOME/.antiword
  92 .br
  93 (3) Directory /usr/share/antiword
  94 .TP
  95 The fontnames file
  96 .br
  97 Antiword will look for its fontname file in the same directories as used for the
  98 mapping files.
  99 .br
 100 The fontnames file contains the translation table from font names used by MS
 101 Word to font names used by PostScript.
 102 .TP
 103 NOTE:
 104 .br
 105 Antiword cannot tell the difference between a file that does not exist and a
 106 file that cannot be opened for reading.
 107 .SH ENVIRONMENT
 108 Antiword uses the environment variable ``ANTIWORDHOME'' as the first directory
 109 to look for its files. Antiword uses the environment variable ``HOME'' to find
 110 the user's home directory. When in text mode it uses the variable ``COLUMNS''
 111 to set the width of the output (unless overridden by the -w option).
 112
 113 Antiword uses the environment variables ``LC_ALL'', ``LC_CTYPE'' and ``LANG''
 114 (in that order) to get the current locale and uses this information to
 115 select the default mapping file.
 116 .SH BUGS
 117 Antiword is far from complete. Many features are still missing. Many images are
 118 not shown yet. Some of the images that are shown, are shown in the wrong place.
 119 PostScript output is only available in ISO 8859-1 and ISO 8859-2.
 120 .SH WEB SITES
 121 The most recent released version of Antiword is always available from:
 122 .br
 123 http://www.winfield.demon.nl/index.html
 124 .br
 125 or try
 126 .br
 127 http://antiword.cjb.net/
 128 .SH AUTHOR
 129 Adri van Os <antiword@winfield.demon.nl>
 130 .br
 131 or try <comments@antiword.cjb.net>
 132 .sp
 133 R.F. Smith <rsmith@xs4all.nl> and
 134 .br
 135 Sindi Keesan <keesan@cyberspace.org>
 136 .br
 137 contributed to this manual page.
 138 .SH LICENSE
 139 Antiword is free software; you can redistribute it and/or modify it
 140 under the terms of the GNU General Public License as published by the Free
 141 Software Foundation; either version 2 of the License, or (at your option)
 142 any later version.
 143
 144 This program is distributed in the hope that it will be useful but WITHOUT
 145 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 146 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 147 more details.
 148
 149 You should have received a copy of the GNU General Public License along
 150 with this program; if not, write to the Free Software Foundation, Inc.,
 151 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 152 .SH ACKNOWLEDGEMENTS
 153 Linux is a registered trademark of Linus Torvalds.
 154 .br
 155 Adobe, PDF and PostScript are trademarks of Adobe Systems Incorporated.
 156 .br
 157 Microsoft is a registered trademark and Windows is a trademark of Microsoft
 158 Corporation.