Update documentation for new command line arguments

This commit is contained in:
Vasily
2019-03-10 23:12:26 +01:00
committed by username223
parent 45bb199a0d
commit 9f24099a93
4 changed files with 13 additions and 13 deletions
+5 -5
View File
@@ -100,15 +100,15 @@ The following actions currently exist:
The application (`AdvancedSettings.exe`) can be run with the following optional arguments:
`"-desktop"`: Creates a settings window on the desktop, but not in VR. Running `startdesktopmode.bat` in the install directory has the same effect.
`"--desktop-mode"`: Creates a settings window on the desktop, but not in VR. Running `startdesktopmode.bat` in the install directory has the same effect.
`"-nosound"`: Forces sound effects off.
`"--force-no-sound"`: Forces sound effects off.
`"-nomanifest"`: Forces not using a `.vrmanifest`.
`"--force-no-manifest"`: Forces not using a `.vrmanifest`.
`"-installmanifest"`: Force installs the `.vrmanifest` and adds the application to autostart. If you're having issues with autostart not working try running the program once with this set. The program will exit early when this flag is set.
`"--force-install-manifest"`: Force installs the `.vrmanifest` and adds the application to autostart. If you're having issues with autostart not working try running the program once with this set. The program will exit early when this flag is set.
`"-removemanifest"`: Force uninstalls the `.vrmanifest`. This should be done every time the application is uninstalled. On Windows it is automatically done by the uninstaller. The program will exit early when this flag is set.
`"--force-remove-manifest"`: Force uninstalls the `.vrmanifest`. This should be done every time the application is uninstalled. On Windows it is automatically done by the uninstaller. The program will exit early when this flag is set.
In addition, the application can receive the command line arguments from the [Easylogging++ library](https://github.com/zuhd-org/easyloggingpp#application-arguments).
+2 -2
View File
@@ -128,7 +128,7 @@ Section "Install" SecInstall
ExecWait '"$INSTDIR\vcredist_x64.exe" /install /quiet'
; Install the vrmanifest
nsExec::ExecToLog '"$INSTDIR\AdvancedSettings.exe" -installmanifest'
nsExec::ExecToLog '"$INSTDIR\AdvancedSettings.exe" --force-install-manifest'
;Store installation folder
WriteRegStr HKLM "Software\OpenVR-AdvancedSettings" "" $INSTDIR
@@ -153,7 +153,7 @@ Section "Uninstall"
!insertmacro TerminateOverlay
; Remove the vrmanifest
nsExec::ExecToLog '"$INSTDIR\AdvancedSettings.exe" -removemanifest'
nsExec::ExecToLog '"$INSTDIR\AdvancedSettings.exe" --force-remove-manifest'
; Delete installed files
!include uninstallFiles.list
+1 -1
View File
@@ -1 +1 @@
start AdvancedSettings.exe -desktop -nosound
start AdvancedSettings.exe --desktop-mode --force-no-sound
+5 -5
View File
@@ -112,7 +112,7 @@ constexpr auto k_forceInstallManifestDescription
= "Forces installing the applications manifest into SteamVR. Application "
"will exit early.";
constexpr auto k_forceRemoveManifest = "force-remove-anifest";
constexpr auto k_forceRemoveManifest = "force-remove-manifest";
constexpr auto k_forceRemoveManifestDescription
= "Forces removing the applications manifest. Application will exit early.";
@@ -287,10 +287,10 @@ void reinstallApplicationManifest( const QString manifestPath )
// The .vrmanifest is used by SteamVR however the exact functiontionality is not
// documented in the official documentation.
// The manifest is installed upon using the NSIS installer for windows (this
// program is called with "-installmanifest" by the installer) and every time
// the program is launched without both "-desktop" and "-nomanifest".
// The OpenVR initialization is necessary for both removing and installing
// manifests.
// program is called with "--force-install-manifest" by the installer) and every
// time the program is launched without both "--desktop-mode" and
// "--force-no-manifest". The OpenVR initialization is necessary for both
// removing and installing manifests.
[[noreturn]] void handleManifests( const bool installManifest,
const bool removeManifest )
{