diff options
Diffstat (limited to 'nixpkgs/pkgs/applications/video/epgstation/epgstation.1')
| -rw-r--r-- | nixpkgs/pkgs/applications/video/epgstation/epgstation.1 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/nixpkgs/pkgs/applications/video/epgstation/epgstation.1 b/nixpkgs/pkgs/applications/video/epgstation/epgstation.1 new file mode 100644 index 00000000000..bb5c0238137 --- /dev/null +++ b/nixpkgs/pkgs/applications/video/epgstation/epgstation.1 @@ -0,0 +1,52 @@ +.Dd $Mdocdate$ +.Dt EPGSTATION 1 +.Os +.Sh NAME +.Nm epgstation +.Nd @DESCRIPTION@ +.Sh SYNOPSIS +.Nm +.Bk -words +.Op Ar command Op Ar args +.Ek +.Sh DESCRIPTION +.Nm +is a wrapper command for EPGStation provided by Nix. It's actually a thin +wrapper around the +.Xr npm 1 +command line tool which you can use to invoke npm commands from the EPGStation +project directory. The command line arguments are simply passed as-is to +.Xr npm 1 . +.Pp +On NixOS, it is strongly recommended that you enable the epgstation module +instead of invoking this command directly to launch EPGStation. On other +platforms, run +.Pp +.Dl $ epgstation start +.Pp +to start EPGStation. +.Sh FILES +.Bl -tag -width Ds -compact +.It Pa /etc/epgstation/config.json +.Nm +configuration file. +.El +.Sh EXAMPLES +Start EPGStation. +.Pp +.Dl $ epgstation start +.Pp +Start EPGStation in development mode. +.Pp +.Dl $ epgstation run dev-start +.Pp +Backup the EPGstation database. +.Pp +.Dl $ epgstation run backup /path/to/dst +.Pp +Restore the EPGstation database. +.Pp +.Dl $ epgstation run restore /path/to/src +.Pp +.Sh SEE ALSO +.Xr npm 1 |