File: rtl-config.1

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 (180 lines) | stat: -rw-r--r-- 4,720 bytes parent folder | download | duplicates (2)
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
.\" This -*- nroff -*- file has been generated from
.\" DocBook SGML with docbook-to-man on Debian GNU/Linux.
...\"
...\"	transcript compatibility for postscript use.
...\"
...\"	synopsis:  .P! <file.ps>
...\"
.de P!
\\&.
.fl			\" force out current output buffer
\\!%PB
\\!/showpage{}def
...\" the following is from Ken Flowers -- it prevents dictionary overflows
\\!/tempdict 200 dict def tempdict begin
.fl			\" prolog
.sy cat \\$1\" bring in postscript file
...\" the following line matches the tempdict above
\\!end % tempdict %
\\!PE
\\!.
.sp \\$2u	\" move below the image
..
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n  
.TH "rtl-config" "1" 
.SH "NAME" 
rtl-config \(em script used to get information about the installed 
version of RTLinux  
.SH "SYNOPSIS" 
.PP 
.nf 
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
\fBrtl-config\fP \fB[options]\fR      
.fi 
.SH "DESCRIPTION" 
.PP 
\fBrtl-config\fP 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.   
 
.SH "OPTIONS" 
.PP 
\fBrtl-config\fP accepts the following 
options (Note that without options, 
\fBrtl-config\fP has the same effect as typing 
"\fBrtl-config --help\fP") 
.IP "\fB--help\fP" 10 
prints 
out useful usage information 
.IP "\fB--config=\fP\fB/path/to/config/file\fR" 10 
uses the specified file as the new 
configuration file to from which to parse all information 
used 
.IP "\fB--modules\fP" 10 
returns the full list of RTLinux 
modules 
.IP "\fB--module_dir\fP" 10 
returns the full path to the RTLinux 
modules 
.IP "\fB--linux\fP" 10 
returns the full path to the Linux source 
tree 
.IP "\fB--prefix\fP" 10 
returns the full path to the RTLinux source 
tree 
.IP "\fB--arch\fP" 10 
returns the machine architecture for which RTLinux was 
compiled 
.IP "\fB--version\fP" 10 
returns the versions of the 
\fBrtl-config\fP script, Linux, and 
RTLinux 
.IP "\fB--rtlVersion\fP" 10 
returns the version of the RTLinux 
kernel 
.IP "\fB--linuxVersion\fP" 10 
returns the version of the Linux 
kernel 
.IP "\fB--cc\fP" 10 
returns 
the name of the compiler used to compile 
RTLinux 
.IP "\fB--docs\fP" 10 
returns 
the root path to the RTLinux documentation 
directory. 
.IP "\fB--include\fP" 10 
returns the full list of include file paths used 
during the compilation process for \fInon Real 
Time\fP programs. It is presented in a form 
that is acceptable to the compiler (refer to both --cc and 
--rtinclude). 
 
.IP "\fB--rtinclude\fP" 10 
returns the full list of include file paths used 
during the compilation process of \fIReal 
Time\fP programs. It is presented in a form 
acceptable to the compiler (refer to both --cc and 
--include). 
 
.IP "\fB--cflags\fP" 10 
returns the full list of optimization flags, and 
general other C flags necessary to compile the user's 
RT modules in C 
.IP "\fB--cppflags\fP" 10 
returns the full list of optimization flags, and 
general other flags necessary to compile the user's RT 
modules in C++  
.IP "\fB--mk\fP" 10 
prints to 
\fBstdout\fP 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. 
.SH "EXAMPLES" 
.PP 
The following example demonstrates a typical usage of 
\fBrtl-config\fP.  It compiles the user's 
\fBmy_module.c\fP with all the necessary flags, 
include file paths, libraries, and optimization flags: 
.PP 
\fBgcc -c `rtl-config --cflags` my_module.c\fP 
.PP 
The following example creates a Makefile compatible include 
file rtl.mk in the user's "Projects" directory: 
.PP 
\fBrtl-config --mk > Projects/rtl.mk\fP 
.SH "RETURN VALUE" 
.PP 
\fBrtl-config\fP returns 0 on success and a 
non-zero error code on error. 
 
.SH "NOTES" 
.PP 
Unless the \fB--config=...\fP option is specified 
at the command line, this script extracts its information from 
the file \fB/usr/include/rtlinux/rtl.config\fP      
.SH "AUTHOR" 
.PP 
Edgar F. Hilton (\fIefhilton@fsmlabs.com (link to URL mailto:efhilton@fsmlabs.com) \fR) 
 
.SH "SEE ALSO" 
\fIrtlinux(1) (link to URL rtlinux.1.html) \fR 
.PP 
\(co2001 FSMLabs Inc. 
.PP 
All rights reserved. 
...\" created by instant / docbook-to-man, Wed 13 Jun 2001, 17:58