aboutsummaryrefslogtreecommitdiffstats
path: root/doc (unfollow)
Commit message (Collapse)AuthorFilesLines
2008-12-24Fix a few problems with the huge mpdconf update. There's alot of shift here, ↵Avuton Olrich1-72/+86
mostly due to word wraps. This, also, improves on uniformity and clarity of the document.
2008-12-24doc: fix "playlistdelete" documentationMax Kellermann1-2/+2
"playlistdelete" takes a song position, not a song id. There are no song ids in stored playlists.
2008-12-20Remove obsolete http_buffer* stuff that went away with the new curl backend.Avuton Olrich1-8/+0
2008-12-20Huge mpdconf update.Avuton Olrich1-175/+198
Over time mpdconf has evolved and has been maintained and contributed to by many different folks at different times. Try to give it some unity. Attempt to clear up some language and make things crystal clear. Add more examples. Use tabs when it makes sense. Make better borders. Remove obsolete options. Try to put more defaults when it makes sense.
2008-12-20doc: clarify "user" setting (starting as root / unprivileged)Max Kellermann2-5/+8
The "user" option does not work if MPD is started by an unprivileged user.
2008-12-16man: document Unix domain socket configuration in the manualMax Kellermann2-0/+7
Additionally, add an example in mpdconf.example.
2008-12-08update: default to follow all symlinksAvuton Olrich2-2/+2
MPD 0.13 and older followed all symbolic links. Although this can be a security problem (as it has always been), 0.14 should offer the same default behaviour as 0.13.
2008-11-28update: added options which control symlink behaviourRaphaël Rigo2-0/+13
The configuration options "follow_outside_symlinks" and "follow_inside_symlinks" let the user control whether MPD should follow symbolic links in the music directory. [mk: converted variables to "bool"; moved configuration to update_global_init()]
2008-11-23command: added documentation for idle subscriptionsMarc Pavot1-0/+6
2008-11-23Makefile.am: include protocol.xml in source tarballMax Kellermann1-1/+1
Added $(DOCBOOK_FILES) to $(EXTRA_DIST). Don't include the generated protocol.html in the tarball.
2008-11-20doc: merged protocol documentation from the wikiMonika Brinkert1-31/+282
Over the years, a lot of commands have been added to MPD which were documented only in the wiki (http://mpd.wikia.com/wiki/Protocol_Reference). Merge all missing commands from there.
2008-11-20doc: rephrase descriptionsMonika Brinkert1-58/+62
Correct lots of grammar and spelling errors. Unify some phrases.
2008-11-20doc: improved XML decorationsMonika Brinkert1-118/+108
Wrapped keywords in DocBook tags where appropriate.
2008-11-20doc: process protocol.xml with xmltoMax Kellermann1-1/+13
Generate and install protocol.html if xmlto is available.
2008-11-20doc: fix "Repeat" typo in protocol.xmlMax Kellermann1-1/+1
The attribute value must be lower case: <arg rep="repeat">
2008-11-19doc: converted doc/COMMANDS to DocBookMax Kellermann2-325/+1064
The goal is to have one structured document which is the authoritative protocol specification. The documentation which currently resides in the wiki will be merged.
2008-10-31update mpdconf.example that shout ouput encoding and protocol settings are ↵Alam Arias1-2/+2
optional
2008-10-31replace tabs with space in shout audio_output exampleAlam Arias1-1/+1
2008-10-25Makefile.am: install documentationMax Kellermann1-3/+3
2008-10-22stored_playlist: send timestampsMax Kellermann1-0/+6
Send last modification timestamps to the client. This allows the client to see when another client modifies a stored playlist.
2008-10-22command: added command "listplaylists"Max Kellermann1-0/+7
"listplaylists" returns a list of all stored playlists. This command seems more elaborate than listing them below "lsinfo".
2008-10-16Makefile.am: fix automake 1.6 errorsMax Kellermann1-3/+3
When building with the ancient automake 1.6 version, the following errors occur: Makefile.am:5: invalid variable `doc_DATA' doc/Makefile.am:2: invalid variable `doc_DATA' This patches renames some internal variables.
2008-10-15idle: client command "noidle" aborts idleMax Kellermann1-2/+4
2008-10-15pulse: clarify the meaning of multiple server namesMax Kellermann1-0/+2
The manual page suggests that you can specify multiple servers, but it did not clarify what that means.
2008-10-14command: added command "idle"Max Kellermann1-0/+21
"idle" waits until something noteworthy happens on the server, e.g. song change, playlist modified, database updated. This allows clients to keep up to date without polling.
2008-10-14Makefile.am: don't override $(docdir)Richard Brown1-1/+0
Makefile.am sets docdir = $(prefix)/share/doc/$(PACKAGE). This overrides the setting specified in ./configure --docdir.
2008-10-14alsa: optionally disable resampling and othersMax Kellermann1-0/+13
Added mpd.conf options for disabling automatic resamling, sample format and channel conversion. This way, users may choose to override ALSA's automatic resampling, and use libsamplerate instead.
2008-10-14shout: fix manual page typoMax Kellermann1-0/+1
A ".TP" was missing, and broke the manual page's layout.
2008-10-12shout: make the protocol configurableAaron McEwan2-1/+6
Added configuration parameter "protocol" which lets the user choose from 3 shout protocols. This adds support for real shoutcast servers.
2008-09-28COMMANDS: assorted formatting fixesEric Wong1-21/+22
* spaces => tabs * long lines wrapped * trailing whitespace killed
2008-09-28COMMANDS: document moveid with negative _to_ argument, tooEric Wong1-1/+3
2008-09-28COMMANDS: document addid with optional position argumentEric Wong1-1/+4
2008-09-23doc/COMMANDS: document "addid"Max Kellermann1-0/+8
2008-09-12shout: introduce pluggable encoder APIEric Wollesen2-2/+9
I've perhaps gone a bit overboard, but here's the current rundown: Both Ogg and MP3 use the "shout" audio output plugin. The shout audio output plugin itself has two new plugins, one for the Ogg encoder, and another for the MP3 (LAME) encoder. Configuration for an Ogg stream doesn't change. For an MP3 stream, configuration is the same as Ogg, with two exceptions. First, you must specify the optional "encoding" parameter, which should be set to "mp3". See mpd.conf(5) for more details. Second, the "quality" parameter is reversed for LAME, such that 1 is high quality for LAME, whereas 10 is high quality for Ogg. I've decomposed the code so that all libshout related operations are done in audioOutput_shout.c, all Ogg specific functions are in audioOutput_shout_ogg.c, and of course then all LAME specific functions are handled in audioOutput_shout_mp3.c. To develop encoder plugins for the shout audio output plugin, I basically just mimicked the plugin system used for audio outputs. This might be overkill, but hopefully if anyone ever wants to support some other sort of stream, like maybe AAC, FLAC, or WMA (hey it could happen), they will hopefully be all set. The Ogg encoder is slightly less optimal under this configuration. It used to send shout data directly out of its ogg_page structures. Now, in the interest of encapsulation, it copies the data from its ogg_page structures into a buffer provided by the shout audio output plugin (see audioOutput_shout_ogg.c, line 77.) I suspect the performance impact is negligible. As for metadata, I'm pretty sure they'll both work. I wrote up a test scaffold that would create a fake tag, and tell the plugin to send it out to the stream every few seconds. It seemed to work fine. Of course, if something does break, I'll be glad to fix it. Lastly, I've renamed lots of things into snake_case, in keeping with normalperson's wishes in that regard. [mk: moved the MP3 patch after this one. Splitted this patch into several parts; the others were already applied before this one. Fixed a bunch GCC warnings and wrong whitespace modifications. Made it compile with mpd-mk by adapting to its prototypes]
2007-06-13Adding FIFO audio output. This is pretty much identical to the old one,J. Alexander Treuman1-0/+11
except that it now uses a timer for throttling. git-svn-id: https://svn.musicpd.org/mpd/trunk@6621 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-06-12Make the shout timeout configurable. The default is still 2 seconds.J. Alexander Treuman2-0/+5
git-svn-id: https://svn.musicpd.org/mpd/trunk@6556 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-06-03Adding ChangeLog entry for zeroconf_enabled, adding Zeroconf section toJ. Alexander Treuman2-8/+13
mpdconf.example, and updating the zeroconf_* docs. git-svn-id: https://svn.musicpd.org/mpd/trunk@6474 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-06-03allow zeroconf to be disabled.Patrik Weiskircher2-0/+7
git-svn-id: https://svn.musicpd.org/mpd/trunk@6467 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-05-30Adding a null output to mpdconf.example.J. Alexander Treuman1-0/+7
git-svn-id: https://svn.musicpd.org/mpd/trunk@6394 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-05-27Increasing default buffer_before_play from 0% to 10%.J. Alexander Treuman2-2/+3
git-svn-id: https://svn.musicpd.org/mpd/trunk@6290 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-05-23Adding a note to mpdconf.example about increasing buffer_before_play if youJ. Alexander Treuman1-0/+1
hear skipping when changing songs. git-svn-id: https://svn.musicpd.org/mpd/trunk@6240 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-05-23Updating the audio_buffer_size and buffer_before_play entries inJ. Alexander Treuman1-4/+5
mpd.conf.5. git-svn-id: https://svn.musicpd.org/mpd/trunk@6239 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-05-23Adding JACK documentation to mpd.conf.5.J. Alexander Treuman1-0/+14
git-svn-id: https://svn.musicpd.org/mpd/trunk@6231 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-04-25mpd.conf.5 claimed the default alsa device was "hw:0,0", but it's actuallyJ. Alexander Treuman1-1/+1
"default". git-svn-id: https://svn.musicpd.org/mpd/trunk@5943 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-04-09Noting the defaults for use_mmap and gapless_mp3_playback in mpd.conf.5.J. Alexander Treuman1-2/+4
git-svn-id: https://svn.musicpd.org/mpd/trunk@5895 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-03-31Updating metadata_to_use docs to be more consistent with tagtypes command.J. Alexander Treuman2-2/+3
git-svn-id: https://svn.musicpd.org/mpd/trunk@5793 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-03-31Reordering parameters in mpd.conf.5 to match the order in mpdconf.example.J. Alexander Treuman1-31/+31
git-svn-id: https://svn.musicpd.org/mpd/trunk@5788 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-03-31Being a picky little bitch about those doc updates.J. Alexander Treuman1-2/+3
git-svn-id: https://svn.musicpd.org/mpd/trunk@5787 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-03-31Doc updates for 0.13.0Avuton Olrich1-0/+4
git-svn-id: https://svn.musicpd.org/mpd/trunk@5786 09075e82-0dd4-0310-85a5-a0d7c8717e4f
2007-02-13Tidying up libsamplerate documentation in the mpd.conf man page.J. Alexander Treuman1-13/+17
git-svn-id: https://svn.musicpd.org/mpd/trunk@5335 09075e82-0dd4-0310-85a5-a0d7c8717e4f
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-12 05:29:47 +0000