aboutsummaryrefslogtreecommitdiffstats
path: root/docs/ja/cli_commands.md
diff options
context:
space:
mode:
authorGravatar Takeshi ISHII <2170248+mtei@users.noreply.github.com>2020-06-28 20:27:06 +0900
committerGravatar GitHub <noreply@github.com>2020-06-28 20:27:06 +0900
commite184da91a662b01eb824329087156bd2507bfad6 (patch)
tree57bbf71b9411dbd719e0cce511d964b6078c75b5 /docs/ja/cli_commands.md
parentd36d5ecfad3ea32c11fbf4a251cea7e25caafc28 (diff)
downloadqmk_firmware-e184da91a662b01eb824329087156bd2507bfad6.tar.gz
[Update] Japanese translation of docs/cli.md and docs/cli_commands.md (#9536)
* update docs/ja/cli.md * update docs/ja/cli_commands.md * Update docs/ja/cli.md Co-authored-by: shela <shelaf@users.noreply.github.com> * update docs/ja/cli_commands.md Co-authored-by: shela <shelaf@users.noreply.github.com>
Diffstat (limited to 'docs/ja/cli_commands.md')
-rw-r--r--docs/ja/cli_commands.md160
1 files changed, 99 insertions, 61 deletions
diff --git a/docs/ja/cli_commands.md b/docs/ja/cli_commands.md
index 013689e5e..81cb03cfe 100644
--- a/docs/ja/cli_commands.md
+++ b/docs/ja/cli_commands.md
@@ -1,48 +1,18 @@
# QMK CLI コマンド
<!---
- original document: 0.8.58:docs/cli.md
- git diff 0.8.58 HEAD -- docs/cli.md | cat
+ original document: 0.9.19:docs/cli_command.md
+ git diff 0.9.19 HEAD -- docs/cli_command.md | cat
-->
-# CLI コマンド
-
-## `qmk cformat`
-
-このコマンドは clang-format を使って C コードを整形します。
-
-引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。
-
-`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。
-
-**指定したファイルに対する使い方**:
-
-```
-qmk cformat [file1] [file2] [...] [fileN]
-```
-
-**全てのコアファイルに対する使い方**:
-
-```
-qmk cformat -a
-```
-
-**origin/master で変更されたファイルのみに対する使い方**:
-
-```
-qmk cformat
-```
-
-**branch_name で変更されたファイルのみに対する使い方**:
-
-```
-qmk cformat -b branch_name
-```
+# ユーザー用コマンド
## `qmk compile`
このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。
+このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
+
**Configurator Exports での使い方**:
```
@@ -113,6 +83,8 @@ $ qmk compile -kb dz60
このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、[ファームウェアを書き込む](ja/flashing.md)を見てください。
+このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
+
**Configurator Exports での使い方**:
```
@@ -141,16 +113,6 @@ qmk flash -b
qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
```
-## `qmk docs`
-
-このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
-
-**使用法**:
-
-```
-qmk docs [-p PORT]
-```
-
## `qmk doctor`
このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。
@@ -175,36 +137,40 @@ qmk doctor [-y] [-n]
qmk doctor -n
-## `qmk json2c`
+## `qmk info`
-QMK Configurator からエクスポートしたものから keymap.c を生成します。
+QMK のキーボードやキーマップに関する情報を表示します。キーボードに関する情報を取得したり、レイアウトを表示したり、基礎となるキーマトリックスを表示したり、JSON キーマップをきれいに印刷したりするのに使用できます。
**使用法**:
```
-qmk json2c [-o OUTPUT] filename
+qmk info [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
```
-## `qmk kle2json`
+このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
-このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
+**例**:
-**使用法**:
+キーボードの基本情報を表示する:
-```
-qmk kle2json [-f] <filename>
-```
+ qmk info -kb planck/rev5
-**例**:
+キーボードのマトリクスを表示する:
-```
-$ qmk kle2json kle.txt
-☒ File info.json already exists, use -f or --force to overwrite.
-```
+ qmk info -kb ergodox_ez -m
+
+キーボードの JSON キーマップを表示する:
+
+ qmk info -kb clueboard/california -km default
+
+## `qmk json2c`
+
+QMK Configurator からエクスポートしたものから keymap.c を生成します。
+
+**使用法**:
```
-$ qmk kle2json -f kle.txt -f
-Ψ Wrote out to info.json
+qmk json2c [-o OUTPUT] filename
```
## `qmk list-keyboards`
@@ -221,6 +187,8 @@ qmk list-keyboards
このコマンドは指定されたキーボード(とリビジョン)の全てのキーマップを列挙します。
+このコマンドはディレクトリを認識します。キーボードのディレクトリにいる場合、自動的に KEYBOARD を入力します。
+
**使用法**:
```
@@ -231,12 +199,82 @@ qmk list-keymaps -kb planck/ez
このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。
+このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。
+
**使用法**:
```
qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
```
+---
+
+# 開発者用コマンド
+
+## `qmk cformat`
+
+このコマンドは clang-format を使って C コードを整形します。
+
+引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。
+
+`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。
+
+**指定したファイルに対する使い方**:
+
+```
+qmk cformat [file1] [file2] [...] [fileN]
+```
+
+**全てのコアファイルに対する使い方**:
+
+```
+qmk cformat -a
+```
+
+**origin/master で変更されたファイルのみに対する使い方**:
+
+```
+qmk cformat
+```
+
+**branch_name で変更されたファイルのみに対する使い方**:
+
+```
+qmk cformat -b branch_name
+```
+
+## `qmk docs`
+
+このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。
+
+**使用法**:
+
+```
+qmk docs [-p PORT]
+```
+
+## `qmk kle2json`
+
+このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
+
+**使用法**:
+
+```
+qmk kle2json [-f] <filename>
+```
+
+**例**:
+
+```
+$ qmk kle2json kle.txt
+☒ File info.json already exists, use -f or --force to overwrite.
+```
+
+```
+$ qmk kle2json -f kle.txt -f
+Ψ Wrote out to info.json
+```
+
## `qmk pyformat`
このコマンドは `qmk_firmware` 内の python コードを整形します。