zyedidia/micro
1
Fork 0
mirror of https://github.com/zyedidia/micro.git synced 2025-06-18 23:05:40 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve man page

Browse Source
This commit is contained in:
Zachary Yedidia 2018-01-29 20:36:18 -05:00
parent aaf098bb47
commit f48116801b
1 changed files with 36 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
assets/packaging/micro.1
View File

@ -7,16 +7,13 @@
.\" See \usr\share\doc\micro\LICENSE for more information. .\" See \usr\share\doc\micro\LICENSE for more information.
.TH micro 1 "2017-03-28" .TH micro 1 "2017-03-28"
.SH NAME .SH NAME
micro \- An intuitive and modern terminal text editor micro \- A modern and intuitive terminal-based text editor
.
.SH SYNOPSIS .SH SYNOPSIS
.B micro .B micro
.RB [] .RB [OPTIONS]
[ [FILE]\&...
.I "filename \&..."
]
.SH DESCRIPTION .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 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. of modern terminals. It comes as one single, batteries-included, static binary with no dependencies.
@ -25,19 +22,39 @@ As the name indicates, micro aims to be somewhat of a successor to the nano edit
enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh). enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).
.SH OPTIONS .SH OPTIONS
.B \-v --version .PP
Displays the current version of micro and the git commit hash. \-config-dir dir
.TP .RS 4
.SH ENVIRONMENT Specify a custom location for the configuration directory
Micro's behaviour can be changed by setting environment variables, of which .RE
there is currently only one: .PP
.I MICRO_TRUE_COLOR \-startpos 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
\-version
.RS 4
Show the version number and information
.RE
When MICRO_TRUE_COLOR is set to 1, micro will attempt to treat your terminal as .SH CONFIGURATION
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 uses
micro will only make use of 256 color features and will internally map true-color \fI$XDG_CONFIG_HOME/micro\fR
colorschemes to the nearest colors available. For more information see micro's documentation. for configuration by default. If it is not set, micro uses ~/.config/micro.
Two main configuration files are settings.json, containing the user's
settings, and bindings.json, containing the user's custom keybindings.
.SH ENVIRONMENT
Micro's behaviour can be changed by setting environment variables, of which there is currently only one:
\fIMICRO_TRUECOLOR\fR.
When MICRO_TRUECOLOR 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_TRUECOLOR 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.
.SH NOTICE .SH NOTICE
This manpage is intended only to serve as a quick guide to the invocation of This manpage is intended only to serve as a quick guide to the invocation of