Skip to content
Extraits de code Groupes Projets
Vérifiée Valider b24ce9cc rédigé par Kubat's avatar Kubat
Parcourir les fichiers

DOC: Update the new manpage for the new lkt command with implicit types in queries

parent 3387fef5
Aucune branche associée trouvée
Aucune étiquette associée trouvée
1 requête de fusion!127Lkt update
.\" vim: ft=groff
.TH "LKT" "1" "___DATE___" "LEKTOR MK 7" .TH "LKT" "1" "___DATE___" "LEKTOR MK 7"
.SH "NAME" .SH "NAME"
lkt \- the lektor command line client lkt \- the lektor command line client
.SH "OVERVIEW" .SH "OVERVIEW"
\fBlkt\fP is the \fBlektord\fP client, much like \fBmpc\fP but with \fBlkt\fP is the \fBlektord\fP client, much like \fBmpc\fP but with
more functionnalities like \fIplaylists\fP and \fIstickers\fP management. more functionnalities like \fIplaylists\fP and \fIstickers\fP management.
...@@ -12,17 +15,10 @@ distinguished from others commands. Thus, it is possible to use the ...@@ -12,17 +15,10 @@ 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 string \fIadm\fP as an alias for \fIadmin\fP. This is like cisco switch
command line interface. command line interface.
.PP .PP
You may be interested in other related programs like:
.PP
.PD 0
.TP
\fIlektord\fP The lektor daemon
.TP
.PD
.SH "COMMANDS" .SH "COMMANDS"
Here are the \fBlkt\fP commands: Here are the \fBlkt\fP commands:
.PP .PP
\fIBASE-COMMANDS\fP \fIBASE-COMMANDS\fP
.PP .PP
...@@ -204,6 +200,7 @@ the filesystem ...@@ -204,6 +200,7 @@ the filesystem
Prints to \fIstdout\fP the default configuration file Prints to \fIstdout\fP the default configuration file
.PP .PP
.SH "OPTIONS" .SH "OPTIONS"
Options can be passed to \fBlkt\fP before specifying the command in a Options can be passed to \fBlkt\fP before specifying the command in a
\fIoption=value\fP format. This is done this way to allow one to make \fIoption=value\fP format. This is done this way to allow one to make
...@@ -226,37 +223,71 @@ The password to use for commands that require authentification. This is the ...@@ -226,37 +223,71 @@ The password to use for commands that require authentification. This is the
case of most of the \fIadmin\fP commands case of most of the \fIadmin\fP commands
.PP .PP
.SH "QUERIES" .SH "QUERIES"
Queries are a way of listing karas in the database. They are composed of a Queries are a way of listing karas in the database. They are composed of an
type and the next of the line is the SQL regex that the kara must verify. optional type (see when it is not optional) and the next of the line is the SQL
In SQL regexes, the wildcard is the "%" character and the jocker the regex that the kara must verify. In SQL regexes, the wildcard is the "%"
character "_". Queries are case insensitive. character and the jocker the character "_". Queries are case insensitive (in
.PP most cases).
.IP \[bu] 2
Valid types for a query are the following: \fIid\fP, \fIlang\fP, \fItype\fP, Valid types for a query are the following: \fIid\fP, \fIlang\fP, \fItype\fP,
\fIcategory\fP, \fIauthor\fP, \fIquery\fP and \fIplaylist\fP. \fIcategory\fP, \fIauthor\fP, \fIquery\fP and \fIplaylist\fP.
.PP .IP \[bu]
For the type \fItype\fP, the valid values are the following: \fIOP\fP, 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. \fIED\fP, \fIIS\fP, \fIAMV\fP, \fIMV\fP, \fIPV\fP and \fILIVE\fP.
.PP .IP \[bu]
For the type \fIlang\fP, the valid values are the following: \fIjp\fP, 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 \fIfr\fP, \fIsp\fP, \fIen\fP, \fIlatin\fP, \fIit\fP, \fIru\fP, \fImulti\fP and
and \fIundefined\fP. \fIundefined\fP.
.IP \[bu]
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 .PP
For the \fIcategory\fP type, the valid values are the following: For the following types of queries, the type part is optional: \fIid\fP,
\fIvo\fP, \fIva\fP, \fIcdg\fP, \fIamv\fP, \fIvocaloid\fP and \fIautres\fP. \fItype\fP, \fIlang\fP, \fIcategory\fP. The other optional type is the
\fIquery\fP type, be carefull with that type of query! The optional type of
queries are recognise as such when reding the regex part:
.IP \[bu] 2
\fI'type'\fP: If the regex is all in upper case, it will be treated as a
\fItype\fP of kara, if the \fItype\fP is invalid \fBlkt\fP will return an
error. This means that you can't do any other queries with only upper case
characters.
.IP \[bu]
\fI'id'\fP: If the regex is a number, it will be treated as an \fIid\fP. This
means that you can't search the database with a unique number as a \fIquery\fP
but it should not be a problem.
.IP \[bu]
\fI'lang'\fP and \fI'category'\fP: If the regex is in lower case and matches a
\fIlang\fP or a \fIcategory\fP, the type will be infered.
.IP \[bu]
\fI'query'\fP: If no other type is infered and no type is recognised (the query
does not begin by \fIauthor\fP, \fIplaylist\fP), then all the regex is
considered to be a \fIquery\fP.
.PP .PP
Here are some examples of queries: Here are some examples of queries:
.PP .PP
.PD 0 .PD 0
.TP .TP
.PD .PD
\fBtype OP\fP \fBtype OP\fP / \fBOP\fP
Select karas that are openings Select karas that are openings
.TP .TP
\fB6000\fP
Select the kara with the id 6000
.TP
\fBauthor kubat\fP \fBauthor kubat\fP
Select karas where the author is "kubat" Select karas where the author is "kubat" or "Kubat" or etc
.TP
\fBtonari%no%totoro\fP
Select karas that match the query "%tonari%no%totoro%"
.PP .PP
.SH "EXAMPLES" .SH "EXAMPLES"
Valid invocations of the \fBlkt\fP command are the following: Valid invocations of the \fBlkt\fP command are the following:
.PP .PP
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter