Directory Opus Manual

AUTOFILELIST

/S

(no value)

Used to automatically populate the "next / previous" list in the viewer with other files visible in the folder tab which launched the command.

Use AUTOFILELIST on its own, without LISTSIBLINGS, to make a command with similar behavior to launching the viewer by double-clicking a file. Specifically, it makes the command respect the Generate next/previous list (when opened via double-click) option on the Standalone Viewer page in Preferences, even when not triggered by a double-click. If the option is off then AUTOFILELIST on its own may have no effect.

If you combine AUTOFILELIST and LISTSIBLINGS together, the command will always populate the "next / previous" list, even if the Preferences option is off, unless more than one file is selected. (If two or more files are selected, and you run the command on them, then just those files will be in the "next / previous" list.)

The "next / previous" list generated by AUTOFILELIST (when the Preferences option is on, or when combined with LISTSIBLINGS) will usually be the same as that generated by LISTSIBLINGS on its own. The two differ in situations where what's visible in the folder tab does not correspond to a real folder on disk. If the folder tab has a filter applied, or is showing something like Find Results or a mode like Flat View, then AUTOFILELIST gets you a list which corresponds to that filtered or multi-directory view; on the other hand, LISTSIBLINGS (on its own) gets you a list of files from the same directory as the file you start with, which may be files that are not displayed in the folder tab at all.

Example: Show AUTOFILELIST LISTSIBLINGS

FULLSCREEN

/S

(no value)

Opens the image viewer in full-screen mode.

Example: Show FULLSCREEN

LISTERLINK

/O

(no value)

The viewer which opens will be linked to the lister which ran the command. The viewer tracks the lister's file selection, similar to a detached preview pane. When a file is clicked in the lister, it will be loaded into the viewer.

Example: Show LISTERLINK

If Preferences or other arguments specify re-use of an existing viewer, one will only be re-used if it was also opened with the LISTERLINK argument and came from the same Lister. Similarly, requests to open viewers without LISTERLINK will not re-use viewers opened with it.

This argument is for use on lister toolbars (etc.) when opening a new viewer. See VIEWERCMD=listerlink, below, if you wish to link or unlink a viewer which is already open.

close

Closes all standalone viewers currently linked to the Lister which runs the command.

Example: Show LISTERLINK=close

toggle

Opens a new linked viewer, if the Lister does not have one already, and closes all the Lister's linked viewers otherwise.

Example: Show LISTERLINK=toggle

LOADALLTHUMBS

/S

(no value)

Triggers the generation of thumbnail images for all files in the source folder, including those that are currently out-of-view.

Example: Show LOADALLTHUMBS

PLUGINABOUT

/K

<plugin name>

Displays the About dialog for the specified plugin. The <plugin name> can be the either the name of the plugin DLL (including the .dll extension) or the "pretty name" of the plugin.

Example: Show PLUGINABOUT text.dll

PLUGINDISABLE

/O

(no value)

Toggles the enable state of the specified plugin. If the plugin is currently enabled it will be disabled, and vice versa. The plugin must be specified using the PLUGIN argument.

Example: Show PLUGINDISABLE PLUGIN gifanim.dll

enable

Enables the plugin specified with the PLUGIN argument.

Example: Show PLUGINDISABLE=enable PLUGIN text.dll

disable

Disables the plugin specified with the PLUGIN argument.

Example: Show PLUGIN audiotags.dll PLUGINDISABLE disable

toggle

It is not necessary to specify "toggle", since it is the default if neither "enable" nor "disable" are specified, but you can if you want to be more explicit.

Example: Show PLUGIN="audiotags.dll" PLUGINDISABLE=toggle

Note that when a PLUGINDISABLE button is a toggle, the button will appear active (e.g. checked or highlighted) when the plugin is 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
Show PLUGIN="wma.dll" PLUGINDISABLE=toggle

PLUGINMANAGER

/S

(no value)

Displays the Viewer / Viewer Plugins page in Preferences, which lets you see and manage your installed viewer plugins.

Example: Show PLUGINMANAGER

SIZE

/K

<width>,<height>

Overrides the default size of the standalone viewer.

Example: Show POS 1920,0 SIZE 960,1080

THUMBNAILSIZE

/K

<size>

Sets the size of thumbnails in the active Lister to the specified size in pixels. This overrides the global thumbnail size set in the File Display Modes / Thumbnails page in Preferences.

Example: Show THUMBNAILSIZE 192

<width>,<height>

