luke
/
iverilog
mirror of https://github.com/steveicarus/iverilog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix code snippet formatting in INSTALL

This commit is contained in:
DeflateAwning 2023-11-03 14:53:58 -06:00
parent 77d7f0b8f7
commit b47b57e52f
1 changed files with 80 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
INSTALL
View File

@ -3,50 +3,50 @@ Basic Installation
These are generic installation instructions. These are generic installation instructions.
The `configure' shell script attempts to guess correct values for The `configure` shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package. those values to create a `Makefile` in each directory of the package.
It may also create one or more `.h' files containing system-dependent It may also create one or more `.h` files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that definitions. Finally, it creates a shell script `config.status` that
you can run in the future to recreate the current configuration, a file you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up `config.cache` that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output reconfiguring, and a file `config.log` containing compiler output
(useful mainly for debugging `configure'). (useful mainly for debugging `configure`).
If you need to do unusual things to compile the package, please try If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail to figure out how `configure` could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can diffs or instructions to the address given in the `README` so they can
be considered for the next release. If at some point `config.cache' be considered for the next release. If at some point `config.cache`
contains results you don't want to keep, you may remove or edit it. contains results you don't want to keep, you may remove or edit it.
The file `configure.ac' is used to create `configure' by a program The file `configure.ac` is used to create `configure` by a program
called `autoconf'. You only need `configure.ac' if you want to change called `autoconf`. You only need `configure.ac` if you want to change
it or regenerate `configure' using a newer version of `autoconf'. it or regenerate `configure` using a newer version of `autoconf`.
The simplest way to compile this package is: The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type 1. `cd` to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're `./configure` to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type using `csh` on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute `sh ./configure` instead to prevent `csh` from trying to execute
`configure' itself. `configure` itself.
Running `configure' takes awhile. While running, it prints some Running `configure` takes awhile. While running, it prints some
messages telling which features it is checking for. messages telling which features it is checking for.
2. Type `make' to compile the package. 2. Type `make` to compile the package.
3. Optionally, type `make check' to run any self-tests that come with 3. Optionally, type `make check` to run any self-tests that come with
the package. the package.
4. Type `make install' to install the programs and any data files and 4. Type `make install` to install the programs and any data files and
documentation. documentation.
5. You can remove the program binaries and object files from the 5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the source code directory by typing `make clean`. To also remove the
files that `configure' created (so you can compile the package for files that `configure` created (so you can compile the package for
a different kind of computer), type `make distclean'. There is a different kind of computer), type `make distclean`. There is
also a `make maintainer-clean' target, but that is intended mainly also a `make maintainer-clean` target, but that is intended mainly
for the package's developers. If you use it, you may have to get for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came all sorts of other programs in order to regenerate files that came
with the distribution. with the distribution.
@ -55,13 +55,13 @@ Compilers and Options
===================== =====================
Some systems require unusual options for compilation or linking that Some systems require unusual options for compilation or linking that
the `configure' script does not know about. You can give `configure' the `configure` script does not know about. You can give `configure`
initial values for variables by setting them in the environment. Using initial values for variables by setting them in the environment. Using
a Bourne-compatible shell, you can do that on the command line like a Bourne-compatible shell, you can do that on the command line like
this: this:
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
Or on systems that have the `env' program, you can do it like this: Or on systems that have the `env` program, you can do it like this:
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
Compiling For Multiple Architectures Compiling For Multiple Architectures
@ -69,112 +69,112 @@ Compiling For Multiple Architectures
You can compile the package for more than one kind of computer at the You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that own directory. To do this, you must use a version of `make` that
supports the `VPATH' variable, such as GNU `make'. `cd' to the supports the `VPATH` variable, such as GNU `make`. `cd` to the
directory where you want the object files and executables to go and run directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the the `configure` script. `configure` automatically checks for the
source code in the directory that `configure' is in and in `..'. source code in the directory that `configure` is in and in `..`.
If you have to use a `make' that does not supports the `VPATH' If you have to use a `make` that does not supports the `VPATH`
variable, you have to compile the package for one architecture at a time variable, you have to compile the package for one architecture at a time
in the source code directory. After you have installed the package for in the source code directory. After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another one architecture, use `make distclean` before reconfiguring for another
architecture. architecture.
Installation Names Installation Names
================== ==================
By default, `make install' will install the package's files in By default, `make install` will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an `/usr/local/bin`, `/usr/local/man`, etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the installation prefix other than `/usr/local` by giving `configure` the
option `--prefix=PATH'. option `--prefix=PATH`.
You can specify separate installation prefixes for You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use give `configure` the option `--exec-prefix=PATH`, the package will use
PATH as the prefix for installing programs and libraries. PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix. Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular options like `--bindir=PATH` to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories kinds of files. Run `configure --help` for a list of the directories
you can set and what kinds of files go in them. you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the with an extra prefix or suffix on their names by giving `configure` the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. option `--program-prefix=PREFIX` or `--program-suffix=SUFFIX`.
Optional Features Optional Features
================= =================
Some packages pay attention to `--enable-FEATURE' options to Some packages pay attention to `--enable-FEATURE` options to
`configure', where FEATURE indicates an optional part of the package. `configure`, where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE They may also pay attention to `--with-PACKAGE` options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The is something like `gnu-as` or `x` (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the `README` should mention any `--enable-` and `--with-` options that the
package recognizes. package recognizes.
For packages that use the X Window System, `configure' can usually For packages that use the X Window System, `configure` can usually
find the X include and library files automatically, but if it doesn't, find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and you can use the `configure` options `--x-includes=DIR` and
`--x-libraries=DIR' to specify their locations. `--x-libraries=DIR` to specify their locations.
Specifying the System Type Specifying the System Type
========================== ==========================
There may be some features `configure' can not figure out There may be some features `configure` can not figure out
automatically, but needs to determine by the type of host the package automatically, but needs to determine by the type of host the package
will run on. Usually `configure' can figure that out, but if it prints will run on. Usually `configure` can figure that out, but if it prints
a message saying it can not guess the host type, give it the a message saying it can not guess the host type, give it the
`--host=TYPE' option. TYPE can either be a short name for the system `--host=TYPE` option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields: type, such as `sun4`, or a canonical name with three fields:
CPU-COMPANY-SYSTEM CPU-COMPANY-SYSTEM
See the file `config.sub' for the possible values of each field. If See the file `config.sub` for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't `config.sub` isn't included in this package, then this package doesn't
need to know the host type. need to know the host type.
If you are building compiler tools for cross-compiling, you can also If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will use the `--target=TYPE` option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of produce code for and the `--build=TYPE` option to select the type of
system on which you are compiling the package. system on which you are compiling the package.
Sharing Defaults Sharing Defaults
================ ================
If you want to set default values for `configure' scripts to share, If you want to set default values for `configure` scripts to share,
you can create a site shell script called `config.site' that gives you can create a site shell script called `config.site` that gives
default values for variables like `CC', `cache_file', and `prefix'. default values for variables like `CC`, `cache_file`, and `prefix`.
`configure' looks for `PREFIX/share/config.site' if it exists, then `configure` looks for `PREFIX/share/config.site` if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the `PREFIX/etc/config.site` if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script. `CONFIG_SITE` environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script. A warning: not all `configure` scripts look for a site script.
Operation Controls Operation Controls
================== ==================
`configure' recognizes the following options to control how it `configure` recognizes the following options to control how it
operates. operates.
`--cache-file=FILE' `--cache-file=FILE`
Use and save the results of the tests in FILE instead of Use and save the results of the tests in FILE instead of
`./config.cache'. Set FILE to `/dev/null' to disable caching, for `./config.cache`. Set FILE to `/dev/null` to disable caching, for
debugging `configure'. debugging `configure`.
`--help' `--help`
Print a summary of the options to `configure', and exit. Print a summary of the options to `configure`, and exit.
`--quiet' `--quiet`
`--silent' `--silent`
`-q' `-q`
Do not print messages saying which checks are being made. Do not print messages saying which checks are being made.
`--srcdir=DIR' `--srcdir=DIR`
Look for the package's source code in directory DIR. Usually Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically. `configure` can determine that directory automatically.
`--version' `--version`
Print the version of Autoconf used to generate the `configure' Print the version of Autoconf used to generate the `configure`
script, and exit. script, and exit.
`configure' also accepts some other, not widely useful, options. `configure` also accepts some other, not widely useful, options.