]> git.sur5r.net Git - cc65/blob - doc/chrcvt65.sgml
Merge pull request #706 from xlar54/master
[cc65] / doc / chrcvt65.sgml
1 <!doctype linuxdoc system>      <!-- -*- text-mode -*- -->
2
3 <article>
4 <title>chrcvt65 Users Guide
5 <author><url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">
6 <date>2013-02-10
7
8 <abstract>
9 chrcvt65 is the vector font converter. It is able to convert a foreign font into
10 the native format.
11 </abstract>
12
13 <!-- Table of contents -->
14 <toc>
15
16 <!-- Begin the document -->
17
18
19 <sect>Overview<p>
20
21 chrcvt65 is a vector font converter. It is able to convert a "BGI Stroked
22 Font" to a compact TGI native vector font. See the function <url
23 url="funcref.html#tgi_load_vectorfont" name="tgi_load_vectorfont"> for usage.
24
25
26
27 <sect>Usage<p>
28
29 The chrcvt65 utility converts the font of one Borland file to its cc65 equivalent.
30
31
32 <sect1>Command line option overview<p>
33
34 The program may be called as follows:
35
36 <tscreen><verb>
37 ---------------------------------------------------------------------------
38 Usage: chrcvt65 [options] file [options] [file]
39 Short options:
40   -h                    Help (this text)
41   -v                    Be more verbose
42   -V                    Print the version number and exit
43
44 Long options:
45   --help                Help (this text)
46   --verbose             Be more verbose
47   --version             Print the version number and exit
48 ---------------------------------------------------------------------------
49 </verb></tscreen>
50
51
52 <sect1>Command line options in detail<p>
53
54 Here is a description of all the command line options:
55
56 <descrip>
57
58   <tag><tt>-v, --verbose</tt></tag>
59
60   Increase the converter verbosity.
61
62
63   <tag><tt>-h, --help</tt></tag>
64
65   Print the short option summary shown above.
66
67
68   <tag><tt>-V, --version</tt></tag>
69
70   Print the version number of the utility. When submitting a bug report,
71   please include the operating system you're using, and the compiler
72   version.
73 </descrip>
74
75
76 <sect>Input and output<p>
77
78 The converter will read one CHR file per invocation and write the font
79 in TCH format to a new file.
80
81 Example output for the command
82 <tscreen><verb>
83 chrcvt65 --verbose LITT.CHR
84 </verb></tscreen>
85 <tscreen><verb>
86 BGI Stroked Font V1.1 - Aug 12, 1991
87 Copyright (c) 1987,1988 Borland International
88 </verb></tscreen>
89
90
91
92 <sect>Copyright<p>
93
94 chrcvt65 is (C) Copyright 2009, Ullrich von Bassewitz. For usage of the
95 binaries and/or sources the following conditions apply:
96
97 This software is provided 'as-is', without any expressed or implied
98 warranty.  In no event will the authors be held liable for any damages
99 arising from the use of this software.
100
101 Permission is granted to anyone to use this software for any purpose,
102 including commercial applications, and to alter it and redistribute it
103 freely, subject to the following restrictions:
104
105 <enum>
106 <item>  The origin of this software must not be misrepresented; you must not
107         claim that you wrote the original software. If you use this software
108         in a product, an acknowledgment in the product documentation would be
109         appreciated but is not required.
110 <item>  Altered source versions must be plainly marked as such, and must not
111         be misrepresented as being the original software.
112 <item>  This notice may not be removed or altered from any source
113         distribution.
114 </enum>
115
116 </article>