From 7eaea77073ed8f075682f6ab824356b4df35ae1d Mon Sep 17 00:00:00 2001
From: Kubat <mael.martin31@gmail.com>
Date: Fri, 1 May 2020 12:04:31 +0200
Subject: [PATCH] Update build and man page
---
doc/lektord.1 | 63 +++++++++++++++++++++++++++------------------------
meson.build | 21 ++++++++---------
2 files changed, 43 insertions(+), 41 deletions(-)
diff --git a/doc/lektord.1 b/doc/lektord.1
index 13ca5819..66245cf2 100644
--- a/doc/lektord.1
+++ b/doc/lektord.1
@@ -9,18 +9,19 @@ You may be interested in other related programs like:
.PP
.PD 0
.TP
-\fIkaradata\fP Metadata manipulation around matroska files for lektor
+\fIlktadm\fP Administration of lektor from a separate executable
.TP
-\fIlkinfo\fP Metadata printing with lektor compatible matroska files
+\fIlkt\fP A standard client for lektord
.PD
.SH "DESCRIPTION"
.PP
Lektor allows one to interactivelly and remotly interact with the player. The
-lektor daemon is mpd compatible.
+lektor daemon is mpd compatible, even if some functionnalities may differ.
+You can almost use \fBmpc\fP with lektord.
.SH "AUTHOR"
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 and Maël 'Kubat' MARTIN.
+\'Taiite' HIRTZ, Maël 'Kubat' MARTIN and Louis 'Elliu' GOYARD.
.SH "AVAILABILITY"
I don't know what to do in this section.
.PP
@@ -37,6 +38,20 @@ Just see one of the dev from lektor or a bakateux.
.TP
\fBhttps://manga.iiens.net\fP The home website for the Bakaclub
.PD
+.SH "INSTALLATION"
+You may install lektor from source like this:
+.sp
+.RS 4
+.nf
+\fB
+% sudo mkdir /home/kara && sudo chown USER:USER /home/kara
+% git clone https://git.iiens.net/martin2018/lektor && cd lektor
+% mkdir build && meson build && cd build && ninja # Compilation
+% sudo meson install --no-rebuild # Install
+% sudo chown USER:USER /home/kara/kara.db # Or you will have some problems
+.fi \fR
+.P
+.RE
.SH "INVOCATION"
To simply launch the daemon do not set any flag. The following flags are
interpreted by the shell when invoked to determine where the shell will read
@@ -45,36 +60,32 @@ commands from:
.PD 0
.TP
.PD
-\fB\-\-init\fP
-Write default config files on the FS. May create folder if they doesn't exist.
-If a configuration is already present it may be overwriten.
-.TP
-\fB\-\-populate\fP
-Read the configuration and populate the sqlite3 database with the found
-compatible matroska video files from the FS.
+\fB\-\-help\fP / \fB\-h\fP
+Prints the help message.
.TP
\fB\-\-version\fP / \fB\-v\fP
Print the version of the lektor daemon.
.PP
-If the lektor daemon is launched without configuration the behaviour is not
-determined. When installing from scratch the following commands need to be
-launched \fBin order\fP:
+If the lektor daemon is launched without a configuration file, it will exit
+with the code \fB1\fP. To init the default configuration file (normally done
+by meson during the install), you should just use:
.sp
.RS 4
.nf
\fB
-% lektord --init
-% karadata --init
-% lektord --populate
+% mkdir ~/.config/lektor/
+% lktadm init conf > ~/.config/lektor/lektor.ini
% lektord
.fi \fR
.P
.RE
.PP
-When downloading karas directly from \fIkurisu\fP the \fBkaradata --init\fP
-should not be needed.
+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:
+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
@@ -121,21 +132,15 @@ The supported categories in lektor are: \fBvo\fP, \fBva\fP, \fBcdg\fP,
.SH "FILES"
.PD 0
.TP
-\fB$HOME/.config/lektor/config\fP general config file
+\fB$HOME/.config/lektor/lektor.ini\fP general config file for the user
.TP
\fB/home/kara/\fP default prefix for the bakabase
.TP
\fB/home/kara/kara.db\fP default sqlite3 base for the bakabase
-.TP
-\fB$HOME/.local/libexec/lektor_info.csh\fP script used to get informations about a running instance of lektor
-.TP
-\fB$HOME/.local/libexec/lektor_info_multiline.csh\fP same, but with multiline output
-.TP
-\fB$HOME/.local/etc/lektor_host\fP the file storing the host to look to for the lektord running instance
.PD
.SH "SEE ALSO"
-\fIkaradata\fP(1),
-\fIlkinfo\fP(1),
+\fIlktadm\fP(1),
+\fIlkt\fP(1),
\fImpc\fP(1),
\fImpd\fP(1)
.PP
diff --git a/meson.build b/meson.build
index 8e6fea1c..0e421b7b 100644
--- a/meson.build
+++ b/meson.build
@@ -88,13 +88,12 @@ initsql_deps = [ declare_dependency( link_with: static_library( 'initsql'
, [ custom_target('init.c'
, output: 'sql_init.c'
, input: 'scripts/init.sql'
- , command: [find_program('xxd'), '-i', '@INPUT@', '@OUTPUT@']) ] ) ) ]
+ , command: [ find_program('xxd'), '-i', '@INPUT@', '@OUTPUT@']) ] ) ) ]
-lib = static_library( meson.project_name()
+lib = static_library( 'lektor'
, files(core_sources)
, include_directories: includes
- , dependencies: [ core_deps, libdl, common_deps, mthread_deps, initsql_deps ]
- )
+ , dependencies: [ core_deps, libdl, common_deps, mthread_deps, initsql_deps ] )
bin_deps = [ declare_dependency( link_with: lib, include_directories: includes) ]
@@ -102,16 +101,14 @@ srv = executable( meson.project_name() + 'd'
, files('src/main/server.c')
, include_directories: includes
, dependencies: [ bin_deps ]
- , install: true
- )
+ , install: true )
# Admin executable
-metadata = executable( 'lktadm'
- , files('src/main/lktadm.c', 'src/cmd.c')
- , include_directories : includes
- , dependencies: [ bin_deps ]
- , install: true
- )
+lktadm = executable( 'lktadm'
+ , files('src/main/lktadm.c', 'src/cmd.c')
+ , include_directories : includes
+ , dependencies: [ bin_deps ]
+ , install: true )
# Client executable
lkt = executable( 'lkt'
--
GitLab