Update -h and man page as per jamuluswebsite/pull/714 #2448
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,82 +60,99 @@ is also possible. | |
| .Pp | ||
| One participant starts | ||
| .Nm | ||
| in Server mode, ideally on a dedicated server (virtual) machine; | ||
| all participants start the (graphical) Client which transmits audio | ||
| to the Server, receiving back a mixed stream. | ||
|
Collaborator
There was a problem hiding this comment.
By whom?
Collaborator
There was a problem hiding this comment. The "Server" here is the Jamulus Server instance, not the machine it's running on. |
||
| Use of a metronome is recommended. | ||
| Clients should be connected using ethernet, not wireless, and use | ||
| proper headphone and microphone connections, not Bluetooth. | ||
| The Server should run on a low-latency system, ideally not a VM. | ||
|
Collaborator
There was a problem hiding this comment.
So why say "(virtual)" on line 63? |
||
| .Pp | ||
| Running | ||
| .Nm | ||
| without any extra options launches the full graphical Client. | ||
|
|
||
| .Pp | ||
| The options are as follows: | ||
|
Collaborator
There was a problem hiding this comment. The options are all a bit mixed up here. In the
Member
Author
There was a problem hiding this comment. Last we spoke about this man page business, we hoped we'd automate it all out of
Contributor
There was a problem hiding this comment. @pljones options in manpages are supposed to be alphabetically sorted, case-insensitive (uppercase @gilgongo manpages are supposed to be much more than just an option summary (you can get that from
Collaborator
There was a problem hiding this comment.
They are alphabetical. They're just in separate sections that aren't related. |
||
| .Bl -tag -width Ds | ||
| .It Fl 6 | Fl \-enableipv6 | ||
| enable IPv6 support | ||
| .It Fl c | Fl \-connect Ar address | ||
| .Pq Client mode only | ||
|
Contributor
There was a problem hiding this comment. probably okay to uppercase this, but looks weird |
||
| connect to the given Server | ||
|
|
||
| .Ar address | ||
| .Pq Ar hostname Ns Op Ar :port | ||
| at startup | ||
| .It Fl d | Fl \-discononquit | ||
| .Pq Server mode only | ||
| disconnect all Clients on quit | ||
|
|
||
| .It Fl e | Fl \-directoryserver Ar hostname | ||
| .Pq Server mode only | ||
| Register the Server with the given Directory by setting the Directory Server Address to use to | ||
| .Ar hostname ; | ||
| see also | ||
| .Fl o ; | ||
| to be a Directory Server, use | ||
| .Dq Li localhost | ||
| .It Fl F | Fl \-fastupdate | ||
| .Pq Server mode only | ||
| use 64 samples frame size mode, which reduces latency if Clients connect with | ||
| .Dq enable small network buffers | ||
| turned on; requires a faster CPU to avoid dropouts and uses more bandwidth to | ||
| connected Clients | ||
| .It Fl \-jsonrpcsecretfile Ar file | ||
| (Server mode only) | ||
| Set the path to a text | ||
| .Ar file | ||
| containing an authentication string for obtaining access to the JSON-RPC API. | ||
| This option is required when | ||
| .Fl \-jsonrpcport | ||
| is used. | ||
| .It Fl \-jsonrpcport Ar port | ||
| (Server mode only) | ||
| Enables JSON-RPC API server to control the application, set the TCP | ||
| .Ar port | ||
| number. | ||
| This API is | ||
| .Em experimental | ||
| and may change. | ||
| It is only accessible from localhost. | ||
| Please refer to the JSON-RPC API Documentation. | ||
| .It Fl f | Fl \-listfilter Ar filter | ||
| .Pq Directory mode only | ||
| whitelist which Servers are allowed to register on the server list; | ||
| .Ar filter | ||
| must consist of semicolon-separated IP addresses | ||
| .It Fl h | Fl \&? | Fl \-help | ||
| display a short help text and exit immediately | ||
| .It Fl i | Fl \-inifile Ar file | ||
| .Pq Client and non-headless Server mode only | ||
| override default initialisation file with | ||
| .Ar file | ||
| .It Fl j | Fl \-nojackconnect | ||
| .Pq Client mode only | ||
| do not automatically connect to JACK | ||
| .It Fl L | Fl \-licence | ||
| .Pq Server mode only | ||
| require Clients to accept the agreement shown in the welcome message | ||
| .Pq use Fl w No to set the text | ||
| before they are allowed joining | ||
| .It Fl l | Fl \-log Ar file | ||
| .Pq Server mode only | ||
| enable logging to | ||
| .Ar file | ||
| .It Fl M | Fl \-mutestream | ||
| .Pq Client mode only | ||
| start in muted state | ||
| .It Fl m | Fl \-htmlstatus Ar file | ||
| .Pq Server mode only | ||
| write Server status and list of connected Clients, in HTML format, to | ||
| .Ar file | ||
| periodically | ||
| .It Fl n | Fl \-nogui | ||
| disable the GUI | ||
| .It Fl o | Fl \-serverinfo Ar info | ||
| .Pq Registered Servers only | ||
| set Server location details, formatted as | ||
| .Sm off | ||
| .Xo | ||
| .Ar name Li \&; | ||
|
|
@@ -151,7 +168,7 @@ see | |
| .Pa https://doc.qt.io/qt\-5/qlocale.html#Country\-enum | ||
| for a list | ||
| .It Fl P | Fl \-delaypan | ||
| .Pq Server mode only | ||
| start with delay panning enabled | ||
| .It Fl p | Fl \-port Ar number | ||
| set the local UDP port to use to | ||
|
|
@@ -163,45 +180,45 @@ set QoS | |
| .Pq iptos byte | ||
| to use | ||
| .Pq default: 128 | ||
| .It Fl R | Fl \-recording Ar Directory | ||
| .Pq Server mode only | ||
| enable recording | ||
| .Pq but see Fl \-norecord | ||
| storing tracks in | ||
| .Ar Directory | ||
| .It Fl s | Fl \-server | ||
| start in Server mode | ||
| .It Fl T | Fl \-multithreading | ||
| .Pq Server mode only | ||
| use multithreading to make better use of multi-core CPUs and | ||
| support more Clients | ||
| .It Fl t | Fl \-notranslation | ||
| disable translations, use built-in English strings | ||
| .It Fl u | Fl \-numchannels | ||
| .Pq Server mode only | ||
| set maximum number of channels | ||
| .Pq and , therefore , users ; | ||
| default is 10, maximum is 150 | ||
| .It Fl v | Fl \-version | ||
| display version information and exit immediately | ||
| .It Fl w | Fl \-welcomemessage Ar message | ||
| .Pq Server mode only | ||
| show | ||
| .Ar message | ||
| .Pq may contain HTML and inline CSS | ||
| to users on connect | ||
| .It Fl z | Fl \-startminimized | ||
| .Pq Server mode only | ||
| start with minimised window | ||
| .It Fl \-centralserver Ar hostname | ||
| .Pq Server mode only | ||
| deprecated alias for | ||
| .Fl \-directoryserver | ||
| .It Fl \-clientname Ar name | ||
| .Pq Client mode only | ||
| set window title and JACK client name | ||
| .It Fl \-ctrlmidich Ar MIDISetup | ||
| .Pq Client mode only | ||
| set MIDI controller channel to listen on, control number offset and | ||
| consecutive CC numbers (channels); format: | ||
| .Sm off | ||
|
|
@@ -227,48 +244,47 @@ left to right. | |
| does not provide feedback as to the current state of the Solo and Mute | ||
| buttons so the controller must track and signal their state locally. | ||
| .It Fl \-directoryfile Ar file | ||
| .Pq Directory mode only | ||
| remember registered Servers even if the Directory is restarted | ||
|
Contributor
There was a problem hiding this comment. lowercase (also most of the others above here)…
Collaborator
There was a problem hiding this comment. You've completely missed the point. |
||
| .It Fl \-mutemyown | ||
| .Pq headless Client only | ||
| mute my channel in my personal mix | ||
| .It Fl \-norecord | ||
| .Pq Server mode only | ||
| do not automatically start recording even if configured with | ||
| .Fl R | ||
| .It Fl \-serverbindip Ar ip | ||
| .Pq Server mode only | ||
| configure Legacy IP address to bind to | ||
| .It Fl \-serverpublicip Ar ip | ||
| .Pq Server mode only | ||
| configure public legacy IP address when both the Directory Server | ||
|
Collaborator
There was a problem hiding this comment. Why is the word "legacy" here at all?
Contributor
There was a problem hiding this comment. “Legacy IP” is the contemporary wording for IPv4 (IP is IPv6). This was introduced into networking terminology a small number of years ago.
Collaborator
There was a problem hiding this comment. So that all us old timers feel old... |
||
| and the actual Server are situated behind the same NAT, so that | ||
| Clients can connect | ||
| .It Fl \-showallservers | ||
| .Pq Client mode only | ||
| show all registered Servers in the serverlist regardless whether a ping | ||
| to the Server is possible or not | ||
| .Pq debugging command | ||
| .It Fl \-showanalyzerconsole | ||
| .Pq Client mode only | ||
| show analyser console to debug network buffer properties | ||
| .Pq debugging command | ||
| .El | ||
| .Pp | ||
| Note that the debugging commands are not intended for general use. | ||
| .Pp | ||
| .Nm Jamulus | ||
| knows four modes of operation: Client mode and three kinds of Server | ||
| .Pq Unregistered, Registered, Directory. | ||
| A Unregistered Server is unlisted, Clients can only connect if given | ||
|
Collaborator
There was a problem hiding this comment.
Not necessarily "IP address" - the host name is perfectly acceptable, if available. Port number is only necessary when it's not the default value. This can be covered here. Or link to the website for further discussion of "Server Address". |
||
| the address (IP address and port). | ||
| A Registered Server will contact a Directory (whose address must be | ||
| given at Server startup) and show up in that Server's list; Clients | ||
| can retrieve a list of Registered Servers from the Directory Server. | ||
|
Collaborator
There was a problem hiding this comment.
And anywhere else.
Member
Author
There was a problem hiding this comment. It is. He said he'd be able to help with formatting, but not content. |
||
| Several Registered Directories are operated by the Jamulus project; | ||
| there is a Directory for each genre, which is how Registered Jamulus | ||
| Servers are categorised into genres. | ||
| .Sh SEE ALSO | ||
| .Xr qjackctl 1 | ||
| .Bl -tag -width Ds | ||
|
|
@@ -277,15 +293,19 @@ online handbook | |
| .It Pa https://jamulus.io/wiki/FAQ | ||
| frequently asked questions | ||
| .It Pa https://jamulus.io/wiki/Running\-a\-Server | ||
| documentation on Server configuration and types | ||
| .It Pa https://jamulus.io/wiki/Server\-Linux#running\-in\-registered\-mode | ||
|
Contributor
There was a problem hiding this comment. 404 Not Found Don’t break the hyperlink.
Collaborator
There was a problem hiding this comment. It won't get released until the website is updated. |
||
| current list of Directory Servers operated by the Jamulus project, | ||
| controlling the | ||
| .Dq genre | ||
| .It Pa https://jamulus.io/wiki/Tips\-Tricks\-More | ||
| verbose | ||
| .Fl \-ctrlmidich | ||
| documentation and other more or less useful information | ||
| .It Pa https://github.com/jamulussoftware/jamulus/blob/master/docs/JSON\-RPC.md | ||
| JSON-RPC API Documentation (see | ||
| .Fl \-jsonrpcport | ||
| above) | ||
| .El | ||
| .Sh AUTHORS | ||
| .An -nosplit | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lowercase
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wrong. The point of the PR is to capitalise "Server", "Client" and other relevant terms where referring to a running instance of Jamulus.