前書き

卒業論文を書くために構築した自分のLaTeX環境をこの記事では紹介します。LaTeXをほとんど使ったことがない状態から構築したので、特に初心者の方に役に立つと思います。また、この記事で環境構築が完結するようにそれぞれの操作を丁寧に解説したので、最速で綺麗なLaTeX環境が作れると思います¹。

環境の確認

macOS BigSur 11.1

LaTeXとは

LaTeXとは組版システムのTeX上で開発された文書処理システムのことです。CUIで操作することができるので、慣れればワープロソフトより格段に速く表現力の高い文書を作ることができます。

Homebrewのインストール

TeXはパッケージ管理システムのHomebrew²を利用してインストールすると良いです。こちらの記事にしたがって、Homebrewのインストールを行ってください。

すでにインストールしている方は、以下のコマンドを実行してください³。それぞれのコマンドの意味についても以下の通りです⁴。

% brew update && brew upgrade && brew cleanup

% brew update：Homebrew自体を更新する
% brew upgrade：Homebrewでインストールしたパッケージを更新する
% brew cleanup：Homebrewでインストールした以前のバージョンのパッケージのキャッシュなどを削除する

MacTeXのインストール

次に、Homebrewを利用してMacTeXのインストールを行います。MacTexにはGUIアプリケーション(LaTeXitとTexShop)とTeXLiveとGhostScriptの三つが含まれます。一つ目のコマンドでMacTexをインストールすることができ、二つ目のコマンドでMacTexからGUIアプリケーションを除いたものをインストールすることができます。今回はGUIアプリケーションが必要ないので、二つ目のコマンドを実行すれば良いです。

% brew install --cask mactex 
% brew install --cask mactex-no-gui

また、インストール後にtlmgrなどのTeXに関わるコマンドを実行するには環境変数のPATHに/usr/local/texlive/2022/bin/universal-darwinを追加する必要があります⁵。% echo $PATHの出力に/usr/local/texlive/2022/bin/universal-darwinが含まれていない場合は以下のコマンドを実行してください⁵。ちなみに、exportは環境変数を設定するコマンドです。

% export PATH=$PATH:/usr/local/texlive/2022/bin/universal-darwin

また、その後に以下のコマンドでTeXLiveのアップデートをしてください⁶$^,$⁷。

% sudo tlmgr update --self --all

確認

LaTeXのサンプルファイルhoge.texを用意して% platex hoge.texと% dvipdfmx hoge.dviを順に実行してPDFができることを確認してください。

Latexmkの設定

ここまででLaTeX環境を作成することができました。次に、毎回コマンドをいくつも打たなくても済むように、文書の作成時に必要回数だけタイプセットするためのツールとしてLatexmkを使います。Latexmkの説明は省略しますが、ホームフォルダ(~)に設定ファイルの.latexmkrcを作成しておくとLatexmkの使用時に読み込んでくれます⁸$^,$⁹。

従って、以下では.latexmkrcを作成して編集していきます。まずは% touch ~/.latexmkrcを実行して.latexmkrcを生成してください。その後はエディタで編集すれば良いですが、編集できない場合はfinderの"フォルダへ移動"の検索画面に~を打ち込んで移動した後に隠しファイルを見れるようにすると⁹、直接ファイルを開いて編集できます。

編集できる状態になったら.latexmkrcに以下を貼り付けてください。それぞれのコードの意味は書いてある通りで、%Sはソースファイル,%Oはオプション,%Dは出力ファイルにそれぞれ置き換えられることを表します⁸。

~/.latexmkrc

# 最大のタイプセット回数
$max_repeat = 5;
# DVI経由でPDFをビルドすることを明示
$pdf_mode = 3;

# pLaTeXを使う
# -halt-on-error:初めのエラーで終わらせる
$latex = 'platex %O %S -halt-on-error';

# pBibTeXを使う(参考文献)
$bibtex = 'pbibtex %O %S';

# Mendexを使う(索引)
$makeindex = 'mendex %O -o %D %S';

# DVIからPDFへの変換
$dvipdf = 'dvipdfmx %O -o %D %S';

確認

LaTeXのサンプルファイルhoge.texを用意して%latexmk hoge.texと実行してPDFができることを確認してください。

VSCodeのインストール

MacでのVSCode入門のインストールの項に従ってインストールしてください。また、VSCodeについてもHomebrewでのインストールをお勧めします。

