WSLコマンドの各種オプションについて

投稿者: | 2020-06-28

前回はWSL2のUbuntuにLAMP環境を構築しWordPressを導入するまでを説明しました。今回はWSLコマンドの各種オプションの使用方法について説明します。

起動、停止

WSLでインストールされているディストリビューションの起動、停止を行い場合は-dまたは-tコマンドを使用します。

-d <Dist>
--distribution <Dist>
指定したディストリビューションを起動する
-t <Dist>
--terminate <Dist>
指定したディストリビューションを停止する

使用例は以下の通りです。

・WSLにインストールされたUbuntu-20.04を起動する
PS> wsl -d Ubuntu-20.04

・WSLにインストールされたUbuntu-20.04を停止する
PS> wsl -t Ubuntu-20.04

各種ステータスの表示

WSLでインストールされているディストリビューションやバージョンの情報を確認する場合は-lオプションと表示したい項目の追加オプションを指定します。

-l
--list
インストールされているディストリビューションとデフォルトのディストリビューションを表示する
--all インストールまたはアンインストールされた全てのディストリビューションとデフォルトのディストリビューションを表示する
-q
--quiet
現在インストールされているディストリビューションの名前のみ表示する
-v
--verbose
インストールされているディストリビューションの名前とステータス、バージョンを表示する

使用例は以下の通りです。

・WSLにインストールまたはアンインストールされた全てのディストリビューションとデフォルトのディストリビューションを表示する 
PS> wsl -l --all

・現在インストールされているディストリビューションの名前のみ表示する
PS> wsl -l -q

・インストールされているディストリビューションの名前とステータス、バージョンを表示する 
PS> wsl -l -v

ステータスやバージョンを確認する「wsl -l -v」コマンドはよく使用します。オプションを指定せず「wsl -l」で実行した場合はallオプションを指定した時と同じ挙動となります。

バージョン、デフォルトディストリビューションの設定

WSLのバージョン関連の設定やデフォルトのディストリビューションを設定するためにはset-versionやset-default-version、set-defaultオプションを使用します。

--set-version <Dist> <Version> 指定したディストリビューションのバージョンを変更する
--set-default-version <Version> ディストリビューションのデフォルトのバージョンを変更する
--set-default -s <Dist> デフォルトのディストリビューションを設定する

使用例は以下の通りです。

・Ubuntu-20.04のWSLのバージョンを2に変更する
PS> wsl --set-version Ubuntu-20.04 2

・デフォルトのWSLのバージョンを2にする
PS> wsl --set-default-version 2

・デフォルトのディストリビューションをUbuntu-20.04にする
PS> wsl --set-default Ubuntu-20.04

コマンドの実行、ユーザーを指定した起動

コマンドプロンプトやPowerShellからWSLでコマンドを実行する場合は-eオプションを使用します。また、ユーザーを指定してディストリビューションを起動する場合は-uオプションを使用します。

-e <Command>
--exec <Command>
コマンドプロンプトやPowerShellからWSLのディストリビューションにコマンドを実行させる
-u
--user
ユーザーを指定してディストリビューションを起動する

使用例は以下の通りです。

・PowerShellから/usr/local配下のフォルダを表示する
PS> wsl -e ls /usr/local/

・ログインユーザーを指定してUbuntu-20.04を起動する
PS> wsl -d Ubuntu-20.04 -u testuser

-eオプションはsudoコマンドも実行することができます。管理者権限が必要な処理の場合は-eオプションでsudoコマンドを指定し、パスワードを入力することで管理者権限でコマンドを実行できます。

エクスポート、インポート

WSLでディストリビューションの状態をエクスポート、インポートするためにはexportオプションとimportオプションを使用します。

--export <Dist> <FileName> 指定したディストリビューションをtar形式のファイルでエクスポートする
--import <Dist> <InstallLocation> <FileName> <Version> 指定したディストリビューションのファイルをインポートする

使用例は以下の通りです。hogehogeの部分は個別のユーザー名に置き換えてください。

・Ubuntu-20.04をtest.tarという名前でデスクトップにエクスポートする
PS> wsl --export Ubuntu-20.04 C:\Users\hogehoge\Desktop\test.tar

・個別ユーザーのPackagesフォルダにディストリビューション用のフォルダを作成しtarファイルをインポートする 
PS> mkdir C:\Users\hogehoge\AppData\Local\Packages\Ubuntu-test
PS> wsl --import Ubuntu-test C:\Users\hogehoge\Appdata\Local\Packages\Ubuntu-test C:\Users\hogehoge\Desktop\test.tar 2 

シャットダウン

WSLで起動しているマシンを全て停止する場合にはshutdownオプションを使用します。

--shutdown WSLで起動している全てのディストリビューションを直ちに停止する

使用例は以下の通りです。

・WSLで起動している全てのディストリビューションを直ちに停止する
PS> wsl --shutdown

WSLで起動しているディストリビューションを直ちに停止するため、処理等を行っているディストリビューションがある場合はデータ等の破損に繋がる可能性があるため注意が必要です。

登録されたディストリビューションを削除する

WSLに登録されているディストリビューションを削除する場合はunregisterオプションを使用します。

--unregister <Dist> WSLで登録されているディストリビューションを削除する

使用例は以下の通りです。

・WSLで登録しているUbuntu-20.04を削除する
PS> wsl --unregister Ubuntu-20.04

unregisterオプションはデフォルトに設定されているディストリビューションでも削除することができます。一度削除したディストリビューションは、exportオプションでファイルとして保持していない限りは復旧できないため、削除を行う際は注意してください。

ヘルプを表示する

WSLコマンドのヘルプを表示するためにはhelpオプションを使用します。

--help WSLコマンドのヘルプを表示する

使用例は以下の通りです。

・WSLのヘルプを表示する
PS> wsl --help

wslの使用中にコマンドのオプションを確認したい場合にはhelpオプションで確認してください。