Update documentation to reflect usage on Linux

[Shushe] / README.markdown

diff --git a/README.markdown b/README.markdown
index 643a4d8da36c3e470ddc197cc5f008b9e1b76404..e99255b94091ff5b1c8e595172d78ec2301e3102 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -21,9 +21,21 @@ It makes things easier by :⁠—
 - Enabling easy inclusion of source files within each other.
 
 It aims to do this with zero dependencies beyond the programs already
 - Enabling easy inclusion of source files within each other.
 
 It aims to do this with zero dependencies beyond the programs already

-  installed on your computer.
-(On Linux machines, you may need to install `libxml2-utils` to get the
-  commandline programs from `libxml2`.)
+  installed on your computer†.
+
+† The only non‐Posix programs‡ required are those provided by `libxml2`
+  and `libxslt` (which most operating systems provide), but on Linux
+  machines the commandline utilities may need to be installed
+  separately as **`libxml2-utils`** and **`xsltproc`**.
+Additionally, not all Linux distributions bundle all necessary Posix
+  programs; on Debian (for example) you may need to separately install
+  **`sharutils`** for `uudecode` and `uuencode` and **`pax`** for
+  archiving.
+
+‡ This make·file also currently depends on non‐Posix `stat` but
+  attempts to handle both the G·N·U and B·S·D variants.
+It expects `xargs` to accept a `-0` option, which, while widely
+  supported, is not a part of the Posix standard.

 
 **Note:**
 ⛩️📰 书社 requires functionality present in G·N·U Make 3.81 (or later)
 
 **Note:**
 ⛩️📰 书社 requires functionality present in G·N·U Make 3.81 (or later)


@@ -75,7 +87,7 @@ Compilation involves the following steps :⁠—
 
 6. ⛩️📰 书社 compiles each output file to `build/result`.
 
 
 6. ⛩️📰 书社 compiles each output file to `build/result`.
 

-7. ⛩️📰 书社 symlinks most output files from `build/result` to
+7. ⛩️📰 书社 copies most output files from `build/result` to

      `build/public`, but it does some additional processing instead on
      those which indicate a non‐X·M·L desired final output form.
 
      `build/public`, but it does some additional processing instead on
      those which indicate a non‐X·M·L desired final output form.
 


@@ -121,21 +133,22 @@ In every case, you may supply your own implementation by overriding the
 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)
 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)

+- `grep`

 - `ln`
 - `ln`

-- `mkdir` (requires support for `-p`)
+- `mkdir`

 - `mv`
 - `mv`

-- `od` (requires support for `-t x1`)
+- `od`

 - `pax` (only when generating archives)
 - `printf`
 - `rm`
 - `sed`
 - `sleep`
 - `pax` (only when generating archives)
 - `printf`
 - `rm`
 - `sed`
 - `sleep`

-- `stat`
+- `stat` (BSD *or* GNU)

 - `test`
 - `touch`
 - `test`
 - `touch`

-- `tr` (requires support for `-d`)
-- `uuencode` (requires support for `-m` and `-r`)
-- `uudecode` (requires support for `-m` and `-r`)
+- `tr`
+- `uuencode`
+- `uudecode`

 - `xargs` (requires support for `-0`)
 - `xmlcatalog` (provided by `libxml2`)
 - `xmllint` (provided by `libxml2`)
 - `xargs` (requires support for `-0`)
 - `xmlcatalog` (provided by `libxml2`)
 - `xmllint` (provided by `libxml2`)


@@ -459,6 +472,10 @@ Transforms are used to convert X·M·L files into their final output,
   It is not possible to selectively only declare one prefix for a
     name·space to the exclusion of others.
 
   It is not possible to selectively only declare one prefix for a
     name·space to the exclusion of others.
 

+  `<书社:raw-output>` elements may be used inside of
+    `<书社:serialize-xml>` elements to inject raw output into the
+    serialized X·M·L.
+

 The following are recommendations on effective creation of
   transforms :⁠—
 
 The following are recommendations on effective creation of
   transforms :⁠—