<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- permission is obtained from the copyright holder. -->
|
<!-- permission is obtained from the copyright holder. -->
|
<HTML
|
<HTML
|
><HEAD
|
><HEAD
|
><TITLE
|
><TITLE
|
>help</TITLE
|
>help</TITLE
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
<META
|
<META
|
NAME="GENERATOR"
|
NAME="GENERATOR"
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
"><LINK
|
"><LINK
|
REL="HOME"
|
REL="HOME"
|
TITLE="eCos Reference Manual"
|
TITLE="eCos Reference Manual"
|
HREF="ecos-ref.html"><LINK
|
HREF="ecos-ref.html"><LINK
|
REL="UP"
|
REL="UP"
|
TITLE="Common Commands"
|
TITLE="Common Commands"
|
HREF="common-commands.html"><LINK
|
HREF="common-commands.html"><LINK
|
REL="PREVIOUS"
|
REL="PREVIOUS"
|
TITLE="dump"
|
TITLE="dump"
|
HREF="dump-command.html"><LINK
|
HREF="dump-command.html"><LINK
|
REL="NEXT"
|
REL="NEXT"
|
TITLE="ip_address"
|
TITLE="ip_address"
|
HREF="ip-address-command.html"></HEAD
|
HREF="ip-address-command.html"></HEAD
|
><BODY
|
><BODY
|
CLASS="REFENTRY"
|
CLASS="REFENTRY"
|
BGCOLOR="#FFFFFF"
|
BGCOLOR="#FFFFFF"
|
TEXT="#000000"
|
TEXT="#000000"
|
LINK="#0000FF"
|
LINK="#0000FF"
|
VLINK="#840084"
|
VLINK="#840084"
|
ALINK="#0000FF"
|
ALINK="#0000FF"
|
><DIV
|
><DIV
|
CLASS="NAVHEADER"
|
CLASS="NAVHEADER"
|
><TABLE
|
><TABLE
|
SUMMARY="Header navigation table"
|
SUMMARY="Header navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TH
|
><TH
|
COLSPAN="3"
|
COLSPAN="3"
|
ALIGN="center"
|
ALIGN="center"
|
>eCos Reference Manual</TH
|
>eCos Reference Manual</TH
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="dump-command.html"
|
HREF="dump-command.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="80%"
|
WIDTH="80%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="ip-address-command.html"
|
HREF="ip-address-command.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"></DIV
|
WIDTH="100%"></DIV
|
><H1
|
><H1
|
><A
|
><A
|
NAME="HELP-COMMAND">help</H1
|
NAME="HELP-COMMAND">help</H1
|
><DIV
|
><DIV
|
CLASS="REFNAMEDIV"
|
CLASS="REFNAMEDIV"
|
><A
|
><A
|
NAME="AEN3316"
|
NAME="AEN3316"
|
></A
|
></A
|
><H2
|
><H2
|
>Name</H2
|
>Name</H2
|
>help -- Display help on available commands</DIV
|
>help -- Display help on available commands</DIV
|
><DIV
|
><DIV
|
CLASS="REFSYNOPSISDIV"
|
CLASS="REFSYNOPSISDIV"
|
><A
|
><A
|
NAME="AEN3319"><H2
|
NAME="AEN3319"><H2
|
>Synopsis</H2
|
>Synopsis</H2
|
><P
|
><P
|
><B
|
><B
|
CLASS="COMMAND"
|
CLASS="COMMAND"
|
>help</B
|
>help</B
|
> [<TT
|
> [<TT
|
CLASS="REPLACEABLE"
|
CLASS="REPLACEABLE"
|
><I
|
><I
|
> topic</I
|
> topic</I
|
></TT
|
></TT
|
>]</P
|
>]</P
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
><A
|
><A
|
NAME="AEN3324"
|
NAME="AEN3324"
|
></A
|
></A
|
><H2
|
><H2
|
>Arguments</H2
|
>Arguments</H2
|
><DIV
|
><DIV
|
CLASS="INFORMALTABLE"
|
CLASS="INFORMALTABLE"
|
><A
|
><A
|
NAME="AEN3326"><P
|
NAME="AEN3326"><P
|
></P
|
></P
|
><TABLE
|
><TABLE
|
BORDER="1"
|
BORDER="1"
|
CLASS="CALSTABLE"
|
CLASS="CALSTABLE"
|
><THEAD
|
><THEAD
|
><TR
|
><TR
|
><TH
|
><TH
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>Name</TH
|
>Name</TH
|
><TH
|
><TH
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>Type</TH
|
>Type</TH
|
><TH
|
><TH
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>Description</TH
|
>Description</TH
|
><TH
|
><TH
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>Default</TH
|
>Default</TH
|
></TR
|
></TR
|
></THEAD
|
></THEAD
|
><TBODY
|
><TBODY
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
><TT
|
><TT
|
CLASS="REPLACEABLE"
|
CLASS="REPLACEABLE"
|
><I
|
><I
|
>topic</I
|
>topic</I
|
></TT
|
></TT
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>String</TD
|
>String</TD
|
><TD
|
><TD
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>Which command to provide help for.</TD
|
>Which command to provide help for.</TD
|
><TD
|
><TD
|
WIDTH="25%"
|
WIDTH="25%"
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
VALIGN="TOP"
|
VALIGN="TOP"
|
>All commands</TD
|
>All commands</TD
|
></TR
|
></TR
|
></TBODY
|
></TBODY
|
></TABLE
|
></TABLE
|
><P
|
><P
|
></P
|
></P
|
></DIV
|
></DIV
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
><A
|
><A
|
NAME="AEN3345"
|
NAME="AEN3345"
|
></A
|
></A
|
><H2
|
><H2
|
>Description</H2
|
>Description</H2
|
><P
|
><P
|
>The <B
|
>The <B
|
CLASS="COMMAND"
|
CLASS="COMMAND"
|
>help</B
|
>help</B
|
> command displays information about the available
|
> command displays information about the available
|
RedBoot commands. If a <SPAN
|
RedBoot commands. If a <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>topic</I
|
>topic</I
|
></SPAN
|
></SPAN
|
> is given, then the display
|
> is given, then the display
|
is restricted to information about that specific command.
|
is restricted to information about that specific command.
|
</P
|
</P
|
><P
|
><P
|
>If the command has sub-commands, e.g. <B
|
>If the command has sub-commands, e.g. <B
|
CLASS="COMMAND"
|
CLASS="COMMAND"
|
>fis</B
|
>fis</B
|
>, then the topic
|
>, then the topic
|
specific display will print additional information about the available sub-commands.
|
specific display will print additional information about the available sub-commands.
|
special (ICMP) packets to a specific host. These packets should be automatically
|
special (ICMP) packets to a specific host. These packets should be automatically
|
returned by that host. The command will indicate how many of these round-trips
|
returned by that host. The command will indicate how many of these round-trips
|
were successfully completed.
|
were successfully completed.
|
</P
|
</P
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="REFSECT1"
|
CLASS="REFSECT1"
|
><A
|
><A
|
NAME="AEN3352"
|
NAME="AEN3352"
|
></A
|
></A
|
><H2
|
><H2
|
>Examples</H2
|
>Examples</H2
|
><P
|
><P
|
>Show generic help. Note that the contents of this display will depend on the various configuration
|
>Show generic help. Note that the contents of this display will depend on the various configuration
|
options for RedBoot when it was built.
|
options for RedBoot when it was built.
|
<TABLE
|
<TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="SCREEN"
|
CLASS="SCREEN"
|
>RedBoot> <TT
|
>RedBoot> <TT
|
CLASS="USERINPUT"
|
CLASS="USERINPUT"
|
><B
|
><B
|
>help</B
|
>help</B
|
></TT
|
></TT
|
>
|
>
|
Manage aliases kept in FLASH memory
|
Manage aliases kept in FLASH memory
|
alias name [value]
|
alias name [value]
|
Manage machine caches
|
Manage machine caches
|
cache [ON | OFF]
|
cache [ON | OFF]
|
Display/switch console channel
|
Display/switch console channel
|
channel [-1|<channel number>]
|
channel [-1|<channel number>]
|
Compute a 32bit checksum [POSIX algorithm] for a range of memory
|
Compute a 32bit checksum [POSIX algorithm] for a range of memory
|
cksum -b <location> -l <length>
|
cksum -b <location> -l <length>
|
Display (hex dump) a range of memory
|
Display (hex dump) a range of memory
|
dump -b <location> [-l <length>] [-s] [-1|2|4]
|
dump -b <location> [-l <length>] [-s] [-1|2|4]
|
Manage FLASH images
|
Manage FLASH images
|
fis {cmds}
|
fis {cmds}
|
Manage configuration kept in FLASH memory
|
Manage configuration kept in FLASH memory
|
fconfig [-i] [-l] [-n] [-f] [-d] | [-d] nickname [value]
|
fconfig [-i] [-l] [-n] [-f] [-d] | [-d] nickname [value]
|
Execute code at a location
|
Execute code at a location
|
go [-w <timeout>] [entry]
|
go [-w <timeout>] [entry]
|
Help about help?
|
Help about help?
|
help [<topic>]
|
help [<topic>]
|
Set/change IP addresses
|
Set/change IP addresses
|
ip_address [-l <local_ip_address>] [-h <server_address>]
|
ip_address [-l <local_ip_address>] [-h <server_address>]
|
Load a file
|
Load a file
|
load [-r] [-v] [-d] [-h <host>] [-m {TFTP | HTTP | {x|y}MODEM -c <channel_number>}]
|
load [-r] [-v] [-d] [-h <host>] [-m {TFTP | HTTP | {x|y}MODEM -c <channel_number>}]
|
[-b <base_address>] <file_name>
|
[-b <base_address>] <file_name>
|
Compare two blocks of memory
|
Compare two blocks of memory
|
mcmp -s <location> -d <location> -l <length> [-1|-2|-4]
|
mcmp -s <location> -d <location> -l <length> [-1|-2|-4]
|
Fill a block of memory with a pattern
|
Fill a block of memory with a pattern
|
mfill -b <location> -l <length> -p <pattern> [-1|-2|-4]
|
mfill -b <location> -l <length> -p <pattern> [-1|-2|-4]
|
Network connectivity test
|
Network connectivity test
|
ping [-v] [-n <count>] [-l <length>] [-t <timeout>] [-r <rate>]
|
ping [-v] [-n <count>] [-l <length>] [-t <timeout>] [-r <rate>]
|
[-i <IP_addr>] -h <IP_addr>
|
[-i <IP_addr>] -h <IP_addr>
|
Reset the system
|
Reset the system
|
reset
|
reset
|
Display RedBoot version information
|
Display RedBoot version information
|
version
|
version
|
Display (hex dump) a range of memory
|
Display (hex dump) a range of memory
|
x -b <location> [-l <length>] [-s] [-1|2|4]</PRE
|
x -b <location> [-l <length>] [-s] [-1|2|4]</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
>
|
>
|
</P
|
</P
|
><P
|
><P
|
>Help about a command with sub-commands.
|
>Help about a command with sub-commands.
|
<TABLE
|
<TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="SCREEN"
|
CLASS="SCREEN"
|
>RedBoot> <TT
|
>RedBoot> <TT
|
CLASS="USERINPUT"
|
CLASS="USERINPUT"
|
><B
|
><B
|
>help fis</B
|
>help fis</B
|
></TT
|
></TT
|
>
|
>
|
Manage FLASH images
|
Manage FLASH images
|
fis {cmds}
|
fis {cmds}
|
Create an image
|
Create an image
|
fis create -b <mem_base> -l <image_length> [-s <data_length>]
|
fis create -b <mem_base> -l <image_length> [-s <data_length>]
|
[-f <flash_addr>] [-e <entry_point>] [-r <ram_addr>] [-n] <name>
|
[-f <flash_addr>] [-e <entry_point>] [-r <ram_addr>] [-n] <name>
|
Display an image from FLASH Image System [FIS]
|
Display an image from FLASH Image System [FIS]
|
fis delete name
|
fis delete name
|
Erase FLASH contents
|
Erase FLASH contents
|
fis erase -f <flash_addr> -l <length>
|
fis erase -f <flash_addr> -l <length>
|
Display free [available] locations within FLASH Image System [FIS]
|
Display free [available] locations within FLASH Image System [FIS]
|
fis free
|
fis free
|
Initialize FLASH Image System [FIS]
|
Initialize FLASH Image System [FIS]
|
fis init [-f]
|
fis init [-f]
|
Display contents of FLASH Image System [FIS]
|
Display contents of FLASH Image System [FIS]
|
fis list [-c] [-d]
|
fis list [-c] [-d]
|
Load image from FLASH Image System [FIS] into RAM
|
Load image from FLASH Image System [FIS] into RAM
|
fis load [-d] [-b <memory_load_address>] [-c] name
|
fis load [-d] [-b <memory_load_address>] [-c] name
|
Write raw data directly to FLASH
|
Write raw data directly to FLASH
|
fis write -f <flash_addr> -b <mem_base> -l <image_length></PRE
|
fis write -f <flash_addr> -b <mem_base> -l <image_length></PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
>
|
>
|
</P
|
</P
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="NAVFOOTER"
|
CLASS="NAVFOOTER"
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"><TABLE
|
WIDTH="100%"><TABLE
|
SUMMARY="Footer navigation table"
|
SUMMARY="Footer navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="dump-command.html"
|
HREF="dump-command.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="ecos-ref.html"
|
HREF="ecos-ref.html"
|
ACCESSKEY="H"
|
ACCESSKEY="H"
|
>Home</A
|
>Home</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="ip-address-command.html"
|
HREF="ip-address-command.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
>dump</TD
|
>dump</TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="common-commands.html"
|
HREF="common-commands.html"
|
ACCESSKEY="U"
|
ACCESSKEY="U"
|
>Up</A
|
>Up</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
>ip_address</TD
|
>ip_address</TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
></DIV
|
></DIV
|
></BODY
|
></BODY
|
></HTML
|
></HTML
|
|
|