Differences

This shows you the differences between two versions of the page.

--- manual:Preferences [2021/10/04 08:18] – peternlewis
+++ manual:Preferences [2024/07/16 12:10] (current) – [Browser Used in Actions & Tokens] peternlewis
@@ Line 3: / Line 3: @@
 To configure Keyboard~~Maestro, first launch Keyboard~~Maestro and choose [[Menus#Keyboard_Maestro_Preferences|Preferences]] from the [[Menus#Keyboard_Maestro|Keyboard Maestro menu]].
-{{ preferencesgeneral.png?522&nolink |Preferences General Pane }}
+{{ preferencesgeneral.png?nolink&582x641 | Preferences General Pane }}
 The preferences are divided into sections.
@@ Line 15: / Line 15: @@
 * Show or hide the [[Applications_Palette|Applications Palette]].
 * configure whether to detect clipboards that resemble passwords and obscure them.
-* configure the light/dark appearance (v9.0+, OS X 10.14+).
+* configure the light/dark appearance (macOS 10.14+).
 * configure the default text size used in various places.
 * configure whether and how to show the status menu.
 * configure the style of the status menu.
+* configure whether to include macro icons in the status menu.
 * configure whether to include pasting clipboards in the status menu.
 * configure whether to include applications in the status menu.
@@ Line 73: / Line 74: @@
 You can paste an image into a Named~~Clipboard by selecting it in the list and pasting an image (if you select part of the text, it will paste the image into the styled text, which works but is probably not what you want).
-You can also inspect variables and other values in the [[Windows#Value_Inspector_Window |Value Inspector]].
 ===== Variables Preferences =====
@@ Line 80: / Line 79: @@
 In the [[Windows#Preferences_Variables_Pane|Variables preference pane]] you can add and remove variables and see and change their values.
-You do not need to create variables, just using them and giving them a value is all that is required for them to spring into existence.  You can also inspect variables and other values in the [[Windows#Value_Inspector_Window |Value Inspector]].
+You do not need to create variables, just using them and giving them a value is all that is required for them to spring into existence.
+You can also inspect variables and other values in the [[Windows#Value_Inspector_Window |Value Inspector]].
 ===== Excluded Preferences =====
@@ Line 89: / Line 90: @@
 You can also add and remove applications from the clipboard history exclusion list.  When an excluded application is at the front, Keyboard Maestro will not automatically record the clipboard history each time it changes.  It will still read the current System Clipboard if you explicitly ask for it in a macro or open the Clipboard History Switcher.
+===== Security Preferences =====
+Keyboard Maestro is designed to act on your behalf and to do many things for you - essentially acting as you in performing tasks. As such, it needs a wide variety of security permissions to perform these tasks.
+This preference panel aims to summarise the important preferences and allow you to explicitly request them as needed.
 ===== Preferences Set by Command Line =====
@@ Line 142: / Line 149: @@
 <code bash>
 defaults write com.stairways.keyboardmaestro.editor Font-Normal -string "Monaco"
+defaults write com.stairways.keyboardmaestro.editor Font-Fixed -string "Monaco"
 defaults write com.stairways.keyboardmaestro.editor Font-Shell -string "USER"
 defaults write com.stairways.keyboardmaestro.editor Font-AppleScript -string "FIXED"
@@ Line 166: / Line 174: @@
 </code>
-:!: **Alert**:  You should **never** set the max number of items to zero.\\
 If you set the max number of items to zero, then the Copy action will fail.
@@ Line 173: / Line 180: @@
 <code bash>
 defaults write com.stairways.keyboardmaestro.engine ClipboardFlavorMaximumSize -int 100000000
+</code>
+**Multiple Clipboard Separator** (default Return)
+The separator added if you paste multiple items from the Clipboard Switcher can be configured in the gear menu or set to something else with the command:
+<code bash>
+defaults write com.stairways.keyboardmaestro.engine MultipleClipboardSeparator " and "
 </code>
@@ Line 202: / Line 217: @@
 **Include Microsoft PDFs in Clipboards**
-Microsoft applications include a PDF flavor with every copy, and starting up the PDF rendering engine is slow, making the first copy after launching a Microsoft application.  **Keyboard Maestro (v9.0+) excludes PDF flavors from clipboards copied in Microsoft applications by default, but you can turn this off with:**
+Microsoft applications include a PDF flavor with every copy, and starting up the PDF rendering engine is slow, making the first copy after launching a Microsoft application.  Keyboard Maestro excludes PDF flavors from clipboards copied in Microsoft applications by default, but you can turn this off with:
 <code bash>
@@ Line 210: / Line 225: @@
 **Include Microsoft Image Formats**
-Microsoft applications also include flavors for every possible image format with every copy.  **Keyboard Maestro (v9.0+) excludes secondary image flavors like BMP when there is a PNG or TIFF flavor available.  You can turn this off with:**
+Microsoft applications also include flavors for every possible image format with every copy.  Keyboard Maestro excludes secondary image flavors like BMP when there is a PNG or TIFF flavor available.  You can turn this off with:
 <code bash>
@@ Line 224: / Line 239: @@
 </code>
-==== Safari Browser Used in Actions & Tokens ====
+==== Browser Used in Actions & Tokens ====
 **Change which Safari-based Browser will be targeted by the "Safari" Actions, Tokens, and Functions.**
-These preferences change AppleScript Application name that is used to control the respective browser in the form of CODE{{{tell application "<browser name>"}}}.  Note that the Safari browser must still behave like Safari, and the Chrome browser must behave like Chrome, or the actions will not work.  Do not bother trying to set them to Firefox or something like that as it will not work.  All this allows you to do is select a specific version of Safari or Chrome respectively.
+These preferences change the AppleScript Application name that is used to control the respective browser in the form of CODE{{{tell application "<browser name>"}}}.  Note that the Safari browser must still behave like Safari, and the Chrome browser must behave like Chrome, or the actions will not work.  Do not bother trying to set them to Firefox or something like that as it will not work.  All this allows you to do is select a specific version of Safari or Chrome respectively.
-You can Safari-based Browser targeted in Actions, etc, as well as the name of the Safari browser shown in applications:
+You can configure which Safari-based Browser is targeted in Safari Actions, as well as the name of the Safari browser shown in the actions:
 <code bash>
@@ Line 236: / Line 251: @@
 defaults write com.stairways.keyboardmaestro.engine BrowserSafariName -string "Safari Tech"
 </code>
-or
-<code bash>
-defaults write com.stairways.keyboardmaestro.engine AppleScriptSafariName -string "com.apple.Safari"
-</code>
-==== Chrome Browser Used in Actions & Tokens ====
 **Change which Chrome-based Browser will be targeted by the various Keyboard Maestro "[[token:ChromeTitle|Chrome Related]]" Actions, Tokens, and Functions.**
@@ Line 267: / Line 274: @@
 </code>
+**Add additional Browsers to the Front Browser Actions, Tokens, and Functions.**
+The current list of browsers supported in Keyboard Maestro as a potential front browser include:
+* com.apple.Safari
+* com.apple.SafariTechnologyPreview
+* com.google.Chrome
+* com.google.Chrome.canary
+* com.brave.Browser
+* com.brave.Browser.beta
+* com.vivaldi.Vivaldi
+* com.vivaldi.Vivaldi.snapshot
+* com.microsoft.edgemac
+Plus whatever browser is specified as the Safari or GoogleChrome above.
+You can add additional browsers supported as the Front Browser by including their bundle IDs in the `AdditionalWebBrowserBundleIDs` preference. You can list as many as you like, separated by spaces or commas.
+<code bash>
+defaults write com.stairways.keyboardmaestro.engine AdditionalWebBrowserBundleIDs -string "com.example.Safari,com.example.Chrome"
+</code>
+:!: Note:  if the bundle ID includes “safari”, it is considered a Safari browser, otherwise it is considered a Chrome-based browser.
+==== Tokens ====
+Tokens are limited to 0.9 seconds in execution time, and are executed somewhat asynchronously in Ventura and later. You can control this with:
+<code bash>
+defaults write com.stairways.keyboardmaestro.engine TokenTimeout -float 0.9
+defaults write com.stairways.keyboardmaestro.engine ForceSynchronousTokens -bool YES
+</code>
 ==== Engine Animation ====
@@ Line 277: / Line 315: @@
 </code>
-==== Typed String Buffer ====
+==== Typed String ====
-You can disable Shift-Space from clearing the Typed String buffer
+You can disable Shift-Space from clearing the Typed String buffer with:
 <code bash>
@@ Line 285: / Line 323: @@
 </code>
-and you can disable clicks from clearing the Typed String buffer
+and you can disable clicks from clearing the Typed String buffer with:
 <code bash>
@@ Line 291: / Line 329: @@
 </code>
-and you can set the idle time for clearing the Typed String buffer (default 5 seconds)
+and you can set the idle time for clearing the Typed String buffer (default 5 seconds) with:
 <code bash>
 defaults write com.stairways.keyboardmaestro.engine TypedStringClearTime -float 5.0
 </code>
+You can disable modifiers taps in the Typed String buffer with:
+<code bash>
+defaults write com.stairways.keyboardmaestro.engine AllowModifiersInTypedStrings -bool NO
+</code>
 ==== Use Unicode for Keystrokes ====
@@ Line 319: / Line 364: @@
 defaults write com.stairways.keyboardmaestro.engine MaxTapUpTime -float 1.0
 </code>
+The default allowable down time is the double click interval, and the default allowable up time is twice the double click interval.
 ==== Sounds ====
@@ Line 360: / Line 407: @@
 </code>
-The default allowable down time is the double click interval, and the default allowable up time is twice the double click interval.
+==== Status Menu ====
 You can set configure whether the Status Menu includes the Paste submenu and how many items it includes with:
@@ Line 369: / Line 416: @@
 </code>
-You can set configure Display Large text color and display period with:
+==== Display Large Text ====
+You can set configure Display Large Text color and display period with:
 <code bash>
@@ Line 401: / Line 450: @@
 defaults write com.stairways.keyboardmaestro.engine ReportUpdatesWhenEditorActivates -bool YES
 </code>
+==== Prompt With List Show All Limit ====
+You can set the limit for the maximum number of items shown by default in the [[action:Prompt_With_List|Prompt With List]] action with:
+<code bash>
+defaults write com.stairways.keyboardmaestro.engine PromptWithListShowAllLimit -int 100
+</code>
+When there is more items than this in the list, by default the action will not show the items as the list may be too long to be practical.
 ==== WebKit Inspector for HTML Prompt ====
@@ Line 422: / Line 482: @@
 The style includes 3 or 6 HSB colors (being background, text, highlighted letter, selected background, selected text, selected highlight letter) each specified as hue,saturation,brightness.  The background brightness is dropped by 33%, but if there are only three colors, then the selected background color is the background without the 33% drop.  You can select the Custom style in the Theme Editor.
-Alternatively (v9.0+), you can specify the theme using JSON and including all the details for the theme including optional gradients.  The format is:
+Alternatively, you can specify the theme using JSON and including all the details for the theme including optional gradients.  The format is:
     {
@@ Line 461: / Line 521: @@
 	}'
-NoteL the “-string” is important - otherwise the `defaults` command will interpret the JSON itself and that will not work.
+Note that the “-string” is important - otherwise the `defaults` command will interpret the JSON itself and that will not work.