doc/html/user-guide/config-tool-invoking.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >Invoking the eCos Configuration Tool</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="eCos User Guide"
  20 HREF="ecos-user-guide.html"><LINK
  21 REL="UP"
  22 TITLE="Getting Started"
  23 HREF="config-tool-getting-started.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="Getting Started"
  26 HREF="config-tool-getting-started.html"><LINK
  27 REL="NEXT"
  28 TITLE="The Component Repository"
  29 HREF="config-tool-component-repository.html"></HEAD
  30 ><BODY
  31 CLASS="SECT1"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >eCos User Guide</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="config-tool-getting-started.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 >Chapter 15. Getting Started</TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="config-tool-component-repository.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><DIV
  81 CLASS="SECT1"
  82 ><H1
  83 CLASS="SECT1"
  84 ><A
  85 NAME="CONFIG-TOOL-INVOKING">Invoking the <SPAN
  86 CLASS="PRODUCTNAME"
  87 >eCos</SPAN
  88 > <SPAN
  89 CLASS="APPLICATION"
  90 >Configuration Tool</SPAN
  91 ></H1
  92 ><DIV
  93 CLASS="SECT2"
  94 ><H2
  95 CLASS="SECT2"
  96 ><A
  97 NAME="AEN967">On Linux</H2
  98 ><P
  99 >Add the <SPAN
 100 CLASS="PRODUCTNAME"
 101 >eCos</SPAN
 102 > <SPAN
 103 CLASS="APPLICATION"
 104 >Configuration Tool</SPAN
 105 > install directory to your PATH, for example:</P
 106 ><TABLE
 107 BORDER="5"
 108 BGCOLOR="#E0E0F0"
 109 WIDTH="70%"
 110 ><TR
 111 ><TD
 112 ><PRE
 113 CLASS="PROGRAMLISTING"
 114 >export PATH=/opt/ecos/ecos<TT
 115 CLASS="REPLACEABLE"
 116 ><I
 117 >&#60;version&#62;</I
 118 ></TT
 119 >/bin:$PATH</PRE
 120 ></TD
 121 ></TR
 122 ></TABLE
 123 ><P
 124 >You may run configtool with zero, one or two arguments. You can specify the <SPAN
 125 CLASS="PRODUCTNAME"
 126 >eCos</SPAN
 127 > repository
 128  location, and/or an <SPAN
 129 CLASS="PRODUCTNAME"
 130 >eCos</SPAN
 131 > save file (extension .ecc) on the command line. The ordering of these
 132 two arguments is not significant. For example:</P
 133 ><TABLE
 134 BORDER="5"
 135 BGCOLOR="#E0E0F0"
 136 WIDTH="70%"
 137 ><TR
 138 ><TD
 139 ><PRE
 140 CLASS="PROGRAMLISTING"
 141 >configtool /opt/ecos/ecos<TT
 142 CLASS="REPLACEABLE"
 143 ><I
 144 >&#60;version&#62;</I
 145 ></TT
 146 >/packages myfile.ecc</PRE
 147 ></TD
 148 ></TR
 149 ></TABLE
 150 ><P
 151 >The <SPAN
 152 CLASS="APPLICATION"
 153 >Configuration Tool</SPAN
 154 > will be displayed (see <A
 155 HREF="config-tool-invoking.html#FIGURE-CONFIGURATION-TOOL"
 156 >Figure 15-1</A
 157 >).</P
 158 ></DIV
 159 ><DIV
 160 CLASS="SECT2"
 161 ><H2
 162 CLASS="SECT2"
 163 ><A
 164 NAME="AEN982">On Windows</H2
 165 ><P
 166 >There are two ways in which to invoke the <SPAN
 167 CLASS="PRODUCTNAME"
 168 >eCos</SPAN
 169 > <SPAN
 170 CLASS="APPLICATION"
 171 >Configuration Tool</SPAN
 172 >:</P
 173 ><P
 174 ></P
 175 ><UL
 176 ><LI
 177 ><P
 178 >             from the desktop explorer or program set up at installation
 179               time (by default
 180               <SPAN
 181 CLASS="emphasis"
 182 ><I
 183 CLASS="EMPHASIS"
 184 >Start</I
 185 ></SPAN
 186 >
 187               -&gt;
 188               <SPAN
 189 CLASS="emphasis"
 190 ><I
 191 CLASS="EMPHASIS"
 192 >Programs</I
 193 ></SPAN
 194 >
 195               -&gt;
 196               <SPAN
 197 CLASS="emphasis"
 198 ><I
 199 CLASS="EMPHASIS"
 200 >eCos</I
 201 ></SPAN
 202 >
 203               -&gt;
 204               <SPAN
 205 CLASS="emphasis"
 206 ><I
 207 CLASS="EMPHASIS"
 208 >Configuration Tool</I
 209 ></SPAN
 210 >
 211               ).</P
 212 ></LI
 213 ><LI
 214 ><P
 215 >type (at a command prompt or in the
 216             <SPAN
 217 CLASS="emphasis"
 218 ><I
 219 CLASS="EMPHASIS"
 220 >Start</I
 221 ></SPAN
 222 >
 223             menu&#8217;s
 224             <SPAN
 225 CLASS="emphasis"
 226 ><I
 227 CLASS="EMPHASIS"
 228 >Run</I
 229 ></SPAN
 230 >
 231             item): &lt;foldername&gt;&#0092;ConfigTool.exe where &lt;foldername&gt; is
 232             the full path of the directory in which you installed the <SPAN
 233 CLASS="PRODUCTNAME"
 234 >eCos</SPAN
 235 >
 236             <SPAN
 237 CLASS="APPLICATION"
 238 >Configuration Tool</SPAN
 239 >.</P
 240 ></LI
 241 ><LI
 242 ><P
 243 >The
 244             <SPAN
 245 CLASS="APPLICATION"
 246 >Configuration Tool</SPAN
 247 >
 248             will be displayed (see <A
 249 HREF="config-tool-invoking.html#FIGURE-CONFIGURATION-TOOL"
 250 >Figure 15-1</A
 251 >).</P
 252 ></LI
 253 ></UL
 254 ><P
 255 >You may run configtool with zero, one or two arguments. You can specify the <SPAN
 256 CLASS="PRODUCTNAME"
 257 >eCos</SPAN
 258 > repository
 259 location, and/or an <SPAN
 260 CLASS="PRODUCTNAME"
 261 >eCos</SPAN
 262 > save file (extension .ecc) on the command line. The ordering of these
 263 two arguments is not significant. For example:</P
 264 ><TABLE
 265 BORDER="5"
 266 BGCOLOR="#E0E0F0"
 267 WIDTH="70%"
 268 ><TR
 269 ><TD
 270 ><PRE
 271 CLASS="PROGRAMLISTING"
 272 >configtool "c:\Program Files\eCos\packages" myfile.ecc</PRE
 273 ></TD
 274 ></TR
 275 ></TABLE
 276 ><P
 277 >If you invoke the configuration tool from the command line with
 278 <SPAN
 279 CLASS="emphasis"
 280 ><I
 281 CLASS="EMPHASIS"
 282 >--help</I
 283 ></SPAN
 284 >, you will see this output:</P
 285 ><TABLE
 286 BORDER="5"
 287 BGCOLOR="#E0E0F0"
 288 WIDTH="70%"
 289 ><TR
 290 ><TD
 291 ><PRE
 292 CLASS="PROGRAMLISTING"
 293 >Usage: eCos Configuration Tool [-h] [-e] [-v] [-c] [input file 1] [input file 2]
 294   -h  --help            displays help on the command line parameters
 295   -e  --edit-only       edit save file only
 296   -v  --version         print version
 297   -c  --compile-help    compile online help only</PRE
 298 ></TD
 299 ></TR
 300 ></TABLE
 301 ><P
 302 >This summarizes valid parameters and switches. Switches are shown with
 303 both short form and long form.</P
 304 ><P
 305 ><SPAN
 306 CLASS="emphasis"
 307 ><I
 308 CLASS="EMPHASIS"
 309 >--help</I
 310 ></SPAN
 311 > shows valid options and parameters, as above.</P
 312 ><P
 313 ><SPAN
 314 CLASS="emphasis"
 315 ><I
 316 CLASS="EMPHASIS"
 317 >--edit-only</I
 318 ></SPAN
 319 > runs the <SPAN
 320 CLASS="APPLICATION"
 321 >Configuration Tool</SPAN
 322 > in a mode that
 323 suppresses creation of a build tree, in case you only want to create and edit save files.</P
 324 ><P
 325 ><SPAN
 326 CLASS="emphasis"
 327 ><I
 328 CLASS="EMPHASIS"
 329 >--version</I
 330 ></SPAN
 331 > shows version and build date information, and exits.</P
 332 ><P
 333 ><SPAN
 334 CLASS="emphasis"
 335 ><I
 336 CLASS="EMPHASIS"
 337 >--compile-help</I
 338 ></SPAN
 339 > compiles help contents files from the HTML documentation
 340 files that the tool finds in the <SPAN
 341 CLASS="PRODUCTNAME"
 342 >eCos</SPAN
 343 > repository, and exits.</P
 344 ><DIV
 345 CLASS="FIGURE"
 346 ><A
 347 NAME="FIGURE-CONFIGURATION-TOOL"><P
 348 ><B
 349 >Figure 15-1. <SPAN
 350 CLASS="APPLICATION"
 351 >Configuration Tool</SPAN
 352 ></B
 353 ></P
 354 ><P
 355 ><IMG
 356 SRC="pix/config-f1.png"></P
 357 ></DIV
 358 ></DIV
 359 ></DIV
 360 ><DIV
 361 CLASS="NAVFOOTER"
 362 ><HR
 363 ALIGN="LEFT"
 364 WIDTH="100%"><TABLE
 365 SUMMARY="Footer navigation table"
 366 WIDTH="100%"
 367 BORDER="0"
 368 CELLPADDING="0"
 369 CELLSPACING="0"
 370 ><TR
 371 ><TD
 372 WIDTH="33%"
 373 ALIGN="left"
 374 VALIGN="top"
 375 ><A
 376 HREF="config-tool-getting-started.html"
 377 ACCESSKEY="P"
 378 >Prev</A
 379 ></TD
 380 ><TD
 381 WIDTH="34%"
 382 ALIGN="center"
 383 VALIGN="top"
 384 ><A
 385 HREF="ecos-user-guide.html"
 386 ACCESSKEY="H"
 387 >Home</A
 388 ></TD
 389 ><TD
 390 WIDTH="33%"
 391 ALIGN="right"
 392 VALIGN="top"
 393 ><A
 394 HREF="config-tool-component-repository.html"
 395 ACCESSKEY="N"
 396 >Next</A
 397 ></TD
 398 ></TR
 399 ><TR
 400 ><TD
 401 WIDTH="33%"
 402 ALIGN="left"
 403 VALIGN="top"
 404 >Getting Started</TD
 405 ><TD
 406 WIDTH="34%"
 407 ALIGN="center"
 408 VALIGN="top"
 409 ><A
 410 HREF="config-tool-getting-started.html"
 411 ACCESSKEY="U"
 412 >Up</A
 413 ></TD
 414 ><TD
 415 WIDTH="33%"
 416 ALIGN="right"
 417 VALIGN="top"
 418 >The Component Repository</TD
 419 ></TR
 420 ></TABLE
 421 ></DIV
 422 ></BODY
 423 ></HTML
 424 >