rtl-config

Name

rtl-config -- script used to get information about the installed version of RTLinux

Synopsis

	rtl-config [options]
    

DESCRIPTION

rtl-config is a tool that is used to determine the compiler and linker flags that should be used to compile and link programs that use RTLinux.

OPTIONS

rtl-config accepts the following options (Note that without options, rtl-config has the same effect as typing "rtl-config --help")

--help

prints out useful usage information

--config=/path/to/config/file

uses the specified file as the new configuration file to from which to parse all information used

--modules

returns the full list of RTLinux modules

--module_dir

returns the full path to the RTLinux modules

--linux

returns the full path to the Linux source tree

--prefix

returns the full path to the RTLinux source tree

--arch

returns the machine architecture for which RTLinux was compiled

--version

returns the versions of the rtl-config script, Linux, and RTLinux

--rtlVersion

returns the version of the RTLinux kernel

--linuxVersion

returns the version of the Linux kernel

--cc

returns the name of the compiler used to compile RTLinux

--docs

returns the root path to the RTLinux documentation directory.

--include

returns the full list of include file paths used during the compilation process for non Real Time programs. It is presented in a form that is acceptable to the compiler (refer to both --cc and --rtinclude).

--rtinclude

returns the full list of include file paths used during the compilation process of Real Time programs. It is presented in a form acceptable to the compiler (refer to both --cc and --include).

--cflags

returns the full list of optimization flags, and general other C flags necessary to compile the user's RT modules in C

--cppflags

returns the full list of optimization flags, and general other flags necessary to compile the user's RT modules in C++

--mk

prints to stdout a full Makefile-compatible file that can be included into the user's Makefiles. This output is a replica of the old rtl.mk file that has been available since older RTLinux distributions.

EXAMPLES

The following example demonstrates a typical usage of rtl-config. It compiles the user's my_module.c with all the necessary flags, include file paths, libraries, and optimization flags:

gcc -c `rtl-config --cflags` my_module.c

The following example creates a Makefile compatible include file rtl.mk in the user's "Projects" directory:

rtl-config --mk > Projects/rtl.mk

RETURN VALUE

rtl-config returns 0 on success and a non-zero error code on error.

NOTES

Unless the --config=... option is specified at the command line, this script extracts its information from the file /usr/include/rtlinux/rtl.config

AUTHOR

Edgar F. Hilton (efhilton@fsmlabs.com)

SEE ALSO

rtlinux(1)

2001 FSMLabs Inc.

All rights reserved.