Skip to content

Commit 20ebca9

Browse files
committed
Update man page
Align it with `micro -help`.
1 parent f735ff0 commit 20ebca9

File tree

2 files changed

+35
-9
lines changed

2 files changed

+35
-9
lines changed

assets/packaging/micro.1

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
.TH micro 1 "2020-02-10"
1+
.TH micro 1 "2025-08-16"
22
.SH NAME
33
micro \- A modern and intuitive terminal-based text editor
44
.SH SYNOPSIS
55
.B micro
6-
.RB [OPTIONS]
7-
[FILE]\&...
6+
.RB [OPTION]...\&
7+
.RB [FILE]...\&
8+
.RB [+LINE[:COL]]
9+
.br
10+
.B micro
11+
.RB [OPTION]...\&
12+
.RB [FILE[:LINE[:COL]]]...\&
13+
\& (only if the `parsecursor` option is enabled)
814

915
.SH DESCRIPTION
1016

@@ -20,7 +26,7 @@ Use Ctrl-q to quit, Ctrl-s to save, and Ctrl-g to open the in-editor help menu.
2026
.PP
2127
\-clean
2228
.RS 4
23-
Cleans the configuration directory
29+
Clean the configuration directory and exit
2430
.RE
2531

2632
.PP
@@ -30,15 +36,17 @@ Specify a custom location for the configuration directory
3036
.RE
3137

3238
.PP
33-
[FILE]:LINE:COL
39+
FILE:LINE[:COL] (only if the `parsecursor` option is enabled)
40+
.br
41+
FILE +LINE[:COL]
3442
.RS 4
3543
Specify a line and column to start the cursor at when opening a buffer
3644
.RE
3745

3846
.PP
3947
\-options
4048
.RS 4
41-
Show all option help
49+
Show all options help and exit
4250
.RE
4351

4452
.PP
@@ -47,15 +55,27 @@ Show all option help
4755
Enable debug mode (enables logging to ./log.txt)
4856
.RE
4957

58+
.PP
59+
\-profile
60+
.RS 4
61+
Enable CPU profiling (writes profile info to ./micro.prof so it can be analyzed later with "go tool pprof micro.prof")
62+
.RE
63+
5064
.PP
5165
\-version
5266
.RS 4
53-
Show the version number and information
67+
Show the version number and information and exit
5468
.RE
5569

5670
Micro's plugins can be managed at the command line with the following commands.
5771
.RS 4
5872

73+
.PP
74+
\-plugin install [PLUGIN]...
75+
.RS 4
76+
Install plugin(s)
77+
.RE
78+
5979
.PP
6080
\-plugin remove [PLUGIN]...
6181
.RS 4
@@ -93,11 +113,16 @@ file (see 'help options').
93113
.RS 4
94114

95115
.PP
96-
\-option value
116+
\-<option> value
97117
.RS 4
98-
Set `option` to `value` for this session
118+
Set `option` to `value` for this session.
119+
.br
99120
For example: `micro -syntax off file.c`
100121
.RE
122+
.RE
123+
124+
.PP
125+
Use `micro -options` to see the full list of configuration options.
101126

102127

103128
.SH CONFIGURATION

cmd/micro/micro.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ var (
4646
)
4747

4848
func InitFlags() {
49+
// Note: keep this in sync with the man page in assets/packaging/micro.1
4950
flag.Usage = func() {
5051
fmt.Println("Usage: micro [OPTION]... [FILE]... [+LINE[:COL]]")
5152
fmt.Println(" micro [OPTION]... [FILE[:LINE[:COL]]]... (only if the `parsecursor` option is enabled)")

0 commit comments

Comments
 (0)