binman - manpages from header comments

binman generates manual pages from header comments in your scripts so that you can keep your documentation and implementation together, in the same file, for easy maintenance. But keeping them apart, in separate files, is supported too.

Features

Direct support for any scripting language that has multi-line comments or uses # for single-line comments such as Ruby, Perl, PHP, Python, R, Tcl, Node.js, Elixir, make, AWK, sed, UNIX shells, Windows PowerShell and more!
Individual commands for manual page extraction, conversion, and display.
Accessible from the command line and also as a library in [Ruby] scripts.
Implemented in roughly 165 statement lines (SLOC) of pure [Ruby] code! :-)

Examples

Here are some examples of HTML manual page sets generated by binman-rake(1):

For examples of input and output files, see "From the command line" below.

Installation

Requirements

Ruby 1.8.7 or newer

For users

If you only want to view pre-built manual pages:

gem install binman

If you also want to build your own manual pages:

gem install md2man -v '~> 5.1'

For developers

git clone https://github.com/sunaku/binman
cd binman
bundle install
bundle exec rake --tasks       # packaging tasks
bundle exec binman-text --help # run it directly
bundle exec binman-roff --help # run it directly
bundle exec binman-html --help # run it directly
bundle exec binman-show --help # run it directly
bundle exec binman-help --help # run it directly
bundle exec binman-rake --help # run it directly

Usage

