summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-01-08 08:11:08 +0000
committerfiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>2007-01-08 08:11:08 +0000
commit5dda65b5dc9213f74f7d33777e002fae903d1cd1 (patch)
tree25de8416fc5755a235b428eb8aaf2e023121d5af /man
parentd47ce5b1f444c9754bfe78733c5658616263522a (diff)
Changes to Pandoc's options to facilitate wrapper scripts:
+ removed -d/--debug option + added --dump-args option, which prints the name of the output file (or '-' for STDOUT) and all the command-line arguments (excluding Pandoc options and their arguments), one per line, then exits. Note that special wrapper options will be treated as arguments if they follow '--' at the end of the command line. Thus, pandoc --dump-args -o foo.html foo.txt -- -e latin1 will print the following to STDOUT: foo.html foo.txt -e latin1 + added --ignore-args option, which causes Pandoc to ignore all (non-option) arguments, including any special options that occur after '--' at the end of the command line. + '-' now means STDIN as the name of an input file, STDOUT as the name of an output file. So, pandoc -o - - will take input from STDIN and print output to STDOUT. Note that if multiple '-o' options are specified on the same line, the last one takes precedence. So, in a script, pandoc "$@" -o - will guarantee output to STDOUT, even if the '-o' option was used. + documented these changes in man pages, README, and changelog. git-svn-id: https://pandoc.googlecode.com/svn/trunk@454 788f1e2b-df1e-0410-8736-df70ead52e1b
Diffstat (limited to 'man')
-rw-r--r--man/man1/pandoc.126
1 files changed, 21 insertions, 5 deletions
diff --git a/man/man1/pandoc.1 b/man/man1/pandoc.1
index 199551f22..8c3c62e15 100644
--- a/man/man1/pandoc.1
+++ b/man/man1/pandoc.1
@@ -93,7 +93,8 @@ Produce output with an appropriate header and footer (e.g. a
standalone HTML, LaTeX, or RTF file, not a fragment).
.TP
.B \-o FILE, \-\-output=FILE
-Write output to \fIFILE\fR instead of STDOUT.
+Write output to \fIFILE\fR instead of STDOUT. If \fIFILE\fR is
+`\-', output will go to STDOUT.
.TP
.B \-p, \-\-preserve-tabs
Preserve tabs instead of converting them to spaces.
@@ -151,10 +152,25 @@ markdown, rst, rtf\fR).
.B \-T \fISTRING\fB, \-\-title-prefix=\fISTRING\fB
Specify \fISTRING\fR as a prefix to the HTML window title.
.TP
-.B \-d, \-\-debug
-Print debugging information (names of input and output files) to
-STDERR. Write output to STDOUT, even if an output file was specified
-using the \fB\-o\fR option.
+.B \-\-dump\-args
+Print information about command\-line arguments to STDOUT, then exit.
+The first line of output contains the name of the output file specified
+with the \fB\-o\fR option, or `\-' (for STDOUT) if no output file was
+specified. The remaining lines contain the command\-line arguments,
+one per line, in the order they appear. These do not include regular
+Pandoc options and their arguments, but do include any options appearing
+after a `\-\-' separator at the end of the line.
+This option is intended primarily for use in wrapper scripts.
+.TP
+.B \-\-ignore\-args
+Ignore command\-line arguments (for use in wrapper scripts).
+Regular Pandoc options are not ignored. Thus, for example,
+.IP
+.B pandoc \-\-ignore\-args \-o foo.html \-s foo.txt -- -e latin1
+.IP
+is equivalent to
+.IP
+.B pandoc \-o foo.html \-s
.TP
.B \-v, \-\-version
Print version.