Documentation/Nightly/Developers/Launcher - Revision history

JChris.FillionR: /* Builds */

2019-07-27T17:41:02Z

Builds

JChris.FillionR at 17:40, 27 July 2019

2019-07-27T17:40:13Z

Lasso at 01:25, 25 April 2018

2018-04-25T01:25:33Z

Lasso at 01:24, 25 April 2018

2018-04-25T01:24:57Z

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:56:57Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

JChris.FillionR: 4.1 -> Nightly

2012-08-22T16:52:52Z

4.1 -> Nightly

New page

{{documentation/underconstruction}}
The [[Slicer3:Launcher|Slicer3 launcher]] has been ported to Qt in Slicer4.

<pre>
Usage
Slicer [options]

Options
--launcher-help Display help
--launcher-verbose Verbose mode
--launch Specify the application to launch
--launcher-detach Launcher will NOT wait for the application to finish
--launcher-no-splash Hide launcher splash
--launcher-timeout Specify the time in second before the launcher kills the application. -1 means no timeout (default: -1)
--launcher-generate-template Generate an example of setting file
--designer Start Qt designer using Slicer plugins
--xterm Start xterm
--gdb Start gdb
--, --ignore-rest Ignores the rest of the labeled arguments following this flag. (default: false)
-h, --help Display available command line arguments.
--disable-python Disable python support. This is equivalent to build the application with Slicer_USE_PYTHONQT=OFF.
--python-script Python script to execute after slicer loads.
--python-code Python code to execute after slicer loads.
--ignore-slicerrc Do not load the Slicer resource file (~/.slicerrc.py).
--disable-cli-modules Disables the loading of Command Line Modules.
--disable-loadable-modules Disables the loading of Loadable Modules.
--disable-scripted-loadable-modules Disables the loading of Scripted Loadable Modules.
--version Displays version information and exits.
--program-path Displays application program path and exits.
--home Displays home path and exits.
--settings-path Displays settings path and exits.
--verbose-module-discovery Enable verbose output during module discovery process.
--disable-settings Start application ignoring user settings.
--disable-message-handlers Start application disabling the 'terminal' message handlers.
--disable-tooltips Disables toolstips in the user interface.
--no-splash Disables the startup splash screen.
--no-main-window Disables display of the main slicer window. Use with --python-script for alternate interface
--show-python-interactor Show Python interactor at startup.
</pre>
== Notes ==
;--launch <executable> [parameters]
:specify the full path of the executable. Use <code>which ''executable''</code> or <code>locate ''executable''</code> to find the full path of an executable.
:''parameters'' is passed to the executable

== Examples ==
.\Slicer.exe --launch "C:\Program Files (x86)\depends22_x86\depends.exe" bin\Debug\MRMLCore.dll
Starts the dependency walker with the MRMLCore.dll library.

= Developers =
The executable Slicer application is: ''Slicer-Superbuild/Slicer-build/Slicer'' (or ''Slicer.exe'')

