-.\" micro manual page - micro(1)
-.\"
-.\" Copyright © 2017 Zachary Yedidia <zyedidia@gmail.com>
-.\" Copyright © 2017 Collin Warren <anatoly@somethinghub.com>
-.\"
-.\" This document is provided under the same licensing as micro.
-.\" See \usr\share\doc\micro\LICENSE for more information.
-.TH micro 1 "2017-03-28"
+.TH micro 1 "2020-02-10"
.SH NAME
-micro \- An intuitive and modern terminal text editor
-.
+micro \- A modern and intuitive terminal-based text editor
.SH SYNOPSIS
.B micro
-.RB []
-[
-.I "filename \&..."
-]
+.RB [OPTIONS]
+[FILE]\&...
+
.SH DESCRIPTION
-( Copied from the README file. )
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
-.B \-v --version
-Displays the current version of micro and the git commit hash.
-.TP
-.SH ENVIRONMENT
-Micro's behaviour can be changed by setting environment variables, of which
-there is currently only one:
-.I MICRO_TRUE_COLOR
-
-When MICRO_TRUE_COLOR is set to 1, micro will attempt to treat your terminal as
-a true-color terminal and will be able to make full use of the true-color colorschemes
-that are included with micro. If MICRO_TRUE_COLOR is not set or is set to 0, then
-micro will only make use of 256 color features and will internally map true-color
-colorschemes to the nearest colors available. For more information see micro's documentation.
+.PP
+\-clean
+.RS 4
+Cleans the configuration directory
+.RE
+
+.PP
+\-config-dir dir
+.RS 4
+Specify a custom location for the configuration directory
+.RE
+
+.PP
+[FILE]:LINE:COL
+.RS 4
+Specify a line and column to start the cursor at when opening a buffer
+.RE
+
+.PP
+\-options
+.RS 4
+Show all option help
+.RE
+
+.PP
+\-debug
+.RS 4
+Enable debug mode (enables logging to ./log.txt)
+.RE
+
+.PP
+\-version
+.RS 4
+Show the version number and information
+.RE
+
+Micro's plugins can be managed at the command line with the following commands.
+.RS 4
+
+.PP
+\-plugin remove [PLUGIN]...
+.RS 4
+Remove plugin(s)
+.RE
+
+.PP
+\-plugin update [PLUGIN]...
+.RS 4
+Update plugin(s) (if no argument is given, updates all plugins)
+.RE
+
+.PP
+\-plugin search [PLUGIN]...
+.RS 4
+Search for a plugin
+.RE
+
+.PP
+\-plugin list
+.RS 4
+List installed plugins
+.RE
+
+.PP
+\-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
+\-option value
+.RS 4
+Set `option` to `value` for this session
+For example: `micro -syntax off file.c`
+.RE
+
+
+.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
bugs as swiftly as possible.
.SH COPYRIGHT
-Copyright \(co 2017 Zachary Yedidia, Collin Warren, et al.
-See /usr/share/doc/micro/LICENSE and /usr/share/doc/micro/AUTHORS for more information.
+Copyright \(co 2020 Zachary Yedidia, et al. MIT license.
+See \fBhttps://github.com/zyedidia/micro\fP for details.
projects / micro.git / blobdiff