Skip to content

Commit

Permalink
README*.md: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yuk7 committed Mar 24, 2020
1 parent dfb0d67 commit 00c5f1c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
22 changes: 20 additions & 2 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,22 @@

[Alpine Linux with Git-LFS and Sphinx](https://github.com/binarylandscapes/AlpineWSL) (by [binarylandscapes](https://github.com/binarylandscapes))

[Amazon Linux 2](https://github.com/yosukes-dev/AmazonWSL) (by [yosukes-dev](https://github.com/yosukes-dev))

[Arch Linux](https://github.com/yuk7/ArchWSL)

[Artix Linux](https://github.com/hdk5/ArtixWSL) (by [hdk5](https://github.com/hdk5))

[CentOS](https://github.com/yuk7/CentWSL)

[CentOS](https://github.com/fbigun/WSL-Distro-Rootfs) (by [fbigun](https://github.com/fbigun))

[Clear Linux](https://github.com/wight554/ClearWSL/) (by [wight554](https://github.com/wight554))

[Fedora](https://github.com/yosukes-dev/FedoraWSL) (by [yosukes-dev](https://github.com/yosukes-dev))

[Red hat(UBI)](https://github.com/yosukes-dev/RHWSL) (by [yosukes-dev](https://github.com/yosukes-dev))

[Void Linux (glibc)](https://github.com/am11/VoidWSL) (by [am11](https://github.com/am11))

[Void Linux (musl-libc)](https://github.com/am11/VoidMuslWSL) (by [am11](https://github.com/am11))
Expand All @@ -48,8 +58,8 @@ exeのファイル名はインストール名に使用されます。


## 📝使い方(インストール後)
#### exe Usage
```cmd
#### exeの使い方
```
Usage :
<引数なし>
- デフォルト設定で新しいシェルを起動します
Expand All @@ -65,11 +75,14 @@ Usage :
- `--default-uid <uid>`: インスタンスのデフォルトユーザーのuidを<uid>に設定します。
- `--append-path <on|off>`: Windows側のPATH設定をLinux側に引き継ぐ機能のon/offを設定します。
- `--mount-drive <on|off>`: Windowsのドライブをマウントする機能のon/offを設定します。
- `--default-term <default|wt|flute>`: デフォルトのターミナルを設定します。
get [setting]
- `--default-uid`: インスタンスのデフォルトユーザーのuidを取得します。
- `--append-path`: Windows側のPATH設定をLinux側に引き継ぐ機能のon/offを確認します。
- `--mount-drive`: Windowsのドライブをマウントする機能のon/offを確認します。
- `--wsl-version`: WSLのバージョン(1/2)を確認します。
- `--default-term`: このランチャーに設定されたデフォルトのターミナルを確認します。
- `--lxuid`: システム内部で使用されているLxUIDを取得します。
backup [contents]
Expand Down Expand Up @@ -112,6 +125,11 @@ Usage :
[user@PC-NAME dir]$
```

#### "Windows Terminal"をデフォルトのターミナルに設定する
```cmd
>{InstanceName}.exe config --default-term wt
```

#### インスタンスをアンインストール
```cmd
>{インスタンス名}.exe clean
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Note: You can distribute your distribution including wsldl exe.

## 📝How-to-Use(for Installed Instance)
#### exe Usage
```cmd
```
Usage :
<no args>
- Open a new shell with your default settings.
Expand All @@ -76,11 +76,14 @@ Usage :
- `--default-uid <uid>`: Set the default user uid for this distro to <uid>
- `--append-path <on|off>`: Switch of Append Windows PATH to $PATH
- `--mount-drive <on|off>`: Switch of Mount drives
- `--default-term <default|wt|flute>`: Set default terminal window
get [setting]
- `--default-uid`: Get the default user uid in this distro
- `--append-path`: Get on/off status of Append Windows PATH to $PATH
- `--mount-drive`: Get on/off status of Mount drives
- `--wsl-version`: Get WSL Version 1/2 for this distro
- `--default-term`: Get Default Terminal for this distro launcher
- `--lxguid`: Get WSL GUID key for this distro
backup [contents]
Expand Down Expand Up @@ -121,6 +124,11 @@ Usage :
[user@PC-NAME dir]$
```

#### Set "Windows Terminal" as default terminal
```cmd
>{InstanceName}.exe config --default-term wt
```

#### How to uninstall instance
```cmd
>{InstanceName}.exe clean
Expand Down

0 comments on commit 00c5f1c

Please sign in to comment.