From 806acdd4f41e93bf1e3e67e99e11c55cce6188c3 Mon Sep 17 00:00:00 2001 From: "J. Alexander Treuman" Date: Mon, 28 Aug 2006 20:47:50 +0000 Subject: Rearrange mpd.conf.5 and conf.[ch] to use the more logical ordering of config parameters that the new (yet to be committed) mpdconf.example will use. git-svn-id: https://svn.musicpd.org/mpd/trunk@4715 09075e82-0dd4-0310-85a5-a0d7c8717e4f --- doc/mpd.conf.5 | 116 ++++++++++++++++++++++++++++----------------------------- 1 file changed, 58 insertions(+), 58 deletions(-) (limited to 'doc') diff --git a/doc/mpd.conf.5 b/doc/mpd.conf.5 index 81ae75ffc..c5a65d957 100644 --- a/doc/mpd.conf.5 +++ b/doc/mpd.conf.5 @@ -54,6 +54,39 @@ mpd will be saved to this file when mpd is terminated by a TERM signal or by the "kill" command. When mpd is restarted, it will read the state file and restore the state of mpd (including the playlist). .TP +.B user +This specifies the user that mpd will run as, if set. +.TP +.B bind_to_address +This specifies which address mpd binds to and listens on. Multiple +bind_to_address parameters may be specified. The default is "any", which binds +to all available addresses. +.TP +.B port +This specifies the port that mpd listens on. The default is 6600. +.TP +.B log_level +This specifies how verbose logs are. "default" is minimal logging, "secure" +reports from what address a connection is opened, and when it is closed, and +"verbose" records excessive amounts of information for debugging purposes. The +default is "default". +.TP +.B password +This specifies a password for access to mpd. The format is +"password@permissions" where permissions is a comma delimited list composed +of "read", "add", "control", and/or "admin". "read" allows for reading of the +database, displaying the current playlist, and current status of mpd. "add" +allows for adding songs and loading playlists. "control" allows for all other +player and playlist manipulations. "admin" allows the db to be updated and for +the client to kill mpd. An example value is "somePassword@read,add". Multiple +password parameters may be specified. +.TP +.B default_permissions +This specifies the permissions of a client that has not been authenticated +using a password. The format of permissions is specified in the description of +the "password" config parameter. If no passwords are specified, the default is +"read,add,control,admin", otherwise it is "" (no permissions). +.TP .B audio_output See \fBDESCRIPTION\fP and the various \fBAUDIO OUTPUT PARAMETERS\fP sections for the format of this parameter. Multiple audio_output parameters may be @@ -79,17 +112,6 @@ This specifies which mixer control to use (sometimes referred to as the "device"). Examples of mixer controls are PCM, Line1, Master, etc. An example for OSS is "Pcm", and an example for alsa is "PCM". .TP -.B filesystem_charset -This specifies the character set used for the filesystem. A list of supported -character sets can be obtained by running "iconv -l". The default is -determined from the locale when the db was originally created. -.TP -.B id3v1_encoding -This specifies the character set which ID3v1 tags are encoded in. A list of -supported character sets can be obtained by running "iconv -l". The default is -to let libid3tag convert them (from ISO-8859-1, as the standard specifies) and -do no additional conversion. -.TP .B replaygain If specified, mpd will adjust the volume of songs played using replaygain tags (see <\fBhttp://www.replaygain.org/\fP>). Setting this to "album" will adjust @@ -131,53 +153,6 @@ If the HTTP proxy server requires authentication, this specifies the username. .B http_proxy_password If the HTTP proxy server requires authentication, this specifies the password. .TP -.B user -This specifies the user that mpd will run as, if set. -.TP -.B bind_to_address -This specifies which address mpd binds to and listens on. Multiple -bind_to_address parameters may be specified. The default is "any", which binds -to all available addresses. -.TP -.B port -This specifies the port that mpd listens on. The default is 6600. -.TP -.B password -This specifies a password for access to mpd. The format is -"password@permissions" where permissions is a comma delimited list composed -of "read", "add", "control", and/or "admin". "read" allows for reading of the -database, displaying the current playlist, and current status of mpd. "add" -allows for adding songs and loading playlists. "control" allows for all other -player and playlist manipulations. "admin" allows the db to be updated and for -the client to kill mpd. An example value is "somePassword@read,add". Multiple -password parameters may be specified. -.TP -.B default_permissions -This specifies the permissions of a client that has not been authenticated -using a password. The format of permissions is specified in the description of -the "password" config parameter. If no passwords are specified, the default is -"read,add,control,admin", otherwise it is "" (no permissions). -.TP -.B metadata_to_use -This specifies the song metadata that will be scanned and made available to -clients. Note that you must recreate (not update) your database for changes to -this parameter to take effect. Possible values are artist, album, title, -track, name, genre, date, composer, performer, comment, and disc. Multiple -tags may be specified as a comma separated list. An example value is -"artist,album,title,track". The special value "none" may be used alone to -disable all metadata. The default is to use all known tag types except for -comments. -.TP -.B max_playlist_length -This specifies the maximum number of songs that can be in the playlist. The -default is 4096. -.TP -.B log_level -This specifies how verbose logs are. "default" is minimal logging, "secure" -reports from what address a connection is opened, and when it is closed, and -"verbose" records excessive amounts of information for debugging purposes. The -default is "default". -.TP .B connection_timeout If a client does not send any new data in this time period, the connection is closed. The default is 60. @@ -186,6 +161,10 @@ closed. The default is 60. This specifies the maximum number of clients that can be connected to mpd. The default is 5. .TP +.B max_playlist_length +This specifies the maximum number of songs that can be in the playlist. The +default is 4096. +.TP .B max_command_list_size This specifies the maximum size a command list can be. The default is 2048. .TP @@ -193,6 +172,27 @@ This specifies the maximum size a command list can be. The default is 2048. This specifies the maximum size of the output buffer to a client. The default is 8192. .TP +.B filesystem_charset +This specifies the character set used for the filesystem. A list of supported +character sets can be obtained by running "iconv -l". The default is +determined from the locale when the db was originally created. +.TP +.B id3v1_encoding +This specifies the character set which ID3v1 tags are encoded in. A list of +supported character sets can be obtained by running "iconv -l". The default is +to let libid3tag convert them (from ISO-8859-1, as the standard specifies) and +do no additional conversion. +.TP +.B metadata_to_use +This specifies the song metadata that will be scanned and made available to +clients. Note that you must recreate (not update) your database for changes to +this parameter to take effect. Possible values are artist, album, title, +track, name, genre, date, composer, performer, comment, and disc. Multiple +tags may be specified as a comma separated list. An example value is +"artist,album,title,track". The special value "none" may be used alone to +disable all metadata. The default is to use all known tag types except for +comments. +.TP .B save_absolute_paths_in_playlists This specifies whether relative or absolute paths for song filenames are used when saving playlists. The default is "no". -- cgit v1.2.3