KBookReader – eBook reader
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

188 lines
7.3 KiB

  1. Basic Installation
  2. ==================
  3. Kbookreader relies on cmake to build.
  4. Here are suggested default options:
  5. -DCMAKE_INSTALL_PREFIX="/opt/trinity" \
  6. -DCONFIG_INSTALL_DIR="/etc/trinity" \
  7. -DSYSCONF_INSTALL_DIR="/etc/trinity" \
  8. -DXDG_MENU_INSTALL_DIR="/etc/xdg/menus" \
  9. -DCMAKE_BUILD_TYPE=RelWithDebInfo \
  12. -DBUILD_ALL="ON" \
  14. ##### the following instructions, kept as a reference, are basically obsolete - October 08 2019 #####
  15. These are generic installation instructions.
  16. The `configure' shell script attempts to guess correct values for
  17. various system-dependent variables used during compilation. It uses
  18. those values to create a `Makefile' in each directory of the package.
  19. It may also create one or more `.h' files containing system-dependent
  20. definitions. Finally, it creates a shell script `config.status' that
  21. you can run in the future to recreate the current configuration, a file
  22. `config.cache' that saves the results of its tests to speed up
  23. reconfiguring, and a file `config.log' containing compiler output
  24. (useful mainly for debugging `configure').
  25. If you need to do unusual things to compile the package, please try
  26. to figure out how `configure' could check whether to do them, and mail
  27. diffs or instructions to the address given in the `README' so they can
  28. be considered for the next release. If at some point `config.cache'
  29. contains results you don't want to keep, you may remove or edit it.
  30. The file `configure.in' is used to create `configure' by a program
  31. called `autoconf'. You only need `configure.in' if you want to change
  32. it or regenerate `configure' using a newer version of `autoconf'.
  33. The simplest way to compile this package is:
  34. 1. `cd' to the directory containing the package's source code and type
  35. `./configure' to configure the package for your system. If you're
  36. using `csh' on an old version of System V, you might need to type
  37. `sh ./configure' instead to prevent `csh' from trying to execute
  38. `configure' itself.
  39. Running `configure' takes a while. While running, it prints some
  40. messages telling which features it is checking for.
  41. 2. Type `make' to compile the package.
  42. 3. Type `make install' to install the programs and any data files and
  43. documentation.
  44. 4. You can remove the program binaries and object files from the
  45. source code directory by typing `make clean'.
  46. Compilers and Options
  47. =====================
  48. Some systems require unusual options for compilation or linking that
  49. the `configure' script does not know about. You can give `configure'
  50. initial values for variables by setting them in the environment. Using
  51. a Bourne-compatible shell, you can do that on the command line like
  52. this:
  53. CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  54. Or on systems that have the `env' program, you can do it like this:
  55. env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  56. Compiling For Multiple Architectures
  57. ====================================
  58. You can compile the package for more than one kind of computer at the
  59. same time, by placing the object files for each architecture in their
  60. own directory. To do this, you must use a version of `make' that
  61. supports the `VPATH' variable, such as GNU `make'. `cd' to the
  62. directory where you want the object files and executables to go and run
  63. the `configure' script. `configure' automatically checks for the
  64. source code in the directory that `configure' is in and in `..'.
  65. If you have to use a `make' that does not supports the `VPATH'
  66. variable, you have to compile the package for one architecture at a time
  67. in the source code directory. After you have installed the package for
  68. one architecture, use `make distclean' before reconfiguring for another
  69. architecture.
  70. Installation Names
  71. ==================
  72. By default, `make install' will install the package's files in
  73. `/usr/local/bin', `/usr/local/man', etc. You can specify an
  74. installation prefix other than `/usr/local' by giving `configure' the
  75. option `--prefix=PATH'.
  76. You can specify separate installation prefixes for
  77. architecture-specific files and architecture-independent files. If you
  78. give `configure' the option `--exec-prefix=PATH', the package will use
  79. PATH as the prefix for installing programs and libraries.
  80. Documentation and other data files will still use the regular prefix.
  81. If the package supports it, you can cause programs to be installed
  82. with an extra prefix or suffix on their names by giving `configure' the
  83. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  84. Optional Features
  85. =================
  86. Some packages pay attention to `--enable-FEATURE' options to
  87. `configure', where FEATURE indicates an optional part of the package.
  88. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  89. is something like `gnu-as' or `x' (for the X Window System). The
  90. `README' should mention any `--enable-' and `--with-' options that the
  91. package recognizes.
  92. For packages that use the X Window System, `configure' can usually
  93. find the X include and library files automatically, but if it doesn't,
  94. you can use the `configure' options `--x-includes=DIR' and
  95. `--x-libraries=DIR' to specify their locations.
  96. Specifying the System Type
  97. ==========================
  98. There may be some features `configure' can not figure out
  99. automatically, but needs to determine by the type of host the package
  100. will run on. Usually `configure' can figure that out, but if it prints
  101. a message saying it can not guess the host type, give it the
  102. `--host=TYPE' option. TYPE can either be a short name for the system
  103. type, such as `sun4', or a canonical name with three fields:
  105. See the file `config.sub' for the possible values of each field. If
  106. `config.sub' isn't included in this package, then this package doesn't
  107. need to know the host type.
  108. If you are building compiler tools for cross-compiling, you can also
  109. use the `--target=TYPE' option to select the type of system they will
  110. produce code for and the `--build=TYPE' option to select the type of
  111. system on which you are compiling the package.
  112. Sharing Defaults
  113. ================
  114. If you want to set default values for `configure' scripts to share,
  115. you can create a site shell script called `config.site' that gives
  116. default values for variables like `CC', `cache_file', and `prefix'.
  117. `configure' looks for `PREFIX/share/config.site' if it exists, then
  118. `PREFIX/etc/config.site' if it exists. Or, you can set the
  119. `CONFIG_SITE' environment variable to the location of the site script.
  120. A warning: not all `configure' scripts look for a site script.
  121. Operation Controls
  122. ==================
  123. `configure' recognizes the following options to control how it
  124. operates.
  125. `--cache-file=FILE'
  126. Use and save the results of the tests in FILE instead of
  127. `./config.cache'. Set FILE to `/dev/null' to disable caching, for
  128. debugging `configure'.
  129. `--help'
  130. Print a summary of the options to `configure', and exit.
  131. `--quiet'
  132. `--silent'
  133. `-q'
  134. Do not print messages saying which checks are being made.
  135. `--srcdir=DIR'
  136. Look for the package's source code in directory DIR. Usually
  137. `configure' can determine that directory automatically.
  138. `--version'
  139. Print the version of Autoconf used to generate the `configure'
  140. script, and exit.
  141. `configure' also accepts some other, not widely useful, options.