refactor bin/marked and man page.

Author: chjj

bin/marked

@@ -2,7 +2,7 @@
 
 /**
  * Marked CLI
- * Copyright (c) 2011-2012, Christopher Jeffrey (MIT License)
+ * Copyright (c) 2011-2013, Christopher Jeffrey (MIT License)
  */
 
 var fs = require('fs')
@@ -13,7 +13,7 @@ var fs = require('fs')
  * Man Page
  */
 
-var help = function() {
+function help() {
   var spawn = require('child_process').spawn;
 
   var options = {
@@ -26,29 +26,28 @@ var help = function() {
   spawn('man',
     [__dirname + '/../man/marked.1'],
     options);
-};
+}
 
 /**
  * Main
  */
 
-var main = function(argv) {
+function main(argv) {
   var files = []
     , options = {}
-    , data = ''
     , input
     , output
     , arg
     , tokens;
 
-  var getarg = function() {
+  function getarg() {
     var arg = argv.shift();
     arg = arg.split('=');
     if (arg.length > 1) {
       argv.unshift(arg.slice(1).join('='));
     }
     return arg[0];
-  };
+  }
 
   while (argv.length) {
     arg = getarg();
@@ -65,65 +64,67 @@ var main = function(argv) {
       case '--tokens':
         tokens = true;
         break;
-      case '--gfm':
-        options.gfm = true;
-        break;
-      case '--tables':
-        options.tables = true;
-        break;
-      case '--breaks':
-        options.breaks = true;
-        break;
-      case '--sanitize':
-        options.sanitize = true;
-        break;
-      case '--pedantic':
-        options.pedantic = true;
-        break;
       case '-h':
       case '--help':
         return help();
       default:
-        files.push(arg);
+        if (arg.indexOf('--') === 0) {
+          arg = arg.substring(2);
+          if (arg.indexOf('no-') === 0) {
+            arg = arg.substring(3);
+            options[arg] = false;
+          } else {
+            options[arg] = true;
+          }
+        } else {
+          files.push(arg);
+        }
         break;
     }
   }
 
-  if (!input) {
-    if (files.length <= 2) {
-      var stdin = process.stdin;
+  function getData(callback) {
+    var data = '';
 
-      stdin.setEncoding('utf8');
-      stdin.resume();
+    if (!input) {
+      if (files.length <= 2) {
+        var stdin = process.stdin;
 
-      stdin.on('data', function(text) {
-        data += text;
-      });
+        stdin.setEncoding('utf8');
+        stdin.resume();
 
-      stdin.on('end', write);
+        stdin.on('data', function(text) {
+          data += text;
+        });
 
-      return;
+        stdin.on('error', function(err) {
+          return callback(err);
+        });
+
+        stdin.on('end', function() {
+          return callback(null, data);
+        });
+
+        return;
+      }
+      input = files.pop();
     }
-    input = files.pop();
-  }
 
-  data = fs.readFileSync(input, 'utf8');
-  write();
+    return fs.readFile(input, 'utf8', callback);
+  }
 
-  function write() {
-    marked.setOptions(options);
+  return getData(function(err, data) {
+    if (err) throw err;
 
     data = tokens
-      ? JSON.stringify(marked.lexer(data), null, 2)
-      : marked(data);
+      ? JSON.stringify(marked.lexer(data, options), null, 2)
+      : marked(data, options);
 
-    if (!output) {
-      process.stdout.write(data + '\n');
-    } else {
-      fs.writeFileSync(output, data);
-    }
-  }
-};
+    return !output
+      ? process.stdout.write(data + '\n')
+      : fs.writeFileSync(output, data);
+  });
+}
 
 if (!module.parent) {
   process.title = 'marked';

man/marked.1

@@ -1,15 +1,31 @@
 .ds q \N'34'
 .TH marked 1
+
 .SH NAME
 marked \- a javascript markdown parser
+
 .SH SYNOPSIS
-.nf
-.B marked [\-o output] [\-i input] [\-th]
-.fi
+.B marked
+[\-o output] [\-i input] [\-\-help]
+[\-\-tokens] [\-\-pedantic] [\-\-gfm]
+[\-\-breaks] [\-\-tables] [\-\-sanitize]
+[\-\-silent] [input]
+
 .SH DESCRIPTION
 .B marked
 is a full-featured javascript markdown parser, built for speed. It also includes
 multiple GFM features.
+
+.SH EXAMPLES
+.TP
+cat in.md | marked > out.html
+.TP
+echo "hello *world*" | marked
+.TP
+marked -o out.html in.md --gfm
+.TP
+marked --output="hello world.html" -i in.md --no-breaks
+
 .SH OPTIONS
 .TP
 .BI \-o,\ \-\-output\ [output]
@@ -29,21 +45,36 @@ markdown bugs.
 .BI \-\-gfm
 Enable github flavored markdown.
 .TP
-.BI \-\-sanitize
-Sanitize output. Ignore any HTML input.
+.BI \-\-breaks
+Enable GFM line breaks. Only works with the gfm option.
 .TP
-.BI \-h,\ \-\-help
-Display help information.
-.SH EXAMPLES
+.BI \-\-tables
+Enable GFM tables. Only works with the gfm option.
 .TP
-cat in.md | marked > out.html
+.BI \-\-sanitize
+Sanitize output. Ignore any HTML input.
 .TP
-echo "hello *world*" | marked
+.BI \-\-no\-sanitize,\ \-no-etc...
+The inverse of any of the marked options above.
 .TP
-marked -o out.html in.md
+.BI \-\-silent
+Silence error output.
 .TP
-marked --output="hello world.html" -i in.md
+.BI \-h,\ \-\-help
+Display help information.
+
+.SH CONFIGURATION
+For configuring and running programmatically.
+
+.B Example
+
+    require('marked')('*foo*', { gfm: true });
+
 .SH BUGS
 Please report any bugs to https://github.com/chjj/marked.
+
 .SH LICENSE
-Copyright (c) 2011-2012, Christopher Jeffrey (MIT License)
+Copyright (c) 2011-2013, Christopher Jeffrey (MIT License)
+
+.SH SEE ALSO
+.BR markdown(1)