.TH glyrc 1 "May 9 2012" .SH NAME .PP glyrc - search engine for music-related metadata .SH USAGE .IP .nf \f[C] glyrc\ GETTER\ [options] \f[] .fi .PP where GETTER must be one of: .IP \[bu] 2 cover .IP \[bu] 2 lyrics .IP \[bu] 2 artistphoto .IP \[bu] 2 artistbio .IP \[bu] 2 similarartists .IP \[bu] 2 similarsongs .IP \[bu] 2 albumreview .IP \[bu] 2 albumlist .IP \[bu] 2 tags .IP \[bu] 2 relations .IP \[bu] 2 tracklist .IP \[bu] 2 guitartabs .IP \[bu] 2 backdrops .SH GENERAL OPTIONS .SS -f --from String .PP Providers from where to get metadata. Refer to glyrc \[em]list for a full list .SS -w --write Path .PP Write metadata to the dir d, or filename d, special values stdout, stderr and null are supported. .PP Certain escapes are escaped inside the filename in the form :X:, where X may be one of: .IP \[bu] 2 type : The getter used in this query (e.g.\ cover) .IP \[bu] 2 artist : Artist \- as passed by \-a .IP \[bu] 2 album : Album \- as passed by \-b .IP \[bu] 2 title : Title \- as passed by \-t .IP \[bu] 2 size : Size in bytes .IP \[bu] 2 format : The image format or `txt' for textitems .IP \[bu] 2 source : The source URL of this item .IP \[bu] 2 prov : The Provider of this item .IP \[bu] 2 cksum : a md5sum of the data .IP \[bu] 2 rating : (Usually 0) .IP \[bu] 2 duration : (Only for tracks) Duration in seconds .IP \[bu] 2 number : An index incremented with each item (starting with 1) .PP The default format is ':artist:\f[I]:album:\f[]:title:\f[I]:type:\f[]:number:.:format:' Strings containing `/' are replaced with `|' automatically, so \[em]write ':artist:' for AC/DC will result in AC|DC .SS -n --number Integer .PP Download max. n items. Amount of actual downloaded items may be less. .SS -l --lang String .PP Language settings. Used by a few getters to deliever localized data. Given in ISO 639-1 codes like `de' .SS -o --only-lang .PP Only use providers that offer language specific data, this only applies for text items. .SS -z --fuzzyness Integer .PP Set threshold for level of Levenshtein algorithm. .SS -q --qsratio Float .PP How to weight quality/speed; 1.0 = full quality, 0.0 = full speed. .SS -x --plugmax Integer .PP Maximum number od download a plugin may deliever. Use to make results more vary. .SS -v --verbosity Integer .PP Set verbosity from 0 to 4. See online README for details. .SH NETWORK OPTIONS .SS -p --parallel Integer .PP Define the number of downloads that may be performed in parallel. .SS -u --useragent String .PP The useragent to use during HTTP requests .SS -r --redirects Integer .PP Define the number of redirects that are allowed. .SS -m --timeout Integer .PP Define the maximum number in seconds after which a download is cancelled. .SS -k --proxy String .PP Set the proxy to use in the form of [protocol://][user:pass\@]yourproxy.domain[:port] .SH PROVIDER SPECIFIC OPTIONS .SS -d --download .PP Download Images. .SS -D --skip-download .PP Don't download images, but return the URLs to them (act like a search engine) .SS -a --artist String .PP Artist name to search for .SS -b --album String .PP Album name to search for .SS -t --title String .PP Songname to search for .SS -e --maxsize Integer .PP (images only) The maximum size a cover may have. .SS -i --minsize Integer .PP (images only) The minimum size a cover may have. .SS -F --formats String .PP A semicolon separated list of imageformats that are allowed. e.g.: \[lq]png;jpeg\[rq] .SS -8 --force-utf8 .PP Forces utf8 encoding for text items, invalid encodings get sorted out .SH MISC OPTIONS .SS -L --list .PP List all fetchers and source providers for each and exit. .SS -h --help .PP This text you unlucky wanderer are viewing. .SS -V --version .PP Print the version string. .SS -U --update .PP Updates libglyr if new version is available. .SS -g --as-one .PP (Textitems only) Output all results as one (useful for tracklist and albumlist). .SS -G --no-as-one .PP Disables \-\-as-one (Default) .SS -y --color .PP Enables colored output for glyrc (Default) .SS -Y --no-color .PP Prints no colored output .SS -s --musictree-path p .PP p is a path to your music directory. Glyr might fetch things like folger.jpg from there .SS -j --callback Command .PP Set a bash command to be executed when a item is finished downloading; The special string is expanded with the actual path to the data. .SH DATABASE OPTIONS .SS -c --cache folder .PP Creates or opens an existing cache at folder/metadata.db and lookups data from there. .SS cache select [Query] .PP Selects data from the cache; you can use any other option behind this. .SS cache delete [Query] .PP Instead of searching for this element, the element is deleted from the database. Needs \[em]cache. .SS cache list .PP List all items in the database (including the artist / album / title / type). Needs \[em]cache. .SH EXAMPLES .IP .nf \f[C] glyrc\ cover\ \-\-artist\ SomeBand\ \-\-album\ SomeAlbum \f[] .fi .PP DB: .IP .nf \f[C] #\ Write\ found\ items\ to\ cache;\ create\ it\ if\ not\ existent glyrc\ lyrics\ \-a\ A\ \-b\ B\ \-\-cache\ /tmp #\ List\ all\ in\ the\ cache glyrc\ cache\ list\ \-\-cache\ /tmp #\ Delete\ artist/album glyrc\ cache\ delete\ cover\ \-a\ Equilibrium\ \-b\ Sagas\ \-\-cache\ /tmp #\ Search\ for\ two\ items\ in\ cache\ and\ print\ them glyrc\ cache\ select\ lyrics\ \-a\ Knorkator\ \-t\ \[aq]A\[aq]\ \-n\ 2\ \-\-cache\ /tmp \f[] .fi .PP With each item received you get a link to the original source, please refer to the individual terms of use, copying and distributing of this data might be not allowed. .PP A more detailed version of this help can be found online: https://github.com/sahib/glyr/wiki/Commandline-arguments .SH AUTHORS Christopher Pahl , Etienne Millon.