First, write md2man(5) text for your script: either in a comment at the top of your script file, described as "Embedded manpage sources" in binman-text(1), or in a separate Markdown file located at man/man?/*.?.{markdown,mkd,md}.

For real examples of what to write, see "From the command line" below.
For the detailed syntax and semantics of what to write, see md2man(5).

Next, you have two ways of generating manual pages from what you've written:

Generate manual pages at "compile time" and ship them with your scripts.
Generate manual pages at "run time" so that your scripts are standalone.

At compile time

Run binman-rake(1) to generate manual pages for all of your ./bin/* scripts.

Alternatively, to have more control over the generation of your manual pages:

Run binman-text(1) to extract manual page text from a specified script.
Run binman-roff(1) to generate a UNIX manual page from a specified script.
Run binman-html(1) to generate a HTML manual page from a specified script.

From the command line

Below are some real examples of generating manual pages from the command line. Note that binman-rake(1) abstracts away all of the complexity you see below!

dasht(1):

binman-text dasht > dasht.1.markdown
binman-roff dasht > dasht.1
binman-html dasht > dasht.1.html

dasht-docsets(1):

binman-text dasht-docsets > dasht-docsets.1.markdown
binman-roff dasht-docsets > dasht-docsets.1
binman-html dasht-docsets > dasht-docsets.1.html

dasht-docsets-install(1):

binman-text dasht-docsets-install > dasht-docsets-install.1.markdown
binman-roff dasht-docsets-install > dasht-docsets-install.1
binman-html dasht-docsets-install > dasht-docsets-install.1.html

dasht-docsets-remove(1):

binman-text dasht-docsets-remove > dasht-docsets-remove.1.markdown
binman-roff dasht-docsets-remove > dasht-docsets-remove.1
binman-html dasht-docsets-remove > dasht-docsets-remove.1.html

dasht-docsets-update(1):

binman-text dasht-docsets-update > dasht-docsets-update.1.markdown
binman-roff dasht-docsets-update > dasht-docsets-update.1
binman-html dasht-docsets-update > dasht-docsets-update.1.html

dasht-query-exec(1):

binman-text dasht-query-exec > dasht-query-exec.1.markdown
binman-roff dasht-query-exec > dasht-query-exec.1
binman-html dasht-query-exec > dasht-query-exec.1.html

dasht-query-html(1):

binman-text dasht-query-html > dasht-query-html.1.markdown
binman-roff dasht-query-html > dasht-query-html.1
binman-html dasht-query-html > dasht-query-html.1.html

dasht-query-line(1):

binman-text dasht-query-line > dasht-query-line.1.markdown
binman-roff dasht-query-line > dasht-query-line.1
binman-html dasht-query-line > dasht-query-line.1.html

dasht-server(1):

binman-text dasht-server > dasht-server.1.markdown
binman-roff dasht-server > dasht-server.1
binman-html dasht-server > dasht-server.1.html

dasht-server-http(1):

binman-text dasht-server-http > dasht-server-http.1.markdown
binman-roff dasht-server-http > dasht-server-http.1
binman-html dasht-server-http > dasht-server-http.1.html

tork(1):

binman-text tork > tork.1.markdown
binman-roff tork > tork.1
binman-html tork > tork.1.html

tork-runner(1):

binman-text tork-runner > tork-runner.1.markdown
binman-roff tork-runner > tork-runner.1
binman-html tork-runner > tork-runner.1.html

tork-herald(1):

binman-text tork-herald > tork-herald.1.markdown
binman-roff tork-herald > tork-herald.1
binman-html tork-herald > tork-herald.1.html

tork-driver(1):

binman-text tork-driver > tork-driver.1.markdown
binman-roff tork-driver > tork-driver.1
binman-html tork-driver > tork-driver.1.html

tork-engine(1):

binman-text tork-engine > tork-engine.1.markdown
binman-roff tork-engine > tork-engine.1
binman-html tork-engine > tork-engine.1.html

tork-master(1):

binman-text tork-master > tork-master.1.markdown
binman-roff tork-master > tork-master.1
binman-html tork-master > tork-master.1.html

tork-remote(1):

binman-text tork-remote > tork-remote.1.markdown
binman-roff tork-remote > tork-remote.1
binman-html tork-remote > tork-remote.1.html

tork-notify(1):

binman-text tork-notify > tork-notify.1.markdown
binman-roff tork-notify > tork-notify.1
binman-html tork-notify > tork-notify.1.html

binman(1):

binman-text binman > binman.1.markdown
binman-roff binman > binman.1
binman-html binman > binman.1.html

binman-text(1):

binman-text binman-text > binman-text.1.markdown
binman-roff binman-text > binman-text.1
binman-html binman-text > binman-text.1.html

binman-roff(1):

binman-text binman-roff > binman-roff.1.markdown
binman-roff binman-roff > binman-roff.1
binman-html binman-roff > binman-roff.1.html

binman-html(1):

binman-text binman-html > binman-html.1.markdown
binman-roff binman-html > binman-html.1
binman-html binman-html > binman-html.1.html

binman-show(1):

binman-text binman-show > binman-show.1.markdown
binman-roff binman-show > binman-show.1
binman-html binman-show > binman-show.1.html

binman-help(1):

binman-text binman-help > binman-help.1.markdown
binman-roff binman-help > binman-help.1
binman-html binman-help > binman-help.1.html

binman-rake(1):

binman-text binman-rake > binman-rake.1.markdown
binman-roff binman-rake > binman-rake.1
binman-html binman-rake > binman-rake.1.html

md2man-roff(1):

binman-text md2man-roff > md2man-roff.1.markdown
binman-roff md2man-roff > md2man-roff.1
binman-html md2man-roff > md2man-roff.1.html

md2man-html(1):

binman-text md2man-html > md2man-html.1.markdown
binman-roff md2man-html > md2man-html.1
binman-html md2man-html > md2man-html.1.html

md2man-rake(1):

binman-text md2man-rake > md2man-rake.1.markdown
binman-roff md2man-rake > md2man-rake.1
binman-html md2man-rake > md2man-rake.1.html

For a Ruby package

Add this snippet to your gemspec file:

s.files += Dir['man/man?/*.?']         # UNIX manpages
s.files += Dir['man/**/*.{html,css}']  # HTML webpages
s.add_development_dependency 'md2man', '~> 5.1'

Add the following line to your Rakefile:

require 'binman/rakefile'

You now have a rake binman task that pre-builds UNIX manual page files for your bin/ scripts into a man/ directory so that your end-users do not need md2man installed in order to view the manual pages you've embedded therein! There are also sub-tasks to build manual pages individually as roff or HTML.

If you're using Bundler, this task also hooks into its gem packaging tasks and ensures that your UNIX manual pages are pre-built and packaged into your gem:

