added --test cli man documentation

markedjs · Mar 10, 2019 · d29a7a6 · d29a7a6
1 parent c3e2280
commit d29a7a6
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 35 deletions.
diff --git a/man/marked.1 b/man/marked.1
@@ -36,6 +36,23 @@ Specify file output. If none is specified, write to stdout.
 Specify file input, otherwise use last argument as input file. If no input file
 is specified, read from stdin.
 .TP
+.BI \-\-test
+Makes sure test file(s) pass.
+.RS
+.PP
+.B \-\-glob [\fIfile\fP]
+Specify test file to use.
+.PP
+.B \-\-bench
+Benchmarks the test file(s).
+.PP
+.B \-\-time
+Times The test file(s).
+.PP
+.B \-\-Run
+Runs test file(s) as minified. 
+.RE
+.TP
 .BI \-t,\ \-\-tokens
 Output a token stream instead of html.
 .TP

diff --git a/man/marked.1.txt b/man/marked.1.txt
@@ -1,21 +1,14 @@
-marked(1)			   marked.js			     marked(1)
-
-
+marked(1)                                                           marked.js                                                          marked(1)
 
 NAME
        marked - a javascript markdown parser
 
-
 SYNOPSIS
-       marked  [-o  <output>]  [-i  <input>]  [--help] [--tokens] [--pedantic]
-       [--gfm] [--breaks] [--tables] [--sanitize] [--smart-lists] [--lang-pre‐
-       fix <prefix>] [--no-etc...] [--silent] [filename]
-
+       marked  [-o  <output>]  [-i  <input>]  [--help]  [--tokens]  [--pedantic]  [--gfm]  [--breaks]  [--tables]  [--sanitize]  [--smart-lists]
+       [--lang-prefix <prefix>] [--no-etc...] [--silent] [filename]
 
 DESCRIPTION
-       marked  is a full-featured javascript markdown parser, built for speed.
-       It also includes multiple GFM features.
-
+       marked is a full-featured javascript markdown parser, built for speed. It also includes multiple GFM features.
 
 EXAMPLES
        cat in.md | marked > out.html
@@ -26,71 +19,72 @@ EXAMPLES
 
        marked --output="hello world.html" -i in.md --no-breaks
 
-
 OPTIONS
        -o, --output [output]
-	      Specify file output. If none is specified, write to stdout.
+              Specify file output. If none is specified, write to stdout.
 
        -i, --input [input]
-	      Specify file input, otherwise use last argument as  input  file.
-	      If no input file is specified, read from stdin.
+              Specify file input, otherwise use last argument as input file. If no input file is specified, read from stdin.
+
+       --test Makes sure test file(s) pass.
+
+              --glob [file] Specify test file to use.
+
+              --bench Benchmarks the test file(s).
+
+              --time Times The test file(s).
+
+              --Run Runs test file(s) as minified.
 
        -t, --tokens
-	      Output a token stream instead of html.
+              Output a token stream instead of html.
 
        --pedantic
-	      Conform  to  obscure  parts  of markdown.pl as much as possible.
-	      Don't fix original markdown bugs.
+              Conform to obscure parts of markdown.pl as much as possible. Don't fix original markdown bugs.
 
        --gfm  Enable github flavored markdown.
 
        --breaks
-	      Enable GFM line breaks. Only works with the gfm option.
+              Enable GFM line breaks. Only works with the gfm option.
 
        --tables
-	      Enable GFM tables. Only works with the gfm option.
+              Enable GFM tables. Only works with the gfm option.
 
        --sanitize
-	      Sanitize output. Ignore any HTML input.
+              Sanitize output. Ignore any HTML input.
 
        --smart-lists
-	      Use smarter list behavior than the original markdown.
+              Use smarter list behavior than the original markdown.
 
        --lang-prefix [prefix]
-	      Set the prefix for code block classes.
+              Set the prefix for code block classes.
 
        --mangle
-	      Mangle email addresses.
+              Mangle email addresses.
 
        --no-sanitize, -no-etc...
-	      The inverse of any of the marked options above.
+              The inverse of any of the marked options above.
 
        --silent
-	      Silence error output.
+              Silence error output.
 
        -h, --help
-	      Display help information.
-
+              Display help information.
 
 CONFIGURATION
        For configuring and running programmatically.
 
        Example
 
-	   require('marked')('*foo*', { gfm: true });
-
+           require('marked')('*foo*', { gfm: true });
 
 BUGS
        Please report any bugs to https://github.com/markedjs/marked.
 
-
 LICENSE
        Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
 
-
 SEE ALSO
        markdown(1), node.js(1)
 
-
-
-v0.3.1				  2014-01-31			     marked(1)
+v0.3.1                                                             2014-01-31                                                          marked(1)