sphinx: add missing trailing newline

[thirdparty/gcc.git] / gcc / fortran / doc / gfortran / intrinsic-procedures / executecommandline.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. _execute_command_line:

EXECUTE_COMMAND_LINE --- Execute a shell command
************************************************

.. index:: EXECUTE_COMMAND_LINE, system, system call, command line

.. function:: EXECUTE_COMMAND_LINE(COMMAND, WAIT, EXITSTAT, CMDSTAT, CMDMSG)

  ``EXECUTE_COMMAND_LINE`` runs a shell command, synchronously or
  asynchronously.

  :param COMMAND:
    Shall be a default ``CHARACTER`` scalar.

  :param WAIT:
    (Optional) Shall be a default ``LOGICAL`` scalar.

  :param EXITSTAT:
    (Optional) Shall be an ``INTEGER`` of the
    default kind.

  :param CMDSTAT:
    (Optional) Shall be an ``INTEGER`` of the
    default kind.

  :param CMDMSG:
    (Optional) Shall be an ``CHARACTER`` scalar of the
    default kind.

  Standard:
    Fortran 2008 and later

  Class:
    Subroutine

  Syntax:
    .. code-block:: fortran

      CALL EXECUTE_COMMAND_LINE(COMMAND [, WAIT, EXITSTAT, CMDSTAT, CMDMSG ])

  Example:
    .. code-block:: fortran

      program test_exec
        integer :: i

        call execute_command_line ("external_prog.exe", exitstat=i)
        print *, "Exit status of external_prog.exe was ", i

        call execute_command_line ("reindex_files.exe", wait=.false.)
        print *, "Now reindexing files in the background"

      end program test_exec

  Note:
    Because this intrinsic is implemented in terms of the ``system``
    function call, its behavior with respect to signaling is processor
    dependent. In particular, on POSIX-compliant systems, the SIGINT and
    SIGQUIT signals will be ignored, and the SIGCHLD will be blocked. As
    such, if the parent process is terminated, the child process might not be
    terminated alongside.

  See also:
    :ref:`SYSTEM`