.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ALSEARCH 1" .TH ALSEARCH 1 "2020-08-11" "perl v5.30.3" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" alsearch \- Search the AudioLink database for music .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBalsearch\fR [\fI\s-1OPTION\s0\fR]... \fIsearch_option\fR... \fI\-\-td=/some/path/to/create/links/\fR .PP \&\fBalsearch\fR [\fI\s-1OPTION\s0\fR]... \fIsearch_option\fR... \fI\-s\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" You can use this script to search for songs in the AudioLink database. You can specify one or several options for the artist, composer, lyricist, album, etc., as the search criteria. .PP You can specify several \fIsearch_option\fR options to search for particular music files. See the section on \*(L"search options\*(R" for the list of options. .PP The search is not case sensitive. \fBalsearch\fR looks for strings as well as sub-strings in the fields being searched. See the \&\*(L"examples\*(R" section for more information. .PP Specifying the \fB\-\-td\fR (target directory) option is mandatory for creating links to the actual files. This directory will contain the symbolic links to the actual audio files. The directory will be created if it doesn't exist. .PP Creating symbolic links to the actual files is analogous to creating playlists in audio-playing software. Symbolic links are actually just point to the actual files on the hard disk. This way of creating and storing playlists is very useful in several ways, some of which are: .IP "1. Compatible across various audio players" 4 .IX Item "1. Compatible across various audio players" Since the \*(L"playlists\*(R" are actually files represented on your hard disk, you can add whole directories generated by the \fBalsearch\fR program in the playlist of your audio software. If you switch to another music player for whatever reason, you still have your playlists. You don't have to bother about compatibility between the playlist formats of the two players. .IP "2. Can be seen and operated upon in a file browser" 4 .IX Item "2. Can be seen and operated upon in a file browser" As the symbolic links are present on a file-system, your playlist collection can be viewed by using normal file operations in the shell or using a GUI-based file browsing program. If the file browsing program is supports file traversals and symlinks, it'll show you the information of the actual song. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-help\fR" 4 .IX Item "--help" Brief usage information .IP "\fB\-\-host\fR=\fIxxx\fR" 4 .IX Item "--host=xxx" Connects to the MySQL server on the target host. Default is localhost. .IP "\fB\-\-pass\fR=\fIxxx\fR" 4 .IX Item "--pass=xxx" Password for the database .IP "\fB\-s\fR, \fB\-\-na\fR" 4 .IX Item "-s, --na" Just displays the search results, doesn't create links (simulation mode) .IP "\fB\-\-td\fR=\fIxxx\fR" 4 .IX Item "--td=xxx" Target-directory in which to create links .IP "\fB\-\-user\fR=\fIxxx\fR" 4 .IX Item "--user=xxx" Username for the database .IP "\fB\-v\fR, \-\-verbose" 4 .IX Item "-v, --verbose" Displays some extra information. Useful for spotting errors and sending debug information. .SH "SEARCH OPTIONS" .IX Header "SEARCH OPTIONS" .IP "\fB\-\-album\fR=\fIxxx\fR" 4 .IX Item "--album=xxx" Search in the \*(L"album\*(R" field .IP "\fB\-\-artist\fR=\fIxxx\fR" 4 .IX Item "--artist=xxx" Search in the artist/band/performers fields. You can give this option multiple times, for example: .Sp \&\f(CW\*(C`alsearch \-\-artist=kishore \-\-artist=asha \-\-td=/songs/asha_kishore\*(C'\fR .IP "\fB\-\-comment\fR=\fIxxx\fR" 4 .IX Item "--comment=xxx" Search in the \*(L"comment\*(R" field .IP "\fB\-c\fR, \fB\-\-composer\fR=\fIxxx\fR" 4 .IX Item "-c, --composer=xxx" Search in the \*(L"composer\*(R" field .IP "\fB\-\-genre\fR=\fIxxx\fR" 4 .IX Item "--genre=xxx" Search in the \*(L"genre\*(R" field .IP "\fB\-l\fR, \fB\-\-lyricist\fR=\fIxxx\fR" 4 .IX Item "-l, --lyricist=xxx" Search in the \*(L"lyricist\*(R" field .IP "\fB\-\-title\fR=\fIxxx\fR" 4 .IX Item "--title=xxx" Search in the \*(L"title\*(R" field .SH "EXAMPLES" .IX Header "EXAMPLES" The options that take arguments can be specified in two ways: .PP \&\f(CW\*(C`alsearch \-\-artist="kishore kumar" \-\-td=/songs/kishore\*(C'\fR .PP \&\f(CW\*(C`alsearch \-\-artist "kishore kumar" \-\-td /songs/kishore\*(C'\fR .PP That is, the option and the argument can be separated with a '\fI \fR' (space) or an '\fI=\fR' (equal) sign. .PP In case you want to search for a string that has spaces, enclose the string in \*(L" \*(R". .PP \&\f(CW\*(C`alsearch \-\-artist=kishore \-\-composer=burman \-\-lyricist=bakshi\*(C'\fR .PP Will search for songs sung by *Kishore*, composed by *Burman* and written by *Bakshi*. Any name in the composer field which have \&\*(L"burman\*(R" in them will be matched. This means, it'll find songs composed by \s-1RD\s0 Burman, \s-1SD\s0 Burman, etc. This is true for all search fields. .SH "SEE ALSO" .IX Header "SEE ALSO" L, L The current version of this man page is available on the AudioLink website at . .SH "BUGS" .IX Header "BUGS" Report bugs related to the AudioLink software or the man pages to the audiolink-devel mailing list . .SH "AUTHOR" .IX Header "AUTHOR" This manual page is written and maintained by Amit Shah .SH "COPYRIGHT" .IX Header "COPYRIGHT" The AudioLink package is Copyright (C) 2003, Amit Shah . All the programs and the documentation that come as part of AudioLink are licensed by the \s-1GNU\s0 General Public License v2 (GPLv2).