doc of v13.4

steve02081504 · steve02081504 · commit 8fa5ea1a42c8 · 2023-05-08T17:44:12.000+08:00
diff --git a/README.md b/README.md
@@ -17,9 +17,12 @@ Easy to use for ghost development
 ## Command line arguments  
 
 ```text
+ghost terminal v13.4
+
 ghost_terminal [options]
 options:
-  -h, --help                            : shows this help message.
+  -h, --help                            : shows this help message and exits.
+  -v, --version                         : shows the version number and exits.
   -c, --command <command>               : runs the specified command and exits.
   -s, --sakura-script <script>          : runs the specified Sakura script and exits.
   -g, --ghost <ghost>                   : links to the specified ghost by name.
@@ -29,6 +32,13 @@ options:
   -rwt, --register-to-windows-terminal  : registers to the Windows terminal (requires -g <ghost name> or -gp <ghost folder path>).
         -rwt-name <name>                : registers to the Windows terminal with the specified name (only works with -rwt).
         -rwt-icon <icon>                : registers to the Windows terminal with the specified icon (PNG or ICO path) (only works with -rwt).
+  --disable-text <text types>|all       : disable some unnecessary text(split by ',') or all of them.
+        root                            : disables the easter egg text when running terminal as root.
+        event                           : disables the warning text when your ghost not having some events.
+        WindowsTerminal                 : disables the text telling you to install Windows Terminal or run this exe with -rwt (-g|-gp).
+        FiraCode                        : disables the text telling you try Fira Code font.
+example:
+  ghost-terminal -g "Taromati2" -rwt --disable-text event,WindowsTerminal,FiraCode
 ```
 
 For example:  
@@ -65,6 +75,12 @@ You can use it to control the display of the terminal, such as text colour, back
     - `X-SSTP-PassThru-SmallIcon` (optional)  
       Set the terminal small icon (PNG or ICO path)  
       If not set, will be consistent with `X-SSTP-PassThru-Icon`  
+    - `X-SSTP-PassThru-CustomLoginInfo` (optional)  
+      If set, the terminal will not display the default login information, but will display the content of this  
+      This return value will be simply escaped:  
+      - `\n` will be converted to a newline  
+      - `\t` will be converted to tabs  
+      - `\\` will be converted to `\`  
 - `ShioriEcho.End`  
   ghost_terminal event on normal program exit  
   - return value  
diff --git a/README_CN.md b/README_CN.md
@@ -13,9 +13,12 @@ up/down切换命令，鼠标右键快速粘贴，支持tab补全（如果人格
 ## 命令行参数  
 
 ```text
+ghost terminal v13.4
+
 ghost_terminal [options]
 选项：
-  -h, --help                           : 显示此帮助信息。
+  -h, --help                           : 显示此帮助信息并退出。
+  -v, --version                        : shows the version number and exits.
   -c, --command <command>              : 运行指定的命令并退出。
   -s, --sakura-script <script>         : 运行指定的Sakura脚本并退出。
   -g, --ghost <ghost>                  : 通过名字链接到指定的ghost。
@@ -25,6 +28,13 @@ ghost_terminal [options]
   -rwt, --register-to-windows-terminal : 注册到Windows终端（需要 -g <ghost name> 或 -gp <ghost文件夹路径>）。
         -rwt-name <name>               : 以指定的名字注册到Windows终端（只与-rwt一起工作）。
         -rwt-icon <icon>               : 用指定的图标（PNG或ICO路径）注册到Windows终端（只适用于-rwt）。
+  --disable-text <text types>|all      : disable some unnecessary text(split by ',') or all of them.
+        root                           : disables the easter egg text when running terminal as root.
+        event                          : disables the warning text when your ghost not having some events.
+        WindowsTerminal                : disables the text telling you to install Windows Terminal or run this exe with -rwt (-g|-gp).
+        FiraCode                       : disables the text telling you try Fira Code font.
+example:
+  ghost-terminal -g "Taromati2" -rwt --disable-text event,WindowsTerminal,FiraCode
 ```
 
 比如：  
@@ -61,6 +71,12 @@ ghost_terminal通过`X-SSTP-PassThru-*`进行与人格间的信息沟通（见[
     - `X-SSTP-PassThru-SmallIcon`（可选）  
       设置终端小图标（PNG或ICO路径）  
       如果不设置，将与`X-SSTP-PassThru-Icon`保持一致  
+    - `X-SSTP-PassThru-CustomLoginInfo`（可选）
+      如果设置了，终端将不显示默认的登录信息，但会显示这个的内容。  
+      这个返回值将经过简单转义：  
+      - `\n` 将转换为换行  
+      - `\t` 将转变为制表符  
+      - `\\` 将转化为 `\`  
 - `ShioriEcho.End`  
   ghost_terminal正常程序退出时事件  
   - 返值  
diff --git a/README_EN.md b/README_EN.md
@@ -13,9 +13,12 @@ Easy to use for ghost development
 ## Command line arguments  
 
 ```text
