From: kaliko Date: Tue, 10 Jun 2014 13:52:34 +0000 (+0200) Subject: Update documentation, generate manuals X-Git-Tag: mpd-sima/0.12.0pr4~3 X-Git-Url: https://git.kaliko.me/?a=commitdiff_plain;h=14a769add6d435a7ad7db4d36074dc79511af4e3;p=mpd-sima.git Update documentation, generate manuals --- diff --git a/data/man/Makefile b/data/man/Makefile index 0e6b1f3..67fb872 100644 --- a/data/man/Makefile +++ b/data/man/Makefile @@ -17,7 +17,7 @@ OPTIONS=--nonet\ all: man simadb_cli: simadb_cli.1.xml - $(XP) $(OPTIONS) $(XSL) $< + xmllint --xinclude --nowarning --noent $< | $(XP) $(OPTIONS) $(XSL) - mpd_sima: mpd_sima.1.xml xmllint --xinclude --nowarning --noent $< | $(XP) $(OPTIONS) $(XSL) - @@ -49,4 +49,11 @@ valid: clean_mpd_sima: rm -rf mpd-sima.1 mpd_sima.1.html -clean: clean_mpd_sima +clean_simadb_cli: + rm -rf simadb_cli.1 simadb_cli.1.html + +clean_mpd_sima.cfg: + rm -rf mpd_sima.cfg.5 mpd_sima.cfg.5.html + +clean: clean_mpd_sima clean_simadb_cli clean_mpd_sima.cfg + rm -rf ./*.pdf diff --git a/data/man/album.cfg b/data/man/album.cfg new file mode 100644 index 0000000..645be84 --- /dev/null +++ b/data/man/album.cfg @@ -0,0 +1,15 @@ +[MPD] +host=example.org +port=8000 + +[sima] +history_duration=48 # 2 days +queue_length=5 + +[lastfm] +queue_mode = album +album_to_add=2 + +[crop] +# keep 30 played tracks in playlist +consume = 30 diff --git a/data/man/files.xml b/data/man/files.xml new file mode 100644 index 0000000..992d2b4 --- /dev/null +++ b/data/man/files.xml @@ -0,0 +1,32 @@ + + + FILES + + + ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg + + Configuration file. + + + + ${XDG_DATA_HOME}/mpd_sima/sima.db + + SQLite DB file. + + + + ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ + + Persistant http cache. + + + + Usually XDG_DATA_HOME is set to + ${HOME}/.local/share and XDG_CONFIG_HOME to + ${HOME}/.config.You may override them using + command line option (cf. + mpd_sima + 1) + + diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1 index faae9d9..9fedc50 100644 --- a/data/man/mpd-sima.1 +++ b/data/man/mpd-sima.1 @@ -2,12 +2,12 @@ .\" Title: mpd-sima .\" Author: Jack Kaliko .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/25/2014 +.\" Date: 06/10/2014 .\" Manual: mpd-sima 0.12.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD\-SIMA" "1" "01/25/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual" +.TH "MPD\-SIMA" "1" "06/10/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -196,19 +196,32 @@ the section called \(lqENVIRONMENT\(rq .PP ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg .RS 4 -The per\-user configuration file\&. Usually -\fBXDG_CONFIG_HOME\fR -is set to -${HOME}/\&.config\&. +Configuration file\&. .RE .PP ${XDG_DATA_HOME}/mpd_sima/sima\&.db .RS 4 -SQLite database\&. Usually +SQLite DB file\&. +.RE +.PP +${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ +.RS 4 +Persistant http cache\&. +.RE +.PP +Usually \fBXDG_DATA_HOME\fR is set to -${HOME}/\&.local/share\&. -.RE +${HOME}/\&.local/share +and +\fBXDG_CONFIG_HOME\fR +to +${HOME}/\&.config\&. +.br +You may override them using command line option +\fB\-\-var_dir\fR +(cf\&. +\fBmpd_sima\fR(1)) .SH "ENVIRONMENT" .PP \fBMPD_HOST\fR, \fBMPD_PORT\fR @@ -233,7 +246,7 @@ mpd_sima\&.cfg .RS 4 mpd_sima\&.cfg is read if present\&. Otherwise built\-in defaults are used\&. An example should be provided in the tarball within -doc/examples/mpd_sima\&.cfg\&. On Debian system please look in +doc/examples/\&. On Debian system please look in /usr/share/doc/mpd\-sima\&. .RE .PP @@ -246,6 +259,9 @@ The default behavior is to add one track, this track is to be chosen among title To change these defaults, use the configuration file mpd_sima\&.cfg .RE +.PP +For details about mpd_sima\&.cfg refer to the manual +\fBmpd_sima.cfg\fR(5) .SH "FEEDBACK/BUGS" .PP The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback, @@ -257,8 +273,7 @@ users are welcome to join the dedicated chat room at .SH "SEE ALSO" .PP \fBmpc\fR(1), -\fBmpd\fR(1), -\fBmpd-sima.cfg\fR(5) +\fBmpd\fR(1) .PP /usr/share/doc/mpd\-sima/ .SH "AUTHOR" diff --git a/data/man/mpd_sima.1.xml b/data/man/mpd_sima.1.xml index 44d77c4..5362cb9 100644 --- a/data/man/mpd_sima.1.xml +++ b/data/man/mpd_sima.1.xml @@ -204,33 +204,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - - FILES - - - ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg - - - The per-user configuration file. Usually XDG_CONFIG_HOME is set to ${HOME}/.config. - - - - ${XDG_DATA_HOME}/mpd_sima/sima.db - - - SQLite database. Usually XDG_DATA_HOME is set to ${HOME}/.local/share. - - - - + ENVIRONMENT @@ -257,7 +231,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ mpd_sima.cfg is read if present. Otherwise built-in defaults are used. An example should be provided in the tarball within - doc/examples/mpd_sima.cfg. On Debian + doc/examples/. On Debian system please look in /usr/share/doc/&dhpackage;. @@ -275,25 +249,13 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - - - - SEE ALSO - - - - mpc - 1 - , - mpd - 1 - , - mpd-sima.cfg - 5 - - - - /usr/share/doc/mpd-sima/ + For details about mpd_sima.cfg refer to the manual + + mpd_sima.cfg + 5 + + + diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 new file mode 100644 index 0000000..95bc337 --- /dev/null +++ b/data/man/mpd_sima.cfg.5 @@ -0,0 +1,413 @@ +'\" t +.\" Title: mpd_sima.cfg +.\" Author: Jack Kaliko +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 06/10/2014 +.\" Manual: mpd-sima 0.12.0 User Manual +.\" Source: mpd-sima +.\" Language: English +.\" +.TH "MPD_SIMA\&.CFG" "5" "06/10/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +mpd_sima.cfg \- mpd\-sima will try to maintain some titles ahead in your play list following different policies\&. This manual document the configuration file for mpd\-sima\&. +.SH "DESCRIPTION" +.PP +This manual page documents briefly +\fBmpd\-sima\fR +configuration options available in user configuration file (see +the section called \(lqFILES\(rq)\&. +.SH "EXAMPLES" +.SS "Album queue mode\&." +.PP +Here is an example of album queue configuration\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +[MPD] +host=example\&.org +port=8000 + +[sima] +history_duration=48 # 2 days +queue_length=5 + +[lastfm] +queue_mode = album +album_to_add=2 + +[crop] +# keep 30 played tracks in playlist +consume = 30 + + +.fi +.if n \{\ +.RE +.\} +.SH "CONFIGURATION FILE" +.PP +The configuration file consists of sections, led by a +\fB[section]\fR +header and followed by +\fBname:\ \&value\fR +entries, with continuations in the style of RFC 822 (see section 3\&.1\&.1, \(lqLONG HEADER FIELDS\(rq); +\fBname=value\fR +is also accepted\&. Lines beginning with +\fI\*(Aq#\*(Aq\fR +or +\fI\*(Aq;\*(Aq\fR +are ignored and may be used to provide comments (\fINota Bene:\fR +inline comment are possible using +\fI\*(Aq#\*(Aq\fR)\&. +.PP +The default values are used in the options lists below\&. +.SS "MPD section" +.PP +This section is meant to configure MPD access, MPD host address / port and password if necessary\&. +.PP +\fB[MPD]\fR +.RS 4 +.RE +.PP +\fBhost=\fR\fIlocalhost\fR +.RS 4 +Set MPD host\&. Use IP or FQDN\&. +.RE +.PP +\fBport=\fR\fI6600\fR +.RS 4 +Set host port to access MPD to\&. +.RE +.PP +\fBpassword=\fR\fIs3cr3t\fR +.RS 4 +Set MPD password to use\&. Do not use this option if you don\*(Aqt have enabled password protected access on your MPD server\&. +.RE +.SS "log section" +.PP +Configure logging\&. +.PP +\fB[log]\fR +.RS 4 +.RE +.PP +\fBlogfile=\fR +.RS 4 +File to log to, usually in d\(aemon mode\&. +.br +Defaut (empty or unset) is to log to stdin/stdout\&. +.RE +.PP +\fBverbosity=\fR\fIinfo\fR +.RS 4 +Logging verbosity among +\fIdebug\fR, +\fIinfo\fR, +\fIwarning\fR, +\fIerror\fR\&. +.RE +.SS "sima section" +.PP +This section allows you to tweak core mpd_sima\&.cfg configuration\&. +.PP +\fB[sima]\fR +.RS 4 +.RE +.PP +\fBhistory_duration=\fR\fI8\fR +.RS 4 +How far to look back in history to avoid to play twice the same track/title (duration in hours)\&. +.RE +.PP +\fBqueue_length=\fR\fI1\fR +.RS 4 +This value triggers queue process if the play list length is less than specified queue_length\&. +.RE +.PP +\fBuser_db=\fR\fIfalse\fR +.RS 4 +Temporarily removed feature +.RE +.PP +mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&. +.br + +Plugins list is a comma separated string list\&. +.br + +Optional plugin\*(Aqs configuration lays in its own section\&. +.br +For instance a "AwesomePlugin" declared here gets its configuration from the corresponding section "[awesomeplugin]"\&. +.br +internal plugins will look for a section named after the lower\-cased name of the pluglin, ie\&. RandomFallBack\ \&\(-> randomfallback\&. +.PP +\fBinternal=\fR\fICrop, RandomFallBack, Lastfm\fR +.RS 4 +\fBCrop\fR +and +\fBRandomFallback\fR +are utilities plugins while +\fBLastfm\fR +is the actual queue plugin\&. +.br + +Another queue plugin is available as a "techno preview", it relies on EchoNest web services, replace +\fBLastFm\fR +with +\fBEchoNest\fR +to try\&. +.RE +.PP +\fBcontrib=\fR +.RS 4 +.RE +.SS "Crop section" +.PP +crop plugin\*(Aqs configuration: +.PP +\fB[crop]\fR +.RS 4 +.RE +.PP +\fBconsume=\fR\fI0\fR +.RS 4 +How many played tracks to keep in the play list\&. Allow to maintain a fixed length play list\&. Set to 0 to keep all played tracks\&. +.RE +.SS "RandomFallback section" +.PP +RandomFallback plugin\*(Aqs configuration: +.PP +\fB[randomfallback]\fR +.RS 4 +.RE +.PP +\fBflavour=\fR\fIsensible\fR +.RS 4 +When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available: +\fIpure\fR, +\fIsensible\fR, +\fIgenre\fR\&. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIpure\fR, pure random choice, even among recently played track\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIsensible\fR, use play history to filter chosen tracks\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIgenre\fR, Not implemented yet\&. +.RE +.sp +.RE +.SS "LastFm section" +.PP +This section allows you to tweak LastFM plugin\*(Aqs configuration\&. +.PP +\fB[lastfm]\fR +.RS 4 +.RE +.PP +\fBqueue_mode=\fR\fItrack\fR +.RS 4 +Queue mode to use among +\fItrack\fR, +\fItop\fR +and +\fIalbum\fR +(see +the section called \(lqQUEUE MODES\(rq +for info about queue modes)\&. +.RE +.PP +\fBmax_art=\fR\fI10\fR +.RS 4 +Number of similar artist to retrieve from local media library\&. +.br +When set to something superior to zero, it tries to get as much similar artists from media library\&. +.RE +.PP +\fBdepth=\fR\fI1\fR +.RS 4 +How many artists to base on similar artists search\&. +.br + +The first is the last played artist and so on back in the history\&. Highter depth allows to get wider suggestions, it might help to reduce looping over same artists\&. +.RE +.PP +\fBsingle_album=\fR\fIfalse\fR +.RS 4 +Prevent from queueing a track from the same album (it often happens with OST)\&. +.br + +Only relevant in "track" queue mode\&. +.RE +.PP +\fBtrack_to_add=\fR\fI1\fR +.RS 4 +How many track(s) to add\&. Only relevant in +\fBtop\fR +and +\fBtrack\fR +queue modes\&. +.RE +.PP +\fBalbum_to_add=\fR\fI1\fR +.RS 4 +How many album(s) to add\&. Only relevant in +\fBalbum\fR +queue modes\&. +.RE +.PP +\fBcache=\fR\fITrue\fR +.RS 4 +Whether or not to use on\-disk persistent http cache\&. +.br +When set to "true", sima will use a persistent cache for its http client\&. The cache is written along with the dbfile in: +.br +$XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&. +.br + +If set to "false", caching is still done but in memory\&. +.RE +.SH "QUEUE MODES" +.PP +mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the one currently played\&. +.PP +mpd\-sima tries preferably to chose among unplayed artists or at least not recently played artist\&. Concerning track and album queue modes titles are chosen purely at random among unplayed tracks\&. +.PP +\fBtrack\fR +.RS 4 +Queue a similar track chosen at random from a similar artist\&. +.RE +.PP +\fBtop\fR +.RS 4 +Queue a track from a similar artist, chosen among "top tracks" according to last\&.fm data mining\&. +.RE +.PP +\fBalbum\fR +.RS 4 +Queue a whole album chosen at random from a similar artist\&. +.sp +\fINota Bene:\fR +.br + +Due to the track point of view of database build upon tracks tags an album lookup for a specific artist will return albums as soon as this artist appears in a single track of the album\&. +.br + +For instance looking for album from "The Velvet Underground" will fetch "Last Days" and "Juno" OSTs because the band appears on the soundtrack of these two movies\&. +.br + +A solution is for you to set AlbumArtists tag to something different than the actual artist of the track\&. For compilations, OSTs etc\&. a strong convention is to use "Various Artists" for this tag\&. +.sp +mpd\-sima is currently looking for AlbumArtists tags and avoid album where this tag is set with "Various Artists"\&. If a single track within an album is found with AlbumArtists:"Various Artists" the complete album is skipped and won\*(Aqt be queued\&. +.br + +It is planned to allow users to set the values of AlbumArtists tag triggering this behaviour\&. cf\&. feature request #2085 on the tracker\&. +.RE +.SH "FILES" +.PP +${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg +.RS 4 +Configuration file\&. +.RE +.PP +${XDG_DATA_HOME}/mpd_sima/sima\&.db +.RS 4 +SQLite DB file\&. +.RE +.PP +${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/ +.RS 4 +Persistant http cache\&. +.RE +.PP +Usually +\fBXDG_DATA_HOME\fR +is set to +${HOME}/\&.local/share +and +\fBXDG_CONFIG_HOME\fR +to +${HOME}/\&.config\&. +.br +You may override them using command line option +\fB\-\-var_dir\fR +(cf\&. +\fBmpd_sima\fR(1)) +.SH "FEEDBACK/BUGS" +.PP +The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback, +\m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&. +.PP +XMPP +users are welcome to join the dedicated chat room at +\m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&. +.SH "SEE ALSO" +.PP +\fBmpc\fR(1), +\fBmpd\fR(1) +.PP +/usr/share/doc/mpd\-sima/ +.SH "AUTHOR" +.PP +\fBJack Kaliko\fR <\&kaliko@azylum\&.org\&> +.RS 4 +Wrote this man page and is currently leading MPD_sima project\&. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2009-2014 Jack Kaliko +.br +.PP +This manual page was written for the Debian system (and may be used by others)\&. +.PP +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&. +.PP +On Debian systems, the complete text of the GNU General Public License can be found in +/usr/share/common\-licenses/GPL\&. +.sp diff --git a/data/man/mpd_sima.cfg.5.xml b/data/man/mpd_sima.cfg.5.xml new file mode 100644 index 0000000..cb6f47d --- /dev/null +++ b/data/man/mpd_sima.cfg.5.xml @@ -0,0 +1,395 @@ + + + + + + +]> + + + + + &dhutils; + &dhsection; + + + &dhutils; + &dhpackage; will try to maintain some titles ahead in your play + list following different policies. This manual document the + configuration file for &dhpackage;. + + + DESCRIPTION + This manual page documents briefly &dhpackage; + configuration options available in user configuration file + (see ). + + + EXAMPLES + + + Album queue mode. + Here is an example of album queue configuration. + + + + + + + Configuration file + The configuration file consists of sections, led by a + [section] header and followed by + entries, with continuations in the style of RFC 822 (see section + 3.1.1, “LONG HEADER FIELDS”); is also accepted. Lines + beginning with '#' or ';' + are ignored and may be used to provide comments (Nota + Bene: inline comment are possible using '#'). + OPTIONS + The default values are used in the options lists below. + + MPD section + This section is meant to configure MPD access, MPD host + address / port and password if necessary. + + + + + + + + localhost + + Set MPD host. Use IP or FQDN. + + + + 6600 + + Set host port to access MPD to. + + + + s3cr3t + + Set MPD password to use. Do not use this option + if you don't have enabled password protected access + on your MPD server. + + + + + + Configure logging. + log section + + + + + + + + + File to log to, usually in dæmon mode.Defaut + (empty or unset) is to log to stdin/stdout. + + + + info + + Logging verbosity among + debug, + info, + warning, + error. + + + + + + sima section + This section allows you to tweak core &dhutils; configuration. + + + + + + + 8 + + How far to look back in history to avoid to play + twice the same track/title (duration in + hours). + + + + 1 + + This value triggers queue process if the play + list length is less than specified + queue_length. + + + + false + + Temporarily removed feature + + + + + &dhpackage;'s plugin management for internal source plugin + and contrib (ie. external plugins). Plugins list is a + comma separated string list. Optional plugin's + configuration lays in its own section.For instance a + "AwesomePlugin" declared here gets its configuration from the + corresponding section "[awesomeplugin]".internal plugins + will look for a section named after the lower-cased name of the + pluglin, ie. RandomFallBack → randomfallback. + + + + Crop, RandomFallBack, Lastfm + + and + are utilities plugins while is the + actual queue plugin. Another queue plugin is available as + a "techno preview", it relies on EchoNest web services, replace + with to try. + + + + + + + + + + + + Crop section + crop plugin's configuration: + + + + + 0 + + How many played tracks to keep in the play list. + Allow to maintain a fixed length play list. + Set to 0 to keep all played tracks. + + + + + + RandomFallback section + RandomFallback plugin's configuration: + + + + + sensible + + When no similar tracks are found, falling back to + random queuing. Different mode, aka random flavour, + are available: + pure, + sensible, + genre. + + + pure, pure random choice, even among recently played track. + + + + sensible, use play history to filter chosen tracks. + + + + genre, Not implemented yet. + + + + + + + + + LastFm section + This section allows you to tweak LastFM plugin's configuration. + + + + + + track + + Queue mode to use among + track, + top and + album (see for info about queue modes). + + + + 10 + + Number of similar artist to retrieve from local + media library.When set to something superior + to zero, it tries to get as much similar artists + from media library. + + + + 1 + + How many artists to base on similar artists + search. The first is the last played artist + and so on back in the history. Highter depth + allows to get wider suggestions, it might help to + reduce looping over same artists. + + + + + false + + Prevent from queueing a track from the same album + (it often happens with OST). + Only relevant in "track" queue mode. + + + + 1 + + How many track(s) to add. Only relevant in + and + queue modes. + + + + 1 + + How many album(s) to add. Only relevant in + queue modes. + + + + True + + Whether or not to use on-disk persistent http + cache.When set to "true", sima will use a + persistent cache for its http client. The cache is + written along with the dbfile in: + $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE. + If set to "false", caching is still done but in memory. + + + + + + + + QUEUE MODES + &dhpackage; offers different queue modes. All of them pick up + tracks from artists similar to the one currently played. + &dhpackage; tries preferably to chose among unplayed artists or + at least not recently played artist. Concerning track and album + queue modes titles are chosen purely at random among unplayed + tracks. + + + + + Queue a similar track chosen at random from a similar artist. + + + + + + Queue a track from a similar artist, chosen among + "top tracks" according to last.fm data mining. + + + + + + Queue a whole album chosen at random from a similar artist. + Nota Bene: Due to the + track point of view of database build upon tracks tags + an album lookup for a specific artist will return + albums as soon as this artist appears in a single track + of the album. + For instance looking for album from "The Velvet + Underground" will fetch "Last Days" and "Juno" OSTs + because the band appears on the soundtrack of these two + movies. + A solution is for you to set AlbumArtists tag to + something different than the actual artist of the + track. For compilations, OSTs etc. a strong convention + is to use "Various Artists" for this tag. + &dhpackage; is currently looking for AlbumArtists tags + and avoid album where this tag is set with "Various + Artists". If a single track within an album is found + with AlbumArtists:"Various Artists" the complete album + is skipped and won't be queued. + It is planned to allow users to set the values of + AlbumArtists tag triggering this behaviour. cf. + feature request #2085 on the tracker. + + + + + + + + diff --git a/data/man/seealso.xml b/data/man/seealso.xml new file mode 100644 index 0000000..79415a1 --- /dev/null +++ b/data/man/seealso.xml @@ -0,0 +1,17 @@ + + + SEE ALSO + + + mpc + 1 + , + mpd + 1 + + + /usr/share/doc/mpd-sima/ + + + diff --git a/data/man/simadb_cli.1 b/data/man/simadb_cli.1 new file mode 100644 index 0000000..b221a72 --- /dev/null +++ b/data/man/simadb_cli.1 @@ -0,0 +1,383 @@ +'\" t +.\" Title: simadb_cli +.\" Author: Jack Kaliko +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 06/10/2014 +.\" Manual: mpd-sima 0.12.0 User Manual +.\" Source: mpd-sima +.\" Language: English +.\" +.TH "SIMADB_CLI" "1" "06/10/2014" "mpd-sima" "mpd-sima 0.12.0 User Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +simadb_cli \- simadb_cli is a command line interface editor for the sima user DB\&. +.SH "SYNOPSIS" +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-add_similarity=\fR\fIsimilarity_string\fR [\fB\-\-check_names\fR] [\fB\-\-dbfile=\fR\fIdb_file\fR] [\fB\-\-reciprocal\fR] [\fB\-\-host=\fR\fImpd_host\fR] [\fB\-\-port=\fR\fImpd_port\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-remove_artist=\fR\fIartist\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] [\fB\-\-reciprocal\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-remove_similarity=\fR\fI"main\ artist,similar\ artist"\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] [\fB\-\-reciprocal\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-purge_hist\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-view_artist=\fR\fB\fI"artist\ name"\fR\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-view_all\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR {\fB\-\-bl_curr_trk\fR | \fB\-\-bl_curr_art\fR | \fB\-\-bl_curr_alb\fR | \fB\-\-bl_art=\fR\fIartist_name\fR} [\fB\-\-dbfile=\fR\fIdb_file\fR] [\fB\-\-host=\fR\fImpd_host\fR] [\fB\-\-port=\fR\fImpd_port\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-remove_bl=\fR\fIrow_id\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR \fB\-\-view_bl\fR [\fB\-\-dbfile=\fR\fIdb_file\fR] +.HP \w'\fBsimadb_cli\fR\ 'u +\fBsimadb_cli\fR {{\fB\-h\fR\ |\ \fB\-\-help\fR} | \fB\-\-version\fR} +.SH "DESCRIPTION" +.PP +This manual page documents briefly the +\fBsimadb_cli\fR +commands\&. +.PP +simadb_cli is a command line interface to get and edit users similarities and blacklist database used with MPD_sima\&. The default database file (see +the section called \(lqFILES\(rq) can be overridden if you want\&. +.PP +Consider reading +the section called \(lqA WORD ABOUT SIMA DATA BASE\(rq +to understand the structure and relation of similarities within the database\&. +.SH "EXAMPLE" +.SS "Similarity edition" +.PP +Here follows some simple examples on how to deal with similarity database\&. +.PP +Pay attention, the following examples set one\-way similarities in the DB! Read more about it in +the section called \(lqA WORD ABOUT SIMA DATA BASE\(rq\&. +.PP +\fIAdding a similarity between two artists\&.\fR +In the following example "Pelican" will point to "Russian Circles" with a match score of 88% (ie\&. "Russian Circles" 88% similar to Pelican, not reciprocal), it will also check against MPD the presence of both artists in the music library\&. +.PP +\fBsimadb_cli \-\-add "Pelican,Russian Circles:80" \-\-check_names\fR +.PP +Similarity string use comma "," as artists separator and semi colon ":" for artist/similarity score separator, cf\&. +the section called \(lqSIMILARITY FORMAT\(rq\&. +.PP +\fIAdding a similarity between multiple artists\&.\fR +In the following example "Rage Against The Machine" will point to "Tool" and "Audioslave" as similar artists and controls artists names are actually in MPD music library\&. +.PP +\fBsimadb_cli \-\-add "Rage Against The Machine,Tool:70,Audiosalve:80" \-\-check_names\fR +.PP +\fIViewing similarit(y|ies) for an artist\&.\fR +In the following example we are looking for entries for "Rage Against The Machine" +.PP +\fBsimadb_cli \-\-view_artist "Rage Against The Machine"\fR +.SS "Black list edition" +.PP +\fIAdding to black list\&.\fR +You can add a single track, an album or an artist to the black list\&. The element to black list is chosen from the currently playing track\&. Use +\fB\-\-bl_curr_trk\fR +to prevent simadb_cli to queue this track, +\fB\-\-bl_curr_alb\fR +or +\fB\-\-bl_curr_art\fR +respectively for the album and the artist\&. +.PP +Remember you need access to your MPD server to retrieve information to black list\&. Defaults are localhost:6600 or found in environment variables but you may set it up from command line: +.PP +\fBsimadb_cli \-\-bl_curr_art \-S mympd\&.example\&.org\fR +.PP +\fITo black list a specific artist\fR +(not currently playing) you can use +\fB\-\-bl_ar="Artist name to black list"\fR\&. +.SH "OPTIONS" +.PP +The program follows the usual GNU command line syntax, with long options starting with two dashes ("\-")\&. A summary of options is included below\&. +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print help and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print version and exit\&. +.RE +.PP +\fB\-a \fR\fB\fIsimilarity_string\fR\fR, \fB\-\-add_similarity=\fR\fB\fIsimilarity_string\fR\fR +.RS 4 +Add similarity to the database\&. +.br +For more details about the +\fIsimilarity_string\fR +see +the section called \(lqSIMILARITY FORMAT\(rq\&. +.RE +.PP +\fB\-c\fR, \fB\-\-check_names\fR +.RS 4 +Use with +\fB\-\-add_similarity\fR +in order to check artists names used in +\fIsimilarity_string\fR\&. simadb_cli will control presence of artists names in MPD library\&. Default is to look for MPD server on localhost:6600 or environment variables +\fBMPD_HOST\fR +and +\fBMPD_PORT\fR +if set\&. +.br +You can as well give simadb_cli host/port on the command line using respectively +\fB\-S\fR +and +\fB\-P\fR\&. +.RE +.PP +\fB\-\-bl_art=\fR\fB\fIartist_name\fR\fR +.RS 4 +Use to black list +\fIartist_name\fR\&. simadb_cli is checking +\fIartist_name\fR +is actually in MPD music library (cf +\fB\-S\fR +and +\fB\-P\fR +options to set MPD host/address if necessary)\&. +.sp +If +\fIartist_name\fR +is not found the script print out a list of matching artists\&. +.RE +.PP +\fB\-\-bl_curr_trk\fR | \fB\-\-bl_curr_art\fR | \fB\-\-bl_curr_alb\fR +.RS 4 +Use to black list the currently playing track|artist|album\&. You need access to your MPD server, use +\fB\-S\fR +and +\fB\-P\fR +to set MPD host/address if necessary\&. +.RE +.PP +\fB\-d \fR\fB\fIdb_file\fR\fR, \fB\-\-dbfile=\fR\fB\fIdb_file\fR\fR +.RS 4 +Use the specific file +\fIdb_file\fR +as database\&. +.br +Default is too use +\fBXDG_DATA_HOME\fR +(see +the section called \(lqFILES\(rq)\&. +.RE +.PP +\fB\-\-purge_hist\fR +.RS 4 +Purge history, you may supply an alternative DB file with \-\-dbfile option\&. +.RE +.PP +\fB\-r\fR, \fB\-\-reciprocal\fR +.RS 4 +Use with an editing options in order to edit reciprocal similarity as well\&. +\fB\-\-add_similarity\fR +and +\fB\-\-remove_{artist|similarity}\fR +are supporting reciprocal edition\&. +.sp +\fIN\&.B\fR: this option has to appear after the editing option on the command line\&. +.sp +See +the section called \(lqA WORD ABOUT SIMA DATA BASE\(rq +for further information about reciprocity notion\&. +.RE +.PP +\fB\-\-remove_artist=\fR\fB\fIartist\fR\fR +.RS 4 +Use to remove an artist entry (as main artist) with its associated similarities\&. To remove artist where it appears as a similar artist use the +\fB\-\-reciprocal\fR +option\&. +.RE +.PP +\fB\-\-remove_bl=\fR\fB\fIrow_id\fR\fR +.RS 4 +Use to remove a black list entry\&. To get the row_id to suppress use +\fB\-\-view_bl\fR +option\&. +.RE +.PP +\fB\-\-remove_similarity=\fR\fB\fI"main artist,similar artist"\fR\fR +.RS 4 +Use to remove a single similarity between a main artist and an associated similarity\&. Give the main artist first, use comma (",") to separate it from similar artist\&. +.br +Use of +\fB\-\-reciprocal\fR +is possible here, see +the section called \(lqA WORD ABOUT SIMA DATA BASE\(rq\&. +.sp +This option is useful in case you want to remove only a specific similarity between two artists, to remove completely an artist use +\fB\-\-remove_artist\fR +instead\&. +.RE +.PP +\fB\-v \fR\fB\fI"artist name"\fR\fR, \fB\-\-view_artist=\fR\fB\fI"artist name"\fR\fR +.RS 4 +Get entries for +\fI"artist name"\fR +in the data base (print to stdout)\&. +.RE +.PP +\fB\-\-view_bl\fR +.RS 4 +Get all entries in the black list\&. +.RE +.PP +\fB\-\-view_all\fR +.RS 4 +Get all entries in the data base (print to stdout)\&. +.RE +.PP +\fB\-P \fR\fB\fImpd_port\fR\fR, \fB\-\-port=\fR\fB\fImpd_port\fR\fR +.RS 4 +Use the specific port number +\fImpd_port\fR +on MPD server\&. This overrides +\fBMPD_PORT\fR +environment variable\&. +.br +Default is +\fI6600\fR\&. +.RE +.PP +\fB\-S \fR\fB\fImpd_host\fR\fR, \fB\-\-host=\fR\fB\fImpd_host\fR\fR +.RS 4 +Use the specific host +\fImpd_host\fR +as MPD server\&. +.br +\fImpd_host\fR +can be an +IP +or a fully qualified domain name as long as your system can resolve it\&. This overrides +\fBMPD_HOST\fR +environment variable\&. +.br +Default is +\fIlocalhost\fR\&. +.RE +.SH "FILES" +.PP +${XDG_DATA_HOME}/mpd_sima/sima\&.db +.RS 4 +SQLite DB file\&. Usually +\fBXDG_DATA_HOME\fR +is set to +${HOME}/\&.local/share\&. +.RE +.SH "SIMILARITY FORMAT" +.PP +The +\fIsimilarity_string\fR +has to be formatted following a special pattern in order for simadb_cli to extract similarity relations between artists names\&. Usually a similarity entry is defined as a main artist, lets say +\fImain_art\fR, followed by a list of similar artists which you want to be related to that +\fImain_art\fR, each artist of that list with a specific similarity value, a match score, quantifying the similarity relation with the +\fImain_art\fR\&. The match score value is an integer in [0 ,100] with 100 corresponding to a perfect match\&. +.PP +\fIsimilarity_string\fR +is then to be formatted as follow: +.PP +\fBmain_art,first artist:,second artist:\fR +.PP +Each artist group are separated with commas (",") and inside each group the artist name and the match score is colon (":") separated\&. Obviously the first artist group, as the main artist, does not have a match score\&. +.PP +Lets see how it works with an example\&. I consider "Led Zeppelin" to be similar to "Tool" with a match score of 25, I also want to have "Audioslave" related to "Led Zeppelin" with a score of 20\&. Then the +\fIsimilarity_string\fR +will be the following: +.PP +\fBLed Zeppelin,Tool:25,Audiosalve:20\fR +.PP +See +the section called \(lqA WORD ABOUT SIMA DATA BASE\(rq +for more details about how similarities are handled +.SH "A WORD ABOUT SIMA DATA BASE" +.PP +The similarity database is defined from the point of view of a +\fImain artist\fR +which is declared related to a list of +\fIsimilar artists\fR\&. That means when you define +\fImain_art\fR +to be similar to +\fIsim_art A\fR +and +\fIsim_art B\fR +the reciprocal won\*(Aqt be true, +\fIsim_art A\fR +and +\fIsim_art B\fR +are not similar to +\fImain_art\fR\&. At least this is the default behavior when you edit entries with simadb_cli, this is also the way last\&.fm is working concerning similar artists\&. This documentation is using that particular terminology to specify which kind of artist we are dealing with : "main artist" or "similar artist"\&. +.br +The +\fB\-\-reciprocal\fR +option allows one to add reciprocal relation where +\fIsim_art A\fR +and +\fIsim_art B\fR +become respectively the +\fImain_art\fR\&. Using +\fB\-\-reciprocal\fR +you will then edit two more entries in the database\&. To summarize here is what you\*(Aqll end up with in your data base adding similarity with this string +\fBmain_art,sim_art A:34,sim_art B:45\fR\&. +.PP +\fBsimadb_cli \-\-reciprocal \-\-add_similarity=main_art,sim_art A:34,sim_art B:45\fR +.PP +main_art similar to sim_art A:34 and sim_art B:45 +.br +sim_art A similar to main_art:34 +.br +sim_art B similar to main_art:45 +.PP +Without the reciprocal option you would have add only the first similarity\&. Usually using the reciprocal option is the desired behavior, at least what users have in mind when thinking of similarity relation between to artists but keep in mind that it may lead to have MPD_sima more sensible to loop over the same two artist (ASSERTION TO BE CONFIRMED)\&. +.SH "FEEDBACK/BUGS" +.PP +The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback, +\m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&. +.PP +XMPP +users are welcome to join the dedicated chat room at +\m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&. +.SH "SEE ALSO" +.PP +\fBmpc\fR(1), +\fBmpd\fR(1) +.PP +/usr/share/doc/mpd\-sima/ +.SH "AUTHOR" +.PP +\fBJack Kaliko\fR <\&kaliko@azylum\&.org\&> +.RS 4 +Wrote this man page and is currently leading MPD_sima project\&. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2009-2014 Jack Kaliko +.br +.PP +This manual page was written for the Debian system (and may be used by others)\&. +.PP +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&. +.PP +On Debian systems, the complete text of the GNU General Public License can be found in +/usr/share/common\-licenses/GPL\&. +.sp diff --git a/data/man/simadb_cli.1.xml b/data/man/simadb_cli.1.xml new file mode 100644 index 0000000..5448f86 --- /dev/null +++ b/data/man/simadb_cli.1.xml @@ -0,0 +1,409 @@ + + + + + + +]> + + + + + &dhutils; + &dhsection; + + + &dhutils; + &dhutils; is a command line interface editor for the sima user DB. + + + + &dhutils; + similarity_string + + + + + db_file + + + + + + mpd_host + + + mpd_port + + + + &dhutils; + artist + + db_file + + + + + + + &dhutils; + "main artist,similar artist" + + db_file + + + + + + + &dhutils; + + + db_file + + + + &dhutils; + + + db_file + + + + &dhutils; + + + db_file + + + + &dhutils; + + + + + artist_name + + + db_file + + + mpd_host + + + mpd_port + + + + &dhutils; + row_id + + db_file + + + + &dhutils; + + + db_file + + + + &dhutils; + + + + + + + + + + + + + + DESCRIPTION + This manual page documents briefly the + &dhutils; commands. + simadb_cli is a command line interface to get and edit users + similarities and blacklist database used with MPD_sima. The default + database file (see ) can be overridden if + you want. + Consider reading to understand the + structure and relation of similarities within the database. + + + EXAMPLE + + Similarity edition + Here follows some simple examples on how to deal with similarity database. + Pay attention, the following examples set one-way similarities in the DB! Read more about it in . + Adding a similarity between two artists. In the following example "Pelican" will point + to "Russian Circles" with a match score of 88% (ie. "Russian Circles" + 88% similar to Pelican, not reciprocal), it will also check against MPD + the presence of both artists in the music library. + &dhutils; --add "Pelican,Russian Circles:80" --check_names + Similarity string use comma "," as artists separator and semi colon ":" for + artist/similarity score separator, cf. . + Adding a similarity between multiple artists. In the following example "Rage + Against The Machine" will point to "Tool" and "Audioslave" as similar + artists and controls artists names are actually in MPD music library. + &dhutils; --add "Rage Against The Machine,Tool:70,Audiosalve:80" --check_names + Viewing similarit(y|ies) for an artist. In the + following example we are looking for entries for "Rage Against The Machine" + &dhutils; --view_artist "Rage Against The Machine" + + + Black list edition + Adding to black list. You can add a single + track, an album or an artist to the black list. The element to + black list is chosen from the currently playing track. Use + to prevent &dhutils; to queue this + track, or respectively for the album and the + artist. + + Remember you need access to your MPD server to retrieve + information to black list. Defaults are localhost:6600 or found in + environment variables but you may set it up from command + line: + + &dhutils; --bl_curr_art -S mympd.example.org + + To black list a specific artist (not + currently playing) you can use . + + + + + OPTIONS + The program follows the usual GNU command line syntax, + with long options starting with two dashes ("-"). A summary of + options is included below. + + + + + + + Print help and exit. + + + + + + Print version and exit. + + + + + + + Add similarity to the database.For more details about the similarity_string see . + + + + + + + Use with in order to check artists names used in similarity_string. &dhutils; will control presence of artists names in MPD library. Default is to look for MPD server on localhost:6600 or environment variables MPD_HOST and MPD_PORT if set.You can as well give &dhutils; host/port on the command line using respectively and . + + + + + + Use to black list artist_name. &dhutils; is checking artist_name is actually in MPD music library (cf and options to set MPD host/address if necessary). + If artist_name is not found the script print out a list of matching artists. + + + + | | + + Use to black list the currently playing track|artist|album. You need access to your MPD server, use and to set MPD host/address if necessary. + + + + + + + Use the specific file db_file as database.Default is too use XDG_DATA_HOME (see ). + + + + + + Purge history, you may supply an alternative DB file with --dbfile option. + + + + + + + Use with an editing options in order to edit reciprocal similarity as well. and are supporting reciprocal edition. + N.B: this option has to appear after the editing option on the command line. + See for further information about reciprocity notion. + + + + + + Use to remove an artist entry (as main artist) with its associated similarities. To remove artist where it appears as a similar artist use the option. + + + + + + Use to remove a black list entry. To get the row_id to suppress use option. + + + + + + Use to remove a single similarity between a main artist and an associated similarity. Give the main artist first, use comma (",") to separate it from similar artist.Use of is possible here, see . + This option is useful in case you want to remove only a specific similarity between two artists, to remove completely an artist use instead. + + + + + + + Get entries for "artist name" in the data base (print to stdout). + + + + + + Get all entries in the black list. + + + + + + Get all entries in the data base (print to stdout). + + + + + + + Use the specific port number mpd_port on MPD server. This overrides MPD_PORT environment variable.Default is 6600. + + + + + + + Use the specific host mpd_host as MPD server.mpd_host can be an IP or a fully qualified domain name as long as your system can resolve it. This overrides MPD_HOST environment variable.Default is localhost. + + + + + + FILES + + + ${XDG_DATA_HOME}/mpd_sima/sima.db + + SQLite DB file. Usually XDG_DATA_HOME is set to ${HOME}/.local/share. + + + + + + SIMILARITY FORMAT + The similarity_string has to be formatted following a special pattern in order for simadb_cli to extract similarity relations between artists names. Usually a similarity entry is defined as a main artist, lets say main_art, followed by a list of similar artists which you want to be related to that main_art, each artist of that list with a specific similarity value, a match score, quantifying the similarity relation with the main_art. The match score value is an integer in [0 ,100] with 100 corresponding to a perfect match. + similarity_string is then to be formatted as follow: + main_art,first artist:<score>,second artist:<score> + Each artist group are separated with commas (",") and inside each group the artist name and the match score is colon (":") separated. Obviously the first artist group, as the main artist, does not have a match score. + Lets see how it works with an example. I consider "Led Zeppelin" to be similar to "Tool" with a match score of 25, I also want to have "Audioslave" related to "Led Zeppelin" with a score of 20. Then the similarity_string will be the following: + Led Zeppelin,Tool:25,Audiosalve:20 + See for more details about how similarities are handled + + + A WORD ABOUT SIMA DATA BASE + The similarity database is defined from the point of view of a main artist which is declared related to a list of similar artists. That means when you define main_art to be similar to sim_art A and sim_art B the reciprocal won't be true, sim_art A and sim_art B are not similar to main_art. At least this is the default behavior when you edit entries with simadb_cli, this is also the way last.fm is working concerning similar artists. This documentation is using that particular terminology to specify which kind of artist we are dealing with : "main artist" or "similar artist".The option allows one to add reciprocal relation where sim_art A and sim_art B become respectively the main_art. Using you will then edit two more entries in the database. To summarize here is what you'll end up with in your data base adding similarity with this string main_art,sim_art A:34,sim_art B:45. + simadb_cli --reciprocal --add_similarity=main_art,sim_art A:34,sim_art B:45 + main_art similar to sim_art A:34 and sim_art B:45sim_art A similar to main_art:34sim_art B similar to main_art:45 + Without the reciprocal option you would have add only the first similarity. Usually using the reciprocal option is the desired behavior, at least what users have in mind when thinking of similarity relation between to artists but keep in mind that it may lead to have MPD_sima more sensible to loop over the same two artist (ASSERTION TO BE CONFIRMED). + + + + +