Skip to content

Commit b44280b

Browse files
committed
update readme and add man page
1 parent b509b20 commit b44280b

File tree

3 files changed

+46
-2
lines changed

3 files changed

+46
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ bar chart.
1212

1313
## Installation
1414

15+
### Arch Linux
16+
17+
frei is available on the [AUR](https://aur.archlinux.org/packages/frei).
18+
1519
### Pre-compiled binaries
1620

1721
Binaries for `i386`, `amd64` and `arm` are available on the [releases
@@ -31,7 +35,7 @@ go build .
3135

3236
| option | description |
3337
|------------|---------------------------------------------|
34-
| `--help` | show list of options |
38+
| `-help` | show list of options |
3539
| `-h` | human-readable numbers (implies `-numbers`) |
3640
| `-key` | display color key |
3741
| `-numbers` | print numbers in addition to the chart |

frei.1

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.TH "frei" "1"
2+
3+
.SH "NAME"
4+
.PP
5+
frei - modern replacement for the 'free' command-line utility
6+
7+
.SH "SYNOPSIS"
8+
.PP
9+
frei [OPTIONS...]
10+
11+
.SH "OPTIONS"
12+
13+
.SS "-h"
14+
.PP
15+
Display human-readable numbers (implies `-numbers`)
16+
17+
.SS "-help"
18+
.PP
19+
Print help message and exit
20+
21+
.SS "-key"
22+
.PP
23+
Display color key
24+
25+
.SS "-numbers"
26+
.PP
27+
Print numbers in addition to the chart
28+
29+
.SS "-version"
30+
.PP
31+
Display version and exit
32+
33+
.SH "DESCRIPTION"
34+
.PP
35+
frei is a modern replacement for the 'free' command-line utility which gives information about memory usage by drawing a colorful chart instead of displaying just the numbers
36+
37+
.SH "AUTHOR"
38+
.PP
39+
alexcoder04 <alexcoder04@protonmail.com>
40+

main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ func main() {
127127
if Version == "" {
128128
fmt.Print("frei [built from source]")
129129
} else {
130-
fmt.Print("frei v" + Version)
130+
fmt.Print("frei " + Version)
131131
}
132132
if CommitSHA != "" {
133133
fmt.Print(" (commit " + CommitSHA + ")")

0 commit comments

Comments
 (0)