lkt.old.template

.\" vim: ft=groff
.TH "LKT.OLD" "1" "___DATE___" "LEKTOR MK 7"
.SH "NAME"

lkt.old \- the old lektor command line client, kept for some back-compatibility issues

.PP
\fB/!\\ Deprecated /!\\\fP

.SH "OVERVIEW"
\fBlkt.old\fP is the old \fBlektord\fP client, much like \fBmpc\fP but with
more functionnalities like \fIplaylists\fP and \fIstickers\fP management.
.PP
Because \fBlkt.old\fP is replaced by \fBlkt\fP, its usage is deprecated in
favor of \fBlkt\fP. The differences are the following:
.IP \[bu] 2
Some types in queries are optional. Thus the type is infered from the regex
part and it means that some \fIqueries\fP are no longer possible.
.PP
Commands can be used with the minimal name that permit them to be
distinguished from others commands. Thus, it is possible to use the
string \fIadm\fP as an alias for \fIadmin\fP. This is like cisco switch
command line interface.
.PP
You may be interested in other related programs like:
.PP
.PD 0
.TP
\fIlektord\fP       The lektor daemon
.TP
.PD

.SH "COMMANDS"
Here are the \fBlkt.old\fP commands:

.PP
\fIBASE-COMMANDS\fP
.PP
.PD 0
.TP
.PD
\fBcurrent\fP
Prints informations about the currently playing kara. Can be used to
display the current kara in a status bar like \fBxmobar\fP or in the
\fBi3 panel\fP
.TP
\fBplay\fP [index]
Toggle play/pause state. If the playback is stopped, start at a possibly
specified index
.TP
\fBnext\fP
Play next kara in the queue
.TP
\fBprevious\fP
Play the previous kara in the queue
.TP
\fBshuffle\fP
Shuffle the queue. If the state was stoppped, play from the first kara
in the queue. If lektor was already playing a kara, it will play it
from the begening. The current kara will be placed in first position
in the queue.
.TP
\fBstatus\fP
Prints information about the state of lektor and the currently playing kara
.TP
\fBstop\fP
Stop the playback and reading the queue, the state is now \fIstopped\fP.
.PP
\fIPLAYLIST-COMMANDS\fP
.PP
.PD 0
.TP
.PD
\fBplt create\fP <plt-name>
Creates a playlist, do nothing if it was already present
.TP
\fBplt destroy\fP <plt-name>
Delete a playlist with all its content, do nothing if the playlist didn't exists
.TP
\fBplt delete\fP <plt-name> <query>
Deletes karas from a playlist with a valid \fIquery\fP
.TP
\fBplt add\fP <plt-name> <query>
Adds karas to a playlist with a valid \fIquery\fP
.TP
\fBplt list\fP <plt-name>
List the content of the playlist named <plt-name>
.TP
\fBplt list\fP
List all the available playlists
.PP

\fIQUEUE-COMMANDS\fP
.PP
.PD 0
.TP
.PD
\fBqueue\fP [count]
Prints the names and ids of the next karas in the queue
.TP
\fBqueue pos\fP <pos | from:to>
Prints the names and ids of karas in the queue. Karas can be designated by
their position or with a range
.TP
\fBqueue pop\fP
Delete the currently playing kara from the queue and pass to the next one.
This can work only if the currently playong kara is not the last
.TP
\fBqueue add\fP <query>
Add karas to the queue at the end of it with a valid query
.TP
\fBqueue insert\fP <query>
Add karas to the queue just after the currently playing kara
.TP
\fBqueue seek\fP <id>
Goto to the kara with the specified id in the queue
.TP
\fBqueue delete\fP <id>
Delete karas from the playlist with their id. You can't delete the currently
playing kara, for that use the \fBpop\fP queue command
.TP
\fBqueue clear\fP
Clear the queue and set the state to \fIstopped\fP
.TP
\fBqueue crop\fP
Crop the queue, delete every kara from it appart from the currently
playing one
.TP
\fBqueue replace\fP <plt-name>
Replace the queue with the content of a playlist. Keep the playling state
.PP

\fISEARCH-COMMANDS\fP
.PP
.PD 0
.TP
.PD
\fBsearch database\fP <query>
Search and prints the kara that correspond to the query in the database
.TP
\fBsearch plt\fP <plt-name> <query>
Search, prints and add to an existing playlist the karas that match
the query
.TP
\fBsearch plt\fP <plt-name>
List the content of the playlist named <plt-name>
.TP
\fBsearch plt\fP
List all the available playlists
.TP
\fBsearch count\fP <query>
Search and prints the number of karas that match the query
.TP
\fBsearch get\fP <id>
Get informations about a specific id
.TP
\fBsearch queue\fP <query>
Search in the queue and prints the karas that match the query
.PP

