Commit 3dccba10 authored by Pablo Rauzy's avatar Pablo Rauzy Committed by Christoph Cullmann
Browse files

update README

parent 6468deec
......@@ -3,48 +3,75 @@ Keyboard Macros Plugin
Record and play keyboard macros (i.e., keyboard action sequences).
## Usage
## Basic usage
### Basic use
### To start recording a keyboard macro:
**To start recording a keyboard macro:**
Menu: `Tools > Keyboard Macros > Record Macro…`
Default shortcut: Ctrl+Shift+K
Default shortcut: `Ctrl+Shift+K`.
The plugin will record every key presses until you end recording.
**To end recording:**
### To end recording:
Menu: `Tools > Keyboard Macros > End Macro Recording`
Default shortcut: Ctrl+Shift+K
Default shortcut: `Ctrl+Shift+K`.
The plugin will stop recording key presses and save the key presses sequences as the current macro.
**To cancel recording:**
### To cancel recording:
Menu: `Tools > Keyboard Macros > Cancel Macro Recording`
The plugin will stop recording key presses but the current macro won't change.
**To play the current macro:**
Default shortcut: `Alt+Shift+K, D`.
### To play the current macro:
Menu: `Tools > Keyboard Macros > Play Macro`
Default shortcut: Ctrl+Alt+K
Default shortcut: `Ctrl+Alt+K`.
The plugin will play the current macro.
### Named macros
## Named macros
It is possible to save keyboard macros.
It is possible to save keyboard macros by giving them a name.
The `kmsave <name>` command will save the current macro under the name `<name>`.
Named macros are persistent between Kate's sessions, they're saved in the `keyboardmacros.json` file in Kate's user data directory (usually `~/.local/share/kate/`).
The `kmload <name>` command will load the macro saved under the name `<name>` as the current one.
### To save the current macro:
The `kmremove <name>` command will remove the macro saved under the name `<name>`.
Menu: `Tools > Keyboard Macros > Save Current Macro`
The `kmplay <name>` command will play the macro saved under the name `<name>` without loading it.
Default shortcut: `Alt+Shift+K, S`.
Note that after the `km` prefix all these commands use a different letter so you can efficiently use them using tab-completion :).
Command: `kmsave <name>` will save the current macro under the name `<name>`.
Named macros are persistent between Kate's sessions, they're saved in the `keyboardmacros.json` file in Kate's user data directory (usually `~/.local/share/kate/`).
### To load a saved macro as the current one:
Menu: `Tools > Keyboard Macros > Load Named Macro`
Default shortcut: `Alt+Shift+K, L`.
Command: `kmload <name>` will load the macro saved under the name `<name>` as the current one.
### To play a saved macro without loading it:
Command: `kmplay <name>` will play the macro saved under the name `<name>` without loading it.
### To delete a saved macro:
Default shortcut: `Alt+Shift+K, D`.
Command: `kmdelete <name>` will delete the macro saved under the name `<name>`.
### Tips for commands
Note that after the `km` prefix all these commands use a different letter so you can efficiently use them using tab-completion :).
## Limitations
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment