--- psiconv/trunk/program/psiconv/psiconv.man 2014/10/19 19:42:58 340 +++ psiconv/trunk/program/psiconv/psiconv.man 2014/10/19 21:38:48 341 @@ -1,76 +1,40 @@ -.\"Created with GNOME Manpages Editor -.\"http://gmanedit.sourceforge.net -.\"Sergio Rua -.\" -.TH PSICONV 1 "11 November 2003" - +.TH PSICONV 1 "October 19, 2014" 0.9.9 "" .SH NAME -psiconv \- Translate Psion 5 and other EPOC device files. - +psiconv \- Psion 5 and other EPOC devices file converter .SH SYNOPSIS .B psiconv -.RI [ \-d | \-\-debug ] -.RI [ \-h | \-\-help ] -.RI [ \-o | \-\-outputfile ] -.RI [ \-s | \-\-silent ] -.RI [ \-T | \-\-type=FILETYPE ] -.RI [ \-V | \-\-version ] -.RI [ \-v | \-\-verbose ] -.RI [ \-u | \-\-UTF8 ] -.RI [ FILE -.IR ... ] -.br - +.RI [ options ] +.RI [ file ] .SH DESCRIPTION -This manual page explains the .B psiconv -program. -.B Psiconv -translates Psion 5 and other EPOC device files to more commonly used formats. -.br -Psiconv works like a filter: output is sent to -.B stdout -without the -.I -o -option, and input is read from -.B stdin -if no files are given. - +is used to convert files generated by Psion 5, Psion 5MX and other EPOC devices into more common formats. It can currently convert Word and TextEd files into ASCII, HTML4 or XHTML, and Sketch, MBM and ClipArt into most common picture formats. +Psiconv works like a filter: by default files are read from stdin and written +to stdout. .SH OPTIONS .TP -.IR \-d | \-\-debug -Show debug information on stderr -.TP -.IR \-h | \-\-help -Display this help and exit +.BR \-c , " \-\-configfile \fIfile\fP" +Read an additional configuration file after the default ones. See psiconv.conf(5). .TP -.IR \-o | \-\-outputfile -Output to file instead of stdout +.BR \-e , " \-\-encoding \fIenc\fP" +Output encoding. Supported encodings are \fBUTF8\fP, \fBUCS2\fP, \fBPsion\fP (the same encoding as the Psion file used) or 7-bit \fBASCII\fP. .TP -.IR \-s | \-\-silent -Do not even show warnings on stderr +.BR \-h , " \-\-help" +Output a small usage guide as well as the supported output formats on stdout and exit successfully. No other output is generated. .TP -.IR \-T | \-\-type=FILETYPE -Output type +.BR \-n , " \-\-noise \fIlevel\fP" +The amount of noise generated on stderr. Recognized values are \fB1\fP or \fBF\fP for fatal errors only, \fB2\fP or \fBE\fP for all errors, \fB3\fP or \fBW\fP for errors and warnings, \fB4\fP or \fBP\fP to include progress indicators and \fB5\fP or \fBD\fP for low level debug information. .TP -.IR \-V | \-\-version -Display the program version and exit +.BR \-o , " \-\-outputfile \fIfile\fP" +File to write output to, instead of stdout. .TP -.IR \-v | \-\-verbose -Show progress indicators on stderr +.BR \-T , " \-\-type \fIfileformat\fP" +The file format to output. By default, Word and TextEd files will be converted to XHTML and Sketch, MBM and Clip Art files to TIFF. The full list of output formats can be found by using the \fB-h\fP option. .TP -.IR \-u | \-\-UTF8 -Input file is encoded in UTF8 - -.SH LICENCE - -Psiconv is released under the Gnu General Public License, version 2 or higher. - -.SH BUGS - -Many more formats should be supported. - +.BR \-V , " \-\-version" +Output the current version of psiconv on stdout and exit successfully. No other output is generated. .SH AUTHOR +Frodo Looijaard +.SH "SEE ALSO" +.BR psiconv.conf (5). -Frodo Looijaard