''Slicer'' is actually a wrapper created using the [http://www.commontk.org/index.php/Tools:_Application_launcher CTK AppLauncher]. The wrapper exists to set library and environment paths before launching the real application binary in ''Slicer-Superbuild/Slicer-build/bin/SlicerQT-real'' (or ''SlicerQT-real.exe'')
*The wrapper is configured in ''[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/SlicerQT/CMakeLists.txt?view=markup Slicer4/Applications/QTGUI/CMakeLists.txt]'' under the heading "Configure Slicer Launcher"
*The launcher configuration is put here: ''Slicer-build/SlicerLauncherSettings.ini''

The launcher is part of the [http://www.commontk.org CTK] effort.

== Source code ==
The AppLauncher source code is here: https://github.com/commontk/AppLauncher

== Builds ==
AppLauncher is built statically with Qt on Windows, Linux and MacOsX:
https://github.com/commontk/AppLauncher/downloads

@@ Line 58: / Line 58: @@
    --qt-testing                                  Enable QtTesting in the user interface
    --exit-after-startup                          Exit after startup is complete. Useful for measuring startup time
 </pre>

← Older revision		Revision as of 07:56, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	{{documentation/underconstruction}}		{{documentation/underconstruction}}
	The [[Slicer3:Launcher\|Slicer3 launcher]] has been ported to Qt in Slicer4.		The [[Slicer3:Launcher\|Slicer3 launcher]] has been ported to Qt in Slicer4.

@@ Line 82: / Line 82: @@
 == Builds ==
-AppLauncher is built statically with Qt on Windows, Linux and MacOsX:
+AppLauncher is built statically with Qt on Windows, Linux and macOS:
-https://github.com/commontk/AppLauncher/downloads
+https://github.com/commontk/AppLauncher/releases

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
-{{documentation/underconstruction}}
 The [[Slicer3:Launcher|Slicer3 launcher]] has been ported to Qt in Slicer4.

@@ Line 7: / Line 7: @@
    Slicer [options]
-Options
+   --launcher-help                              Display help
-   --launcher-help                Display help
+  --launcher-version                           Show launcher version information
-   --launcher-verbose             Verbose mode
+   --launcher-verbose                           Verbose mode
-   --launch                       Specify the application to launch
+   --launch                                     Specify the application to launch
-   --launcher-detach              Launcher will NOT wait for the application to finish
+   --launcher-detach                            Launcher will NOT wait for the application to finish
-   --launcher-no-splash           Hide launcher splash
+   --launcher-no-splash                         Hide launcher splash
-   --launcher-timeout             Specify the time in second before the launcher kills the application. -1 means no timeout (default: -1)
+   --launcher-timeout                           Specify the time in second before the launcher kills the application. -1 means no timeout (default: -1)
-   --launcher-generate-template   Generate an example of setting file
+   --launcher-load-environment                  Specify the saved environment to load.
-   --designer                     Start Qt designer using Slicer plugins
+  --launcher-dump-environment                  Launcher will print environment variables to be set, then exit
-   --xterm                        Start xterm
+   --launcher-show-set-environment-commands     Launcher will print commands suitable for setting the parent environment (i.e. using 'eval' in a POSIX shell), then exit
-   --gdb                          Start gdb
+  --launcher-additional-settings               Additional settings file to consider
-   --, --ignore-rest                     Ignores the rest of the labeled arguments following this flag. (default: false)
+   --launcher-ignore-user-additional-settings   Ignore additional user settings
-   -h, --help                            Display available command line arguments.
+  --launcher-generate-exec-wrapper-script      Generate executable wrapper script allowing to set the environment
-   --disable-python                      Disable python support. This is equivalent to build the application with Slicer_USE_PYTHONQT=OFF.
+   --launcher-generate-template                 Generate an example of setting file
-   --python-script                       Python script to execute after slicer loads.
+   --cmd                                        Start cmd
-   --python-code                         Python code to execute after slicer loads.
-   --ignore-slicerrc                     Do not load the Slicer resource file (~/.slicerrc.py).
+   --, --ignore-rest                             Ignores the rest of the labeled arguments following this flag. (default: false)
-   --disable-cli-modules                 Disables the loading of Command Line Modules.
+   -h, --help                                    Display available command line arguments.
-   --disable-loadable-modules            Disables the loading of Loadable Modules.
+  --testing                                     Activate testing mode. It implies --disable-settings and --ignore-slicerrc. (default: false)
-   --disable-scripted-loadable-modules   Disables the loading of Scripted Loadable Modules.
+   --disable-python                              Disable python support. This is equivalent to build the application with Slicer_USE_PYTHONQT=OFF.
-   --version                             Displays version information and exits.
+   --python-script                               Python script to execute after slicer loads.
-   --program-path                        Displays application program path and exits.
+   --python-code                                 Python code to execute after slicer loads.
-   --home                                Displays home path and exits.
+  -c                                            Python code to execute after slicer loads. By default, no modules are loaded and Slicer exits afterward.
-   --settings-path                       Displays settings path and exits.
+   --ignore-slicerrc                             Do not load the Slicer resource file (~/.slicerrc.py).
-   --verbose-module-discovery            Enable verbose output during module discovery process.
+  --additional-module-path                      Additional module path to consider when searching for modules to load.
-   --disable-settings                    Start application ignoring user settings.
+  --additional-module-paths                     List of additional module path to consider when searching for modules to load.
-   --disable-message-handlers            Start application disabling the 'terminal' message handlers.
+  --modules-to-ignore                           Comma separated list of modules that should *NOT* be loaded.
-   --disable-tooltips                    Disables toolstips in the user interface.
+  --disable-modules                             Disable the loading of any Modules.
-   --no-splash                           Disables the startup splash screen.
+  --disable-builtin-modules                     Disable the loading of builtin Modules.
-   --no-main-window                      Disables display of the main slicer window.  Use with --python-script for alternate interface
+  --disable-cli-modules                         Disable the loading of any Command Line Modules.
-   --show-python-interactor              Show Python interactor at startup.
+   --disable-builtin-cli-modules                 Disable the loading of builtin Command Line Modules.
 </pre>
 == Notes ==
 ;--launch <executable> [parameters]