Directory Opus Manual

(no argument)

-

-

Displays the Preferences dialog.

Example: Prefs

BACKUP

/O

(no value)

Automates the configuration backup process. By default all your configuration settings, toolbars, menus and hotkeys are included in the backup, but extra data like images and sounds are not. The optional values for this argument can be used to control which extra data is included in the backup. Use the TO argument to specify the name of the backup file, and the PASSWORD, DESC and QUIET arguments provide additional control.

Example: Prefs BACKUP TO="/desktop/PrefsBackup"

images

When automating a configuration backup, includes image files in your backup (corresponds to the Backup images option in the Backup and Restore Configuration wizard).

Example: Prefs BACKUP=images TO="/desktop/PrefsBackup"

sounds

Includes sound files in the backup (corresponds to the Backup sounds option).

Example: Prefs BACKUP=sounds TO="/desktop/PrefsBackup"

data

Include miscellaneous data in the backup (corresponds to the Backup miscellaneous data option).

Example: Prefs BACKUP=data TO="/desktop/PrefsBackup"

localstate

Include local state data (corresponds to the Backup local state data option).

Example: Prefs BACKUP=data,localstate TO="/desktop/PrefsBackup"

all

Backup everything (equivalent to BACKUP=images,sounds,data,localstate).

Example: Prefs BACKUP=all TO="/desktop/PrefsBackup"

notabs

Exclude currently open windows and tabs from the backup. (Only relevant if local state is being backed up.)

Example: Prefs BACKUP=all,notabs TO="/desktop/PrefsBackup"

COLLAPSEALL

/S

(no value)

Collapses all categories in the Preferences dialog. Combine with the PAGE argument to show a new page and collapse all other categories.

Example: Prefs PAGE=folderformats COLLAPSEALL

DESC

/K

<description>

Assign a description to a configuration backup (used with the BACKUP or BACKUPRESTORE argument). Remember that if the description string contains spaces you need to enclose it with quotes.

Example: Prefs BACKUP TO="/desktop/PrefsBackup" DESC="My Opus Config"

FROM

/K

<backup file>

Specifies the configuration backup file to restore (used with the RESTORE argument to automate the configuration restore process).

Example: Prefs RESTORE FROM="/desktop/PrefsBackup"

HEADING

/O

(no value)

When used with commands which generate a list of items (see dynamic buttons), the HEADING argument adds a small heading at the start of the list. The heading will be hidden when the list is empty. Headings only happen for commands which potentially generate multiple items at the same level as the button itself.

When HEADING is used by itself, without specifying a text value, the main button's label text is used for the heading.

Example: Prefs LAYOUTLIST HEADING

<heading text>

You can specify the heading text if you want it to be different to the button's label.

Example: Prefs STYLELIST HEADING="Styles"

LAYOUT

/K

<layout name>

Loads the named Lister layout.

Example: Prefs LAYOUT="Music Albums"

LAYOUTEDIT

/S

(no value)

Opens the Preferences dialog and displays the Layouts and Styles / Layouts page (equivalent to Prefs PAGE=layouts).

Example: Prefs LAYOUTEDIT

LAYOUTIGNORETOOLBARS

/K

yes

When loading a layout with the LAYOUT argument, this overrides the Ignore toolbars saved within this layout flag set for the layout, and forces the layout's toolbars to be ignored, and the default toolbar set to be used instead. When saving a layout with the LAYOUTSAVE argument, it sets the state of that flag within the layout.

Example: Prefs LAYOUT="Photos" LAYOUTIGNORETOOLBARS=yes

no

Does not ignore the layout's toolbars.

Example: Prefs LAYOUT="Photos" LAYOUTIGNORETOOLBARS=no

LAYOUTMOUSERELATIVE

/K

yes

When loading a layout with the LAYOUT argument, this overrides the Open layout relative to the monitor the mouse is currently on flag set for the layout, and forces the layout's position to be relative to the mouse. When saving a layout with the LAYOUTSAVE argument, it sets the state of that flag within the layout.

Example: Prefs LAYOUT="Find" LAYOUTMOUSERELATIVE=yes

no

Does not open the layout relative to the mouse pointer.

Example: Prefs LAYOUT="BackupFiles" LAYOUTMOUSERELATIVE=no

LAYOUTNOVIRTDESKTOP

/K

yes

When loading a layout, prevents Listers being restored to their original virtual desktops (overrides the setting in the Layout).

Example: Prefs LAYOUT="Find" LAYOUTNOVIRTDESKTOP=yes

no

Allows Listers to be restored to their original virtual desktops.

Example: Prefs LAYOUT="Find" LAYOUTNOVIRTDESKTOP=no

LAYOUTTHISLISTER

/O

(no value)

