Skip to content

Commit

Permalink
improve help
Browse files Browse the repository at this point in the history
  • Loading branch information
yuk7 committed Jul 15, 2021
1 parent 8ec96b1 commit 135602c
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 27 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,32 @@ Usage :
- Open a new shell with your default settings.
run <command line>
- Run the given command line in that distro. Inherit current directory.
- Run the given command line in that instance. Inherit current directory.
runp <command line (includes windows path)>
- Run the path translated command line in that distro.
- Run the given command line in that instance after converting its path.
config [setting [value]]
- `--default-user <user>`: Set the default user for this distro to <user>
- `--default-uid <uid>`: Set the default user for this distro to <uid>
- `--default-user <user>`: Set the default user of this instance to <user>.
- `--default-uid <uid>`: Set the default user uid of this instance to <uid>.
- `--append-path <true|false>`: Switch of Append Windows PATH to $PATH
- `--mount-drive <true|false>`: Switch of Mount drives
- `--default-term <default|wt|flute>`: Set default terminal window
- `--default-term <default|wt|flute>`: Set default type of terminal window.
get [setting [value]]
- `--default-uid`: Get the default user uid in this distro
- `--append-path`: Get true/false status of Append Windows PATH to $PATH
- `--mount-drive`: Get true/false status of Mount drives
- `--wsl-version`: Get WSL Version 1/2 for this distro
- `--default-term`: Get Default Terminal for this distro launcher
- `--wt-profile-name`: Get Profile Name from Windows Terminal
- `--lxguid`: Get WSL GUID key for this distro
get [setting]
- `--default-uid`: Get the default user uid in this instance.
- `--append-path`: Get true/false status of Append Windows PATH to $PATH.
- `--mount-drive`: Get true/false status of Mount drives.
- `--wsl-version`: Get the version os the WSL (1/2) of this instance.
- `--default-term`: Get Default Terminal type of this instance launcher.
- `--lxguid`: Get WSL GUID key for this instance.
backup [contents]
- `--tar`: Output backup.tar to the current directory.
- `--reg`: Output settings registry file to the current directory.
clean
- Uninstall the distro.
- Uninstall that instance.
help
- Print this usage message.
Expand Down
4 changes: 2 additions & 2 deletions src/backup/backup.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ func ShowHelp(showTitle bool) {
println("Usage:")
}
println(" backup [contents]")
println(" - `--tar`: Output backup.tar to the current directory")
println(" - `--reg`: Output settings registry file to the current directory")
println(" - `--tar`: Output backup.tar to the current directory.")
println(" - `--reg`: Output settings registry file to the current directory.")
}
2 changes: 1 addition & 1 deletion src/clean/clean.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ func ShowHelp(showTitle bool) {
println("Usage:")
}
println(" clean")
println(" - Uninstall the distro.")
println(" - Uninstall that instance.")
}
6 changes: 3 additions & 3 deletions src/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ func ShowHelp(showTitle bool) {
println("Usage:")
}
println(" config [setting [value]]")
println(" - `--default-user <user>`: Set the default user for this instance to <user>")
println(" - `--default-uid <uid>`: Set the default user for this instance to <uid>")
println(" - `--default-user <user>`: Set the default user of this instance to <user>.")
println(" - `--default-uid <uid>`: Set the default user uid of this instance to <uid>.")
println(" - `--append-path <true|false>`: Switch of Append Windows PATH to $PATH")
println(" - `--mount-drive <true|false>`: Switch of Mount drives")
println(" - `--default-term <default|wt|flute>`: Set default terminal window")
println(" - `--default-term <default|wt|flute>`: Set default type of terminal window.")
}
12 changes: 6 additions & 6 deletions src/get/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,11 @@ func ShowHelp(showTitle bool) {
println("Usage:")
}
println(" get [setting [value]]")
println(" - `--default-uid`: Get the default user uid in this instance")
println(" - `--append-path`: Get true/false status of Append Windows PATH to $PATH")
println(" - `--mount-drive`: Get true/false status of Mount drives")
println(" - `--wsl-version`: Get WSL Version 1/2 for this instance")
println(" - `--default-term`: Get Default Terminal for this instance launcher")
println(" - `--default-uid`: Get the default user uid in this instance.")
println(" - `--append-path`: Get true/false status of Append Windows PATH to $PATH.")
println(" - `--mount-drive`: Get true/false status of Mount drives.")
println(" - `--wsl-version`: Get the version os the WSL (1/2) of this instance.")
println(" - `--default-term`: Get Default Terminal type of this instance launcher.")
println(" - `--wt-profile-name`: Get Profile Name from Windows Terminal")
println(" - `--lxguid`: Get WSL GUID key for this instance")
println(" - `--lxguid`: Get WSL GUID key for this instance.")
}
2 changes: 1 addition & 1 deletion src/run/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -197,5 +197,5 @@ func ShowHelp(showTitle bool) {
println(" - Run the given command line in that instance. Inherit current directory.")
println()
println(" runp <command line (includes windows path)>")
println(" - Run the path translated command line in that instance.")
println(" - Run the given command line in that instance after converting its path.")
}

0 comments on commit 135602c

Please sign in to comment.