The Prefs internal command can be used to:
Command Arguments:
Argument |
Type |
Possible values |
Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
(no argument) |
- |
- |
Displays the Preferences
dialog. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 Imagesfile
type group. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
sounds |
Includes sound files in the backup (corresponds to the Backup
sounds option). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
data |
Include miscellaneous data in the backup (corresponds to the
Backup miscellaneous data
option). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
localstate |
Include local state data (corresponds to the Backup local state
data option). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
all |
Backup everything (equivalent to
BACKUP=images,sounds,data,localstate). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. You can use the
TO argument to override the default backup name, and the
PASSWORD or DESC arguments to pre-supply
a default password or descriptions when creating a
backup. If you wish to automate the backup or restore process, without showing the interactive wizard, use the separate BACKUP or RESTORE arguments. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CUSTOMIZE |
/O |
(no value) |
Displays the Customize dialog. The dialog
will open on the page that was last
used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
<page> |
Displays the specified tab on the Customize dialog.
Allowable values for this argument are commands,
toolbars, keys and
menus. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FILETYPES |
/S |
(no value) |
Displays the File
Types dialog. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FROM |
/K |
<backup file> |
Specifies the configuration backup file to restore (used with the
RESTORE argument to automate the configuration restore
process). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FTPSITES |
/O |
(no value) |
Displays the FTP
Address Book. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
<site name> |
Displays the FTP
Address Book 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KEYS |
/S |
(no value) |
Displays the Keys page of the
Customize dialog (equivalent to Prefs
CUSTOMIZE=keys). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LAYOUT |
/K |
<layout name> |
Loads the named Lister
layout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
no |
Does not close all existing Listers when loading a
layout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LAYOUTEDIT |
/S |
(no value) |
Opens the Preferences dialog and displays the Layouts and Styles / Layouts
page (equivalent to Prefs
PAGE=layouts). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
no |
Does not ignore the layout's folder
formats. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
no |
Does not open the layout relative to the mouse
pointer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
single |
Saves only the active Lister as a layout. Any other currently open
Listers are not included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LIMITPATH |
/K/M |
<paths> |
When opening a new Layout with the LAYOUT argument, this lets you restrict the newly opened Listers to one or more paths (and their descendants). Attempts to navigate outside of the allowed paths will display an error.
Example: Prefs LAYOUT="Focus On Work" LIMITPATH "C:\Work" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
reset |
If a Layout was saved with restricted paths, this lets you override the restrictions when opening the Layout.
Example: Prefs LAYOUT="LockedLister" LIMITPATH=reset | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOSCRIPT |
/S |
(no value) |
Allows a script to run the
Prefs LAYOUT command without triggering other scripts (or
itself). Adding the NOSCRIPT argument disables the OnBeforeFolderChange,
OnAfterFolderChange,
OnOpenTab
and OnOpenLister events that
would otherwise be triggered by opening a Lister layout. Example: Prefs LAYOUT="My Layout" NOSCRIPT | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PASSWORD |
/K |
<password> |
Encrypt a configuration backup (used with the BACKUP
or BACKUPRESTORE argument). You will need to enter the
password when you restore the
backup. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
images |
Restores images from the configuration backup (corresponds to the
Restore images option in the Backup and Restore
Configuration
wizard). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
sounds |
Restores sounds from the configuration backup (corresponds to the
Restore sounds option in the
wizard). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
data |
Restores miscellaneous data (corresponds to the Restore
miscellaneous data option in the
wizard). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
localstate |
Restores local state data (corresponds to the Restore local
state data (window positions, etc) option in the
wizard). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
all |
Restores all items in the configuration backup (the equivalent of
RESTORE=images,sounds,data,localstate). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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*" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
enable |
Enable the specified script(s), or all scripts if no script name is
specified. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
disable |
Disable the specified script(s), or all scripts if no script name is
specified. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
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.) 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: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SETDEFAULTLISTER |
/O |
(no value) |
Saves the currently active Lister as the Default
Lister. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
force |
Suppress the confirmation and success prompts when setting the Default
Lister manually. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
quiet |
Suppress the success prompt when setting the Default
Lister. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SHOWICONS |
/S |
(no value) |
Displays icons for dynamic lists generated by the
LAYOUTLIST, STYLELIST and
VFSPLUGINLIST
arguments. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
STYLE |
/K |
<style name> |
Applies the specified style
to the current Lister. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
^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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
STYLEEDIT |
/S |
(no value) |
Displays the Layouts and Styles / Styles
page in Preferences (equivalent to Prefs
PAGE=styles). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
STYLESAVE |
/O |
(no value) |
Saves the current appearance of the active Lister as a
style. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
<style name> |
Specifies the name for the style to create. Opus will prompt for a name
if one is not provided. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
THEMES |
/S |
(no value) |
Displays the Lister
Themes dialog. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TO |
/K |
<backup file> |
Specifies the filename for the configuration backup (used with the
BACKUP or BACKUPRESTORE
argument). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TOOLBARS |
/S |
(no value) |
Displays the Toolbars tab in the
Customize dialog (equivalent to Prefs
CUSTOMIZE=toolbars). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VFSPLUGINABOUT |
/K |
<plugin name> |
Displays the About dialog for the specified VFS
plugin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VFSPLUGINCONFIG |
/K |
<plugin name> |
Displays the Configuration dialog for the specified
VFS plugin. 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VFSPLUGINDISABLE |
/K |
<plugin name> |
Enable or disable the specified VFS plugin. If the plugin is currently
enabled it will be disabled, and vice
versa. 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. If you specify just the name
of the DLL, the entire plugin will be toggled. You can also toggle
individual types (assuming the plugin as a whole is still enabled) by
adding a ':' character after the DLL name and then the name of the type,
as found in the Preferences VFS Plugins
page. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
enable |
Enable the specified VFS
plugin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
disable |
Disable the specified VFS
plugin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
toggle |
Toggling is the default, if neither "enable" nor "disable" is specified, but you can specify "toggle" if you wish to be more explicit. Note that when a VFSPLUGINDISABLE button is a toggle, the button will appear active (e.g. checked or highlighted) when plugins 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: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VFSPLUGINMANAGER |
/S |
(no value) |
Displays the Zip & Other Archives / Archive
and VFS Plugins page in Preferences (equivalent to
Prefs
PAGE=vfsplugins). |
Viewer Plugins: See the separate Show command for managing Viewer Plugins.