diff options
Diffstat (limited to 'shell/configuration_and_init.rst')
-rw-r--r-- | shell/configuration_and_init.rst | 119 |
1 files changed, 58 insertions, 61 deletions
diff --git a/shell/configuration_and_init.rst b/shell/configuration_and_init.rst index cb60ce7..4895fdb 100644 --- a/shell/configuration_and_init.rst +++ b/shell/configuration_and_init.rst @@ -296,91 +296,88 @@ Functions This section describes the Shell related C functions which are publicly available related to initialization and configuration. +.. raw:: latex + + \clearpage + rtems_shell_init - Initialize the shell --------------------------------------- .. index:: initialization - -**CALLING SEQUENCE:** - .. index:: rtems_shell_init -.. code-block:: c - - rtems_status_code rtems_shell_init( - const char *task_name, - size_t task_stacksize, - rtems_task_priority task_priority, - const char *devname, - bool forever, - bool wait, - rtems_login_check login_check - ); - -**DIRECTIVE STATUS CODES:** - -``RTEMS_SUCCESSFUL`` - Shell task spawned successfully +CALLING SEQUENCE: + .. code-block:: c + + rtems_status_code rtems_shell_init( + const char *task_name, + size_t task_stacksize, + rtems_task_priority task_priority, + const char *devname, + bool forever, + bool wait, + rtems_login_check login_check + ); -others - to indicate a failure condition +DIRECTIVE STATUS CODES: + ``RTEMS_SUCCESSFUL`` - Shell task spawned successfully + *others* - to indicate a failure condition -**DESCRIPTION:** +DESCRIPTION: + This service creates a task with the specified characteristics to run the RTEMS + Shell attached to the specified ``devname``. -This service creates a task with the specified characteristics to run the RTEMS -Shell attached to the specified ``devname``. +NOTES: + This method invokes the ``rtems_task_create`` and ``rtems_task_start`` + directives and as such may return any status code that those directives may + return. -**NOTES:** + There is one POSIX key necessary for all shell instances together and one + POSIX key value pair per instance. You should make sure that your RTEMS + configuration accounts for these resources. -This method invokes the ``rtems_task_create`` and ``rtems_task_start`` -directives and as such may return any status code that those directives may -return. +.. raw:: latex -There is one POSIX key necessary for all shell instances together and one POSIX -key value pair per instance. You should make sure that your RTEMS configuration -accounts for these resources. + \clearpage rtems_shell_login_check - Default login check handler ----------------------------------------------------- .. index:: initialization - -**CALLING SEQUENCE:** - .. index:: rtems_shell_login_check -.. code:: c - - bool rtems_shell_login_check( - const char *user, - const char *passphrase - ); - -**DIRECTIVE STATUS CODES:** - -``true`` - login is allowed, and -``false`` - otherwise. +CALLING SEQUENCE: + .. code:: c -**DESCRIPTION:** + bool rtems_shell_login_check( + const char *user, + const char *passphrase + ); -This function checks if the specified passphrase is valid for the specified -user. +DIRECTIVE STATUS CODES: + ``true`` - login is allowed, and + ``false`` - otherwise. -**NOTES:** +DESCRIPTION: + This function checks if the specified passphrase is valid for the specified + user. -As a side-effect if the specified passphrase is valid for the specified user, -this function: +NOTES: + As a side-effect if the specified passphrase is valid for the specified + user, this function: -- performs a filesystem change root operation to the directory of the specified - user if the directory path is non-empty, + - performs a filesystem change root operation to the directory of the + specified user if the directory path is non-empty, -- changes the owner of the current shell device to the UID of the specified - user, + - changes the owner of the current shell device to the UID of the specified + user, -- sets the real and effective UID of the current user environment to the UID of - the specified user, + - sets the real and effective UID of the current user environment to the + UID of the specified user, -- sets the real and effective GID of the current user environment to the GID of - the specified user, and + - sets the real and effective GID of the current user environment to the + GID of the specified user, and -- sets the supplementary group IDs of the current user environment to the - supplementary group IDs of the specified user. + - sets the supplementary group IDs of the current user environment to the + supplementary group IDs of the specified user. -In case the filesystem change root operation fails, then the environment setup -is aborted and ``false`` is returned. + In case the filesystem change root operation fails, then the environment + setup is aborted and ``false`` is returned. |