|
NAMEsmi - Simple Markup Interpreter / Filter for simple markupSYNTAXsmi [ -h -n -v ] Input Outputsmi [ -h -n -v ] InFile > OutFile DESCRIPTIONThe smi interpreter, assumes the first argument (Input, or InFile) contains simple markup -- Markdown, for example.smi will return that Input, or InFile in HTML format. Output, if not specified, will be to STDOUT. Which can be piped to something, or redirected, as desired. If Input is formatted in HTML markup, smi will return the meta-characters as their entities -- nice, if you'd like to display Markup in HTML <code> blocks. Given this fact, one might also consider smi a Filter, as well. Possible use cases, are quite broad, and can't possibly be fully deacribed here. OPTIONS
FILESIf no Outfile is given, Output is sent to standard output. The Input, and Output are processed strictly serially; consequently smi may be used in pipe-lines.EXAMPLESCreate a web page, from one written in Markdown:smi Markdown.txt > Markdown.html Take the HTML file generated above, and make the output suitable for displaying within a <code> block on your web pages: smi -n Maekdown.html > Markdown.code BUGSStrictly speaking, Markdown syntax still needs better interpretation. The only thing missing in this area, is handling of <cite>.Other than that; I am aware of no bugs. <cite>, and better documentation will be addressed in the next version. AUTHORSChris Hutchinson <portmaster@bsdforge.com>Enno boland <g@s01.de> SEE ALSOpipe(2)
Visit the GSP FreeBSD Man Page Interface. |