.\" 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 "AUDIOLINK 1"
.TH AUDIOLINK 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"
audiolink \- Create AudioLink config file, databases and tables
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
audiolink [\fI\s-1OPTION\s0\fR]...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
AudioLink is a set of programs which help you manage your music
collection. It makes searching for music on your local storage media
easier and faster. Your searches can include a variety of criteria,
like male artists, female artists, band, genre, etc.
.PP
It supports music files of \s-1MP3\s0 and Ogg Vorbis formats.
.PP
\&\fBaudiolink\fR assists you in creating a configuration file for oft-used
options passed to the AudioLink programs and creating the MySQL
database and tables which the AudioLink programs, \fBalfilldb\fR\|(1) and
\&\fBalsearch\fR\|(1) use.
.PP
The options specified on the command prompt override the options
specified in the config file.
.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\-\-user\fR=\fIxxx\fR" 4
.IX Item "--user=xxx"
Username for the database
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
Display extra information about what's going on
.SH "MORE INFORMATION"
.IX Header "MORE INFORMATION"
The user and password fields for the database have to be
specified. There are three ways of doing this:
.IP "1. Command-line arguments" 4
.IX Item "1. Command-line arguments"
By specifying them via the \-\-user and \-\-pass command-line arguments to
the programs:
.Sp
\&\f(CW\*(C`alfilldb \-\-user=mysql_username \-\-pass=mysql_password \-\-prompt=basic /songs/\*(C'\fR
.Sp
\&\f(CW\*(C`alsearch \-\-user=mysql_username \-\-pass=mysql_password \-\-artist=kishore \-\-td=/songs/kishore\*(C'\fR
.IP "2. Environment variables" 4
.IX Item "2. Environment variables"
Setting the \s-1DBI_USER\s0 and \s-1DBI_PASS\s0 environment variables:
.Sp
If you are using bash, ksh, zsh or sh do this:
.Sp
\&\f(CW\*(C`export DBI_USER=mysql_username\*(C'\fR
.Sp
\&\f(CW\*(C`export DBI_PASS=mysql_password\*(C'\fR
.Sp
If you are using csh or tcsh, do this:
.Sp
\&\f(CW\*(C`setenv DBI_USER mysql_username\*(C'\fR
.Sp
\&\f(CW\*(C`setenv DBI_USER mysql_password\*(C'\fR
.Sp
Consult the man page of the respective shell interpreter that you
use for help on environment variables.
.IP "3. Config file" 4
.IX Item "3. Config file"
Specifying them in the config file (the most convenient). The config
file is stored in each user's home directory in the
\&\fI~/.audiolink/config\fR location.
.SH "CONFIGURATION FILE"
.IX Header "CONFIGURATION FILE"
The AudioLink configuration file \fIconfig\fR resides in the
\&\fI.audiolink/\fR directory in the user's home directory
(\fI\f(CI$HOME\fI/.audiolink/config\fR).
.PP
The format of the current config file is pretty easy to understand:
Just put in \f(CW\*(C`a = b\*(C'\fR on separate lines for all the options you want the
AudioLink scripts to use by default. Here, a is the option name, like
user, password, host, etc., and b is the value you wish to associate
the option with. For example, to set the username for accessing the
database to 'root', you would put this in the config file:
.PP
\&\f(CW\*(C`user = root\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
L<alfilldb(1)>, L<alsearch(1)>
The current version of this man page is available on the AudioLink
website at <http://audiolink.sourceforge.net/>.
.SH "BUGS"
.IX Header "BUGS"
Report bugs related to the AudioLink software or the man pages to the
audiolink-devel mailing list <audiolink\-devel@lists.sourceforge.net>.
.SH "AUTHOR"
.IX Header "AUTHOR"
This manual page is written and maintained by Amit Shah <amitshah@gmx.net>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
The AudioLink package is Copyright (C) 2003, Amit Shah
<amitshah@gmx.net>. All the programs and the documentation that come
as part of AudioLink are licensed by the \s-1GNU\s0 General Public License v2
(GPLv2).