Skip to content

Document basic JSON-RPC api in CLI options #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ann0see merged 2 commits into from
Mar 16, 2022
Merged

Document basic JSON-RPC api in CLI options #724

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bbcede
Document JSON-RPC CLI options
ann0see Mar 15, 2022
55fa7d3
Remove unneeded space
ann0see Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions wiki/en/Include-Shared-Commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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