Command Line Arguments

Command line arguments allow you to determine how your Newlook Developer, Smartclient, Smartframe or Embedded Newlook Control session will start.

TIP:

It is possible to combine command line arguments. For instance, if you wanted to auto-connect and set a timeout parameter in Smartclient you would specify the following shortcut target: "C:\Program Files (x86)\Newlook 11.1\looksoftware.Client.exe" -c"AcmeConnection" -t10

Command line arguments

For more information about specifying command line arguments in a deployment package, refer to Smartclient and Smartframe Deployment.

Argument

Can be used with

Description

Example

--backcolor

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Backcolor

Introduced in 11.0.9.

Specifies the backcolor for the client menu, status and function key bars. Also applies to title and function key bars in pop up forms. Equivalent to the BackColor parameter.

 

Input formats compatible with this option include:

  • Named color, for example --backcolor="Red"
  • &H00BBGGRR, for example --backcolor="&H0000CCFF"
  • #RRGGBB, for example --backcolor="#FFCC00"
  • 0xBBGGRR, for example --backcolor="0x00CCFF"

--backcolor="SteelBlue"

-c<"connection">

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Connect

Automatically connect to the specified connection on startup.

Where <"connection"> is the name of a connection that has been configured in Newlook Developer and deployed with Newlook Smartclient, or created in Smartclient itself.

Note:

This -c (connect) argument will take precedence over any startup macro you have specified in your repository. However, if a -r (run macro) argument is also present, then it will take precedence over the -c argument.

-C"Acme Connection"

-d<options>

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Debug

Note:

The legacy -d trace parameter has been replaced by the --trace parameter (see table entry below).

The -d parameter should be used in conjunction with the trace (t) parameter, and one or more logging options, specifying the type of activity that you wish to log. For example, if you wanted to log the datastream and any communications, you would specify the following command line parameter: -dtai.

Debugging options:

t - Enable tracing and write out trace to a log file (select logging options from list below)

Logging options:

a - Log communications API

i - Log datastream

j - Log transactions

k - Log keyboard

l - Log field list

r - Log recognition

u - Log a text dump of each visited screen

y - Log layout

Obsolete The following legacy logging options are obsolete and will not generate any entry in the trace file:

-dc - Log crash information

-dd - Log distribution list

-de - Log Ehllapi

-dn - Log NoSimulate

-dti

--DataPath=<"fully qualified solutions path">

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Data path

Used to specify the fully qualified path of a custom solution folder.

If your data path contains spaces then you will need to surround the path with quotes.

Any solution specified in the -i command line argument will be relative to the path specified in this argument. If not specified, DataPath defaults to C:\ProgramData\Newlook 11.1.

The example on the right will start Smartclient with a DataPath of C:\ACME.

Refer to the DataPath command line parameter topic for more information.

--DataPath="C:\ACME"

--forecolor

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Forecolor

Introduced in 11.0.9.

Specifies the forecolor (font color) of client menu text. Also applies to title bar text in popup forms. Equivalent to the ForeColor parameter.

Input formats compatible with this option include:

  • Named color, for example --backcolor="Red"
  • &H00BBGGRR, for example --backcolor="&H0000CCFF"
  • #RRGGBB, for example --backcolor="#FFCC00"
  • 0xBBGGRR, for example --backcolor="0x00CCFF"

 --forecolor="#FFFFFF"

-h

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Hide Toolbars

Run Smartclient without the menu bar, toolbar or status bar.

-h

--hidedevelopertools

Newlook Developer

Smartframe

Hide developer tools

Introduced in 11.0.9.

Smartframe only.

This argument removes the Chromium Developer Tools option from the system and context menus for Smartframe users. It also prevents template error notifications from displaying on the status bar of Smartframe. It is important to note that enabling this command line argument will not prevent application errors from displaying in Smartframe, only errors generated by your template code.

--hidedevelopertools

--hidetoolbars=<option>

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Hide Toolbars (extended)

Introduced in 11.0.5.

This argument is an alternative to the -h parameter above.

It provides more granular control over the display of specific toolbar elements.

HideToolbar options:

0 - Hide none (display all toolbars)

2 - Hide menu bar

32 - Hide function key bar (in both full screen and pop up)

64 - Hide status bar

512 - Hide function key bar (in full screen only)

-1 - Hide all toolbars

The above values can be added together if you wish to hide more than one tool bar. For example, to hide only the menu and status bars, specify the value 66 (64 + 2).

