sphinx: add missing trailing newline

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

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

.. _lstat:

LSTAT --- Get file status
*************************

.. index:: LSTAT, file system, file status

.. function:: LSTAT(NAME, VALUES, STATUS)

  ``LSTAT`` is identical to :ref:`STAT`, except that if path is a
  symbolic link, then the link itself is statted, not the file that it
  refers to.

  :param NAME:
    The type shall be ``CHARACTER`` of the default
    kind, a valid path within the file system.

  :param VALUES:
    The type shall be ``INTEGER(4), DIMENSION(13)``.

  :param STATUS:
    (Optional) status flag of type ``INTEGER(4)``.
    Returns 0 on success and a system specific error code otherwise.

  Standard:
    GNU extension

  Class:
    Subroutine, function

  Syntax:
    .. code-block:: fortran

      CALL LSTAT(NAME, VALUES [, STATUS])
      STATUS = LSTAT(NAME, VALUES)

  Example:
    See :ref:`STAT` for an example.

  See also:
    To stat an open file:
    :ref:`FSTAT`
    To stat a file:
    :ref:`STAT`