go-md2man(1)

πŸ“¦
version 2.0.7 Β· 4 versions
, in alpine 3.24, arch rolling, fedora 43, fedora 44, ubuntu stonking

πŸ’– go-md2man(1) πŸ’–

okay bestie, welcome to the User Manual for go-md2man β€” the little markdown-to-manpage converter that literally just works, no cap ✨


🌸 NAME 🌸

go-md2man β€” turns markdown files into manpages, slay πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

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

✨ DESCRIPTION ✨

so here's the vibe: go-md2man takes your standard markdown formatted documents and converts them into manpages. it's giving glow-up but for text files πŸ’–

and the best part? it's written purely in Go, specifically so it can reduce dependencies on 3rd party libs. minimal, clean, iconic, no baggage. we love a low-dependency queen πŸ‘‘

by default, the input is stdin and the output is stdout. so if you just pipe stuff in, it'll pipe stuff right back out. easy peasy πŸ“


πŸŽ€ OPTIONS πŸŽ€

  • -in=file β€” the path to the markdown file that's gonna get processed. defaults to stdin, so if you don't say anything it just reads whatever you feed it 🫢
  • -out=file β€” the path to the output file where the processed stuff goes. defaults to stdout, meaning it'll just print right at you πŸ’…

🌈 EXAMPLES 🌈

converting go-md2man.1.md into a manpage, the classic way:

go-md2man < go-md2man.1.md > go-md2man.1

same thing but using command line arguments instead of shell redirection:

go-md2man -in=go-md2man.1.md -out=go-md2man.1

both valid, both cute, pick your fighter πŸ’–


πŸ‘‘ HISTORY πŸ‘‘

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


okay that's the whole page bestie, go forth and convert your markdown, you got this πŸ§šπŸ’œ

and that's a wrap on go-md2man, straight from the January 2015 archives β€” mwah, periodt πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from