Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

add example input file from Linux Man Page Howto

  • Loading branch information...
commit 5d7df2e45c4f9bae978210c914dc1779b2e810c4 1 parent 3f7cbce
@sunaku sunaku authored
Showing with 94 additions and 0 deletions.
  1. +83 −0 EXAMPLE.markdown
  2. +11 −0 README.markdown
View
83 EXAMPLE.markdown
@@ -0,0 +1,83 @@
+FOO 1 "MARCH 1995" Linux "User Manuals"
+=======================================
+
+NAME
+----
+
+foo - frobnicate the bar library
+
+SYNOPSIS
+--------
+
+`foo` [`-bar`] [`-c` *config-file* ] *file* ...
+
+DESCRIPTION
+-----------
+
+`foo` frobnicates the bar library by tweaking internal symbol tables. By
+default it parses all baz segments and rearranges them in reverse order by
+time for the xyzzy(1) linker to find them. The symdef entry is then compressed
+using the WBG (Whiz-Bang-Gizmo) algorithm. All files are processed in the
+order specified.
+
+OPTIONS
+-------
+
+`-b`
+ Do not write "busy" to stdout while processing.
+
+`-c` *config-file*
+ Use the alternate system wide *config-file* instead of */etc/foo.conf*. This
+ overrides any `FOOCONF` environment variable.
+
+`-a`
+ In addition to the baz segments, also parse the blurfl headers.
+
+`-r`
+ Recursive mode. Operates as fast as lightning at the expense of a megabyte
+ of virtual memory.
+
+FILES
+-----
+
+*/etc/foo.conf*
+ The system wide configuration file. See foo(5) for further details.
+
+*~/.foorc*
+ Per user configuration file. See foo(5) for further details.
+
+ENVIRONMENT
+-----------
+
+`FOOCONF`
+ If non-null the full pathname for an alternate system wide */etc/foo.conf*.
+ Overridden by the `-c` option.
+
+DIAGNOSTICS
+-----------
+
+The following diagnostics may be issued on stderr:
+
+**Bad magic number.**
+ The input file does not look like an archive file.
+
+**Old style baz segments.**
+ `foo` can only handle new style baz segments. COBOL object libraries are not
+ supported in this version.
+
+BUGS
+----
+
+The command name should have been chosen more carefully to reflect its
+purpose.
+
+AUTHOR
+------
+
+Jens Schweikhardt <howto@schweikhardt.net>
+
+SEE ALSO
+--------
+
+bar(1), foo(5), xyzzy(1), [Linux Man Page Howto](
+http://www.schweikhardt.net/man_page_howto.html)
View
11 README.markdown
@@ -7,6 +7,17 @@ documents into UNIX man pages (really [Roff] documents) using [Redcarpet2].
[Roff]: http://troff.org
[Markdown]: http://daringfireball.net/projects/markdown/
[Redcarpet2]: https://github.com/tanoku/redcarpet
+[example]: https://raw.github.com/sunaku/md2man/master/EXAMPLE.markdown
+
+------------------------------------------------------------------------------
+Demonstration
+------------------------------------------------------------------------------
+
+Try converting [this example Markdown file][example] into a UNIX man page:
+
+ md2man EXAMPLE.markdown | man -l -
+
+![Obligatory screenshot of md2man(1) in action!](http://ompldr.org/vYnFvbw)
------------------------------------------------------------------------------
Installation
Please sign in to comment.
Something went wrong with that request. Please try again.