Prefs

The Prefs internal command can be used to:

 

Command Arguments:

Argument

Type

Possible values

Description

(no argument)

-

-

Displays the Preferences dialog.

Example: Prefs

ADDBACKGROUND

/S

(no value)

Adds selected images to the list on the Display / Images Preferences page. This makes them available to be used as background images in Listers and toolbars. For example, you could add this command to the context menu for the Images file type group.

Example: Prefs ADDBACKGROUND

ADDFTPSITE

/S

(no value)

Adds the currently connected FTP site as a new entry in the FTP Address Book. If you are not currently viewing an FTP directory this command has no effect.

Example: Prefs ADDFTPSITE

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

BACKUPRESTORE

/S

(no value)

Initiates the Backup and Restore Configuration wizard, which lets you backup and restore your configuration, as well as export Opus to a USB drive.

Example: Prefs BACKUPRESTORE

CUSTOMIZE

/O

(no value)

Displays the Customize dialog. The dialog will open on the page that was last used.

Example: Prefs CUSTOMIZE

 

 

<page>

Displays the specified tab on the Customize dialog. Allowable values for this argument are commands, toolbars, keys and menus.

Example: Prefs CUSTOMIZE=toolbars

DESC

/K

<description>

Assign a description to a configuration backup (used with the BACKUP 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"

FILETYPES

/S

(no value)

Displays the File Types dialog.

Example: Prefs FILETYPES

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

FTPSITES

/O

(no value)

Displays the FTP Address Book.

Example: 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 to open relative to the mouse pointer.

Example: Prefs LAYOUT "Photo Viewing" LAYOUTIGNOREFORMATS=yes

 

 

<site name>

Displays the Open layout relative to the monitor the mouse is currently on and automatically selects the named site. If the site is in a sub-folder in the address book you need to provide the full path of the site.

Example: Prefs FTPSITES WorkServers\Production

KEYS

/S

(no value)

Displays the Keys page of the Customize dialog (equivalent to Prefs CUSTOMIZE=keys).

Example: Prefs KEYS

LAYOUT

/K

<layout name>

Loads the named Lister layout.

Example: Prefs LAYOUT "Music Albums"

LAYOUTCLOSELISTERS

/K

yes

When loading a layout with the LAYOUT argument, this overrides the Close all existing Listers when loading this layout flag set for the layout, and forces all existing Listers to close. When saving a layout with the LAYOUTSAVE argument, it sets the state of that flag within the layout.

Example: Prefs LAYOUT "FTP Sync" LAYOUTCLOSELISTERS=yes

 

 

no

Does not close all existing Listers when loading a layout.

Example: Prefs LAYOUT "Photo Album" LAYOUTCLOSELISTERS=no

LAYOUTEDIT

/S

(no value)

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

Example: Prefs LAYOUTEDIT

LAYOUTIGNOREFORMATS

/K

yes

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

Example: Prefs LAYOUT "Photo Viewing" LAYOUTIGNOREFORMATS=yes

 

 

no

Does not ignore the layout's folder formats.

Example: Prefs LAYOUT Photos LAYOUTIGNOREFORMATS=no

LAYOUTLIST

/S

(no value)

Displays a list of your saved Lister layouts (acts as a dynamic button). Selecting an item from the generated list loads the specified layout. The LAYOUTCLOSELISTERS, LAYOUTIGNOREFORMATS and LAYOUTMOUSERELATIVE flags can be used in conjunction with this argument to control the behaviour of the generated buttons.

Example: Prefs LAYOUTLIST LAYOUTCLOSELISTERS=yes

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

LAYOUTNAME

/K

<layout name>

Specifies a name when saving a layout using the LAYOUTSAVE argument. If not provided Opus will prompt for a name for the new layout.

Example: Prefs LAYOUTNAME "My Layout" LAYOUTSAVE

LAYOUTSAVE

/O

(no value)

Saves the currently open Listers as a layout. You can use the LAYOUTNAME argument to specify the layout name. You can also use the LAYOUTCLOSELISTERS, LAYOUTIGNOREFORMATS and LAYOUTMOUSERELATIVE arguments to control the state of those flags for the saved layout.

Example: Prefs LAYOUTSAVE

 

 

single

Saves only the active Lister as a layout. Any other currently open Listers are not included.

Example: Prefs LAYOUTSAVE=single LAYOUTNAME=CurrentLister

 

 

noupdatesettings

If you do not use the LAYOUTNAME argument to provide a name for the layout, Opus will display a dialog prompting for the name - this dialog also contains various options for the layout (ignore formats, mouse relative, etc). Changes you make to those options will be saved as the default settings for the LAYOUTSAVE function unless you specify the noupdatesettings value.

Example: Prefs LAYOUTSAVE=noupdatesettings LAYOUTMOUSERELATIVE=yes LAYOUTNAME "My Layout" 

 

 

updatecurrent

If the current lister is already part of a layout, that layout will be updated and you will not be prompted for a layout name or any further options.

Example: Prefs LAYOUTSAVE=updatecurrent 

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, all the settings from the layout are used - otherwise, only the specified settings are used.

Example: Prefs LAYOUT PhotoViewing LAYOUTTHISLISTER

 

 

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=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

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. Valid page keywords are:

advanced

aliases

archivecontext

arcoptions

autoloading

colors

copyattr

copyopts

dblclkfiles

dblclktaskbar

deflister

deleting

details

display

displaymodetoolbars

doubleclick

email

explorerrep

faves

fayt

fdb

fields

filedisplay

fileop

filterbar

filters

flickr

folderbehavior

folderdisplay

folderformats

foldertabs

globalfilters

iconsets

images

jumplist

labels

language

layouts

logging

metadata

misc

mouse

plugins

powerdetails

powermodebuttons

progress

proxy

recent

rename

scripts

slideshow

smartfaves

sounds

startup

status

styles

tabappearance

tabgroups

thumbnails

tiles

toolbarappearance

toolbars

toolbarsets

transitionanimations

treeactions

treeappearance

treebehavior

treecontents

updates

vfsplugins

viewer

viewerpane

virtualfolders

windowsint

zip


Example: Prefs PAGE=transitionanimations

PASSWORD

/K

<password>

Encrypt a configuration backup (used with the BACKUP argument). You will need to enter the password when you restore the backup.

Example: Prefs BACKUP TO /desktop/PrefsBackup PASSWORD abc123

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

RESTORE

/O

(no value)

Automates the configuration restore process. By default all the configuration settings, toolbars, menus and hotkeys from the backup will be restored, 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 restore. Use the FROM argument to specify the name of the backup file. If the backup file was encrypted you can provide the password with the PASSWORD argument. The QUIET argument prevents any user interface from being displayed, and Opus will automatically restart when the restore is complete.

Example: Prefs RESTORE FROM /desktop/PrefsBackup

 

 

images

Restores images from the configuration backup (corresponds to the Restore images option in the Backup and Restore Configuration wizard).

Example: Prefs RESTORE=images FROM /desktop/PrefsBackup

 

 

sounds

Restores sounds from the configuration backup (corresponds to the Restore sounds option in the wizard).

Example: Prefs RESTORE=images,sounds FROM /desktop/PrefsBackup

 

 

data

Restores miscellaneous data (corresponds to the Restore miscellaneous data option in the wizard).

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

 

 

localstate

Restores local state data (corresponds to the Restore local state data (window positions, etc) option in the wizard).

Example: Prefs RESTORE=data,localstate FROM /desktop/PrefsBackup QUIET

 

 

replace

Replaces your existing configuration completely (corresponds to the similarly named option in the wizard). If you select this, your existing configuration is deleted before the restore is done. Without this option, the restored configuration files are written over the top of your existing configuration - but the effect of this is to merge things like toolbars and images with different names.

Example: Prefs RESTORE=replace,images,sounds FROM /desktop/PrefsBackup

 

 

all

Restores all items in the configuration backup (the equivalent of RESTORE=images,sounds,data,localstate).

Example: Prefs RESTORE=replace,all FROM /desktop/PrefsBackup

SETDEFAULTLISTER

/O

(no value)

Saves the currently active Lister as the Default Lister.

Example: Prefs SETDEFAULTLISTER

 

 

force

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

Example: Prefs SETDEFAULTLISTER=force

 

 

quiet

Suppress the success prompt when setting the Default Lister.

Example: Prefs SETDEFAULTLISTER=quiet

SHOWICONS

/S

(no value)

Displays icons for dynamic lists generated by the LAYOUTLIST, STYLELIST and VFSPLUGINLIST arguments.

Example: Prefs LAYOUTLIST SHOWICONS

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

STYLEEDIT

/S

(no value)

Displays the Layouts and Styles / Styles page in Preferences (equivalent to Prefs PAGE=styles).

Example: Prefs STYLEEDIT

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

STYLESAVE

/O

(no value)

Saves the current appearance of the active Lister as a style.

Example: Prefs STYLESAVE

 

 

<style name>

Specifies the name for the style to create. Opus will prompt for a name if one is not provided.

Example: Prefs STYLESAVE "My Style"

THEMES

/S

(no value)

Displays the Lister Themes dialog.

Example: Prefs THEMES

TO

/K

<backup file>

Specifies the filename for the configuration backup (used with the BACKUP  argument to automate the configuration backup process).

Example: Prefs BACKUP TO /mydocuments/OpusPrefsBackup

TOOLBARS

/S

(no value)

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

Example: Prefs TOOLBARS

VFSPLUGINABOUT

/K

<plugin name>

Displays the About dialog for the specified VFS plugin.

Example: Prefs VFSPLUGINABOUT opus7zip.dll

VFSPLUGINCONFIG

/K

<plugin name>

Displays the Configuration dialog for the specified VFS plugin.

Example: Prefs VFSPLUGINCONFIG opus7zip.dll

VFSPLUGINDISABLE

/K

<plugin name>

Enable or disable the specified VFS plugin. If the plugin is currently enabled it will be disabled, and vice versa.

Example: Prefs VFSPLUGINDISABLE opus7zip.dll

 

 

enable

Enable the specified VFS plugin.

Example: Prefs VFSPLUGINDISABLE opus7zip.dll,enable

 

 

disable

Disable the specified VFS plugin.

Example: Prefs VFSPLUGINDISABLE opus7zip.dll,disable

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

VFSPLUGINMANAGER

/S

(no value)

Displays the Zip & Other Archives / Archive and VFS Plugins page in Preferences (equivalent to Prefs PAGE=vfsplugins).

Example: Prefs VFSPLUGINMANAGER