Basename-based conditions

You may decide that your action will appear depending on the basenames of the items currently selected in the file-manager: you may define that each item of the selection must meet some sort of basename, and you may simultaneously decide that none of the selected item(s) can have some other sort of basename.

Click on the Basenames tab to show the page which will permit you to configure your basename-based conditions.

In fact, basename-based conditions are built as a list of « must match one of » and « must not match any of » patterns. In order you action be candidate regarding of these basename-based conditions, each element of the selection must be valid for all the listed conditions: the basename of each element must match at least one of the defined « must match one of » patterns, and must not match any of the defined « must not match any of » patterns.

If at least one element of the selection does not match all the defined conditions, then your action will not be displayed.

When targeting the selection context menu, your basename-based conditions will be checked against the currently selected items. When targeting the location context menu or the toolbar, your basename-based conditions will be checked against the basename of the current location.

Defining a new basename-based condition involves two steps.

1. Define the new condition filter.

   • Press Insert or click on button to insert a new condition filter

   • Edit the newly inserted condition filter to the basename you want match.

     A basename-based condition may use « * » or « ? » wildcard characters.

2. Indicates whether this a « must match one of » or a « must not match any of » condition.

   Click on the Must match one of or Must not match any of radio button in the same row to set the corresponding condition.

Depending of your target operating system, make sure that the Match case checkbox is activated (or not).

• When activated, all filters are considered as case sensitive, which means that /my/file filename is considered distinct from /My/File one.

  This is the default behavior on Unix-like systems.

• When disactivated, filters are considered as case insensitive, which means that /my/file and /My/File filenames are considered the same name.

  This is most probably what you want if you target some sort of Windows system.

By default, the basename-based condition is just one « must match one of * » condition. As all basenames always match the « * » condition, this just means that basename-based conditions are not considered as relevant for the action.

Mimetype-based conditions

You may decide that your action will appear depending on the mimetypes of the items currently selected in the file-manager: you may define that each item of the selection must meet some sort of mimetype; and you may simultaneously decide that none of the selected item(s) can have some other sort of mimetype.

Click on the Mimetypes tab to show the page which will permit you to configure your mimetype-based conditions.

In fact, mimetype-based conditions are built as a list of « must match one of » and « must not match any of » patterns. In order you action be candidate regarding of these mimetype-based conditions, each element of the selection must be valid for all the listed conditions: the mimetype of each element must match at least one of the defined « must match one of » patterns, and must not match any of the defined « must not match any of » patterns.

If at least one element of the selection does not match all the defined conditions, then your action will not be displayed.

When targeting the selection context menu, your mimetype-based conditions will be checked against the currently selected items. When targeting the location context menu or the toolbar, your mimetype-based conditions will be checked against the mimetype of the current location, which happens to be the well known « inode/directory » mimetype.

Defining a new mimetype-based condition involves two steps.

1. Define the new condition filter.

   • Press Insert or click on button to insert a new condition filter

   • Edit the newly inserted condition filter to the mimetype you want match.

     A mimetype must be defined as a group/subgroup expression.

     The « * » wildcard is supported only in some situations: The « */* » expression matches all mimetypes. As a convenient shortcut, the « * » literal is also accepted for this same purpose. A group/* string matches all subgroups of group mimetype.

     The */subgroup string is not accepted as a valid wildcard.

2. Indicates whether this a « must match one of » or a « must not match any of » condition.

   Click on the Must match one of or Must not match any of radio button in the same row to set the corresponding condition.

By default, the mimetype-based condition is just one « must match one of */* » condition. As all mimetypes always match the « */* », this just means that mimetypes are not considered as relevant for the action.

Folder-based conditions

You may decide that your action will appear depending on the directory the items currently selected in the file-manager are located in: you may define that each item of the selection must be located in one hierarchy or in another; and you may simultaneously decide that none of the selected item(s) can be located in some other hierarchy.

A folder-based condition must be understood as the specification of the hierarchy in which the currently examined item should (or should not) stay: this is a pattern on the dirname of the element.

Click on the Folders tab to show the page which will permit you to configure your folder-based conditions.

In fact, folder-based conditions are built as a list of « must match one of » and « must not match any of » patterns. In order you action be candidate regarding of these folder-based conditions, each element of the selection must be valid for all the listed conditions: each element must located in one of the defined « must match one of » folders, and must not match any of the defined « must not match any of » folders.

