aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-12-11 15:58:11 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2015-12-11 23:55:08 -0800
commit536b6bf538a95f6db6ed41b72257f8b09fd26886 (patch)
tree384dc0790f9555b16df3789c4e1a80616eadd52d /README
parent63d875c6cbc9a8ac6b514982327a70df01d8a482 (diff)
downloadpandoc-536b6bf538a95f6db6ed41b72257f8b09fd26886.tar.gz
Implemented SoftBreak and new `--wrap` option.
Added threefold wrapping option. * Command line option: deprecated `--no-wrap`, added `--wrap=[auto|none|preserve]` * Added WrapOption, exported from Text.Pandoc.Options * Changed type of writerWrapText in WriterOptions from Bool to WrapOption. * Modified Text.Pandoc.Shared functions for SoftBreak. * Supported SoftBreak in writers. * Updated tests. * Updated README. Closes #1701.
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 12 insertions, 3 deletions
diff --git a/README b/README
index 754f393ee..f9de43aaf 100644
--- a/README
+++ b/README
@@ -522,11 +522,20 @@ General writer options
to inch/centimeters and vice versa. The default is 96dpi.
Technically, the correct term would be ppi (pixels per inch).
+`--wrap=[auto|none|preserve]`
+
+: Determine how text is wrapped in the output (the source
+ code, not the rendered version). With `auto` (the default),
+ pandoc will attempt to wrap lines to the column width specified by
+ `--columns` (default 80). With `none`, pandoc will not wrap
+ lines at all. With `preserve`, pandoc will attempt to
+ preserve the wrapping from the source document (that is,
+ where there are nonsemantic newlines in the source, there
+ will be nonsemantic newlines in the output as well).
+
`--no-wrap`
-: Disable text wrapping in output. By default, text is wrapped
- appropriately for the output format. This affects only the
- generated source code, not the layout on the rendered page.
+: Deprecated synonym for `--wrap=none`.
`--columns=`*NUMBER*