lib/psiconv/psiconv.conf.man.in

.TH PSICONV.CONF 5 "October 19, 2014" 0.9.9 ""
.SH NAME
psiconv.conf \- Configuration for libpsiconv
.SH SYNOPSIS
.I /etc/psiconv/psiconv.conf
.I ~/.psiconv.conf
.SH DESCRIPTION
The library \fBlibpsiconv\fR 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 \fBpsiconv.conf\fR can be used to specify these differences.
.PP
There is a global configuration file \fI/etc/psiconv/psiconv.conf\fR (it may be located elsewhere, depending upon the configuration choices) which is read first; a user-specific file \fI~/.psiconv.conf\fR is read next. The application linked to \fBlibpsiconv\fR can add yet another configuration file which is read after the standard two. Settings in later configuration file overrule those in earlier files.
.SH BASIC STRUCTURE
The configuration files are line based. Empty lines, lines containing only whitespace and comment lines are ignored. A comment line starts with optional whitespace followed by \fB#\fR (a hash).
.PP
All other lines contain a single configuration statement each of the form \fIVAR\fB=\fIVALUE\fR. There may be whitespace around the \fB=\fR sign and at the start and end of the line. Variables \fIVAR\fR are case insensitive. There may not be a trailing comment after a statement.
.SH CONFIGURATION SETTINGS
.SS GENERAL SETTINGS
.TP
.B 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.
.PP
.RS
.RS
.PD 0
.B 1
: Only display fatal errors
.PP
.B 2
: Display errors
.PP
.B 3
: Display warnings
.PP
.B 4
: Display progress information
.PP
.B 5
: Display debug information
.PD
.RE
.PP
Programs can use their own error/information reporting routines; by default, everything is logged to stderr.
.SS COLOR SETTINGS
.TP
.B Color
Either \fB0\fR for greyscale displayes or \fB1\fR for color displays
.TP
.B ColorDepth
The number of bits used to encode colors or hues of grey.
.TP
\fBRedBits\fR, \fBGreenBits\fR and \fBBlueBits\fR
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.
.PP
.RE
.SS CHARACTER SET SETTINGS
.TP
.B CharacterSet
The character set used in EPOC files. \fB0\fR is Unicode (Eastern Psions), \fB1\fR is IBM Codepage 1252 (Western Europe Psions).
.TP
\fBChar0\fR, \fBChar1\fR, \fBChar2\fR, ...
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).
.TP
.B UnknownEPOCChar
When translating from Unicode back to EPOC format, the Unicode character may not be presentable. This is the Psion codepage character number to use in this case. Allowed values: 0 to 255.
.TP
.B 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.
.SH EXAMPLE
The defaults for a western Psion 5 would be:
.RS
.PD 0
Color = 0
.PP
ColorDepth = 2
.PP
#RedBits = 0
.PP
#GreenBits = 0
.PP
#BlueBits = 0
.PP
CharacterSet = 1
.PP
UnknownUnicodeChar = 63
.PP
UnknownEPOCChar = 63
.PD
.RE
.FI
.SH AUTHOR
Frodo Looijaard <frodo@frodo.looijaard.name>
.SH "SEE ALSO"
.BR psiconv (1).
1	.TH PSICONV.CONF 5 "October 19, 2014" 0.9.9 ""
2	.SH NAME
3	psiconv.conf \- Configuration for libpsiconv
4	.SH SYNOPSIS
5	.I /etc/psiconv/psiconv.conf
6	.I ~/.psiconv.conf
7	.SH DESCRIPTION
8	The library \fBlibpsiconv\fR 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 \fBpsiconv.conf\fR can be used to specify these differences.
9	.PP
10	There is a global configuration file \fI/etc/psiconv/psiconv.conf\fR (it may be located elsewhere, depending upon the configuration choices) which is read first; a user-specific file \fI~/.psiconv.conf\fR is read next. The application linked to \fBlibpsiconv\fR can add yet another configuration file which is read after the standard two. Settings in later configuration file overrule those in earlier files.
11	.SH BASIC STRUCTURE
12	The configuration files are line based. Empty lines, lines containing only whitespace and comment lines are ignored. A comment line starts with optional whitespace followed by \fB#\fR (a hash).
13	.PP
14	All other lines contain a single configuration statement each of the form \fIVAR\fB=\fIVALUE\fR. There may be whitespace around the \fB=\fR sign and at the start and end of the line. Variables \fIVAR\fR are case insensitive. There may not be a trailing comment after a statement.
15	.SH CONFIGURATION SETTINGS
16	.SS GENERAL SETTINGS
17	.TP
18	.B Verbosity
19	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.
20	.PP
21	.RS
22	.RS
23	.PD 0
24	.B 1
25	: Only display fatal errors
26	.PP
27	.B 2
28	: Display errors
29	.PP
30	.B 3
31	: Display warnings
32	.PP
33	.B 4
34	: Display progress information
35	.PP
36	.B 5
37	: Display debug information
38	.PD
39	.RE
40	.PP
41	Programs can use their own error/information reporting routines; by default, everything is logged to stderr.
42	.SS COLOR SETTINGS
43	.TP
44	.B Color
45	Either \fB0\fR for greyscale displayes or \fB1\fR for color displays
46	.TP
47	.B ColorDepth
48	The number of bits used to encode colors or hues of grey.
49	.TP
50	\fBRedBits\fR, \fBGreenBits\fR and \fBBlueBits\fR
51	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.
52	.PP
53	.RE
54	.SS CHARACTER SET SETTINGS
55	.TP
56	.B CharacterSet
57	The character set used in EPOC files. \fB0\fR is Unicode (Eastern Psions), \fB1\fR is IBM Codepage 1252 (Western Europe Psions).
58	.TP
59	\fBChar0\fR, \fBChar1\fR, \fBChar2\fR, ...
60	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).
61	.TP
62	.B UnknownEPOCChar
63	When translating from Unicode back to EPOC format, the Unicode character may not be presentable. This is the Psion codepage character number to use in this case. Allowed values: 0 to 255.
64	.TP
65	.B UnknownUnicodeChar
66	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.
67	.SH EXAMPLE
68	The defaults for a western Psion 5 would be:
69	.RS
70	.PD 0
71	Color = 0
72	.PP
73	ColorDepth = 2
74	.PP
75	#RedBits = 0
76	.PP
77	#GreenBits = 0
78	.PP
79	#BlueBits = 0
80	.PP
81	CharacterSet = 1
82	.PP
83	UnknownUnicodeChar = 63
84	.PP
85	UnknownEPOCChar = 63
86	.PD
87	.RE
88	.FI
89	.SH AUTHOR
90	Frodo Looijaard <frodo@frodo.looijaard.name>
91	.SH "SEE ALSO"
92	.BR psiconv (1).
frodo@frodo.looijaard.name	ViewVC Help
Powered by ViewVC 1.1.26