URL
https://opencores.org/ocsvn/or1k/or1k/trunk
Subversion Repositories or1k
[/] [or1k/] [trunk/] [ecos-2.0/] [doc/] [html/] [ref/] [alias-command.html] - Rev 1765
Compare with Previous | Blame | View Log
<!-- Copyright (C) 2003 Red Hat, Inc. -->
<!-- This material may be distributed only subject to the terms -->
<!-- and conditions set forth in the Open Publication License, v1.0 -->
<!-- or later (the latest version is presently available at -->
<!-- http://www.opencontent.org/openpub/). -->
<!-- Distribution of the work or derivative of the work in any -->
<!-- standard (paper) book form is prohibited unless prior -->
<!-- permission is obtained from the copyright holder. -->
<HTML
><HEAD
><TITLE
>alias</TITLE
><meta name="MSSmartTagsPreventParsing" content="TRUE">
<META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="eCos Reference Manual"
HREF="ecos-ref.html"><LINK
REL="UP"
TITLE="Common Commands"
HREF="common-commands.html"><LINK
REL="PREVIOUS"
TITLE="Common Commands"
HREF="common-commands.html"><LINK
REL="NEXT"
TITLE="baudrate"
HREF="baudrate-command.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>eCos Reference Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="common-commands.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="baudrate-command.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="ALIAS-COMMAND">alias</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2927"
></A
><H2
>Name</H2
>alias -- Manipulate command line aliases</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2930"><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>alias</B
> {<TT
CLASS="REPLACEABLE"
><I
> name</I
></TT
>} [<TT
CLASS="REPLACEABLE"
><I
> value</I
></TT
>]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2937"
></A
><H2
>Arguments</H2
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN2939"><P
></P
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><THEAD
><TR
><TH
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>Name</TH
><TH
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>Type</TH
><TH
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>Description</TH
><TH
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>Default</TH
></TR
></THEAD
><TBODY
><TR
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="REPLACEABLE"
><I
>name</I
></TT
></TD
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>Name</TD
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>The name for this alias.</TD
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>none</I
></SPAN
></TD
></TR
><TR
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="REPLACEABLE"
><I
>value</I
></TT
></TD
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>String</TD
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
>Replacement value for the alias.</TD
><TD
WIDTH="25%"
ALIGN="LEFT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>none</I
></SPAN
></TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2966"
></A
><H2
>Description</H2
><P
>The <B
CLASS="COMMAND"
>alias</B
> command is used to maintain simple command
line aliases. These aliases are shorthand for longer expressions.
When the pattern %{name} appears in a command line, including in a script,
the corresponding value will be substituted. Aliases may be nested.
</P
><P
>If no value is provided, then the current value of the alias is displayed.
</P
><P
>If the system supports non-volatile configuration data via the
<B
CLASS="COMMAND"
>fconfig</B
> command (see <A
HREF="persistent-state-flash.html"
>the Section called <I
>Persistent State Flash-based Configuration and Control</I
> in Chapter 2</A
>),
then the value will be saved and used when the system is reset.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2974"
></A
><H2
>Examples</H2
><P
>Set an alias.
<TABLE
BORDER="5"
BGCOLOR="#E0E0F0"
WIDTH="70%"
><TR
><TD
><PRE
CLASS="SCREEN"
>
RedBoot> <TT
CLASS="USERINPUT"
><B
>alias joe "This is Joe"</B
></TT
>
Update RedBoot non-volatile configuration - continue (y/n)? n</PRE
></TD
></TR
></TABLE
> </P
><P
>Display an alias.
<TABLE
BORDER="5"
BGCOLOR="#E0E0F0"
WIDTH="70%"
><TR
><TD
><PRE
CLASS="SCREEN"
>
RedBoot> <TT
CLASS="USERINPUT"
><B
>alias joe</B
></TT
>
'joe' = 'This is Joe'</PRE
></TD
></TR
></TABLE
> </P
><P
>Use an alias. Note: the <B
CLASS="COMMAND"
>"="</B
> command simply echoes the command to to console.
<TABLE
BORDER="5"
BGCOLOR="#E0E0F0"
WIDTH="70%"
><TR
><TD
><PRE
CLASS="SCREEN"
>
RedBoot> <TT
CLASS="USERINPUT"
><B
>= %{joe}</B
></TT
>
This is Joe</PRE
></TD
></TR
></TABLE
></P
><P
>Aliases can be nested.
<TABLE
BORDER="5"
BGCOLOR="#E0E0F0"
WIDTH="70%"
><TR
><TD
><PRE
CLASS="SCREEN"
>RedBoot> <TT
CLASS="USERINPUT"
><B
>alias frank "Who are you? %{joe}"</B
></TT
>
Update RedBoot non-volatile configuration - continue (y/n)? n
RedBoot> <TT
CLASS="USERINPUT"
><B
>= %{frank}</B
></TT
>
Who are you? This is Joe</PRE
></TD
></TR
></TABLE
></P
><P
>Notice how the value of %{frank} changes when %{joe} is changed since
the value of %{joe} is not evaluated until %{frank} is evaluated.
<TABLE
BORDER="5"
BGCOLOR="#E0E0F0"
WIDTH="70%"
><TR
><TD
><PRE
CLASS="SCREEN"
>RedBoot> <TT
CLASS="USERINPUT"
><B
>alias joe "This is now Josephine"</B
></TT
>
Update RedBoot non-volatile configuration - continue (y/n)? n
RedBoot> <TT
CLASS="USERINPUT"
><B
>= %{frank}</B
></TT
>
Who are you? This is now Josephine</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="common-commands.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ecos-ref.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="baudrate-command.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Common Commands</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="common-commands.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>baudrate</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>