USB メモリ活用講座
【実践編・texdoc ポータブル化】

< 最終更新日: 2021-05-16 >

texdoc の基本的な使い方

texdoc はコマンドですので,コマンドプロンプトを開いてキーボードから必要事項をタイプして使うのが基本です. たとえば,pLaTeX2e 新ドキュメントクラス について知りたい場合には,次のように入力します:

texdoc jsclasses Enter

すると,PDF ビューアが起動されて,U:\w32tex\share\texmf-dist\doc\platex\jsclasses にある jsclasses.pdf が開かれるはずです. もし,「'texdoc' は、内部コマンドまたは外部コマンド、操作可能なプログラムまたはバッチファイルとして認識されていません。」と表示される場合には,W32TeX ポータブル化の設定が済んでいるコマンドプロンプトからお試しください.

texdoc の後ろに付ける検索対象キーワードとしては,コマンド名 (platexdvipdfmx など),パッケージ名 (jarticlegraphicxhyperref など) が指定できますが,必ずしも期待したドキュメントが開かれるとは限りません. また,(当たり前のことですが) 和文ではなく,英文が表示される方が多いかもしれません. タイプミスをしたり,適切なキーワードを指定しないと,該当するドキュメントが見つからないといったメッセージが表示されることもあります.

そのような場合には,-l (または --list) オプションを付けて texdoc を起動し,関連がありそうな候補を表示させてみるとよいかもしれません. たとえば,dvipdfmx について調べたい場合,次のように入力してみます:

texdoc -l dvipdfmx Enter

候補が多い場合には,その数と Display them all? (y/N) といったメッセージが表示されます. y キーをタイプして表示されるリストから dvipdfm-w32.txt とある行の左端の番号をタイプして Enter キーをタイプすると,日本語の PDF ファイルを作成するのに有用な情報が得られます. さらに広い範囲で候補を探したい場合は,-s (または --showall) オプションを試してみるとよいでしょう.

ちなみに,texdoc 自身の使い方は,-h (または --help) オプションで表示されます. さらに詳しい使い方は,texdoc 自身で調べてみるとよいでしょう.

texdoc texdoc Enter

texdoc のビューア設定

texdoc は,テキスト/HTML/PDF/PostScript/DVI ファイルなどを,それぞれに関連付けられたアプリケーションで開いてくれます. しかし USB ポータブル環境では,ホストとなる Windows PC に PostScript や DVI ファイルを開くためのアプリケーションがインストールされ,拡張子が関連付けられているとは限りません (W32TeX のドキュメントのほとんどはテキストか,MD か PDF なのですが). 拡張子に関連付けられたアプリケーションがあるとしても,それが期待する動作をしてくれるとも限りません. たとえば Adobe Acrobat がインストールされた PC では,PostScript ファイルは Acrobat Distiller に関連付けられており,問答無用で PDF ファイルへの変換が実行されてしまうかもしれません.

今どきの標準的な Windows PC であれば,HTML や PDF が開けないということはないと思いますが,ホスト PC 内のアプリケーションの「最近使用したファイル」などの履歴に USB メモリ上のファイルの情報が残ってしまうことが気になるという方もいるかもしれません. さらに,テキストファイルは more コマンドによって表示されますので,コマンドプロンプトが苦手な方には使いにくいことと思われます (とりあえずは,スペースキーでページ送り,Q キーで終了といった操作を覚えておけば大丈夫なのですが).

texdoc では環境変数 PAGER_texdocMDVIEWER_texdocBROWSER_texdocPDFVIEWER_texdocPSVIEWER_texdocDVIVIEWER_texdoc の設定に従って,各種ドキュメントを開くビューアの指定ができるようですので,これらを利用して texdoc が呼び出すビューアを変更してみましょう※1

TeXworks のポータブル設定で編集した texenv.vbs の後半 (環境変数 GS_OPTIONS を設定した後など) に次のようなコードを追加します:

' texdoc のビューア設定
objEnv.Item("PAGER_texdoc") = "start terapad /rl"
objEnv.Item("MDVIEWER_texdoc") = "start terapad /rl"
objEnv.Item("BROWSER_texdoc") = strDrv & "\PortableApps\FirefoxPortable\FirefoxPortable.exe"
objEnv.Item("PDFVIEWER_texdoc") = "start SumatraPDF"
objEnv.Item("PSVIEWER_texdoc") = "start SumatraPdf"
objEnv.Item("DVIVIEWER_texdoc") = "wakedvi.vbs"

