doc/html/ref/help-command.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 >help</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 Reference Manual"
  20 HREF="ecos-ref.html"><LINK
  21 REL="UP"
  22 TITLE="Common Commands"
  23 HREF="common-commands.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="dump"
  26 HREF="dump-command.html"><LINK
  27 REL="NEXT"
  28 TITLE="ip_address"
  29 HREF="ip-address-command.html"></HEAD
  30 ><BODY
  31 CLASS="REFENTRY"
  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 Reference Manual</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="dump-command.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 ></TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="ip-address-command.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><H1
  81 ><A
  82 NAME="HELP-COMMAND">help</H1
  83 ><DIV
  84 CLASS="REFNAMEDIV"
  85 ><A
  86 NAME="AEN3316"
  87 ></A
  88 ><H2
  89 >Name</H2
  90 >help&nbsp;--&nbsp;Display help on available commands</DIV
  91 ><DIV
  92 CLASS="REFSYNOPSISDIV"
  93 ><A
  94 NAME="AEN3319"><H2
  95 >Synopsis</H2
  96 ><P
  97 ><B
  98 CLASS="COMMAND"
  99 >help</B
 100 >  [<TT
 101 CLASS="REPLACEABLE"
 102 ><I
 103 > topic</I
 104 ></TT
 105 >]</P
 106 ></DIV
 107 ><DIV
 108 CLASS="REFSECT1"
 109 ><A
 110 NAME="AEN3324"
 111 ></A
 112 ><H2
 113 >Arguments</H2
 114 ><DIV
 115 CLASS="INFORMALTABLE"
 116 ><A
 117 NAME="AEN3326"><P
 118 ></P
 119 ><TABLE
 120 BORDER="1"
 121 CLASS="CALSTABLE"
 122 ><THEAD
 123 ><TR
 124 ><TH
 125 WIDTH="25%"
 126 ALIGN="LEFT"
 127 VALIGN="TOP"
 128 >Name</TH
 129 ><TH
 130 WIDTH="25%"
 131 ALIGN="LEFT"
 132 VALIGN="TOP"
 133 >Type</TH
 134 ><TH
 135 WIDTH="25%"
 136 ALIGN="LEFT"
 137 VALIGN="TOP"
 138 >Description</TH
 139 ><TH
 140 WIDTH="25%"
 141 ALIGN="LEFT"
 142 VALIGN="TOP"
 143 >Default</TH
 144 ></TR
 145 ></THEAD
 146 ><TBODY
 147 ><TR
 148 ><TD
 149 WIDTH="25%"
 150 ALIGN="LEFT"
 151 VALIGN="TOP"
 152 ><TT
 153 CLASS="REPLACEABLE"
 154 ><I
 155 >topic</I
 156 ></TT
 157 ></TD
 158 ><TD
 159 WIDTH="25%"
 160 ALIGN="LEFT"
 161 VALIGN="TOP"
 162 >String</TD
 163 ><TD
 164 WIDTH="25%"
 165 ALIGN="LEFT"
 166 VALIGN="TOP"
 167 >Which command to provide help for.</TD
 168 ><TD
 169 WIDTH="25%"
 170 ALIGN="LEFT"
 171 VALIGN="TOP"
 172 >All commands</TD
 173 ></TR
 174 ></TBODY
 175 ></TABLE
 176 ><P
 177 ></P
 178 ></DIV
 179 ></DIV
 180 ><DIV
 181 CLASS="REFSECT1"
 182 ><A
 183 NAME="AEN3345"
 184 ></A
 185 ><H2
 186 >Description</H2
 187 ><P
 188 >The <B
 189 CLASS="COMMAND"
 190 >help</B
 191 > command displays information about the available
 192 RedBoot commands.  If a <SPAN
 193 CLASS="emphasis"
 194 ><I
 195 CLASS="EMPHASIS"
 196 >topic</I
 197 ></SPAN
 198 > is given, then the display
 199 is restricted to information about that specific command.
 200       </P
 201 ><P
 202 >If the command has sub-commands, e.g. <B
 203 CLASS="COMMAND"
 204 >fis</B
 205 >, then the topic
 206 specific display will print additional information about the available sub-commands.
 207 special (ICMP) packets to a specific host. These packets should be automatically
 208 returned by that host. The command will indicate how many of these round-trips
 209 were successfully completed.
 210       </P
 211 ></DIV
 212 ><DIV
 213 CLASS="REFSECT1"
 214 ><A
 215 NAME="AEN3352"
 216 ></A
 217 ><H2
 218 >Examples</H2
 219 ><P
 220 >Show generic help.  Note that the contents of this display will depend on the various configuration
 221 options for RedBoot when it was built.
 222 <TABLE
 223 BORDER="5"
 224 BGCOLOR="#E0E0F0"
 225 WIDTH="70%"
 226 ><TR
 227 ><TD
 228 ><PRE
 229 CLASS="SCREEN"
 230 >RedBoot&#62; <TT
 231 CLASS="USERINPUT"
 232 ><B
 233 >help</B
 234 ></TT
 235 >
 236 Manage aliases kept in FLASH memory
 237    alias name [value]
 238 Manage machine caches
 239    cache [ON | OFF]
 240 Display/switch console channel
 241    channel [-1|&lt;channel number&gt;]
 242 Compute a 32bit checksum [POSIX algorithm] for a range of memory
 243    cksum -b &lt;location&gt; -l &lt;length&gt;
 244 Display (hex dump) a range of memory
 245    dump -b &lt;location&gt; [-l &lt;length&gt;] [-s] [-1|2|4]
 246 Manage FLASH images
 247    fis {cmds}
 248 Manage configuration kept in FLASH memory
 249    fconfig [-i] [-l] [-n] [-f] [-d] | [-d] nickname [value]
 250 Execute code at a location
 251    go [-w &lt;timeout&gt;] [entry]
 252 Help about help?
 253    help [&lt;topic&gt;]
 254 Set/change IP addresses
 255    ip_address [-l &lt;local_ip_address&gt;] [-h &lt;server_address&gt;]
 256 Load a file
 257    load [-r] [-v] [-d] [-h &lt;host&gt;] [-m {TFTP | HTTP | {x|y}MODEM -c &lt;channel_number&gt;}]
 258         [-b &lt;base_address&gt;] &lt;file_name&gt;
 259 Compare two blocks of memory
 260    mcmp -s &lt;location&gt; -d &lt;location&gt; -l &lt;length&gt; [-1|-2|-4]
 261 Fill a block of memory with a pattern
 262    mfill -b &lt;location&gt; -l &lt;length&gt; -p &lt;pattern&gt; [-1|-2|-4]
 263 Network connectivity test
 264    ping [-v] [-n &lt;count&gt;] [-l &lt;length&gt;] [-t &lt;timeout&gt;] [-r &lt;rate&gt;]
 265         [-i &lt;IP_addr&gt;] -h &lt;IP_addr&gt;
 266 Reset the system
 267    reset
 268 Display RedBoot version information
 269    version
 270 Display (hex dump) a range of memory
 271    x -b &lt;location&gt; [-l &lt;length&gt;] [-s] [-1|2|4]</PRE
 272 ></TD
 273 ></TR
 274 ></TABLE
 275 >
 276       </P
 277 ><P
 278 >Help about a command with sub-commands.
 279 <TABLE
 280 BORDER="5"
 281 BGCOLOR="#E0E0F0"
 282 WIDTH="70%"
 283 ><TR
 284 ><TD
 285 ><PRE
 286 CLASS="SCREEN"
 287 >RedBoot&#62; <TT
 288 CLASS="USERINPUT"
 289 ><B
 290 >help fis</B
 291 ></TT
 292 >
 293 Manage FLASH images
 294    fis {cmds}
 295 Create an image
 296   fis create -b &lt;mem_base&gt; -l &lt;image_length&gt; [-s &lt;data_length&gt;]
 297       [-f &lt;flash_addr&gt;] [-e &lt;entry_point&gt;] [-r &lt;ram_addr&gt;] [-n] &lt;name&gt;
 298 Display an image from FLASH Image System [FIS]
 299   fis delete name
 300 Erase FLASH contents
 301   fis erase -f &lt;flash_addr&gt; -l &lt;length&gt;
 302 Display free [available] locations within FLASH Image System [FIS]
 303   fis free
 304 Initialize FLASH Image System [FIS]
 305   fis init [-f]
 306 Display contents of FLASH Image System [FIS]
 307   fis list [-c] [-d]
 308 Load image from FLASH Image System [FIS] into RAM
 309   fis load [-d] [-b &lt;memory_load_address&gt;] [-c] name
 310 Write raw data directly to FLASH
 311   fis write -f &lt;flash_addr&gt; -b &lt;mem_base&gt; -l &lt;image_length&gt;</PRE
 312 ></TD
 313 ></TR
 314 ></TABLE
 315 >
 316       </P
 317 ></DIV
 318 ><DIV
 319 CLASS="NAVFOOTER"
 320 ><HR
 321 ALIGN="LEFT"
 322 WIDTH="100%"><TABLE
 323 SUMMARY="Footer navigation table"
 324 WIDTH="100%"
 325 BORDER="0"
 326 CELLPADDING="0"
 327 CELLSPACING="0"
 328 ><TR
 329 ><TD
 330 WIDTH="33%"
 331 ALIGN="left"
 332 VALIGN="top"
 333 ><A
 334 HREF="dump-command.html"
 335 ACCESSKEY="P"
 336 >Prev</A
 337 ></TD
 338 ><TD
 339 WIDTH="34%"
 340 ALIGN="center"
 341 VALIGN="top"
 342 ><A
 343 HREF="ecos-ref.html"
 344 ACCESSKEY="H"
 345 >Home</A
 346 ></TD
 347 ><TD
 348 WIDTH="33%"
 349 ALIGN="right"
 350 VALIGN="top"
 351 ><A
 352 HREF="ip-address-command.html"
 353 ACCESSKEY="N"
 354 >Next</A
 355 ></TD
 356 ></TR
 357 ><TR
 358 ><TD
 359 WIDTH="33%"
 360 ALIGN="left"
 361 VALIGN="top"
 362 >dump</TD
 363 ><TD
 364 WIDTH="34%"
 365 ALIGN="center"
 366 VALIGN="top"
 367 ><A
 368 HREF="common-commands.html"
 369 ACCESSKEY="U"
 370 >Up</A
 371 ></TD
 372 ><TD
 373 WIDTH="33%"
 374 ALIGN="right"
 375 VALIGN="top"
 376 >ip_address</TD
 377 ></TR
 378 ></TABLE
 379 ></DIV
 380 ></BODY
 381 ></HTML
 382 >