summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2014-10-28 10:21:09 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2014-10-28 10:21:44 -0700
commit93b82e8ea6a6ea3263a54b7d2a78e910323505b8 (patch)
tree72548fb53153521ba08f1bdd4501f47a7b240019 /README
parent60846471a3dfd5d77270d832f41954ffc9696b3c (diff)
Clarified need for `-s` to get character encoding info.
Closes #1724, #1725.
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
index 556c35bc8..f117ef103 100644
--- a/README
+++ b/README
@@ -50,6 +50,15 @@ default (though output to *stdout* is disabled for the `odt`, `docx`,
pandoc -o output.html input.txt
+By default, pandoc produces a document fragment, not a standalone
+document with a proper header and footer. To produce a standalone
+document, use the `-s` or `--standalone` flag:
+
+ pandoc -s -o output.html input.txt
+
+For more information on how standalone documents are produced, see
+[Templates](#templates), below.
+
Instead of a file, an absolute URI may be given. In this case
pandoc will fetch the content using HTTP:
@@ -95,6 +104,11 @@ should pipe input and output through `iconv`:
iconv -t utf-8 input.txt | pandoc | iconv -f utf-8
+Note that in some output formats (such as HTML, LaTeX, ConTeXt,
+RTF, OPML, DocBook, and Texinfo), information about
+the character encoding is included in the document header, which
+will only be included if you use the `-s/--standalone` option.
+
Creating a PDF
--------------