The Favorites internal command can be used to:
Command Arguments:
Argument |
Type |
Possible values |
Description |
---|---|---|---|
(no argument) |
- |
- |
Displays a dynamically generated list of your favorite folders - you can navigate to a folder
simply by selecting it from this list. Acts as a dynamic button. |
ADD |
/O |
(no value) |
Add the current source folder to your Favorites list. The entire path
of the folder will be displayed in the Favorites list by
default. |
|
|
nameonly |
Add the current source folder to your Favorites list, with the name of
the favorite entry set to the name of the folder (so that only the name
shows in the Favorites list, not the entire
path). |
|
|
alias |
Add or modify a folder alias instead of a favorite. You may use the
NAME argument to specify the name of the alias, or omit
it to automatically use the folder's name. You may use the
PATH argument to specify the path the alias should point
to, or omit it to automatically use the current path. |
ADDDIALOG |
/S |
(no value) |
Display a dialog that lets you edit the name and path when adding a new
favorite folder. |
ALIAS |
/K |
delete |
Deletes a folder alias. The alias name must be given by the
NAME argument, and is not optional. Example: Favorites ALIAS=delete NAME=MyAlias |
|
|
set |
Creates or modifies a folder alias. The alias name must be given by the
NAME argument, and the path must be given by the
PATH argument, with neither being optional. Example: Favorites ALIAS=set NAME=MyAlias PATH "C:\Users\Jon\Documents" |
|
|
list |
Generates a dynamic list of aliases, instead of the regular Favorite
list. Use this if you want a menu of your aliases which (depending on
other arguments) you can click on to go to them, copy files to them, and
so on. By default only your user-defined aliases are shown; use the
builtin or all keywords
to override this. Example: Favorites ALIAS=list NOOPENINTABS SHOWICONS |
|
|
builtin |
Use in conjunction with the list keyword to
only show the large list of built-in aliases (by default only
user-defined aliases are included). Example: Favorites ALIAS=list,builtin SHOWICONS |
|
|
all |
Use in conjunction with the list keyword to include
both user-defined and built-in aliases in the list. Example: Favorites ALIAS=list,all |
BRANCH |
/K |
<branch path> |
Specifies the branch of the favorites tree to add a new favorite to,
when used with the ADD or ADDDIALOG
arguments. To add to the root of the favorites tree, omit the
BRANCH argument entirely. Specify nested branches with a
\ between each component, similar to a folder path. If
you specify a branch where some or all parts do not exist, the missing
parts will be created. When used with ADDDIALOG, the
specified path will be selected by default but can then be changed when
interacting with the
dialog. |
COPYTO |
/S |
(no value) |
Modifies the generated list of favorites, turning each item into a
"copy" button that will copy selected files to the favorite
folder. Example: Favorites COPYTO |
EDIT |
/S |
(no value) |
Display the Favorites and Recent / Favorites
List page in
Preferences. |
FILTER |
/K |
<wildcard> |
When displaying a list of Favorites or SmartFavorites, you can use the
FILTER argument to filter the list by path, using a wildcard. Paths
which do not match the wildcard will be hidden from the generated list,
and any sub-branches which become empty will also be
pruned. |
KEYARGS |
/K/M |
<qualifier:arguments> ... |
When displaying a list of favorites, this argument lets you assign
different behaviour to the items in the list if a qualifier key is held
down. This is a multiple value argument - for each qualifier key
combination listed, you can define a separate set of arguments that will
be used when the item in the list is selected. |
MOVETO |
/S |
(no value) |
Modifies the generated list of favorites, turning each item into a
"move" button that will move selected files to the favorite
folder. Example: Favorites MOVETO |
MULTIFUNC |
/O |
(no value) |
The generated list of favorites will be multiple function buttons
(three-button buttons) - clicking them with the left mouse button will act
as if OPENINLEFT were set, the right button will act as
if OPENINRIGHT were set, and the middle mouse button will
act as if NEW were
set. |
|
|
tabs |
Similar to the above except the left and right mouse button
functions will open a new tab on the appropriate side of the Lister. You
can control how new tabs are opened with the NEWTAB
argument. |
NAME |
/K |
<name> |
Specifies the name of the newly created favorite or alias. If a name is
not provided, the name of the folder will be used by
default. |
NAMESONLY |
/S |
(no value) |
When listing Smart Favorites, each item in the list will only display its respective folder's name, not the full path. Full paths are displayed in tooltips instead. (The NAMESONLY argument does not work with the normal Favorites list, since you are free to edit item labels in that as you wish. See the ADD=nameonly argument, above, if you wish to automate suppression of full paths when adding normal favorites.) Example: Favorites SMART NAMESONLY |
NEW |
/S |
(no value) |
Favorites selected from the list generated by this command will open in
a new Lister instead of the current
one. |
NEWTAB |
/O |
(no value) |
Favorites selected from the list generated by this command will open in
a new
tab. |
|
|
deflister |
If no lister exists, the Default Lister will open with an additional
tab for the folder. If a lister exists, the folder will open normally in a
new tab within the existing
lister. |
|
|
findexisting |
Look for the folder in an existing tab before opening a new one. If
found, the existing tab will be brought to the front; otherwise a new tab
will be opened. The active tab is checked first, and nothing will happen
if the active tab already displays the selected
path. |
|
|
findinactive |
Like findexisting, except that if the active tab
already has the selected path then a new tab will be opened. Intended for
buttons which switch to existing tabs to reduce clutter while retaining
the ability to open a second tab for the same folder when
needed. |
|
|
nofocus |
New tabs opened by favorites selected from the list will not be brought
to the front. |
|
|
tofront |
If the folder was found in an existing tab, bring that tab to the front
(only used with
findexisting). |
NOLABEL |
/S |
(no value) |
The favorites list displayed by this command will not show any labels
for the favorite folders. |
NOOPENINTABS |
/S |
(no value) |
Do not add the Open in tabs
command that is normally displayed at
the bottom of the generated favorites
list. |
OPENINDEST |
/S |
(no value) |
Favorites selected from the list will open in the destination file
display or Lister. |
OPENINDUAL |
/S |
(no value) |
Favorites selected from the list will open in the other file display of
a dual-display Lister. The Lister will be set to dual-display mode if it
isn't in that mode
already. |
OPENINLEFT |
/S |
(no value) |
Favorites will open in the left-hand (or top) display of a dual-display
Lister. |
OPENINRIGHT |
/S |
(no value) |
Favorites will open in the right-hand (or bottom) display of a
dual-display Lister. |
PATH |
|
<folder path> |
When used with the ADD argument, specifies the path to add as a favorite or alias. Without this, the current source folder will be used. When used without the ADD argument, this modifies the dynamically generated list of favorite folders to only show the contents of a specified sub-branch of the favorites list. The branch path must be preceded with an asterisk. (To filter the list by path rather than sub-branch, see the FILTER argument.) PATH is the default argument for the
Favorites command; you do not need to specify the
PATH keyword
itself. |
SHOWICONS |
/S |
(no value) |
The favorites list displayed by this command will display icons for the
items within it. Note that the button that contains the Favorites
command must also have its Show
image option turned
on. |
SMART |
/O |
(no value) |
Generates a dynamic list of SmartFavorites instead of the regular
Favorite list. The number of folders displayed in the list is specified on
the Favorites
and Recent / SmartFavorites Preferences
page. Add the NAMESONLY argument to show only folder names
instead of full paths, and move the full paths into
tooltips. |
|
|
<number of items> |
Display the specified number of SmartFavorites (overrides the number
set in Preferences). |
|
|
clear |
Clears the SmartFavorites list, the same as clicking the option to do
so within the Preferences
dialog. |
USEQUALKEYS |
/S |
(no value) |
Activates pre-configured behaviour for the main qualifier keys -
Control will open the favorite folder in the
dual-display, Shift in a new Lister and
Alt in a new tab. |