X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/868d7faa784990b0ec70975e6b1d736d2c2ab8c0..6d78d92dfa675156640925421f33aa0535f6f46f:/README.markdown?ds=inline diff --git a/README.markdown b/README.markdown index d459604..3375b8a 100644 --- a/README.markdown +++ b/README.markdown @@ -57,13 +57,6 @@ 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 @@ -108,13 +101,6 @@ 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 @@ -212,7 +198,6 @@ In every case, you may supply your own implementation by overriding the - `rm` - `sed` - `sleep` -- `stat` (BSD *or* GNU) - `test` - `touch` - `tr` @@ -307,8 +292,8 @@ The following additional variables can be used to control the behaviour 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`). - **`THISREV`:** The current version of ⛩️📰 书社 (default: derived from the current @@ -318,6 +303,15 @@ The following additional variables can be used to control the behaviour 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). @@ -350,14 +344,12 @@ 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 (`-`), 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 @@ -579,6 +571,10 @@ The following params are made available globally in parsers and - **`SRCTIME`:** The time at which the source file was last modified. + Due to limitations in Posix, this time will only have minute + precision if the file was modified in the last six months, and will + only have day precision if the file is older. + Users should not expect this value to be particularly stable. - **`THISREV`:** The value of the `THISREV` variable (if present). @@ -700,29 +696,6 @@ 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][].