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.
+### `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.
+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`
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
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
git tag/branch/commit).
### Attributes added during parsing
-⛩️📰 书社 will add a few attributes to the output of the parsing step,
- namely :—
+⛩️📰 书社 will add a few attributes to elements which result from
+ parsing plaintext `<html:script>` elements.
+These include :—
-- A `@书社:cksum` attribute on toplevel result elements, giving the
- `cksum` checksum of the corresponding source file.
+- A `@书社:parsed-by` attribute, giving a space‐separated list of
+ parsers which parsed the node.
+ (Generally, this will be a list of one, but it is possible for the
+ result of a parse to be another plaintext node, which may be parsed
+ by a different parser.)
-- For the elements which result from parsing plaintext `<html:script>`
- elements :—
+- A `@书社:media-type` attribute, giving the identified media type of
+ the plaintext node.
- - A `@书社:parsed-by` attribute, giving a space‐separated list of
- parsers which parsed the node.
- (Generally, this will be a list of one, but it is possible for the
- result of a parse to be another plaintext node, which may be
- parsed by a different parser.)
+## Output Redirection
- - A `@书社:media-type` attribute, giving the identified media type of
- the plaintext node.
+By default, ⛩️📰 书社 installs files to the same location in `DESTDIR`
+ as they were placed in their `SRCDIR`.
+This behaviour can be customized by setting the `@书社:destination`
+ attribute on the root element, whose value can give a different path.
+This attribute is read after parsing, but before transformation (where
+ it is silently dropped).
## Embedding
and update them accordingly; it will signal an error if the
dependencies are recursive.
-## Output Redirection
+### Attributes added during expansion
-By default, ⛩️📰 书社 installs files to the same location in `DESTDIR`
- as they were placed in their `SRCDIR`.
-This behaviour can be customized by setting the `@书社:destination`
- attribute on the root element, whose value can give a different path.
-This attribute is read after parsing, but before transformation (where
- it is silently dropped).
+⛩️📰 书社 will add a few attributes to toplevel result elements, both
+ in the main document and any embedded documents, during the expansion
+ phase prior to the main transformation.
+These include :—
+
+- A `@书社:cksum` attribute giving the `cksum` checksum of the
+ corresponding source file.
+
+- A `@书社:mtime` attribute giving the last modified time of the
+ corresponding source file.
+
+- A `@书社:identifier` attribute giving the ⛩️📰 书社 identifier
+ (i·e, starting with `about:shushe?`) of the corresponding source
+ file.
+
+- For elements in the `html` namespace, an `itemscope` attribute and an
+ `itemtype` attribute with a value of
+ `urn:fdc:ladys.computer:20231231:Shu1She4:document` (for the main
+ document) or `urn:fdc:ladys.computer:20231231:Shu1She4:embed` (for
+ embedded documents).
+ These attributes are used to scope any nested `<html:meta>` elements
+ with `@itemprop` attributes to their containing documents.
## Transforms
- **`BUILDTIME`:**
The current time.
-- **`CKSUM`:**
- The checksum of the source file (⅌ `cksum`).
-
- **`IDENTIFIER`:**
The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with
`about:shushe`).
- **`SRCREV`:**
The value of the `SRCREV` variable (if present).
-- **`SRCTIME`:**
- The time at which the source file was last modified.
-
- **`THISREV`:**
The value of the `THISREV` variable (if present).
The following params are only available in transforms :—
-- **`CATALOG`:**
- The path of the catalog file (within `BUILDDIR`).
-
- **`PATH`:**
The path of the output file (within `DESTDIR`).
[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