pkgs/applications/video/mirakurun/mirakurun.1

   1 .Dd $Mdocdate$
   2 .Dt MIRAKURUN 1
   3 .Os
   4 .Sh NAME
   5 .Nm mirakurun
   6 .Nd @DESCRIPTION@
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Bk -words
  10 .Op Ar command Op Ar args
  11 .Ek
  12 .Sh DESCRIPTION
  13 .Nm
  14 is a wrapper command for Mirakurun provided by Nix. It's actually a thin
  15 wrapper around the
  16 .Xr npm 1
  17 command line tool which you can use to invoke npm commands from the Mirakurun
  18 project directory. The command line arguments are simply passed as-is to
  19 .Xr npm 1 .
  20 .Pp
  21 On NixOS, it is strongly recommended that you enable the mirakurun module
  22 instead of invoking this command directly to launch Mirakurun. On other
  23 platforms, run
  24 .Pp
  25 .Dl $ mirakurun start
  26 .Pp
  27 to start Mirakurun.
  28 .Sh FILES
  29 .Bl -tag -width Ds -compact
  30 .It Pa /etc/mirakurun
  31 .Nm
  32 configuration directory.
  33 .El
  34 .Sh EXAMPLES
  35 Start Mirakurun.
  36 .Pp
  37 .Dl $ mirakurun start
  38 .Pp
  39 Start Mirakurun in development mode.
  40 .Pp
  41 .Dl $ mirakurun run debug
  42 .Pp
  43 .Sh SEE ALSO
  44 .Xr npm 1