User Tools

Site Tools


manual:Preferences

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:Preferences [2020/02/25 23:43]
peternlewis AlwaysRecordAbsoluteClicks
manual:Preferences [2021/03/21 20:26] (current)
peternlewis [Preferences Set by Command Line]
Line 90: 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.
  
-===== Other Hidden ​Preferences =====+===== Preferences ​Set by Command Line =====
  
-You can configure various preferences using defaults write from the Mac OS X Terminal. ​ Some preferences will take effect immediately,​ but others may require the editor or engine to be relaunched.+You can configure various preferences using defaults write from the Mac OS X Terminal. ​ Some preferences will take effect immediately,​ but others may require the editor or engine to be relaunched. These preferences are documented here only to provide utility. Their behaviour may change in the future, or have unexpected consequences.
  
 ==== Editor ==== ==== Editor ====
Line 156: Line 156:
 ==== Clipboard ==== ==== Clipboard ====
  
-You can set the maximum number of items in the clipboard history ​(default 200)+If you wish to effectively disable the Keyboard Maestro Clipboard History, you can do so by setting the history size to zero, and then Keyboard Maestro will only read the clipboard when you explicitly ask it to use the clipboard. 
 + 
 +You can set the following preferences for the Clipboard History 
 + 
 +**Maximum Number of Items** ​(default 200)
  
 <code bash> <code bash>
Line 162: Line 166:
 </​code>​ </​code>​
  
-You can set the maximum clipboard flavor size (default 100MB)+:!: **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. 
 + 
 +**Maximum Clipboard Flavor Size** ​(default 100MB)
  
 <code bash> <code bash>
Line 168: Line 175:
 </​code>​ </​code>​
  
