pkgs/by-name/fl/flockit/package.nix

   1 {
   2   lib,
   3   stdenv,
   4   fetchFromGitHub,
   5   runtimeShell,
   6 }:
   7
   8 stdenv.mkDerivation {
   9   pname = "flockit";
  10   version = "2012-08-11";
  11
  12   src = fetchFromGitHub {
  13     owner = "smerritt";
  14     repo = "flockit";
  15     rev = "5c2b2092f8edcc8e3e2eb6ef66c968675dbfa686";
  16     sha256 = "0vajck9q2677gpn9a4flkyz7mw69ql1647cjwqh834nrcr2b5164";
  17   };
  18
  19   installPhase = ''
  20     mkdir -p $out/lib $out/bin
  21     cp ./libflockit.so $out/lib
  22
  23     (cat <<EOI
  24     #!${runtimeShell}
  25     env LD_PRELOAD="$out/lib/libflockit.so" FLOCKIT_FILE_PREFIX=\$1 \''${@:2}
  26     EOI
  27     ) > $out/bin/flockit
  28     chmod +x $out/bin/flockit
  29   '';
  30
  31   meta = with lib; {
  32     description = "LD_PRELOAD shim to add file locking to programs that don't do it (I'm looking at you, rsync!)";
  33     mainProgram = "flockit";
  34     longDescription = ''
  35       This library and tool exists solely because rsync doesn't have file locking.
  36
  37       It's not used like a normal library; you don't link against it, and you
  38       don't have to patch your source code to use it. It's inserted between your
  39       program and its libraries by use of LD_PRELOAD.
  40
  41       For example:
  42
  43         $ env LD_PRELOAD=$(nix-build -A pkgs.flockit)/lib/libflockit.so FLOCKIT_FILE_PREFIX=test rsync SRC DEST
  44
  45       Besides the library a handy executable is provided which can simplify the above to:
  46
  47         $ $(nix-build -A pkgs.flockit)/bin/flockit test rsync SRC DEST
  48
  49       Also see the following blog post:
  50       https://www.swiftstack.com/blog/2012/08/15/old-school-monkeypatching/
  51     '';
  52     homepage = "https://github.com/smerritt/flockit";
  53     license = licenses.asl20;
  54     platforms = platforms.linux;
  55     maintainers = [ maintainers.basvandijk ];
  56   };
  57 }