Sets the width and height of thumbnails separately. This lets you have non-square thumbnail sizes if desired.

Example: Show THUMBNAILSIZE 92,64

<change>

Adjusts the size of thumbnails in the active Lister by the specified delta value. You must specify either a leading + or - to make this a relative size change.

Example: Show THUMBNAILSIZE +32

<change w>,<change h>

Adjusts both the width and height of thumbnails by the specified deltas.

Example: Show THUMBNAILSIZE +16,+24

left

Applies the size change to only the left (or top) file display in a dual-display Lister.

Example: Show THUMBNAILSIZE left,128

right

Applies the size change to only the right (or bottom) file display.

Example: Show THUMBNAILSIZE +64,right

source

Applies the size change to only the source file display.

Example: Show THUMBNAILSIZE source,64,80

dest

Applies the size change to only the destination file display.

Example: Show THUMBNAILSIZE dest,256

both

Applies the size change to both visible file displays in a dual-display Lister, but only the active folder tabs.

Example: Show THUMBNAILSIZE both,+32

all

Applies the size change to all file displays in the Lister, including both sides of a dual-display Lister and all folder tabs. This is the default behaviour.

Example: Show THUMBNAILSIZE all,+32

reset

Resets the thumbnail size to the value set in Preferences.

Example: Show THUMBNAILSIZE all,reset

list

Generates dynamic buttons that provide a number of thumbnail size options, intelligently chosen to suit your system DPI settings.

Example: Show THUMBNAILSIZE=list

VIEWERCMD

/K

<command>

Only for use in the standalone viewer, this command forms the basis of the default viewer toolbar, context menu and hotkeys. These commands can also be used from scripts that run within the context of the viewer.

alpha

Toggle the Hide Alpha Channel option on and off.

Example: Show VIEWERCMD=alpha

alwaysontop

(Opus 13.4.2 and above.) Toggle the Keep On Top option on and off. This makes the viewer always on-top relative to other normal windows.

Example: Show VIEWERCMD=alwaysontop

If Preferences or Customize are opened, the viewer will reset to normal to avoid the dialogs opening behind it. Full-screen viewers are inherently on-top when active, regardless of this setting.

You can also specify on or off to ensure the viewer is in a particular mode instead of toggling.

Example: Show VIEWERCMD=alwaysontop,on

backcol

Override or reset the viewer's background color. This only affects viewers and plugins which support it, and is useful for checking images that use transparency against various background colors. The change is temporary (not saved to your configuration) and only affects the viewer the command is run in.

If no color is specified, the background is reset to the color from Preferences.

Example: Show VIEWERCMD=backcol

Otherwise, a color should be specified in either #RRGGBB hex or RRR,GGG,BBB decimal format:

Example: Show VIEWERCMD=backcol,#FFFFFF
Example: Show VIEWERCMD=backcol,127,127,127

If you need a button or hotkey which toggles a color override on each push, edit the items in the default Viewer toolbar's View / Background Color menu to see how it's done.

close

Closes the standalone viewer window.

Example: Show VIEWERCMD=close

cmdbar

Displays a FAYT-style command bar at the bottom of the viewer window, which lets you type in an ad-hoc command to run in the context of the viewer.

Example: Show VIEWERCMD=cmdbar

copy

Copies the currently selected region of the image to the clipboard.

Example: Show VIEWERCMD=copy

copyto

Prompts for a new filename to copy the currently viewed file to.

Example: Show VIEWERCMD=copyto

crop

Crops the image to the currently selected region. The file on disk is not modified unless the image is saved.

Example: Show VIEWERCMD=crop

cut

Cuts the currently viewed file to the clipboard. If you then perform a paste in a Lister the viewed file will be moved.

Example: Show VIEWERCMD=cut

delete

Deletes the currently viewed file (after prompting for confirmation, by default).

Example: Show VIEWERCMD=delete

The main difference between using this command and the actual Delete command is that the viewer will move to the next file after the current one has been deleted.

The additional options can be specified:

• close automatically closes the viewer after deleting the image
• noadvance stops the viewer moving onto the next image after deleting the image

You may also specify one or more of the following Delete command arguments: shift, force, quiet, norecycle, recycle, or secure (or secure=n for n passes).

Any additional options or Delete command arguments must be included in a comma separated list without any extra spaces:

Example: Show VIEWERCMD=delete,quiet,secure=2

If no additional arguments are given, the shift argument is implicit, to maintain the old default behavior. If you only wish to disable the shift argument, use noshift:

