From 389c762afcee425bb26a940b7dd509d9d10160d4 Mon Sep 17 00:00:00 2001 From: fiddlosopher <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b> Date: Thu, 12 Jul 2007 03:45:00 +0000 Subject: [PATCH] Documented --toc/--table-of-contents option in pandoc man page and README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@679 788f1e2b-df1e-0410-8736-df70ead52e1b --- README | 5 +++++ man/man1/pandoc.1.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/README b/README index 75a0afa1d..c41aa4bd5 100644 --- a/README +++ b/README @@ -267,6 +267,11 @@ specified.) header. To see the headers used by default, use the `-D` option: for example, `pandoc -D html` prints the default HTML header. +`--toc` or `--table-of-contents` includes an automatically generated +table of contents (or, in the case of `latex` and `rst`, an instruction +to create one) in the output document. This option has no effect with +`man`, `docbook`, or `s5` output formats. + `-c` or `--css` allows the user to specify a custom stylesheet that will be linked to in HTML and S5 output. diff --git a/man/man1/pandoc.1.md b/man/man1/pandoc.1.md index 8d1d701c3..c614a8d90 100644 --- a/man/man1/pandoc.1.md +++ b/man/man1/pandoc.1.md @@ -111,6 +111,11 @@ to Pandoc. Or use `html2markdown`(1), a wrapper around `pandoc`. : Number section headings in LaTeX output. (Default is not to number them.) +\--toc, \--table-of-contents +: Include an automatically generated table of contents (HTML, markdown, + RTF) or an instruction to create one (LaTeX, reStructuredText). + This option has no effect on man, DocBook, or S5 output. + -c *CSS*, \--css=*CSS* : Link to a CSS style sheet. *CSS* is the pathname of the style sheet.