+ghost terminal v13.4
+
 ghost_terminal [options]
 options:
-  -h, --help                            : shows this help message.
+  -h, --help                            : shows this help message and exits.
+  -v, --version                         : shows the version number and exits.
   -c, --command <command>               : runs the specified command and exits.
   -s, --sakura-script <script>          : runs the specified Sakura script and exits.
   -g, --ghost <ghost>                   : links to the specified ghost by name.
@@ -25,6 +28,13 @@ options:
   -rwt, --register-to-windows-terminal  : registers to the Windows terminal (requires -g <ghost name> or -gp <ghost folder path>).
         -rwt-name <name>                : registers to the Windows terminal with the specified name (only works with -rwt).
         -rwt-icon <icon>                : registers to the Windows terminal with the specified icon (PNG or ICO path) (only works with -rwt).
+  --disable-text <text types>|all       : disable some unnecessary text(split by ',') or all of them.
+        root                            : disables the easter egg text when running terminal as root.
+        event                           : disables the warning text when your ghost not having some events.
+        WindowsTerminal                 : disables the text telling you to install Windows Terminal or run this exe with -rwt (-g|-gp).
+        FiraCode                        : disables the text telling you try Fira Code font.
+example:
+  ghost-terminal -g "Taromati2" -rwt --disable-text event,WindowsTerminal,FiraCode
 ```
 
 For example:  
@@ -61,6 +71,12 @@ You can use it to control the display of the terminal, such as text colour, back
     - `X-SSTP-PassThru-SmallIcon` (optional)  
       Set the terminal small icon (PNG or ICO path)  
       If not set, will be consistent with `X-SSTP-PassThru-Icon`  
+    - `X-SSTP-PassThru-CustomLoginInfo` (optional)  
+      If set, the terminal will not display the default login information, but will display the content of this  
+      This return value will be simply escaped:  
+      - `\n` will be converted to a newline  
+      - `\t` will be converted to tabs  
+      - `\\` will be converted to `\`  
 - `ShioriEcho.End`  
   ghost_terminal event on normal program exit  
   - return value  
diff --git a/README_JP.md b/README_JP.md
@@ -15,9 +15,12 @@ ghost_terminalをシステム端末のように使用する
 テキスト
 
 ```text
+ghost terminal v13.4
+
 ghost_terminal [オプション]を指定します。
 オプションで指定します。
-  -h, --help                           : ヘルプメッセージを表示する．
+  -h, --help                           : ヘルプメッセージを表示し、終了する。
+  -v, --version                        : はバージョン番号を表示し、終了する。
   -c, --command <command>              : 指定されたコマンドを実行し、終了する。
   -s, --sakura-script <script>         : 指定されたサクラスクリプトを実行し、終了する。
   -g, --ghost <ghost>                  : 指定されたゴーストに名前でリンクする。
@@ -27,6 +30,13 @@ ghost_terminal [オプション]を指定します。
   -rwt, --register-to-windows-terminal : Windows端末に登録する（-g <ghost name> または -gp <ghost folder path> が必要）．
         -rwt-name <name>               : 指定された名前のWindows端末に登録する（-rwtとの組み合わせでのみ動作）。
         -rwt-icon <icon>               : 指定されたアイコン（PNGまたはICOのパス）でWindows端末に登録します（-rwtとの組み合わせのみ）。
+  --disable-text <text types>|all      : 不要なテキスト（','で分割されたもの）またはそのすべてを無効にする。
+        root                           : は、rootでterminalを実行したときのイースターエッグテキストを無効にします。
+        event                          : ゴーストのイベントがないときの警告文を表示しないようにします。
+        WindowsTerminal                : Windows Terminalをインストールするか、このexeを-rwt (-g|-gp)で実行するように指示するテキストを無効化します。
+        FiraCode                       : Fira Codeフォントを試していることを示すテキストを表示しないようにします。
+example:
+  ghost-terminal -g "Taromati2" -rwt --disable-text event,WindowsTerminal,FiraCode
 ```
 
 例えば、こんな感じです：  
@@ -63,6 +73,12 @@ ghost_terminalの出力は、プレーンテキストではなく、仮想端末
     - `X-SSTP-PassThru-SmallIcon` (オプション)  
       端末の小さいアイコンを設定する  
       設定されていない場合、`X-SSTP-PassThru-Icon`と一致する  
+    - `X-SSTP-PassThru-CustomLoginInfo` (optional)  
+      設定された場合、端末はデフォルトのログイン情報を表示せず、この  
+      この戻り値は、単純にエスケープされます：  
+      - `\n` は改行に変換されます。  
+      - `\t` はタブに変換されます。  
+      - `\\` は `\` に変換される。  
 - `ShioriEcho.End`  
   通常のプログラム終了時に発生するghost_terminalイベント  
   - 戻り値  
