summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2018-05-02 06:50:16 -0700
committerKaz Kylheku <kaz@kylheku.com>2018-05-02 06:50:16 -0700
commit2447f9162f13a41763a3a88ef3275a9e455f1bb5 (patch)
tree983b05edaadb91fce2c4155448ef538f4357ef6f
parentddecfba369f53290123e94580416f947a6c8d385 (diff)
downloadtxr-2447f9162f13a41763a3a88ef3275a9e455f1bb5.tar.gz
txr-2447f9162f13a41763a3a88ef3275a9e455f1bb5.tar.bz2
txr-2447f9162f13a41763a3a88ef3275a9e455f1bb5.zip
doc: break up long syntax.
* txr.1: The syntax synopses for the following functions and macros are too long and are awkwardly wrapped by man under 80 columns: make-time, make-time-utc, make-env, call-update-expander, call-clobber-expander and txr-if. Breaking up and shortening some identifiers.
-rw-r--r--txr.123
1 files changed, 14 insertions, 9 deletions
diff --git a/txr.1 b/txr.1
index c09ac271..66592705 100644
--- a/txr.1
+++ b/txr.1
@@ -16218,7 +16218,7 @@ functions whose arguments are constant forms.
.coNP Function @ make-env
.synb
-.mets (make-env >> [ variable-bindings >> [ function-bindings <> [ next-env ]]])
+.mets (make-env >> [ var-bindings >> [ fun-bindings <> [ next-env ]]])
.syne
.desc
The
@@ -16228,12 +16228,12 @@ function creates an environment object suitable as the
parameter.
The
-.meta variable-bindings
+.meta var-bindings
and
-.meta function-bindings
+.meta fun-bindings
parameters, if specified,
should be association lists, mapping symbols to objects. The objects in
-.meta function-bindings
+.meta fun-bindings
should be functions, or objects callable as functions.
The
@@ -33411,7 +33411,8 @@ macro:
.coNP Function @ call-update-expander
.synb
-.mets (call-update-expander < getter < setter < place < env << body-form )
+.mets (call-update-expander < getter < setter < place < env
+.mets \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ << body-form )
.syne
.desc
The
@@ -33503,7 +33504,8 @@ Implement the swap macro using
.coNP Function @ call-clobber-expander
.synb
-.mets (call-clobber-expander < simple-setter < place < env << body-form )
+.mets (call-clobber-expander < simple-setter < place < env
+.mets \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ << body-form )
.syne
.desc
The
@@ -47391,8 +47393,10 @@ struct is
.coNP Functions @ make-time and @ make-time-utc
.synb
-.mets (make-time < year < month < day < hour < minute < second << dst-advice )
-.mets (make-time-utc < year < month < day < hour < minute < second << dst-advice )
+.mets (make-time < year < month < day
+.mets \ \ \ \ \ \ \ \ \ \ < hour < minute < second << dst-advice )
+.mets (make-time-utc < year < month < day
+.mets \ \ \ \ \ \ \ \ \ \ \ \ \ \ < hour < minute < second << dst-advice )
.syne
.desc
The
@@ -55082,7 +55086,8 @@ it is local inside it.
.coNP Macro @ txr-if
.synb
-.mets (txr-if < name <> ( argument *) < input < then-expr <> [ else-expr ])
+.mets (txr-if < name <> ( argument *) < input
+.mets \ \ \ \ \ \ \ < then-expr <> [ else-expr ])
.syne
.desc
The