man-cheatsheet/README.md
2024-08-17 17:30:02 +10:00

16 lines
649 B
Markdown

# Personal man page
This repo is for my personal man page. It uses `pandoc` to process markdown into a manpage. See https://gabmus.org/posts/man_pages_with_markdown_and_pandoc
1. create a markdown file for the manpage. We save it in section 7: _Miscellaneous Information Manual_, so it needs to be named `[name].7.md`.
2. create a file in man page format using pandoc:
```sh
pandoc --standalone -t man cheatsheet.7.md -o cheatsheet.7
```
3. Then symlink to the appropriate man file directory:
```sh
ln -s /Users/hugh/coding/man/cheatsheet.7 /usr/local/share/man/man7/
```
Now you can run `man cheatsheet` and see your man page!