In conjunction with the LAYOUT argument, this applies the settings from the specified layout to the current Lister instead of opening a new Lister.

If no value is given to the LAYOUTTHISLISTER argument, the layout's panels (e.g. viewer pane, dual file display, utility panel) are applied to the current lister but the window size and position, and current paths, are left unchanged.

Example: Prefs LAYOUT="PhotoViewing" LAYOUTTHISLISTER

nopanels

Do not apply the layout's panels (e.g. viewer pane, dual file display, utility panel) to the currernt window. (If none of the other values are specified, then nothing will be done at all.)

Example: Prefs LAYOUT="SmallLister" LAYOUTTHISLISTER=nopanels,size

size

Use the window size from the specified layout.

Example: Prefs LAYOUT="SmallLister" LAYOUTTHISLISTER=size

pos

Use the window position from the specified layout.

Example: Prefs LAYOUT="NiceSizedLister" LAYOUTTHISLISTER=pos,size

paths

Use the paths/tabs (and folder formats) from the specified layout.

Example: Prefs LAYOUT="CurrentWork" LAYOUTTHISLISTER=pos,size,paths

You can also use LAYOUTIGNOREFORMATS in conjunction with LAYOUTTHISLISTER=paths to override whether or not the layout's folder formats are applied (which is normally determined by a flag you can set when saving and editing each layout).

Example: Prefs LAYOUT="My Layout" LAYOUTTHISLISTER=paths LAYOUTIGNOREFORMATS=yes

MENUMARKERS

/S

(no value)

When used with LAYOUTLIST, if the generated list of layouts includes any submenus, the top-level buttons will display a glyph indicating a dropdown menu.

Example: Prefs LAYOUTLIST MENUMARKERS

PAGE

/K

<prefs page>

Opens the Preferences dialog to the specified page. If this argument is not supplied the Preferences dialog will open to the last-used page.

Opus can work out the command for you if you open the Preferences dialog, go to the page you want, then select File / Copy Page Shortcut To Clipboard at the top of the window.

Some pages allow data to be passed to them to indicate the item to edit. For example, scripts allows a script to be selected by name and its configuration dialog to be shown automatically. To do this, append a colon and the appropriate data to the page name.

Example: Prefs PAGE=transitionanimations
Example: Prefs PAGE=scripts:dopstack.js

QUIET

/S

(no value)

Prevents the Backup and Restore Configuration wizard from appearing when the backup or restore are automated (when used with the BACKUP and RESTORE arguments). If specified when restoring a configuration, Opus will be restarted automatically - you can use the Close AUTOLISTER command to control whether a new Lister is opened when Opus restarts this way.

Example: Prefs RESTORE FROM="/desktop/PrefsBackup" QUIET

SCRIPTDISABLE

/O

(no value)

If no script name is given, the command toggles the global option to disable all script add-ins. This will disable any event scripts, command scripts and column scripts you have installed. This is typically used to test if problems are due to scripts or something else.

The global option does not affect the enabled/disabled state of any individual script. In other words, if a script is disabled and you then disable scripting globally, then enable scripting globally again, the script will still be disabled. The other difference between the global setting and individually disabling all scripts is that the global setting will also affect scripts which are installed after the change.

Example: Prefs SCRIPTDISABLE

<script name>

Enable or disable the specified script or scripts. The script name should match the filename(s) of the script add-in(s) you wish to affect.

If the global option to disable all script add-ins is in effect, no individual script can be enabled.

The script name can use simple * wildcards to match multiple filenames. While this can be used to enable or disable multiple scripts at once, it is intended to avoid worrying about whether a script is installed with ".js" and ".vbs" or ".js.txt" and ".vbs.txt" style extensions.

(As a special case, if the script name wildcard is literally "*" or "*.*", the command acts the same as if no script name was specified, and toggles the global option to disable all script add-ins.)

If the script name is the only parameter, the script will be toggled (enabled if currently disabled; disabled if currently enabled). If multiple scripts match the pattern, they will all be set to the same state as the first match, and not toggled individually.

Example: Prefs SCRIPTDISABLE="My Script.js*"

If a script is inside a Script Package (.osp file), the package must be included in the name:

Example: Prefs SCRIPTDISABLE="My Package.osp\My Script.vbs"

Wildcards can make dealing with script packages easier, and can also handle script packages which contain multiple scripts, or where you distribute a script to people as a .osp but work on it privately as a text file:

Example: Prefs SCRIPTDISABLE="My Package.osp*"
Example: Prefs SCRIPTDISABLE="*My Script.vbs*"

enable

Enable the specified script(s), or all scripts if no script name is specified.

Example: Prefs SCRIPTDISABLE="My Script.js*,enable"
Example: Prefs SCRIPTDISABLE=enable

disable

Disable the specified script(s), or all scripts if no script name is specified.

