You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://gitter.im/zyedidia/micro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -176,7 +172,7 @@ for other operating systems. These packages are not guaranteed to be up-to-date.
176
172
*`winget install zyedidia.micro`
177
173
* OpenBSD: Available in the ports tree and also available as a binary package.
178
174
*`pkg_add -v micro`.
179
-
* NetBSD, macOS, Linux, Illumos, etc. with [pkgsrc](http://www.pkgsrc.org/)-current:
175
+
* NetBSD, macOS, Linux, Illumos, etc. with [pkgsrc](https://www.pkgsrc.org/)-current:
180
176
*`pkg_add micro`
181
177
* macOS: Available in package managers.
182
178
*`sudo port install micro` (with [MacPorts](https://www.macports.org))
@@ -230,7 +226,7 @@ Native macOS builds are done with `CGO_ENABLED=1` forced set to support adding t
230
226
231
227
### macOS terminal
232
228
233
-
If you are using macOS, you should consider using [iTerm2](http://iterm2.com/) instead of the default terminal (Terminal.app). The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose `xterm defaults` under `Preferences->Profiles->Keys->Presets...`, and select `Esc+` for `Left Option Key` in the same menu. The newest versions also support true color.
229
+
If you are using macOS, you should consider using [iTerm2](https://iterm2.com/) instead of the default terminal (Terminal.app). The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose `xterm defaults` under `Preferences->Profiles->Keys->Presets...`, and select `Esc+` for `Left Option Key` in the same menu. The newest versions also support true color.
234
230
235
231
If you still insist on using the default Mac terminal, be sure to set `Use Option key as Meta key` under
236
232
`Preferences->Profiles->Keyboard` to use <kbd>option</kbd> as <kbd>alt</kbd>.
micro \- A modern and intuitive terminal-based text editor
4
4
.SH SYNOPSIS
5
5
.Bmicro
6
-
.RB [OPTIONS]
7
-
[FILE]\&...
8
-
6
+
.RI [ OPTION ]...\&
7
+
.RI [ FILE ]...\&
8
+
.RI [+ LINE [: COL ]]\&
9
+
.RI [+/ REGEX ]
10
+
.br
11
+
.Bmicro
12
+
.RI [ OPTION ]...\&
13
+
.RI [ FILE [: LINE [: COL ]]]...\&
14
+
\& (only if the `parsecursor` option is enabled)
9
15
.SH DESCRIPTION
10
-
11
16
Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
12
17
of modern terminals. It comes as one single, batteries-included, static binary with no dependencies.
13
18
14
19
As the name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use in a pinch, but micro also aims to be
15
20
enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).
16
21
17
22
Use Ctrl-q to quit, Ctrl-s to save, and Ctrl-g to open the in-editor help menu.
18
-
19
23
.SH OPTIONS
20
24
.PP
21
-
\-clean
25
+
.B\-clean
22
26
.RS4
23
-
Cleans the configuration directory
27
+
Clean the configuration directory and exit
24
28
.RE
25
-
26
29
.PP
27
-
\-config-dir dir
30
+
.B\-config-dir
31
+
.Idir
28
32
.RS4
29
33
Specify a custom location for the configuration directory
30
34
.RE
31
-
32
35
.PP
33
-
[FILE]:LINE:COL
36
+
.IR FILE : LINE [: COL ]
37
+
(only if the `parsecursor` option is enabled)
38
+
.br
39
+
.IR FILE \ + LINE [: COL ]
34
40
.RS4
35
41
Specify a line and column to start the cursor at when opening a buffer
36
42
.RE
37
-
38
43
.PP
39
-
\-options
44
+
.RI +/ REGEX
40
45
.RS4
41
-
Show all option help
46
+
Specify a regex to search for when opening a buffer
42
47
.RE
43
-
44
48
.PP
45
-
\-debug
49
+
.B\-options
50
+
.RS4
51
+
Show all options help and exit
52
+
.RE
53
+
.PP
54
+
.B\-debug
46
55
.RS4
47
56
Enable debug mode (enables logging to ./log.txt)
48
57
.RE
49
-
50
58
.PP
51
-
\-version
59
+
.B\-profile
52
60
.RS4
53
-
Show the version number and information
61
+
Enable CPU profiling (writes profile info to ./micro.prof so it can be analyzed later with "go tool pprof micro.prof")
62
+
.RE
63
+
.PP
64
+
.B\-version
65
+
.RS4
66
+
Show the version number and information and exit
54
67
.RE
55
68
56
69
Micro's plugins can be managed at the command line with the following commands.
57
70
.RS4
58
-
59
71
.PP
60
-
\-plugin remove [PLUGIN]...
72
+
.B\-plugininstall
73
+
.RI [ PLUGIN ]...
74
+
.RS4
75
+
Install plugin(s)
76
+
.RE
77
+
.PP
78
+
.B\-pluginremove
79
+
.RI [ PLUGIN ]...
61
80
.RS4
62
81
Remove plugin(s)
63
82
.RE
64
-
65
83
.PP
66
-
\-plugin update [PLUGIN]...
84
+
.B\-pluginupdate
85
+
.RI [ PLUGIN ]...
67
86
.RS4
68
87
Update plugin(s) (if no argument is given, updates all plugins)
69
88
.RE
70
-
71
89
.PP
72
-
\-plugin search [PLUGIN]...
90
+
.B\-pluginsearch
91
+
.RI [ PLUGIN ]...
73
92
.RS4
74
93
Search for a plugin
75
94
.RE
76
-
77
95
.PP
78
-
\-plugin list
96
+
.B\-pluginlist
79
97
.RS4
80
98
List installed plugins
81
99
.RE
82
-
83
100
.PP
84
-
\-plugin available
101
+
.B\-pluginavailable
85
102
.RS4
86
103
List available plugins
87
104
.RE
@@ -91,35 +108,33 @@ Micro's options can also be set via command line arguments for quick
91
108
adjustments. For real configuration, please use the settings.json
92
109
file (see 'help options').
93
110
.RS4
94
-
95
111
.PP
96
-
\-option value
112
+
.BI\-< option >
113
+
.Ivalue
97
114
.RS4
98
-
Set `option` to `value` for this session
115
+
Set `option` to `value` for this session.
116
+
.br
99
117
For example: `micro -syntax off file.c`
100
118
.RE
101
-
102
-
119
+
.RE
120
+
.PP
121
+
Use `micro -options` to see the full list of configuration options.
103
122
.SH CONFIGURATION
104
-
105
123
Micro uses $MICRO_CONFIG_HOME as the configuration directory.
106
124
If this environment variable is not set, it uses $XDG_CONFIG_HOME/micro instead.
107
125
If that environment variable is not set, it uses ~/.config/micro as the configuration directory.
108
126
In the documentation, we use ~/.config/micro to refer to the configuration directory
109
127
(even if it may in fact be somewhere else if you have set either of the above environment variables).
110
-
111
128
.SH NOTICE
112
129
This manpage is intended only to serve as a quick guide to the invocation of
113
130
micro and is not intended to replace the full documentation included with micro
114
131
which can be accessed from within micro. Micro tells you what key combination to
115
132
press to get help in the lower right.
116
-
117
133
.SH BUGS
118
134
A comprehensive list of bugs will not be listed in this manpage. See the Github
119
135
page at \fBhttps://github.com/zyedidia/micro/issues\fP for a list of known bugs
120
136
and to report any newly encountered bugs you may find. We strive to correct
121
137
bugs as swiftly as possible.
122
-
123
138
.SH COPYRIGHT
124
139
Copyright \(co 2020 Zachary Yedidia, et al. MIT license.
125
140
See \fBhttps://github.com/zyedidia/micro\fP for details.
0 commit comments