ここでは以下のサンプルプログラムを説明する。これらのプログラムは m17n ライブラリの使い方を説明するものであり、実際の使用を意図したものではない。

m17n-conv – ファイルのコードを変換する
m17n-view – ファイルを見る
m17n-date – 日時を表示する
m17n-dump – テキスト画像のダンプ
m17n-edit – 多言語テキストの編集
mimx-anthy – 入力メソッド <ja, anthy> 用外部モジュール.
mimx-ispell – 入力メソッド <en, ispell> 用外部モジュール

@section m17n-conv m17n-conv -- ファイルのコードを変換する

@subsection m17n-conv-synopsis SYNOPSIS

m17n-conv [ OPTION ... ] [ INFILE [ OUTFILE ] ]

@subsection m17n-conv-description 説明

与えられたファイルのコードを別のものに変換する。 

INFILE が省略された場合は、標準入力からとる。OUTFILE が省略された 
場合は、標準出力へ書き出す。

以下のオプションが利用できる。

<ul>

<li> -f FROMCODE

FROMCODE は INFILE のコード系である。(デフォルトは UTF-8) 

<li> -t TOCODE

TOCODE は OUTFILE のコード系である。(デフォルトは UTF-8) 

<li> -k

エラーで変換を停止しない。

<li> -s

警告を表示しない。 

<li> -v

進行状況を表示する。 

<li> -l

利用可能なコード系を列挙する。 

<li> --version

バージョン番号を表示する。 

<li> -h, --help

このメッセージを表示する。 

</ul>


@section m17n-view m17n-view -- ファイルを見る

@subsection m17n-view-synopsis SYNOPSIS

m17n-view [ XT-OPTION ...] [ OPTION ... ] [ FILE ]

@subsection m17n-view-description DESCRIPTION

FILE をウィンドウに表示する。 

FILE が省略された場合は、標準入力からとる。 

XT-OPTIONs は Xt の標準の引数である。 (e.g. -fn, -fg). 

以下のオプションが利用できる。 

<ul>

<li> -e ENCODING

ENCODING は FILE のコード系である。(デフォルトは UTF-8) 

<li> -s FONTSIZE

FONTSIZE はフォントの大きさをポイント単位で示したものである。省略 
された場合は、X のリソースで定義されたデフォルトフォントの大きさと 
なる。

<li> --version

バージョン番号を表示する。

<li> -h, --help

このメッセージを表示する。

@section m17n-date m17n-date -- 日時を表示する

@subsection m17n-date-synopsis シノプシス

m17n-date [ OPTION ... ]

@subsection m17n-date-description 説明

システムの日時をさまざまなロケールでウィンドウに表示する。 

以下のオプションが利用できる。 

<ul>

<li> --version

バージョン番号を表示する。 

<li> -h, --help

このメッセージを表示する。

</ul>


@section m17n-dump m17n-dump -- テキスト画像のダンプ

@subsection m17n-dump-synopsis SYNOPSIS

m17n-dump [ OPTION ... ] [ FILE ]

@subsection m17n-dump-description DESCRIPTION

テキストを PNG 画像としてダンプする。 

PNG 画像は現在のディレクトリに作られた "BASE.png" という名前の 
ファイルに書き込まれる。ここで BASE はFILE の basename である。 
FILE が省略されれば、テキストは標準入力から読まれ、画像は 
"output.png" にダンプされる。

以下のオプションが利用できる。

<ul>

<li> -s SIZE

SIZE はフォントの大きさをポイント単位で示したものである。デフォル
トの大きさは 12 ポイント。

<li> -d DPI

DPI は解像度を１インチあたりのドット単位で示したものである。デフォ 
ルトの解像度は 300 dpi。

<li> -p PAPER

PAPER はぺーパサイズ : a4, a4r, a5, a5r, b5, b5r, letter, WxH また
は W。 WxH の場合、 W と H は幅と高さをミリメータ単位で示したもの。
W の場合、 W は幅をミリメータ単位で示したもの。このオプションが指定
されている場合は、 PAPER が画像サイズを制限す る。FILE が 1 ページ
に納まらないほど大きい場合は、"BASE.01.png", "BASE.02.png" 等の名前
のついた複数のファイルが作られる。

