Skip to content

Commit 320843b

Browse files
authored
Merge pull request #1759 from henkdegroot/help-text-update
Add reference to website in Help
2 parents 1c08853 + 56dd000 commit 320843b

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

src/main.cpp

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -731,19 +731,22 @@ int main ( int argc, char** argv )
731731
\******************************************************************************/
732732
QString UsageArguments ( char** argv )
733733
{
734-
return "Usage: " + QString ( argv[0] ) +
735-
" [option] [optional argument]\n"
736-
"\nGeneral options:\n"
734+
// clang-format off
735+
return "\n"
736+
"Usage: " + QString ( argv[0] ) + " [option] [optional argument]\n"
737+
"\n"
738+
"General options:\n"
737739
" -h, -?, --help display this help text and exit\n"
738-
" -i, --inifile initialization file name (not\n"
739-
" supported for headless server mode)\n"
740+
" -i, --inifile initialization file name\n"
741+
" (not supported for headless server mode)\n"
740742
" -n, --nogui disable GUI\n"
741743
" -p, --port set the local port number\n"
742744
" -Q, --qos set the QoS value. Default is 128. Disable with 0\n"
743745
" (see the Jamulus website to enable QoS on Windows)\n"
744746
" -t, --notranslation disable translation (use English language)\n"
745747
" -v, --version output version information and exit\n"
746-
"\nServer only:\n"
748+
"\n"
749+
"Server only:\n"
747750
" -d, --discononquit disconnect all clients on quit\n"
748751
" -e, --directoryserver address of the directory server with which to register\n"
749752
" (or 'localhost' to host a server list on this server)\n"
@@ -768,15 +771,21 @@ QString UsageArguments ( char** argv )
768771
" running a slave and your own directory server\n"
769772
" behind the same NAT\n"
770773
" --serverbindip specify the IP address the server will bind to\n"
771-
"\nClient only:\n"
774+
"\n"
775+
"Client only:\n"
772776
" -M, --mutestream starts the application in muted state\n"
773777
" --mutemyown mute me in my personal mix (headless only)\n"
774778
" -c, --connect connect to given server address on startup\n"
775-
" -j, --nojackconnect disable auto Jack connections\n"
779+
" -j, --nojackconnect disable auto JACK connections\n"
776780
" --ctrlmidich MIDI controller channel to listen\n"
777-
" --clientname client name (window title and jack client name)\n"
778-
"\nExample: " +
779-
QString ( argv[0] ) + " -s --inifile myinifile.ini\n";
781+
" --clientname client name (window title and JACK client name)\n"
782+
"\n"
783+
"Example: " + QString ( argv[0] ) + " -s --inifile myinifile.ini\n"
784+
"\n"
785+
"For more information and localized help see:\n"
786+
"\n"
787+
"https://jamulus.io/wiki/Command-Line-Options\n";
788+
// clang-format on
780789
}
781790

782791
bool GetFlagArgument ( char** argv, int& i, QString strShortOpt, QString strLongOpt )

0 commit comments

Comments
 (0)