bundle exec rake build
gem spec pkg/*.gem | fgrep man/man

At run time

Run binman-show(1) to display the manual page (which may have been pre-generated at "compile time") for a specified script.

Alternatively, an easy way to add support for -h and --help options in a specified script is to run binman-help(1) with its file path and command line arguments. This displays its manual page (which may have been pre-generated at "compile time") only when those help options are found in its arguments.

From a shell script

#!/usr/bin/sh
# your program's manual page goes here

# OPTION 1: show manual and exit if ARGV has -h or --help except after --
binman-help "$0" "$@" && exit

# OPTION 2: show manual unconditionally
binman-show "$0"

From a Ruby script

#!/usr/bin/env ruby
# your program's manual page goes here

require 'binman'

# OPTION 1: show manual and exit if ARGV has -h or --help except after --
BinMan.help

# OPTION 2: show manual unconditionally
BinMan.show

You can also specify your program's source file encoding above the manual:

#!/usr/bin/env ruby
# -*- coding: utf-8 -*-
# your program's manual page goes here

You can also write the manual as a multi-line Ruby comment:

#!/usr/bin/env ruby
=begin
your program's manual page goes here
=end

You can also specify your program's source file encoding above the manual:

#!/usr/bin/env ruby
# -*- coding: utf-8 -*-
=begin
your program's manual page goes here
=end

See the API documentation for even more possibilities!

From a Perl script

#!/usr/bin/env perl
# your program's manual page goes here

# OPTION 1: show manual and exit if ARGV has -h or --help except after --
system('binman-help', __FILE__, @ARGV) == 0 and exit;

# OPTION 2: show manual unconditionally
system('binman-show', __FILE__);

You can also write the manual as a multi-line Ruby comment after __END__:

#!/usr/bin/env perl
print "your program's code goes here";
__END__
=begin
your program's manual page goes here
=end

From a Python script

#!/usr/bin/env python
# your program's manual page goes here

import sys, subprocess

# OPTION 1: show manual and exit if ARGV has -h or --help except after --
subprocess.call(['binman-help', __file__] + sys.argv) == 0 and sys.exit()

# OPTION 2: show manual unconditionally
subprocess.call(['binman-show', __file__])

You can also specify your program's source file encoding above the manual:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# your program's manual page goes here

You can also write the manual as a multi-line Ruby comment inside a docstring:

#!/usr/bin/env python
"""
=begin
your program's manual page goes here
=end
"""

You can also specify your program's source file encoding above the manual:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
=begin
your program's manual page goes here
=end
"""

From an AWK script

The technique for determining current AWK script file name comes from here.

#!/usr/bin/awk -f
# your program's manual page goes here

# OPTION 1: show manual and exit if ARGV has -h or --help except after --
BEGIN {getline c <"/proc/self/cmdline"; sub(".*-f\0"," ",c); gsub("\0"," ",c);
       if(system("binman-help" c) == 0){ exit }}

# OPTION 2: show manual unconditionally
BEGIN {getline c <"/proc/self/cmdline"; sub(".*-f\0"," ",c); sub("\0.*","",c);
       system("binman-show" c)}

From a Tcl script

#!/usr/bin/env tclsh
# your program's manual page goes here

# OPTION 1: show manual and exit if ARGV has -h or --help except after --
if {![catch {exec -- >/dev/tty binman-help $argv0 {*}$argv}]} {exit}

# OPTION 2: show manual unconditionally
exec >/dev/tty binman-show $argv0

You can also write the manual as a multi-line Ruby comment inside an if 0:

#!/usr/bin/env tclsh
if 0 {
=begin
your program's manual page goes here
=end
}

From a Node.js script

/*
=begin
your program's manual page goes here
=end
*/

var exec = require('child_process').exec;

// OPTION 1: show manual and exit if ARGV has -h or --help except after --
exec(['>/dev/tty', 'binman-help', __filename].concat(process.argv).
join(' '), function(error){ if (error === null){ process.exit(); } });

// OPTION 2: show manual unconditionally
exec(['>/dev/tty', 'binman-show', __filename].join(' '));

License

Like my work? 👍 Please spare a life today as thanks! :cow::pig::chicken::fish::speak_no_evil::v::revolving_hearts:

Released under the ISC license. See the LICENSE file for details.

Comment out md in the binman example and remove =begin and =end to fix ruby coloring

This example works without any changes to your code and plays better with coloring.
Thanks for binman!

