diff options
Diffstat (limited to '')
| -rw-r--r-- | INSTALL | 71 |
1 files changed, 10 insertions, 61 deletions
@@ -2,7 +2,7 @@ Name Install - instructions for installing the pages into the system Synopsis - sudo make [-j] install [V=1] [prefix=ARG] [DESTDIR=ARG] [...] + sudo make [-j] install [prefix=ARG] [DESTDIR=ARG] [...] Description (a) Use a package manager @@ -46,17 +46,13 @@ Description are specially designed for this project. To see all of the available variables, use: - $ make help-variables + $ make help The most common ones that you may use are: - DESTDIR - prefix - Use V=1 for a more verbose output from the makefiles: - - $ sudo make install V=1 - Uninstall You can uninstall the pages with the following command (but see the "Caveats" section below): @@ -70,60 +66,13 @@ Description $ make help Dependencies - - Build-depends: - - Generic: - - echo(1) - - expr(1) - - find(1) - - grep(1) - - locale(1) - - make(1) - GNU Make is required. - - sed(1) - - sort(1) - - xargs(1) - - - For installing: - - gzip(1) - - install(1) - - ln(1) - - sponge(1) - - test(1) - - - For uninstalling / cleaning: - - rm(1) - - rmdir(1) - - - For linting/building/checking man(7) source: - - eqn(1) - - grotty(1) - - head(1) - - mkdir(1) - - tail(1) - - tbl(1) - - troff(1) >= 1.23.0 - GNU troff is required. - - - For linting/building C source: - - cc(1) - GCC or Clang - - clang-tidy(1) - - cpplint(1) - - iwyu(1) - - mandoc(1) - - mkdir(1) - - pkg-config(1) - - tac(1) - - libbsd-dev - - And one that isn't packaged, but can be extracted from the - Linux kernel source tree in <scripts/checkpatch.pl>: - - - checkpatch(1) - - - For building HTML pages: - - man2html(1) - - - Depends: - - man(1) - - groff(1) | mandoc(1) + To see the build-dependencies of the project, that is, the + dependencies of the build system, see `make help`. + + To read the manual pages, you'll need: + + - man(1) + - groff(1) | mandoc(1) Lint & check You can lint and check both the manual pages, and the example C @@ -131,7 +80,7 @@ Description targets that can be used. Files - Makefile, share/mk/install-man.mk, share/mk/install.mk + GNUmakefile, share/mk/install-man.mk, share/mk/install.mk Main makefiles for installing (however, others may also be used by inclusion). |