summaryrefslogtreecommitdiffstats
path: root/share/doc/install
blob: b97fe37f700f6b10000098ab1afa2bae17807da0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
Name
       Install - instructions for installing library into the system

Synopsis
       sudo make [-j] install [prefix=...] [DESTDIR=...] [...]
       make [-j] installcheck [...]

Description
   Install manually from source
       In most cases, you just want to install the entire library.  To install
       all the files in the default system directories (per GNU guidelines),
       use:

           $ make               # optional
           $ sudo make install
           $ make installcheck  # optional

       You can install in parallel if you want.  A few features can be used to
       tweak the install:

       Variables
           There are many variables available with which you can tweak
           the build system.  Most of them are directory variables and
           command variables, based on the GNU Coding Standards.  Others
           are specially designed for this project.  To see the
           available variables, use:

               $ make help-variables

       Uninstall
            TODO

       Targets
            There are targets for more granular control, such as 'install-dev'.
            See the help to know all of them:

                $ make help

   Dependencies
       There are no run-time dependencies other than libc.  To learn the
       build dependencies of the project, run

           $ find share/mk/ -type f \
           | xargs grep include.*configure/build-depends/ \
           | sed 's,share/mk/,,' \
           | sed 's,/.*:,:,' \
           | sed 's,include $.*/, ,' \
           | sed 's,\.mk,,g' \
           | sort \
           | uniq;

   Lint
       You can lint the source code.  See 'make help' for a list of targets
       that can be used.

Files
   GNUmakefile
   share/mk/
       Build system.

   include/a2i/
       Header files.

   src/a2i/
       Source files.

   lib/pkgconfig/*.pc
       pc(5) file.

   /usr/local/include/a2i/
       Installed header files.

   /usr/local/lib/liba2i.a
       Static library.

   /usr/local/lib/liba2i.so*
       Shared library.

   /usr/local/share/pkgconfig/liba2i.pc
       Installed pc(5) file.

Standards
       <https://www.gnu.org/prep/standards/html_node/Directory-Variables.html>.
       <https://www.gnu.org/prep/standards/html_node/Command-Variables.html>.
       <https://refspecs.linuxfoundation.org/FHS_3.0/fhs/index.html>