--hidetoolbars=66

--html=<"HTML file">

Newlook Developer

Smartframe

HTML

Introduced in 11.0.0.

Smartframe only.

Specifies the startup HTML file to load when Smartframe starts. This is the equivalent of the Smartframe URL. (Smartframe only).

The example on the right will start Smartframe with the Fixed Size template in the @Acme solution folder.

Refer to the HTMLStartup command line parameter topic for more information.

--html="@Acme\Fixed Size\SmartFrame.html"

-i<"filename">

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Load solution

Start Newlook Smartclient using the specified solution.

Note: Any file path specified here is relative to the path defined in the Data Path command line option. If not specified, the DataPath defaults to C:\ProgramData\Newlook 11.1.

If your solution path contains spaces then you will need to surround the path with quotes.

If the -i parameter is not specified, Smartclient will attempt to open Newlook.ini.

This option is particularly helpful if you have more than one solution, as you can configure multiple desktop shortcuts to point to different .ini files.

The example on the right will start Smartclient with the @Acme\Acme.ini solution file.

-i"@Acme\Acme.ini"

-l

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Save last screen

Smartclient only

This argument saves the last screen visited as an .nl file ().

In the event that Newlook Smartclient is unable to properly recognize a screen, or prematurely terminates while attempting to display a host screen, the –l argument can be used to save screen information before Newlook terminates. This option can be useful if you are experiencing issues with a particular screen and need to send details to Support.

The last screen visited will saved in the C:\ProgramData\Newlook 11.1 folder with the name Lastscr.nl.

Warning:

The -l option should only be used for capturing problem screens. Having this option active at all times will impose a significant performance penalty.

-l

--lang=<"culture">

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Language

Introduced in 11.0.6.

Set language for the display of Smartclient menus and dialogs.

Where: <culture> can currently be either “en-US” or “ja-JP” (using “English” or “Japanese” will also work).

--lang="ja-JP"

-m<count>

 

Multiple sessions

Obsolete The 'Start multiple sessions' command line argument is obsolete from Newlook 11.0 onwards and will generate a runtime error if used in a shortcut.

Start the specified number of sessions (Ignored if the -c command line parameter is not also specified).

Each session is started sequentially and all sessions have the same characteristic, apart from their session number.

-m2 -c"Acme"

-q

-quiet

Newlook Developer

Newlook Smartclient

Quiet mode

Suppress the splash screen on start up (Smartclient only).

The same effect can be achieved via Settings | Preferences and de-selecting the Show Splash Screen option.

 -q

-r<"macro">

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Run macro

Run the specified macro at startup. This macro will take precedence over any startup macro you have specified in your repository.

Note: This macro will take precedence over any startup macro you have specified in your repository. If a -c connect command line argument is present, then the -r run macro argument will also take precedence over it.

-r"ConnectToPortal"

--record

Newlook Smartclient

Recording

Start the Newlook Smartclient session in recording mode. This mode records user activity and writes it out to a recording file (<solution>.<user>.nlrecording) in C:\ProgramData\Newlook 11.1, which can then be imported into Insights.

Smartclient-only, cannot be used with Smartframe.

--record

-t<seconds>

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Timeout

Specifies the session timeout parameter. This is how frequently (in seconds) Smartclient will send a keep alive packet in situations where no data has been either sent or received from the host.

-t10

--trace<arg>,<arg>,<arg>,...

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

Tracing

Enable tracing for the current session. Tracing information will be written out to the file newlook.trc.

Refer to the Trace command line parameter topic for more information.

--Trace=DATASTREAM,LICENSING

-v<option>

Newlook Developer

Newlook Smartclient

Smartframe

Embedded Newlook Control

View mode

Start Newlook Smartclient in one of the following view modes:

e  Emulator - start the session in Emulator mode. With this option it is possible to switch to GUI mode.

n  Emulator only - start the session in Emulator mode and disable Graphical mode.

g  Graphical (default) - start the session in Graphical mode and enable switching between modes.

r  Graphical only - start the session in Graphical mode and disable Emulator mode.

If not specified, Smartclient will be started in Graphical mode ( the equivalent of -vg).

-ve

-vn

-vg

-vr

See Also

Configuring desktop shortcuts | Startup macro | Options Parameter (Smartframe) | Smartframe Newlook Control API | Options Parameter (Embedded Newlook Control