Example: Prefs SCRIPTDISABLE="My Script.js*,disable"
Example: Prefs SCRIPTDISABLE=disable

toggle

Toggle the specified script(s), or all scripts if no script name is specified.

(This is the default, if neither "enable" nor "disable" is specified, but you can include it if you wish to be more explicit.)

Example: Prefs SCRIPTDISABLE="My Script.js*,toggle"
Example: Prefs SCRIPTDISABLE=toggle

Note that when a SCRIPTDISABLE button is a toggle, the button will appear active (e.g. checked or highlighted) when scripts are disabled. As with most commands, you can add @toggle:invert on a new line at the top of the command sequence to reverse this.

Example:

@toggle:invert
Prefs SCRIPTDISABLE="Viewer Select.js,toggle"

SCRIPTINSTALL

/O

(no value)

Launches the Script Installer to install the currently selected script file.

Example: Prefs SCRIPTINSTALL

<file path>

Launches the Script Installer to install the specified script file.

Example: Prefs SCRIPTINSTALL /downloads/CoolScript.osp

SETLISTERDEFAULTS

/O

(no value)

Lets you select a Lister to save as the Default Lister, or to set other default parameters.

Example: Prefs SETLISTERDEFAULTS

force

Suppress the confirmation and success prompts when setting the Default Lister manually.

Example: Prefs SETLISTERDEFAULTS=force

quiet

Suppress the success prompt when setting the Default Lister.

Example: Prefs SETLISTERDEFAULTS=quiet

nodeflister

Turns off saving of the Default Lister while still saving other default parameters.

Example: Prefs SETLISTERDEFAULTS=quiet,nodeflister

toolbars

Saves the default toolbar set from the selected Lister.

Example: Prefs SETLISTERDEFAULTS=toolbars,nodeflister

formats

Saves the default folder format from the selected Lister.

Example: Prefs SETLISTERDEFAULTS=force,quiet,formats,toolbars,nodeflister

STYLE

/K

<style name>

Applies the specified style to the current Lister.

Example: Prefs STYLE="Dual Horizontal"

^prev

This refers to the initial appearance of the Lister when it was opened, and lets you return to that state as if it were a normal style.

Example: Prefs STYLE=^prev

STYLELIST

/O

(no value)

Displays a list of your saved Lister styles (acts as a dynamic button). Selecting an item from the generated list applies the specified style to the current Lister.

Example: Prefs STYLELIST

showprevious

Includes the special "Previous" style in the generated list. This refers to the initial appearance of the Lister when it was opened, and lets you return to that state as if it were a normal style.

Example: Prefs STYLELIST=showprevious

THEMEIMPORT

/K

<filename>

Imports the specified theme by copying it to the configuration folder. The full pathname must be specified.

Example: Prefs THEMEIMPORT "c:\mythemes\dark.dlt"

THEMENAME

/K

<theme file>

Specifies the filename of the theme to load, when combined with the THEMELOAD argument.

Must be the name of the .dlt theme file on disk. A theme's filename may differ from the name displayed in Preferences, but the UI can generate the whole command for you: Double-click a theme in Preferences, then open the Apply button's menu for an option that puts the command into the clipboard.

The .dlt extension is optional and will be added automatically if omitted.

You may specify the full path to a theme file anywhere on your system. If a full path is not given, the specified name (or relative path) is assumed to be relative to the Themes config folder.

Example: Prefs THEMENAME="My Theme" THEMELOAD

!defaultdark

Loads the internal Default Dark theme, effectively resetting some or all of your cosmetic settings.

Example: Prefs THEMENAME="!defaultdark" THEMELOAD

!defaultlight

Loads the internal Default Light theme, effectively resetting some or all of your cosmetic settings.

Example: Prefs THEMENAME="!defaultlight" THEMELOAD

TOOLBARS

/S

(no value)

Displays the Toolbars tab in the Customize dialog (equivalent to Prefs CUSTOMIZE=toolbars).

Example: Prefs TOOLBARS

VFSPLUGINCONFIG

/K

<plugin name>

Displays the Configuration dialog for the specified VFS plugin.

Example: Prefs VFSPLUGINCONFIG opus7zip.dll

A single VFS plugin DLL may present itself as multiple types. For example, the Archives plugin (opus7zip.dll) which comes with Opus has separate types for 7z, RAR, ISO, and so on. To display the config window for a particular type, add a ':' character and then the name of the type, as found in the Preferences VFS Plugins page.

Example: Prefs VFSPLUGINCONFIG opus7zip.dll:7z

VFSPLUGINLIST

/S

(no value)

Displays a list of the installed VFS plugins (acts as a dynamic button). Each plugin in the list has a sub-menu containing about, configure, and enable/disable commands.

Example: Prefs VFSPLUGINLIST