assets/packaging/micro.1

   1 .TH micro 1 "2020-02-10"
   2 .SH NAME
   3 micro \- A modern and intuitive terminal-based text editor
   4 .SH SYNOPSIS
   5 .B micro
   6 .RB [OPTIONS]
   7 [FILE]\&...
   8
   9 .SH DESCRIPTION
  10
  11 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 of modern terminals. It comes as one single, batteries-included, static binary with no dependencies.
  13
  14 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 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
  17 .SH OPTIONS
  18 .PP
  19 \-clean
  20 .RS4
  21 Cleans the configuration directory
  22 .RE
  23
  24 .PP
  25 \-config-dir dir
  26 .RS 4
  27 Specify a custom location for the configuration directory
  28 .RE
  29
  30 .PP
  31 \-[FILE]:LINE:COL
  32 .RS 4
  33 Specify a line and column to start the cursor at when opening a buffer
  34 .RE
  35
  36 .PP
  37 \-options
  38 .RS 4
  39 Show all option help
  40 .RE
  41
  42 .PP
  43 \-debug
  44 .RS 4
  45 Enable debug mode (enables logging to ./log.txt)
  46 .RE
  47
  48 .PP
  49 \-version
  50 .RS 4
  51 Show the version number and information
  52 .RE
  53
  54 Micro's plugin's can be managed at the command line with the following commands.
  55 .RS 4
  56
  57 .PP
  58 \-plugin remove [PLUGIN]...
  59 .RS 4
  60 Remove plugin(s)
  61 .RE
  62
  63 .PP
  64 \-plugin update [PLUGIN]...
  65 .RS 4
  66 Update plugin(s) (if no argument is given, updates all plugins)
  67 .RE
  68
  69 .PP
  70 \-plugin search [PLUGIN]...
  71 .RS 4
  72 Search for a plugin
  73 .RE
  74
  75 .PP
  76 \-plugin list
  77 .RS 4
  78 List installed plugins
  79 .RE
  80
  81 .PP
  82 \-plugin available
  83 .RS 4
  84 List available plugins
  85 .RE
  86 .RE
  87
  88 Micro's options can also be set via command line arguments for quick
  89 adjustments. For real configuration, please use the settings.json
  90 file (see 'help options').
  91 .RS 4
  92
  93 .PP
  94 \-option value
  95 .RS 4
  96 Set `option` to `value` for this session
  97 For example: `micro -syntax off file.c`
  98 .RE
  99
 100
 101 .SH CONFIGURATION
 102
 103 Micro uses $MICRO_CONFIG_HOME as the configuration directory.
 104 If this environment variable is not set, it uses $XDG_CONFIG_HOME/micro instead.
 105 If that environment variable is not set, it uses ~/.config/micro as the configuration directory.
 106 In the documentation, we use ~/.config/micro to refer to the configuration directory
 107 (even if it may in fact be somewhere else if you have set either of the above environment variables).
 108
 109 .SH NOTICE
 110 This manpage is intended only to serve as a quick guide to the invocation of
 111 micro and is not intended to replace the full documentation included with micro
 112 which can be accessed from within micro. Micro tells you what key combination to
 113 press to get help in the lower right.
 114
 115 .SH BUGS
 116 A comprehensive list of bugs will not be listed in this manpage. See the Github
 117 page at \fBhttps://github.com/zyedidia/micro/issues\fP for a list of known bugs
 118 and to report any newly encountered bugs you may find. We strive to correct
 119 bugs as swiftly as possible.
 120
 121 .SH COPYRIGHT
 122 Copyright \(co 2017 Zachary Yedidia, Collin Warren, et al.
 123 See /usr/share/doc/micro/LICENSE and /usr/share/doc/micro/AUTHORS for more information.