diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mpdconf.example | 44 | ||||
| -rw-r--r-- | doc/protocol.xml | 21 |
2 files changed, 30 insertions, 35 deletions
diff --git a/doc/mpdconf.example b/doc/mpdconf.example index 8ce3a1b9f..2d2732869 100644 --- a/doc/mpdconf.example +++ b/doc/mpdconf.example @@ -184,12 +184,12 @@ input { #audio_output { # type "alsa" # name "My ALSA Device" -# device "hw:0,0" # optional -# format "44100:16:2" # optional -# mixer_type "hardware" # optional -# mixer_device "default" # optional -# mixer_control "PCM" # optional -# mixer_index "0" # optional +## device "hw:0,0" # optional +## format "44100:16:2" # optional +## mixer_type "hardware" # optional +## mixer_device "default" # optional +## mixer_control "PCM" # optional +## mixer_index "0" # optional #} # # An example of an OSS output: @@ -197,11 +197,11 @@ input { #audio_output { # type "oss" # name "My OSS Device" -# device "/dev/dsp" # optional -# format "44100:16:2" # optional -# mixer_type "hardware" # optional -# mixer_device "/dev/mixer" # optional -# mixer_control "PCM" # optional +## device "/dev/dsp" # optional +## format "44100:16:2" # optional +## mixer_type "hardware" # optional +## mixer_device "/dev/mixer" # optional +## mixer_control "PCM" # optional #} # # An example of a shout output (for streaming to Icecast): @@ -217,13 +217,13 @@ input { # quality "5.0" # bitrate "128" # format "44100:16:1" -# protocol "icecast2" # optional -# user "source" # optional -# description "My Stream Description" # optional -# genre "jazz" # optional -# public "no" # optional -# timeout "2" # optional -# mixer_type "software" # optional +## protocol "icecast2" # optional +## user "source" # optional +## description "My Stream Description" # optional +## genre "jazz" # optional +## public "no" # optional +## timeout "2" # optional +## mixer_type "software" # optional #} # # An example of a recorder output: @@ -233,7 +233,7 @@ input { # name "My recorder" # encoder "vorbis" # optional, vorbis or lame # path "/var/lib/mpd/recorder/mpd.ogg" -# quality "5.0" # do not define if bitrate is defined +## quality "5.0" # do not define if bitrate is defined # bitrate "128" # do not define if quality is defined # format "44100:16:1" #} @@ -245,7 +245,7 @@ input { # name "My HTTP Stream" # encoder "vorbis" # optional, vorbis or lame # port "8000" -# quality "5.0" # do not define if bitrate is defined +## quality "5.0" # do not define if bitrate is defined # bitrate "128" # do not define if quality is defined # format "44100:16:1" #} @@ -255,8 +255,8 @@ input { #audio_output { # type "pulse" # name "My Pulse Output" -# server "remote_server" # optional -# sink "remote_server_sink" # optional +## server "remote_server" # optional +## sink "remote_server_sink" # optional #} # ## Example "pipe" output: diff --git a/doc/protocol.xml b/doc/protocol.xml index 30f8792c8..922d27676 100644 --- a/doc/protocol.xml +++ b/doc/protocol.xml @@ -1224,29 +1224,24 @@ OK <term> <cmdsynopsis> <command>update</command> - <arg><replaceable>URI</replaceable></arg> + <arg choice="opt"><replaceable>URI</replaceable></arg> </cmdsynopsis> </term> <listitem> <para> - Updates the music database. + Updates the music database: find new files, remove + deleted files, update modified files. </para> <para> <varname>URI</varname> is a particular directory or - song/file to update. + song/file to update. If you do not specify it, + everything is updated. </para> <para> Prints "updating_db: JOBID" where - <varname>JOBID</varname> is the job id requested for - your update, and is displayed in status, while the - requested update is happening. - </para> - <para> - To update a number of paths/songs at once, use - command_list, it will be much more faster/efficient. - Also, if you use a command_list for updating, only one - <command>update</command> job id will be returned per - sequence of updates. + <varname>JOBID</varname> is a positive number + identifying the update job. You can read the current + job id in the <command>status</command> response. </para> </listitem> </varlistentry> |