Directory Opus Manual

{filepath}

{f!}

Passes the full path and filename of each selected item. Files are passed one at a time - a command that uses this code will be repeated once for each additional selected item. If no files are selected the command will still be run, passing an empty string for this code.
Full paths, one at a time, selected items not required, long filenames, source file display

{file}

{o!}

Passes the filename only of each selected item (without its path). Multiple files are passed one at a time.
Filenames only, one at a time, selected items not required, long filenames, source file display

{allfilepath}

{F!}

Passes the full path and filename of all selected items at once. The command will only be run once, no matter how many items are selected - the names of all selected items will be passed on the command line separated by spaces. You can use the sep= modifier (described below) to specify an alternative separator character.
Full paths, all at once, selected items not required, long filenames, source file display

{allfile}

{O!}

Passes the filename only of all selected items at once. File paths are not passed.
Filenames only, all at once, selected items not required, long filenames, source file display

{filepathshort}

{fs!}

Passes the full path and filename of each selected item, in short (8.3) format. This is useful for running 16 bit programs or other legacy software that can't handle long filenames.
Full paths, one at a time, selected items not required, short filenames, source file display

{fileshort}

{os!}

Passes the filename only (no paths) of each selected item, in short (8.3) format.
Filenames only, one at a time, selected items not required, short filenames, source file display

{allfilepathshort}

{Fs!}

Passes the short (8.3) form of the full path and filename of all selected items at once.
Full paths, all at once, selected items not required, short filenames, source file display

{allfileshort}

{Os!}

Passes the filename only of all selected items at once, in short (8.3) format.
Filenames only, all at once, selected items not required, short filenames, source file display

{filepathdest}

{fd!}

Passes the full path and filename of each selected item in the destination file display. Files are passed one at a time - a command that uses this code will be repeated once for each additional selected item. If no files are selected in the destination, or there is currently no destination, the command will still be run, passing an empty string for this code.
Full paths, one at a time, selected items not required, long filenames, destination file display

{filedest}

{od!}

Passes the filename only of each selected item from the destination file display (without its path). Multiple files are passed one at a time.
Filenames only, one at a time, selected items not required, long filenames, destination file display

{allfilepathdest}

{Fd!}

Passes the full path and filename of all selected items, from the destination file display, all at once. The command will only be run once, no matter how many items are selected - the names of all selected items will be passed on the command line separated by spaces.
Full paths, all at once, selected items not required, long filenames, destination file display

{allfiledest}

{Od!}

Passes the filename only of all selected items at once, from the destination file display. File paths are not passed.
Filenames only, all at once, selected items not required, long filenames, destination file display

{filepathshortdest}

{fsd!}

Passes the full path and filename of each selected item, in short (8.3) format, from the destination file display. This is useful for running 16 bit programs or other legacy software that can't handle long filenames.
Full paths, one at a time, selected items not required, short filenames, destination file display

{fileshortdest}

{osd!}

Passes the filename only (no paths) of each selected item in the destination file display, in short (8.3) format.
Filenames only, one at a time, selected items not required, short filenames, destination file display

{allfilepathshortdest}

{Fsd!}

Passes the short (8.3) form of the full path and filename of all selected items at once, from the destination file display.
Full paths, all at once, selected items not required, short filenames, destination file display

{allfileshortdest}

{Osd!}

Passes the filename only of all selected items at once, in short (8.3) format, from the destination file display.
Filenames only, all at once, selected items not required, short filenames, destination file display

noext

Strips the filename extension from filenames. For example, if {file} returned cat_photo.jpg then {file|noext} would return cat_photo. Note that if the item is a folder then its name will not be changed, even if it contains a dot, as folders are not considered to have file extensions.

ext2

Returns the filename extension without the dot. For example, if {file|ext} returned .jpg then {file|ext2} would return jpg.

escbackslash

Automatically escapes any occurrences of \ in the filename, turning them into \\.
This can be necessary when using codes like {filepath} to insert paths into strings which will have sequences like \n and \\ interpreted specially.
For example, a command to add the selected file from the source and the selected file from the destination to the clipboard on separate lines:

