This is a repository providing sources building various Dash docsets using a Makefile. Supported docsets can be found as a submodule under ./src/configs
. Simply pass the name of the docset as a target for the Makefile (e.g., make GNU_Make
).
Usage: make DOCSET_NAME [BUILD_DIR=...] [NO_CSS=yes] [LOCALE=...] [VERSION=...]
DOCSET_NAME must be a directory under ./src/configs.
BUILD_DIR can be set to a directory to build under. The default is ./build.
NO_CSS if set to `yes`, build with stylesheets disabled.
LOCALE specify a locale to build for (see below table for more details).
VERSION specify an upstream version to build from.
Other possible targets:
archive - create .tgz archives for all docsets in BUILD_DIR
clean - remove all docsets and .tgz archives from BUILD_DIR
$(BUILD_DIR)/$(DOCSET_NAME).docset - equivalent to DOCSET_NAME
$(BUILD_DIR)/$(DOCSET_NAME).tgz - create a .tgz archive of DOCSET_NAME
This table shows which supported docsets support which options. All targets support the setting of DOCSET_NAME and BUILD_DIR.
LOCALE | NO_CSS | VERSION | |
---|---|---|---|
debmake | ✓ (see here) | ✓ | |
flex | ✓ | ||
GNU_Autoconf | ✓ | ||
GNU_Autoconf_Archive | ✓ | ||
GNU_Automake | |||
GNU_Bash | |||
GNU_Bison | |||
GNU_Make | ✓ |
This table shows the dependencies for each supported docset. Additionally, all docsets depend on a POSIX-compliant shell (e.g. bash), make, and sqlite3.
curl | po4a | pup | texinfo | |
---|---|---|---|---|
debmake | ✓ | ✓ | ||
flex | ✓ | ✓ | ✓ | |
GNU_Autoconf | ✓ | ✓ | ||
GNU_Autoconf_Archive | ✓ | ✓ | ✓ | |
GNU_Automake | ✓ | ✓ | ||
GNU_Bash | ✓ | ✓ | ||
GNU_Bison | ✓ | ✓ | ||
GNU_Make | ✓ | ✓ |
.
├── src
│ ├── configs - supported docsets, including metadata and build scripts
│ └── scripts - general purpose scripts
└── tmp - intermediate sources (e.g., upstream sources are downloaded to here)
- Louie Shprung
- Design is based on benzado's gnu-make-dash-docset