File: rtl-config.1.html

package info (click to toggle)
rtlinux 3.1pre3-2
links: PTS
area: non-free
in suites: sarge, woody
size: 4,892 kB
ctags: 4,228
sloc: ansic: 26,204; sh: 2,069; makefile: 1,414; perl: 855; tcl: 489; asm: 380; cpp: 42
file content (405 lines) | stat: -rw-r--r-- 5,737 bytes
parent folder | download | duplicates (2)
<HTML
><HEAD
><TITLE
>rtl-config</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"></HEAD
><BODY
CLASS="REFENTRY"
><H1
><A
NAME="AEN1"
>rtl-config</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>rtl-config&nbsp;--&nbsp;script used to get information about the installed
    version of RTLinux </DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
>	<TT
CLASS="FUNCTION"
>rtl-config</TT
> <TT
CLASS="PARAMETER"
><I
>[options]</I
></TT
>
    </PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN12"
></A
><H2
>DESCRIPTION</H2
><P
>       <TT
CLASS="FUNCTION"
>rtl-config</TT
> 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.  
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN16"
></A
><H2
>OPTIONS</H2
><P
><TT
CLASS="FUNCTION"
>rtl-config</TT
> accepts the following
    options (Note that without options,
    <TT
CLASS="FUNCTION"
>rtl-config</TT
> has the same effect as typing
    "<B
CLASS="COMMAND"
>rtl-config --help</B
>")</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><B
CLASS="COMMAND"
>--help</B
></DT
><DD
><P
>prints
        out useful usage information</P
></DD
><DT
><B
CLASS="COMMAND"
>--config=</B
><TT
CLASS="PARAMETER"
><I
>/path/to/config/file</I
></TT
></DT
><DD
><P
>uses the specified file as the new
	configuration file to from which to parse all information
	used</P
></DD
><DT
><B
CLASS="COMMAND"
>--modules</B
></DT
><DD
><P
>returns the full list of RTLinux
        modules</P
></DD
><DT
><B
CLASS="COMMAND"
>--module_dir</B
></DT
><DD
><P
>returns the full path to the RTLinux
        modules</P
></DD
><DT
><B
CLASS="COMMAND"
>--linux</B
></DT
><DD
><P
>returns the full path to the Linux source
        tree</P
></DD
><DT
><B
CLASS="COMMAND"
>--prefix</B
></DT
><DD
><P
>returns the full path to the RTLinux source
        tree</P
></DD
><DT
><B
CLASS="COMMAND"
>--arch</B
></DT
><DD
><P
>returns the machine architecture for which RTLinux was
	compiled</P
></DD
><DT
><B
CLASS="COMMAND"
>--version</B
></DT
><DD
><P
>returns the versions of the
	<TT
CLASS="FUNCTION"
>rtl-config</TT
> script, Linux, and
	RTLinux</P
></DD
><DT
><B
CLASS="COMMAND"
>--rtlVersion</B
></DT
><DD
><P
>returns the version of the RTLinux
	kernel</P
></DD
><DT
><B
CLASS="COMMAND"
>--linuxVersion</B
></DT
><DD
><P
>returns the version of the Linux
	kernel</P
></DD
><DT
><B
CLASS="COMMAND"
>--cc</B
></DT
><DD
><P
>returns
	the name of the compiler used to compile
	RTLinux</P
></DD
><DT
><B
CLASS="COMMAND"
>--docs</B
></DT
><DD
><P
>returns
	the root path to the RTLinux documentation
	directory.</P
></DD
><DT
><B
CLASS="COMMAND"
>--include</B
></DT
><DD
><P
>returns the full list of include file paths used
	        during the compilation process for <I
CLASS="EMPHASIS"
>non Real
		Time</I
> programs. It is presented in a form
		that is acceptable to the compiler (refer to both --cc and
		--rtinclude).
	</P
></DD
><DT
><B
CLASS="COMMAND"
>--rtinclude</B
></DT
><DD
><P
>returns the full list of include file paths used
               	during the compilation process of <I
CLASS="EMPHASIS"
>Real
		Time</I
> programs. It is presented in a form
		acceptable to the compiler (refer to both --cc and
		--include).
	</P
></DD
><DT
><B
CLASS="COMMAND"
>--cflags</B
></DT
><DD
><P
>returns the full list of optimization flags, and
               general other C flags necessary to compile the user's
               RT modules in C</P
></DD
><DT
><B
CLASS="COMMAND"
>--cppflags</B
></DT
><DD
><P
>returns the full list of optimization flags, and
               general other flags necessary to compile the user's RT
               modules in C++ </P
></DD
><DT
><B
CLASS="COMMAND"
>--mk</B
></DT
><DD
><P
>prints to
               <TT
CLASS="FILENAME"
>stdout</TT
> 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.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN113"
></A
><H2
>EXAMPLES</H2
><P
>The following example demonstrates a typical usage of
      <TT
CLASS="FUNCTION"
>rtl-config</TT
>.  It compiles the user's
      <TT
CLASS="FILENAME"
>my_module.c</TT
> with all the necessary flags,
      include file paths, libraries, and optimization flags:</P
><P
><B
CLASS="COMMAND"
>gcc -c `rtl-config --cflags` my_module.c</B
></P
><P
>The following example creates a Makefile compatible include
       file rtl.mk in the user's "Projects" directory:</P
><P
><B
CLASS="COMMAND"
>rtl-config --mk &#62; Projects/rtl.mk</B
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN123"
></A
><H2
>RETURN VALUE</H2
><P
>     <TT
CLASS="FUNCTION"
>rtl-config</TT
> returns 0 on success and a
     non-zero error code on error.
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN127"
></A
><H2
>NOTES</H2
><P
>     Unless the <TT
CLASS="USERINPUT"
><B
>--config=...</B
></TT
> option is specified
       at the command line, this script extracts its information from
       the file <TT
CLASS="FILENAME"
>/usr/include/rtlinux/rtl.config</TT
>
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN132"
></A
><H2
>AUTHOR</H2
><P
>Edgar F. Hilton (<A
HREF="mailto:efhilton@fsmlabs.com"
TARGET="_top"
>efhilton@fsmlabs.com</A
>)
    </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN136"
></A
><H2
>SEE ALSO</H2
><A
HREF="rtlinux.1.html"
TARGET="_top"
>rtlinux(1)</A
><P
>2001 FSMLabs Inc.</P
><P
>All rights reserved.</P
></DIV
></BODY
></HTML
>