installed on your computer†.
† Assuming an operating system with a fairly featureful, and
- Posix‐compliant, development setup (e·g, macOS).
+ Posix‐compliant, development setup (e·g, Macintosh ≥ version 10.8).
In fact, on Linux you will probably need to install a few programs:
`libxml2-utils`, `xsltproc`, `sharutils`, and `pax`.
## Prerequisites
In most cases, ⛩️📰 书社 aims to require only functionality which is
- present in all Posix‐compliant operating systems.
+ present in all Posix‐compliant (`POSIX.1-2001`) operating systems.
There are a few exceptions.
Details on particular programs are given below; if a program is not
listed, it is assumed that any Posix‐compliant implementation will
work.
-### `date`
-
-This is a Posix utility, but ⛩️📰 书社 currently depends on
- unspecified behaviour.
-When the G·N·U version of `stat` is being used, then the G·N·U version
- of `date` is also expected.
+### `diff`
+
+This is a Posix utility, but ⛩️📰 书社 depends on functionality
+ introduced after `POSIX.1-2001` (the `-u` option, introduced in
+ `POSIX.1-2008`).
+Macintosh systems somewhat interestingly implement this option
+ correctly in legacy mode (`COMMAND_MODE=legacy`) but incorrectly by
+ default (despite claiming `POSIX.1-2008` conformance for this
+ utility).
+[Note this erroneous comment claiming nanosecond & timezone are
+ extensions rather than standardized.][rdar-92753335]
+Despite this, the default Macintosh implementation will still work with
+ ⛩️📰 书社, with the caveat that the timestamp will only include a
+ fractional component when a Posix⹀compliant (e·g, Macintosh legacy or
+ G·N·U) implementation is used.
### `file`
-This is a Posix utility, but ⛩️📰 书社 currently depends on
- unspecified behaviour.
+This is a Posix utility, but it was considered optional in
+ `POSIX.1-2001` (altho it was made mandatory in `POSIX.1-2008`) and
+ ⛩️📰 书社 currently depends on unspecified behaviour.
It requires support for the following additional options :—
- **`-C`**, when supplied with `-m`, must be useable to compile a
### `make`
-This is a Posix utility, but ⛩️📰 书社 currently depends on
- unspecified behaviour.
+This is a Posix utility, but it is considered an optional Software
+ Development utility and ⛩️📰 书社 currently depends on unspecified
+ behaviour.
⛩️📰 书社 requires specifically the G·N·U version of `make`, and
depends on functionality present in version 3.81 or later.
It is not expected to work in previous versions, or with other
### `pax`
-This is a Posix utility, but not included in the Linux Standard Base or
- installed by default in many distributions.
-Only `ustar` format support is required.
-
-### `stat`
-
-This is not a Posix utility, and nor is it particularly portable.
-To get around incompatibilities, ⛩️📰 书社 attempts to recognize G·N·U
- `stat` by searching for the string `GNU` when invoked with the
- `--version` option, and falls back to B·S·D behaviour otherwise.
+This is a Posix utility, but it is not included in the Linux Standard
+ Base or installed by default in many distributions.
+⛩️📰 书社 only requires support for the `ustar` format.
### `uudecode` and `uuencode`
-These are Posix utilities, but not included in the Linux Standard Base
- or installed by default in many distributions.
+These are Posix utilities, but they were considered optional in
+ `POSIX.1-2001` (altho they are made mandatory in `POSIX.1-2008`) and
+ they are not included in the Linux Standard Base or installed by
+ default in many distributions.
The G·N·U [Sharutils](https://www.gnu.org/software/sharutils/) package
- can be installed to access them.
+ provides one implementation.
### `xmlcatalog` and `xmllint`
These are not a Posix utilities.
-They is a part of `libxml2`, but may need to be installed separately
- (e·g by the name `libxml2-utils`).
+They are a part of `libxml2`, but may need to be installed separately
+ on some platforms (e·g by the name `libxml2-utils`).
### `xsltproc`
This is not a Posix utility.
-It is a part of `libxslt`, but may need to be installed separately.
+It is a part of `libxslt`, but may need to be installed separately on
+ some platforms.
## Basic Usage
- `awk`
- `cat`
+- `cd`
- `cksum`
- `cp`
- `date`
-- `echo`
+- `diff`
- `file`
- `find`
- `git` (optional; set `GIT=` to disable)
- `grep`
- `ln`
-- `ls`
- `mkdir`
- `mv`
- `od`
- `rm`
- `sed`
- `sleep`
-- `stat` (BSD *or* GNU)
- `test`
- `touch`
- `tr`
those which end with a cloparen, and those which contain a hash,
buck, percent, asterisk, colon, semi, eroteme, bracket, backslash,
or pipe.
+ It is important that these rules not produce any output, as anything
+ printed to `stdout` will be considered a result of the find.
- **`EXTRAFINDRULES`:**
The value of this variable is appended to `FINDRULES` by default, to
enable additional transforms without overriding the existing ones.
- **`XMLTYPES`:**
- A white·space‐separated list of media types to consider X·M·L
- (default: `application/xml text/xml`).
+ A white·space‐separated list of media types or media type suffixes to
+ consider X·M·L (default: `application/xml text/xml +xml`).
+
+- **`FINALIZE`:**
+ A program to run on (unspecial) X·M·L files after they are
+ transformed (default: `xmllint --nonet --nsclean`).
+ This variable can be used for postprocessing.
- **`THISREV`:**
The current version of ⛩️📰 书社 (default: derived from the current
The current version of the source files (default: derived from the
current git tag/branch/commit).
+- **`QUIET`:**
+ If this variable has a value, informative messages will not be
+ printed (default: empty).
+ Informative messages print to stderr, not stdout, so disabling them
+ usually shouldn’t be necessary.
+ This does not (cannot) disable messages from Make itself, for which
+ the `-s`, `--silent` ∕ `--quiet` Make option is more likely to be
+ useful.
+
- **`VERBOSE`:**
If this variable has a value, every recipe instruction will be
printed when it runs (default: empty).
contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`),
bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets
(`[` or `]`), erotemes (`?`), backslashes (`\`), or control
- characters, must not begin with a hyphen‐minus (`-`), must not end
- with a cloparen (`)`), and must not contain quoted braces (`"{` or
- `}"`).**
+ characters, must not begin with a hyphen‐minus (`-`), and must not end
+ with a cloparen (`)`).**
The former characters have the potential to conflict with make syntax,
- a leading hyphen‐minus is confusable for a command‐line argument, a
+ a leading hyphen‐minus is confusable for a commandline argument, and a
trailing cloparen [activates a bug in G·N·U Make
- 3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894),
- and quoted braces are used internally by the program.
+ 3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894).
## Parsers
non X·M·L output types, ⁊·c).
Other child elements will be ignored.
+ If the `<书社:archive>` element is given an `@书社:expanded`
+ attribute, rather than producing a tarball ⛩️📰 书社 will output
+ the directory which expanding the tarball would produce.
+ This mechanism can be used to generate multiple files from a single
+ source, provided all of the files are contained with·in the same
+ directory.
+
- **`<书社:base64-binary>`:**
The text nodes in the transformation result will, after removing all
Ascii whitespace, be treated as a Base·64 string, which is then
A plaintext (U·T·F‐8) file will be produced from the text nodes in
the transformation result.
-## Pagination
-
-It is possible to have a single source file produce multiple output
- files via `<书社:page>` elements, whose `@name` gives the name of the
- page.
-If a parsed document has a `@书社:destination` which contains `%s`,
- the `%s` will be replaced with the `@name` for each `<书社:page>` (and
- removed for the main output).
-Otherwise, the `@name` is inserted before the first period of the
- filename (or at the end of the filename for those with no period).
-If `<书社:page>`s do not have a `@name`, they are numbered
- sequentially.
-The destination of pages must be in the same directory as their parent.
-
-Pagination essentially forms a limited convenience for the more
- sophisticated technique of creating an archive with ⛩️📰 书社 and
- then unarchiving it.
-Pages are, from Make’s point of view, untracked side·effects of
- installing the main output, meaning they cannot be targeted directly
- and will not appear in `make list` or `make listout`.
-They are intended solely for the like of indices and feeds, for which
- convenience and necessity outweigh their flaws.
-
## License
This repository conforms to [REUSE][].
[REUSE]: <https://reuse.software/spec/>
[draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
+[rdar-92753335]: <https://github.com/apple-oss-distributions/patch_cmds/blob/5084833f90df1b0e0924ea56f94c0199b3b8bbc6/diff/diffreg.c#L1800-L1808>
Lady’s Gitweb / Shushe / blobdiff