<li> -m MARGIN

MARGIN は水平、垂直マージンをミリメータ単位で示したものである。デ 
フォルトのマージンは 20 mm。PAPER が指定されていなければ無視される。

<li> -c POS

POS はカーソルの文字位置。デフォルトでは、カーソルは描かれない。

<li> -x

FILE は m17n ライブラリのシリアライズ機能によって作られた XML ファ 
イルであり、画像を生成する前にデシリアライズされる。

<li> -w

語の境界で改行する。 

<li> -f FILTER

FILTER はシェルコマンド行を含む文字列である。このオプションが指定
されていれば、PNG 画像はファイルに書かれるのではなく、FILTER に 
標準入力として渡される。 FILTER が "%s" を含んでいれば、それは FILE 
のベースネームに置き換えられる。このプログラムのデフォルトの振舞い
と、FILTER に "cat > %s.png" を指定した場合の振舞は同一である。

もし FILTER が単に "-" であれば、 PNG 画像は stdout に出力される。

<li> -a

アンチエイリアス処理を行う。

<li> --family FAMILY

ファミリィ名が FAMILY のフォントを優先的に使う。

<li> --language LANG

言語 LANG 用に指定されたフォントを優先的に使う。LANG は ISO 630 の
２文字コード（例：英語は "en" ）でなければならない。

<li> -fg FOREGROUND

テキストの色を指定する。HTML 4.0 の色の名前および "#RRGGBB" 記法を
サポート。

<li> -bg BACKGROUND

背景の色を指定する。サポートされている色の名前は FOREGROUND 同じ。
ただし、もし "transparent" が指定されたら背景を透明にする。

<li> -r

Specify that the orientation of the text is right-to-left.

<li> -q

一切のメッセージを表示しない。 

<li> --version

バージョン番号を表示する。

<li> -h, --help

このメッセージを表示する。 

</ul>


@section m17n-edit m17n-edit -- 多言語テキストの編集

@subsection m17n-edit-synopsis SYNOPSIS

m17n-edit [ XT-OPTION ...] [ OPTION ... ] FILE

@subsection m17n-edit-description DESCRIPTION

FILE をウィンドウに表示し、ユーザが編集できるようにする。

XT-OPTIONs は Xt の標準の引数である。 (e.g. -fn, -fg). 

以下のオプションが利用できる。 

<ul>

<li> --version

バージョン番号を表示する。 

<li> -h, --help

このメッセージを表示する。 

</ul>

このプログラムは m17n GUI API の使い方を示すものである。m17n-edit
は直接 GUI API を使っているが、この API は主にツールキットライブラ
リやXOM (X Output Method) の実装用であり、アプリケーションプログラ
ムからの直接の利用を意図していない。


@section mimx-anthy mimx-anthy -- 入力メソッド <ja, anthy> 用外部モジュール.

@subsection mimx-anthy-description DESCRIPTION

共有ライブラリ mimx-anthy.so は入力メソッド<ja, anthy> に用いられ 
る外部モジュールであり、以下の関数を export している。

<ul>
<li> init

モジュールの初期化。 

<li> fini

モジュールの終了。 

<li> convert

現在の preedit テキスト (ひらがな列) をかな漢字テキストに変換する。 

<li> change

現在のセグメントの候補の変遷を記録する。 

<li> resize

現在のセグメントの長さを変更する。 

<li> commit

全セグメントの最新の候補をコミットする。

</ul>

@subsection mimx-anthy-seealso 参照
@ref mdbIM


@section mimx-ispell mimx-ispell -- 入力メソッド <en, ispell> 用外部モジュール

@subsection mimx-ispell-description DESCRIPTION

共有ライブラリ mimx-ispell.so は入力メソッド <en, ispell> に用いら 
れる外部モジュールであり、以下の関数を export している。

<ul>
<li> init

ライブラリの初期化。

<li> fini

ライブラリの終了。 

<li> ispell_word

現在の preedit テキスト (英文) の綴を調べ、間違っていれば候補のリ 
ストを返す。

</ul>

このプログラムはm17n 入力メソッド用外部モジュールの書き方を示すた 
めのものであり、実際の利用を意図したものではない。

@subsection mimx-ispell-seealso 参照
@ref mdbIM