From 4236b46d5c9f18aaeaa0c0f445b17e2ece480ace Mon Sep 17 00:00:00 2001
From: Kubat <mael.martin31@gmail.com>
Date: Fri, 1 May 2020 15:49:43 +0200
Subject: [PATCH] Base files for man pages generation
---
doc/footer | 38 ++++++++++++++++++++++++++++++++++++++
doc/header | 1 +
doc/lektor.1 | 15 +++++++++++++++
doc/lektord.1 | 38 --------------------------------------
doc/lkt.1 | 0
doc/lktadm.1 | 0
meson.build | 3 +++
7 files changed, 57 insertions(+), 38 deletions(-)
create mode 100644 doc/footer
create mode 100644 doc/header
create mode 100644 doc/lektor.1
create mode 100644 doc/lkt.1
create mode 100644 doc/lktadm.1
diff --git a/doc/footer b/doc/footer
new file mode 100644
index 00000000..5bed4985
--- /dev/null
+++ b/doc/footer
@@ -0,0 +1,38 @@
+.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.
+.PP
+The up\-to\-date source code is available via Git from Gitlab\&. See
+\fBhttps://git\&.iiens\&.net/martin2018/lektor\fP
+.fi
+.SH "RELATED SITES AND THE LEKTOR FAQ"
+Just see one of the dev from lektor or a bakateux if you have some questions
+about lektor.
+.PP
+.PD 0
+.TP
+\fBhttps://kurisu.iiens.net\fP The depo site for the karaoke base
+.TP
+\fBhttps://manga.iiens.net\fP The home website for the Bakaclub
+.PD
+.SH "FILES"
+.PD 0
+.TP
+\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
+.PD
+.SH "SEE ALSO"
+\fIlektor\fP(1),
+\fIlektord\fP(1),
+\fIlktadm\fP(1),
+\fIlkt\fP(1),
+\fImpc\fP(1),
+\fImpd\fP(1),
+\fImeson\fP(1)
+.PP
+\fBIEEE Standard for information Technology \-
+Portable Operating System Interface (POSIX)\fP
diff --git a/doc/header b/doc/header
new file mode 100644
index 00000000..04e76afa
--- /dev/null
+++ b/doc/header
@@ -0,0 +1 @@
+.TH "___PAGE___" "1" "___DATE___" "LEKTOR MK 7"
diff --git a/doc/lektor.1 b/doc/lektor.1
new file mode 100644
index 00000000..1ef07241
--- /dev/null
+++ b/doc/lektor.1
@@ -0,0 +1,15 @@
+.SH "NAME"
+lektord \- the lektor daemon
+.SH "OVERVIEW"
+The lektord is only the lektor's daemon. It may need other scripts and/or
+external programs to work correctly.
+.PP
+You may be interested in other related programs like:
+.PP
+.PD 0
+.TP
+\fIlktadm\fP Administration of lektor from a separate executable
+.TP
+\fIlkt\fP A standard client for lektord
+.PD
+.SH "DESCRIPTION"
diff --git a/doc/lektord.1 b/doc/lektord.1
index 66245cf2..2cfd595a 100644
--- a/doc/lektord.1
+++ b/doc/lektord.1
@@ -1,4 +1,3 @@
-.TH "LEKTORD" "1" "February 12, 2020" "lektord 0\&.1\&.0"
.SH "NAME"
lektord \- the lektor daemon
.SH "OVERVIEW"
@@ -18,26 +17,6 @@ You may be interested in other related programs like:
Lektor allows one to interactivelly and remotly interact with the player. The
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, Maël 'Kubat' MARTIN and Louis 'Elliu' GOYARD.
-.SH "AVAILABILITY"
-I don't know what to do in this section.
-.PP
-The up\-to\-date source code is available via Git from Gitlab\&. See
-\fBhttps://git\&.iiens\&.net/martin2018/lektor\fP
-.fi
-.SH "THE LEKTOR FAQ"
-Just see one of the dev from lektor or a bakateux.
-.SH "RELATED SITES"
-.PP
-.PD 0
-.TP
-\fBhttps://kurisu.iiens.net\fP The depo site for the karaoke base
-.TP
-\fBhttps://manga.iiens.net\fP The home website for the Bakaclub
-.PD
.SH "INSTALLATION"
You may install lektor from source like this:
.sp
@@ -129,20 +108,3 @@ The supported types in lektor are: \fBOP\fP, \fBED\fP, \fBIS\fP, \fBAMV\fP,
.SH "SUPPORTED CATEGORIES"
The supported categories in lektor are: \fBvo\fP, \fBva\fP, \fBcdg\fP,
\fBamv\fP, \fBvocaloid\fP and \fBautres\fP.
-.SH "FILES"
-.PD 0
-.TP
-\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
-.PD
-.SH "SEE ALSO"
-\fIlktadm\fP(1),
-\fIlkt\fP(1),
-\fImpc\fP(1),
-\fImpd\fP(1)
-.PP
-\fBIEEE Standard for information Technology \-
-Portable Operating System Interface (POSIX)\fP
diff --git a/doc/lkt.1 b/doc/lkt.1
new file mode 100644
index 00000000..e69de29b
diff --git a/doc/lktadm.1 b/doc/lktadm.1
new file mode 100644
index 00000000..e69de29b
diff --git a/meson.build b/meson.build
index e064258f..7cf68f71 100644
--- a/meson.build
+++ b/meson.build
@@ -143,6 +143,9 @@ man_sh = find_program('scripts/man.sh')
man_header = run_command('realpath', 'doc/header').stdout().strip()
man_footer = run_command('realpath', 'doc/footer').stdout().strip()
man_files = [ [ 'lektord', '1' ]
+ , [ 'lektor', '1' ]
+ , [ 'lktadm', '1' ]
+ , [ 'lkt', '1' ]
]
foreach man: man_files
--
GitLab