summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2018-11-25 22:57:29 -0800
committerKaz Kylheku <kaz@kylheku.com>2018-11-25 22:57:29 -0800
commit6eed5ead43aa206fa6213c3e7069f5d3fe601c66 (patch)
tree4956e691151297f42e35f43cef411ad3ef7b30aa /txr.1
parentf057a56f9dc8e2a4ad77ecf26f6cf114812bf389 (diff)
downloadtxr-6eed5ead43aa206fa6213c3e7069f5d3fe601c66.tar.gz
txr-6eed5ead43aa206fa6213c3e7069f5d3fe601c66.tar.bz2
txr-6eed5ead43aa206fa6213c3e7069f5d3fe601c66.zip
doc: clarify pretty printing.
* txr.1: adding more details to description of the effect of pretty printing.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.137
1 files changed, 34 insertions, 3 deletions
diff --git a/txr.1 b/txr.1
index 60220d3d..ead65a61 100644
--- a/txr.1
+++ b/txr.1
@@ -43556,13 +43556,44 @@ then the
function renders in a way which strives for read-print
consistency: an object is printed in a notation which is recognized as
a similar object of the same kind when it appears in \*(TX source code.
+Floating-point objects are printed as if using the
+.code format
+function, with formatting controlled by the
+.code *print-flo-format*
+variable.
+
If
.meta pretty-p
is true, then
.code print
-performs does not strive for read-print consistency. For instance, it prints a
-string object simply by dumping its characters, rather than by adding the
-surrounding quotes and rendering escape syntax for special characters.
+does not strive for read-print consistency.
+Strings are printed by sending their characters to the output
+stream, as if by the
+.code put-string
+function, rather than being rendered in the string literal notation
+consisting of double quotes, and escape sequences for control
+characters. Likewise, character objects are printed via
+.code put-char
+rather than the
+.code #\e
+notation. Buffer objects are printed by sending their bytes to the
+output stream using
+.code put-byte
+rather than being rendered in the
+.code #b
+notation.
+Symbols are printed without their package prefix, except that
+symbols from the keyword package are still printed with the leading colon.
+Floating-point objects are printed as if using the
+.code format
+function, with formatting controlled by the
+.code *pprint-flo-format*
+variable.
+
+When aggregate objects like conses, ranges and vectors are printed,
+the notations of these objects themselves are unaffected by the
+.code pretty-p
+flag; however, that flag is distributed to the elements.
The
.code print