xnu-792.6.76.tar.gz

[apple/xnu.git] / osfmk / man / bootstrap_arguments.html

diff --git a/osfmk/man/bootstrap_arguments.html b/osfmk/man/bootstrap_arguments.html
index 0b62fd7f88c5d85d6c38bd64f0b9286cf43e7a5a..c6c81db7853ad08d99812cfb5d33d42354f0c839 100755 (executable)
--- a/osfmk/man/bootstrap_arguments.html
+++ b/osfmk/man/bootstrap_arguments.html
@@ -1 +1,56 @@
-<h2>bootstrap_arguments</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return a set of arguments to the bootstrap task.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   bootstrap_arguments</strong>\r                <strong>(mach_port_t</strong>                          <var>bootstrap</var>,\r                 <strong>task_t</strong>                                    <var>task</var>,\r                 <strong>pointer_t</strong>                            <var>pointer_t</var>,\r                 <strong>mach_msg_type_number_t</strong>  <var>mach_msg_type_number_t</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>bootstrap</var> \r<dd>\r[in bootstrap send right]\rThe bootstrap port for the task, obtained from \r<strong>task_get_special_ports</strong>.\r<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe task port for the task whose argument strings are requested.\r<p>\r<dt> <var>arguments</var> \r<dd>\r[pointer to dynamic out array of characters]\rThe argument strings for the task. This is an array of \r<var>argumentCnt</var> bytes, containing NUL characters\rseparating the strings.\r<p>\r<dt> <var>argumentsCnt</var> \r<dd>\r[out pointer to scalar]\rNumber of bytes contained in <var>arguments</var>.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe kernel will respond to the bootstrap task (task 1) with the\rarguments and environment specified to the boot loader. The bootstrap\rtask can act as a server on this interface for the tasks that it\rcreates in order to pass arguments to them. The <strong>libsa_mach.a</strong>\rstandalone Mach C runtime startup code uses <strong>bootstrap_arguments</strong> and\r<strong>bootstrap_environment</strong> to initialize <var>argc</var>, <var>argv</var>, \rand <var>envp</var> for <strong>main</strong>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="bootstrap_ports.html"><strong>bootstrap_ports</strong></a>,\r<a href="bootstrap_environment.html"><strong>bootstrap_environment</strong></a>.\r\r
\ No newline at end of file
+<h2>bootstrap_arguments</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return a set of arguments to the bootstrap task.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   bootstrap_arguments</strong>
+                <strong>(mach_port_t</strong>                          <var>bootstrap</var>,
+                 <strong>task_t</strong>                                    <var>task</var>,
+                 <strong>pointer_t</strong>                            <var>pointer_t</var>,
+                 <strong>mach_msg_type_number_t</strong>  <var>mach_msg_type_number_t</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>bootstrap</var> 
+<dd>
+[in bootstrap send right]
+The bootstrap port for the task, obtained from 
+<strong>task_get_special_ports</strong>.
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The task port for the task whose argument strings are requested.
+<p>
+<dt> <var>arguments</var> 
+<dd>
+[pointer to dynamic out array of characters]
+The argument strings for the task. This is an array of 
+<var>argumentCnt</var> bytes, containing NUL characters
+separating the strings.
+<p>
+<dt> <var>argumentsCnt</var> 
+<dd>
+[out pointer to scalar]
+Number of bytes contained in <var>arguments</var>.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The kernel will respond to the bootstrap task (task 1) with the
+arguments and environment specified to the boot loader. The bootstrap
+task can act as a server on this interface for the tasks that it
+creates in order to pass arguments to them. The <strong>libsa_mach.a</strong>
+standalone Mach C runtime startup code uses <strong>bootstrap_arguments</strong> and
+<strong>bootstrap_environment</strong> to initialize <var>argc</var>, <var>argv</var>, 
+and <var>envp</var> for <strong>main</strong>.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="bootstrap_ports.html"><strong>bootstrap_ports</strong></a>,
+<a href="bootstrap_environment.html"><strong>bootstrap_environment</strong></a>.
+