Example: Show VIEWERCMD=delete,noshift

dragsel

Lets you trigger certain mouse actions from an OnViewerEvent script event. For example, when the script event is triggered to tell you the user clicked the left mouse button, you could trigger scrolling or expand mode depending on where on the window the mouse was clicked.

The default behavior is to scroll; use the "select" keyword to trigger selection mode, and "expand" to trigger expand/scroll mode.

By default the command assumes the left mouse button was used to trigger the event - use the "rclick" keyword for the right mouse button, and "mclick" keyword for the middle mouse button.

You can also provide the coordinates of the click by passing "pos:x,y" on the command line - if not provided, the current mouse position is assumed.

Example: Show VIEWERCMD=dragsel,expand,mclick,pos:100,100

first

Goes back to view the first file in the list.

Example: Show VIEWERCMD=first

flip

Flips the currently viewed image. The file on disk is not modified unless the image is saved. Use with horiz to flip horizontally or vert to flip vertically.

Example: Show VIEWERCMD=flip,horiz

frame

Turns the standalone viewer's picture frame option on or off. This only affects viewers and plugins which support it (most image types, but not things like Office or PDF documents). The change affects all open viewer windows and is saved to your configuration.

The frame is toggled by default.

Example: Show VIEWERCMD=frame

You can also specify "on" or "off" to explicitly turn the frame on or off.

Example: Show VIEWERCMD=frame,on

fullscreen

Turns full-screen mode on and off. By default, it will toggle the setting, but you can also explicitly turn it on or off.

Example: Show VIEWERCMD=fullscreen
Example: Show VIEWERCMD=fullscreen,on
Example: Show VIEWERCMD=fullscreen,off

gamma

Adjust the gamma value of the image display. The adjustment value can be one of the following:

Example: Show VIEWERCMD=gamma,+1
Example: Show VIEWERCMD=gamma,reset

goto

Go to a specified file in the list. Must be used with a value indicating the image, where 0 is the first image, 1 is the second and so on. This command can also be used to jump forwards or backwards a specific number of files, by specifying a number preceded by + or -.

Example: Show VIEWERCMD=goto,0
Example: Show VIEWERCMD=goto,+10

help

Displays help about the image viewer.

Example: Show VIEWERCMD=help

hex

Toggles the display in and out of hexadecimal mode.

Example: Show VIEWERCMD=hex

info

Toggles the image information overlay on and off.

Example: Show VIEWERCMD=info

last

Go to the last file in the list.

Example: Show VIEWERCMD=last

listerlink

Link or unlink the viewer from the lister that opened it. When a lister and viewer are linked, selecting a file in the lister will display it in the viewer, making a standalone viewer like a detached preview pane.

If listerlink is specified on its own, it will toggle the link (assuming the lister still exists). You can also specify toggle to be more explicit, or on or off to turn linking on or off without toggling.

Example: Show VIEWERCMD=listerlink
Example: Show VIEWERCMD=listerlink,off

This is for running via viewer toolbars (etc.) to change the link state of an existing viewer. There is also a standalone LISTERLINK argument (above) which can be used to open new viewers from a lister and link them as soon as they open.

mark

This keyword is used to control image marking. It has many different functions, which are accessed by combining it with the following keywords:

Example: Show VIEWERCMD=mark,toggle,nohighlight
Example: Show VIEWERCMD=mark,view

markfirst

Use this in conjunction with next and prev to mark the previous image before moving onto the next (or previous) one.

Example: Show VIEWERCMD=next,markfirst

meta

Toggles the embedded metadata panel on or off, and controls its width. Combine with the following keywords:

Example: Show VIEWERCMD=meta,toggle,grow,400

minwidth

Save the width of the current viewer window as the new minimum width. When new viewers open they won't automatically size themselves narrower than this width.

Example: Show VIEWERCMD=minwidth

monitornext

Assuming a multi-monitor system, moves the viewer to the next monitor. Most useful with full-screen viewers.

Example: Show VIEWERCMD=monitornext

monitorprev

Move the viewer to the previous monitor.

Example: Show VIEWERCMD=monitorprev

moveto

Prompts for a new filename to move the currently viewed file to.

Example: Show VIEWERCMD=moveto

next

Go to and view the next file in the list. You can combine this with markfirst to mark the current image first.

Example: Show VIEWERCMD=next

nextlist

Generates a list of the subsequent files in the image list (acts as a dynamic button - designed for use on the drop-down attached to the Next button).

