From 158f546f90a63687a8023a2381144c1447572b6d Mon Sep 17 00:00:00 2001 From: Kubat <mael.martin31@gmail.com> Date: Sun, 2 Aug 2020 20:49:41 +0200 Subject: [PATCH] DOC: Update README and manpage generation --- README.md | 21 ++++++++++++++++++--- man/.gitignore | 1 + man/Makefile.am | 2 +- man/Makefile.in | 2 +- 4 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 man/.gitignore diff --git a/README.md b/README.md index 29adb7a0..eb5c19f0 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,9 @@ Prerequisites: - [autotools](https://www.gnu.org/software/autoconf/) only if you change the configuration (if you only edit existing files you won't need it) -- a C compiler with C18 support (e.g. `gcc>8.1`, `clang>7.0`) +- a C compiler with C11 support - the [sqlite3](https://www.sqlite.org/) development library, version 3.31.0 or newer for [generated columns](https://www.sqlite.org/gencol.html) support -- the [json-c](https://github.com/json-c/json-c) development library -- the [libcurl](https://github.com/curl/curl) developmemt library - a POSIX.1-2008 compatible system (i.e. not MS Windows) For the module sdl2, you will need the folowing prerequisites: @@ -24,6 +22,11 @@ For the module sdl2, you will need the folowing prerequisites: - the [mpv](https://mpv.io/) development library - the [sdl2](https://www.libsdl.org/) development library +For the module repo, you will need the folowing prerequisites: + +- the [json-c](https://github.com/json-c/json-c) development library +- the [libcurl](https://github.com/curl/curl) developmemt library + You will also need the following executables, with their path setted in the configuration file: @@ -84,6 +87,18 @@ commands are here for that. To run lektor, you can simply run the binary like: `./lektord`. +If lektord did not exited normally (i.e. without the `lkt adm kill` command), the +database will still store the fact that lektord is running. To by-pass it, you +will need to launch lektord with the `-F` (forced) option, like: + +``` +lektord -F +``` + +It is not recommended to launch always lektord with the `-F` option, because that +way you could launch multiple instances of the lektod daemon, which could results +in undefined behaviours. + Lektor will use specialized software (hwdec set to yes), if you have an nvidia card with optimus (in almose every laptop), please use `optirun` or `primusrun`: diff --git a/man/.gitignore b/man/.gitignore new file mode 100644 index 00000000..900429f5 --- /dev/null +++ b/man/.gitignore @@ -0,0 +1 @@ +*.man diff --git a/man/Makefile.am b/man/Makefile.am index 512e43ac..007e9ccf 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,5 +1,5 @@ notrans_dist_man1_MANS = lektor.man lektord.man lkt.man -MAN = $(abs_top_srcdir)/scripts/manpager.bash +MAN = $(abs_top_srcdir)/scripts/manpage.bash .template.man: $(MAN) $< diff --git a/man/Makefile.in b/man/Makefile.in index d6f911c2..f7cfc4b3 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -207,7 +207,7 @@ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ LT_SYS_LIBRARY_PATH = @LT_SYS_LIBRARY_PATH@ MAKEINFO = @MAKEINFO@ -MAN = $(abs_top_srcdir)/scripts/manpager.bash +MAN = $(abs_top_srcdir)/scripts/manpage.bash MANIFEST_TOOL = @MANIFEST_TOOL@ MKDIR_P = @MKDIR_P@ NM = @NM@ -- GitLab