home | help 
PSICONV.CONF(5) 						 PSICONV.CONF(5)

NAME
     psiconv.conf - Configuration for libpsiconv

SYNOPSIS
     /etc/psiconv/psiconv.conf ~/.psiconv.conf

DESCRIPTION
     The library libpsiconv is used to convert files generated by Psion 5, Psion
     5MX  and  other EPOC devices into more common formats and vice versa. There
     are several variants of EPOC devices which all use slightly different  file
     formats.  The  configuration file psiconv.conf can be used to specify these
     differences.

     There is a global configuration file /etc/psiconv/psiconv.conf (it  may  be
     located  elsewhere, depending upon the configuration choices) which is read
     first; a user-specific file ~/.psiconv.conf is read next.	The  application
     linked  to  libpsiconv can add yet another configuration file which is read
     after the standard two. Settings in later configuration file overrule those
     in earlier files.

BASIC STRUCTURE
     The configuration files are line based. Empty lines, lines containing  only
     whitespace  and  comment  lines are ignored. A comment line starts with op-
     tional whitespace followed by # (a hash).

     All other lines contain a single configuration statement each of  the  form
     VAR=VALUE.  There	may be whitespace around the = sign and at the start and
     end of the line. Variables VAR are case insensitive. There  may  not  be  a
     trailing comment after a statement.

CONFIGURATION SETTINGS
   GENERAL SETTINGS
     Verbosity
	    This  determines  how  much output the library generates, especially
	    when it is parsing Psion files. There are five levels of  verbosity;
	    higher numbers generate more output.

		   1 : Only display fatal errors
		   2 : Display errors
		   3 : Display warnings
		   4 : Display progress information
		   5 : Display debug information

	    Programs  can use their own error/information reporting routines; by
	    default, everything is logged to stderr.

   COLOR SETTINGS
     Color  Either 0 for greyscale displayes or 1 for color displays

     ColorDepth
	    The number of bits used to encode colors or hues of grey.

     RedBits, GreenBits and BlueBits
	    If you have a color display, colors may be	encoded  either  as  RGB
	    colors  or	as  entries  in a palet. In the first case, set here the
	    number of bits used to encode red, green and blue. Make sure the sum
	    of these bit numbers equals the ColorDepth set above. To use one  of
	    the  default  palets, set all three to zero. If you have a greyscale
	    display, these settings are ignored.

   CHARACTER SET SETTINGS
     CharacterSet
	    The character set used in EPOC files. 0 is Unicode (Eastern Psions),
	    1 is IBM Codepage 1252 (Western Europe Psions).

     Char0, Char1, Char2, ...
	    Change a single character in the character set. The  number  in  the
	    variable name is the index in the EPOC character set (0 to 255), the
	    value is a Unicode index (0 to 65535).

     UnknownEPOCChar
	    When translating from Unicode back to EPOC format, the Unicode char-
	    acter  may	not be presentable. This is the Psion codepage character
	    number to use in this case. Allowed values: 0 to 255.

     UnknownUnicodeChar
	    When translating from EPOC format to Unicode, the EPOC character may
	    not be known. This is the Unicode character number to  use	in  this
	    case.  The	default  below	is a question mark. Allowed values: 0 to
	    65535.

EXAMPLE
     The defaults for a western Psion 5 would be:
	    Color = 0
	    ColorDepth = 2
	    #RedBits = 0
	    #GreenBits = 0
	    #BlueBits = 0
	    CharacterSet = 1
	    UnknownUnicodeChar = 63
	    UnknownEPOCChar = 63

AUTHOR
     Frodo Looijaard <frodo@frodo.looijaard.name>

SEE ALSO
     psiconv(1).

0.9.9				October 19, 2014		 PSICONV.CONF(5)
home | help