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

< 最終更新日: 2022-04-09 >

TeX Live マネージャによる追加作業

TeX Live マネージャは,TeX Live 環境を最新の状態に保ったり,関連ツールやパッケージを追加・削除したりするための便利なユーティリティソフトウェアです. ここでは,TeX Live マネージャを使って texdoc コマンドが利用できるようにする手順を紹介します. トラブルシュートの参考になるよう,確認のための作業も含めて説明します.

  1. TeX Live をポータブルインストールした場合は,TeX Live Menu を常駐させ,Command Prompt を開きます. ローカルインストールの場合は,スタートメニューの TeX Live サブメニューから Command Prompt を開きます. なお,TeX Live のインストール作業を管理者権限 (Adminstrator) で行った場合は,それに合わせてください (TeX Live Menu を管理者権限で起動すればよいでしょう).
  2. 次のコマンドを実行してみます.
    texdoc --help Enter
    texdoc の使用法に関する英文メッセージが表示された場合は,この後の追加作業は不要です.texdoc の基本的な使い方へ進んでください. 「'texdoc' は、内部コマンドまたは外部コマンド、操作可能なプログラムまたはバッチファイルとして認識されていません。」と表示される場合には,次に進みます.
  3. TeX Live をインストールしたときと同じ準備作業を行います.
    • ISO イメージからインストールした場合は,ISO イメージをマウントします.
    • ネットワークインストーラを利用した場合は,インターネットに接続します. プロキシサーバ経由のインターネット接続環境を利用しているならば,環境変数を設定します.
  4. コマンドライン版の TeX Live マネージャである tlmgr を使って,texdoc コマンドについて下調べをしてみましょう.
    tlmgr info texdoc Enter
    何行かに渡って TeX Live のデータベースに登録されている texdoc に関する情報が表示されるはずです. インストール済みかどうか (installed),どのくらいのディスク容量が必要か (sizes),どのコレクションに収録されているか (collection) などを確認するとよいでしょう (tlmgr については 次の記事 も参照してください).
  5. texdoc を含むコレクション collection-binextra についても,同様に下調べしてみましょう.
    tlmgr info collection-binextra Enter
    短い説明文 (shortdesc) や,長い説明文 (longdesc) から,TeX に関連する補助的なプログラムをまとめたものであることがわかります. ディスク容量 (sizes) が 172MB 程度ですので,できれば texdoc 単体で追加することにします.
  6. GUI 版の TeX Live マネージャ (図1) を起動します※1
    tlshell Enter
    図1・TeX Liveマネージャ
    図1・TeX Live マネージャ
  7. 図1 中段の「パッケージリスト」の左側「状態」から「未インストール」をクリックします. 図2 のリポジトリのロード (読み込み) に関するダイアログボックスが表示されます. 図2 のように「読み込み完了」と表示されたら 閉じる をクリックして,ダイアログボックスを閉じて,次へ進んでください.
    図2・TeX Live:リポジトリのロード
    図2・TeX Live:リポジトリのロード
    数十秒~数分待っても「読み込み完了」とならない場合は,何らかの不具合が発生している可能性があります. 中止 をクリックしてロードを中断し,トラブルシュートを行ってください.
    • ISO イメージからインストールした場合: ISO イメージをマウントし忘れているか,ドライブレターがインストール時と異なっているかもしれません. 図1 のメニューバーから オプション-リポジトリ とたどると,図3 のダイアログボックスが表示されるので,ローカルディレクトリ をクリックして,ISO イメージをマウントしたドライブを指定しなおしてみてください.
    • ネットワークインストーラを使った場合: TeX Live のインストール時のトラブルシュートを参考にしてください. 図3 でミラーサーバを変更してみるのも効果があるかもしれません.
    図3・TeX Live:リポジトリの変更
    図3・TeX Live:リポジトリの変更
  8. 図1 中段の「パッケージリスト」の右側「検索」欄のテキストボックスに texdoc とタイプします. 図1 下段に検索結果として texdoctexdoc.win32texdoctktexdoctk.win32 の 4 項目が表示されるはずです※2. 名称の左側をクリックするとチェック印が付きますので,texdoctexdoc.win32 にチェックしたら 選択項目をインストール をクリックします.
  9. 図4 のようなダイアログボックスが表示され,インストール作業の進捗状況が表示されます. ファイルの追加・削除が終わると,mktexlsr コマンドが呼び出されて,ls-R データベースの更新が行われます. その完了通知 (done running mktexlsr) が表示されたら,閉じる をクリックすればインストール終了です. なお,ls-R データベースについては ls-R データベースによる組版処理の高速化 を参考にしてください.
    図4・TeX Live:インストールログ
    図3・TeX Live:インストールログ

