From 3bbcede4c06d27ca642a3e626fd2321fb8805c1c Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Tue, 15 Mar 2022 23:25:37 +0100 Subject: [PATCH 1/2] Document JSON-RPC CLI options --- wiki/en/Include-Shared-Commands.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/wiki/en/Include-Shared-Commands.md b/wiki/en/Include-Shared-Commands.md index 313409e4c..d7b99e799 100644 --- a/wiki/en/Include-Shared-Commands.md +++ b/wiki/en/Include-Shared-Commands.md @@ -1,11 +1,13 @@ [comment]: # (This is an include file for use in multiple documents) -- `-h` or `--help` Display help text -- `-i` or `--inifile` Set location of initialization file (overrides default) -- `-n` or `--nogui` Disable GUI (for use in headless mode) -- `-p` or `--port` Sets the local UDP port number. Default is 22124 -- `-Q` or `--qos` Sets the quality of service DSCP value. Default is 128. Disable with 0. QoS is ignored by Windows. To enable it, [see this page](QOS-Windows) -- `-t` or `--notranslation` Disable UI language translations -- `-6` or `--enableipv6` Enable IPv6 addressing (IPv4 is always enabled) -- `-v` or `--version` Output version information and exit +- `-h` or `--help` Display help text +- `-i` or `--inifile` Set location of initialization file (overrides default) +- `-n` or `--nogui` Disable GUI (for use in headless mode) +- `-p` or `--port` Sets the local UDP port number. Default is 22124 +- `--jsonrpcport` Enables JSON-RPC API server to control the app, set TCP port number (EXPERIMENTAL, APIs might change; only accessible from localhost). Please see [the JSON-RPC API Documentation file](https://github.com/jamulussoftware/jamulus/blob/master/docs/JSON-RPC.md). +- `--jsonrpcsecretfile` Required when using `--jsonrpcport`. Sets a path to a text file containing an authentication string for getting access to the JSON-RPC API. +- `-Q` or `--qos` Sets the quality of service DSCP value. Default is 128. Disable with 0. QoS is ignored by Windows. To enable it, [see this page](QOS-Windows) +- `-t` or `--notranslation` Disable UI language translations +- `-6` or `--enableipv6` Enable IPv6 addressing (IPv4 is always enabled) +- `-v` or `--version` Output version information and exit From 55fa7d376d778963f3cb88359422f217ec915733 Mon Sep 17 00:00:00 2001 From: ann0see <20726856+ann0see@users.noreply.github.com> Date: Wed, 16 Mar 2022 07:36:05 +0100 Subject: [PATCH 2/2] Remove unneeded space Co-authored-by: Thai Pangsakulyanont --- wiki/en/Include-Shared-Commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/wiki/en/Include-Shared-Commands.md b/wiki/en/Include-Shared-Commands.md index d7b99e799..8c8122bb8 100644 --- a/wiki/en/Include-Shared-Commands.md +++ b/wiki/en/Include-Shared-Commands.md @@ -9,5 +9,5 @@ - `--jsonrpcsecretfile` Required when using `--jsonrpcport`. Sets a path to a text file containing an authentication string for getting access to the JSON-RPC API. - `-Q` or `--qos` Sets the quality of service DSCP value. Default is 128. Disable with 0. QoS is ignored by Windows. To enable it, [see this page](QOS-Windows) - `-t` or `--notranslation` Disable UI language translations -- `-6` or `--enableipv6` Enable IPv6 addressing (IPv4 is always enabled) +- `-6` or `--enableipv6` Enable IPv6 addressing (IPv4 is always enabled) - `-v` or `--version` Output version information and exit