linux/Documentation/linux_tv/media/dvb/video-try-command.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

66 lines
1.2 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _VIDEO_TRY_COMMAND:
=================
VIDEO_TRY_COMMAND
=================
NAME
----
VIDEO_TRY_COMMAND
SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
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 VIDEO_TRY_COMMAND for this command.
- .. row 3
- struct video_command \*cmd
- Try a decoder command.
DESCRIPTION
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
this ioctl has been replaced by the
:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
This ioctl tries a decoder command. The ``video_command`` struct is a
subset of the ``v4l2_decoder_cmd`` struct, so refer to the
:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
for more information.
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.