If at least one element of the selection does not match all the defined conditions, then your action will not be displayed.

When targeting the selection context menu, your folder-based conditions will be checked against the dirname of each currently selected items. When targeting the location context menu or the toolbar, your folder-based conditions will be checked against the current location.

Defining a new folder-based condition involves two steps.

1. Define the new condition filter.

   • Press Insert or click on button to insert a new condition filter

   • Edit the newly inserted condition filter to the folder you want match.

     The « * » and « ? » characters are accepted as wildcards at any level of the defined folder filter.

   • Or click on Browse to select a folder on the filesystem.

2. Indicates whether this a « must match one of » or a « must not match any of » condition.

   Click on the Must match one of or Must not match any of radio button in the same row to set the corresponding condition.

By default, the folder-based condition is just one « must match one of / » condition. As / is always the top of an Unix-like filesystem, then all selected items always match this condition.

If you target a Windows system, then this default value may not be what you actually want.

Scheme-base-conditions

You may decide that your action will appear depending on the schemes of the URIs of the items currently selected in the file-manager: you may define that each item of the selection must have some scheme; and you may simultaneously decide that none of the selected item(s) may have some other scheme.

Click on the Schemes tab to show the page which will permit you to configure your scheme-based conditions.

In fact, scheme-based conditions are built as a list of « must match one of » and « must not match any of » patterns. In order you action be candidate regarding of these scheme-based conditions, each element of the selection must be valid for all the listed conditions: the scheme of each element must match at least one of the defined « must match one of » patterns, and must not match any of the defined « must not match any of » patterns.

If at least one element of the selection does not match all the defined conditions, then your action will not be displayed.

When targeting the selection context menu, your scheme-based conditions will be checked against the currently selected items. When targeting the location context menu or the toolbar, your scheme-based conditions will be checked against the scheme of the current location.

Defining a new scheme-based condition involves two steps.

1. Define the new condition filter.

   • Press Insert or click on button to insert a new condition filter

   • Edit the newly inserted condition filter to the scheme you want match.

     Scheme-based conditions only accept « * » wildcard, which stands for « any scheme ».

   • Or click on Common to select a scheme among those predefined in Edit->Preferences.

     

     Selecting a scheme among predefined defaults

     Figure 10. Selecting a scheme among predefined defaults

     A new scheme may only be selected here if it is not already defined as a scheme filter.

     To select a new scheme, click OK, or double-click on the desired row.

2. Indicates whether this a « must match one of » or a « must not match any of » condition.

   Click on the Must match one of or Must not match any of radio button in the same row to set the corresponding condition.

By default, the scheme-based condition is just one « must match one of * » condition, which means that schemes are not relevant for this action.

Capability-based conditions

Capabilities are some properties that a file may exhibit to the user.

But the Local capability, all others are dependant of the user who executes the command.

You may so decide that your action will appear, or not, depending on the capabilities of the selected item(s) vs. the current user.

Click on the Capabilities tab to show the page which will permit you to configure your capability-based conditions.

In fact, capability-based conditions are built as a list of « must match all of » and « must not match any of » patterns. In order you action be candidate regarding of these capability-based conditions, each element of the selection must be valid for all the listed conditions: the capability of each element must match each of the defined « must match all of » capabilities, and must not match any of the defined « must not match any of » ones.

If at least one element of the selection does not match all the defined conditions, then your action will not be displayed.

When targeting the selection context menu, your capability-based conditions will be checked against the currently selected items. When targeting the location context menu or the toolbar, your capability-based conditions will be checked against those of of the current location.

Defining a new capability-based condition involves two steps.

1. Define the new condition filter.

   • Press Insert to insert a new condition filter

   • Edit the newly inserted condition filter to the capability you want match.

   • Or click on to open the Adding a new capability dialog box.

     

     The list of managed capabilities

     Figure 12. Managed capabilities

     A new capability may only be selected here if it is not already defined as a capability filter.

     To select a new capability, click OK, or double-click on the desired row.

2. Indicates whether this a « must match all of » or a « must not match any of » condition.

   Click on the Must match all of or Must not match any of radio button in the same row to set the corresponding condition.

By default, the capability-based condition list is empty. This means that capabilities are not relevant for this action.

Selection count condition

You may define that your action will only appear if the current selection in the file manager has some precise count, or some precise relation with a given count.

Click on the Environment tab to show the page which will permit you to configure your environment-based conditions.

