]> git.lizzy.rs Git - micro.git/blob - assets/packaging/micro.1
Merge pull request #877 from IOAyman/readme
[micro.git] / assets / packaging / micro.1
1 .\" micro manual page - micro(1)
2 .\" 
3 .\" Copyright © 2017 Zachary Yedidia <zyedidia@gmail.com>
4 .\" Copyright © 2017 Collin Warren <anatoly@somethinghub.com>
5 .\"
6 .\" This document is provided under the same licensing as micro.
7 .\" See \usr\share\doc\micro\LICENSE for more information.
8 .TH micro 1 "2017-03-28"
9 .SH NAME
10 micro \- An intuitive and modern terminal text editor
11 .
12 .SH SYNOPSIS
13 .B micro
14 .RB []
15 [
16 .I "filename \&..."
17 ]
18 .SH DESCRIPTION
19 ( Copied from the README file. )
20
21 Micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the full capabilities
22 of modern terminals. It comes as one single, batteries-included, static binary with no dependencies.
23
24 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
25 enjoyable to use full time, whether you work in the terminal because you prefer it (like me), or because you need to (over ssh).
26
27 .SH OPTIONS
28 .B \-v --version
29 Displays the current version of micro and the git commit hash. 
30 .TP
31 .SH ENVIRONMENT
32 Micro's behaviour can be changed by setting environment variables, of which 
33 there is currently only one:
34 .I MICRO_TRUE_COLOR
35
36 When MICRO_TRUE_COLOR is set to 1, micro will attempt to treat your terminal as
37 a true-color terminal and will be able to make full use of the true-color colorschemes
38 that are included with micro. If MICRO_TRUE_COLOR is not set or is set to 0, then
39 micro will only make use of 256 color features and will internally map true-color
40 colorschemes to the nearest colors available. For more information see micro's documentation.
41
42 .SH NOTICE
43 This manpage is intended only to serve as a quick guide to the invocation of 
44 micro and is not intended to replace the full documentation included with micro
45 which can be accessed from within micro. Micro tells you what key combination to
46 press to get help in the lower right.
47
48 .SH BUGS
49 A comprehensive list of bugs will not be listed in this manpage. See the Github
50 page at \fBhttps://github.com/zyedidia/micro/issues\fP for a list of known bugs
51 and to report any newly encountered bugs you may find. We strive to correct
52 bugs as swiftly as possible.
53
54 .SH COPYRIGHT
55 Copyright \(co 2017 Zachary Yedidia, Collin Warren, et al.
56 See /usr/share/doc/micro/LICENSE and /usr/share/doc/micro/AUTHORS for more information.