texdoc の基本的な使い方

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

texdoc jsclasses Enter

すると,PDF ビューアが起動されて,U:\texlive\2022\texmf-dist\doc\platex\jsclasses にある jsclasses.pdf が開かれるはずです.

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

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

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

TeX Live Menu の Command Prompt では,コマンドプロンプトを開くときに,TeX Live のインストール先 (U:\texlive\2022) の下にある tlpkg\installer\tl-cmd.bat が実行されます. このバッチファイル (U:\texlive\2022\tlpkg\installer\tl-cmd.bat) をテキストエディタで編集してみましょう. バッチファイルの最後に start "TeX Live" "%COMSPEC" という行があるはずですので,それより上に次の 7 行を加えます:

if defined PAGER_texdoc goto :SKIP
set PATH=%~d0\usr\bin;%PATH%
set PAGER_texdoc=wakeTXT.bat -ro
set MDVIEWER_texdoc=wakeTXT.bat
set BROWSER_texdoc=wakeHTML.bat
set PDFVIEWER_texdoc=wakePDF.bat
:SKIP

1 行めは,すでに PAGER_texdoc が定義済みであれば,この後の set 命令をスキップするためのオマジナイです※4

2 行めの PATH は一般にパス指定と呼ばれるもので,USB ドライブの \usr\bin に「パスを通して」います※5. それぞれの環境変数の設定について,以下で簡単に補足説明します.

PAGER_texdoc
テキストファイルを開くビューア (エディタ) を指定します. ここでは,テキストエディタを起動するためのバッチファイル wakeTXT.bat を呼び出すことにしています. wakeTXT.bat は次のような内容で,U:\usr\bin に保存しておきます※6
@echo off
start %~d0\PortableApps\Notepad++Portable\Notepad++Portable.exe %*
MDVIEWER_texdoc
MD ファイル (中身はテキストファイル) を開くビューア (エディタ) を指定します. ここでは,テキストエディタを起動するためのバッチファイル wakeTXT.bat を呼び出すことにしています.
BROWSER_texdoc
HTML ファイルを開くビューア (Web ブラウザ) を指定します. ここでは,Web ブラウザを起動するためのバッチファイル wakeHTML.bat を呼び出すことにしています. wakeHTML.bat は次のような内容で,U:\usr\bin に保存しておきます※6
@echo off
start %~d0\PortableApps\FirefoxPortable\FirefoxPortable.exe %*
PDFVIEWR_texdoc
PDF ファイルを開くビューアを指定します. ここでは,PDF ビューアを起動するためのバッチファイル wakeHTML.bat を呼び出すことにしています. wakeHTML.bat は次のような内容で,U:\usr\bin に保存しておきます※6
@echo off
start %~d0\PortableApps\SumatraPDFPortable\SumatraPDFPortable.exe %*

【参考】texdoc に類似する Web サイト

texdoc に類似する TeX のパッケージなどに関する情報を調べることができる Web サイトをいくつか紹介します. ポータブル Web ブラウザ のお気に入り (ブックマーク) として登録しておくとよいかもしれません.

https://texdoc.org/
texdoc のオンライン Web サービスです. 英文です.
http://xyoshiki.web.fc2.com/texindex.html
熊澤吉起先生の Web ページで,多くのパッケージが辞書的にまとめられています. 和文の解説や使用例が詳しく紹介されています.
https://konoyonohana.blog.fc2.com/
多くのパッケージがアルファベット順,目的別順などに整理されています. こちらでも和文の解説や使用例が詳しく紹介されています.