Example: Show VIEWERCMD=nextlist

notfullscreen

Hides this button when the viewer is not in full-screen mode. You can combine this with any other keyword.

Example: Show VIEWERCMD=delete,notfullscreen

onlyfullscreen

Hides this button unless the viewer is in full-screen mode. You can combine this with any other keyword.

Example: Show VIEWERCMD=close,onlyfullscreen

open

Open and view a new file. By default this will prompt for the file to open, but you can provide a filename on the command line (e.g. from a script).

Example: Show VIEWERCMD=open
Example: Show VIEWERCMD="open,c:\my pictures\image.jpg"

pluginabout

Displays the About dialog for the current viewer plugin.

Example: Show VIEWERCMD=pluginabout

plugincfg

Displays the configuration dialog for the current viewer plugin (if it provides one).

Example: Show VIEWERCMD=plugincfg

plugincmd

Trigger a command provided by the current viewer plugin (if it provides any). The command is specified as a number where 0 means the first command, 1 means the second and so on.

Example: Show VIEWERCMD=plugincmd,0

plugincmds

Generates a list of the commands provided by the current viewer plugin (if it provides any). This acts as a dynamic button.

Example: Show VIEWERCMD=plugincmds

prev

Go to and view the previous file in the list. You can combine this with markfirst to mark the current image first.

Example: Show VIEWERCMD=prev,markfirst

prevlist

Generates a list of the previous files in the image list (acts as a dynamic button - designed for use on the drop-down attached to the Previous button).

Example: Show VIEWERCMD=prevlist

print

Print the currently viewed file.

Example: Show VIEWERCMD=print

refresh

Refresh the currently viewed file. The file will be reloaded from disk.

Example: Show VIEWERCMD=refresh

reselect

Reselect the previous selection. This lets you easily crop more than one image to the same area (i.e. select a region, crop and save this image, move to the next image, reselect the previous region, crop and save, …).

Example: Show VIEWERCMD=reselect

restore

Undoes the previous crop operation.

Example: Show VIEWERCMD=restore

rotate

Rotate the display of the current image. The file on disk is not modified unless you save the image. The amount to rotate by can be specified as follows:

Example: Show VIEWERCMD=rotate,+90

save

Save any changes you have made to the current image. Use with the quiet option to replace the existing file silently. This command is unavailable if the image is not in one of the formats that Opus is able to save (currently PNG, JPG, BMP and GIF) - in that case, you can use saveas to save the image in one of those formats.

Example: Show VIEWERCMD=save,quiet

saveas

Prompts for a new filename to save the image to. The Save Picture dialog also lets you choose the image format to save in. You can optionally provide a filename to save to on the command line (e.g. from a script).

Example: Show VIEWERCMD=saveas
Example: Show VIEWERCMD="saveas,c:\my pictures\image.png"

scroll

Scrolls the current image. You must specify either horiz or vert to indicate the dimension you want to scroll, combined with another keyword to indicate how far to scroll. The keywords are:

Example: Show VIEWERCMD=scroll,vert,pagedown

selaspect

Fixes the aspect ratio of the selection marquee. You can specify an aspect ratio (16:9, 3/2, etc), or reset to remove the restriction.

Example: Show VIEWERCMD=selaspect,16:9
Example: Show VIEWERCMD=selaspect,reset

selectall

Select the entire image.

Example: Show VIEWERCMD=selectall

selectfile

Select the currently displayed file in the folder tab the viewer was launched from.

Example: Show VIEWERCMD=selectfile

shortcutbar

Toggle the display of the shortcut bar on and off.

Example: Show VIEWERCMD=shortcutbar

slideshow

Toggle slideshow mode on and off.

Example: Show VIEWERCMD=slideshow

You can also turn it on or off explicitly, regardless of its current state:

Example: Show VIEWERCMD=slideshow,on
Example: Show VIEWERCMD=slideshow,off

statusbar

Toggle the status bar on and off.

Example: Show VIEWERCMD=statusbar

toolbar

Toggle display of the toolbar on and off.

Example: Show VIEWERCMD=toolbar

wallpaper

Sets the currently displayed image as your Windows desktop wallpaper. By default the wallpaper will be set to center mode, but you can specify a mode by providing an additional keyword:

Example: Show VIEWERCMD=wallpaper,span

zoom

Adjusts the zoom level of the current image display. You must provide an additional keyword to indicate the desired zoom level:

Example: Show VIEWERCMD=zoom,+