doc/source/reference.rst

   1 .. _reference:
   2
   3 Reference
   4 =========
   5
   6 Environment variables
   7 ---------------------
   8
   9 :py:class:`mpdaio.MPDClient` honors the following environment variables:
  10
  11 .. envvar:: MPD_HOST
  12
  13    MPD host (:abbr:`FQDN (fully qualified domain name)`, IP, socket path or abstract socket) and password.
  14
  15     | To define a **password** set :envvar:`MPD_HOST` to "*password@host*" (password only "*password@*")
  16     | For **abstract socket** use "@" as prefix : "*@socket*" and then with a password  "*pass@@socket*"
  17     | Regular **unix socket** are set with an absolute path: "*/run/mpd/socket*"
  18
  19 .. envvar:: MPD_PORT
  20
  21    MPD port, relevant for TCP socket only
  22
  23 .. envvar:: MPD_TIMEOUT
  24
  25    socket timeout when connecting to MPD and waiting for MPD’s response (in seconds)
  26
  27 .. envvar:: XDG_RUNTIME_DIR
  28
  29    path to look for potential socket
  30
  31 .. _default_settings:
  32
  33 Default settings
  34 ----------------
  35
  36 Default host:
  37  * use :envvar:`MPD_HOST` environment variable if set, extract password if present,
  38  * else looks for an existing file in :envvar:`${XDG_RUNTIME_DIR:-/run/}/mpd/socket`
  39  * else set host to ``localhost``
  40
  41 Default port:
  42  * use :envvar:`MPD_PORT` environment variable is set
  43  * else use ``6600``
  44
  45 Default timeout:
  46  * use :envvar:`MPD_TIMEOUT` is set
  47  * else use :py:obj:`mpdaio.CONNECTION_TIMEOUT`
  48
  49
  50 Changelog
  51 ---------
  52
  53 No release yet