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