mirror of
https://github.com/Hopiu/micro.git
synced 2026-03-17 06:20:28 +00:00
Improve help text
This commit is contained in:
Zachary Yedidia
parent
1f62ff9d80
commit
74bd338cbc
2 changed files with 53 additions and 22 deletions
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,20 @@
|
|||
# Micro help text
|
||||
|
||||
Micro is a terminal-based text editor that aims to be easy to use and intuitive,
|
||||
while also taking advantage of the full capabilities of modern terminals.
|
||||
|
||||
### Usage
|
||||
|
||||
Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
|
||||
|
||||
Micro also supports creating buffers from stdin:
|
||||
|
||||
```
|
||||
$ ifconfig | micro
|
||||
```
|
||||
|
||||
You can move the cursor around with the arrow keys and mouse.
|
||||
|
||||
### Keybindings
|
||||
|
||||
These are the default keybindings, along with their actions.
|
||||
|
|
@ -15,29 +30,22 @@ These are the default keybindings, along with their actions.
|
|||
|
||||
* Ctrl-s: Save
|
||||
* Ctrl-o: Open file
|
||||
|
||||
* Ctrl-z: Undo
|
||||
* Ctrl-y: Redo
|
||||
|
||||
* Ctrl-f: Find
|
||||
* Ctrl-n: Find next
|
||||
* Ctrl-p: Find previous
|
||||
|
||||
* Ctrl-a: Select all
|
||||
|
||||
* Ctrl-c: Copy
|
||||
* Ctrl-x: Cut
|
||||
* Ctrl-k: Cut line
|
||||
* Ctrl-v: Paste
|
||||
|
||||
* Ctrl-u: Half page up
|
||||
* Ctrl-d: Half page down
|
||||
* PageUp: Page up
|
||||
* PageDown: Page down
|
||||
|
||||
* Home: Go to beginning of file
|
||||
* End: Go to end of file
|
||||
|
||||
* Ctrl-r: Toggle line numbers
|
||||
|
||||
The buffer bindings may be rebound using the `~/.config/micro/bindings.json` file. Each key is bound to an action.
|
||||
|
|
@ -59,13 +67,14 @@ Here are the possible commands that you can use.
|
|||
* `quit`: Quits micro.
|
||||
* `save`: Saves the current buffer.
|
||||
|
||||
`replace "search" "value"`: This will replace `search` with `value`.
|
||||
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.
|
||||
* `replace "search" "value"`: This will replace `search` with `value`.
|
||||
|
||||
`set option value`: sets the option to value. Please see the next section for a list of options you can set.
|
||||
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.
|
||||
|
||||
`run sh-command`: runs the given shell command in the background. The command's output will be displayed
|
||||
* `set option value`: sets the option to value. Please see the next section for a list of options you can set.
|
||||
|
||||
* `run sh-command`: runs the given shell command in the background. The command's output will be displayed
|
||||
in one line when it finishes running.
|
||||
|
||||
### Options
|
||||
|
|
@ -77,31 +86,53 @@ if `$XDG_CONFIG_HOME` is not set, `~/.config/micro` is used as the config direct
|
|||
|
||||
Here are the options that you can set:
|
||||
|
||||
`colorscheme`: loads the colorscheme stored in $(configDir)/colorschemes/`option`.micro
|
||||
* `colorscheme`: loads the colorscheme stored in $(configDir)/colorschemes/`option`.micro
|
||||
|
||||
default value: `default`
|
||||
Note that the default colorschemes (default, solarized, and solarized-tc) are not located in configDir,
|
||||
because they are embedded in the micro binary
|
||||
|
||||
`tabsize`: sets the tab size to `option`
|
||||
The colorscheme can be selected from all the files in the ~/.config/micro/colorschemes/ directory. Micro comes by default with three colorschemes:
|
||||
|
||||
* default: this is the default colorscheme.
|
||||
* solarized: this is the solarized colorscheme (used in the screenshot). You should have the
|
||||
solarized color palette in your terminal to use it.
|
||||
* solarized-tc: this is the solarized colorscheme for true color, just make sure
|
||||
your terminal supports true color before using it and that the MICRO_TRUECOLOR environment
|
||||
variable is set to 1 before starting micro.
|
||||
|
||||
|
||||
* `tabsize`: sets the tab size to `option`
|
||||
|
||||
default value: `4`
|
||||
|
||||
`syntax`: turns syntax on or off
|
||||
* `syntax`: turns syntax on or off
|
||||
|
||||
default value: `on`
|
||||
|
||||
`tabsToSpaces`: use spaces instead of tabs
|
||||
* `tabsToSpaces`: use spaces instead of tabs
|
||||
|
||||
default value: `off`
|
||||
|
||||
`autoindent`: when creating a new line use the same indentation as the previous line
|
||||
* `autoindent`: when creating a new line use the same indentation as the previous line
|
||||
|
||||
default value: `on`
|
||||
|
||||
`ruler`: display line numbers
|
||||
* `ruler`: display line numbers
|
||||
|
||||
default value: `on`
|
||||
|
||||
`gofmt`: Run `gofmt` whenever the file is saved (this only applies to `.go` files)
|
||||
* `gofmt`: Run `gofmt` whenever the file is saved (this only applies to `.go` files)
|
||||
|
||||
default value: `off`
|
||||
|
||||
`goimports`: run `goimports` whenever the file is saved (this only applies to `.go` files)
|
||||
* `goimports`: run `goimports` whenever the file is saved (this only applies to `.go` files)
|
||||
|
||||
default value: `off`
|
||||
|
||||
Any option you set in the editor will be saved to the file ~/.config/micro/settings.json so,
|
||||
in effect, your configuration file will be created for you. If you'd like to take your configuration
|
||||
with you to another machine, simply copy the settings.json to the other machine.
|
||||
|
||||
In the future, the `gofmt` and `goimports` will be refactored using a plugin system. However,
|
||||
currently they just make it easier to program micro in micro.
|
||||
|
|
|
|||
Loading…
Reference in a new issue