The selection count condition is defined in the Appears if selection contains frame.

When targeting the selection context menu, the count condition defined here will be checked against the count of currently selected items. When targeting the location context menu or the toolbar, the count condition will be checked against zero because there is no selected item in this case.

To define a selection count condition:

• Select in the Count drop-down list the operator you want apply to the selection count:

  < (strictly less than)

  = (equal to)

  > (strictly greather than)

• Enter the reference count you wish.

The selection count defaults to « Count > (strictly greater than) 0 », which means that the action will be candidate to be displayed as soon as at least one item is selected in the file manager.

Desktop selection

You may define that your action:

• will always appear,

• or will only appear in some given desktop environments,

• or will not appear in some given desktop environments.

Only one choice between these three items is possible.

Click on the Environment tab to show the page which will permit you to configure your environment-based conditions.

The desktop selection is defined in the Desktop environment frame.

To define the desktop environment condition:

1. First select the type of filter:

   does your action should always appear, regarding of the desktop environment ?

   does your action should only appear in some desktop environment(s) ?

   does your action should never appear in some desktop environment(s) ?

2. If your action should not always appear, then select the relevant desktop environment(s) in the listbox in the right side.

The targeted desktop environment condition defaults to « Always appear », which means that the action will be candidate to be displayed regarding of the current desktop environment.

Executable found condition

You may define that your action will only appear if some prerequisite package is installed on your system. This is checked here by specifying that a specific file, known or at least supposed to be provided by the package, must be present on the filesystem, and executable.

Click on the Environment tab to show the page which will permit you to configure your environment-based conditions.

The executable found condition is defined in the Execution environment frame.

To define the relevant file, enter its full filename in the Appears if the file is executable entry box, or click on Browse to select a file on the filesystem.

Leave the field empty if this condition is not relevant for your action.

You may embed some parameters in the searched filename. These parameters will be dynamically substituted at runtime with values which will depend of currently selected item(s).

D-Bus registration condition

You may define that your action will only appear if some given name is registered on D-Bus system at runtime.

Click on the Environment tab to show the page which will permit you to configure your environment-based conditions, and focus on Execution environment frame.

To define the relevant name, enter it in the Appears if the name is registered on D-Bus entry box.

Leave the field empty if this condition is not relevant for your action.

You may embed some parameters in the searched name. These parameters will be dynamically substituted at runtime with values which will depend of currently selected item(s).

Customized condition

You may define that your action will only appear if some given command outputs a true string on its standard output.

Click on the Environment tab to show the page which will permit you to configure your environment-based conditions, and focus on Execution environment frame.

This lets you define your own customized condition filter, by writing a small script which outputs, or not, the true string on stdout when it is ran.

To define the command, enter it in the Appears if the command outputs "true" entry box.

Leave the field empty if this condition is not relevant for your action.

You may embed some parameters in the executed filename or its options. These parameters will be dynamically substituted at runtime with values which will depend of currently selected item(s).

Running process condition

You may define that your action will only appear if some given binary is currently running.

Click on the Environment tab to show the page which will permit you to configure your environment-based conditions, and focus on Execution environment frame.

To define the binary, enter its name in the Appears if the binary is running entry box, or click on Browse to select a file on the filesystem.

Even if you enter here the full filename of a binary, only its basename will be searched for in the processes list at runtime.

Leave the field empty if this condition is not relevant for your action.

You may embed some parameters in the searched name. These parameters will be dynamically substituted at runtime with values which will depend of currently selected item(s).

Targeting the selection context menu

When Display item in selection context menu is checked, then your action will be candidate to be displayed in Nautilus context menu as soon as at least one item is selected in the file manager. Your action will so deal with currently selected item(s).In order to be actually displayed, all the conditions defined in your candidate action must be met by each item currently selected in the Nautilus file manager.

When an action targets the selection context menu, and is actually displayed in Nautilus context menu, then it is also displayed in Nautilus Edit menu.

This target is checked by default.

Targeting the location context menu

When Display item in location context menu checkbox is activated, then your action will be candidate to be displayed in Nautilus context menu when the file manager selection is empty. Your action will so deal with currently displayed location. In order to be actually displayed, all the conditions defined in your candidate action must be met by the location currently displayed in the Nautilus file manager.

When an action targets the location context menu, and is actually displayed in Nautilus context menu, then it is also displayed in Nautilus File menu.

