mirror of
https://github.com/micro-editor/micro.git
synced 2026-10-12 02:18:55 +00:00
Andrew Whitworth
de6b5b1768
This argument allows us to execute one or more commands immediately after editor initialization. This is useful in cases where you know you are going to want to open two panes immediately, or for scripting purposes so you can start with certain things set up, or if you want to execute certain plugin actions at startup, etc. Usage: micro -exec "...cmd..." micro -exec "cmd1" -exec "cmd2" -exec "cmd3" ... (multiple commands are gathered into an array and executed in order) Commands are executed after plugin initialization, so you can use plugin commands as well. Updated man page with information about the new argument.
147 lines
3.8 KiB
Groff
147 lines
3.8 KiB
Groff
.TH micro 1 "2025-09-03"
|
|
.SH NAME
|
|
micro \- A modern and intuitive terminal-based text editor
|
|
.SH SYNOPSIS
|
|
.B micro
|
|
.RI [ OPTION ]...\&
|
|
.RI [ FILE ]...\&
|
|
.RI [+ LINE [: COL ]]\&
|
|
.RI [+/ REGEX ]
|
|
.br
|
|
.B micro
|
|
.RI [ OPTION ]...\&
|
|
.RI [ FILE [: LINE [: COL ]]]...\&
|
|
\& (only if the `parsecursor` option is enabled)
|
|
.SH DESCRIPTION
|
|
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. It comes as one single, batteries-included, static binary with no dependencies.
|
|
|
|
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
|
|
enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).
|
|
|
|
Use Ctrl-q to quit, Ctrl-s to save, and Ctrl-g to open the in-editor help menu.
|
|
.SH OPTIONS
|
|
.PP
|
|
.B \-clean
|
|
.RS 4
|
|
Clean the configuration directory and exit
|
|
.RE
|
|
.PP
|
|
.B \-config-dir
|
|
.I dir
|
|
.RS 4
|
|
Specify a custom location for the configuration directory
|
|
.RE
|
|
.PP
|
|
.IR FILE : LINE [: COL ]
|
|
(only if the `parsecursor` option is enabled)
|
|
.br
|
|
.IR FILE \ + LINE [: COL ]
|
|
.RS 4
|
|
Specify a line and column to start the cursor at when opening a buffer
|
|
.RE
|
|
.PP
|
|
.RI +/ REGEX
|
|
.RS 4
|
|
Specify a regex to search for when opening a buffer
|
|
.RE
|
|
.PP
|
|
.B \-options
|
|
.RS 4
|
|
Show all options help and exit
|
|
.RE
|
|
.PP
|
|
.B \-debug
|
|
.RS 4
|
|
Enable debug mode (enables logging to ./log.txt)
|
|
.RE
|
|
.PP
|
|
.B \-profile
|
|
.RS 4
|
|
Enable CPU profiling (writes profile info to ./micro.prof so it can be analyzed later with "go tool pprof micro.prof")
|
|
.RE
|
|
.PP
|
|
.B \-version
|
|
.RS 4
|
|
Show the version number and information and exit
|
|
.RE
|
|
.PP
|
|
.B \-exec
|
|
.I command
|
|
.RS 4
|
|
Run a command after the editor initializes (may be repeated)
|
|
.RE
|
|
|
|
Micro's plugins can be managed at the command line with the following commands.
|
|
.RS 4
|
|
.PP
|
|
.B \-plugin install
|
|
.RI [ PLUGIN ]...
|
|
.RS 4
|
|
Install plugin(s)
|
|
.RE
|
|
.PP
|
|
.B \-plugin remove
|
|
.RI [ PLUGIN ]...
|
|
.RS 4
|
|
Remove plugin(s)
|
|
.RE
|
|
.PP
|
|
.B \-plugin update
|
|
.RI [ PLUGIN ]...
|
|
.RS 4
|
|
Update plugin(s) (if no argument is given, updates all plugins)
|
|
.RE
|
|
.PP
|
|
.B \-plugin search
|
|
.RI [ PLUGIN ]...
|
|
.RS 4
|
|
Search for a plugin
|
|
.RE
|
|
.PP
|
|
.B \-plugin list
|
|
.RS 4
|
|
List installed plugins
|
|
.RE
|
|
.PP
|
|
.B \-plugin available
|
|
.RS 4
|
|
List available plugins
|
|
.RE
|
|
.RE
|
|
|
|
Micro's options can also be set via command line arguments for quick
|
|
adjustments. For real configuration, please use the settings.json
|
|
file (see 'help options').
|
|
.RS 4
|
|
.PP
|
|
.BI \-< option >
|
|
.I value
|
|
.RS 4
|
|
Set `option` to `value` for this session.
|
|
.br
|
|
For example: `micro -syntax off file.c`
|
|
.RE
|
|
.RE
|
|
.PP
|
|
Use `micro -options` to see the full list of configuration options.
|
|
.SH CONFIGURATION
|
|
Micro uses $MICRO_CONFIG_HOME as the configuration directory.
|
|
If this environment variable is not set, it uses $XDG_CONFIG_HOME/micro instead.
|
|
If that environment variable is not set, it uses ~/.config/micro as the configuration directory.
|
|
In the documentation, we use ~/.config/micro to refer to the configuration directory
|
|
(even if it may in fact be somewhere else if you have set either of the above environment variables).
|
|
.SH NOTICE
|
|
This manpage is intended only to serve as a quick guide to the invocation of
|
|
micro and is not intended to replace the full documentation included with micro
|
|
which can be accessed from within micro. Micro tells you what key combination to
|
|
press to get help in the lower right.
|
|
.SH BUGS
|
|
A comprehensive list of bugs will not be listed in this manpage. See the Github
|
|
page at \fBhttps://github.com/micro-editor/micro/issues\fP for a list of known bugs
|
|
and to report any newly encountered bugs you may find. We strive to correct
|
|
bugs as swiftly as possible.
|
|
.SH COPYRIGHT
|
|
Copyright \(co 2020 Zachary Yedidia, et al. MIT license.
|
|
See \fBhttps://github.com/micro-editor/micro\fP for details.
|