Using the console

Command prompt navigation
Basic console command structure
The console output
Console command autocompletion

Discovering available Objects, Actions or Options

Choosing an Object, Action or Option name from the output

Reusing and saving commands
See also

Command prompt navigation

Utilize these keystrokes when the cursor is at the prompt > to navigate the console window.

Keystroke	Description
Up/Down	Cycle through previous commands.
Ctrl+Backspace	Delete previous word.
Ctrl+Delete	Delete next word.
Ctrl+End	Go to the end of the command.
Ctrl+Left/Right	Backward/Forward one word.
Enter	Execute the command at the prompt.
Esc	Delete the command at the prompt. Before further typing press Esc again to restore it.
Tab	Autocomplete an Object, Action or Option from a partial input.
Shift+Tab	Discover available Objects, Actions or Options from a partial input.
Shift+Up/Down	Cycle through the available Objects, Actions or Options.

Basic console command structure

Refer to anatomy of a command.

The console output

When you execute a command, the output is a result or an ERROR.

On past commands > indicates that the command was executed successfully.

Otherwise, if the output is an ERROR the console replaces the > prompt for the command with # and outputs the error message on the next line prefixed with ERROR | .

If you input a partial Object, Action or Option, Shift+Tab outputs the available Objects, Actions or Options to the console.

These font colors differentiate between outputs in the console.

Black for the prompt > and your input commands
Dark gray for matching Objects, Actions or Options
Dark blue for output from successful commands
Red for ERROR messages from illegal commands

The ClearConsole Action and Options erase input and output text from the console window.

Console command autocompletion

The console features autocompletion, which reduces the amount of typing and increases the accuracy (by avoiding typos).

Press the Tab key to autocomplete your partial console commands. Autocompletion is case insensitive.

The console will autocomplete up to the next character ambiguity in the Object, Action or Option name.

For example, if there are several transducers (T1, T2, etc) with TS raw variables in your fileset

> ts(Tab)

replaces your partial input with

> Fileset 1: TS raw pings T

Press Tab again to revert to your original input.

If the input is fully and unambiguously completed, a terminating space is added. For example,

> tsrawpingst1(Tab)

replaces your partial input with

> Fileset 1: TS raw pings T1

Discovering available Objects, Actions or Options

Press Shift+Tab without a space at the end of your input without a space to print the available Objects, Actions or Options.

This feature equips you to discover the Objects available to you, or the Actions you can perform.

If your input matches Objects, Actions or Options, the prefix in the output indicates the fileset of the raw variable or the Action for the Option. For example

> s(Shift+Tab)

"s" matches object

Fileset 1: Sv raw pings T1

Fileset 1: Sv raw pings T2.

"s" matches actions

Close Save

CreateLine SmoothingFilterOperator

...

Properties SurveyPlatform

Save.

Note that the Save Action at the end of the above example has no prefix.

Filter the available Objects and discover the union of the available Actions by pressing Shift+Tab after the | character.

> Fileset 1: Sv raw pings T1 | Fileset 1: TS raw pings T1 |(Shift+Tab)

The following actions are applicable:

AppliedObjects

...

Properties.

Specify an Action and query the available Options. Note the space after the Action name, otherwise the Action name itself is matched.

> * | ClearConsole (Shift+Tab)

The following ClearConsole options are available:

ClearBlankLines

ClearCommands

ClearErrors

ClearHelp

ClearReplies.

Choosing an Object, Action or Option name from the output

First press Shift+Tab at the end of your input without a space to print the available Objects, Actions or Options.

> ts(Shift+Tab)

"ts" matches objects

Fileset 1: TS raw pings T1

Fileset 1: TS raw pings T2

> ts

Then use Shift+Up/Down to choose one.

> ts(Shift+Tab)

"ts" matches objects

Fileset 1: TS raw pings T1

Fileset 1: TS raw pings T2

> ts(Shift+Up)

> Fileset 1: TS raw pings T2(Shift+Down)

> ts(Shift+Down)

> Fileset 1: TS raw pings T1

Reusing and saving commands

You can copy, paste and execute the console output from a successful command.

You can also cycle through previous commands by pressing the Up arrow key at the prompt.

Save successful commands you have previously issued in the console to a text file with ExportCommands. Subsequently reload and execute them as a batch with ImportCommands.