linux/Documentation/linux_tv/media/dvb/audio-get-status.rst
Mauro Carvalho Chehab 586027cefa doc-rst: linux_tv: reformat all syscall pages
The syscall pages are written to be used also as man-pages.

However, they don't match the format used by kernel-doc
generated pages from DocBook. Rewrite them to match it.

One side effect is that now all such pages at the book
will have the same format, reducing the format differences
between DVB and the other parts of the book.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:53:13 -03:00

60 lines
966 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _AUDIO_GET_STATUS:
================
AUDIO_GET_STATUS
================
NAME
----
AUDIO_GET_STATUS
SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
ARGUMENTS
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals AUDIO_GET_STATUS for this command.
- .. row 3
- struct audio_status \*status
- Returns the current state of Audio Device.
DESCRIPTION
-----------
This ioctl call asks the Audio Device to return the current state of the
Audio Device.
RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.