#!/usr/bin/env ruby
# # BINMAN 1 2013-05-08 3.3.0
# 
# ## NAME
# 
# binman - man pages for bin scripts
# 
# ## SYNOPSIS
# 
# `binman` [*OPTION*]... *COMMAND*
# 
# ## DESCRIPTION
# 
# [binman] produces UNIX manual pages for your executable scripts. It can
# extract their leading comment headers (defined below), convert them from
# markdown(7) into roff(7) using [md2man], and display them using man(1).
# 
# ### Leading comment headers
# 
# A leading comment header can be one of the following two things:
# 
#1.  A contiguous sequence of single-line comments (which begin with `#`
#     and optionally continue with a single space followed by any number of
#     characters until the end of the line) starting at the beginning of the
#     file (after shebang and encoding comments plus optional blank lines) and
#     ending at the first single blank line.
# 
#2.  The first embedded document delimited by `=begin` and `=end` lines, which
#     begin with the respective delimiters and optionally continue with a single
#     space followed by any number of characters until the end of the line.
# 
# ### Markdown processing divergence
# 
# Although your leading comment headers are written in markdown(7), `binman
# conv` inherits the following additions to markdown(7) syntax from [md2man]:
# 
#   * There can be at most one top-level heading (H1).  It is emitted as `.TH`
#     in the roff(7) output to define the UNIX manual page's header and footer.
# 
#   * Paragraphs whose lines are all uniformly indented by two spaces are
#     considered to be "indented paragraphs".  They are unindented accordingly
#     before emission as `.IP` in the roff(7) output.
# 
#   * Paragraphs whose subsequent lines (all except the first) are uniformly
#     indented by two spaces are considered to be a "tagged paragraphs".  They
#     are unindented accordingly before emission as `.TP` in the roff(7) output.
# 
# ### Markdown processing extensions
# 
# The following [Redcarpet] extensions are enabled while processing markdown(7):
# 
#   * tables
#   * autolink
#   * superscript
#   * strikethrough
#   * no\_intra\_emphasis
#   * fenced\_code\_blocks
# 
# ## OPTIONS
# 
# `-h`, `--help`
#   Show this help manual.
# 
# ## COMMANDS
# 
# `help` *FILE* [*ARGUMENT*]...
#   If the given *ARGUMENT* sequence contains `-h` or `--help` except after
#   `--`, then this program extracts the given *FILE*'s leading comment header,
#   converts it into roff(7), and displays it using man(1) before exiting with
#   status code `0`.  Otherwise, this program exits with status code `111`.
# 
# `show` [*FILE*]
#   Use man(1) to display the roff(7) conversion of the leading comment header
#   extracted from the given *FILE* or STDIN.
# 
# `load` [*FILE*]
#   Print the leading comment header extracted from the given *FILE* or STDIN.
# 
# `dump` [*FILE*]
#   Print the roff(7) conversion of the leading comment header extracted from
#   the given *FILE* or STDIN.
# 
# `conv` [*FILE*]
#   Print the roff(7) conversion of the markdown(7) document read from the given
#   *FILE* or STDIN.
# 
# ## SEE ALSO
# 
# man(1), roff(7), markdown(7)
# 
# [binman]: https://github.com/sunaku/binman
# [md2man]: https://github.com/sunaku/md2man
# [Redcarpet]: https://github.com/vmg/redcarpet

require 'binman'

command, source = ARGV

if command == 'help'
  BinMan.help source, ARGV[2..-1]
  exit 111
else
  BinMan.help
  source ||= STDIN
  case command
  when 'show'
    BinMan.send(command, source)
  when 'load', 'dump', 'conv'
    puts BinMan.send(command, source)
  else
    warn 'binman: invalid command; try --help'
    exit 1
  end
end

sunaku / binman Goto Github PK

binman's Introduction

binman - manpages from header comments

Features

Examples

Installation

Requirements

For users

For developers

Usage

At compile time

From the command line

For a Ruby package

At run time

From a shell script

From a Ruby script

From a Perl script

From a Python script

From an AWK script

From a Tcl script

From a Node.js script

License

binman's People

Contributors

Stargazers

Watchers

Forkers

binman's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs