Progress in writing manpages

doc/footer

 .SH "AUTHOR AND AVAILABILITY"
 Lektor is a karaoke player for POSIX compliant systems (i.e. not MS-Windows)
 writen initially in C. Some may call it Lektor mk 7. It was writen by Hubert
-\'Taiite' HIRTZ, Maël 'Kubat' MARTIN and Louis 'Elliu' GOYARD.
+\'Taiite' HIRTZ, Maël 'Kubat' MARTIN and Louis 'Elliu' GOYARD. These people
+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

doc/lektor.1

 .SH "NAME"
-lektord \- the lektor daemon
+lektor \- the lektor karaoke player
 .SH "OVERVIEW"
-The lektord is only the lektor's daemon. It may need other scripts and/or
-external programs to work correctly.
+Lektor is a collection of pragram, a daemon a client and an administrator
+used to play karaoker from the bakabase.
 .PP
 You may be interested in other related programs like:
 .PP
 .PD 0
 .TP
+\fIlektord\fP       The lektor daemon
+.TP
 \fIlktadm\fP        Administration of lektor from a separate executable
 .TP
 \fIlkt\fP           A standard client for lektord
 .PD
 .SH "DESCRIPTION"
+lektor is a replacement of old bash scripts present on \fISakura\fP (now
+\fIShinSakura\fP). It allows interaction from the network with a \fIMPD\fP
+compatible protocol even if functionnalities may differ.
+.PP
+Here is a list of functionnalities offered by lektor:
+.PP
+.PD 0
+.TP
+.PD
+\fBBase synchronisation\fP
+The entire base can be syncrhonised from \fIKurisu\fP.
+.TP
+\fBManipulation over the network\fP
+Lektord can be piloted over the network with \fBlkt\fP.
+.TP
+\fBPlaylists and stickers\fP
+Reading and searching through the base can be facilitated by creating
+\fIplaylist\fP and using \fIstickers\fP (\fIMPD\fP version of tags).
+.PP
+.SH "SUPPORTED URIS"
+When searching the database, the following URIs are supported by lektor. Those
+URIs are hidden, you should not use them, but here is some documentation about
+them.
+.PP
+.PD 0
+.TP
+.PD
+\(bu
+\fBid://${arg}\fP
+the \fBarg\fP should be the id of the kara in the sqlite3 database.
+.TP
+\(bu
+\fBfs://${arg}\fP
+the \fBarg\fP should be a part of the path to the kara.
+.TP
+\(bu
+\fBlang://${arg}\fP / \fBlanguage://${arg}\fP
+the \fBarg\fP should be the language of the kara.
+.TP
+\(bu
+\fBtype://${arg}\fP
+the \fBarg\fP should be the type of the kara.
+.TP
+\(bu
+\fBcat://${arg}\fP / \fBcategory://${arg}\fP
+the \fBarg\fP should be the category of the kara.
+.TP
+\(bu
+\fBauthor://${arg}\fP
+the \fBarg\fP should be the author of the kara
+.TP
+\(bu
+\fBquery://${arg}\fP
+the \fBarg\fP should be a sqlite3 query. The formating string on which the query
+is applied is like \fB"${cat}/${source} - ${type}${song_num?} - ${title}"\fP.
+You usually want to do this.
+.PP
+.SH "SUPPORTED LANGUAGES"
+The supported languages in lektor are: \fBjp\fP, \fBfr\fP, \fBsp\fP, \fBen\fP,
+\fBlatin\fP, \fBit\fP, \fBru\fP, \fBmulti\fP and \fBundefined\fP.
+.SH "SUPPORTED TYPES"
+The supported types in lektor are: \fBOP\fP, \fBED\fP, \fBIS\fP, \fBAMV\fP,
+\fBVOCA\fP, \fBMV\fP, \fBPV\fP and \fBLIVE\fP.
+.SH "SUPPORTED CATEGORIES"
+The supported categories in lektor are: \fBvo\fP, \fBva\fP, \fBcdg\fP,
+\fBamv\fP, \fBvocaloid\fP and \fBautres\fP.

doc/lektord.1

@@ -61,50 +61,3 @@ by meson during the install), you should just use:
 .PP
 You should edit the configuration file to set correct path to \fB.so\fP file,
 those files are modules for the window of lektord.
-.SH "SUPPORTED URIS"
-When searching the database, the following URIs are supported by lektor. Those
-URIs are hidden, you should not use them, but here is some documentation about
-them.
-.PP
-.PD 0
-.TP
-.PD
-\(bu
-\fBid://${arg}\fP
-the \fBarg\fP should be the id of the kara in the sqlite3 database.
-.TP
-\(bu
-\fBfs://${arg}\fP
-the \fBarg\fP should be a part of the path to the kara.
-.TP
-\(bu
-\fBlang://${arg}\fP / \fBlanguage://${arg}\fP
-the \fBarg\fP should be the language of the kara.
-.TP
-\(bu
-\fBtype://${arg}\fP
-the \fBarg\fP should be the type of the kara.
-.TP
-\(bu
-\fBcat://${arg}\fP / \fBcategory://${arg}\fP
-the \fBarg\fP should be the category of the kara.
-.TP
-\(bu
-\fBauthor://${arg}\fP
-the \fBarg\fP should be the author of the kara
-.TP
-\(bu
-\fBquery://${arg}\fP
-the \fBarg\fP should be a sqlite3 query. The formating string on which the query
-is applied is like \fB"${cat}/${source} - ${type}${song_num?} - ${title}"\fP.
-You usually want to do this.
-.PP
-.SH "SUPPORTED LANGUAGES"
-The supported languages in lektor are: \fBjp\fP, \fBfr\fP, \fBsp\fP, \fBen\fP,
-\fBlatin\fP, \fBit\fP, \fBru\fP, \fBmulti\fP and \fBundefined\fP.
-.SH "SUPPORTED TYPES"
-The supported types in lektor are: \fBOP\fP, \fBED\fP, \fBIS\fP, \fBAMV\fP,
-\fBVOCA\fP, \fBMV\fP, \fBPV\fP and \fBLIVE\fP.
-.SH "SUPPORTED CATEGORIES"
-The supported categories in lektor are: \fBvo\fP, \fBva\fP, \fBcdg\fP,
-\fBamv\fP, \fBvocaloid\fP and \fBautres\fP.

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.
+.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
+\fIlktadm\fP        Administration of lektor from a separate executable
+.PD
+.SH "COMMANDS"
+Here are the \fBlkt\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
+.PP

doc/lktadm.1

+.SH "NAME"
+lktadm \- the lektor administration tool
+.SH "OVERVIEW"
+You may be interested in other related programs like:
+.PP
+.PD 0
+.TP
+\fIlektord\fP       The lektor daemon
+.TP
+\fIlkt\fP           A standard client for lektord
+.PD
+

meson.build

@@ -155,6 +155,7 @@ foreach man: man_files
                , input: 'doc/@0@.@1@'.format(man_name, man_section)
                , output: '@0@.@1@'.format(man_name, man_section)
                , command: [ man_sh, '@INPUT@', '@OUTPUT@', man_header, man_footer ]
+               , depend_files: [ man_header, man_footer ]
                , install: true
                , install_dir: join_paths(get_option('mandir'), 'man@0@'.format(man_section)) )
 endforeach