コマンドラインオプション

コマンドラインオプション
txtnovel [options] <textfile>
txtnovel --fontnames <fontfile>

組版を行う場合は、テキストファイルを1つ指定してください。

出力関連の設定は、テキストの方でも指定できます。
コマンドラインオプションがある場合は、テキストの設定よりも、コマンドラインオプションの方が優先されます。

-p,--prefix [STR]
"out"


出力ファイル名の先頭パスを指定します。

この文字列の後に、ページ数と拡張子が自動で追加されるので、「出力ディレクトリ+ファイル名の先頭の名前」で指定してください。
ディレクトリパスの指定がない場合は、カレントディレクトリに出力されます。

[例] -p /path/out/file → "/path/out/file1-100.pdf" or "/path/out/file001.png,..."

PDF で出力する場合、テキストの方で値を設定すると、固定のファイル名にすることもできます。
-f,--format [STR]
pdf


出力フォーマットを指定します。
以下のいずれかを指定してください。
大文字小文字は区別しません。

pdf: PDF
bmp: BMP 画像
png: PNG 画像
jpeg: JPEG 画像
psd: PSD 画像 (Photoshop 形式、レイヤなし)
-d,--dpi [N]
-w,--width [N]
-h,--height [N]
600 dpi


画像出力時、画像のサイズを指定します。
裁ち切りを含む用紙サイズを、指定したサイズで出力することになります。

これらのオプションは、3つのうち1つだけが有効です。
複数指定された場合は、最後に指定されたオプションが有効になります。

dpi: 指定 DPI で出力した場合のサイズになります。
width: px 単位で、画像の幅を指定します。
height: px 単位で、画像の高さを指定します。
-a,--aa
-A,--no-aa
300 dpi 未満で ON


画像出力時、文字などをアンチエイリアスありで描画するかどうかを指定します。

--aa: アンチエイリアスを ON にします。
--no-aa: アンチエイリアスを OFF にします。

デフォルトでは、実際に出力される画像のサイズから DPI を計算した時に、300 dpi 以上になる場合は OFF、300 dpi 未満の場合は ON にします。
-g,--grid画像出力時、グリッドの描画を常に ON にします。
テキストの設定で OFF になっていても、ON になります。
-s,--no-pdfsepPDF 出力時、本文内で PDF 分割が指定されていても、PDF 分割を行いません。
-n,--no-cacheフォントのキャッシュファイルを作成しません。

※このオプションは、フォントの読み込み時にキャッシュを作成しないだけで、すでに作成されているキャッシュファイルはそのまま読み込みます。
--fontnames引数で指定されたフォントファイルから、フォント名 (PostScript 名) の一覧を表示します。
このオプションがある場合、テキストの処理は行われません。

*.ttc/*.otc のフォントファイルには、1つのファイルに複数のフォントが含まれているため、フォントの index 値を指定する必要があります。
このオプションを使うことで、各 index 値にどのフォントが対応しているのかを確認できます。
-V,--versionプログラムのバージョン情報を表示します
--helpヘルプを表示します
フォントのキャッシュファイルについて
文字のレイアウトを行うために、まずは、使用するフォントファイルを読み込んで、必要な情報を取得する必要があります。

新しいフォントファイルを読み込んだ時、デフォルトでは、現在のカレントディレクトリに「フォントのファイル名からディレクトリを除いた名前 + '_' + index 値 + '.cache'」のファイル名で、フォントのキャッシュファイルが作成されます。

このファイルには、レイアウト時に必要になる情報(グリフの幅、Unicode→GID のマップ、GSUB のグリフ置換データなど)が含まれています。

キャッシュファイルを作成することにより、次回以降、同じフォントを読み込む際に、フォントファイルを一から解析する必要がなくなるので、処理時間を短縮できます。

同じフォントを何度も繰り返し使用する場合は、キャッシュファイルを有効に活用できます。
逆に、プログラムを一度しか実行しない場合など、キャッシュを作成する必要がない時は、コマンドラインオプションで --no-cache を指定してください。

  • フォントファイルが更新されると、キャッシュファイルも再作成されます。
  • キャッシュファイルは、不要になった時に手動で削除してください。
  • 存在するディレクトリが異なっていても、ファイル名自体が同じフォントファイルは、同じキャッシュファイル名になります。
キャッシュディレクトリの指定
フォントのキャッシュファイルの場所を指定したい場合は、環境変数 TXTNOVEL_CACHE_DIR を設定して、ディレクトリの文字列をセットしてください。

# 実行時に指定する
$ env TXTNOVEL_CACHE_DIR="/path/dir" txtnovel test.txt

# ~/.bashrc などで設定する
export TXTNOVEL_CACHE_DIR="/path/dir"