\fISTICKERS-COMMANDS\fP
.PP
.PD 0
.TP
.PD
\fBsticker create\fP <name>
Create a sticker that can be used to tag \fIkara\fP and \fIplt\fP objects
.TP
\fBsticker get\fP <type> <uri> [ <name> [ <op> <value> ] ]
List the stickers of an object \fIuri\fP. The object \fItype\fP can be
\fIkara\fP or \fIplt\fP

A condition can be defined on the value of the sticker with an operator
\fIop\fP and an integer value \fIvalue\fP. Supported operators are \fIl\fP
for 'less than', \fIe\fP for 'equal to' and \fIg\fP for 'greater than'.
Operations are not strict
.TP
\fBsticker set\fP <type> <uri> <name> <value>
Set the value of a sticker \fIname\fP to \fIvalue\fP for the object with the
id \fIuri\fP
.TP
\fBsticker delete\fP <type> <uri> [name]
Delete all the stickers or only one (specified by \fIname\fP) of the object
with the id \fIuri\fP
.PP

\fIADMIN-COMMANDS\fP
.PP
.PD 0
.TP
.PD
\fBadmin ping\fP
Pings the lektord daemon, prints \fIOK\fP only if the ping succeeded
.TP
\fBadmin kill\fP
Kill the lektord daemon
.TP
\fBadmin restart\fP
Try to restart the lektord daemon
.TP
\fBadmin rescan\fP
Rescan karas from the filesystem. New karas that are not in the database
will be added to it. Don't synchronize from the repo
.TP
\fBadmin populate\fP
Force a rescan (without taking into account the timestamp). Can be used
to bootstrap the database from a filesystem
.TP
\fBadmin update\fP
Update the base from the \fIKurisu\fP repo. Don't scan for new files in
the filesystem
.TP
\fBadmin config\fP
Prints to \fIstdout\fP the default configuration file
.PP

.SH "OPTIONS"
Options can be passed to \fBlkt.old\fP before specifying the command in a
\fIoption=value\fP format. This is done this way to allow one to make an alias
of the \fBlkt.old\fP command.
.PP
The possible options are the following:
.PP
.PD 0
.TP
.PD
\fBhost\fP
The hostname or the IP of the machine where the \fBlektord\fP daemon
is running
.TP
\fBport\fP
The port on which the \fBlektord\fP daemon is listening
.TP
\fBpwd\fP
The password to use for commands that require authentification. This is the
case of most of the \fIadmin\fP commands
.PP

.SH "QUERIES"
Queries are a way of listing karas in the database. They are composed of a
type and the next of the line is the SQL regex that the kara must verify.
In SQL regexes, the wildcard is the "%" character and the jocker the
character "_". Queries are case insensitive.
.PP
Valid types for a query are the following: \fIid\fP, \fIlang\fP, \fItype\fP,
\fIcategory\fP, \fIauthor\fP, \fIquery\fP and \fIplaylist\fP.
.PP
For the type \fItype\fP, the valid values are the following: \fIOP\fP,
\fIED\fP, \fIIS\fP, \fIAMV\fP, \fIVOCA\fP, \fIMV\fP, \fIPV\fP and \fILIVE\fP.
.PP
For the type \fIlang\fP, the valid values are the following: \fIjp\fP,
\fIfr\fP, \fIsp\fP, \fIen\fP, \fIlatin\fP, \fIit\fP, \fIru\fP, \fImulti\fP
and \fIundefined\fP.
.PP
For the \fIcategory\fP type, the valid values are the following:
\fIvo\fP, \fIva\fP, \fIcdg\fP, \fIamv\fP, \fIvocaloid\fP and \fIautres\fP.
.PP
Here are some examples of queries:
.PP
.PD 0
.TP
.PD
\fBtype OP\fP
Select karas that are openings
.TP
\fBauthor kubat\fP
Select karas where the author is "kubat"
.PP

.SH "EXAMPLES"
Valid invocations of the \fBlkt.old\fP command are the following:
.PP
.PD 0
.TP
.PD
\fBlkt.old host=sakura port=6601 pwd=toto admin restart\fP
Restart the lektord daemon on the \fIsakura\fP PC. This daemon is listening on
the port \fI6601\fP and the password of the admin user is \fItoto\fP
.TP
\fBlkt.old q a author krocoh\fP
Add kara that Krocoh has done to the queue