<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>change log for rtems (2010-05-09)</title>
</head>
<body text='#000000' bgcolor='#ffffff'>
<a name='cs1'></a>
<table border='0' cellspacing='0' cellpadding='5' width='100%' bgcolor='#eeeeee'>
<tr><td colspan='3' bgcolor='#dddddd'>
<font color='#bb2222'><strong>joel</strong></font>
</td></tr>
<tr><td colspan='3' bgcolor='#dddddd'><pre>2010-05-09 Joel Sherrill <joel.sherrill@oarcorp.com>
PR 1512/doc
* shell/general.t: Add setenv, getenv, and unsetenv.
</pre></td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/doc/ChangeLog.diff?r1=text&tr1=1.268&r2=text&tr2=1.269&diff_format=h">M</a></td><td width='1%'>1.269</td><td width='100%'>doc/ChangeLog</td></tr>
<tr><td width='1%'><a href="http://www.rtems.com/cgi-bin/viewcvs.cgi//rtems/doc/shell/general.t.diff?r1=text&tr1=1.8&r2=text&tr2=1.9&diff_format=h">M</a></td><td width='1%'>1.9</td><td width='100%'>doc/shell/general.t</td></tr>
</table>
<pre>
<font color='#006600'>diff -u rtems/doc/ChangeLog:1.268 rtems/doc/ChangeLog:1.269
--- rtems/doc/ChangeLog:1.268 Wed May 5 15:44:15 2010
+++ rtems/doc/ChangeLog Sun May 9 18:13:26 2010
</font><font color='#997700'>@@ -1,3 +1,8 @@
</font><font color='#000088'>+2010-05-09 Joel Sherrill <joel.sherrill@oarcorp.com>
+
+ PR 1512/doc
+ * shell/general.t: Add setenv, getenv, and unsetenv.
+
</font> 2010-05-05 Alin Rus <alin.codejunkie@gmail.com>
PR 1510/doc
<font color='#006600'>diff -u rtems/doc/shell/general.t:1.8 rtems/doc/shell/general.t:1.9
--- rtems/doc/shell/general.t:1.8 Fri Feb 29 17:20:29 2008
+++ rtems/doc/shell/general.t Sun May 9 18:13:26 2010
</font><font color='#997700'>@@ -1,5 +1,5 @@
</font> @c
<font color='#880000'>-@c COPYRIGHT (c) 1988-2008.
</font><font color='#000088'>+@c COPYRIGHT (c) 1988-2010.
</font> @c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
<font color='#997700'>@@ -21,6 +21,9 @@
</font> @item @code{id} - show uid gid euid and egid
@item @code{tty} - show ttyname
@item @code{whoami} - print effective user id
<font color='#000088'>+@item @code{getenv} - print environment variable
+@item @code{setenv} - set environment variable
+@item @code{unsetenv} - unset environment variable
</font> @item @code{logoff} - logoff from the system
@item @code{exit} - alias for logoff command
<font color='#997700'>@@ -623,6 +626,222 @@
</font> @c
@c
@page
<font color='#000088'>+@subsection getenv - print environment variable
+
+@pgindex getenv
+
+@subheading SYNOPSYS:
+
+@example
+getenv variable
+@end example
+
+@subheading DESCRIPTION:
+
+This command is used to display the value of a @code{variable} in the set
+of environment variables.
+
+@subheading EXIT STATUS:
+
+This command will return 1 and print a diagnostic message if
+a failure occurs.
+
+@subheading NOTES:
+
+The entire RTEMS application shares a single set of environment variables.
+
+@subheading EXAMPLES:
+
+The following is an example of how to use @code{getenv}:
+
+@example
+SHLL [/] $ getenv BASEPATH
+/mnt/hda1
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_GETENV
+@findex CONFIGURE_SHELL_COMMAND_GETENV
+
+This command is included in the default shell command set.<span style="background-color: #FF0000"> </span>
+When building a custom command set, define
+@code{CONFIGURE_SHELL_COMMAND_GETENV} to have this
+command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_GETENV} when all
+shell commands have been configured.
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_getenv
+
+The @code{getenv} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_getenv(
+ int argc,
+ char **argv
+);
+@end example
+
+The configuration structure for the @code{getenv} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_GETENV_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection setenv - set environment variable
+
+@pgindex setenv
+
+@subheading SYNOPSYS:
+
+@example
+setenv variable [value]
+@end example
+
+@subheading DESCRIPTION:
+
+This command is used to add a new @code{variable} to the set of environment
+variables or to modify the variable of an already existing @code{variable}.
+If the @code{value} is not provided, the @code{variable} will be set to the
+empty string.
+
+@subheading EXIT STATUS:
+
+This command will return 1 and print a diagnostic message if
+a failure occurs.
+
+@subheading NOTES:
+
+The entire RTEMS application shares a single set of environment variables.
+
+@subheading EXAMPLES:
+
+The following is an example of how to use @code{setenv}:
+
+@example
+SHLL [/] $ setenv BASEPATH /mnt/hda1
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_SETENV
+@findex CONFIGURE_SHELL_COMMAND_SETENV
+
+This command is included in the default shell command set.<span style="background-color: #FF0000"> </span>
+When building a custom command set, define
+@code{CONFIGURE_SHELL_COMMAND_SETENV} to have this
+command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_SETENV} when all
+shell commands have been configured.
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_setenv
+
+The @code{setenv} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_setenv(
+ int argc,
+ char **argv
+);
+@end example
+
+The configuration structure for the @code{setenv} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_SETENV_Command;
+@end example
+
+@c
+@c
+@c
+@page
+@subsection unsetenv - unset environment variable
+
+@pgindex unsetenv
+
+@subheading SYNOPSYS:
+
+@example
+unsetenv variable
+@end example
+
+@subheading DESCRIPTION:
+
+This command is remove to a @code{variable} from the set of environment
+variables.
+
+@subheading EXIT STATUS:
+
+This command will return 1 and print a diagnostic message if
+a failure occurs.
+
+@subheading NOTES:
+
+The entire RTEMS application shares a single set of environment variables.
+
+@subheading EXAMPLES:
+
+The following is an example of how to use @code{unsetenv}:
+
+@example
+SHLL [/] $ unsetenv BASEPATH
+@end example
+
+@subheading CONFIGURATION:
+
+@findex CONFIGURE_SHELL_NO_COMMAND_UNSETENV
+@findex CONFIGURE_SHELL_COMMAND_UNSETENV
+
+This command is included in the default shell command set.<span style="background-color: #FF0000"> </span>
+When building a custom command set, define
+@code{CONFIGURE_SHELL_COMMAND_UNSETENV} to have this
+command included.
+
+This command can be excluded from the shell command set by
+defining @code{CONFIGURE_SHELL_NO_COMMAND_UNSETENV} when all
+shell commands have been configured.
+
+@subheading PROGRAMMING INFORMATION:
+
+@findex rtems_shell_rtems_main_unsetenv
+
+The @code{unsetenv} is implemented by a C language function
+which has the following prototype:
+
+@example
+int rtems_shell_rtems_main_unsetenv(
+ int argc,
+ char **argv
+);
+@end example
+
+The configuration structure for the @code{unsetenv} has the
+following prototype:
+
+@example
+extern rtems_shell_cmd_t rtems_shell_UNSETENV_Command;
+@end example
+
+@c
+@c
+@c
+@page
</font> @subsection logoff - logoff from the system
@pgindex logoff
</pre>
<p> </p>
<p>--<br />
<small>Generated by <a href="http://www.codewiz.org/projects/index.html#loginfo">Deluxe Loginfo</a> 2.122 by Bernardo Innocenti <bernie@develer.com></small></p>
</body>
</html>