X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=sidebyside;f=runtime%2Fhelp%2Fcommands.md;h=a1e64cbcafe841f768e29271b99c0cb27d422589;hb=0f4f60c018a396e42f00f45b1279fcb06fa046e1;hp=45264f2ac32f5e3546b164ad660354eab1a10e40;hpb=d247db3e9d4e9d4462d6a33aa1c666e8477354c4;p=micro.git diff --git a/runtime/help/commands.md b/runtime/help/commands.md index 45264f2a..a1e64cbc 100644 --- a/runtime/help/commands.md +++ b/runtime/help/commands.md @@ -9,11 +9,12 @@ Here are the possible commands that you can use. will 'save as' the filename. * `replace "search" "value" flags`: This will replace `search` with `value`. - The `flags` are optional. At this point, there is only one flag: `-a`, which - replaces all occurrences at once. + The `flags` are optional. Possible flags are: + * `-a`: Replace all occurrences at once + * `-l`: Do a literal search instead of a regex search - Note that `search` must be a valid regex. If one of the arguments does not - have any spaces in it, you may omit the quotes. + Note that `search` must be a valid regex (unless `-l` is passed). If one + of the arguments does not have any spaces in it, you may omit the quotes. * `replaceall "search" "value"`: This will replace `search` with `value` without user confirmation. @@ -79,8 +80,26 @@ Here are the possible commands that you can use. * `retab`: Replaces all leading tabs with spaces or leading spaces with tabs depending on the value of `tabstospaces`. +* `raw`: Micro will open a new tab and show the escape sequence for every event + it receives from the terminal. This shows you what micro actually sees from + the terminal and helps you see which bindings aren't possible and why. This + is most useful for debugging keybindings. + +* `showkey`: Show the action(s) bound to a given key. For example + running `> showkey CtrlC` will display `main.(*View).Copy`. Unfortuately + showkey does not work well for keys bound to plugin actions. For those + it just shows "LuaFunctionBinding." + --- The following commands are provided by the default plugins: * `lint`: Lint the current file for errors. + +# Command Parsing + +When running a command, you can use extra syntax that micro will expand before +running the command. To use an argument with a space in it, simply put it in +quotes. You can also use environment variables in the command bar and they +will be expanded to their value. Finally, you can put an expression in backticks +and it will be evaluated by the shell beforehand.