mirror of
https://github.com/zyedidia/micro.git
synced 2026-02-04 22:20:20 +09:00
man page: Improve formatting
Display option names in bold text and argument placeholders in italic text, as recommended in `man man`.
This commit is contained in:
@@ -3,13 +3,13 @@
|
||||
micro \- A modern and intuitive terminal-based text editor
|
||||
.SH SYNOPSIS
|
||||
.B micro
|
||||
.RB [OPTION]...\&
|
||||
.RB [FILE]...\&
|
||||
.RB [+LINE[:COL]]
|
||||
.RI [ OPTION ]...\&
|
||||
.RI [ FILE ]...\&
|
||||
.RI [+ LINE [: COL ]]
|
||||
.br
|
||||
.B micro
|
||||
.RB [OPTION]...\&
|
||||
.RB [FILE[:LINE[:COL]]]...\&
|
||||
.RI [ OPTION ]...\&
|
||||
.RI [ FILE [: LINE [: COL ]]]...\&
|
||||
\& (only if the `parsecursor` option is enabled)
|
||||
|
||||
.SH DESCRIPTION
|
||||
@@ -24,45 +24,47 @@ Use Ctrl-q to quit, Ctrl-s to save, and Ctrl-g to open the in-editor help menu.
|
||||
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
\-clean
|
||||
.B \-clean
|
||||
.RS 4
|
||||
Clean the configuration directory and exit
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-config-dir dir
|
||||
.B \-config-dir
|
||||
.I dir
|
||||
.RS 4
|
||||
Specify a custom location for the configuration directory
|
||||
.RE
|
||||
|
||||
.PP
|
||||
FILE:LINE[:COL] (only if the `parsecursor` option is enabled)
|
||||
.IR FILE : LINE [: COL ]
|
||||
(only if the `parsecursor` option is enabled)
|
||||
.br
|
||||
FILE +LINE[:COL]
|
||||
.IR FILE \ + LINE [: COL ]
|
||||
.RS 4
|
||||
Specify a line and column to start the cursor at when opening a buffer
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-options
|
||||
.B \-options
|
||||
.RS 4
|
||||
Show all options help and exit
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-debug
|
||||
.B \-debug
|
||||
.RS 4
|
||||
Enable debug mode (enables logging to ./log.txt)
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-profile
|
||||
.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
|
||||
\-version
|
||||
.B \-version
|
||||
.RS 4
|
||||
Show the version number and information and exit
|
||||
.RE
|
||||
@@ -71,37 +73,41 @@ Micro's plugins can be managed at the command line with the following commands.
|
||||
.RS 4
|
||||
|
||||
.PP
|
||||
\-plugin install [PLUGIN]...
|
||||
.B \-plugin install
|
||||
.RI [ PLUGIN ]...
|
||||
.RS 4
|
||||
Install plugin(s)
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-plugin remove [PLUGIN]...
|
||||
.B \-plugin remove
|
||||
.RI [ PLUGIN ]...
|
||||
.RS 4
|
||||
Remove plugin(s)
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-plugin update [PLUGIN]...
|
||||
.B \-plugin update
|
||||
.RI [ PLUGIN ]...
|
||||
.RS 4
|
||||
Update plugin(s) (if no argument is given, updates all plugins)
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-plugin search [PLUGIN]...
|
||||
.B \-plugin search
|
||||
.RI [ PLUGIN ]...
|
||||
.RS 4
|
||||
Search for a plugin
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-plugin list
|
||||
.B \-plugin list
|
||||
.RS 4
|
||||
List installed plugins
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\-plugin available
|
||||
.B \-plugin available
|
||||
.RS 4
|
||||
List available plugins
|
||||
.RE
|
||||
@@ -113,7 +119,8 @@ file (see 'help options').
|
||||
.RS 4
|
||||
|
||||
.PP
|
||||
\-<option> value
|
||||
.BI \-< option >
|
||||
.I value
|
||||
.RS 4
|
||||
Set `option` to `value` for this session.
|
||||
.br
|
||||
|
||||
Reference in New Issue
Block a user