-You can set the maximum position ​of concealed ​(passworditems in the clipboard ​history ​(default 10)+**Ignored Clipboard Flavors** 
 + 
 +You can add additional clipboard flavors to be ignored using: 
 + 
 +<code bash> 
 +defaults write com.stairways.keyboardmaestro.engine ExtraIgnoredClipboardFlavors "​com.whatever.badflavor"​ 
 +</​code>​ 
 + 
 +The string should be a bar (`|`) separated list of flavors ​(technically a regular expression). These flavors will be excluded from the clipboard ​when Keyboard Maestro reads the clipboard. 
 + 
 +You can also write to `IgnoredClipboardFlavors`,​ which will set the entire list of ignored clipboard flavors, but that is a bad idea since the flavors that are ignored, are ignored for a reason, and overwriting the list will produce negative results. 
 + 
 +**Maximum Position of Concealed (Password) Items** ​(default 10)
  
 <code bash> <code bash>
Line 174: Line 193:
 </​code>​ </​code>​
  
-You can set a regular expression which matches text you think should ​or should not be concealed ​as passwords.+**Regular Expression Which Matches Text You Think Should ​or Should Not Be Concealed ​as Passwords**
  
 <code bash> <code bash>
Line 181: Line 200:
 </​code>​ </​code>​
  
-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:+**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:**
  
 <code bash> <code bash>
Line 187: Line 208:
 </​code>​ </​code>​
  
-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:+**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:**
  
 <code bash> <code bash>
Line 193: Line 216:
 </​code>​ </​code>​
  
-==== Engine ​====+==== AppleScript OSA Command ​====
  
 You can set the command line tool that is used to execute AppleScripts You can set the command line tool that is used to execute AppleScripts
Line 201: Line 224:
 </​code>​ </​code>​
  
-You can set the AppleScript name of the Safari ​application, as well as the name of the Safari browser shown in applications:​+==== Safari 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. 
 + 
 +You can Safari-based Browser targeted in Actions, etc, as well as the name of the Safari browser shown in applications:​
  
 <code bash> <code bash>
Line 214: Line 243:
 </​code>​ </​code>​
  
-Similarly for Google ​Chrome:+==== 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.** 
 + 
 +:!: Note:  By using the [[token:​FrontBrowserTitle|FrontBrowser Related]] Tokens, Actions, and Functions, you may not need to change the below. ​ Just use these _FrontBrowser_ entities and whatever Browser is currently (or most recently) frontmost will be targeted. ​ This includes all Safari-based Browsers and Chrome-based Browsers.
  
 <code bash> <code bash>
 +# ~~~ For Brave Browser ~~~
 +defaults write com.stairways.keyboardmaestro.engine AppleScriptGoogleChromeBundleID -string "​com.brave.Browser"​
 +defaults write com.stairways.keyboardmaestro.engine BrowserGoogleChromeName -string "Brave Browser"​
 +
 +# ~~~For Chrome Canary ~~~
 defaults write com.stairways.keyboardmaestro.engine AppleScriptGoogleChromeBundleID -string "​com.google.Chrome.canary"​ defaults write com.stairways.keyboardmaestro.engine AppleScriptGoogleChromeBundleID -string "​com.google.Chrome.canary"​
 defaults write com.stairways.keyboardmaestro.engine BrowserGoogleChromeName -string "​Chrome Canary"​ defaults write com.stairways.keyboardmaestro.engine BrowserGoogleChromeName -string "​Chrome Canary"​
 </​code>​ </​code>​
  
-The AppleScript name is used in AppleScript'​s which control ​the respective browser in the form of CODE{{{tell app "<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.+**To restore ​the defaults** back to use Google Chrome, just delete ​the preferences:​ 
 + 
 +<code bash> 
 +# ~~~ Restore to Google ​Chrome ​~~~ 
 +defaults delete com.stairways.keyboardmaestro.engine AppleScriptGoogleChromeBundleID 
 +defaults delete com.stairways.keyboardmaestro.engine BrowserGoogleChromeName 
 +</​code>​ 
 + 
 + 
 + 
 +==== Engine Animation ====
  
 You can disable all animation in the engine with: You can disable all animation in the engine with:
Line 228: Line 276:
 defaults write com.stairways.keyboardmaestro.engine DisableAnimation -bool YES defaults write com.stairways.keyboardmaestro.engine DisableAnimation -bool YES
 </​code>​ </​code>​
 +
 +==== Typed String Buffer ====
  
 You can disable Shift-Space from clearing the Typed String buffer You can disable Shift-Space from clearing the Typed String buffer
Line 246: Line 296:
 defaults write com.stairways.keyboardmaestro.engine TypedStringClearTime -float 5.0 defaults write com.stairways.keyboardmaestro.engine TypedStringClearTime -float 5.0
 </​code>​ </​code>​
 +
 +==== Use Unicode for Keystrokes ====
  
 You can force Keyboard Maestro to simulate keystrokes only as Unicode characters, rather than typing them as you would on the keyboard You can force Keyboard Maestro to simulate keystrokes only as Unicode characters, rather than typing them as you would on the keyboard
Line 252: Line 304:
 defaults write com.stairways.keyboardmaestro.engine ForceInsertTextByTypingToUseUnicode -bool YES defaults write com.stairways.keyboardmaestro.engine ForceInsertTextByTypingToUseUnicode -bool YES
 </​code>​ </​code>​
 +
 +==== Hot Key Triggers ====
  
 You can set the maximum key down trigger time for Hot Key triggers (default 10 seconds) You can set the maximum key down trigger time for Hot Key triggers (default 10 seconds)
Line 258: Line 312:
 defaults write com.stairways.keyboardmaestro.engine MaxKeyRepeatTime -float 10.0 defaults write com.stairways.keyboardmaestro.engine MaxKeyRepeatTime -float 10.0
 </​code>​ </​code>​
 +
 +You can configure the timing of a "​tap"​ (Hot Key and USB Device Key triggers) with:
 +
 +<code bash>
 +defaults write com.stairways.keyboardmaestro.engine MaxTapDownTime -float 1.0
 +defaults write com.stairways.keyboardmaestro.engine MaxTapUpTime -float 1.0
 +</​code>​
 +
 +==== Sounds ====
  
 You can silence the clipboard transfer sounds with: You can silence the clipboard transfer sounds with:
Line 270: Line 333:
 defaults write com.stairways.keyboardmaestro.engine SilenceRecordingSounds -bool YES defaults write com.stairways.keyboardmaestro.engine SilenceRecordingSounds -bool YES
 </​code>​ </​code>​
 +
 +==== Recordings ====
  
 You can adjust the recording delay with: You can adjust the recording delay with:
Line 286: Line 351:
  
 By default, clicks are recorded relative to the front window, if that window has remained the front window and retained its size and position for some time.  Note that for a short time after recording, you can change the relative field in the action, and the values will update to appropriate values. By default, clicks are recorded relative to the front window, if that window has remained the front window and retained its size and position for some time.  Note that for a short time after recording, you can change the relative field in the action, and the values will update to appropriate values.
 +
 +==== Conflict Palette ====
  
 You can have the conflict palette use sequential hot keys from the first letter with: You can have the conflict palette use sequential hot keys from the first letter with:
Line 291: Line 358:
 <code bash> <code bash>
 defaults write com.stairways.keyboardmaestro.engine SequentialConflictPalette -bool YES defaults write com.stairways.keyboardmaestro.engine SequentialConflictPalette -bool YES
-</​code>​ 
- 
-You can configure the timing of a "​tap"​ (Hot Key and USB Device Key triggers) with: 
- 
-<code bash> 
-defaults write com.stairways.keyboardmaestro.engine MaxTapDownTime -float 1.0 
-defaults write com.stairways.keyboardmaestro.engine MaxTapUpTime -float 1.0 
 </​code>​ </​code>​
  
Line 321: Line 381:
 defaults write com.stairways.keyboardmaestro.engine RecordedClickRestoresMouseLocation -bool NO defaults write com.stairways.keyboardmaestro.engine RecordedClickRestoresMouseLocation -bool NO
 </​code>​ </​code>​
 +
 +==== Notifications ====
  
 You can control which notifications are displayed with: You can control which notifications are displayed with:
Line 331: Line 393:
 defaults write com.stairways.keyboardmaestro.engine "​Notification-ReceivedClipboard"​ -bool YES defaults write com.stairways.keyboardmaestro.engine "​Notification-ReceivedClipboard"​ -bool YES
 </​code>​ </​code>​
 +
 +==== Software Updates ====
  
 You can have new versions reported only when the editor activates with: You can have new versions reported only when the editor activates with:
Line 337: Line 401:
 defaults write com.stairways.keyboardmaestro.engine ReportUpdatesWhenEditorActivates -bool YES defaults write com.stairways.keyboardmaestro.engine ReportUpdatesWhenEditorActivates -bool YES
 </​code>​ </​code>​
 +
 +==== WebKit Inspector for HTML Prompt ====
  
 You can enable the WebKit inspector with: You can enable the WebKit inspector with:
manual/Preferences.1582692209.txt.gz · Last modified: 2020/02/25 23:43 by peternlewis