User Tools

Site Tools


manual:How_do_I

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:How_do_I [2019/06/18 01:19]
peternlewis
manual:How_do_I [2023/09/26 03:58] (current)
peternlewis
Line 3: Line 3:
 ===== How do I install Keyboard Maestro? ===== ===== How do I install Keyboard Maestro? =====
  
-To install Keyboard~~Maestro, ​simply copy it to your Mac’s FILE{{{Applications}}} folder (or anywhere you like).+To install Keyboard~~Maestro, ​[[https://​download.keyboardmaestro.com/​|download it]] and then use the Finder to move it to your Mac’s FILE{{{Applications}}} folder (or anywhere you like).
  
-Note: You must use the Finder to do this since the Finder will turn off Apple'​s App Translocation security feature when you move the application. ​+Note: You must use the Finder to do this since the Finder will turn off [[assistance:​Translocation_Problem|Apple'​s App Translocation]] security feature when you move the application.
  
 When you launch Keyboard~~Maestro it launches an invisible “Keyboard~~Maestro~~Engine” that continues to run even after you quit Keyboard~~Maestro. The engine is the process that enables your [[Macros]], [[Application Switcher]], and [[Clipboard History Switcher]] to work.  This means that they will continue to work after you quit Keyboard~~Maestro,​ as long as the engine is still running. When you launch Keyboard~~Maestro it launches an invisible “Keyboard~~Maestro~~Engine” that continues to run even after you quit Keyboard~~Maestro. The engine is the process that enables your [[Macros]], [[Application Switcher]], and [[Clipboard History Switcher]] to work.  This means that they will continue to work after you quit Keyboard~~Maestro,​ as long as the engine is still running.
