X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/ccef2f2a2243cf086b165562cb73defa14f34f62..c37b4d6b8b17a0e2b0f6a8edd54eec025eb9a9d7:/README.markdown diff --git a/README.markdown b/README.markdown index 5457ce7..b83d49e 100644 --- a/README.markdown +++ b/README.markdown @@ -21,16 +21,12 @@ 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 - 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†. -**Note:** -⛩️📰 书社 requires functionality present in G·N·U Make 3.81 (or later) - and will not work in previous versions, or other implementations of - Make. -Compatibility with later versions of G·N·U Make is assumed, but not - tested. +† Assuming an operating system with a fairly featureful, and + Posix‐compliant, development setup (e·g, macOS). +In fact, on Linux you will probably need to install a few programs: + `libxml2-utils`, `xsltproc`, `sharutils`, and `pax`. ## Nomenclature @@ -52,6 +48,91 @@ The name 书社 was chosen to play on this pun, as In Ascii environments, ⛩️📰 书社 should be written `Shushe`, following the pinyin transliteration. +## Prerequisites + +In most cases, ⛩️📰 书社 aims to require only functionality which is + present in all Posix‐compliant 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. + +### `file` + +This is a Posix utility, but ⛩️📰 书社 currently depends on + unspecified behaviour. +It requires support for the following additional options :⁠— + +- **`-C`**, when supplied with `-m`, must be useable to compile a + `.mgc` magicfile for use with future invocations of `file`. + +- **`--files-from`** must be useable to provide a file that `file` + should read file·names from, and `-` must be useable in this + context to specify the standard input. + +- **`--mime-type`** must cause `file` to print the internet media type + of the file with no charset parameter. + +- **`--separator`** must be useable to set the separator that `file` + uses to separate file names from types. + +These options are implemented by the + [Fine Free File Command](https://darwinsys.com/file/), which is used + by most operating systems. + +### `git` + +This is not a Posix utility. +Usage of `git` is optional, but recommended (and activated by default). +To disable it, set `GIT=`. + +### `make` + +This is a Posix utility, but ⛩️📰 书社 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 + implementations of Make. + +### `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. + +### `uudecode` and `uuencode` + +These are Posix utilities, but 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. + +### `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`). + +### `xsltproc` + +This is not a Posix utility. +It is a part of `libxslt`, but may need to be installed separately. + ## Basic Usage Place source files in `sources/` and run `make install` to compile @@ -123,9 +204,10 @@ In every case, you may supply your own implementation by overriding the - `git` (optional; set `GIT=` to disable) - `grep` - `ln` -- `mkdir` (requires support for `-p`) +- `ls` +- `mkdir` - `mv` -- `od` (requires support for `-t x1`) +- `od` - `pax` (only when generating archives) - `printf` - `rm` @@ -134,10 +216,10 @@ In every case, you may supply your own implementation by overriding the - `stat` (BSD *or* GNU) - `test` - `touch` -- `tr` (requires support for `-d`) -- `uuencode` (requires support for `-m` and `-r`) -- `uudecode` (requires support for `-m` and `-r`) -- `xargs` (requires support for `-0`) +- `tr` +- `uuencode` +- `uudecode` +- `xargs` - `xmlcatalog` (provided by `libxml2`) - `xmllint` (provided by `libxml2`) - `xsltproc` (provided by `libxslt`) @@ -269,12 +351,14 @@ Source files whose media type does not have an associated X·S·L·T 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 (`-`), and must not - end with a cloparen (`)`).** + characters, must not begin with a hyphen‐minus (`-`), must not end + with a cloparen (`)`), and must not contain quoted braces (`"{` or + `}"`).** The former characters have the potential to conflict with make syntax, - a leading hyphen‐minus is confusable for a command‐line 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). + a leading hyphen‐minus is confusable for a command‐line argument, 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. ## Parsers @@ -610,6 +694,29 @@ They are :⁠— 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][].