Changed install directory of executable file and shared files.
[chise/kage.git] / kagecgi / README.en
1 KAGE/cgi is a Kanji-glyph generating engine.
2
3 It can use by command prompt and for executable cgi for httpd server.
4
5
6 PREREQUISITES
7 =============
8
9 KAGE/cgi needs following librarys:
10
11  - Berkely DB 3
12  - libpng
13  - glib2.0
14  - xlib
15
16
17 CONFIGURATION
18 =============
19
20 Please edit `Makefile' fit with your environment.
21
22
23
24 RUNNING MAKE
25 ============
26
27 Run the program `make' as follows:
28
29   % make
30
31
32 INSTALLING
33 ==========
34
35 1) Engine program
36
37   # make install
38
39   (by default, it will be installed as /usr/local/bin/kage.cgi)
40
41  Also, if you need to use as cgi, copy/make symbolic link to proper directory.
42  (ex. % cp /usr/local/bin/kage.cgi /var/www/cgi-bin/)
43  
44 2) Parts database (wget is required)
45
46   # make database
47
48   (by default, it will be installed as /usr/local/share/kagecgi/kagedb) 
49
50
51 TEST
52 ====
53
54 1) Run from command prompt
55
56  - % kage.cgi u2ff0.u6c35.u6c38 > result.png
57  - % kage.cgi u4e08-k > result.png
58  - % kage.cgi 'u7389&shotai=gothic' > result.png
59  - % kage.cgi 'u4e5f&type=eps' > result.eps
60
61 2) Run as cgi program
62
63 Call engine by a web browser like as `http://hoge.hoge/cgi-bin/kage.cgi?u4e00'.
64
65 Glyph will be appear (`ICHI (one)' : u4e00 in ISO/IEC 10646-1).
66
67 Another examples:
68  - kage.cgi?u2ff0.u6c35.u6c38 (combination of parts)
69  - kage.cgi?u4e08-k (fix a glyph design to K-Source of ISO/IEC 10646-1 [Default: J-Source])
70  - kage.cgi?u7389&shotai=gothic (generate as Gothic glyph [Default: Mincho])
71  - kage.cgi?u4e5f&type=eps (generate as .eps file [Default: .png file])
72
73
74 GETTING MORE INFORMATION
75 ========================
76
77 Please visit http://fonts.jp/ for further information.
78
79 (Currently, only Japanese language site are avalable)