Skip to content

Commit 2b5eb3e

Browse files
committed
man page: Improve formatting
Display option names in bold text and argument placeholders in italic text, as recommended in `man man`.
1 parent 20ebca9 commit 2b5eb3e

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

‎assets/packaging/micro.1‎

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
micro \- A modern and intuitive terminal-based text editor
44
.SH SYNOPSIS
55
.B micro
6-
.RB [OPTION]...\&
7-
.RB [FILE]...\&
8-
.RB [+LINE[:COL]]
6+
.RI [ OPTION ]...\&
7+
.RI [ FILE ]...\&
8+
.RI [+ LINE [: COL ]]
99
.br
1010
.B micro
11-
.RB [OPTION]...\&
12-
.RB [FILE[:LINE[:COL]]]...\&
11+
.RI [ OPTION ]...\&
12+
.RI [ FILE [: LINE [: COL ]]]...\&
1313
\& (only if the `parsecursor` option is enabled)
1414

1515
.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.
2424

2525
.SH OPTIONS
2626
.PP
27-
\-clean
27+
.B \-clean
2828
.RS 4
2929
Clean the configuration directory and exit
3030
.RE
3131

3232
.PP
33-
\-config-dir dir
33+
.B \-config-dir
34+
.I dir
3435
.RS 4
3536
Specify a custom location for the configuration directory
3637
.RE
3738

3839
.PP
39-
FILE:LINE[:COL] (only if the `parsecursor` option is enabled)
40+
.IR FILE : LINE [: COL ]
41+
(only if the `parsecursor` option is enabled)
4042
.br
41-
FILE +LINE[:COL]
43+
.IR FILE \ + LINE [: COL ]
4244
.RS 4
4345
Specify a line and column to start the cursor at when opening a buffer
4446
.RE
4547

4648
.PP
47-
\-options
49+
.B \-options
4850
.RS 4
4951
Show all options help and exit
5052
.RE
5153

5254
.PP
53-
\-debug
55+
.B \-debug
5456
.RS 4
5557
Enable debug mode (enables logging to ./log.txt)
5658
.RE
5759

5860
.PP
59-
\-profile
61+
.B \-profile
6062
.RS 4
6163
Enable CPU profiling (writes profile info to ./micro.prof so it can be analyzed later with "go tool pprof micro.prof")
6264
.RE
6365

6466
.PP
65-
\-version
67+
.B \-version
6668
.RS 4
6769
Show the version number and information and exit
6870
.RE
@@ -71,37 +73,41 @@ Micro's plugins can be managed at the command line with the following commands.
7173
.RS 4
7274

7375
.PP
74-
\-plugin install [PLUGIN]...
76+
.B \-plugin install
77+
.RI [ PLUGIN ]...
7578
.RS 4
7679
Install plugin(s)
7780
.RE
7881

7982
.PP
80-
\-plugin remove [PLUGIN]...
83+
.B \-plugin remove
84+
.RI [ PLUGIN ]...
8185
.RS 4
8286
Remove plugin(s)
8387
.RE
8488

8589
.PP
86-
\-plugin update [PLUGIN]...
90+
.B \-plugin update
91+
.RI [ PLUGIN ]...
8792
.RS 4
8893
Update plugin(s) (if no argument is given, updates all plugins)
8994
.RE
9095

9196
.PP
92-
\-plugin search [PLUGIN]...
97+
.B \-plugin search
98+
.RI [ PLUGIN ]...
9399
.RS 4
94100
Search for a plugin
95101
.RE
96102

97103
.PP
98-
\-plugin list
104+
.B \-plugin list
99105
.RS 4
100106
List installed plugins
101107
.RE
102108

103109
.PP
104-
\-plugin available
110+
.B \-plugin available
105111
.RS 4
106112
List available plugins
107113
.RE
@@ -113,7 +119,8 @@ file (see 'help options').
113119
.RS 4
114120

115121
.PP
116-
\-<option> value
122+
.BI \-< option >
123+
.I value
117124
.RS 4
118125
Set `option` to `value` for this session.
119126
.br

0 commit comments

Comments
 (0)