1
0
mirror of https://github.com/mpv-player/mpv synced 2025-02-09 00:17:07 +00:00

manpage: lua: cosmetic changes to mp.options section

This commit is contained in:
wm4 2014-05-25 19:43:25 +02:00
parent 9d0e5f6da6
commit e648f7e783

View File

@ -411,15 +411,15 @@ with ``require 'mp.msg'``.
All of these are shortcuts and equivalent to the corresponding All of these are shortcuts and equivalent to the corresponding
``msg.log(level, ...)`` call. ``msg.log(level, ...)`` call.
mp.options mp.options functions
---------- --------------------
mpv comes with a built-in module to manage options from config-files and the mpv comes with a built-in module to manage options from config-files and the
command-line. All you have to do is to supply a table with default options to command-line. All you have to do is to supply a table with default options to
the read_options function. The function will overwrite the default values the read_options function. The function will overwrite the default values
with values found in the config-file and the command-line (in that order). with values found in the config-file and the command-line (in that order).
``read_options(table, identifier)`` ``options.read_options(table [, identifier])``
A ``table`` with key-value pairs. The type of the default values is A ``table`` with key-value pairs. The type of the default values is
important for converting the values read from the config file or important for converting the values read from the config file or
command-line back. Do not use ``nil`` as a default value! command-line back. Do not use ``nil`` as a default value!
@ -431,7 +431,7 @@ with values found in the config-file and the command-line (in that order).
Example implementation:: Example implementation::
local opt = require 'mp.options' require 'mp.options'
local options = { local options = {
optionA = "defaultvalueA", optionA = "defaultvalueA",
optionB = -0.5, optionB = -0.5,