git.iko.soy/typeable/pandoc
on master help sign in
Updated description of wrapper scripts in README.

git-svn-id: https://pandoc.googlecode.com/svn/trunk@1774 788f1e2b-df1e-0410-8736-df70ead52e1b

commit6aea1f92019f6e86c8e1f41c94a8d0d5a4d879d3 authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> dateSat 2 Jan 2010, 18:18 (17 years ago) parentfa9dfe9
1 file changed+33−15
README+33−15
README+33−15
@@ -1,6 +1,6 @@
11% Pandoc User's Guide
22% John MacFarlane
3−% December 7, 2009
3+% December 7, 2009
44
55Pandoc is a [Haskell] library for converting from one markup format to
66another, and a command-line tool that uses this library. It can read
@@ -123,17 +123,18 @@ will convert `source.txt` from the local encoding to UTF-8, then
123123convert it to HTML, then convert back to the local encoding,
124124putting the output in `output.html`.
125125
126−The shell scripts (described below) automatically convert the input
126+The wrapper scripts (described below) automatically convert the input
127127from the local encoding to UTF-8 before running them through `pandoc`,
128128then convert the output back to the local encoding.
129129
130−Shell scripts
131−=============
130+Wrappers
131+========
132132
133−Three shell scripts, `markdown2pdf`, `html2markdown`, and `hsmarkdown`,
134−are included in the standard Pandoc installation. (They are not included
135−in the Windows binary package, as they require a POSIX shell, but they
136−may be used in Windows under Cygwin.)
133+Three wrapper scripts, `markdown2pdf`, `html2markdown`, and
134+`hsmarkdown`, are included in the standard Pandoc installation. (The
135+Windows binary package does not include `html2markdown`, which is
136+a POSIX shell script. It does include portable Haskell versions of
137+`markdown2pdf` and `hsmarkdown`.)
137138
1381391. `markdown2pdf` produces a PDF file from markdown-formatted
139140 text, using `pandoc` and `pdflatex`. The default
@@ -198,7 +199,7 @@ may be used in Windows under Cygwin.)
198199 options are allowed. (In fact, options will be interpreted as
199200 filenames.)
200201
201− As an alternative to using the `hsmarkdown` shell script, the
202+ As an alternative to using the `hsmarkdown` script, the
202203 user may create a symbolic link to `pandoc` called `hsmarkdown`.
203204 When invoked under the name `hsmarkdown`, `pandoc` will behave
204205 as if the `--strict` flag had been selected, and no command-line
@@ -330,8 +331,14 @@ For further documentation, see the `pandoc(1)` man page.
330331 of an ODT produced using pandoc. The contents of the reference ODT
331332 are ignored, but its stylesheets are used in the new ODT. If no
332333 reference ODT is specified on the command line, pandoc will look
333− for `$HOME/.pandoc/reference.odt` (on unix) or
334− `C:\Documents And Settings\USERNAME\Application Data\pandoc\reference.odt`
334+ for a file `reference.odt` in
335+
336+ $HOME/.pandoc
337+
338+ (on unix) or
339+
340+ C:\Documents And Settings\USERNAME\Application Data\pandoc
341+
335342 (on Windows). If this is not found either, sensible defaults will be
336343 used.
337344
@@ -477,9 +484,14 @@ document. To see the default template that is used, just type
477484where `FORMAT` is the name of the output format. A custom template
478485can be specified using the `--template` option. You can also override
479486the system default templates for a given output format `FORMAT`
480−by putting a file `FORMAT.template` in `$HOME/.pandoc/templates`
487+by putting a file `FORMAT.template` in
488+
489+ $HOME/.pandoc/templates
490+
481491(on unix) or
482−`C:\Documents And Settings\USERNAME\Application Data\pandoc\templates`
492+
493+ C:\Documents And Settings\USERNAME\Application Data\pandoc\templates
494+
483495(on Windows).
484496
485497Templates may contain *variables*. Variable names are sequences of
@@ -1236,8 +1248,14 @@ Alternatively, you may use `-s` together with the `--template`
12361248option to specify a custom template.
12371249
12381250You can change the style of the slides by putting customized CSS files
1239−in `$HOME/.pandoc/s5/default` (on unix) or
1240−`C:\Documents And Settings\USERNAME\Application Data\pandoc\reference.odt`
1251+in
1252+
1253+ $HOME/.pandoc/s5/default
1254+
1255+(on unix) or
1256+
1257+ C:\Documents And Settings\USERNAME\Application Data\pandoc\reference.odt
1258+
12411259(on Windows). The originals may be found in pandoc's system
12421260data directory (generally `$CABALDIR/pandoc-VERSION/s5/default`).
12431261Pandoc will look there for any files it does not find in the user's