Skip to content

Commit 43b5e0c

Browse files
committed
Update build-system.md: Align with Makefile
1 parent f440187 commit 43b5e0c

1 file changed

Lines changed: 21 additions & 15 deletions

File tree

docs/build-system.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ make help
2626
which will show
2727

2828
```
29-
Usage: make [CXX=c++] [CXX_STANDARD=c++23] [target]
29+
Usage: make [CXX=c++] [CXX_STANDARD=c++23] [INST_DIR=/usr/local/bin]
30+
[MAN_DIR=/usr/local/share/man/man1] [ARGS] [target=all]
3031
3132
Targets:
3233
all - Build release version (default)
@@ -38,33 +39,38 @@ Targets:
3839
test - Build and test release version
3940
test-release - Build and test release version
4041
test-debug - Build and test debug version
41-
install - Build and install release version
42-
uninstall - Remove installed program
42+
install - Install program and man page
43+
uninstall - Uninstall program and man page
4344
clean - Remove release and debug build files
4445
clean-release - Remove release build files
4546
clean-debug - Remove debug build files
4647
show - Show operating system and compiler info
4748
show-os - Show operating system info
4849
show-compiler - Show compiler info
50+
show-version - Show version number
4951
help - Show this help message and exit
5052
5153
Variables:
5254
CXX - C++ compiler (default: c++).
5355
CXX_STANDARD - C++ standard (default: c++23).
54-
PREFIX - Installation prefix (default: /usr/local)
55-
INSTALL_DIR - Installation directory (default: $PREFIX/bin)
56+
INST_DIR - Install dir for program (default: /usr/local/bin)
57+
MAN_DIR - Install dir for man page (default: /usr/local/share/man/man1)
58+
ARGS - Command-line arguments to forward to program
5659
5760
Examples:
58-
make # Build release version
59-
make all # Build release version
60-
make release # Build release version
61-
make debug # Build debug version
62-
make run-debug # Build and run debug version
63-
make test-debug # Build and test debug version
64-
make CXX=g++ # Build with g++ compiler
65-
make CXX_STANDARD=c++20 # Build with C++20 standard
66-
make PREFIX=/opt/local install # Install to /opt/local/bin
67-
make PREFIX=/opt/local uninstall # Remove program from /opt/local/bin
61+
make # Build release version
62+
make all # Build release version
63+
make release # Build release version
64+
make debug # Build debug version
65+
make run-debug # Build and run debug version
66+
make test-debug # Build and test debug version
67+
make CXX=g++ # Build with g++ compiler
68+
make CXX_STANDARD=c++20 # Build with C++20 standard
69+
make INST_DIR=/tmp install # Install to /tmp
70+
make INST_DIR=/tmp uninstall # Uninstall from /tmp
71+
make MAN_DIR=/tmp install # Install, saving man page to /tmp
72+
make MAN_DIR=/tmp uninstall # Uninstall, removing man page from /tmp
73+
make ARGS=--help run-debug # Run debug-version program with --help
6874
```
6975

7076
---

0 commit comments

Comments
 (0)