octoleo/lsyncd
1
0
Fork 0
mirror of https://github.com/octoleo/lsyncd.git synced 2024-12-04 19:03:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs and build manpage on build process

Browse Source
This commit is contained in:
Daniel Poelzleithner 2023-03-03 14:24:31 +01:00
parent 5d3e0fe417
commit 95a2c2fca2
5 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CMakeLists.txt
View File

@ -91,7 +91,8 @@ add_custom_command( OUTPUT defaults.out
# the manpage # the manpage
add_custom_target( manpage add_custom_target( manpage
COMMAND ${CMAKE_COMMAND} -E echo "Updating the manpage" COMMAND ${CMAKE_COMMAND} -E echo "Updating the manpage"
COMMAND a2x --format=manpage docs/manpage/lsyncd.1.txt COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/man
COMMAND a2x --format=manpage ${PROJECT_SOURCE_DIR}/docs/manpage/lsyncd.1.txt -D ${CMAKE_CURRENT_BINARY_DIR}/man
DEPENDS docs/manpage/lsyncd.1.txt DEPENDS docs/manpage/lsyncd.1.txt
) )
@ -136,6 +137,6 @@ add_executable( lsyncd ${LSYNCD_SRC} )
target_link_libraries( lsyncd ${LUA_LIBRARIES} ) target_link_libraries( lsyncd ${LUA_LIBRARIES} )
install( TARGETS lsyncd RUNTIME DESTINATION bin ) install( TARGETS lsyncd RUNTIME DESTINATION bin )
install( FILES docs/manpage/lsyncd.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 COMPONENT man ) install( FILES ${CMAKE_CURRENT_BINARY_DIR}/man/lsyncd.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 COMPONENT man )
install( DIRECTORY examples DESTINATION doc ) install( DIRECTORY examples DESTINATION doc )
install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION doc OPTIONAL) install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION doc OPTIONAL)

4
docs/help/index.md
View File

