User Tools
manual:How_do_I
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
manual:How_do_I [2017/09/24 23:19] peternlewis [How do I cancel a running Macro?] |
manual:How_do_I [2019/06/14 00:22] peternlewis [How do I revert to a previous version of Keyboard Maestro?] |
||
|---|---|---|---|
| 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, simply copy it to your Mac’s FILE{{{Applications}}} folder (or anywhere you like). |
| - | Note: You must use the Finder to do this will turn off Apple's App Translocation security feature when you move the application with the Finder. | + | 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. |
| 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 18: | Line 18: | ||
| To upgrade Keyboard~~Maestro manually, quit the engine by choosing [[Menus#File_Quit_Engine|Quit Engine]] from the [[Menus#File|File menu]] and 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 [[Menus#File_Quit_Engine|Quit Engine]] from the [[Menus#File|File menu]] and 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 7.plist}}} in case you wish to revert to version 7 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 8.plist}}} in case you wish to revert to version 7 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 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, 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? ===== | ||
| Line 44: | Line 44: | ||
| 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#Keyboard_Maestro_Register_Keyboard_Maestro|Register Keyboard Maestro]] from the [[Menus#Keyboard_Maestro|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 8 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. | + | 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#Keyboard_Maestro_Register_Keyboard_Maestro|Register Keyboard Maestro]] from the [[Menus#Keyboard_Maestro|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 8 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. |
| ===== How do I get started? ===== | ===== How do I get started? ===== | ||
| Line 50: | Line 50: | ||
| The first thing to do is to read the [[Quick Start]] and do the tutorial by choosing [[Menus#Help_Tutorial|Tutorial]] from the [[Menus#Help|Help 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 [[Menus#Help_Tutorial|Tutorial]] from the [[Menus#Help|Help 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). | ||
| - | After that, use your Mac normally and keep an eye out for things you do repetitively. Things like: | + | |
| + | |||
| + | The best way to start using Keyboard Maestro is to start simple: | ||
| + | |||
| + | * Read the [[Quick Start]]. | ||
| + | * Do the Tutorial by choosing [[Menus#Help_Tutorial|Tutorial]] from the [[Menus#Help|Help 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: | ||
| * launch or switch to a particular application. | * launch or switch to a particular application. | ||
| Line 63: | Line 75: | ||
| 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 74: | Line 85: | ||
| ===== How do I find a Macro I've used or modified recently? ===== | ===== How do I find a Macro I've used or modified recently? ===== | ||
| - | You can sort the macros by name, by trigger, by date created, modified or used. So if you launch Keyboard Maestro, select the All Macros pseudo group, and then choose [[Menus#View_Sort_Macros_by_Date_Modified|Sort Macros by Date Modified]] from the [[Menus#View|View menu]] (or choose [[Menus#View_Sort_Macros_by_Date_Used|Sort Macros by Date Used]] from the [[Menus#View|View menu]]) to sort the recently modified (or used) macros to the top. | + | You can sort the macros by name, by trigger, by date created, modified or used. So if you launch Keyboard Maestro, select the All Macros smart group, and then choose [[Menus#View_Sort_Macros_by_Date_Modified|Sort Macros by Date Modified]] from the [[Menus#View|View menu]] (or choose [[Menus#View_Sort_Macros_by_Date_Used|Sort Macros by Date Used]] from the [[Menus#View|View menu]]) to sort the recently modified (or used) macros to the top. |
| You can also click the BUTTON{{{◷}}} button above the macro editor pane to select from recently modified macros, or use the BUTTON{{{⌘}}} button to select from recently used macros. | You can also click the BUTTON{{{◷}}} button above the macro editor pane to select from recently modified macros, or use the BUTTON{{{⌘}}} button to select from recently used macros. | ||
| Line 109: | Line 120: | ||
| Here is how to create a Macro to insert an image when you press a Hot~~Key. | Here is how to create a Macro to insert an image when you press a Hot~~Key. | ||
| - | * Create a macro (see the [[How_do_I#How_do_I_create_a_new_Macro?|How do I create a new Macro?]] section) with the [[/action/Paste_from_Named_Clipboard|Paste from Named Clipboard action]]. | + | * Create a macro (see the [[How_do_I#How_do_I_create_a_new_Macro?|How do I create a new Macro?]] section) with the [[action:Set_Clipboard_to_Image | Set Clipboard to Image]] action. |
| - | * Select New from the clipboard popup menu, which will create a new named clipboard and show it in the [[Windows#Preferences_Clipboards_Pane|Clipboards preference pane]]. | + | * Paste your image in to the action, or have the action read the image from a file or Named~~Clipboard. |
| - | * Name the new clipboard “My Image”. | + | * Then use the [[action:Paste | Paste]] action to paste your image. |
| - | * Go find your image and copy it, and return to the Preferences window, click on the My Image clipboard on the left side so it is selected, and choose [[Menus#Edit_Paste|Paste]] from the [[Menus#Edit|Edit menu]] to assign the image to the clipboard. | + | |
| Name the macro, and assign it whatever trigger you desire. | Name the macro, and assign it whatever trigger you desire. | ||
| Now whenever you trigger the macro you just created, your image will be pasted in. | Now whenever you trigger the macro you just created, your image will be pasted in. | ||
| - | |||
| ===== How do I Insert the current date? ===== | ===== How do I Insert the current date? ===== | ||
| - | You can insert text using the [[/action/Insert_Text|Insert Text action]], and it processes [[Tokens]]. There are some basic date format tokens (such as CODE{{{%LongDate%}}}), or you can use the CODE{{{%ICUDateTime%}}} [[Tokens|Token]] with any [[https://www.stairways.com/action/linkthru?icudatetime|ICU date format]]. | + | You can insert text using the [[/action/Insert_Text|Insert Text action]], and it processes [[Tokens]]. There are some basic date format tokens (such as the [[token:LongDate|%LongDate%]] token), or you can use the [[token:ICUDateTime|%ICUDateTime%]] token with any [[https://www.stairways.com/action/linkthru?icudatetime|ICU date format]]. |
| ===== How do I get more than one Macro Palette (Toolbar)? ===== | ===== How do I get more than one Macro Palette (Toolbar)? ===== | ||
| Line 130: | Line 138: | ||
| * When a hot key (or typed string or device key) conflicts (ie, triggers more than one macro), the [[Windows#Conflict_Palette|Conflict Palette]] appears which lets you select from the conflicting macros. This can be an easy way to allow a single hot key to offer a multitude of similar actions. You can then use number keys or the mouse to select the desired hot key, or can use other keys to filter the palette until only one macro remains. | * When a hot key (or typed string or device key) conflicts (ie, triggers more than one macro), the [[Windows#Conflict_Palette|Conflict Palette]] appears which lets you select from the conflicting macros. This can be an easy way to allow a single hot key to offer a multitude of similar actions. You can then use number keys or the mouse to select the desired hot key, or can use other keys to filter the palette until only one macro remains. | ||
| - | So to have more than one macro palette, create a macro group for each desired palette and configure it to show a palette as desired. Put your macros in there. Create as many of these as you like.The macros in such a macro group are only active while the palette is displayed, so if you only display it occasionally, especially only for one action, then they can have very simple hot keys (like plain letters for example). | + | So to have more than one macro palette, create a macro group for each desired palette and configure it to show a palette as desired. Put your macros in there. Create as many of these as you like. The macros in such a macro group are only active while the palette is displayed, so if you only display it occasionally, especially only for one action, then they can have very simple hot keys (like plain letters for example). |
| You can control the order of macros in a macro palette (or the status menu) by prefixing their name with two characters and a closing parenthesis (eg "01)" - two characters and a closing bracket). The macros will be sorted based on the code, but the code will be stripped off before display in the palette (or status menu). | You can control the order of macros in a macro palette (or the status menu) by prefixing their name with two characters and a closing parenthesis (eg "01)" - two characters and a closing bracket). The macros will be sorted based on the code, but the code will be stripped off before display in the palette (or status menu). | ||
| Line 156: | Line 164: | ||
| 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). | ||
| - | To transfer all your information to a new Mac you can copy the FILE{{{~/Library/Application Support/Keyboard Maestro}}} folder and optionally the FILE{{{~/Library/Preferences/com.stairways.keyboardmaestro.*}}} files to your new Mac. You can get to FILE{{{~/Library}}} in the Finder by holding down the option key and selecting Library from the Go menu. | + | To transfer all your information to a new Mac you can copy the FILE{{{~/Library/Application Support/Keyboard Maestro}}} folder and optionally the FILE{{{~/Library/Preferences/com.stairways.keyboardmaestro.*}}} files to your new Mac. You can get to FILE{{{~/Library}}} in the Finder by holding down the shift (or option) key and selecting Library from the Go menu. |
| - | Make sure that Keyboard Maestro and Keyboard Maestro Engine are not running on the source or target Mac when you transfer the folder. And make sure the resulting files and folders have the correct ownership and permissions. | + | Make sure that Keyboard Maestro and Keyboard Maestro Engine are not running on the source or target Mac when you transfer the folder. And make sure the resulting files and folders have the **correct ownership and permissions**. |
| If you copy the FILE{{{com.stairways.keyboardmaestro.*}}} files, the new Mac will have the same [[token:MacUUID]] token and be considered the same Mac for syncing purposes, so you should not do this if you intend to continue using the old Mac. | If you copy the FILE{{{com.stairways.keyboardmaestro.*}}} files, the new Mac will have the same [[token:MacUUID]] token and be considered the same Mac for syncing purposes, so you should not do this if you intend to continue using the old Mac. | ||
| Line 185: | Line 193: | ||
| For version 7, 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 7.plist}}}. Download Keyboard~~Maestro~~7.3.1, if necessary, from [[https://files.stairways.com/keyboardmaestro/keyboardmaestro-731.zip]]. Move Keyboard~~Maestro~~7 to the Applications folder and launch it. Turn on the “Launch Engine at Login” preference if desired. | For version 7, 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 7.plist}}}. Download Keyboard~~Maestro~~7.3.1, if necessary, from [[https://files.stairways.com/keyboardmaestro/keyboardmaestro-731.zip]]. Move Keyboard~~Maestro~~7 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. | ||
manual/How_do_I.txt · Last modified: 2023/09/26 03:58 by peternlewis
Page Tools