Clipboard EXPANDNEWLINES SET {filepath|escbackslash}\n{filepathdest|escbackslash}.

In this example, if the source file was C:\New Folder\test.txt then it would be converted to C:\\New Folder\\text.txt. If the \N sequence had not been escaped, it would have removed the letter N from the path and put ew Folder\text.txt on a separate line. (There are more subtle cases when dealing with folder paths, but they are less important with file paths.)

escnl

Automatically escapes any occurrences of \n in the filename, turning them into \\n.
(This is a weaker version of escbackslash, above. You should probably use escbackslash instead.)
Using escnl helps when using codes like {filepath} as the message text for a dialog code like {dlgstring}. For example, the path C:\New Folder\test.txt would be converted to C:\\New Folder\test.txt. If the \N sequence wasn't escaped, it would have been converted into a line-break in the dialog message text.

escwild

Automatically escapes any wildcard characters in the filename. Used when passing filenames to internal commands that understand standard wildcards, in case a filename contains characters like ( and ) which have special meaning to some functions. For example, {file|escwild|noext} would turn Accounts (2010).xls into Accounts '(2010').

filem

The same as file except that each filename is written to a separate line in the text file. For example, {allfilepath|filem}.

filemq

The same as filem except that each filename is always surrounded by quotes. For example, {allfilepath|filemq}.

ucsle

Forces the file written by file, filem or fileq to use UCS-16LE format. For example, {allfilepath|filem|ucsle}.

urlencode

URL-encodes the filename it adds to the command line. Useful if you want to pass the filename to the Internet in some way. For example, you could have a context menu command which does an automatic Google search for the selected filename with: https://www.google.com/search?q={file|urlencode}

cronly

When used with filem or filemq, makes it so the file has only CR (carriage return) characters between each line. The default is CR,LF pairs as is standard on Windows. For example, {allfilepath|filem|cronly}.

nopath

Returns only the final component of the path. For example, if {filepath} returns C:\Program Files\GPSoftware\Directory Opus\, {filepath|nopath} would return Directory Opus\. You would normally use something like {file} to get just the name of something, but using {filepath|nopath} has the subtle difference of including the \ on the end of the name when the item is a folder.

noshort

Suppresses automatic shortening of file paths which are longer than 260 characters. Opus itself can handle very long paths but many Windows programs cannot. When sending very long paths to external programs, Opus normally uses the short (8.3) versions to reduce problems. Use noshort to prevent this when you know the target program can cope. For example, {filepath|noshort}.

notermdrive

Similar to noterm, but also removes the trailing path separator when the resultant path is a drive root with no sub-directory. For example, both {sourcepath} and {sourcepath|noterm} might return C:\ whereas C: would be returned by {sourcepath|notermdrive}. Drive roots are a special case in Windows and generally require a trailing backslash, but there are exceptions (like the Windows subst command) where the backslash must be omitted.

regex

Allows testing and manipulation of the filename.

If your regular expression contains a | symbol, you should enclose the whole pattern in quotes.

cleanfilepath

Replaces any illegal filename characters in the string, while leaving path separators and colons. (Colons are only left in if they are part of a drive letter at the start of the string.) Should be used when the string can be an absolute path. (Will not usually have an effect in this context, given the input should already a valid file name or path. More useful with clipboard data.)

wsl

Returns the path in WSL (Windows System for Linux) format (e.g. /mnt/c/Program Files/ instead of C:\Program Files).

..

Modifies the code to refer to the selected item's parent folder rather than the item itself. You can pass multiple .. modifiers separated by \ to return folders higher up the tree. For example {filepath|..\..} would return the name of the item's parent's parent.

driveletter

Modifies the code to refer to the drive letter, on its own, at the start of the selected item's path. For example {filepath|driveletter} might return C. If the path is not relative to a drive letter, the whole path will be inserted as-is.
You can also use {filepath|\} to get something like C:\, or {filepath|\|notermdrive} to get something like C:, while handling non-drive roots (e.g. UNC paths) differently.

%1

{filepath}

%L

{filepath}

%*

{allfilepath}