@ -9,7 +9,7 @@ There is a [discussion group to all things related Lsyncd](https://groups.google
Issues Issues
------ ------
For cases Lsyncd is missbehaving there are [Issues](https://github.com/axkibe/lsyncd/issues) on Github. For cases Lsyncd is missbehaving there are [Issues](https://github.com/lsyncd/lsyncd/issues) on Github.
Please check: Please check:
@ -19,4 +19,4 @@ Please check:
Source & Improvement Source & Improvement
-------------------- --------------------
[Fork Lsyncd at Github](https://github.com/axkibe/lsyncd) [Fork Lsyncd at Github](https://github.com/lsyncd/lsyncd)

6
docs/manpage/lsyncd.1
View File

@ -1,7 +1,7 @@
'\" t '\" t
.\" Title: lsyncd .\" Title: lsyncd
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: January 2017 .\" Date: January 2017
.\" Manual: Lsyncd .\" Manual: Lsyncd
.\" Source: Lsyncd 2.2.1 .\" Source: Lsyncd 2.2.1
@ -149,13 +149,13 @@ Failure (syntax, unrecoverable error condition, internal failure)
.RE .RE
.SH "SEE ALSO" .SH "SEE ALSO"
.sp .sp
Online Manual: https://axkibe\&.github\&.io/lsyncd/ Online Manual: https://lsyncd\&.github\&.io/lsyncd/
.SH "VERSION" .SH "VERSION"
.sp .sp
This man page is for lsyncd(1) version 2\&.2\&.0 This man page is for lsyncd(1) version 2\&.2\&.0
.SH "AUTHOR" .SH "AUTHOR"
.sp .sp
Axel Kittenberger, <axkibe@gmail\&.com> 2010\-2017 Axel Kittenberger, <axkibe@gmail\&.com> 2010\-2017 Daniel Poelzleithner, <poelzleithner@b1\-systems\&.de> 2021\-2023
.SH "COPYING" .SH "COPYING"
.sp .sp
Copyright (C) 2010\-2017 Axel Kittenberger\&. Free use of this software is granted under the terms of the GNU General Public License (GPL) version 2, or any later version\&. Free redistrubition of this Documentation (/doc directory) is granted under the terms of the Creative Commons 3\&.0 Attribution License (CC\-3\&.0\-BY)\&. Copyright (C) 2010\-2017 Axel Kittenberger\&. Free use of this software is granted under the terms of the GNU General Public License (GPL) version 2, or any later version\&. Free redistrubition of this Documentation (/doc directory) is granted under the terms of the Creative Commons 3\&.0 Attribution License (CC\-3\&.0\-BY)\&.

8
docs/manpage/lsyncd.1.txt
View File

@ -41,7 +41,7 @@ Fine-grained customization can be achieved through the CONFIG-FILE. Custom
action configs can even be written from scratch in cascading layers ranging action configs can even be written from scratch in cascading layers ranging
from shell scripts to code written in the LUA(1) language. This way simplicity from shell scripts to code written in the LUA(1) language. This way simplicity
can be balanced with powerfulness. See the online manual for details on the can be balanced with powerfulness. See the online manual for details on the
CONFIG-FILE https://axkibe.github.io/lsyncd/manual/config/file/ . CONFIG-FILE https://lsyncd.github.io/lsyncd/manual/config/file/ .
Note that under normal configuration Lsyncd will delete pre-existing files in Note that under normal configuration Lsyncd will delete pre-existing files in
the target directories that are not present in the respective source directory. the target directories that are not present in the respective source directory.
@ -69,6 +69,9 @@ OPTIONS
*-nodaemon*:: *-nodaemon*::
Lsyncd will not detach from the invoker and log as well to stdout/err. Lsyncd will not detach from the invoker and log as well to stdout/err.
*-onepass*::
Sync once and exit
*-pidfile* 'FILE':: *-pidfile* 'FILE'::
Lsyncd will write its process ID in 'FILE'. Lsyncd will write its process ID in 'FILE'.
@ -89,7 +92,7 @@ EXIT STATUS
SEE ALSO SEE ALSO
-------- --------
Online Manual: https://axkibe.github.io/lsyncd/ Online Manual: https://lsyncd.github.io/lsyncd/
VERSION VERSION
------ ------
@ -98,6 +101,7 @@ This man page is for lsyncd(1) version 2.2.0
AUTHOR AUTHOR
------ ------
Axel Kittenberger, <axkibe@gmail.com> 2010-2017 Axel Kittenberger, <axkibe@gmail.com> 2010-2017
Daniel Poelzleithner, <poelzleithner@b1-systems.de> 2021-2023
COPYING COPYING
------- -------

12
flake.nix
View File

@ -15,14 +15,17 @@
allowBroken = true; allowBroken = true;
};}); #.legacyPackages.${system}; };}); #.legacyPackages.${system};
defaultDeps = with pkgs; [ defaultDeps = with pkgs; [
gcc
cmake
gnumake
glib glib
rsync rsync
openssh openssh
];
nativeDeps = with pkgs; [
curl curl
asciidoc
jekyll jekyll
gcc
cmake
gnumake
]; ];
version = builtins.elemAt version = builtins.elemAt
(builtins.match ''.*lsyncd_version = '([0-9\.]*)'.*'' (builtins.match ''.*lsyncd_version = '([0-9\.]*)'.*''
@ -138,10 +141,11 @@
src = ./.; src = ./.;
buildPhase = '' buildPhase = ''
make all docs-html make all manpage docs-html
''; '';
buildInputs = defaultDeps ++ luaPackages; buildInputs = defaultDeps ++ luaPackages;
nativeBuildInputs = nativeDeps;
}); });
mkDev = extras: pkgs.mkShell { mkDev = extras: pkgs.mkShell {
propagatedBuildInputs = defaultDeps ++ extras; propagatedBuildInputs = defaultDeps ++ extras;