Add cash.7 README

4 files changed, 95 insertions, 1 deletions

diff --git a/bin/cash/Makefile b/bin/cash/Makefile
index f1f026f0..4a9ec599 100644
--- a/bin/cash/Makefile
+++ b/bin/cash/Makefile
@@ -82,3 +82,6 @@ install: cash $(MAN1)
 
 uninstall:
 	rm -f $(PREFIX)/bin/cash $(MAN1:%=$(MANDIR)/man1/%)
+
+README: cash.7
+	mandoc cash.7 | col -bx > README
diff --git a/bin/cash/README b/bin/cash/README
new file mode 100644
index 00000000..dac1cec5
--- /dev/null
+++ b/bin/cash/README
@@ -0,0 +1,28 @@
+CASH(7)            FreeBSD Miscellaneous Information Manual            CASH(7)
+
+NAME
+     cash – the Causal Agency shell
+
+DESCRIPTION
+     cash is a shell derived from FreeBSD sh(1), which is in turn derived from
+     Almquist shell.  It includes editline(3) from NetBSD.
+
+   Differences from sh(1)
+     •   ENV defaults to ‘${XDG_CONFIG_HOME:-${HOME}/.config}/cash/env.sh’.
+
+     •   PS0 is printed before each prompt, allowing multi-line prompts.
+
+     •   Right-aligned prompts can be set with RPS1 and RPS2.
+
+     •   PSlit can be used to embed terminal escape sequences in prompts, as
+         in NetBSD sh(1).
+
+     •   HOME is shortened to ‘~’ in prompt expansion.
+
+     •   fc -s =new allows prefixing commands with new.
+
+HISTORY
+     sh(1) sources were imported from FreeBSD 12.0.  editline(3) sources were
+     imported from NetBSD 8.0.
+
+Causal Agency                  January 14, 2019                  Causal Agency
diff --git a/bin/cash/cash.1 b/bin/cash/cash.1
index 7c12b4b6..9b355577 100644
--- a/bin/cash/cash.1
+++ b/bin/cash/cash.1
@@ -2512,7 +2512,7 @@ nor
 .It Fl s
 Re-execute the command without invoking an editor.
 .
-.It Ar old Ns = Ns new
+.It Ar old Ns = Ns Ar new
 Replace the first occurrence of
 .Ar old
 in the command with
diff --git a/bin/cash/cash.7 b/bin/cash/cash.7
new file mode 100644
index 00000000..35f9fc4f
--- /dev/null
+++ b/bin/cash/cash.7
@@ -0,0 +1,63 @@
+.Dd January 14, 2019
+.Dt CASH 7
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm cash
+.Nd the Causal Agency shell
+.
+.Sh DESCRIPTION
+.Nm
+is a shell derived from
+.Fx
+.Xr sh 1 ,
+which is in turn derived from Almquist shell.
+It includes
+.Xr editline 3
+from
+.Nx .
+.
+.Ss Differences from Xr sh 1
+.Bl -bullet
+.It
+.Va ENV
+defaults to
+.Ql ${XDG_CONFIG_HOME:-${HOME}/.config}/cash/env.sh .
+.
+.It
+.Va PS0
+is printed before each prompt,
+allowing multi-line prompts.
+.
+.It
+Right-aligned prompts can be set with
+.Va RPS1
+and
+.Va RPS2 .
+.
+.It
+.Va PSlit
+can be used to embed terminal escape sequences in prompts,
+as in
+.Nx
+.Xr sh 1 .
+.
+.It
+.Va HOME
+is shortened to
+.Sq ~
+in prompt expansion.
+.
+.It
+.Ic fc Fl s Ar = Ns Ar new
+allows prefixing commands with
+.Ar new .
+.El
+.
+.Sh HISTORY
+.Xr sh 1
+sources were imported from
+.Fx 12.0 .
+.Xr editline 3
+sources were imported from
+.Nx 8.0 .