Skip to content

Commit 28e8996

Browse files
Tweaks to script help output. (#669)
* chore(platform_scripts): Updating windows help text. * chore(platform_scripts): Updating helper script help text. * chore(platform_scripts): Removed accidental commit. * chore(platform_scripts): Trying to fix windows line endings.
1 parent 0804975 commit 28e8996

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

SignallingWebServer/platform_scripts/bash/common.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ NODE_VERSION=$(<"${SCRIPT_DIR}/../../../NODE_VERSION")
66
function print_usage() {
77
echo "
88
Script usage:
9-
${0} [--help] [--publicip <IP Address>] [--turn <turn server>] [--stun <stun server>] -- [server options...]
10-
Where:
9+
start.sh [script options...] -- [server options...]
10+
Script options:
1111
--help Print this message and stop this script.
1212
--debug Run all scripts with --inspect
1313
--nosudo Run all scripts without \`sudo\` command useful for when run in containers.
@@ -28,7 +28,7 @@ function print_usage() {
2828
--build-wilbur Force build of wilbur
2929
--deps Force reinstall of dependencies
3030
31-
Other options: stored and passed to the server. All parameters printed once the script values are set.
31+
Anything after -- is passed directly to the signalling server.
3232
Command line options might be omitted to run with defaults and it is a good practice to omit specific ones when just starting the TURN or the STUN server alone, not the whole set of scripts.
3333
"
3434
if [[ -d "${SCRIPT_DIR}/../../dist/" ]]; then

SignallingWebServer/platform_scripts/cmd/common.bat

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ GOTO :eof
1414
:Usage
1515
echo.
1616
echo Usage:
17-
echo %0 [--help] [--publicip ^<IP Address^>] [--turn ^<turn server^>] [--stun ^<stun server^>] -- [server options...]
18-
echo Where:
17+
echo start.bat [script options...] -- [server options...]
18+
echo Script options:
1919
echo --help Print this message and stop this script.
2020
echo --publicip Define public ip address (using default port) for turn server, syntax: --publicip ; it is used for
2121
echo Default value: Retrieved from 'curl https://api.ipify.org' or if unsuccessful then set to 127.0.0.1. It is the IP address of the server and the default IP address of the TURN server
@@ -32,7 +32,7 @@ echo --rebuild Force a rebuild of everything
3232
echo --build-libraries Force a rebuild of shared libraries
3333
echo --build-wilbur Force build of wilbur
3434
echo --deps Force reinstall of dependencies
35-
echo Other options: stored and passed to the server.
35+
echo Everything after -- is passed directly to the signalling server executable.
3636
IF exist "%SCRIPT_DIR%..\..\dist" (
3737
pushd %SCRIPT_DIR%..\..
3838
call %NPM% run start --- --help

0 commit comments

Comments
 (0)