Free C++ Compiler ポータブル化の設定 (別解) で紹介した Command Prompt Portable のバッチファイルを編集して利用する場合には,次の5行を加えます:

set PAGER_texdoc=start terapad /rl
set MDVIEWER_texdoc=start terapad /rl
set BROWSER_texdoc=%~d0\PortableApps\FirefoxPortable\FirefoxPortable.exe
set PDFVIEWER_texdoc=start SumatraPdf
set PSVIEWER_texdoc=start SumatraPdf
set DVIVIEWER_texdoc=wakedvi.vbs

それぞれの環境変数の設定について,以下で簡単に補足説明します.

PAGER_texdoc
テキストファイルを開くビューア (エディタ) を指定します. ここでは,テキストエディタ TeraPad を書き換え禁止モードで利用することにしています※2
MDVIEWER_texdoc
MD ファイル (中身はテキストファイル) を開くビューア (エディタ) を指定します. ここでは,テキストエディタ TeraPad を書き換え禁止モードで利用することにしています※2
BROWSER_texdoc
HTML ファイルを開くビューア (Web ブラウザ) を指定します. ここでは,PortableApps.com が配布している Mozilla Firefox を利用することにしています.
PDFVIEWR_texdoc
PDF ファイルを開くビューアを指定します. ここでは,SumatraPDF を利用することにしています※2
PSVIEWER_texdoc
PostScript ファイルを開くビューアを指定します. ここでは,Ghostscript へのパスや環境変数が設定されているものとして,SumatraPDF をビューアとして利用することにしています.
DVIVIEWER_texdoc
DVI ファイルを開くビューアを指定します. ここでは,dviout for Windows のポータブル化で作成した起動スクリプトを利用することにしています.

ltxpkgdocs を追加する

TeX の魅力の一つに,ユーザ自身でパラメータを調整することで文書の書式を変えたり,マクロやコマンドを定義することで独自の環境や命令を作成できることがあります. それらをパッケージ (スタイルファイル) としてまとめれば,再利用性を高めることができますし,それを他のユーザに提供すれば社会貢献にもつながることでしょう.

世界中の TeX ユーザが作成したパッケージの類を蓄積し,配布している Web サイトとして CTAN (Comprehensive TeX Archive Network) があります. W32TeX では,CTAN で配布される膨大なパッケージの中でも有用なものが ltxpkgs.tar.xz にまとめられています. 以前はこのファイルにマニュアル類もひとまとめに含められていたのですが,2016 年 7 月 8 日からは,スタイルファイルなどのパッケージ本体が ltxpkgs.tar.xz に,マニュアル類が ltxpkgdocs.tar.xz に分離されて配布されるようになりました. マニュアルの大部分は英文で,約 540MB もの空き容量が必要であることなどから,ltxpkgdocs.tar.xz は必須とはいえませんが,USB メモリのアキ容量にゆとりがあり,少しでも TeX を究めたいと思うのであれば,ぜひ追加しておきましょう. 具体的な追加インストール作業は以下の通りです:

  1. W32TeX の配布サイト から ltxpkgdocs.tar.xz (約 401MB) をダウンロードします. ここでは,C:\temp にダウンロードするものとします.
  2. コマンドプロンプトを開き,以下のコマンドによって W32TeX をインストールしたフォルダ (U:\usr\w32tex とします) に移動し,texinstwin.zip に含まれている tar.exe を使って ltxpkgdocs.tar.xz を展開します.
    cd /D U:\usr\w32tex Enter
    tar xJvf C:\temp\ltxpkgdocs.tar.xz Enter

あとは,調べたいパッケージ名を指定して texdoc コマンドを起動すればよいでしょう. たとえば,fancyvrb パッケージについて調べたければ,次のように入力します.

texdoc fancyvrb Enter

ls-R データベースを利用している場合は,mktexlsr コマンドを実行して更新作業を忘れずに行いましょう.

ちなみに,熊澤吉起先生の Web ページでは多くのパッケージが辞書的にまとめられています. 和文の解説や使用例が詳しく紹介されていますので,一度閲覧してみるとよいでしょう.