X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/a9dfb3cd8b5a2a8a3c6b8ce90212638166a15fd3..540047bcda4be5d3782bf16af78965da64f61149:/README.markdown diff --git a/README.markdown b/README.markdown index dec092a..de82209 100644 --- a/README.markdown +++ b/README.markdown @@ -157,17 +157,10 @@ The following additional variables can be used to control the behaviour - **`MAGICDIR`:** The location of the magic files to use (default: `$(THISDIR)/magic`). -- **`FINDOPTS`:** - Options to pass to `find` when searching for source files (default: - `-PE`). - - **`FINDRULES`:** - Rules to use with `find` when searching for source files (default: - `-flags -nohidden -and -not -name '.*'`). - -- **`FINDINCLUDEOPTS`:** - Options to pass to `find` when searching for includes (default: - `$(FINDOPTS)`). + Rules to use with `find` when searching for source files. + The default ignores hidden files, those that start with a period or + hyphen‐minus, and those which contain a pipe, buck, or colon. - **`FINDINCLUDERULES`:** Rules to use with `find` when searching for includes (default: @@ -213,11 +206,12 @@ Text formats with associated X·S·L·T parsers are wrapped in a H·T·M·L Source files whose media type does not have an associated X·S·L·T parser are considered “assets” and will not be transformed. -For compatibility with this program, source filenames should not - contain Ascii whitespace or any of the following Ascii characters: - ``!"#$%&()-:<>?\^`{|}``. -These characters are either invalid in u·r·i’s or conflict with aspects - of the Make or commandline syntax. +**☡ For compatibility with this program, source filenames must not + contain Ascii whitespace, colons (`:`), pipes (`|`), bucks (`$`), + percents (`%`) or control characters, and must not begin with a + hyphen‐minus (`-`).** +The former characters have the potential to conflict with make syntax, + and a leading hyphen‐minus is confusable for a command‐line argument. ## Parsers @@ -310,6 +304,15 @@ Embedding takes place after parsing but before transformation, so and update them accordingly; it will signal an error if the dependencies are recursive. +## Output Redirection + +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). + ## Transforms Transforms are used to convert X·M·L files into their final output,