diff options
author | fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> | 2006-12-28 02:20:09 +0000 |
---|---|---|
committer | fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> | 2006-12-28 02:20:09 +0000 |
commit | a1a30d69bd83e57e494cd3ca5077086077731998 (patch) | |
tree | 8193378eb51d13a20cf9f28ce479af431d3dcba4 /man/man1/pandoc.1 | |
parent | a1539d9ab8141ab11add5b304792e7c9bc7a363a (diff) | |
download | pandoc-a1a30d69bd83e57e494cd3ca5077086077731998.tar.gz |
+ Removed the convenience symlinks (which don't work on Windows under
Cygwin, due to Windows' lack of true symbolic links).
+ Modified the wrappers to use 'pandoc' instead of the symlinks.
+ Modified the Makefile to remove all references to the symlinks.
+ Removed code from Main.hs that made pandoc's behavior depend on the
name of the calling program.
+ Added code to Main.hs that sets default reader and writer based on
extensions of input and output filenames (if provided). (Thanks to
roktas for the idea.)
+ Modified README and man pages accordingly.
+ Removed WINDOWS-README target from Makefile. It is no longer needed
now that we don't have the symlinks.
git-svn-id: https://pandoc.googlecode.com/svn/trunk@295 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man/man1/pandoc.1')
-rw-r--r-- | man/man1/pandoc.1 | 50 |
1 files changed, 21 insertions, 29 deletions
diff --git a/man/man1/pandoc.1 b/man/man1/pandoc.1 index 82c9ae321..f6280f463 100644 --- a/man/man1/pandoc.1 +++ b/man/man1/pandoc.1 @@ -1,8 +1,6 @@ .TH PANDOC 1 "December 15, 2006" Pandoc "User Manuals" .SH NAME -pandoc, markdown2html, markdown2latex, markdown2rst, markdown2rtf, -markdown2s5, html2markdown2, latex2markdown, rst2markdown \- general -markup converter +pandoc \- general markup converter .SH SYNOPSIS \fBpandoc\fR [\fIoptions\fR] [\fIinput\-file\fR]... .SH DESCRIPTION @@ -13,41 +11,37 @@ slide shows. .PP If no \fIinput\-file\fR is specified, input is read from STDIN. Otherwise, the \fIinput\-files\fR are concatenated (with a blank -line between each) and used as input. Output goes to standard -output. If you want output to a file, use the \fB\-o\fR option or -shell redirection: +line between each) and used as input. Output goes to STDOUT by +default. For output to a file, use the \fB\-o\fR option: .IP .B pandoc \-o output.html input.txt -.IP -.B pandoc input.txt > output.html .PP -The default behavior of \fIPandoc\fR is to convert the input from -markdown\-formatted plain text to HTML. Different input and output -formats can be specified using command\-line options. For example, +The input and output formats may be specified using command-line options +(see \fBOPTIONS\fR, below, for details). If these formats are not +specified explicitly, \fIPandoc\fR will attempt to determine them +from the extensions of the input and output filenames. If input comes +from STDIN or from a file with an unknown extension, the input is assumed +to be markdown. If no output filename is specified using the \fB\-o\fR +option, or if a filename is specified but its extension is unknown, +the output will default to HTML. Thus, for example, .IP -.B pandoc \-f latex \-t markdown chap1.tex > chap1.txt +.B pandoc -o chap1.tex chap1.txt .PP -converts \fIchap1.tex\fR from LaTeX to markdown\-formatted plain text. -See below for a detailed list of command\-line options. +converts \fIchap1.txt\fR from markdown to LaTeX. And +.IP +.B pandoc README .PP -For convenience, eight variant programs are available: -\fBmarkdown2html\fR (same as \fBpandoc \-w html\fR), -\fBmarkdown2latex\fR (same as \fBpandoc \-w latex\fR), -\fBmarkdown2rst\fR (same as \fBpandoc \-w rst\fR), -\fBmarkdown2rtf\fR (same as \fBpandoc \-w rtf\fR), -\fBmarkdown2s5\fR (same as \fBpandoc \-w s5\fR), -\fBhtml2markdown\fR (same as \fBpandoc \-r html \-w markdown\fR), -\fBlatex2markdown\fR (same as \fBpandoc \-r latex \-w markdown\fR), -and \fBrst2markdown\fR (same as \fBpandoc \-r rst \-w markdown\fR). -These programs take an appropriately restricted subset of \fBpandoc\fR's -options. (Run them with the \fB-h\fR flag for a full list of allowed -options.) +converts \fIREADME\fR from markdown to HTML. .PP \fIPandoc\fR uses the UTF\-8 character encoding for both input and output. If your local character encoding is not UTF\-8, you should pipe input and output through \fBiconv\fR: .IP .B iconv \-t utf\-8 input.txt | pandoc | iconv \-f utf\-8 +.PP +\fIPandoc\fR's HTML parser is not very forgiving. If your input is +HTML, consider running it through \fBtidy\fR(1) before passing it +to Pandoc. Or use \fBweb2markdown\fR(1), a wrapper around \fBpandoc\fR. .SH OPTIONS .TP @@ -158,9 +152,7 @@ Show usage message. .SH "SEE ALSO" \fBweb2markdown\fR(1), -\fBmarkdown2pdf\fR(1), -\fBiconv\fR(1) - +\fBmarkdown2pdf\fR(1). The .I README file distributed with Pandoc contains full documentation. |