Skip to content

Commit

Permalink
go-md2man.1.md: more formatting
Browse files Browse the repository at this point in the history
1. Use some standard formatting rules, such as
 - literals are bold;
 - variables are italic;
 - file names are italic (even when literal);
 - use ``` for code blocks.

2. Add an example with shell redirection.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
  • Loading branch information
kolyshkin committed Apr 18, 2023
1 parent 7e94ef1 commit 6aaabf8
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions go-md2man.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,24 @@ go-md2man 1 "January 2015" go-md2man "User Manual"
go-md2man - Convert markdown files into manpages

# SYNOPSIS
go-md2man -in=[/path/to/md/file] -out=[/path/to/output]
**go-md2man** [**-in**=*/path/to/md/file*] [**-out**=*/path/to/output*]

# DESCRIPTION
go-md2man converts standard markdown formatted documents into manpages. It is
**go-md2man** converts standard markdown formatted documents into manpages. It is
written purely in Go so as to reduce dependencies on 3rd party libs.

By default, the input is stdin and the output is stdout.

# EXAMPLES
Convert the markdown file "go-md2man.1.md" into a manpage:
Convert the markdown file *go-md2man.1.md* into a manpage:
```
go-md2man < go-md2man.1.md > go-md2man.1
```

Same, but using command line arguments instead of shell redirection:
```
go-md2man -in=go-md2man.1.md -out=go-md2man.1
```

# HISTORY
January 2015, Originally compiled by Brian Goff( cpuguy83@gmail.com )
January 2015, Originally compiled by Brian Goff (cpuguy83@gmail.com).

0 comments on commit 6aaabf8

Please sign in to comment.