Targeting the toolbar

When Display item in the toolbar checkbox is activated, then your action will be candidate to be displayed in Nautilus toolbar.

Actions displayed in the toolbar only deal with the location which is currently displayed in the file-manager, not with the items which may be currently selected (or not). In order to be displayed, all the conditions defined in your candidate action must so be met by the current location.

Notes

• the Context label as a label,

• the Icon,

• these two properties being associated with the Tooltip.

Depending of the exact configuration of your desktop environment, the icon may or may not be displayed in front of the label in the menu.

You may embed some parameters in the label, the icon name or the tooltip. These parameters will be dynamically substituted at runtime with values which will depend of currently selected item(s).

• the Toolbar label as a label,

• the Icon,

• these two properties being associated with the Tooltip.

Depending of the exact configuration of your desktop environment, the toolbar label may or may not be displayed in front of the icon in the toolbar.

The toolbar label defaults to the same label than those used in menus. By unchecking the Use same label for icon in the toolbar checkbox, then you can define a label specific to the toolbar, usually shorter that those defined for the menus.

You may embed some parameters in the toolbar label, the icon name or the tooltip. These parameters will be dynamically substituted at runtime with values which will depend of currently selected item(s).

Available parameters

In the Command page, click on Legend button to see the list of available parameters.

The Legend button has a toggling action: click once to display the Parameter Legend dialog box; click a second time to hide it.

The word « first » may be misleading as it only refers to the list of selected items internally provided by the file manager to the Nautilus-Actions plugin. In particular, it has nothing to do with the visual selection you may have done in the file manager window. And, in fact, which is the « first » selected item in a multiple selection is absolutly undefined and rather unpredictable.

Where the action should it be executed ?

Your action may be executed in a particular working directory.

You may specify it in the Command tab, in the Working directory entry box, or by clicking on Browse to select a folder on the filesystem.

The working directory defaults to %d, which runs the command in the base directory of the (first) selected item.

In the particular case of the %d parameter, which is the « first » selected item is not very important: we are rather sure that all selected items are located in the same base directory.

How the action should it be executed ?

Apart from configuring the conditions the selection must met in order your action be displayed in file manager menus, Nautilus-Actions allows you to configure how exactly your command will be executed.

Click on the Execution tab to show the page which will permit you to configure the execution of your command.

Ordering the profiles inside an action

At runtime, Nautilus-Actions will begin with examining the conditions set on your action.

If these conditions (the action-conditions) are met, then Nautilus-Actions will examine in order each profile.

If the conditions defined in a profile are met, then this profile will be validated, and the review of other profiles will stop.

If no profile is found valid at runtime, then the action will be itself considered invalid, and will not be displayed in the file manager context menu.

So, ordering of the profiles may be important for your action: the first valid profile found, the first - and the only - selected profile.

You may order your profiles inside an action in two ways.

1. Cut the profile to be moved, select the profile before which you want yout cut profile to be inserted, and paste it.

2. Cick on the profile to be moved, and drag it to its right place.

Alphabetically sorting your actions and menus

In these modes, actions and menus are sorted depending of their label, inside of their parent.

You may sort your actions by:

• Click on (resp. ) button to sort your actions in ascending (resp. descending) order.

• Or edit your corresponding preference.

Manually organizing your actions and menus

In this mode, a new action or a new menu will be inserted just before the current action or menu, inside of the same parent if apply.

To choose this mode:

• Click on button.

• Or edit your corresponding preference.

Cut/Delete

Deletion applies to current selection. When the current selection covers all profiles of an action, the delete action really delete the selected profiles, leaving the action as invalid if all profiles were selected.

Multiple selection

Multiple selection is possible in Nautilus-Actions Configuration Tool. You can extend the current selection by pressing the touch Ctrl or Shift while selecting an item to add to the selection.

Nautilus-Actions Configuration Tool only accepts homogeneous multiple selections. That is, you may select one or more profiles, or one or more actions or menus. A multiple selection containing both profiles and actions or menus is not allowed. This is because Nautilus-Actions Configuration Tool would not know where to paste such a selection.

Note that selecting any row means also selecting children of this row. These childs are said « implicitely selected »: they will be part of next edition operations, but are not considered when verifying if selection is homogeneous. Also, they cannot be unselected.

Runtime preferences

User interface preferences

Import preferences

Export preferences

Schemes preferences

I/O providers preferences