This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
manual:Preferences [2021/11/09 03:31] peternlewis |
manual:Preferences [2024/07/16 08:10] (current) peternlewis [Browser Used in Actions & Tokens] |
||
---|---|---|---|
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]]. | 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. | The preferences are divided into sections. | ||
Line 19: | Line 19: | ||
* configure whether and how to show the status menu. | * configure whether and how to show the status menu. | ||
* configure the style of 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 pasting clipboards in the status menu. | ||
* configure whether to include applications 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 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 ===== | ===== 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. | 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 ===== | ===== 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. | 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 ===== | ===== Preferences Set by Command Line ===== | ||
Line 142: | Line 149: | ||
<code bash> | <code bash> | ||
defaults write com.stairways.keyboardmaestro.editor Font-Normal -string "Monaco" | 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-Shell -string "USER" | ||
defaults write com.stairways.keyboardmaestro.editor Font-AppleScript -string "FIXED" | defaults write com.stairways.keyboardmaestro.editor Font-AppleScript -string "FIXED" | ||
Line 166: | Line 174: | ||
</code> | </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. | If you set the max number of items to zero, then the Copy action will fail. | ||
Line 173: | Line 180: | ||
<code bash> | <code bash> | ||
defaults write com.stairways.keyboardmaestro.engine ClipboardFlavorMaximumSize -int 100000000 | 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> | </code> | ||
Line 228: | Line 243: | ||
**Change which Safari-based Browser will be targeted by the "Safari" Actions, Tokens, and Functions.** | **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> | <code bash> | ||
defaults write com.stairways.keyboardmaestro.engine AppleScriptSafariBundleID -string "com.apple.SafariTechnologyPreview" | defaults write com.stairways.keyboardmaestro.engine AppleScriptSafariBundleID -string "com.apple.SafariTechnologyPreview" | ||
defaults write com.stairways.keyboardmaestro.engine BrowserSafariName -string "Safari Tech" | 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> | </code> | ||
Line 276: | Line 285: | ||
* com.brave.Browser.beta | * com.brave.Browser.beta | ||
* com.vivaldi.Vivaldi | * com.vivaldi.Vivaldi | ||
+ | * com.vivaldi.Vivaldi.snapshot | ||
* com.microsoft.edgemac | * com.microsoft.edgemac | ||
Line 287: | Line 297: | ||
:!: Note: if the bundle ID includes “safari”, it is considered a Safari browser, otherwise it is considered a Chrome-based browser. | :!: 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 ==== | ==== Engine Animation ==== | ||
Line 296: | Line 315: | ||
</code> | </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> | <code bash> | ||
Line 304: | Line 323: | ||
</code> | </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> | <code bash> | ||
Line 310: | Line 329: | ||
</code> | </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> | <code bash> | ||
defaults write com.stairways.keyboardmaestro.engine TypedStringClearTime -float 5.0 | defaults write com.stairways.keyboardmaestro.engine TypedStringClearTime -float 5.0 | ||
</code> | </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 ==== | ==== Use Unicode for Keystrokes ==== | ||
Line 338: | Line 364: | ||
defaults write com.stairways.keyboardmaestro.engine MaxTapUpTime -float 1.0 | defaults write com.stairways.keyboardmaestro.engine MaxTapUpTime -float 1.0 | ||
</code> | </code> | ||
+ | |||
+ | The default allowable down time is the double click interval, and the default allowable up time is twice the double click interval. | ||
==== Sounds ==== | ==== Sounds ==== | ||
Line 379: | Line 407: | ||
</code> | </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: | You can set configure whether the Status Menu includes the Paste submenu and how many items it includes with: | ||
Line 388: | Line 416: | ||
</code> | </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> | <code bash> | ||
Line 420: | Line 450: | ||
defaults write com.stairways.keyboardmaestro.engine ReportUpdatesWhenEditorActivates -bool YES | defaults write com.stairways.keyboardmaestro.engine ReportUpdatesWhenEditorActivates -bool YES | ||
</code> | </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 ==== | ==== WebKit Inspector for HTML Prompt ==== | ||
Line 480: | 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. |