summaryrefslogtreecommitdiff
path: root/fonts/utilities/jfmutil/README.md
blob: 91fdb1bccbca37009eed2fd0f4481c2a66e727e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
jfmutil
=======

Perl: Utility to process pTeX-extended TFM and VF

This program provides functionality to process data files (JFM and VF)
that form logical fonts used in (u)pTeX. The functions currently
available include:

  - The mutual conversion between Japanese virtual fonts (pairs of VF
    and JFM) and files in the “ZVP format”, which is an original text
    format representing data in virtual fonts. This function can be seen
    as counterpart to vftovp/vptovf programs.
  - The mutual conversion between VF files alone and files in the “ZVP0
    format”, which is a subset of the ZVP format.
  - The replication of virtual fonts with different names, where the
    referred TFM names in the VF will be suitably revised.

### SYSTEM REQUIREMENTS

  - Perl interpreter: v5.8.1 or later.
  - The following commands from pTeX distribution:
      - kpsewhich
      - ppltotf, ptftopl

### LICENSE

This package is distributed under the MIT License.

### USAGE

    This is jfmutil v1.x.x <20xx/xx/xx> by 'ZR'.
    [ZRTeXtor library v1.x.x <20xx/xx/xx> by 'ZR']

    * ZVP Conversion
    Usage: jfmutil vf2zvp0 [<options>] <in.vf> [<out.zvp0>]
           jfmutil zvp02vf [<options>] <in.zvp0> [<out.vf>]
           jfmutil vf2zvp [<options>] <in.vf> [<in.tfm> <out.zvp>]
           jfmutil zvp2vf [<options>] <in.zvp> [<out.vf> <out.tfm>]
           jfmutil zpl2tfm [<options>] <in.zvp0> [<out.vf>]
           jfmutil tfm2zpl [<options>] <in.zvp0> [<out.vf>]
    Arguments:
      <in.xxx>        input files
        N.B. Input TFM/VF files are searched by Kpathsea. (ZVP/ZVP9 are not.)
      <out.xxx>       output files
    Options:
           --hex      output charcode in 'H' form [default]
      -o / --octal    output charcode in 'O' form
      --uptool        use upTeX tools (uppltotf etc.)
      --lenient       ignore non-fatal error on VFs
      The following options affect interpretation of 'K' form.
      --kanji=ENC     set source encoding: ENC=jis/sjis/euc/utf8/none
      --kanji-internal=ENC set internal encoding: ENC=jis/unicode/none
      -j / --jis      == --kanji=jis --kanji-internal=jis
      -u / --unicode  == --kanji=utf8 --kanji-internal=unicode
      -E / --no-encoding == --kanji=none --kanji-internal=none

    * VF Replication
    Usage: jfmutil vfcopy [<options>] <in.vf> <out.vf> <out_base.tfm>...
           jfmutil vfinfo [<options>] <in.vf>
           jfmutil jodel [<options>] <in.vf> <prefix>
    Arguments:
      <in.vf>       input virtual font name
        N.B. Input TFM/VF files are searched by Kpathsea.
      <out.vf>      output virtual font name
      <out_base.tfm>  names of raw TFMs referred by the output virtual font;
                    each entry replaces a font mapping in the input font in
                    the given order, so the exactly same number of entries
                    must be given as font mappings
      <prefix>      prefix of output font names (only for jodel)
    Options:
      -z / --zero   change first fontmap id in vf to zero
      --uptex       assume input font to be for upTeX (only for jodel)
      --unicode     generate VF for 'direct-unicode' mode imposed by pxufont
                    package; this option is supported only for upTeX fonts and
                    thus implies '--uptex' (only for jodel)

    * Common Options
      -h / --help     show this help message and exit
      -V / --version  show version

C>jfmutil --version
Please refer to README-ja.md (in Japanese) for detail.

Revision History
----------------

  * Version 1.2.3 〈2019/09/02〉
      - Bug fix.

  * Version 1.2.2 〈2019/02/09〉
      - Bug fix.

  * Version 1.2.1 〈2019/02/08〉
      - (experimental) Add `jodel` subcommand.

  * Version 1.2.0 〈2019/02/02〉
      - Add option `--lenient`.

  * Version 1.1.2 〈2018/01/21〉
      - Use ZRTeXtor v1.5.0. The changes are:
          + Support for the recent extension of JFM format, which allows
            non-default character classes to contain non-BMP characters.

  * Version 1.1.1 〈2018/01/20〉
      - Bug fix.

  * Version 1.1.0 〈2017/09/16〉
      - Add subcommands `vfinfo` and `vfcopy`.

  * Version 1.0.1 〈2017/07/21〉
      - Add shebang line.

  * Version 1.0.0 〈2017/07/17〉
      - The first public version (as jfmutil).
      - ZRTeXtor is of v1.4.0.

--------------------
Takayuki YATO (aka. "ZR")  
https://github.com/zr-tex8r