Line 12: Line 12:
  
 You should consider turning on the “Launch Engine at Login” preference in the [[Windows#​Preferences_General_Pane|General preference pane]] to ensure all of Keyboard~~Maestro’s facilities are available to you as soon as you login or startup your Mac. You should consider turning on the “Launch Engine at Login” preference in the [[Windows#​Preferences_General_Pane|General preference pane]] to ensure all of Keyboard~~Maestro’s facilities are available to you as soon as you login or startup your Mac.
 +
 ===== How do I upgrade Keyboard Maestro? ===== ===== How do I upgrade Keyboard Maestro? =====
  
Line 18: Line 19:
 To upgrade Keyboard~~Maestro manually, quit the engine by choosing the [[Menus#​Quit_Engine|File ➤ Quit Engine menu]], and quit the editor, and replace the Keyboard~~Maestro application in your FILE{{{Applications}}} folder with the new one.  Finally, launch Keyboard Maestro to restart the engine. To upgrade Keyboard~~Maestro manually, quit the engine by choosing the [[Menus#​Quit_Engine|File ➤ Quit Engine menu]], and quit the editor, and replace the Keyboard~~Maestro application in your FILE{{{Applications}}} folder with the new one.  Finally, launch Keyboard Maestro to restart the engine.
  
-Keyboard~~Maestro will automatically import your previous version macros, clipboards and preferences. ​ Your old macros will be saved in the FILE{{{~/​Library/​Preferences/​Keyboard Maestro/​Keyboard Maestro Macros Saved Version ​8.plist}}} in case you wish to revert to version ​for any reason.+Keyboard~~Maestro will automatically import your previous version macros, clipboards and preferences. ​ Your old macros will be saved in the FILE{{{~/​Library/​Preferences/​Keyboard Maestro/​Keyboard Maestro Macros Saved Version ​10.plist}}} in case you wish to revert to version ​10 for any reason.
  
-If you are upgrading directly from a much older version, you will get better results by upgrading to the last of each major version in turn, ie, run 2.1.3, then 3.5, then 4.3.2, then 5.3.2, then 6.4.8, then 7.3.1, then 8.4.2, then the current version. ​ You can download old versions from our [[https://​files.stairways.com/​|file archive]].+If you are upgrading directly from a much older version, you will get better results by upgrading to the last of each major version in turn, ie, run 2.1.3, then 3.5, then 4.3.2, then 5.3.2, then 6.4.8, then 7.3.1, then 8.4.2, ​9.2, 10.2, and then the current version. ​ You can download old versions from our [[https://​files.stairways.com/​|file archive]].
  
 ===== How do I purchase Keyboard Maestro? ===== ===== How do I purchase Keyboard Maestro? =====
  
-New customers can purchase Keyboard~~Maestro for US$36 by choosing the [[Menus#​Purchase_Keyboard_Maestro|Keyboard Maestro ➤ Purchase Keyboard Maestro menu]]. ​ Customers with five or more users should contact us for a volume discount quote.+New customers can purchase Keyboard~~Maestro for US$36 by choosing the [[Menus#​Purchase_Keyboard_Maestro|Keyboard Maestro ➤ Purchase Keyboard Maestro menu]].  ​If you own a previous version of Keyboard Maestro and it is already registered, you can purchase the upgrade at a discount by choosing [[Menus#​Purchase_Keyboard_Maestro_Upgrade|Keyboard Maestro ➤ Purchase Keyboard Maestro Upgrade menu]]. ​Customers with ten or more users should contact us for a volume discount quote.
  
 You can look up your current or previous license status and serial numbers, and get information about discounted upgrades from [[https://​enquiry.stairways.com/​]]. You can look up your current or previous license status and serial numbers, and get information about discounted upgrades from [[https://​enquiry.stairways.com/​]].
Line 44: Line 45:
 If you do not receive your serial number promptly after purchasing, it may be that the email has not reached you, possibly due to spam filtering on your email service. ​ In this case, try looking up your purchase at [[https://​enquiry.stairways.com/​]] (although that will email you your serial number which might again be lost to over-zealous spam filters). If you do not receive your serial number promptly after purchasing, it may be that the email has not reached you, possibly due to spam filtering on your email service. ​ In this case, try looking up your purchase at [[https://​enquiry.stairways.com/​]] (although that will email you your serial number which might again be lost to over-zealous spam filters).
  
-Once you have your username (email address) and serial number, launch Keyboard~~Maestro and either immediately click the BUTTON{{{Use Existing License}}} button or choose [[Menus#​Register_Keyboard_Maestro|Keyboard Maestro ➤ Register Keyboard Maestro menu]] and then enter the username (email address) exactly as shown and the serial number exactly as shown and click the BUTTON{{{OK}}} button. ​ If you have any problems, recheck that the email address and serial number you are entering are exactly as shown (the serial number’s email address does not change even if you have changed your email address with us) and also that your license matches the major version number (eg, a version ​license will work with version ​8.x of Keyboard~~Maestro). ​ If you are already registered, the Register~~Keyboard~~Maestro menu will show you the registration details in the About Keyboard Maestro window — if it says it is registered to you, you are all set.+Once you have your username (email address) and serial number, launch Keyboard~~Maestro and either immediately click the BUTTON{{{Use Existing License}}} button or choose [[Menus#​Register_Keyboard_Maestro|Keyboard Maestro ➤ Register Keyboard Maestro menu]] and then enter the username (email address) exactly as shown and the serial number exactly as shown and click the BUTTON{{{OK}}} button. ​ If you have any problems, recheck that the email address and serial number you are entering are exactly as shown (the serial number’s email address does not change even if you have changed your email address with us) and also that your license matches the major version number (eg, a version ​10 license will work with version ​10.x of Keyboard~~Maestro). 
 + 
 +If you are already registered, the Register~~Keyboard~~Maestro menu will show you the registration details in the About Keyboard Maestro window — if it says it is registered to you, you are all set.
  
 ===== How do I get started? ===== ===== How do I get started? =====
Line 50: Line 53:
 The first thing to do is to read the [[Quick Start]] and do the tutorial by choosing the [[Menus#​Tutorial|Help ➤ Tutorial menu]]. ​ You may also want to subscribe to our Getting Started emails (Keyboard Maestro will ask you to subscribe or you can do that at your [[https://​www.stairways.com/​form/​manageemail|customer database page]] on our web site). The first thing to do is to read the [[Quick Start]] and do the tutorial by choosing the [[Menus#​Tutorial|Help ➤ Tutorial menu]]. ​ You may also want to subscribe to our Getting Started emails (Keyboard Maestro will ask you to subscribe or you can do that at your [[https://​www.stairways.com/​form/​manageemail|customer database page]] on our web site).
  
 +The best way to start using Keyboard Maestro is to start simple and then grow your macros organically. Simple things might include:
  
 +* launching or switching to a particular application.
 +* opening a particular document.
 +* typing a specific string of text (eg your name, address, etc).
  
-The best way to start using Keyboard Maestro is to start simple: +You may also like to joint the forum (https://​forum.keyboardmaestro.com/​) and ask for help with any macros you get stuck on. The forum is a fantastic resource, and if you are having troubles building a specific macro, the forum is the first place you should go to ask for help since we frequently cannot help with macros for specific applications that we probably don't have access ​to.
- +
-* Read the [[Quick Start]]. +
-* Do the Tutorial by choosing the [[Menus#​Tutorial|Help ➤ Tutorial menu]]. +
-* And then grow your macros organically,​ starting simple. +
-* Join the forum (https://​forum.keyboardmaestro.com/​) and ask for help with any macros you get stuck on. +
-* Consider enrolling in David Spark’s [[https://​learn.macsparky.com/​p/​km|Keyboard Maestro Field Guide]]. +
- +
-You may also want to subscribe to our Getting Started emails (Keyboard Maestro will ask you to subscribe or you can do that at your [[https://​www.stairways.com/​form/​manageemail|customer database page]] on our web site).+
  
-Then use your Mac normally and keep an eye out for things ​you do repetitively. ​ Things ​like:+If you would really ​like to extend your use of Keyboard Maestro, consider enrolling in David Spark’s [[https://​learn.macsparky.com/​p/​km|Keyboard Maestro Field Guide]].
  
-* launch or switch to a particular application. +Then use your Mac normally and keep an eye out for things you do repetitively.
-* open a particular document. +
-* type a specific string of text (eg your name, address, etc).+
  
-When you notice something, ​consider ​making a Macro to do it and assigning it to a Hot~~Key or Macro~~Palette or Status~~Menu trigger.+When you notice something, ​think about making a Macro to do it and assigning it to a [[trigger:​Hot_Key|Hot Key]] or [[trigger:​Global_Macro_Palette|Global ​Macro Palette]] or [[trigger:​Status_Menu|Status Menu]] trigger.
  
 Try to be consistent with your Hot~~Keys, for example you might have a set of applications you open, using a function key for each, and a set of documents you open, using a Control-Function Key combination for each of them, and a bunch of snippets of text your type, using Control-Letter for each of them (the letter could be a mnemonic to help you remember which one is which). ​ Consider putting a sticker on your keyboard across the top of your function keys to help you remember which ones do which function. ​ Remember that you can use the number pad keys as well. Try to be consistent with your Hot~~Keys, for example you might have a set of applications you open, using a function key for each, and a set of documents you open, using a Control-Function Key combination for each of them, and a bunch of snippets of text your type, using Control-Letter for each of them (the letter could be a mnemonic to help you remember which one is which). ​ Consider putting a sticker on your keyboard across the top of your function keys to help you remember which ones do which function. ​ Remember that you can use the number pad keys as well.
  
 Also, keep in mind common command keys and system defined hot keys and try to avoid conflicting with them. Also, keep in mind common command keys and system defined hot keys and try to avoid conflicting with them.
 +
 +And remember that you can give a bunch of macros the same hot key trigger and Keyboard Maestro will ask you which one you want to use when you press the key.
  
 See also the [[Tips]] section. See also the [[Tips]] section.
 +
 ===== How do I create a new Macro? ===== ===== How do I create a new Macro? =====
  
Line 99: Line 99:
 And finally, you can use the [[action:​Cancel_All_Macros|Cancel All Macros, Cancel Other Macros, Cancel This Macro, or Cancel Just This Macro]] actions. And finally, you can use the [[action:​Cancel_All_Macros|Cancel All Macros, Cancel Other Macros, Cancel This Macro, or Cancel Just This Macro]] actions.
  
-In desperation,​ you can quit the Keyboard Maestro Engine from the status menu, and you can launch the editor while holding all the modifiers down to quit all running engines ​and not launch the engine.+In desperation,​ you can quit the Keyboard Maestro Engine from the status menu or Safe Boot the Mac to restart it without launching any applications, and then you can launch the editor while holding all the modifiers down to quit all running engines.
  
 ===== How can I get the mouse coordinates on the screen or in a window? ===== ===== How can I get the mouse coordinates on the screen or in a window? =====
Line 161: Line 161:
 So to configure the Application~~Switcher,​ launch Keyboard Maestro, select the Switcher Group, and double click the Activate Application Switcher macro. ​ You can then configure the various Application Switcher parameters, such as style and icon size by configuring the Application Switcher action. ​ You can also configure the hot key used to activate the switcher, or disable the switcher. So to configure the Application~~Switcher,​ launch Keyboard Maestro, select the Switcher Group, and double click the Activate Application Switcher macro. ​ You can then configure the various Application Switcher parameters, such as style and icon size by configuring the Application Switcher action. ​ You can also configure the hot key used to activate the switcher, or disable the switcher.
  
-===== How do I backup / transfer my installation to another Mac? =====+===== How do I backup ​/ migrate ​/ transfer my installation to another Mac? ===== 
 + 
 +Your macros are stored on your local Mac in the Application Support folder. So ensure you have good backups of your entire Mac to ensure your macros are safe (good backups are always a good idea!).
  
 If you are going to continue using both Macs, you should use [[Macro_Syncing|Macro Syncing]] rather than transferring your information. ​ And indeed you can use Macro Syncing to transfer to a new Mac (even if both Macs wont be on at the same time as long as you preserve the sync file). If you are going to continue using both Macs, you should use [[Macro_Syncing|Macro Syncing]] rather than transferring your information. ​ And indeed you can use Macro Syncing to transfer to a new Mac (even if both Macs wont be on at the same time as long as you preserve the sync file).
Line 172: Line 174:
  
 Alternatively,​ to just transfer the macros, you can turn on Macro Syncing and save the macro sync file anywhere. ​ Transfer it to the new Mac, install Keyboard Maestro as normal, and then turn on macro syncing and select the transferred file to replace your macros. ​ Then turn off macro syncing. ​ This will transfer just the macros, not any settings, variables, or clipboards or the like. Alternatively,​ to just transfer the macros, you can turn on Macro Syncing and save the macro sync file anywhere. ​ Transfer it to the new Mac, install Keyboard Maestro as normal, and then turn on macro syncing and select the transferred file to replace your macros. ​ Then turn off macro syncing. ​ This will transfer just the macros, not any settings, variables, or clipboards or the like.
- 
  
 ===== How do I uninstall Keyboard Maestro? ===== ===== How do I uninstall Keyboard Maestro? =====
Line 197: Line 198:
  
 For version 8, open the FILE{{{~/​Library/​Application Support/​Keyboard Maestro}}} folder. ​ Trash the FILE{{{Keyboard Maestro Macros.plist}}} and replace it with the FILE{{{Keyboard Maestro Macros Saved Version 8.plist}}}. ​ Download Keyboard~~Maestro~~8.2.4,​ if necessary, from [[https://​files.stairways.com/​keyboardmaestro/​keyboardmaestro-824.zip]]. ​ Move Keyboard~~Maestro~~8 to the Applications folder and launch it.  Turn on the “Launch Engine at Login” preference if desired. For version 8, open the FILE{{{~/​Library/​Application Support/​Keyboard Maestro}}} folder. ​ Trash the FILE{{{Keyboard Maestro Macros.plist}}} and replace it with the FILE{{{Keyboard Maestro Macros Saved Version 8.plist}}}. ​ Download Keyboard~~Maestro~~8.2.4,​ if necessary, from [[https://​files.stairways.com/​keyboardmaestro/​keyboardmaestro-824.zip]]. ​ Move Keyboard~~Maestro~~8 to the Applications folder and launch it.  Turn on the “Launch Engine at Login” preference if desired.
 +
 +For version 9, open the FILE{{{~/​Library/​Application Support/​Keyboard Maestro}}} folder. ​ Trash the FILE{{{Keyboard Maestro Macros.plist}}} and replace it with the FILE{{{Keyboard Maestro Macros Saved Version 9.plist}}}. ​ Download Keyboard~~Maestro~~9.2,​ if necessary, from [[https://​files.stairways.com/​keyboardmaestro/​keyboardmaestro-92.zip]]. ​ Move Keyboard~~Maestro~~9 to the Applications folder and launch it.  Turn on the “Launch Engine at Login” preference if desired.
 +
 +For version 10, open the FILE{{{~/​Library/​Application Support/​Keyboard Maestro}}} folder. ​ Trash the FILE{{{Keyboard Maestro Macros.plist}}} and replace it with the FILE{{{Keyboard Maestro Macros Saved Version 10.plist}}}. ​ Download Keyboard~~Maestro~~10.2,​ if necessary, from [[https://​files.stairways.com/​keyboardmaestro/​keyboardmaestro-1020.zip]]. ​ Move Keyboard~~Maestro~~10 to the Applications folder and launch it.  Turn on the “Launch Engine at Login” preference if desired.
 +
manual/How_do_I.1560835198.txt.gz · Last modified: 2019/06/18 01:19 by peternlewis