Progress in manpages

doc/footer

@@ -5,7 +5,8 @@ writen initially in C. Some may call it Lektor mk 7. It was writen by Hubert
 also helped: Loïc 'Sting' ALLÈGRE and Etienne 'Pelle' BRATEAU.
 .PP
 The up\-to\-date source code is available via Git from Gitlab\&. See
-\fBhttps://git\&.iiens\&.net/martin2018/lektor\fP
+\fBhttps://git\&.iiens\&.net/martin2018/lektor\fP. The source code is
+provided under the \fIISC\fP licence.
 .fi
 .SH "RELATED SITES AND THE LEKTOR FAQ"
 Just see one of the dev from lektor or a bakateux if you have some questions

doc/lkt.1

 .SH "NAME"
 lkt \- the lektor command line client
+
 .SH "OVERVIEW"
 \fBlkt\fP is the \fBlektord\fP client, much like \fBmpc\fP but with
 more functionnalities like \fIplaylists\fP and \fIstickers\fP management.
@@ -17,8 +18,10 @@ You may be interested in other related programs like:
 .TP
 \fIlktadm\fP        Administration of lektor from a separate executable
 .PD
+
 .SH "COMMANDS"
 Here are the \fBlkt\fP commands:
+
 .PP
 \fIBASE-COMMANDS\fP
 .PP
@@ -69,3 +72,153 @@ Deletes karas from a playlist with a valid \fIquery\fP
 \fBplt add\fP <plt-name> <query>
 Adds karas to a playlist with a valid \fIquery\fP
 .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 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
+.PP
+
+\fISEARCH-COMMANDS\fP
+.PP
+.PD 0
+.TP
+.PD
+\fBsearch get\fP <query>
+Search and prints the kara that correspond to the query in the database
+.TP
+\fBsearch add\fP <query>
+Search, prints and add to the queue the karas that match the query
+.TP
+\fBsearch insert\fP <query>
+Search, prints and insert into the queue the karas that match the query
+.TP
+\fBsearch plt\fP <plt-name> <query>
+Search, prints and add to an existing playlist the karas that match
+the query
+.TP
+\fBsearch count\fP <query>
+Search and prints the number of karas that match the query
+.TP
+\fBsearch queue\fP <query>
+Search in the queue and prints the karas that match the query
+.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 update\fP
+Update the base from the \fIKurisu\fP repo. Don't scan for new files in
+the filesystem
+.PP
+
+.SH "OPTIONS"
+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
+an alias of the \fBlkt\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, \fIlanguage\fP, or
+\fIlang\fP, \fItype\fP, \fIcat\fP or \fIcategory\fP, \fIauthor\fP, \fIquery\fP,
+\fIsource\fP and \fItitle\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 \fIlanguage\fP or \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 \fIcat\fP or \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 k%\fP
+Select karas where the author begin with the character "k"
+.PP
+
+.SH "EXAMPLES"
+Valid invocations of the \fBlkt\fP command are the following:
+.PP
+.PD 0
+.TP
+.PD
+\fBlkt 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 q a author krocoh\fP
+Add kara that Krocoh has done to the queue