VSCodeの設定

LatexmkをVSCodeと組み合わせるとさらに便利になり、変更して保存するだけでPDFの生成と更新を行うことができます。また、タブでPDFとLaTeXのソースファイルを同時に見ながら作業することもできます。

VSCodeでLaTeXを使うには拡張機能のLaTeX Workshopをインストールすると良いです。インストール後にsettings.json¹⁰$^,$¹¹でLaTeX Workshopの設定をします。VSCodeを開いた状態でCmd + ,のショートカットキーを用い、画面右上に出てくる下記のマークを押して開いたファイルを編集します。

また、settings.jsonに以下のLaTeXの設定の部分を貼り付ければ問題なく動きますが、自分でカスタマイズしてください。

settings.json

{
    //----other settings----

    //----latex settings----
    //viewerをタブで開く
    "latex-workshop.view.pdf.viewer": "tab",
    //intellisenseを有効にする
    "latex-workshop.intellisense.package.enabled": true,
    //生成ファイルを格納するディレクトリ名
    "latex-workshop.latex.outDir": "latex_out",
    //自動でPDFを更新
    "latex-workshop.latex.autoBuild.run":"onFileChange",
    //生成ファイルで削除するファイル
    "latex-workshop.latex.autoClean.run": "onBuilt",
    "latex-workshop.latex.clean.fileTypes": [
        "*.aux","*.bbl","*.blg","*.dvi","*.fdb_latexmk","*.fls","*.synctex.gz","*.toc"
    ],
    //ビルドの動作
    "latex-workshop.latex.recipes": [
        {
            "name": "latexmk",
            "tools": ["latexmk"]
        },
    ],
    //ビルドのコマンド
    "latex-workshop.latex.tools": [
        {
            "name": "latexmk",
            "command": "latexmk",
            "args": ["-outdir=%OUTDIR%","%DOC%.tex"]
        },
    ]

    //----other settings----
}

確認

LaTeXのサンプルファイルhoge.texを開いて保存するだけでhoge.pdfとhoge.logのみがlatex_outに保存されることを確認してください。

Mathpix

もう一つ便利なツールとしてMathpixを紹介します。このツールは論文中の数式をスクショするとLaTeXの数式に変換してくれます。

以下のコマンドを実行するとHomebrew経由でインストールすることができます。もちろん公式サイトからdmgファイルをダウンロードしてインストールすることもできます。

また、使い方については難しくないので、公式サイトを眺めてください。

% brew install --cask mathpix-snipping-tool

参考にすべきサイト

TeX Users Group

TeXの本家のサイトなので、全て載っている
ただし、英語

TeX Wiki

Texに関することが日本語で書かれている
読者参加型なので大抵の内容は書いてある

Latexのサンプルファイル

環境構築の確認用のサンプルファイルです。

hoge.tex

\documentclass[dvipdfmx]{jreport}

\begin{document}

\title{test}
\author{hogefuga}

\maketitle

\section{hoge1}

This is sample.

\section{hoge2}

これはサンプルです。

\end{document}

LaTeXの環境構築に焦点を当てるために省略した部分がある点はご了承ください。 ↩
Homebrewの概要はhomebrewとは何者か。仕組みについて調べてみたを読むと把握できます。 ↩
これ以降、% コマンド名で実行するコマンドを示します。シェルによっては%が$ですが、適宜読み替えてください。 ↩
詳しくはmanコマンドで確認してください。 ↩
2022とuniversal-darwinの部分は環境により異なるので、確かめるようにしてください。 ↩ ↩²
環境によりますが、5分~15分程度はかかると思います。 ↩
--selfがtlmgrのアップデートで,--allがインストールしたパッケージのアップデートを表します。詳しくはmanで確認してください。 ↩
詳しくはLatexmkのドキュメントを参照することをお勧めします。 ↩ ↩²
.がついているファイルを隠しファイルと呼びます。finder上でcommandとshiftと.を同時に押すと、開いているディレクトリにある隠しファイルが表示されます。 ↩ ↩²
$HOME/Library/Application\ Support/Code/Userにあるsettings.jsonを編集してください。 ↩
。VSCodeを快適に使うためのJSON入門にてJSON記法を理解するとスムーズに設定等を行うことができます。 ↩

最速で綺麗なLaTeX環境を構築する手順をまとめてみた(MacOS)

前書き